@hey-api/openapi-ts 0.63.1 → 0.64.0

package/dist/index.d.cts

@@ -6441,41 +6441,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 +6467,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 +6498,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 +6509,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 +6520,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 +6594,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,11 +7018,11 @@ 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';
@@ -7375,6 +7400,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 +7456,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 +7484,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 +7531,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 +7640,12 @@ interface IRSchemaObject
 
 type IRSecurityObject = SecuritySchemeObject$2;
 
+type IRServerObject = ServerObject$1;
+
 interface IRModel {
   components?: IRComponentsObject;
   paths?: IRPathsObject;
+  servers?: ReadonlyArray<IRServerObject>;
 }
 
 declare namespace IR {
@@ -7633,6 +7663,7 @@ declare namespace IR {
   export type ResponsesObject = IRResponsesObject;
   export type SchemaObject = IRSchemaObject;
   export type SecurityObject = IRSecurityObject;
+  export type ServerObject = IRServerObject;
 }
 
 declare namespace LegacyIR {

package/dist/index.d.ts

@@ -6441,41 +6441,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 +6467,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 +6498,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 +6509,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 +6520,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 +6594,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,11 +7018,11 @@ 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';
@@ -7375,6 +7400,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 +7456,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 +7484,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 +7531,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 +7640,12 @@ interface IRSchemaObject
 
 type IRSecurityObject = SecuritySchemeObject$2;
 
+type IRServerObject = ServerObject$1;
+
 interface IRModel {
   components?: IRComponentsObject;
   paths?: IRPathsObject;
+  servers?: ReadonlyArray<IRServerObject>;
 }
 
 declare namespace IR {
@@ -7633,6 +7663,7 @@ declare namespace IR {
   export type ResponsesObject = IRResponsesObject;
   export type SchemaObject = IRSchemaObject;
   export type SecurityObject = IRSecurityObject;
+  export type ServerObject = IRServerObject;
 }
 
 declare namespace LegacyIR {