Skip to content

[chore] Update deps #1536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/openapi-fetch/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,11 @@ const client = createClient({
| form (exploded) | `/users?role=admin&firstName=Alex` |
| **deepObject (default)** | `/users?id[role]=admin&id[firstName]=Alex` |

> [!NOTE]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I incorrectly thought Vitepress changed their syntax, but this is just an alternate form of the same thing. The ::: is required for a lot of Vitepress markdown features so I’ll stick with that.

>
> **deepObject** is always exploded, so it doesn’t matter if you set `explode: true` or `explode: false`—it’ll generate the same output.
::: note

**deepObject** is always exploded, so it doesn’t matter if you set `explode: true` or `explode: false`—it’ll generate the same output.

:::

### Alternate function syntax

Expand All @@ -115,9 +117,11 @@ const client = createClient({
});
```

> [!WARNING]
>
> When serializing yourself, the string will be kept exactly as-authored, so you’ll have to call [encodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI) or [encodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) to escape special characters.
::: warning

When serializing yourself, the string will be kept exactly as-authored, so you’ll have to call [encodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI) or [encodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) to escape special characters.

:::

## bodySerializer

Expand Down
8 changes: 5 additions & 3 deletions docs/openapi-fetch/middleware-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ const client = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
client.use(myMiddleware);
```

> [!TIP]
>
> The order in which middleware are registered matters. For requests, `onRequest()` will be called in the order registered. For responses, `onResponse()` will be called in **reverse** order. That way the first middleware gets the first “dibs” on requests, and the final control over the end response.
::: tip

The order in which middleware are registered matters. For requests, `onRequest()` will be called in the order registered. For responses, `onResponse()` will be called in **reverse** order. That way the first middleware gets the first “dibs” on requests, and the final control over the end response.

:::

### Skipping

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@
"devDependencies": {
"@changesets/changelog-github": "^0.5.0",
"@changesets/cli": "^2.27.1",
"@typescript-eslint/eslint-plugin": "^6.19.1",
"@typescript-eslint/parser": "^6.19.1",
"@typescript-eslint/eslint-plugin": "^7.0.1",
"@typescript-eslint/parser": "^7.0.1",
"del-cli": "^5.1.0",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-import": "^2.29.1",
"eslint-plugin-no-only-tests": "^3.1.0",
"eslint-plugin-prettier": "^5.1.3",
"eslint-plugin-vitest": "^0.2.8",
"prettier": "^3.2.4",
"prettier": "^3.2.5",
"typescript": "^5.3.3"
}
}
4 changes: 2 additions & 2 deletions packages/openapi-fetch/examples/nextjs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"dev": "next dev"
},
"dependencies": {
"next": "14.0.1",
"next": "14.1.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessary to keep the example deps updated, but next in particular is usually the one that annoys me with security warnings

"openapi-fetch": "workspace:^",
"react": "18.2.0",
"react-dom": "18.2.0"
},
"devDependencies": {
"@types/node": "20.5.1",
"@types/node": "20.11.19",
"@types/react": "18.2.20",
"@types/react-dom": "18.2.7",
"openapi-typescript": "workspace:^",
Expand Down
4 changes: 2 additions & 2 deletions packages/openapi-typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@
"typescript": "^5.x"
},
"dependencies": {
"@redocly/openapi-core": "^1.8.0",
"@redocly/openapi-core": "^1.9.0",
"ansi-colors": "^4.1.3",
"supports-color": "^9.4.0",
"yargs-parser": "^21.1.1"
},
"devDependencies": {
"@types/degit": "^2.8.6",
"@types/js-yaml": "^4.0.9",
"@types/node": "^20.11.8",
"@types/node": "^20.11.19",
"degit": "^2.8.4",
"del-cli": "^5.1.0",
"esbuild": "^0.20.0",
Expand Down
Loading