@hey-api/openapi-ts 0.69.2 → 0.71.0

package/dist/internal.d.cts

@@ -1,6 +1,6 @@
 import { JSONSchema } from '@hey-api/json-schema-ref-parser';
-import { c as Config, I as IR, W as WatchValues } from './types.d-CuSvND4p.cjs';
-export { i as initConfigs } from './types.d-CuSvND4p.cjs';
+import { e as Config, I as IR, W as WatchValues } from './types.d-Dy-fBrKf.cjs';
+export { i as initConfigs } from './types.d-Dy-fBrKf.cjs';
 import 'node:fs';
 import 'typescript';
 

package/dist/internal.d.ts

@@ -1,6 +1,6 @@
 import { JSONSchema } from '@hey-api/json-schema-ref-parser';
-import { c as Config, I as IR, W as WatchValues } from './types.d-CuSvND4p.js';
-export { i as initConfigs } from './types.d-CuSvND4p.js';
+import { e as Config, I as IR, W as WatchValues } from './types.d-Dy-fBrKf.js';
+export { i as initConfigs } from './types.d-Dy-fBrKf.js';
 import 'node:fs';
 import 'typescript';
 

package/dist/internal.js

@@ -1,2 +1,2 @@
-import {createRequire}from'module';export{o as getSpec,x as initConfigs,r as parseOpenApiSpec}from'./chunk-7JYB3OMB.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
+import {createRequire}from'module';export{p as getSpec,z as initConfigs,u as parseOpenApiSpec}from'./chunk-LBEWMSUW.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
 //# sourceMappingURL=internal.js.map

package/dist/{types.d-CuSvND4p.d.cts → types.d-Dy-fBrKf.d.cts}

@@ -5050,6 +5050,10 @@ interface XMLObject$1 {
   wrapped?: boolean;
 }
 
+interface OpenApiV2_0_XTypes {
+    SchemaObject: SchemaObject$1;
+}
+
 /**
  * This is the root object of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#openapi-description OpenAPI Description}.
  *
@@ -6331,6 +6335,22 @@ type OpenApiSchemaFormats =
 
 type Format = JsonSchemaFormats | OpenApiSchemaFormats | (string & {});
 
+interface OpenApiV3_0_XTypes {
+    ParameterObject: ParameterObject;
+    ReferenceObject: ReferenceObject;
+    RequestBodyObject: RequestBodyObject;
+    ResponseObject: ResponseObject;
+    SchemaObject: SchemaObject;
+}
+
+interface OpenApiV3_1_XTypes {
+    ParameterObject: ParameterObject$2;
+    ReferenceObject: ReferenceObject$2;
+    RequestBodyObject: RequestBodyObject$1;
+    ResponseObject: ResponseObject$2;
+    SchemaObject: SchemaObject$2;
+}
+
 declare namespace OpenApi {
   export type V2_0_X = OpenApiV2_0_X;
 
@@ -6339,6 +6359,44 @@ declare namespace OpenApi {
   export type V3_1_X = OpenApiV3_1_X;
 }
 
+declare namespace OpenApiParameterObject {
+  export type V3_0_X =
+    | OpenApiV3_0_XTypes['ParameterObject']
+    | OpenApiV3_0_XTypes['ReferenceObject'];
+
+  export type V3_1_X =
+    | OpenApiV3_1_XTypes['ParameterObject']
+    | OpenApiV3_1_XTypes['ReferenceObject'];
+}
+
+declare namespace OpenApiRequestBodyObject {
+  export type V3_0_X =
+    | OpenApiV3_0_XTypes['RequestBodyObject']
+    | OpenApiV3_0_XTypes['ReferenceObject'];
+
+  export type V3_1_X =
+    | OpenApiV3_1_XTypes['RequestBodyObject']
+    | OpenApiV3_1_XTypes['ReferenceObject'];
+}
+
+declare namespace OpenApiResponseObject {
+  export type V3_0_X =
+    | OpenApiV3_0_XTypes['ResponseObject']
+    | OpenApiV3_0_XTypes['ReferenceObject'];
+
+  export type V3_1_X =
+    | OpenApiV3_1_XTypes['ResponseObject']
+    | OpenApiV3_1_XTypes['ReferenceObject'];
+}
+
+declare namespace OpenApiSchemaObject {
+  export type V2_0_X = OpenApiV2_0_XTypes['SchemaObject'];
+
+  export type V3_0_X = OpenApiV3_0_XTypes['SchemaObject'];
+
+  export type V3_1_X = OpenApiV3_1_XTypes['SchemaObject'];
+}
+
 interface Operation extends Omit<Operation$1, 'tags'> {
   service: string;
 }
@@ -6676,10 +6734,10 @@ interface Config$c extends Plugin.Name<'@hey-api/schemas'> {
         schema:
           | OpenApiSchema
           | OpenApiSchema$1
-          | SchemaObject$1
-          | ReferenceObject
-          | SchemaObject
-          | SchemaObject$2,
+          | OpenApiV2_0_XTypes['SchemaObject']
+          | OpenApiV3_0_XTypes['ReferenceObject']
+          | OpenApiV3_0_XTypes['SchemaObject']
+          | OpenApiV3_1_XTypes['SchemaObject'],
       ) => string);
   /**
    * Name of the generated file.
@@ -6699,9 +6757,9 @@ interface Config$c extends Plugin.Name<'@hey-api/schemas'> {
 
 interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
   /**
-   * Group operation methods into classes? When enabled, you can
-   * select which classes to export with `sdk.include` and/or
-   * transform their names with `sdk.serviceNameBuilder`.
+   * Group operation methods into classes? When enabled, you can select which
+   * classes to export with `sdk.include` and/or transform their names with
+   * `sdk.classNameBuilder`.
    *
    * Note that by enabling this option, your SDKs will **NOT**
    * support {@link https://developer.mozilla.org/docs/Glossary/Tree_shaking tree-shaking}.
@@ -6718,6 +6776,13 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   auth?: boolean;
+  /**
+   * Customize the generated class names. The name variable is obtained from
+   * your OpenAPI specification tags or `instance` value.
+   *
+   * This option has no effect if `sdk.asClass` is `false`.
+   */
+  classNameBuilder?: string | ((name: string) => string);
   /**
    * 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.
@@ -6743,6 +6808,14 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    * This option has no effect if `sdk.asClass` is `false`.
    */
   include?: string;
