@hey-api/openapi-ts 0.69.0 → 0.69.2

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-DaUN4Gwe.cjs';
-export { i as initConfigs } from './types.d-DaUN4Gwe.cjs';
+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 '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-DaUN4Gwe.js';
-export { i as initConfigs } from './types.d-DaUN4Gwe.js';
+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 '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-ALAAQACG.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-7JYB3OMB.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
 //# sourceMappingURL=internal.js.map

package/dist/{types.d-DaUN4Gwe.d.cts → types.d-CuSvND4p.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;
@@ -6666,17 +6666,21 @@ interface Config$c extends Plugin.Name<'@hey-api/schemas'> {
    * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
    * valid JavaScript/TypeScript identifier, e.g. if your schema name is
    * "Foo-Bar", `name` value would be "FooBar".
+   *
+   * @default '{{name}}Schema'
    */
-  nameBuilder?: (
-    name: string,
-    schema:
-      | OpenApiSchema
-      | OpenApiSchema$1
-      | SchemaObject$1
-      | ReferenceObject
-      | SchemaObject
-      | SchemaObject$2,
-  ) => string;
+  nameBuilder?:
+    | string
+    | ((
+        name: string,
+        schema:
+          | OpenApiSchema
+          | OpenApiSchema$1
+          | SchemaObject$1
+          | ReferenceObject
+          | SchemaObject
+          | SchemaObject$2,
+      ) => string);
   /**
    * Name of the generated file.
    *
@@ -6764,7 +6768,7 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    *
    * @default '{{name}}Service'
    */
-  serviceNameBuilder?: string;
+  serviceNameBuilder?: string | ((name: string) => string);
   /**
    * Transform response data before returning. This is useful if you want to
    * convert for example ISO strings into Date objects. However, transformation
@@ -6795,8 +6799,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
@@ -6804,14 +6806,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';
@@ -6924,32 +6927,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;
@@ -7226,6 +7227,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**
@@ -7432,7 +7454,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**
    *
@@ -7441,6 +7471,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 {
@@ -7576,90 +7613,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<
@@ -7674,7 +7680,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']>;
@@ -7682,7 +7691,6 @@ type Config = Omit<
       ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
       'name'
     >;
-    watch: Extract<Required<UserConfig['watch']>, object>;
   };
 
 interface Identifier {

package/dist/{types.d-DaUN4Gwe.d.ts → types.d-CuSvND4p.d.ts}

@@ -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;
@@ -6666,17 +6666,21 @@ interface Config$c extends Plugin.Name<'@hey-api/schemas'> {
    * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
    * valid JavaScript/TypeScript identifier, e.g. if your schema name is
    * "Foo-Bar", `name` value would be "FooBar".
+   *
+   * @default '{{name}}Schema'
    */
-  nameBuilder?: (
-    name: string,
-    schema:
-      | OpenApiSchema
-      | OpenApiSchema$1
-      | SchemaObject$1
-      | ReferenceObject
-      | SchemaObject
-      | SchemaObject$2,
-  ) => string;
+  nameBuilder?:
+    | string
+    | ((
+        name: string,
+        schema:
+          | OpenApiSchema
+          | OpenApiSchema$1
+          | SchemaObject$1
+          | ReferenceObject
+          | SchemaObject
+          | SchemaObject$2,
+      ) => string);
   /**
    * Name of the generated file.
    *
@@ -6764,7 +6768,7 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
    *
    * @default '{{name}}Service'
    */
-  serviceNameBuilder?: string;
+  serviceNameBuilder?: string | ((name: string) => string);
   /**
    * Transform response data before returning. This is useful if you want to
    * convert for example ISO strings into Date objects. However, transformation
@@ -6795,8 +6799,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
@@ -6804,14 +6806,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';
@@ -6924,32 +6927,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;
@@ -7226,6 +7227,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**
@@ -7432,7 +7454,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**
    *
@@ -7441,6 +7471,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 {
@@ -7576,90 +7613,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<
@@ -7674,7 +7680,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']>;
@@ -7682,7 +7691,6 @@ type Config = Omit<
       ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
       'name'
     >;
-    watch: Extract<Required<UserConfig['watch']>, object>;
   };
 
 interface Identifier {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.69.0",
+  "version": "0.69.2",
   "description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
   "homepage": "https://heyapi.dev/",
   "repository": {
@@ -77,7 +77,9 @@
   },
   "dependencies": {
     "@hey-api/json-schema-ref-parser": "1.0.6",
+    "ansi-colors": "4.1.3",
     "c12": "2.0.1",
+    "color-support": "1.1.3",
     "commander": "13.0.0",
     "handlebars": "4.7.8"
   },
@@ -97,6 +99,7 @@
     "ts-node": "10.9.2",
     "tslib": "2.8.1",
     "typescript": "5.8.3",
+    "yaml": "2.8.0",
     "@config/vite-base": "0.0.1",
     "@hey-api/client-core": "0.1.4"
   },