@hey-api/openapi-ts 0.52.11 → 0.53.0

package/dist/node/index.d.ts

@@ -5,12 +5,77 @@ interface Dictionary<T = unknown> {
     [key: string]: T;
 }
 
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
+ */
+interface OpenApiExternalDocs$1 {
+    description?: string;
+    url: string;
+}
+
 interface WithEnumExtension {
     'x-enum-descriptions'?: ReadonlyArray<string>;
     'x-enum-varnames'?: ReadonlyArray<string>;
     'x-enumNames'?: ReadonlyArray<string>;
 }
 
+interface WithNullableExtension {
+    'x-nullable'?: boolean;
+}
+
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#reference-object
+ */
+interface OpenApiReference$1 {
+    $ref?: string;
+}
+
+/**
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#xml-object
+ */
+interface OpenApiXml$1 {
+    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$1 extends OpenApiReference$1, WithEnumExtension, WithNullableExtension {
+    additionalProperties?: boolean | OpenApiSchema$1;
+    allOf?: OpenApiSchema$1[];
+    default?: unknown;
+    description?: string;
+    discriminator?: string;
+    enum?: (string | number)[];
+    example?: unknown;
+    exclusiveMaximum?: boolean;
+    exclusiveMinimum?: boolean;
+    externalDocs?: OpenApiExternalDocs$1;
+    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    items?: OpenApiSchema$1;
+    maxItems?: number;
+    maxLength?: number;
+    maxProperties?: number;
+    maximum?: number;
+    minItems?: number;
+    minLength?: number;
+    minProperties?: number;
+    minimum?: number;
+    multipleOf?: number;
+    pattern?: string;
+    properties?: Dictionary<OpenApiSchema$1>;
+    readOnly?: boolean;
+    required?: string[];
+    title?: string;
+    type?: string;
+    uniqueItems?: boolean;
+    xml?: OpenApiXml$1;
+}
+
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object
  */
@@ -433,7 +498,7 @@ interface PluginTanStackVueQuery extends PluginDefinition {
 
 type Plugins = PluginTanStackReactQuery | PluginTanStackSolidQuery | PluginTanStackSvelteQuery | PluginTanStackVueQuery;
 
-type Client = '@hey-api/client-axios' | '@hey-api/client-fetch' | 'angular' | 'axios' | 'fetch' | 'node' | 'xhr' | '';
+type Client = '@hey-api/client-axios' | '@hey-api/client-fetch' | 'legacy/angular' | 'legacy/axios' | 'legacy/fetch' | 'legacy/node' | 'legacy/xhr' | '';
 interface ClientConfig {
     /**
      * Manually set base in OpenAPI config instead of inferring from server value
@@ -442,7 +507,6 @@ interface ClientConfig {
     base?: string;
     /**
      * HTTP client to generate
-     * @default 'fetch'
      */
     client?: Client | {
         /**
@@ -457,7 +521,6 @@ interface ClientConfig {
         bundle?: boolean;
         /**
          * HTTP client to generate
-         * @default 'fetch'
          */
         name: Client;
     };
@@ -533,6 +596,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$1 | OpenApiSchema) => 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 +646,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 +711,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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/openapi-ts",
-  "version": "0.52.11",
+  "version": "0.53.0",
   "type": "module",
   "description": "Turn your OpenAPI specification into a beautiful TypeScript client",
   "homepage": "https://heyapi.vercel.app/",
@@ -36,7 +36,8 @@
   },
   "files": [
     "bin",
-    "dist"
+    "dist",
+    "LICENSE.md"
   ],
   "engines": {
     "node": "^18.0.0 || >=20.0.0"
@@ -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.53.2",
     "@tanstack/solid-query": "5.51.21",
-    "@tanstack/svelte-query": "5.52.0",
-    "@tanstack/vue-query": "5.52.0",
+    "@tanstack/svelte-query": "5.53.2",
+    "@tanstack/vue-query": "5.53.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",

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.