@hey-api/openapi-ts 0.52.11 → 0.53.1

package/dist/node/index.d.ts

@@ -5,37 +5,29 @@ interface Dictionary<T = unknown> {
     [key: string]: T;
 }
 
-interface WithEnumExtension {
-    'x-enum-descriptions'?: ReadonlyArray<string>;
-    'x-enum-varnames'?: ReadonlyArray<string>;
-    'x-enumNames'?: ReadonlyArray<string>;
-}
-
-/**
- * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object
- */
-interface OpenApiExternalDocs {
-    description?: string;
-    url: string;
-}
-
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#reference-object
  */
-interface OpenApiReference {
+interface OpenApiReference$1 {
     $ref?: string;
 }
 
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#example-object
  */
-interface OpenApiExample extends OpenApiReference {
+interface OpenApiExample extends OpenApiReference$1 {
     description?: string;
     externalValue?: string;
     summary?: string;
     value?: unknown;
 }
 
+interface WithEnumExtension {
+    'x-enum-descriptions'?: ReadonlyArray<string>;
+    'x-enum-varnames'?: ReadonlyArray<string>;
+    'x-enumNames'?: ReadonlyArray<string>;
+}
+
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object
  */
@@ -44,10 +36,18 @@ interface OpenApiDiscriminator {
     propertyName: string;
 }
 
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object
+ */
+interface OpenApiExternalDocs$1 {
+    description?: string;
+    url: string;
+}
+
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object
  */
-interface OpenApiXml {
+interface OpenApiXml$1 {
     attribute?: boolean;
     name?: string;
     namespace?: string;
@@ -58,10 +58,10 @@ interface OpenApiXml {
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object
  */
-interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
-    additionalProperties?: boolean | OpenApiSchema;
-    allOf?: OpenApiSchema[];
-    anyOf?: OpenApiSchema[];
+interface OpenApiSchema$1 extends OpenApiReference$1, WithEnumExtension {
+    additionalProperties?: boolean | OpenApiSchema$1;
+    allOf?: OpenApiSchema$1[];
+    anyOf?: OpenApiSchema$1[];
     const?: string | number | boolean | null;
     default?: unknown;
     deprecated?: boolean;
@@ -71,9 +71,9 @@ interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
     example?: unknown;
     exclusiveMaximum?: boolean;
     exclusiveMinimum?: boolean;
-    externalDocs?: OpenApiExternalDocs;
+    externalDocs?: OpenApiExternalDocs$1;
     format?: 'binary' | 'boolean' | 'byte' | 'date-time' | 'date' | 'double' | 'float' | 'int32' | 'int64' | 'password' | 'string';
-    items?: OpenApiSchema;
+    items?: OpenApiSchema$1;
     maxItems?: number;
     maxLength?: number;
     maxProperties?: number;
@@ -83,19 +83,19 @@ interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
     minProperties?: number;
     minimum?: number;
     multipleOf?: number;
-    not?: OpenApiSchema[];
+    not?: OpenApiSchema$1[];
     nullable?: boolean;
-    oneOf?: OpenApiSchema[];
+    oneOf?: OpenApiSchema$1[];
     pattern?: string;
-    prefixItems?: OpenApiSchema[];
-    properties?: Dictionary<OpenApiSchema>;
+    prefixItems?: OpenApiSchema$1[];
+    properties?: Dictionary<OpenApiSchema$1>;
     readOnly?: boolean;
     required?: string[];
     title?: string;
     type?: string | string[];
     uniqueItems?: boolean;
     writeOnly?: boolean;
-    xml?: OpenApiXml;
+    xml?: OpenApiXml$1;
 }
 
 /**
@@ -112,12 +112,12 @@ type MediaType = 'application/json';
 interface MediaTypeObject {
     example?: unknown;
     examples?: Dictionary<OpenApiExample>;
-    schema: OpenApiSchema;
+    schema: OpenApiSchema$1;
 }
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object
  */
-interface OpenApiParameter extends OpenApiReference {
+interface OpenApiParameter extends OpenApiReference$1 {
     allowEmptyValue?: boolean;
     allowReserved?: boolean;
     content?: Record<MediaType, MediaTypeObject>;
@@ -130,7 +130,7 @@ interface OpenApiParameter extends OpenApiReference {
     name: string;
     nullable?: boolean;
     required?: boolean;
-    schema?: OpenApiSchema;
+    schema?: OpenApiSchema$1;
     style?: string;
 }
 
@@ -160,7 +160,7 @@ interface OperationResponse extends Model {
     responseTypes: Array<'error' | 'success'>;
 }
 type Method = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
-interface Operation extends OperationParameters {
+interface Operation$1 extends OperationParameters {
     deprecated: boolean;
     description: string | null;
     /**
@@ -176,12 +176,8 @@ interface Operation extends OperationParameters {
      * Sorted by status code.
      */
     responses: OperationResponse[];
-    /**
-     * Service name, might be without postfix. This will be used to name the
-     * exported class.
-     */
-    service: string;
     summary: string | null;
+    tags: string[] | null;
 }
 interface Schema {
     default?: unknown;
@@ -239,20 +235,10 @@ interface Model extends Schema {
     template: string | null;
     type: string;
 }
-interface Service extends Pick<Model, '$refs' | 'imports' | 'name'> {
-    operations: Operation[];
-}
-
-interface Client$1 {
+interface Client$2 {
     models: Model[];
-    /**
-     * Map of unique operation IDs where operation IDs are keys. The values
-     * are endpoints in the `${method} ${path}` format. This is used to detect
-     * duplicate operation IDs in the specification.
-     */
-    operationIds: Map<string, string>;
+    operations: Operation$1[];
     server: string;
-    services: Service[];
     /**
      * Map of generated types where type names are keys. This is used to track
      * uniquely generated types as we may want to deduplicate if there are
@@ -263,6 +249,81 @@ interface Client$1 {
     version: string;
 }
 
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
+ */
+interface OpenApiExternalDocs {
+    description?: string;
+    url: string;
+}
+
+interface WithNullableExtension {
+    'x-nullable'?: boolean;
+}
+
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#reference-object
+ */
+interface OpenApiReference {
+    $ref?: string;
+}
+
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#xml-object
+ */
+interface OpenApiXml {
+    attribute?: boolean;
+    name?: string;
+    namespace?: string;
+    prefix?: string;
+    wrapped?: boolean;
+}
+
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#schema-object
+ */
+interface OpenApiSchema extends OpenApiReference, WithEnumExtension, WithNullableExtension {
+    additionalProperties?: boolean | OpenApiSchema;
+    allOf?: OpenApiSchema[];
+    default?: unknown;
+    description?: string;
+    discriminator?: string;
+    enum?: (string | number)[];
+    example?: unknown;
+    exclusiveMaximum?: boolean;
+    exclusiveMinimum?: boolean;
+    externalDocs?: OpenApiExternalDocs;
+    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    items?: OpenApiSchema;
+    maxItems?: number;
+    maxLength?: number;
+    maxProperties?: number;
+    maximum?: number;
+    minItems?: number;
+    minLength?: number;
+    minProperties?: number;
+    minimum?: number;
+    multipleOf?: number;
+    pattern?: string;
+    properties?: Dictionary<OpenApiSchema>;
+    readOnly?: boolean;
+    required?: string[];
+    title?: string;
+    type?: string;
+    uniqueItems?: boolean;
+    xml?: OpenApiXml;
+}
+
+interface Operation extends Omit<Operation$1, 'tags'> {
+    service: string;
+}
+interface Service extends Pick<Model, '$refs' | 'imports' | 'name'> {
+    operations: Operation[];
+}
+interface Client$1 extends Omit<Client$2, 'operations'> {
+    services: Service[];
+}
+
 interface ImportExportItemObject {
     alias?: string;
     asType?: boolean;
@@ -295,8 +356,8 @@ declare class TypeScriptFile {
      */
     removeNode(): void;
     private _setName;
-    toString(seperator?: string): string;
-    write(seperator?: string): void;
+    toString(separator?: string): string;
+    write(separator?: string): void;
 }
 
 type ExtractFromArray<T, Discriminator> = T extends Discriminator ? Required<T> : never;
@@ -319,7 +380,43 @@ interface PluginDefinition {
     output?: string;
 }
 
-interface PluginTanStackReactQuery extends PluginDefinition {
+interface PluginConfig$6 extends PluginDefinition {
+    /**
+     * Generate Hey API schemas from the provided input.
+     */
+    name: '@hey-api/schemas';
+    /**
+     * Name of the generated file.
+     * @default 'schemas'
+     */
+    output?: string;
+}
+
+interface PluginConfig$5 extends PluginDefinition {
+    /**
+     * Generate Hey API services from the provided input.
+     */
+    name: '@hey-api/services';
+    /**
+     * Name of the generated file.
+     * @default 'services'
+     */
+    output?: string;
+}
+
+interface PluginConfig$4 extends PluginDefinition {
+    /**
+     * Generate Hey API types from the provided input.
+     */
+    name: '@hey-api/types';
+    /**
+     * Name of the generated file.
+     * @default 'types'
+     */
+    output?: string;
+}
+
+interface PluginConfig$3 extends PluginDefinition {
     /**
      * Generate {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
      * @default true
@@ -347,7 +444,7 @@ interface PluginTanStackReactQuery extends PluginDefinition {
     queryOptions?: boolean;
 }
 
-interface PluginTanStackSolidQuery extends PluginDefinition {
+interface PluginConfig$2 extends PluginDefinition {
     /**
      * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
      * @default true
@@ -375,7 +472,7 @@ interface PluginTanStackSolidQuery extends PluginDefinition {
     queryOptions?: boolean;
 }
 
-interface PluginTanStackSvelteQuery extends PluginDefinition {
+interface PluginConfig$1 extends PluginDefinition {
     /**
      * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
      * @default true
@@ -403,7 +500,7 @@ interface PluginTanStackSvelteQuery extends PluginDefinition {
     queryOptions?: boolean;
 }
 
-interface PluginTanStackVueQuery extends PluginDefinition {
+interface PluginConfig extends PluginDefinition {
     /**
      * Generate {@link https://tanstack.com/query/v5/docs/framework/vue/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
      * @default true
@@ -431,9 +528,10 @@ interface PluginTanStackVueQuery extends PluginDefinition {
     queryOptions?: boolean;
 }
 
-type Plugins = PluginTanStackReactQuery | PluginTanStackSolidQuery | PluginTanStackSvelteQuery | PluginTanStackVueQuery;
+type Plugins = PluginConfig$6 | PluginConfig$5 | PluginConfig$4 | PluginConfig$3 | PluginConfig$2 | PluginConfig$1 | PluginConfig;
 
-type Client = '@hey-api/client-axios' | '@hey-api/client-fetch' | 'angular' | 'axios' | 'fetch' | 'node' | 'xhr' | '';
+declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
+type Client = (typeof CLIENTS)[number];
 interface ClientConfig {
     /**
      * Manually set base in OpenAPI config instead of inferring from server value
@@ -442,7 +540,6 @@ interface ClientConfig {
     base?: string;
     /**
      * HTTP client to generate
-     * @default 'fetch'
      */
     client?: Client | {
         /**
@@ -457,7 +554,6 @@ interface ClientConfig {
         bundle?: boolean;
         /**
          * HTTP client to generate
-         * @default 'fetch'
          */
         name: Client;
     };
@@ -533,6 +629,12 @@ interface ClientConfig {
          * @default true
          */
         export?: boolean;
+        /**
+         * 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".
+         */
+        name?: (name: string, schema: OpenApiSchema | OpenApiSchema$1) => string;
         /**
          * Choose schema type to generate. Select 'form' if you don't want
          * descriptions to reduce bundle size and you plan to use schemas
@@ -577,7 +679,7 @@ interface ClientConfig {
          */
         include?: string;
         /**
-         * Customise the method name of methods within the service. By default, {@link Operation.name} is used.
+         * Customise the name of methods within the service. By default, {@link Operation.name} is used.
          */
         methodNameBuilder?: (operation: Operation) => string;
         /**
@@ -642,7 +744,8 @@ interface ClientConfig {
      */
     useOptions?: boolean;
 }
-type UserConfig = ClientConfig;
+interface UserConfig extends ClientConfig {
+}
 type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'name' | 'output' | 'plugins' | 'request' | 'schemas' | 'services' | 'types'> & Pick<ClientConfig, 'base' | 'name' | 'request'> & {
     client: Extract<Required<ClientConfig>['client'], object>;
     output: Extract<Required<ClientConfig>['output'], object>;
@@ -660,10 +763,10 @@ type Config = Omit<Required<ClientConfig>, 'base' | 'client' | 'name' | 'output'
  * service layer, etc.
  * @param userConfig {@link UserConfig} passed to the `createClient()` method
  */
-declare function createClient(userConfig: UserConfig): Promise<Client$1[]>;
+declare function createClient(userConfig: UserConfig): Promise<ReadonlyArray<Client$1>>;
 /**
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
  */
-declare function defineConfig(config: UserConfig): UserConfig;
+declare const defineConfig: (config: UserConfig) => UserConfig;
 
 export { type UserConfig, createClient, defineConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.52.11",
+  "version": "0.53.1",
   "type": "module",
   "description": "Turn your OpenAPI specification into a beautiful TypeScript client",
   "homepage": "https://heyapi.vercel.app/",
@@ -36,14 +36,15 @@
   },
   "files": [
     "bin",
-    "dist"
+    "dist",
+    "LICENSE.md"
   ],
   "engines": {
     "node": "^18.0.0 || >=20.0.0"
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "11.7.0",
-    "c12": "1.11.1",
+    "c12": "1.11.2",
     "commander": "12.1.0",
     "handlebars": "4.7.8"
   },
@@ -64,13 +65,13 @@
     "@angular/router": "17.3.9",
     "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "15.2.3",
-    "@tanstack/react-query": "5.52.1",
+    "@tanstack/react-query": "5.56.2",
     "@tanstack/solid-query": "5.51.21",
-    "@tanstack/svelte-query": "5.52.0",
-    "@tanstack/vue-query": "5.52.0",
+    "@tanstack/svelte-query": "5.56.2",
+    "@tanstack/vue-query": "5.56.2",
     "@types/cross-spawn": "6.0.6",
     "@types/express": "4.17.21",
-    "axios": "1.7.5",
+    "axios": "1.7.7",
     "cross-spawn": "7.0.3",
     "eslint": "9.6.0",
     "express": "4.19.2",
@@ -83,7 +84,7 @@
     "tslib": "2.6.3",
     "typescript": "5.5.3",
     "@hey-api/client-axios": "0.2.3",
-    "@hey-api/client-fetch": "0.2.4"
+    "@hey-api/client-fetch": "0.3.0"
   },
   "scripts": {
     "build-bundle": "rollup --config rollup.config.ts --configPlugin typescript",

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) Hey API
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.