Merge branch 'main' into main

Author: mellster2012

.github/workflows/ci.yml

@@ -6,6 +6,9 @@ on:
       - main
   pull_request:
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 concurrency:
   group: ci-${{ github.ref }}
   cancel-in-progress: true
@@ -20,7 +23,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - run: pnpm run lint
   test-node-versions:
@@ -35,9 +38,8 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test
   test-e2e:
     runs-on: ubuntu-latest
@@ -48,7 +50,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - run: pnpm exec playwright install --with-deps
       - run: pnpm run test-e2e
@@ -61,9 +63,8 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test
   test-windows:
     runs-on: windows-latest
@@ -74,7 +75,6 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test

.github/workflows/release.yml

@@ -5,6 +5,9 @@ on:
     branches:
       - main
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 jobs:
   changelog:
     runs-on: ubuntu-latest
@@ -19,15 +22,13 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - uses: changesets/action@v1
         with:
           version: pnpm run version
           publish: pnpm exec changeset publish
           commit: "[ci] release"
           title: "[ci] release"
         env:
-          GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/size-limit.yml

@@ -1,9 +1,13 @@
 name: "Size Limit"
+
 on:
   pull_request:
     branches: [main]
     types: [opened, synchronize]
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 jobs:
   size-limit:
     permissions:
@@ -17,7 +21,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - uses: andresz1/[email protected]
         with:

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+.turbo
 dist
 node_modules
 coverage

CONTRIBUTING.md

@@ -1,25 +1,38 @@
 # Contributing
 
-Contributions are welcome! T
+Contributions are welcome!
 
 ## Setup
 
