@hey-api/openapi-ts 0.82.0 → 0.82.2

package/dist/{types.d-kCNGz4sv.d.ts → types.d-44bOq98L.d.ts}

@@ -1,4 +1,5 @@
 import { SemVer, RangeOptions } from 'semver';
+import { CodegenProject } from '@hey-api/codegen-core';
 import fs from 'node:fs';
 import typescript__default from 'typescript';
 
@@ -2712,14 +2713,6 @@ declare class GeneratedFile {
      * identifiers.
      */
     addNodeReference<T>(id: string, node: Pick<NodeReference<T>, 'factory'>): T;
-    /**
-     * Prevents a specific identifier from being created. This is useful for
-     * transformers where we know a certain transformer won't be needed, and
-     * we want to avoid attempting to create since we know it won't happen.
-     */
-    blockIdentifier({ $ref, namespace, }: Pick<EnsureUniqueIdentifierData, '$ref'> & {
-        namespace: Namespace;
-    }): Identifier;
     get exportFromIndex(): boolean;
     /**
      * Returns an actual node name. If node doesn't exist throws an error.
@@ -7739,6 +7732,7 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
     config: Omit<T['resolvedConfig'], 'name' | 'output'>;
     context: IR$1.Context;
     dependencies: Required<Plugin.Config<T>>['dependencies'];
+    gen: CodegenProject;
     private handler;
     name: T['resolvedConfig']['name'];
     output: Required<T['config']>['output'];
@@ -7752,6 +7746,7 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
     constructor(props: Pick<Required<Plugin.Config<T>>, 'config' | 'dependencies' | 'handler'> & {
         api?: T['api'];
         context: IR$1.Context<OpenApi$3.V2_0_X | OpenApi$3.V3_0_X | OpenApi$3.V3_1_X>;
+        gen: CodegenProject;
         name: string;
         output: string;
     });
@@ -8705,7 +8700,7 @@ type UserConfig$a = Plugin.Name<'@hey-api/transformers'> & {
 
 type HeyApiTransformersPlugin = DefinePlugin<UserConfig$a>;
 
-type EnumsType = 'javascript' | 'typescript';
+type EnumsType = 'javascript' | 'typescript' | 'typescript-const';
 
 type UserConfig$9 = Plugin.Name<'@hey-api/typescript'> & {
   /**
@@ -8784,6 +8779,7 @@ type UserConfig$9 = Plugin.Name<'@hey-api/typescript'> & {
          * Can be:
          * - `javascript`: Generates JavaScript objects
          * - `typescript`: Generates TypeScript enums
+         * - `typescript-const`: Generates TypeScript const enums
          *
          * @default 'javascript'
          */
@@ -9033,6 +9029,7 @@ type Config$8 = Plugin.Name<'@hey-api/typescript'> & {
      * Can be:
      * - `javascript`: Generates JavaScript objects
      * - `typescript`: Generates TypeScript enums
+     * - `typescript-const`: Generates TypeScript const enums
      *
      * @default 'javascript'
      */
@@ -9861,6 +9858,12 @@ type UserConfig$7 = Plugin.Name<'@tanstack/angular-query-experimental'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -10104,6 +10107,12 @@ type Config$6 = Plugin.Name<'@tanstack/angular-query-experimental'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.
@@ -10168,7 +10177,7 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Configuration for generated infinite query key helpers.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions TanStack Query: infiniteQueryOptions}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
      *
      * Can be:
      * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10197,8 +10206,9 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * Custom naming pattern for generated infinite query key names. The name variable is
            * obtained from the SDK function name.
            *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
+           *
            * @default '{{name}}InfiniteQueryKey'
-           * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
            */
           name?: StringName;
           /**
@@ -10212,7 +10222,7 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Configuration for generated infinite query options helpers.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions TanStack Query: infiniteQueryOptions}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
      *
      * Can be:
      * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10264,15 +10274,16 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * Custom naming pattern for generated infinite query options names. The name variable is
            * obtained from the SDK function name.
            *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
+           *
            * @default '{{name}}InfiniteOptions'
-           * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
            */
           name?: StringName;
         };
     /**
      * Configuration for generated mutation options helpers.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation TanStack Query: useMutation}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation useMutation}
      *
      * Can be:
      * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10324,8 +10335,9 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * Custom naming pattern for generated mutation options names. The name variable is
            * obtained from the SDK function name.
            *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation useMutation}
+           *
            * @default '{{name}}Mutation'
-           * @see https://tanstack.com/query/v5/docs/framework/react/reference/useMutation
            */
           name?: StringName;
         };
