@hey-api/openapi-ts 0.62.3 → 0.63.0

package/dist/index.d.ts

@@ -6370,7 +6370,20 @@ type OmitUnderscoreKeys<T> = {
   [K in keyof T as K extends `_${string}` ? never : K]: T[K];
 };
 
+type PluginClientNames =
+  | '@hey-api/client-axios'
+  | '@hey-api/client-fetch'
+  | '@hey-api/client-nuxt'
+  | 'legacy/angular'
+  | 'legacy/axios'
+  | 'legacy/fetch'
+  | 'legacy/node'
+  | 'legacy/xhr';
+
+type PluginValidatorNames = 'zod';
+
 type PluginNames =
+  | PluginClientNames
   | '@hey-api/schemas'
   | '@hey-api/sdk'
   | '@hey-api/transformers'
@@ -6381,15 +6394,18 @@ type PluginNames =
   | '@tanstack/svelte-query'
   | '@tanstack/vue-query'
   | 'fastify'
-  | 'zod';
+  | PluginValidatorNames;
 
 type AnyPluginName = PluginNames | (string & {});
 
-type PluginTag = 'transformer' | 'validator';
+type PluginTag = 'client' | 'transformer' | 'validator';
 
 interface PluginContext {
   ensureDependency: (name: PluginNames | true) => void;
-  pluginByTag: (tag: PluginTag) => AnyPluginName | undefined;
+  pluginByTag: (
+    tag: PluginTag,
+    errorMessage?: string,
+  ) => AnyPluginName | undefined;
 }
 
 interface BaseConfig {
@@ -6424,6 +6440,41 @@ interface Meta<Config extends BaseConfig> {
   _tags?: ReadonlyArray<PluginTag>;
 }
 
+/**
+ * Public Client API.
+ */
+declare namespace Client {
+  export type Config = {
+    /**
+     * Bundle the client module? Set this to true if don't want to declare it
+     * as a separate dependency. When true, the client module will be generated
+     * from the client package and bundled with the rest of the generated output.
+     * This is useful if you're repackaging the output, publishing it to other
+     * users, and you don't want them to install any dependencies.
+     *
+     * @default false
+     */
+    bundle?: boolean;
+    /**
+     * Name of the generated file.
+     *
+     * @default 'client'
+     */
+    output?: string;
+    /**
+     * Relative path to the runtime configuration file. This file must export
+     * a `createClientConfig()` function. The `createClientConfig()` function
+     * will be called on client initialization and the returned object will
+     * become the client's initial configuration.
+     *
+     * You may want to initialize your client this way instead of calling
+     * `setConfig()`. This is useful for example if you're using Next.js
+     * to ensure your client always has the correct values.
+     */
+    runtimeConfigPath?: string;
+  };
+}
+
 /**
  * Public Plugin API.
  */
@@ -6480,6 +6531,52 @@ declare namespace Plugin {
   export type UserConfig<Config extends BaseConfig> = Omit<Config, 'output'>;
 }
 
+interface Config$j
+  extends Plugin.Name<'@hey-api/client-axios'>,
+    Client.Config {
+  /**
+   * Throw an error instead of returning it in the response?
+   *
+   * @default false
+   */
+  throwOnError?: boolean;
+}
+
+interface Config$i
+  extends Plugin.Name<'@hey-api/client-fetch'>,
+    Client.Config {
+  /**
+   * Throw an error instead of returning it in the response?
+   *
+   * @default false
+   */
+  throwOnError?: boolean;
+}
+
+interface Config$h
+  extends Plugin.Name<'@hey-api/client-nuxt'>,
+    Client.Config {}
+
+interface Config$g
+  extends Plugin.Name<'legacy/angular'>,
+    Pick<Client.Config, 'output'> {}
+
+interface Config$f
+  extends Plugin.Name<'legacy/axios'>,
+    Pick<Client.Config, 'output'> {}
+
+interface Config$e
+  extends Plugin.Name<'legacy/fetch'>,
+    Pick<Client.Config, 'output'> {}
+
+interface Config$d
+  extends Plugin.Name<'legacy/node'>,
+    Pick<Client.Config, 'output'> {}
+
+interface Config$c
+  extends Plugin.Name<'legacy/xhr'>,
+    Pick<Client.Config, 'output'> {}
+
 interface Config$b extends Plugin.Name<'@hey-api/schemas'> {
   /**
    * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
@@ -6498,6 +6595,7 @@ interface Config$b extends Plugin.Name<'@hey-api/schemas'> {
   ) => string;
   /**
    * Name of the generated file.
+   *
    * @default 'schemas'
    */
   output?: string;
@@ -6505,6 +6603,7 @@ interface Config$b extends Plugin.Name<'@hey-api/schemas'> {
    * Choose schema type to generate. Select 'form' if you don't want
    * descriptions to reduce bundle size and you plan to use schemas
    * for form validation
+   *
    * @default 'json'
    */
   type?: 'form' | 'json';
@@ -6531,6 +6630,18 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   auth?: boolean;
+  /**
+   * Use an internal client instance to send HTTP requests. This is useful if
+   * you don't want to manually pass the client to each SDK function.
+   *
+   * Ensure you have declared the selected library as a dependency to avoid
+   * errors. You can customize the selected client output through its plugin.
+   * You can also set `client` to `true` to automatically choose the client
+   * from your defined plugins.
+   *
+   * @default true
+   */
+  client?: PluginClientNames | boolean;
   /**
    * @deprecated
    *
@@ -6567,11 +6678,11 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   output?: string;
   /**
+   * @deprecated
+   *
    * Define shape of returned value from service calls
    *
    * @default 'body'
-   *
-   * @deprecated
    */
   response?: 'body' | 'response';
   /**
@@ -6583,12 +6694,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default '{{name}}Service'
    */
   serviceNameBuilder?: string;
-  /**
-   * Throw an error instead of returning it in the response?
-   *
-   * @default false
-   */
-  throwOnError?: boolean;
   /**
    * Transform response data before returning. This is useful if you want to
    * convert for example ISO strings into Date objects. However, transformation
@@ -6614,7 +6719,7 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    *
    * @default false
    */
-  validator?: 'zod' | boolean;
+  validator?: PluginValidatorNames | boolean;
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -6710,22 +6815,26 @@ interface Config$7
   extends Plugin.Name<'@tanstack/angular-query-experimental'> {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
+   *
    * @default true
    */
   infiniteQueryOptions?: boolean;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/useMutation `useMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   *
    * @default true
    */
   mutationOptions?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default '@tanstack/angular-query-experimental'
    */
   output?: string;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/queryOptions `queryOptions()`} helpers?
    * These will be generated from all requests.
+   *
    * @default true
    */
   queryOptions?: boolean;
@@ -6734,22 +6843,26 @@ interface Config$7
 interface Config$6 extends Plugin.Name<'@tanstack/react-query'> {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
+   *
    * @default true
    */
   infiniteQueryOptions?: boolean;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   *
    * @default true
    */
   mutationOptions?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default '@tanstack/react-query'
    */
   output?: string;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions `queryOptions()`} helpers?
    * These will be generated from all requests.
+   *
    * @default true
    */
   queryOptions?: boolean;
@@ -6758,22 +6871,26 @@ interface Config$6 extends Plugin.Name<'@tanstack/react-query'> {
 interface Config$5 extends Plugin.Name<'@tanstack/solid-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
+   *
    * @default true
    */
   infiniteQueryOptions?: boolean;
   /**
    * Generate `createMutation()` helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   *
    * @default true
    */
   mutationOptions?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default '@tanstack/solid-query'
    */
   output?: string;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createQuery `createQuery()`} helpers?
    * These will be generated from all requests.
+   *
    * @default true
    */
   queryOptions?: boolean;
@@ -6782,22 +6899,26 @@ interface Config$5 extends Plugin.Name<'@tanstack/solid-query'> {
 interface Config$4 extends Plugin.Name<'@tanstack/svelte-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
+   *
    * @default true
    */
   infiniteQueryOptions?: boolean;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation `createMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   *
    * @default true
    */
   mutationOptions?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default '@tanstack/svelte-query'
    */
   output?: string;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery `createQuery()`} helpers?
    * These will be generated from all requests.
+   *
    * @default true
    */
   queryOptions?: boolean;
@@ -6806,22 +6927,26 @@ interface Config$4 extends Plugin.Name<'@tanstack/svelte-query'> {
 interface Config$3 extends Plugin.Name<'@tanstack/vue-query'> {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/vue/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
+   *
    * @default true
    */
   infiniteQueryOptions?: boolean;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/vue/reference/useMutation `useMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   *
    * @default true
    */
   mutationOptions?: boolean;
   /**
    * Name of the generated file.
+   *
    * @default '@tanstack/vue-query'
    */
   output?: string;
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/vue/guides/query-options `queryOptions()`} helpers?
    * These will be generated from all requests.
+   *
    * @default true
    */
   queryOptions?: boolean;
@@ -6830,6 +6955,7 @@ interface Config$3 extends Plugin.Name<'@tanstack/vue-query'> {
 interface Config$2 extends Plugin.Name<'fastify'> {
   /**
    * Name of the generated file.
+   *
    * @default 'fastify'
    */
   output?: string;
@@ -6846,6 +6972,7 @@ interface Config$1 extends Plugin.Name<'zod'> {
   // nameBuilder?: (model: IR.OperationObject | IR.SchemaObject) => string;
   /**
    * Name of the generated file.
+   *
    * @default 'zod'
    */
   output?: string;
@@ -6854,38 +6981,16 @@ interface Config$1 extends Plugin.Name<'zod'> {
 /**
  * User-facing plugin types.
  */
-type UserPlugins = Plugin.UserConfig<Config$b> | Plugin.UserConfig<Config$a> | Plugin.UserConfig<Config$9> | Plugin.UserConfig<Config$8> | Plugin.UserConfig<Config$7> | Plugin.UserConfig<Config$6> | Plugin.UserConfig<Config$5> | Plugin.UserConfig<Config$4> | Plugin.UserConfig<Config$3> | Plugin.UserConfig<Config$2> | Plugin.UserConfig<Config$1>;
+type UserPlugins = Plugin.UserConfig<Config$j> | Plugin.UserConfig<Config$i> | Plugin.UserConfig<Config$h> | Plugin.UserConfig<Config$g> | Plugin.UserConfig<Config$f> | Plugin.UserConfig<Config$e> | Plugin.UserConfig<Config$d> | Plugin.UserConfig<Config$c> | Plugin.UserConfig<Config$b> | Plugin.UserConfig<Config$a> | Plugin.UserConfig<Config$9> | Plugin.UserConfig<Config$8> | Plugin.UserConfig<Config$7> | Plugin.UserConfig<Config$6> | Plugin.UserConfig<Config$5> | Plugin.UserConfig<Config$4> | Plugin.UserConfig<Config$3> | Plugin.UserConfig<Config$2> | Plugin.UserConfig<Config$1>;
 /**
  * Internal plugin types.
  */
-type ClientPlugins = Plugin.Config<Config$b> | Plugin.Config<Config$a> | Plugin.Config<Config$9> | Plugin.Config<Config$8> | Plugin.Config<Config$7> | Plugin.Config<Config$6> | Plugin.Config<Config$5> | Plugin.Config<Config$4> | Plugin.Config<Config$3> | Plugin.Config<Config$2> | Plugin.Config<Config$1>;
+type ClientPlugins = Plugin.Config<Config$j> | Plugin.Config<Config$i> | Plugin.Config<Config$h> | Plugin.Config<Config$g> | Plugin.Config<Config$f> | Plugin.Config<Config$e> | Plugin.Config<Config$d> | Plugin.Config<Config$c> | Plugin.Config<Config$b> | Plugin.Config<Config$a> | Plugin.Config<Config$9> | Plugin.Config<Config$8> | Plugin.Config<Config$7> | Plugin.Config<Config$6> | Plugin.Config<Config$5> | Plugin.Config<Config$4> | Plugin.Config<Config$3> | Plugin.Config<Config$2> | Plugin.Config<Config$1>;
 
-declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "@hey-api/client-nuxt", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
-type Client = (typeof CLIENTS)[number];
 type Formatters = 'biome' | 'prettier';
 type Linters = 'biome' | 'eslint' | 'oxlint';
 type StringCase = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
-interface ClientConfig {
-    /**
-     * HTTP client to generate
-     */
-    client?: Client | false | {
-        /**
-         * Bundle the client module? Set this to true if you're using a client
-         * package and don't want to declare it as a separate dependency.
-         * When true, the client module will be generated from the client
-         * package and bundled with the rest of the generated output. This is
-         * useful if you're repackaging the output, publishing it to other users,
-         * and you don't want them to install any dependencies.
-         *
-         * @default false
-         */
-        bundle?: boolean;
-        /**
-         * HTTP client to generate
-         */
-        name: Client;
-    };
+interface UserConfig {
     /**
      * Path to the config file. Set this value if you don't use the default
      * config file name, or it's not located in the project root.
@@ -7088,19 +7193,17 @@ interface ClientConfig {
      */
     useOptions?: boolean;
 }
-type UserConfig = ClientConfig;
-type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'input' | 'logs' | 'name' | 'output' | 'plugins' | 'request' | 'watch'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
-    client: Extract<Required<ClientConfig>['client'], object>;
-    input: ExtractWithDiscriminator<ClientConfig['input'], {
+type Config = Omit<Required<UserConfig>, 'base' | 'input' | 'logs' | 'name' | 'output' | 'plugins' | 'request' | 'watch'> & Pick<UserConfig, 'base' | 'name' | 'request'> & {
+    input: ExtractWithDiscriminator<UserConfig['input'], {
         path: unknown;
     }>;
-    logs: Extract<Required<ClientConfig['logs']>, object>;
-    output: Extract<ClientConfig['output'], object>;
+    logs: Extract<Required<UserConfig['logs']>, object>;
+    output: Extract<UserConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;
     plugins: ArrayOfObjectsToObjectMap<ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, {
         name: string;
     }>, 'name'>;
-    watch: Extract<ClientConfig['watch'], object>;
+    watch: Extract<UserConfig['watch'], object>;
 };
 
 interface Identifier {
@@ -7176,11 +7279,13 @@ declare class TypeScriptFile {
         namespace: keyof Namespaces;
     }): Identifier;
     /**
-     * Adds an import to the provided module. Handles duplication, returns added import.
+     * Adds an import to the provided module. Handles duplication, returns added
+     * import. Returns the imported name. If we import an aliased export, `name`
+     * will be equal to the specified `alias`.
      */
     import({ module, ...importedItem }: ImportExportItemObject & {
         module: string;
-    }): ImportExportItemObject;
+    }): Pick<ImportExportItemObject, 'asType' | 'name'>;
     isEmpty(): boolean;
     nameWithoutExtension(): string;
     relativePathToFile({ context, id, }: {