@hey-api/openapi-ts 0.63.2 → 0.64.1

package/dist/index.d.cts

@@ -6340,30 +6340,45 @@ declare namespace OpenApi {
 }
 
 interface Operation extends Omit<Operation$1, 'tags'> {
-    service: string;
+  service: string;
 }
+
 interface Service extends Pick<Model, '$refs' | 'imports' | 'name'> {
-    operations: Operation[];
+  operations: Operation[];
 }
+
 interface Client$1 extends Omit<Client$2, 'operations'> {
-    services: Service[];
+  services: Service[];
 }
 
-type ExtractWithDiscriminator<T, Discriminator> = T extends Discriminator ? T : never;
+type ExtractWithDiscriminator<T, Discriminator> = T extends Discriminator
+  ? T
+  : never;
+
 /**
  * Accepts an array of elements union and attempts to extract only objects.
  * For example, Array<string | number | { id: string }> would result in
  * Array<{ id: string }>.
  */
-type ExtractArrayOfObjects<T, Discriminator> = T extends Array<infer U> ? Array<ExtractWithDiscriminator<U, Discriminator>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<ExtractWithDiscriminator<U, Discriminator>> : never;
+type ExtractArrayOfObjects<T, Discriminator> =
+  T extends Array<infer U>
+    ? Array<ExtractWithDiscriminator<U, Discriminator>>
+    : T extends ReadonlyArray<infer U>
+      ? ReadonlyArray<ExtractWithDiscriminator<U, Discriminator>>
+      : never;
+
 type Files = Record<string, TypeScriptFile>;
+
 /**
  * Transforms an array of objects into an optional object map.
  * For example, Array<{ id: string }> would result in
  * { [key: string]?: { id: string } }
  */