@@ -10338,7 +10350,7 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Configuration for generated query keys.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryKey TanStack Query: queryKey}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryKey queryKey}
      *
      * Can be:
      * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10367,8 +10379,9 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * Custom naming pattern for generated query key names. The name variable is
            * obtained from the SDK function name.
            *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys Query Keys}
+           *
            * @default '{{name}}QueryKey'
-           * @see https://tanstack.com/query/v5/docs/framework/react/reference/queryKey
            */
           name?: StringName;
           /**
@@ -10382,7 +10395,7 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Configuration for generated query options helpers.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions TanStack Query: queryOptions}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions queryOptions}
      *
      * Can be:
      * - `boolean`: Shorthand for `{ enabled: boolean }`
@@ -10407,6 +10420,12 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -10430,13 +10449,51 @@ type UserConfig$6 = Plugin.Name<'@tanstack/react-query'> &
            * @default undefined
            */
           meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
-
           /**
            * Custom naming pattern for generated query options names. The name variable is
            * obtained from the SDK function name.
            *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions queryOptions}
+           *
            * @default '{{name}}Options'
-           * @see https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions
+           */
+          name?: StringName;
+        };
+    /**
+     * Configuration for generated `useQuery()` function helpers.
+     *
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useQuery useQuery}
+     *
+     * Can be:
+     * - `boolean`: Shorthand for `{ enabled: boolean }`
+     * - `string` or `function`: Shorthand for `{ name: string | function }`
+     * - `object`: Full configuration object
+     *
+     * @default false
+     */
+    useQuery?:
+      | boolean
+      | StringName
+      | {
+          /**
+           * The casing convention to use for generated names.
+           *
+           * @default 'camelCase'
+           */
+          case?: StringCase;
+          /**
+           * Whether to generate `useQuery()` function helpers.
+           *
+           * @default true
+           */
+          enabled?: boolean;
+          /**
+           * Custom naming pattern for generated `useQuery()` function names. The name variable is
+           * obtained from the SDK function name.
+           *
+           * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useQuery useQuery}
+           *
+           * @default 'use{{name}}Query'
            */
           name?: StringName;
         };
@@ -10465,7 +10522,7 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Resolved configuration for generated infinite query key helpers.
      *