+  /**
+   * Set `instance` to create an instantiable SDK. Using `true` will use the
+   * default instance name; in practice, you want to define your own by passing
+   * a string value.
+   *
+   * @default false
+   */
+  instance?: string | boolean;
   /**
    * Customise the name of methods within the service. By default, {@link IR.OperationObject.id} or {@link Operation.name} is used.
    */
@@ -6761,14 +6834,13 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    */
   output?: string;
   /**
-   * Customize the generated service class names. The name variable is
-   * obtained from your OpenAPI specification tags.
+   * **This feature works only with the Fetch client**
    *
-   * This option has no effect if `sdk.asClass` is `false`.
+   * Should we return only data or multiple fields (data, error, response, etc.)?
    *
-   * @default '{{name}}Service'
+   * @default 'fields'
    */
-  serviceNameBuilder?: string | ((name: string) => string);
+  responseStyle?: 'data' | 'fields';
   /**
    * Transform response data before returning. This is useful if you want to
    * convert for example ISO strings into Date objects. However, transformation
@@ -7216,38 +7288,6 @@ type UserPlugins = Plugin.UserConfig<Config$i> | Plugin.UserConfig<Config$l> | P
  */
 type ClientPlugins = Plugin.Config<Config$i> | Plugin.Config<Config$l> | Plugin.Config<Config$k> | Plugin.Config<Config$j> | 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$4> | Plugin.Config<Config$8> | Plugin.Config<Config$7> | Plugin.Config<Config$6> | Plugin.Config<Config$5> | 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';