-This monorepo uses [pnpm workspaces](https://pnpm.io/) that lets packages pull from local versions rather than remote. After installing pnpm, running this command from the root will set everything up:
+This monorepo uses [pnpm workspaces](https://pnpm.io/) that lets packages pull from local versions rather than remote. It also uses [Turborepo](https://turbo.build/repo/docs) to run commands more easily. After installing pnpm, running the following commands from the root will set everything up:
 
 ```sh
 pnpm i
+pnpm run build
 ```
 
+## Workspace vs local commands
+
+The “workspace“ is the root `package.json`. Running commands here will run on all packages. For example, running `pnpm run build` in the workspace root will build all packages. But running `cd packages/openapi-typescript && pnpm run build` will only build that one package.
+
+It’s worth noting that some packages depend on others in the monorepo. For example, `openapi-fetch` depends on `openapi-typescript` building built. `openapi-react-query` relies on `openapi-fetch` which relies on `openapi-typescript`. If running commands per-package, you’d have to manually build each package before the test suite could run. But running `pnpm run build` in the workspace root once will build all packages for you, so that you can run any test suite.
+
+> ![NOTE]
+>
+> Note that if any package changes, be sure to rebuild before running tests! Of course, CI will always do this, but in case you see differences between local vs CI, this is usually the culprit—a stale build.
+
+Again, Turborepo is there so that you don’t have to think about all the packages as much, if you’re just contributing to one. But these tips may help you troubleshoot if something unexpected happens.
+
 ## Structure
 
 This monorepo has 2 main sections: the `docs/` that deploy to `openapi-ts.dev`, and `packages/` which are all the npm packages. Each npm package has its own `CONTRIBUTING.md` doc that describes setup needed for that package.
 
 ```
-┬── docs/                         # openapi-ts.dev
-│
+┬── docs/
 └── packages/
-    ├── openapi-fetch/            # openapi-fetch package
+    ├── openapi-fetch/
+    ├── openapi-react-query/
+    ├── openapi-typescript/
     ├── openapi-typescript-helpers/
-    │                             # openapi-typescript package
-    └── openapi-typescript/       # openapi-typescript package
+    └── swr-openapi/
 ```

docs/cli.md

@@ -120,6 +120,7 @@ The following flags are supported in the CLI:
 | `--immutable`                      |       | `false`  | Generates immutable types (readonly properties and readonly array)                                                  |
 | `--path-params-as-types`           |       | `false`  | Allow dynamic string lookups on the `paths` object                                                                  |
 | `--root-types`                     |       | `false`  | Exports types from `components` as root level type aliases                                                          |
+| `--root-types-no-schema-prefix`    |       | `false`  | Do not add "Schema" prefix to types at the root level (should only be used with --root-types)                       |
 
 ### pathParamsAsTypes
 

docs/data/contributors.json

@@ -207,7 +207,7 @@ openapi-fetch supports path serialization as [outlined in the 3.1 spec](https://
 
 ## Middleware
 
-Middleware is an object with `onRequest()` and `onResponse()` callbacks that can observe and modify requests and responses.
+Middleware is an object with `onRequest()`, `onResponse()` and `onError()` callbacks that can observe and modify requests, responses and errors.
 
 ```ts
 import createClient from "openapi-fetch";
@@ -224,6 +224,12 @@ const myMiddleware: Middleware = {
     // change status of response
     return new Response(body, { ...resOptions, status: 200 });
   },
+  async onError({ error }) {
+    // wrap errors thrown by fetch
+    onError({ error }) {
+      return new Error("Oops, fetch failed", { cause: error });
+    },
+  },
 };
 
 const client = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
@@ -238,21 +244,33 @@ client.use(myMiddleware);
 
 Each middleware callback receives the following `options` object with the following:
 
-| Name         | Type            | Description                                                                                 |
-| :----------- | :-------------- | :------------------------------------------------------------------------------------------ |
-| `request`    | `Request`       | The current `Request` to be sent to the endpoint.                                           |
-| `response`   | `Response`      | The `Response` returned from the endpoint (note: this will be `undefined` for `onRequest`). |
-| `schemaPath` | `string`        | The original OpenAPI path called (e.g. `/users/{user_id}`)                                  |
-| `params`     | `Object`        | The original `params` object passed to `GET()` / `POST()` / etc.                            |
-| `id`         | `string`        | A random, unique ID for this request.                                                       |
-| `options`    | `ClientOptions` | The readonly options passed to `createClient()`.                                            |
+| Name         | Type            | Description                                                      |
+| :----------- | :-------------- | :----------------------------------------------------------------|
+| `request`    | `Request`       | The current `Request` to be sent to the endpoint.                |
+| `schemaPath` | `string`        | The original OpenAPI path called (e.g. `/users/{user_id}`)       |
+| `params`     | `Object`        | The original `params` object passed to `GET()` / `POST()` / etc. |
+| `id`         | `string`        | A random, unique ID for this request.                            |
+| `options`    | `ClientOptions` | The readonly options passed to `createClient()`.                 |
+
+In addition to these, the `onResponse` callback receives an additional `response` property:
+
+| Name         | Type            | Description                                |
+| :----------- | :-------------- | :------------------------------------------|
+| `response`   | `Response`      | The `Response` returned from the endpoint. |
+
+And the `onError` callback receives an additional `error` property:
+
+| Name         | Type            | Description                                                              |
+| :----------- | :-------------- | :------------------------------------------------------------------------|
+| `error`      | `unknown`       | The error thrown by `fetch`, probably a `TypeError` or a `DOMException`. |
 
 #### Response
 
 Each middleware callback can return:
 
 - **onRequest**: Either a `Request` to modify the request, or `undefined` to leave it untouched (skip)
-- **onResponse** Either a `Response` to modify the response, or `undefined` to leave it untouched (skip)
+- **onResponse**: Either a `Response` to modify the response, or `undefined` to leave it untouched (skip)
+- **onError**: Either an `Error` to modify the error that is thrown, a `Response` which means that the `fetch` call will proceed as successful, or `undefined` to leave the error untouched (skip)
 
 ### Ejecting middleware
 

docs/openapi-fetch/api.md

@@ -4,11 +4,11 @@ title: Middleware & Auth
 
 # Middleware & Auth
 
-Middleware allows you to modify either the request, response, or both for all fetches. One of the most common usecases is authentication, but can also be used for logging/telemetry, throwing errors, or handling specific edge cases.
+Middleware allows you to modify either the request, response, or both for all fetches as well as handling errors thrown by `fetch`. One of the most common usecases is authentication, but can also be used for logging/telemetry, throwing errors, or handling specific edge cases.
 
 ## Middleware
 
-Each middleware can provide `onRequest()` and `onResponse()` callbacks, which can observe and/or mutate requests and responses.
+Each middleware can provide `onRequest()`, `onResponse()` and `onError` callbacks, which can observe and/or mutate requests, responses and `fetch` errors.
 
 ::: code-group
 
@@ -27,6 +27,12 @@ const myMiddleware: Middleware = {
     // change status of response
     return new Response(body, { ...resOptions, status: 200 });
   },
+  async onError({ error }) {
+    // wrap errors thrown by fetch
+    onError({ error }) {
+      return new Error("Oops, fetch failed", { cause: error });
+    },
+  },
 };
 
 const client = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
@@ -71,6 +77,44 @@ onResponse({ response }) {
 }
 ```
 
+### Error Handling
+
+The `onError` callback allows you to handle errors thrown by `fetch`. Common errors are `TypeError`s which can occur when there is a network or CORS error or `DOMException`s when the request is aborted using an `AbortController`.
+
+Depending on the return value, `onError` can handle errors in three different ways:
+
+**Return nothing** which means that the error will still be thrown. This is useful for logging.
+
+```ts
+onError({ error }) {
+  console.error(error);
+  return;
+},
+```
+
+**Return another instance of `Error`** which is thrown instead of the original error.
+
+```ts
+onError({ error }) {
+  return new Error("Oops", { cause: error });
+},
+```
+
+**Return a new instance of `Response`** which means that the `fetch` call will proceed as successful.
+
+```ts
+onError({ error }) {
+  return Response.json({ message: 'nothing to see' });
+},
+```
+
+::: tip
+
+`onError` _does not_ handle error responses with `4xx` or `5xx` HTTP status codes, since these are considered "successful" responses but with a bad status code. In these cases you need to check the response's  status property or `ok()` method via the `onResponse` callback.
+
+:::
+
+
 ### Ejecting middleware
 
 To remove middleware, call `client.eject(middleware)`:

docs/openapi-fetch/middleware-auth.md

@@ -6,10 +6,9 @@
   "scripts": {
     "build": "pnpm run update-contributors && vitepress build && cp _redirects .vitepress/dist",
     "dev": "pnpm run update-contributors && vitepress dev",
-    "tokens": "co build",
     "update-contributors": "node scripts/update-contributors.js"
   },
   "devDependencies": {
-    "vitepress": "1.3.2"
+    "vitepress": "1.5.0"
   }
 }

docs/package.json

@@ -7,28 +7,30 @@
     "name": "Drew Powers",
     "email": "[email protected]"
   },
+  "packageManager": "[email protected]",
   "scripts": {
-    "build": "pnpm run -r --filter \"!*docs\" --aggregate-output build",
-    "lint": "pnpm run -r --parallel --aggregate-output lint",
+    "build": "turbo run build",
+    "lint": "turbo run lint",
     "dev": "pnpm run -r --parallel --filter \"{packages/*}\" --aggregate-output dev",
-    "format": "pnpm run -r --parallel --aggregate-output format",
-    "test": "pnpm run -r --parallel --aggregate-output test",
-    "test-e2e": "pnpm run -r --parallel --aggregate-output test-e2e",
-    "size": "pnpm run build && size-limit",
+    "format": "turbo run format",
+    "test": "turbo run test",
+    "test-e2e": "turbo run test-e2e",
+    "size": "turbo run size-limit",
     "version": "pnpm run build && changeset version && pnpm i"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@changesets/changelog-github": "^0.5.0",
-    "@changesets/cli": "^2.27.9",
-    "@playwright/test": "^1.48.1",
+    "@changesets/cli": "^2.27.10",
+    "@playwright/test": "^1.49.0",
     "@size-limit/preset-small-lib": "^11.1.6",
-    "@types/node": "^22.8.0",
+    "@types/node": "^22.10.1",
     "del-cli": "^5.1.0",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.1",
     "size-limit": "^11.1.6",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.3"
+    "turbo": "^2.3.3",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6"
   },
   "size-limit": [
     {

package.json

@@ -1,5 +1,11 @@
 # openapi-fetch
 
+## 0.13.1
+
+### Patch Changes
+
+- [#1974](https://github.com/openapi-ts/openapi-typescript/pull/1974) [`35c576c`](https://github.com/openapi-ts/openapi-typescript/commit/35c576c8b2852f66e641014d13ffcfdeb21e98a1) Thanks [@luchsamapparat](https://github.com/luchsamapparat)! - add onError handler to middleware
+
 ## 0.13.0
 
 ### Minor Changes

packages/openapi-fetch/CHANGELOG.md

@@ -6,7 +6,7 @@
     "dev": "next dev"
   },
   "dependencies": {
-    "next": "15.0.1",
+    "next": "15.0.3",
     "openapi-fetch": "workspace:^",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
@@ -15,6 +15,6 @@
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
     "openapi-typescript": "workspace:^",
-    "typescript": "5.4.5"
+    "typescript": "^5.7.2"
   }
 }