@hey-api/openapi-ts 0.61.2 → 0.62.0

package/dist/index.d.cts

@@ -640,7 +640,7 @@ interface ExternalDocumentationObject$2 {
  *   type: integer
  * ```
  */
-interface HeaderObject$2 extends Omit<ParameterObject$2, 'in' | 'name'> {}
+type HeaderObject$2 = Omit<ParameterObject$2, 'in' | 'name'>;
 
 /**
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
@@ -1676,7 +1676,7 @@ interface ResponsesObject$2 {
  *
  * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions Specification Extensions}, though as noted, additional properties MAY omit the `x-` prefix within this object.
  */
-interface SchemaObject$2 extends JsonSchemaDraft2020_12 {}
+type SchemaObject$2 = JsonSchemaDraft2020_12;
 
 /**
  * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#componentsSecuritySchemes Security Schemes} under the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object Components Object}.
@@ -2483,7 +2483,6 @@ type JsonSchemaFormats$2 =
   | 'uri-reference'
   | 'uri-template'
   | 'uuid'
-  // eslint-disable-next-line @typescript-eslint/ban-types
   | (string & {});
 
 type JsonSchemaTypes$1 =
@@ -3444,7 +3443,6 @@ type JsonSchemaFormats$1 =
   | 'ipv4'
   | 'ipv6'
   | 'uri'
-  // eslint-disable-next-line @typescript-eslint/ban-types
   | (string & {});
 
 type JsonSchemaTypes =
@@ -5307,7 +5305,7 @@ interface ExternalDocumentationObject {
  *
  * TODO: examples
  */
-interface HeaderObject extends Omit<ParameterObject, 'in' | 'name'> {}
+type HeaderObject = Omit<ParameterObject, 'in' | 'name'>;
 
 /**
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
@@ -6331,11 +6329,7 @@ type OpenApiSchemaFormats =
   | 'date-time'
   | 'password';
 
-type Format =
-  | JsonSchemaFormats
-  | OpenApiSchemaFormats
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  | (string & {});
+type Format = JsonSchemaFormats | OpenApiSchemaFormats | (string & {});
 
 declare namespace OpenApi {
   export type V2_0_X = OpenApiV2_0_X;
@@ -6389,7 +6383,6 @@ type PluginNames =
   | 'fastify'
   | 'zod';
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 type AnyPluginName = PluginNames | (string & {});
 
 type PluginTag = 'transformer' | 'validator';
@@ -6401,8 +6394,6 @@ interface PluginContext {
 
 interface BaseConfig {
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Should the exports from the plugin's file be re-exported in the index
    * barrel file?
    */
@@ -6468,8 +6459,9 @@ declare namespace Plugin {
     Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
 
   /**
-   * Plugin implementation for legacy parser. Use only if you need to support
-   * OpenAPI 2.0 since that isn't supported by the experimental parser yet.
+   * @deprecated
+   *
+   * Plugin implementation for legacy parser.
    */
   export type LegacyHandler<Config extends BaseConfig> = (args: {
     client: Client$1;
@@ -6532,8 +6524,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   asClass?: boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Should the generated functions contain auth mechanisms? You may want to
    * disable this option if you're handling auth yourself or defining it
    * globally on the client and want to reduce the size of generated code.
@@ -6542,6 +6532,8 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   auth?: boolean;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Filter endpoints to be included in the generated SDK. The provided
@@ -6549,8 +6541,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * included in the output. The input pattern this string will be tested
    * against is `{method} {path}`. For example, you can match
    * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
-   *
-   * @deprecated
    */
   filter?: string;
   /**
@@ -6612,8 +6602,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   transformer?: '@hey-api/transformers' | boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Validate response data against schema before returning. This is useful
    * if you want to ensure the response conforms to a desired shape. However,
    * validation adds runtime overhead, so it's not recommended to use unless
@@ -6631,8 +6619,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Convert long integers into BigInt values?
    *
    * @default true
@@ -6662,8 +6648,6 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Defines casing of the enum keys. By default, we use `SCREAMING_SNAKE_CASE`.
    * This option has effect only when `enums` is defined.
    *
@@ -6671,8 +6655,6 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   enumsCase?: StringCase;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * By default, inline enums (enums not defined as reusable components in
    * the input file) are generated as inlined union types. You can set
    * `exportInlineEnums` to `true` to treat inline enums as reusable components.
@@ -6682,19 +6664,17 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   exportInlineEnums?: boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Defines casing of the identifiers. By default, we use `PascalCase`.
    *
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Include only types matching regular expression.
-   *
-   * @deprecated
    */
   include?: string;
   /**
@@ -6704,24 +6684,24 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   output?: string;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Use your preferred naming pattern
    *
    * @default 'preserve'
-   *
-   * @deprecated
    */
   style?: 'PascalCase' | 'preserve';
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Generate a tree of types containing all operations? It will be named
    * $OpenApiTs.
    *
    * @default false
-   *
-   * @deprecated
    */
   tree?: boolean;
 }
@@ -6917,12 +6897,6 @@ interface ClientConfig {
      * @default false
      */
     dryRun?: boolean;
-    /**
-     * Opt in to the experimental parser?
-     *
-     * @default false
-     */
-    experimentalParser?: 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
@@ -6932,8 +6906,6 @@ interface ClientConfig {
      */
     input: string | Record<string, unknown> | {
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Prevent parts matching the regular expression from being processed.
          * You can select both operations and components by reference within
          * the bundled input. In case of conflicts, `exclude` takes precedence
@@ -6945,8 +6917,6 @@ interface ClientConfig {
          */
         exclude?: string;
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Process only parts matching the regular expression. You can select both
          * operations and components by reference within the bundled input. In
          * case of conflicts, `exclude` takes precedence over `include`.
@@ -6999,8 +6969,6 @@ interface ClientConfig {
      */
     output: string | {
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Defines casing of the output fields. By default, we preserve `input`
          * values as data transforms incur a performance penalty at runtime.
          *
@@ -7042,70 +7010,77 @@ interface ClientConfig {
      */
     plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
     /**
-     * Manually set base in OpenAPI config instead of inferring from server value
+     * Regenerate the client when the input file changes?
      *
+     * @default false
+     */
+    watch?: boolean | number | {
+        /**
+         * Regenerate the client when the input file changes?
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * How often should we attempt to detect the input file change?
+         *
+         * @default 1000
+         */
+        interval?: number;
+    };
+    /**
      * @deprecated
+     *
+     * Manually set base in OpenAPI config instead of inferring from server value
      */
     base?: string;
     /**
-     * Generate core client classes?
+     * @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
-     *
-     * @deprecated
      */
     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
-     *
-     * @deprecated
      */
     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
      *
-     * @deprecated
-     *
      * @default true
      */
     useOptions?: boolean;
-    /**
-     * Regenerate the client when the input file changes?
-     *
-     * @default false
-     */
-    watch?: boolean | number | {
-        /**
-         * Regenerate the client when the input file changes?
-         *
-         * @default false
-         */
-        enabled?: boolean;
-        /**
-         * How often should we attempt to detect the input file change?
-         *
-         * @default 1000
-         */
-        interval?: number;
-    };
-}
-interface UserConfig extends ClientConfig {
 }
+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'], {

package/dist/index.d.ts

@@ -640,7 +640,7 @@ interface ExternalDocumentationObject$2 {
  *   type: integer
  * ```
  */
-interface HeaderObject$2 extends Omit<ParameterObject$2, 'in' | 'name'> {}
+type HeaderObject$2 = Omit<ParameterObject$2, 'in' | 'name'>;
 
 /**
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
@@ -1676,7 +1676,7 @@ interface ResponsesObject$2 {
  *
  * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions Specification Extensions}, though as noted, additional properties MAY omit the `x-` prefix within this object.
  */
-interface SchemaObject$2 extends JsonSchemaDraft2020_12 {}
+type SchemaObject$2 = JsonSchemaDraft2020_12;
 
 /**
  * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#componentsSecuritySchemes Security Schemes} under the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object Components Object}.
@@ -2483,7 +2483,6 @@ type JsonSchemaFormats$2 =
   | 'uri-reference'
   | 'uri-template'
   | 'uuid'
-  // eslint-disable-next-line @typescript-eslint/ban-types
   | (string & {});
 
 type JsonSchemaTypes$1 =
@@ -3444,7 +3443,6 @@ type JsonSchemaFormats$1 =
   | 'ipv4'
   | 'ipv6'
   | 'uri'
-  // eslint-disable-next-line @typescript-eslint/ban-types
   | (string & {});
 
 type JsonSchemaTypes =
@@ -5307,7 +5305,7 @@ interface ExternalDocumentationObject {
  *
  * TODO: examples
  */
-interface HeaderObject extends Omit<ParameterObject, 'in' | 'name'> {}
+type HeaderObject = Omit<ParameterObject, 'in' | 'name'>;
 
 /**
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
@@ -6331,11 +6329,7 @@ type OpenApiSchemaFormats =
   | 'date-time'
   | 'password';
 
-type Format =
-  | JsonSchemaFormats
-  | OpenApiSchemaFormats
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  | (string & {});
+type Format = JsonSchemaFormats | OpenApiSchemaFormats | (string & {});
 
 declare namespace OpenApi {
   export type V2_0_X = OpenApiV2_0_X;
@@ -6389,7 +6383,6 @@ type PluginNames =
   | 'fastify'
   | 'zod';
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 type AnyPluginName = PluginNames | (string & {});
 
 type PluginTag = 'transformer' | 'validator';
@@ -6401,8 +6394,6 @@ interface PluginContext {
 
 interface BaseConfig {
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Should the exports from the plugin's file be re-exported in the index
    * barrel file?
    */
@@ -6468,8 +6459,9 @@ declare namespace Plugin {
     Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
 
   /**
-   * Plugin implementation for legacy parser. Use only if you need to support
-   * OpenAPI 2.0 since that isn't supported by the experimental parser yet.
+   * @deprecated
+   *
+   * Plugin implementation for legacy parser.
    */
   export type LegacyHandler<Config extends BaseConfig> = (args: {
     client: Client$1;
@@ -6532,8 +6524,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   asClass?: boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Should the generated functions contain auth mechanisms? You may want to
    * disable this option if you're handling auth yourself or defining it
    * globally on the client and want to reduce the size of generated code.
@@ -6542,6 +6532,8 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   auth?: boolean;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Filter endpoints to be included in the generated SDK. The provided
@@ -6549,8 +6541,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * included in the output. The input pattern this string will be tested
    * against is `{method} {path}`. For example, you can match
    * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
-   *
-   * @deprecated
    */
   filter?: string;
   /**
@@ -6612,8 +6602,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    */
   transformer?: '@hey-api/transformers' | boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Validate response data against schema before returning. This is useful
    * if you want to ensure the response conforms to a desired shape. However,
    * validation adds runtime overhead, so it's not recommended to use unless
@@ -6631,8 +6619,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Convert long integers into BigInt values?
    *
    * @default true
@@ -6662,8 +6648,6 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Defines casing of the enum keys. By default, we use `SCREAMING_SNAKE_CASE`.
    * This option has effect only when `enums` is defined.
    *
@@ -6671,8 +6655,6 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   enumsCase?: StringCase;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * By default, inline enums (enums not defined as reusable components in
    * the input file) are generated as inlined union types. You can set
    * `exportInlineEnums` to `true` to treat inline enums as reusable components.
@@ -6682,19 +6664,17 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   exportInlineEnums?: boolean;
   /**
-   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-   *
    * Defines casing of the identifiers. By default, we use `PascalCase`.
    *
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Include only types matching regular expression.
-   *
-   * @deprecated
    */
   include?: string;
   /**
@@ -6704,24 +6684,24 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    */
   output?: string;
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Use your preferred naming pattern
    *
    * @default 'preserve'
-   *
-   * @deprecated
    */
   style?: 'PascalCase' | 'preserve';
   /**
+   * @deprecated
+   *
    * **This feature works only with the legacy parser**
    *
    * Generate a tree of types containing all operations? It will be named
    * $OpenApiTs.
    *
    * @default false
-   *
-   * @deprecated
    */
   tree?: boolean;
 }
@@ -6917,12 +6897,6 @@ interface ClientConfig {
      * @default false
      */
     dryRun?: boolean;
-    /**
-     * Opt in to the experimental parser?
-     *
-     * @default false
-     */
-    experimentalParser?: 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
@@ -6932,8 +6906,6 @@ interface ClientConfig {
      */
     input: string | Record<string, unknown> | {
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Prevent parts matching the regular expression from being processed.
          * You can select both operations and components by reference within
          * the bundled input. In case of conflicts, `exclude` takes precedence
@@ -6945,8 +6917,6 @@ interface ClientConfig {
          */
         exclude?: string;
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Process only parts matching the regular expression. You can select both
          * operations and components by reference within the bundled input. In
          * case of conflicts, `exclude` takes precedence over `include`.
@@ -6999,8 +6969,6 @@ interface ClientConfig {
      */
     output: string | {
         /**
-         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
-         *
          * Defines casing of the output fields. By default, we preserve `input`
          * values as data transforms incur a performance penalty at runtime.
          *
@@ -7042,70 +7010,77 @@ interface ClientConfig {
      */
     plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
     /**
-     * Manually set base in OpenAPI config instead of inferring from server value
+     * Regenerate the client when the input file changes?
      *
+     * @default false
+     */
+    watch?: boolean | number | {
+        /**
+         * Regenerate the client when the input file changes?
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * How often should we attempt to detect the input file change?
+         *
+         * @default 1000
+         */
+        interval?: number;
+    };
+    /**
      * @deprecated
+     *
+     * Manually set base in OpenAPI config instead of inferring from server value
      */
     base?: string;
     /**
-     * Generate core client classes?
+     * @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
-     *
-     * @deprecated
      */
     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
-     *
-     * @deprecated
      */
     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
      *
-     * @deprecated
-     *
      * @default true
      */
     useOptions?: boolean;
-    /**
-     * Regenerate the client when the input file changes?
-     *
-     * @default false
-     */
-    watch?: boolean | number | {
-        /**
-         * Regenerate the client when the input file changes?
-         *
-         * @default false
-         */
-        enabled?: boolean;
-        /**
-         * How often should we attempt to detect the input file change?
-         *
-         * @default 1000
-         */
-        interval?: number;
-    };
-}
-interface UserConfig extends ClientConfig {
 }
+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'], {