Version Packages

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@hey-api/[email protected]

Minor Changes

• BREAKING: rename exported Security interface to Auth

• BREAKING: remove support for passing auth to Axios instance

• BREAKING: please update @hey-api/openapi-ts to the latest version

  feat: replace accessToken and apiKey functions with auth

  Added auth option

  Client package functions accessToken and apiKey were replaced with a single auth function for fetching auth tokens. If your API supports multiple auth mechanisms, you can use the auth argument to return the appropriate token.

  import { client } from 'client/sdk.gen';
  
  client.setConfig({
    accessToken: () => '<my_token>', // [!code --]
    apiKey: () => '<my_token>', // [!code --]
    auth: (auth) => '<my_token>', // [!code ++]
  });

  Due to conflict with the Axios native auth option, we removed support for configuring Axios auth. Please let us know if you require this feature added back.

@hey-api/[email protected]

Minor Changes

• BREAKING: please update @hey-api/openapi-ts to the latest version

  feat: replace accessToken and apiKey functions with auth

  Added auth option

  Client package functions accessToken and apiKey were replaced with a single auth function for fetching auth tokens. If your API supports multiple auth mechanisms, you can use the auth argument to return the appropriate token.

  import { client } from 'client/sdk.gen';
  
  client.setConfig({
    accessToken: () => '<my_token>', // [!code --]
    apiKey: () => '<my_token>', // [!code --]
    auth: (auth) => '<my_token>', // [!code ++]
  });

• BREAKING: rename exported Security interface to Auth

• #1507 e2e1410 Thanks @nimobeeren! - BREAKING: return raw response body (of type ReadableStream) when Content-Type response header is not provided and parseAs is set to auto

@hey-api/[email protected]

Minor Changes

• #1520 b3c23ba Thanks @chriswiggins! - Add support for HTTP Bearer Authentication Scheme

• #1525 7b7313e Thanks @mrlubos! - feat: add OpenAPI 2.0 support to experimental parser

• #1511 4e8064d Thanks @mrlubos! - feat: add watch mode

  Watch Mode

  ::: warning
  Watch mode currently supports only remote files via URL.
  :::

  If your schema changes frequently, you may want to automatically regenerate the output during development. To watch your input file for changes, enable watch mode in your configuration or pass the --watch flag to the CLI.

  Config

  export default {
    client: '@hey-api/client-fetch',
    input: 'path/to/openapi.json',
    output: 'src/client',
    watch: true,
  };

  CLI

  npx @hey-api/openapi-ts \
    -c @hey-api/client-fetch \
    -i path/to/openapi.json \
    -o src/client \
    -w

• BREAKING: please update @hey-api/client-* packages to the latest version

  feat: add support for basic http auth

Patch Changes

• #1529 ccc0bbc Thanks @mrlubos! - fix: add support for long integers

• #1512 dd0e0a2 Thanks @mrlubos! - fix: add sdk.throwOnError option

• #1525 7b7313e Thanks @mrlubos! - fix: preserve leading separators in enum keys

@hey-api/[email protected]

Minor Changes

• #1511 4e8064d Thanks @mrlubos! - feat: add watch mode

  Watch Mode

  ::: warning
  Watch mode currently supports only remote files via URL.
  :::

  If your schema changes frequently, you may want to automatically regenerate the output during development. To watch your input file for changes, enable watch mode in your configuration or pass the --watch flag to the CLI.

  Config

  export default {
    client: '@hey-api/client-fetch',
    input: 'path/to/openapi.json',
    output: 'src/client',
    watch: true,
  };

  CLI

  npx @hey-api/openapi-ts \
    -c @hey-api/client-fetch \
    -i path/to/openapi.json \
    -o src/client \
    -w

Patch Changes

• #1496 1e418ba Thanks @mrlubos! - docs: split output section into multiple pages

@example/[email protected]

Patch Changes

• Updated dependencies []:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

@example/[email protected]

Patch Changes

• Updated dependencies [e2e1410]:
  • @hey-api/[email protected]

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 6, 2025 9:55am

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.