@hey-api/openapi-ts 0.79.1 → 0.80.0

package/dist/internal.d.cts

@@ -1,5 +1,6 @@
-import { k as Config, c as IR, U as UserConfig, W as WatchValues } from './types.d-BRYhp7DX.cjs';
+import { k as Config, c as IR, U as UserConfig, W as WatchValues } from './types.d-CXdSuWix.cjs';
 import { JSONSchema } from '@hey-api/json-schema-ref-parser';
+import 'semver';
 import 'node:fs';
 import 'typescript';
 
@@ -8,18 +9,22 @@ import 'typescript';
  * Parse the resolved OpenAPI specification. This will populate and return
  * `context` with intermediate representation obtained from the parsed spec.
  */
-declare const parseOpenApiSpec: ({ config, spec, }: {
+declare const parseOpenApiSpec: ({ config, dependencies, spec, }: {
     config: Config;
+    dependencies: Record<string, string>;
     spec: unknown;
 }) => IR.Context | undefined;
 
 /**
  * @internal
  */
-declare const initConfigs: (userConfig: UserConfig | undefined) => Promise<ReadonlyArray<{
-    config: Config;
-    errors: ReadonlyArray<Error>;
-}>>;
+declare const initConfigs: (userConfig: UserConfig | undefined) => Promise<{
+    dependencies: Record<string, string>;
+    results: ReadonlyArray<{
+        config: Config;
+        errors: ReadonlyArray<Error>;
+    }>;
+}>;
 
 interface SpecResponse {
     data: JSONSchema;

package/dist/internal.d.ts

@@ -1,5 +1,6 @@
-import { k as Config, c as IR, U as UserConfig, W as WatchValues } from './types.d-BRYhp7DX.js';
+import { k as Config, c as IR, U as UserConfig, W as WatchValues } from './types.d-CXdSuWix.js';
 import { JSONSchema } from '@hey-api/json-schema-ref-parser';
+import 'semver';
 import 'node:fs';
 import 'typescript';
 
@@ -8,18 +9,22 @@ import 'typescript';
  * Parse the resolved OpenAPI specification. This will populate and return
  * `context` with intermediate representation obtained from the parsed spec.
  */
-declare const parseOpenApiSpec: ({ config, spec, }: {
+declare const parseOpenApiSpec: ({ config, dependencies, spec, }: {
     config: Config;
+    dependencies: Record<string, string>;
     spec: unknown;
 }) => IR.Context | undefined;
 
 /**
  * @internal
  */
-declare const initConfigs: (userConfig: UserConfig | undefined) => Promise<ReadonlyArray<{
-    config: Config;
-    errors: ReadonlyArray<Error>;
-}>>;
+declare const initConfigs: (userConfig: UserConfig | undefined) => Promise<{
+    dependencies: Record<string, string>;
+    results: ReadonlyArray<{
+        config: Config;
+        errors: ReadonlyArray<Error>;
+    }>;
+}>;
 
 interface SpecResponse {
     data: JSONSchema;

package/dist/internal.js

@@ -1,2 +1,2 @@
-import {createRequire}from'module';export{J as getSpec,I as initConfigs,G as parseOpenApiSpec}from'./chunk-H4ADXQ4D.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
+import {createRequire}from'module';export{J as getSpec,I as initConfigs,G as parseOpenApiSpec}from'./chunk-AMRI65AJ.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
 //# sourceMappingURL=internal.js.map

package/dist/{types.d-BRYhp7DX.d.cts → types.d-CXdSuWix.d.cts}

@@ -1,3 +1,4 @@
+import { SemVer, RangeOptions } from 'semver';
 import fs from 'node:fs';
 import ts__default from 'typescript';
 
@@ -2494,6 +2495,28 @@ type JsonSchemaTypes$1 =
   | 'object'
   | 'string';
 
+type Package = {
+    /**
+     * Get the installed version of a package.
+     * @param name The name of the package to get the version for.
+     * @returns A SemVer object containing version information, or undefined if the package is not installed
+     *         or the version string is invalid.
+     */
+    getVersion: (name: string) => SemVer | undefined;
+    /**
+     * Check if a given package is installed in the project.
+     * @param name The name of the package to check.
+     */
+    isInstalled: (name: string) => boolean;
+    /**
+     * Check if the installed version of a package or a given SemVer object satisfies a semver range.
+     * @param nameOrVersion The name of the package to check, or a SemVer object.
+     * @param range The semver range to check against.
+     * @returns True if the version satisfies the range, false otherwise.
+     */
+    satisfies: (nameOrVersion: string | SemVer, range: string, optionsOrLoose?: boolean | RangeOptions) => boolean;
+};
+
 interface ImportExportItemObject<Name extends string | undefined = string | undefined, Alias extends string | undefined = undefined> {
     alias?: Alias;
     asType?: boolean;
@@ -7676,6 +7699,13 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
     private handler;
     name: T['resolvedConfig']['name'];
     output: Required<T['config']>['output'];
+    /**
+     * The package metadata and utilities for the current context, constructed
+     * from the provided dependencies. Used for managing package-related
+     * information such as name, version, and dependency resolution during
+     * code generation.
+     */
+    package: IR.Context['package'];
     constructor(props: Pick<Required<Plugin.Config<T>>, 'config' | 'dependencies' | 'handler'> & {
         api?: T['api'];
         context: IR.Context<OpenApi$3.V2_0_X | OpenApi$3.V3_0_X | OpenApi$3.V3_1_X>;
@@ -7756,7 +7786,8 @@ type AnyPluginName = PluginNames | (string & {});
 
 type PluginTag = 'client' | 'transformer' | 'validator';
 
-interface PluginContext {
+type PluginContext = {
+  package: Package;
   pluginByTag: <T extends AnyPluginName | boolean = AnyPluginName>(
     tag: PluginTag,
     props?: {
@@ -7765,7 +7796,7 @@ interface PluginContext {
     },
   ) => Exclude<T, boolean> | undefined;
   valueToObject: ValueToObject;
-}
+};
 
 type BaseApi = Record<string, unknown>;
 
@@ -8851,10 +8882,14 @@ type Config$7 = Plugin.Name<'@hey-api/typescript'> & {
   tree: boolean;
 };
 
+interface PluginState {
+  usedTypeIDs: Set<string>;
+}
+
 type HeyApiTypeScriptPlugin = DefinePlugin<UserConfig$8, Config$7, Api$2>;
 
 type OnRef = (id: string) => void;
-declare const schemaToType: ({ onRef, plugin, schema, }: {
+declare const schemaToType: ({ onRef, plugin, schema, state, }: {
     /**
      * Callback that can be used to perform side-effects when we encounter a
      * reference. For example, we might want to import the referenced type.
@@ -8862,6 +8897,7 @@ declare const schemaToType: ({ onRef, plugin, schema, }: {
     onRef: OnRef | undefined;
     plugin: HeyApiTypeScriptPlugin["Instance"];
     schema: IR.SchemaObject;
+    state: PluginState;
 }) => ts__default.TypeNode;
 
 type GetIdArgs$1 = {
@@ -11062,6 +11098,17 @@ type UserConfig = Plugin.Name<'zod'> & {
    * @default true
    */
   comments?: boolean;
+  /**
+   * The compatibility version to target for generated output.
+   *
+   * Can be:
+   * - `4`: [Zod 4](https://zod.dev/packages/zod) (default).
+   * - `3`: [Zod 3](https://v3.zod.dev/).
+   * - `'mini'`: [Zod Mini](https://zod.dev/packages/mini).
+   *
+   * @default 4
+   */
+  compatibilityVersion?: 3 | 4 | 'mini';
   /**
    * Configuration for date handling in generated Zod schemas.
    *
@@ -11383,6 +11430,17 @@ type Config = Plugin.Name<'zod'> & {
    * @default true
    */
   comments: boolean;
+  /**
+   * The compatibility version to target for generated output.
+   *
+   * Can be:
+   * - `4`: [Zod 4](https://zod.dev/packages/zod) (default).
+   * - `3`: [Zod 3](https://v3.zod.dev/).
+   * - `'mini'`: [Zod Mini](https://zod.dev/packages/mini).
+   *
+   * @default 4
+   */
+  compatibilityVersion: 3 | 4 | 'mini';
   /**
    * Configuration for date handling in generated Zod schemas.
    *
@@ -11703,6 +11761,13 @@ declare class IRContext<Spec extends Record<string, any> = any> {
      * Intermediate representation model obtained from `spec`.
      */
     ir: IR.Model;
+    /**
+     * The package metadata and utilities for the current context, constructed
+     * from the provided dependencies. Used for managing package-related
+     * information such as name, version, and dependency resolution during
+     * code generation.
+     */
+    package: Package;
     /**
      * A map of registered plugin instances, keyed by plugin name. Plugins are
      * registered through the `registerPlugin` method and can be accessed by
@@ -11713,8 +11778,9 @@ declare class IRContext<Spec extends Record<string, any> = any> {
      * Resolved specification from `input`.
      */
     spec: Spec;
-    constructor({ config, spec }: {
+    constructor({ config, dependencies, spec, }: {
         config: Config$9;
+        dependencies: Record<string, string>;
         spec: Spec;
     });
     /**
@@ -11889,6 +11955,7 @@ interface IRSchemaObject
     | 'pattern'
     | 'required'
     | 'title'
+    | 'example'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be

package/dist/{types.d-BRYhp7DX.d.ts → types.d-CXdSuWix.d.ts}

@@ -1,3 +1,4 @@
+import { SemVer, RangeOptions } from 'semver';
 import fs from 'node:fs';
 import ts__default from 'typescript';
 
@@ -2494,6 +2495,28 @@ type JsonSchemaTypes$1 =
   | 'object'
   | 'string';
 
+type Package = {
+    /**
+     * Get the installed version of a package.
+     * @param name The name of the package to get the version for.
+     * @returns A SemVer object containing version information, or undefined if the package is not installed
+     *         or the version string is invalid.
+     */
+    getVersion: (name: string) => SemVer | undefined;
+    /**
+     * Check if a given package is installed in the project.
+     * @param name The name of the package to check.
+     */
+    isInstalled: (name: string) => boolean;
+    /**
+     * Check if the installed version of a package or a given SemVer object satisfies a semver range.
+     * @param nameOrVersion The name of the package to check, or a SemVer object.
+     * @param range The semver range to check against.
+     * @returns True if the version satisfies the range, false otherwise.
+     */
+    satisfies: (nameOrVersion: string | SemVer, range: string, optionsOrLoose?: boolean | RangeOptions) => boolean;
+};
+
 interface ImportExportItemObject<Name extends string | undefined = string | undefined, Alias extends string | undefined = undefined> {
     alias?: Alias;
     asType?: boolean;
@@ -7676,6 +7699,13 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
     private handler;
     name: T['resolvedConfig']['name'];
     output: Required<T['config']>['output'];
+    /**
+     * The package metadata and utilities for the current context, constructed
+     * from the provided dependencies. Used for managing package-related
+     * information such as name, version, and dependency resolution during
+     * code generation.
+     */
+    package: IR.Context['package'];
     constructor(props: Pick<Required<Plugin.Config<T>>, 'config' | 'dependencies' | 'handler'> & {
         api?: T['api'];
         context: IR.Context<OpenApi$3.V2_0_X | OpenApi$3.V3_0_X | OpenApi$3.V3_1_X>;
@@ -7756,7 +7786,8 @@ type AnyPluginName = PluginNames | (string & {});
 
 type PluginTag = 'client' | 'transformer' | 'validator';
 
-interface PluginContext {
+type PluginContext = {
+  package: Package;
   pluginByTag: <T extends AnyPluginName | boolean = AnyPluginName>(
     tag: PluginTag,
     props?: {
@@ -7765,7 +7796,7 @@ interface PluginContext {
     },
   ) => Exclude<T, boolean> | undefined;
   valueToObject: ValueToObject;
-}
+};
 
 type BaseApi = Record<string, unknown>;
 
@@ -8851,10 +8882,14 @@ type Config$7 = Plugin.Name<'@hey-api/typescript'> & {
   tree: boolean;
 };
 
+interface PluginState {
+  usedTypeIDs: Set<string>;
+}
+
 type HeyApiTypeScriptPlugin = DefinePlugin<UserConfig$8, Config$7, Api$2>;
 
 type OnRef = (id: string) => void;
-declare const schemaToType: ({ onRef, plugin, schema, }: {
+declare const schemaToType: ({ onRef, plugin, schema, state, }: {
     /**
      * Callback that can be used to perform side-effects when we encounter a
      * reference. For example, we might want to import the referenced type.
@@ -8862,6 +8897,7 @@ declare const schemaToType: ({ onRef, plugin, schema, }: {
     onRef: OnRef | undefined;
     plugin: HeyApiTypeScriptPlugin["Instance"];
     schema: IR.SchemaObject;
+    state: PluginState;
 }) => ts__default.TypeNode;
 
 type GetIdArgs$1 = {
@@ -11062,6 +11098,17 @@ type UserConfig = Plugin.Name<'zod'> & {
    * @default true
    */
   comments?: boolean;
+  /**
+   * The compatibility version to target for generated output.
+   *
+   * Can be:
+   * - `4`: [Zod 4](https://zod.dev/packages/zod) (default).
+   * - `3`: [Zod 3](https://v3.zod.dev/).
+   * - `'mini'`: [Zod Mini](https://zod.dev/packages/mini).
+   *
+   * @default 4
+   */
+  compatibilityVersion?: 3 | 4 | 'mini';
   /**
    * Configuration for date handling in generated Zod schemas.
    *
@@ -11383,6 +11430,17 @@ type Config = Plugin.Name<'zod'> & {
    * @default true
    */
   comments: boolean;
+  /**
+   * The compatibility version to target for generated output.
+   *
+   * Can be:
+   * - `4`: [Zod 4](https://zod.dev/packages/zod) (default).
+   * - `3`: [Zod 3](https://v3.zod.dev/).
+   * - `'mini'`: [Zod Mini](https://zod.dev/packages/mini).
+   *
+   * @default 4
+   */
+  compatibilityVersion: 3 | 4 | 'mini';
   /**
    * Configuration for date handling in generated Zod schemas.
    *
@@ -11703,6 +11761,13 @@ declare class IRContext<Spec extends Record<string, any> = any> {
      * Intermediate representation model obtained from `spec`.
      */
     ir: IR.Model;
+    /**
+     * The package metadata and utilities for the current context, constructed
+     * from the provided dependencies. Used for managing package-related
+     * information such as name, version, and dependency resolution during
+     * code generation.
+     */
+    package: Package;
     /**
      * A map of registered plugin instances, keyed by plugin name. Plugins are
      * registered through the `registerPlugin` method and can be accessed by
@@ -11713,8 +11778,9 @@ declare class IRContext<Spec extends Record<string, any> = any> {
      * Resolved specification from `input`.
      */
     spec: Spec;
-    constructor({ config, spec }: {
+    constructor({ config, dependencies, spec, }: {
         config: Config$9;
+        dependencies: Record<string, string>;
         spec: Spec;
     });
     /**
@@ -11889,6 +11955,7 @@ interface IRSchemaObject
     | 'pattern'
     | 'required'
     | 'title'
+    | 'example'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.79.1",
+  "version": "0.80.0",
   "description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
   "homepage": "https://heyapi.dev/",
   "repository": {
@@ -82,7 +82,8 @@
     "color-support": "1.1.3",
     "commander": "13.0.0",
     "handlebars": "4.7.8",
-    "open": "10.1.2"
+    "open": "10.1.2",
+    "semver": "7.7.2"
   },
   "peerDependencies": {
     "typescript": "^5.5.3"
@@ -91,6 +92,7 @@
     "@types/bun": "1.2.19",
     "@types/cross-spawn": "6.0.6",
     "@types/express": "4.17.21",
+    "@types/semver": "7.7.0",
     "axios": "1.8.2",
     "cross-spawn": "7.0.5",
     "eslint": "9.17.0",