-
-interface Watch {
-  /**
-   * Regenerate the client when the input file changes?
-   *
-   * @default false
-   */
-  enabled?: boolean;
-  /**
-   * How often should we attempt to detect the input file change? (in ms)
-   *
-   * @default 1000
-   */
-  interval?: number;
-  /**
-   * How long will we wait before the request times out?
-   *
-   * @default 60_000
-   */
-  timeout?: number;
-}
-
 interface Input {
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
@@ -7283,136 +7323,7 @@ interface Input {
    * Filters can be used to select a subset of your input before it's processed
    * by plugins.
    */
-  filters?: {
-    /**
-     * Include deprecated resources in the output?
-     *
-     * @default true
-     */
-    deprecated?: boolean;
-    operations?: {
-      /**
-       * Prevent operations matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['GET /api/v1/foo']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only operations matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['GET /api/v1/foo']
-       */
-      include?: ReadonlyArray<string>;
-    };
-    /**
-     * Keep reusable components without any references in the output? By
-     * default, we exclude orphaned resources.
-     *
-     * @default false
-     */
-    orphans?: boolean;
-    parameters?: {
-      /**
-       * Prevent parameters matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['QueryParam']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only parameters matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['QueryParam']
-       */
-      include?: ReadonlyArray<string>;
-    };
-    /**
-     * Should we preserve the key order when overwriting your input? This
-     * option is disabled by default to improve performance.
-     *
-     * @default false
-     */
-    preserveOrder?: boolean;
-    requestBodies?: {
-      /**
-       * Prevent request bodies matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only request bodies matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      include?: ReadonlyArray<string>;
-    };
-    responses?: {
-      /**
-       * Prevent responses matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only responses matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      include?: ReadonlyArray<string>;
-    };
-    schemas?: {
-      /**
-       * Prevent schemas matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only schemas matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['Foo']
-       */
-      include?: ReadonlyArray<string>;
-    };
-    tags?: {
-      /**
-       * Prevent tags matching the `exclude` filters from being processed.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['foo']
-       */
-      exclude?: ReadonlyArray<string>;
-      /**
-       * Process only tags matching the `include` filters.
-       *
-       * In case of conflicts, `exclude` takes precedence over `include`.
-       *
-       * @example ['foo']
-       */
-      include?: ReadonlyArray<string>;
-    };
-  };
+  filters?: Filters;
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7420,7 +7331,7 @@ interface Input {
    */
   organization?: string;
   /**
-   * Pagination configuration
+   * Pagination configuration.
    */
   pagination?: {
     /**
@@ -7431,6 +7342,11 @@ interface Input {
      */
     keywords?: ReadonlyArray<string>;
   };
+  /**
+   * Custom input transformations to execute before parsing. This allows you
+   * to modify, fix, or enhance input definitions before code generation.
+   */
+  patch?: Patch;
   /**
    * 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
@@ -7480,6 +7396,229 @@ interface Input {
   watch?: boolean | number | Watch;
 }
 
+interface Filters {
+  /**
+   * Include deprecated resources in the output?
+   *
+   * @default true
+   */
+  deprecated?: boolean;
+  operations?: {
+    /**
+     * Prevent operations matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['GET /api/v1/foo']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only operations matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['GET /api/v1/foo']
+     */
+    include?: ReadonlyArray<string>;
+  };
+  /**
+   * Keep reusable components without any references in the output? By
+   * default, we exclude orphaned resources.
+   *
+   * @default false
+   */
+  orphans?: boolean;
+  parameters?: {
+    /**
+     * Prevent parameters matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['QueryParam']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only parameters matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['QueryParam']
+     */
+    include?: ReadonlyArray<string>;
+  };
+  /**
+   * Should we preserve the key order when overwriting your input? This
+   * option is disabled by default to improve performance.
+   *
+   * @default false
+   */
+  preserveOrder?: boolean;
+  requestBodies?: {
+    /**
+     * Prevent request bodies matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only request bodies matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    include?: ReadonlyArray<string>;
+  };
+  responses?: {
+    /**
+     * Prevent responses matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only responses matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    include?: ReadonlyArray<string>;
+  };
+  schemas?: {
+    /**
+     * Prevent schemas matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only schemas matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['Foo']
+     */
+    include?: ReadonlyArray<string>;
+  };
+  tags?: {
+    /**
+     * Prevent tags matching the `exclude` filters from being processed.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['foo']
+     */
+    exclude?: ReadonlyArray<string>;
+    /**
+     * Process only tags matching the `include` filters.
+     *
+     * In case of conflicts, `exclude` takes precedence over `include`.
+     *
+     * @example ['foo']
+     */
+    include?: ReadonlyArray<string>;
+  };
+}
+
+interface Patch {
+  parameters?: Record<
+    string,
+    (
+      parameter: OpenApiParameterObject.V3_0_X | OpenApiParameterObject.V3_1_X,
+    ) => void
+  >;
+  requestBodies?: Record<
+    string,
+    (
+      requestBody:
+        | OpenApiRequestBodyObject.V3_0_X
+        | OpenApiRequestBodyObject.V3_1_X,
+    ) => void
+  >;
+  responses?: Record<
+    string,
+    (
+      response: OpenApiResponseObject.V3_0_X | OpenApiResponseObject.V3_1_X,
+    ) => void
+  >;
+  /**
+   * Each function receives the schema object to be modified in place. Common
+   * use cases include fixing incorrect data types, removing unwanted
+   * properties, adding missing fields, or standardizing date/time formats.
+   *
+   * @example
+   * ```js
+   * schemas: {
+   *   Foo: (schema) => {
+   *     // convert date-time format to timestamp
+   *     delete schema.properties.updatedAt.format;
+   *     schema.properties.updatedAt.type = 'number';
+   *   },
+   *   Bar: (schema) => {
+   *     // add missing property
+   *     schema.properties.metadata = {
+   *       additionalProperties: true,
+   *       type: 'object',
+   *     };
+   *     schema.required = ['metadata'];
+   *   },
+   *   Baz: (schema) => {
+   *     // remove property
+   *     delete schema.properties.internalField;
+   *   }
+   * }
+   * ```
+   */
+  schemas?: Record<
+    string,
+    (
+      schema:
+        | OpenApiSchemaObject.V2_0_X
+        | OpenApiSchemaObject.V3_0_X
+        | OpenApiSchemaObject.V3_1_X,
+    ) => void
+  >;
+}
+
+interface Watch {
+  /**
+   * Regenerate the client when the input file changes?
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * How often should we attempt to detect the input file change? (in ms)
+   *
+   * @default 1000
+   */
+  interval?: number;
+  /**
+   * How long will we wait before the request times out?
+   *
+   * @default 60_000
+   */
+  timeout?: number;
+}
+
+type Formatters = 'biome' | 'prettier';
+
+type Linters = 'biome' | 'eslint' | 'oxlint';
+
+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
@@ -7703,30 +7842,44 @@ interface Identifier {
      */
     name: string | false;
 }
-type Namespace = Record<string, Pick<Identifier, 'name'> & {
+type NamespaceEntry = Pick<Identifier, 'name'> & {
     /**
      * Ref to the type in OpenAPI specification.
      */
     $ref: string;
-}>;
-interface Namespaces {
+};
+type Identifiers = Record<string, {
+    /**
+     * TypeScript enum only namespace.
+     *
+     * @example
+     * ```ts
+     * export enum Foo = {
+     *   FOO = 'foo'
+     * }
+     * ```
+     */
+    enum?: Record<string, NamespaceEntry>;
     /**
      * Type namespace. Types, interfaces, and type aliases exist here.
+     *
      * @example
      * ```ts
      * export type Foo = string;
      * ```
      */
-    type: Namespace;
+    type?: Record<string, NamespaceEntry>;
     /**
      * Value namespace. Variables, functions, classes, and constants exist here.
+     *
      * @example
      * ```js
      * export const foo = '';
      * ```
      */
-    value: Namespace;
-}
+    value?: Record<string, NamespaceEntry>;
+}>;
+type Namespace = keyof Identifiers[keyof Identifiers];
 type FileImportResult = Pick<ImportExportItemObject, 'asType' | 'name'>;
 declare class TypeScriptFile {
     /**
@@ -7740,7 +7893,7 @@ declare class TypeScriptFile {
     private _items;
     private _name;
     private _path;
-    namespaces: Namespaces;
+    identifiers: Identifiers;
     /**
      * Path relative to the client output root.
      */
@@ -7767,12 +7920,12 @@ declare class TypeScriptFile {
      * we want to avoid attempting to create since we know it won't happen.
      */
     blockIdentifier({ $ref, namespace, }: Pick<EnsureUniqueIdentifierData, '$ref'> & {
-        namespace: keyof Namespaces;
+        namespace: Namespace;
     }): Identifier;
     get exportFromIndex(): boolean;
     get id(): string;
-    identifier({ namespace, ...args }: Omit<EnsureUniqueIdentifierData, 'case' | 'namespace'> & {
-        namespace: keyof Namespaces;
+    identifier(args: Pick<EnsureUniqueIdentifierData, '$ref' | 'count' | 'create' | 'nameTransformer'> & {
+        namespace: Namespace;
     }): Identifier;
     /**
      * Adds an import to the provided module. Handles duplication, returns added
@@ -7802,6 +7955,7 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    identifiers: Identifiers;
     /**
      * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
      */
@@ -8168,4 +8322,4 @@ interface WatchValues {
   lastValue?: string;
 }
 
-export { type Client$1 as C, IR as I, LegacyIR as L, OpenApi as O, type PluginHandler as P, type StringCase as S, type UserConfig as U, type WatchValues as W, Client as a, Plugin as b, type Config as c, defaultPlugins as d, initConfigs as i };
+export { type Client$1 as C, IR as I, LegacyIR as L, OpenApi as O, type PluginHandler as P, type StringCase as S, type UserConfig as U, type WatchValues as W, OpenApiSchemaObject as a, Client as b, Plugin as c, defaultPlugins as d, type Config as e, initConfigs as i };