-type ArrayOfObjectsToObjectMap<T extends ReadonlyArray<Record<string, any>>, D extends keyof T[number]> = {
-    [K in T[number][D]]?: Extract<T[number], Record<D, K>>;
+type ArrayOfObjectsToObjectMap<
+  T extends ReadonlyArray<Record<string, any>>,
+  D extends keyof T[number],
+> = {
+  [K in T[number][D]]?: Extract<T[number], Record<D, K>>;
 };
 
 type OmitUnderscoreKeys<T> = {
@@ -6441,41 +6456,6 @@ 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.
  */
@@ -6502,10 +6482,10 @@ declare namespace Plugin {
   /**
    * Plugin implementation for experimental parser.
    */
-  export type Handler<Config extends BaseConfig> = (args: {
+  export type Handler<Config extends BaseConfig, ReturnType = void> = (args: {
     context: IR.Context<OpenApi.V2_0_X | OpenApi.V3_0_X | OpenApi.V3_1_X>;
     plugin: Plugin.Instance<Config>;
-  }) => void;
+  }) => ReturnType;
 
   export type Instance<Config extends BaseConfig> = OmitUnderscoreKeys<Config> &
     Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
@@ -6533,7 +6513,7 @@ declare namespace Plugin {
 }
 
 interface Config$k
-  extends Plugin.Name<'@hey-api/client-axios'>,
+  extends Plugin.Name<'@hey-api/client-fetch'>,
     Client.Config {
   /**
    * Throw an error instead of returning it in the response?
@@ -6544,7 +6524,7 @@ interface Config$k
 }
 
 interface Config$j
-  extends Plugin.Name<'@hey-api/client-fetch'>,
+  extends Plugin.Name<'@hey-api/client-next'>,
     Client.Config {
   /**
    * Throw an error instead of returning it in the response?
@@ -6555,7 +6535,71 @@ interface Config$j
 }
 
 interface Config$i
-  extends Plugin.Name<'@hey-api/client-next'>,
+  extends Plugin.Name<'@hey-api/client-nuxt'>,
+    Client.Config {}
+
+/**
+ * Public Client API.
+ */
+declare namespace Client {
+  export type Config = {
+    /**
+     * Set a default base URL when creating the client? You can set `baseUrl`
+     * to a string which will be used as the base URL. If your input defines
+     * server(s), you can set `baseUrl` to a number to pick a specific server
+     * to use as the base URL. You can disable setting the base URL by setting
+     * `baseUrl` to `false`. By default, `baseUrl` is `true` and it will try to
+     * use the first defined server value. If there's none, we won't set a
+     * base URL.
+     *
+     * If the matched URL contains template literals, it will be ignored.
+     *
+     * @default true
+     */
+    baseUrl?: string | number | boolean;
+    /**
+     * 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;
+    /**
+     * Should the type helper for base URL allow only values matching the
+     * server(s) defined in the input? By default, `strictBaseUrl` is `false`
+     * which will provide type hints and allow you to pass any string.
+     *
+     * Note that setting `strictBaseUrl` to `true` can produce an invalid
+     * build if you specify `baseUrl` which doesn't conform to the type helper.
+     *
+     * @default false
+     */
+    strictBaseUrl?: boolean;
+  };
+}
+
+interface Config$h
+  extends Plugin.Name<'@hey-api/client-axios'>,
     Client.Config {
   /**
    * Throw an error instead of returning it in the response?
@@ -6565,10 +6609,6 @@ interface Config$i
   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'> {}
@@ -6993,35 +7033,46 @@ interface Config$1 extends Plugin.Name<'zod'> {
 /**
  * User-facing plugin types.
  */
-type UserPlugins = Plugin.UserConfig<Config$k> | 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>;
+type UserPlugins = Plugin.UserConfig<Config$h> | Plugin.UserConfig<Config$k> | Plugin.UserConfig<Config$j> | Plugin.UserConfig<Config$i> | 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$k> | 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>;
+type ClientPlugins = Plugin.Config<Config$h> | Plugin.Config<Config$k> | Plugin.Config<Config$j> | Plugin.Config<Config$i> | 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>;
 
 type Formatters = 'biome' | 'prettier';
+
 type Linters = 'biome' | 'eslint' | 'oxlint';
-type StringCase = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
+
+type StringCase =
+  | 'camelCase'
+  | 'PascalCase'
+  | 'preserve'
+  | 'snake_case'
+  | 'SCREAMING_SNAKE_CASE';
+
 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.
-     */
-    configFile?: string;
-    /**
-     * Skip writing files to disk?
-     *
-     * @default false
-     */
-    dryRun?: boolean;
-    /**
-     * Path to the OpenAPI specification. This can be either local or remote path.
-     * Both JSON and YAML file formats are supported. You can also pass the parsed
-     * object directly if you're fetching the file yourself.
-     *
-     * Alternatively, you can define a configuration object with more options.
-     */
-    input: string | Record<string, unknown> | {
+  /**
+   * 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.
+   */
+  configFile?: string;
+  /**
+   * Skip writing files to disk?
+   *
+   * @default false
+   */
+  dryRun?: boolean;
+  /**
+   * Path to the OpenAPI specification. This can be either local or remote path.
+   * Both JSON and YAML file formats are supported. You can also pass the parsed
+   * object directly if you're fetching the file yourself.
+   *
+   * Alternatively, you can define a configuration object with more options.
+   */
+  input:
+    | string
+    | Record<string, unknown>
+    | {
         /**
          * Prevent parts matching the regular expression from being processed.
          * You can select both operations and components by reference within
@@ -7049,13 +7100,15 @@ interface UserConfig {
          * object directly if you're fetching the file yourself.
          */
         path: string | Record<string, unknown>;
-    };
-    /**
-     * The relative location of the logs folder
-     *
-     * @default process.cwd()
-     */
-    logs?: string | {
+      };
+  /**
+   * The relative location of the logs folder
+   *
+   * @default process.cwd()
+   */
+  logs?:
+    | string
+    | {
         /**
          * The logging level to control the verbosity of log output.
          * Determines which messages are logged based on their severity.
@@ -7073,18 +7126,27 @@ interface UserConfig {
          *
          * @default 'info'
          */
-        level?: 'debug' | 'error' | 'fatal' | 'info' | 'silent' | 'trace' | 'warn';
+        level?:
+          | 'debug'
+          | 'error'
+          | 'fatal'
+          | 'info'
+          | 'silent'
+          | 'trace'
+          | 'warn';
         /**
          * The relative location of the logs folder
          *
          * @default process.cwd()
          */
         path?: string;
-    };
-    /**
-     * The relative location of the output folder
-     */
-    output: string | {
+      };
+  /**
+   * The relative location of the output folder
+   */
+  output:
+    | string
+    | {
         /**
          * Defines casing of the output fields. By default, we preserve `input`
          * values as data transforms incur a performance penalty at runtime.
@@ -7125,21 +7187,25 @@ interface UserConfig {
          * The relative location of the output folder
          */
         path: string;
-    };
-    /**
-     * Plugins generate artifacts from `input`. By default, we generate SDK
-     * functions and TypeScript interfaces. If you manually define `plugins`,
-     * you need to include the default plugins if you wish to use them.
-     *
-     * @default ['@hey-api/typescript', '@hey-api/sdk']
-     */
-    plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
-    /**
-     * Regenerate the client when the input file changes?
-     *
-     * @default false
-     */
-    watch?: boolean | number | {
+      };
+  /**
+   * Plugins generate artifacts from `input`. By default, we generate SDK
+   * functions and TypeScript interfaces. If you manually define `plugins`,
+   * you need to include the default plugins if you wish to use them.
+   *
+   * @default ['@hey-api/typescript', '@hey-api/sdk']
+   */
+  plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
+  /**
+   * Regenerate the client when the input file changes? You can alternatively
+   * pass a numeric value for the interval in ms.
+   *
+   * @default false
+   */
+  watch?:
+    | boolean
+    | number
+    | {
         /**
          * Regenerate the client when the input file changes?
          *
@@ -7147,76 +7213,94 @@ interface UserConfig {
          */
         enabled?: boolean;
         /**
-         * How often should we attempt to detect the input file change?
+         * How often should we attempt to detect the input file change? (in ms)
          *
          * @default 1000
          */
         interval?: number;
-    };
-    /**
-     * @deprecated
-     *
-     * Manually set base in OpenAPI config instead of inferring from server value
-     */
-    base?: string;
-    /**
-     * @deprecated
-     *
-     * Opt in to the experimental parser?
-     *
-     * @default true
-     */
-    experimentalParser?: boolean;
-    /**
-     * @deprecated
-     *
-     * Generate core client classes?
-     *
-     * @default true
-     */
-    exportCore?: boolean;
-    /**
-     * @deprecated
-     *
-     * Custom client class name. Please note this option is deprecated and
-     * will be removed in favor of clients.
-     *
-     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
-     */
-    name?: string;
-    /**
-     * @deprecated
-     *
-     * Path to custom request file. Please note this option is deprecated and
-     * will be removed in favor of clients.
-     *
-     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-request
-     */
-    request?: string;
-    /**
-     * @deprecated
-     *
-     * Use options or arguments functions. Please note this option is deprecated and
-     * will be removed in favor of clients.
-     *
-     * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
-     *
-     * @default true
-     */
-    useOptions?: boolean;
-}
-type Config = Omit<Required<UserConfig>, 'base' | 'input' | 'logs' | 'name' | 'output' | 'plugins' | 'request' | 'watch'> & Pick<UserConfig, 'base' | 'name' | 'request'> & {
-    input: ExtractWithDiscriminator<UserConfig['input'], {
-        path: unknown;
-    }>;
+        /**
+         * How long will we wait before the request times out?
+         *
+         * @default 60_000
+         */
+        timeout?: number;
+      };
+  /**
+   * @deprecated
+   *
+   * Manually set base in OpenAPI config instead of inferring from server value
+   */
+  // eslint-disable-next-line typescript-sort-keys/interface
+  base?: string;
+  /**
+   * @deprecated
+   *
+   * Opt in to the experimental parser?
+   *
+   * @default true
+   */
+  experimentalParser?: boolean;
+  /**
+   * @deprecated
+   *
+   * Generate core client classes?
+   *
+   * @default true
+   */
+  exportCore?: boolean;
+  /**
+   * @deprecated
+   *
+   * Custom client class name. Please note this option is deprecated and
+   * will be removed in favor of clients.
+   *
+   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
+   */
+  name?: string;
+  /**
+   * @deprecated
+   *
+   * Path to custom request file. Please note this option is deprecated and
+   * will be removed in favor of clients.
+   *
+   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-request
+   */
+  request?: string;
+  /**
+   * @deprecated
+   *
+   * Use options or arguments functions. Please note this option is deprecated and
+   * will be removed in favor of clients.
+   *
+   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
+   *
+   * @default true
+   */
+  useOptions?: boolean;
+}
+
+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<UserConfig['logs']>, object>;
     output: Extract<UserConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;
-    plugins: ArrayOfObjectsToObjectMap<ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, {
-        name: string;
-    }>, 'name'>;
-    watch: Extract<UserConfig['watch'], object>;
-};
+    plugins: ArrayOfObjectsToObjectMap<
+      ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
+      'name'
+    >;
+    watch: Extract<Required<UserConfig['watch']>, object>;
+  };
 
 interface Identifier {
     /**
@@ -7375,6 +7459,9 @@ interface Events {
         name: string;
         schema: IR.SchemaObject;
     }) => void;
+    server: (args: {
+        server: IR.ServerObject;
+    }) => void;
 }
 declare class IRContext<Spec extends Record<string, any> = any> {
     /**
@@ -7428,27 +7515,24 @@ declare class IRContext<Spec extends Record<string, any> = any> {
 
 type IRMediaType = 'form-data' | 'json' | 'text' | 'url-search-params';
 
+interface IRBodyObject {
+  mediaType: string;
+  /**
+   * Does body control pagination? We handle only simple values
+   * for now, up to 1 nested field.
+   */
+  pagination?: boolean | string;
+  required?: boolean;
+  schema: IRSchemaObject;
+  type?: IRMediaType;
+}
+
 interface IRComponentsObject {
   parameters?: Record<string, IRParameterObject>;
   requestBodies?: Record<string, IRRequestBodyObject>;
   schemas?: Record<string, IRSchemaObject>;
 }
 
-interface IRPathsObject {
-  [path: `/${string}`]: IRPathItemObject;
-}
-
-interface IRPathItemObject {
-  delete?: IROperationObject;
-  get?: IROperationObject;
-  head?: IROperationObject;
-  options?: IROperationObject;
-  patch?: IROperationObject;
-  post?: IROperationObject;
-  put?: IROperationObject;
-  trace?: IROperationObject;
-}
-
 interface IROperationObject {
   body?: IRBodyObject;
   deprecated?: boolean;
@@ -7459,24 +7543,11 @@ interface IROperationObject {
   path: keyof IRPathsObject;
   responses?: IRResponsesObject;
   security?: ReadonlyArray<IRSecurityObject>;
-  // TODO: parser - add more properties
-  // servers?: ReadonlyArray<ServerObject>;
+  servers?: ReadonlyArray<IRServerObject>;
   summary?: string;
   tags?: ReadonlyArray<string>;
 }
 
-interface IRBodyObject {
-  mediaType: string;
-  /**
-   * Does body control pagination? We handle only simple values
-   * for now, up to 1 nested field.
-   */
-  pagination?: boolean | string;
-  required?: boolean;
-  schema: IRSchemaObject;
-  type?: IRMediaType;
-}
-
 interface IRParametersObject {
   cookie?: Record<string, IRParameterObject>;
   header?: Record<string, IRParameterObject>;
@@ -7519,6 +7590,21 @@ interface IRParameterObject
     | 'spaceDelimited';
 }
 
+interface IRPathsObject {
+  [path: `/${string}`]: IRPathItemObject;
+}
+
+interface IRPathItemObject {
+  delete?: IROperationObject;
+  get?: IROperationObject;
+  head?: IROperationObject;
+  options?: IROperationObject;
+  patch?: IROperationObject;
+  post?: IROperationObject;
+  put?: IROperationObject;
+  trace?: IROperationObject;
+}
+
 interface IRRequestBodyObject
   extends Pick<JsonSchemaDraft2020_12, 'description'> {
   required?: boolean;
@@ -7613,9 +7699,12 @@ interface IRSchemaObject
 
 type IRSecurityObject = SecuritySchemeObject$2;
 
+type IRServerObject = ServerObject$1;
+
 interface IRModel {
   components?: IRComponentsObject;
   paths?: IRPathsObject;
+  servers?: ReadonlyArray<IRServerObject>;
 }
 
 declare namespace IR {
@@ -7633,8 +7722,14 @@ declare namespace IR {
   export type ResponsesObject = IRResponsesObject;
   export type SchemaObject = IRSchemaObject;
   export type SecurityObject = IRSecurityObject;
+  export type ServerObject = IRServerObject;
 }
 
+/**
+ * Default plugins used to generate artifacts if plugins aren't specified.
+ */
+declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
+
 declare namespace LegacyIR {
   export type LegacyOperation = Operation;
 }
@@ -7648,16 +7743,11 @@ declare const utils: {
 };
 
 /**
- * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
- * given language it will generate the client, including the typed models, validation schemas,
- * service layer, etc.
- * @param userConfig {@link UserConfig} passed to the `createClient()` method
- */
-declare function createClient(userConfig: UserConfig): Promise<ReadonlyArray<Client$1 | IR.Context>>;
-/**
- * Default plugins used to generate artifacts if plugins aren't specified.
+ * Generate a client from the provided configuration.
+ *
+ * @param userConfig User provided {@link UserConfig} configuration.
  */
-declare const defaultPlugins: readonly ["@hey-api/typescript", "@hey-api/sdk"];
+declare const createClient: (userConfig: UserConfig) => Promise<ReadonlyArray<Client$1 | IR.Context>>;
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */