@hey-api/openapi-ts 0.56.1 → 0.56.3

package/dist/index.d.cts

@@ -3802,7 +3802,7 @@ interface XMLObject {
   wrapped?: boolean;
 }
 
-interface Config$9 extends PluginName<'@hey-api/schemas'> {
+interface Config$a extends PluginName<'@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
@@ -3920,7 +3920,21 @@ interface IRResponseObject {
 interface IRSchemaObject
   extends Pick<
     JsonSchemaDraft2020_12,
-    '$ref' | 'const' | 'deprecated' | 'description' | 'required' | 'title'
+    | '$ref'
+    | 'const'
+    | 'default'
+    | 'deprecated'
+    | 'description'
+    | 'exclusiveMaximum'
+    | 'exclusiveMinimum'
+    | 'maximum'
+    | 'maxItems'
+    | 'maxLength'
+    | 'minimum'
+    | 'minItems'
+    | 'minLength'
+    | 'required'
+    | 'title'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
@@ -3970,7 +3984,7 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$8 extends PluginName<'@hey-api/services'> {
+interface Config$9 extends PluginName<'@hey-api/services'> {
   /**
    * Group operation methods into service classes? When enabled, you can
    * select which classes to export with `services.include` and/or
@@ -4031,7 +4045,7 @@ interface Config$8 extends PluginName<'@hey-api/services'> {
   serviceNameBuilder?: string;
 }
 
-interface Config$7 extends PluginName<'@hey-api/transformers'> {
+interface Config$8 extends PluginName<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
    * @default false
@@ -4044,7 +4058,7 @@ interface Config$7 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$6 extends PluginName<'@hey-api/types'> {
+interface Config$7 extends PluginName<'@hey-api/types'> {
   /**
    * Generate enum definitions?
    * @default false
@@ -4078,7 +4092,7 @@ interface Config$6 extends PluginName<'@hey-api/types'> {
   tree?: boolean;
 }
 
-interface Config$5
+interface Config$6
   extends PluginName<'@tanstack/angular-query-experimental'> {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
@@ -4103,7 +4117,7 @@ interface Config$5
   queryOptions?: boolean;
 }
 
-interface Config$4 extends PluginName<'@tanstack/react-query'> {
+interface Config$5 extends PluginName<'@tanstack/react-query'> {
   /**
    * 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
@@ -4127,7 +4141,7 @@ interface Config$4 extends PluginName<'@tanstack/react-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$3 extends PluginName<'@tanstack/solid-query'> {
+interface Config$4 extends PluginName<'@tanstack/solid-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
    * @default true
@@ -4151,7 +4165,7 @@ interface Config$3 extends PluginName<'@tanstack/solid-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
+interface Config$3 extends PluginName<'@tanstack/svelte-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
    * @default true
@@ -4175,7 +4189,7 @@ interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$1 extends PluginName<'@tanstack/vue-query'> {
+interface Config$2 extends PluginName<'@tanstack/vue-query'> {
   /**
    * 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
@@ -4199,7 +4213,7 @@ interface Config$1 extends PluginName<'@tanstack/vue-query'> {
   queryOptions?: boolean;
 }
 
-interface Config extends PluginName<'fastify'> {
+interface Config$1 extends PluginName<'fastify'> {
   /**
    * Name of the generated file.
    * @default 'fastify'
@@ -4207,10 +4221,26 @@ interface Config extends PluginName<'fastify'> {
   output?: string;
 }
 
+// import type { IROperationObject, IRSchemaObject } from '../../ir/ir';
+
+
+interface Config extends PluginName<'zod'> {
+  /**
+   * Customise the Zod schema name. By default, `z{{name}}` is used,
+   * where `name` is a definition name or an operation name.
+   */
+  // nameBuilder?: (model: IROperationObject | IRSchemaObject) => string;
+  /**
+   * Name of the generated file.
+   * @default 'zod'
+   */
+  output?: string;
+}
+
 /**
  * User-facing plugin types.
  */
-type UserPlugins = UserConfig$1<Config$9> | UserConfig$1<Config$8> | UserConfig$1<Config$7> | UserConfig$1<Config$6> | UserConfig$1<Config$5> | UserConfig$1<Config$4> | UserConfig$1<Config$3> | UserConfig$1<Config$2> | UserConfig$1<Config$1> | UserConfig$1<Config>;
+type UserPlugins = UserConfig$1<Config$a> | UserConfig$1<Config$9> | UserConfig$1<Config$8> | UserConfig$1<Config$7> | UserConfig$1<Config$6> | UserConfig$1<Config$5> | UserConfig$1<Config$4> | UserConfig$1<Config$3> | UserConfig$1<Config$2> | UserConfig$1<Config$1> | UserConfig$1<Config>;
 
 declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
 type Client$2 = (typeof CLIENTS)[number];
@@ -4272,9 +4302,21 @@ interface ClientConfig {
      * Alternatively, you can define a configuration object with more options.
      */
     input: string | Record<string, unknown> | {
+        /**
+         * Prevent parts matching the regular expression from being processed.
+         * You can select both operations and components by reference within
+         * the bundled input. In case of conflicts, `exclude` takes precedence
+         * over `include`.
+         *
+         * @example
+         * operation: '^#/paths/api/v1/foo/get$'
+         * schema: '^#/components/schemas/Foo$'
+         */
+        exclude?: string;
         /**
          * Process only parts matching the regular expression. You can select both
-         * operations and components by reference within the bundled input.
+         * operations and components by reference within the bundled input. In
+         * case of conflicts, `exclude` takes precedence over `include`.
          *
          * @example
          * operation: '^#/paths/api/v1/foo/get$'

package/dist/index.d.ts

@@ -3802,7 +3802,7 @@ interface XMLObject {
   wrapped?: boolean;
 }
 
-interface Config$9 extends PluginName<'@hey-api/schemas'> {
+interface Config$a extends PluginName<'@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
@@ -3920,7 +3920,21 @@ interface IRResponseObject {
 interface IRSchemaObject
   extends Pick<
     JsonSchemaDraft2020_12,
-    '$ref' | 'const' | 'deprecated' | 'description' | 'required' | 'title'
+    | '$ref'
+    | 'const'
+    | 'default'
+    | 'deprecated'
+    | 'description'
+    | 'exclusiveMaximum'
+    | 'exclusiveMinimum'
+    | 'maximum'
+    | 'maxItems'
+    | 'maxLength'
+    | 'minimum'
+    | 'minItems'
+    | 'minLength'
+    | 'required'
+    | 'title'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
@@ -3970,7 +3984,7 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$8 extends PluginName<'@hey-api/services'> {
+interface Config$9 extends PluginName<'@hey-api/services'> {
   /**
    * Group operation methods into service classes? When enabled, you can
    * select which classes to export with `services.include` and/or
@@ -4031,7 +4045,7 @@ interface Config$8 extends PluginName<'@hey-api/services'> {
   serviceNameBuilder?: string;
 }
 
-interface Config$7 extends PluginName<'@hey-api/transformers'> {
+interface Config$8 extends PluginName<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
    * @default false
@@ -4044,7 +4058,7 @@ interface Config$7 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$6 extends PluginName<'@hey-api/types'> {
+interface Config$7 extends PluginName<'@hey-api/types'> {
   /**
    * Generate enum definitions?
    * @default false
@@ -4078,7 +4092,7 @@ interface Config$6 extends PluginName<'@hey-api/types'> {
   tree?: boolean;
 }
 
-interface Config$5
+interface Config$6
   extends PluginName<'@tanstack/angular-query-experimental'> {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
@@ -4103,7 +4117,7 @@ interface Config$5
   queryOptions?: boolean;
 }
 
-interface Config$4 extends PluginName<'@tanstack/react-query'> {
+interface Config$5 extends PluginName<'@tanstack/react-query'> {
   /**
    * 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
@@ -4127,7 +4141,7 @@ interface Config$4 extends PluginName<'@tanstack/react-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$3 extends PluginName<'@tanstack/solid-query'> {
+interface Config$4 extends PluginName<'@tanstack/solid-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
    * @default true
@@ -4151,7 +4165,7 @@ interface Config$3 extends PluginName<'@tanstack/solid-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
+interface Config$3 extends PluginName<'@tanstack/svelte-query'> {
   /**
    * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
    * @default true
@@ -4175,7 +4189,7 @@ interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
   queryOptions?: boolean;
 }
 
-interface Config$1 extends PluginName<'@tanstack/vue-query'> {
+interface Config$2 extends PluginName<'@tanstack/vue-query'> {
   /**
    * 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
@@ -4199,7 +4213,7 @@ interface Config$1 extends PluginName<'@tanstack/vue-query'> {
   queryOptions?: boolean;
 }
 
-interface Config extends PluginName<'fastify'> {
+interface Config$1 extends PluginName<'fastify'> {
   /**
    * Name of the generated file.
    * @default 'fastify'
@@ -4207,10 +4221,26 @@ interface Config extends PluginName<'fastify'> {
   output?: string;
 }
 
+// import type { IROperationObject, IRSchemaObject } from '../../ir/ir';
+
+
+interface Config extends PluginName<'zod'> {
+  /**
+   * Customise the Zod schema name. By default, `z{{name}}` is used,
+   * where `name` is a definition name or an operation name.
+   */
+  // nameBuilder?: (model: IROperationObject | IRSchemaObject) => string;
+  /**
+   * Name of the generated file.
+   * @default 'zod'
+   */
+  output?: string;
+}
+
 /**
  * User-facing plugin types.
  */
-type UserPlugins = UserConfig$1<Config$9> | UserConfig$1<Config$8> | UserConfig$1<Config$7> | UserConfig$1<Config$6> | UserConfig$1<Config$5> | UserConfig$1<Config$4> | UserConfig$1<Config$3> | UserConfig$1<Config$2> | UserConfig$1<Config$1> | UserConfig$1<Config>;
+type UserPlugins = UserConfig$1<Config$a> | UserConfig$1<Config$9> | UserConfig$1<Config$8> | UserConfig$1<Config$7> | UserConfig$1<Config$6> | UserConfig$1<Config$5> | UserConfig$1<Config$4> | UserConfig$1<Config$3> | UserConfig$1<Config$2> | UserConfig$1<Config$1> | UserConfig$1<Config>;
 
 declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
 type Client$2 = (typeof CLIENTS)[number];
@@ -4272,9 +4302,21 @@ interface ClientConfig {
      * Alternatively, you can define a configuration object with more options.
      */
     input: string | Record<string, unknown> | {
+        /**
+         * Prevent parts matching the regular expression from being processed.
+         * You can select both operations and components by reference within
+         * the bundled input. In case of conflicts, `exclude` takes precedence
+         * over `include`.
+         *
+         * @example
+         * operation: '^#/paths/api/v1/foo/get$'
+         * schema: '^#/components/schemas/Foo$'
+         */
+        exclude?: string;
         /**
          * Process only parts matching the regular expression. You can select both
-         * operations and components by reference within the bundled input.
+         * operations and components by reference within the bundled input. In
+         * case of conflicts, `exclude` takes precedence over `include`.
          *
          * @example
          * operation: '^#/paths/api/v1/foo/get$'