@hey-api/openapi-ts 0.69.1 → 0.70.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-DewPnfre.cjs';
-export { i as initConfigs } from './types.d-DewPnfre.cjs';
+import { c as Config, I as IR, W as WatchValues } from './types.d-B4ySIeCs.cjs';
+export { i as initConfigs } from './types.d-B4ySIeCs.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-DewPnfre.js';
-export { i as initConfigs } from './types.d-DewPnfre.js';
+import { c as Config, I as IR, W as WatchValues } from './types.d-B4ySIeCs.js';
+export { i as initConfigs } from './types.d-B4ySIeCs.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-QYTRELTS.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
+import {createRequire}from'module';export{o as getSpec,x as initConfigs,r as parseOpenApiSpec}from'./chunk-LDP2PZAC.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
 //# sourceMappingURL=internal.js.map

package/dist/{types.d-DewPnfre.d.cts → types.d-B4ySIeCs.d.cts}

@@ -6491,9 +6491,9 @@ declare namespace Plugin {
     Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
 
   /**
-   * @deprecated
-   *
    * Plugin implementation for legacy parser.
+   *
+   * @deprecated
    */
   export type LegacyHandler<Config extends BaseConfig> = (args: {
     client: Client$1;
@@ -6760,6 +6760,14 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    * @default 'sdk'
    */
   output?: string;
+  /**
+   * **This feature works only with the Fetch client**
+   *
+   * Should we return only data or multiple fields (data, error, response, etc.)?
+   *
+   * @default 'fields'
+   */
+  responseStyle?: 'data' | 'fields';
   /**
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
@@ -6799,8 +6807,6 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
   // DEPRECATED OPTIONS BELOW
 
   /**
-   * @deprecated
-   *
    * **This feature works only with the legacy parser**
    *
    * Filter endpoints to be included in the generated SDK. The provided
@@ -6808,14 +6814,15 @@ interface Config$b 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
    */
   // eslint-disable-next-line typescript-sort-keys/interface
   filter?: string;
   /**
-   * @deprecated
-   *
    * Define shape of returned value from service calls
    *
+   * @deprecated
    * @default 'body'
    */
   response?: 'body' | 'response';
@@ -6928,32 +6935,30 @@ interface Config$9 extends Plugin.Name<'@hey-api/typescript'> {
   // DEPRECATED OPTIONS BELOW
 
   /**
-   * @deprecated
-   *
    * **This feature works only with the legacy parser**
    *
    * Include only types matching regular expression.
+   *
+   * @deprecated
    */
   // eslint-disable-next-line typescript-sort-keys/interface
   include?: string;
   /**
-   * @deprecated
-   *
    * **This feature works only with the legacy parser**
    *
    * Use your preferred naming pattern
    *
+   * @deprecated
    * @default 'preserve'
    */
   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.
    *
+   * @deprecated
    * @default false
    */
   tree?: boolean;
@@ -7230,6 +7235,27 @@ type StringCase =
   | '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**
@@ -7436,7 +7462,15 @@ interface Input {
    * the first match will be returned.
    */
   tags?: ReadonlyArray<string>;
-
+  /**
+   * **This is an experimental feature.**
+   *
+   * Validate the input before generating output? This is an experimental,
+   * lightweight feature and support will be added on an ad hoc basis.
+   *
+   * @default false
+   */
+  validate_EXPERIMENTAL?: boolean;
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7445,6 +7479,13 @@ interface Input {
    * the value.
    */
   version?: string;
+  /**
+   * 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 | Watch;
 }
 
 interface UserConfig {
@@ -7580,90 +7621,59 @@ interface UserConfig {
    * @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?
-         *
-         * @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;
-      };
 
   // DEPRECATED OPTIONS BELOW
 
   /**
-   * @deprecated
-   *
    * Manually set base in OpenAPI config instead of inferring from server value
+   *
+   * @deprecated
    */
   // eslint-disable-next-line typescript-sort-keys/interface
   base?: string;
   /**
-   * @deprecated
-   *
    * Opt in to the experimental parser?
    *
+   * @deprecated
    * @default true
    */
   experimentalParser?: boolean;
   /**
-   * @deprecated
-   *
    * Generate core client classes?
    *
+   * @deprecated
    * @default true
    */
   exportCore?: boolean;
   /**
-   * @deprecated
-   *
    * Custom client class name. Please note this option is deprecated and
    * will be removed in favor of clients.
    *
+   * @deprecated
    * @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.
    *
+   * @deprecated
    * @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
-   *
+   * @deprecated
    * @default true
+   * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
    */
   useOptions?: boolean;
+  /**
+   * @deprecated use `input.watch` instead
+   */
+  watch?: boolean | number | Watch;
 }
 
 type Config = Omit<
@@ -7678,7 +7688,10 @@ type Config = Omit<
   | 'watch'
 > &
   Pick<UserConfig, 'base' | 'name' | 'request'> & {
-    input: Omit<Input, 'path'> & Pick<Required<Input>, 'path'>;
+    input: Omit<Input, 'path' | 'validate_EXPERIMENTAL' | 'watch'> &
+      Pick<Required<Input>, 'path' | 'validate_EXPERIMENTAL'> & {
+        watch: Extract<Required<Required<Input>['watch']>, object>;
+      };
     logs: Extract<Required<UserConfig['logs']>, object>;
     output: Extract<UserConfig['output'], object>;
     pluginOrder: ReadonlyArray<ClientPlugins['name']>;
@@ -7686,7 +7699,6 @@ type Config = Omit<
       ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
       'name'
     >;
-    watch: Extract<Required<UserConfig['watch']>, object>;
   };
 
 interface Identifier {
@@ -7699,30 +7711,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 {
     /**
@@ -7736,7 +7762,7 @@ declare class TypeScriptFile {
     private _items;
     private _name;
     private _path;
-    namespaces: Namespaces;
+    identifiers: Identifiers;
     /**
      * Path relative to the client output root.
      */
@@ -7763,12 +7789,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
@@ -7798,6 +7824,7 @@ interface EnsureUniqueIdentifierData {
     case: StringCase | undefined;
     count?: number;
     create?: boolean;
+    identifiers: Identifiers;
     /**
      * Transforms name obtained from `$ref` before it's passed to `stringCase()`.
      */