-     * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
      */
     infiniteQueryKeys: {
       /**
@@ -10483,8 +10540,9 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
       /**
        * Custom naming pattern for generated infinite query key names. The name variable is obtained from the SDK function name.
        *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
+       *
        * @default '{{name}}InfiniteQueryKey'
-       * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
        */
       name: StringName;
       /**
@@ -10498,7 +10556,7 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Resolved configuration for generated infinite query options helpers.
      *
-     * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
      */
     infiniteQueryOptions: {
       /**
@@ -10539,15 +10597,16 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
       /**
        * Custom naming pattern for generated infinite query options names. The name variable is obtained from the SDK function name.
        *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions infiniteQueryOptions}
+       *
        * @default '{{name}}InfiniteOptions'
-       * @see https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions
        */
       name: StringName;
     };
     /**
      * Resolved configuration for generated mutation options helpers.
      *
-     * @see https://tanstack.com/query/v5/docs/framework/react/reference/useMutation
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation useMutation}
      */
     mutationOptions: {
       /**
@@ -10588,8 +10647,9 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
       /**
        * Custom naming pattern for generated mutation options names. The name variable is obtained from the SDK function name.
        *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation useMutation}
+       *
        * @default '{{name}}Mutation'
-       * @see https://tanstack.com/query/v5/docs/framework/react/reference/useMutation
        */
       name: StringName;
     };
@@ -10602,7 +10662,7 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Resolved configuration for generated query keys.
      *
-     * @see https://tanstack.com/query/v5/docs/framework/react/reference/queryKey
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys Query Keys}
      */
     queryKeys: {
       /**
@@ -10620,8 +10680,9 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
       /**
        * Custom naming pattern for generated query key names. The name variable is obtained from the SDK function name.
        *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys Query Keys}
+       *
        * @default '{{name}}QueryKey'
-       * @see https://tanstack.com/query/v5/docs/framework/react/reference/queryKey
        */
       name: StringName;
       /**
@@ -10635,7 +10696,7 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
     /**
      * Resolved configuration for generated query options helpers.
      *
-     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions TanStack Query: queryOptions}
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions queryOptions}
      */
     queryOptions: {
       /**
@@ -10650,6 +10711,12 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.
@@ -10676,8 +10743,37 @@ type Config$5 = Plugin.Name<'@tanstack/react-query'> &
       /**
        * Custom naming pattern for generated query options names. The name variable is obtained from the SDK function name.
        *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions queryOptions}
+       *
        * @default '{{name}}Options'
-       * @see https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions
+       */
+      name: StringName;
+    };
+    /**
+     * Configuration for generated `useQuery()` function helpers.
+     *
+     * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useQuery useQuery}
+     */
+    useQuery: {
+      /**
+       * The casing convention to use for generated names.
+       *
+       * @default 'camelCase'
+       */
+      case: StringCase;
+      /**
+       * Whether to generate `useQuery()` function helpers.
+       *
+       * @default true
+       */
+      enabled: boolean;
+      /**
+       * Custom naming pattern for generated `useQuery()` function names. The name variable is
+       * obtained from the SDK function name.
+       *
+       * See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useQuery useQuery}
+       *
+       * @default 'use{{name}}Query'
        */
       name: StringName;
     };
@@ -10951,6 +11047,12 @@ type UserConfig$5 = Plugin.Name<'@tanstack/solid-query'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -11194,6 +11296,12 @@ type Config$4 = Plugin.Name<'@tanstack/solid-query'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.
@@ -11494,6 +11602,12 @@ type UserConfig$4 = Plugin.Name<'@tanstack/svelte-query'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -11737,6 +11851,12 @@ type Config$3 = Plugin.Name<'@tanstack/svelte-query'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.
@@ -12039,6 +12159,12 @@ type UserConfig$3 = Plugin.Name<'@tanstack/vue-query'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -12285,6 +12411,12 @@ type Config$2 = Plugin.Name<'@tanstack/vue-query'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.
@@ -13480,6 +13612,7 @@ declare class IRContext<Spec extends Record<string, any> = any> {
      * A map of files that will be generated from `spec`.
      */
     files: Files;
+    gen: CodegenProject;
     /**
      * Intermediate representation model obtained from `spec`.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.82.0",
+  "version": "0.82.2",
   "description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
   "homepage": "https://heyapi.dev/",
   "repository": {
@@ -76,6 +76,7 @@
     "node": "^18.18.0 || ^20.9.0 || >=22.10.0"
   },
   "dependencies": {
+    "@hey-api/codegen-core": "^0.0.1",
     "@hey-api/json-schema-ref-parser": "1.0.7",
     "ansi-colors": "4.1.3",
     "c12": "2.0.1",
@@ -87,7 +88,7 @@
     "semver": "7.7.2"
   },
   "peerDependencies": {
-    "typescript": "^5.5.3"
+    "typescript": ">=5.5.3"
   },
   "devDependencies": {
     "@angular/common": "19.2.0",