@hey-api/openapi-ts 0.56.1 → 0.56.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -3802,7 +3802,7 @@ interface XMLObject {
3802
3802
  wrapped?: boolean;
3803
3803
  }
3804
3804
 
3805
- interface Config$9 extends PluginName<'@hey-api/schemas'> {
3805
+ interface Config$a extends PluginName<'@hey-api/schemas'> {
3806
3806
  /**
3807
3807
  * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
3808
3808
  * valid JavaScript/TypeScript identifier, e.g. if your schema name is
@@ -3970,7 +3970,7 @@ interface IRSchemaObject
3970
3970
  | 'void';
3971
3971
  }
3972
3972
 
3973
- interface Config$8 extends PluginName<'@hey-api/services'> {
3973
+ interface Config$9 extends PluginName<'@hey-api/services'> {
3974
3974
  /**
3975
3975
  * Group operation methods into service classes? When enabled, you can
3976
3976
  * select which classes to export with `services.include` and/or
@@ -4031,7 +4031,7 @@ interface Config$8 extends PluginName<'@hey-api/services'> {
4031
4031
  serviceNameBuilder?: string;
4032
4032
  }
4033
4033
 
4034
- interface Config$7 extends PluginName<'@hey-api/transformers'> {
4034
+ interface Config$8 extends PluginName<'@hey-api/transformers'> {
4035
4035
  /**
4036
4036
  * Convert date strings into Date objects?
4037
4037
  * @default false
@@ -4044,7 +4044,7 @@ interface Config$7 extends PluginName<'@hey-api/transformers'> {
4044
4044
  output?: string;
4045
4045
  }
4046
4046
 
4047
- interface Config$6 extends PluginName<'@hey-api/types'> {
4047
+ interface Config$7 extends PluginName<'@hey-api/types'> {
4048
4048
  /**
4049
4049
  * Generate enum definitions?
4050
4050
  * @default false
@@ -4078,7 +4078,7 @@ interface Config$6 extends PluginName<'@hey-api/types'> {
4078
4078
  tree?: boolean;
4079
4079
  }
4080
4080
 
4081
- interface Config$5
4081
+ interface Config$6
4082
4082
  extends PluginName<'@tanstack/angular-query-experimental'> {
4083
4083
  /**
4084
4084
  * 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 +4103,7 @@ interface Config$5
4103
4103
  queryOptions?: boolean;
4104
4104
  }
4105
4105
 
4106
- interface Config$4 extends PluginName<'@tanstack/react-query'> {
4106
+ interface Config$5 extends PluginName<'@tanstack/react-query'> {
4107
4107
  /**
4108
4108
  * 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.
4109
4109
  * @default true
@@ -4127,7 +4127,7 @@ interface Config$4 extends PluginName<'@tanstack/react-query'> {
4127
4127
  queryOptions?: boolean;
4128
4128
  }
4129
4129
 
4130
- interface Config$3 extends PluginName<'@tanstack/solid-query'> {
4130
+ interface Config$4 extends PluginName<'@tanstack/solid-query'> {
4131
4131
  /**
4132
4132
  * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
4133
4133
  * @default true
@@ -4151,7 +4151,7 @@ interface Config$3 extends PluginName<'@tanstack/solid-query'> {
4151
4151
  queryOptions?: boolean;
4152
4152
  }
4153
4153
 
4154
- interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
4154
+ interface Config$3 extends PluginName<'@tanstack/svelte-query'> {
4155
4155
  /**
4156
4156
  * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
4157
4157
  * @default true
@@ -4175,7 +4175,7 @@ interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
4175
4175
  queryOptions?: boolean;
4176
4176
  }
4177
4177
 
4178
- interface Config$1 extends PluginName<'@tanstack/vue-query'> {
4178
+ interface Config$2 extends PluginName<'@tanstack/vue-query'> {
4179
4179
  /**
4180
4180
  * 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.
4181
4181
  * @default true
@@ -4199,7 +4199,7 @@ interface Config$1 extends PluginName<'@tanstack/vue-query'> {
4199
4199
  queryOptions?: boolean;
4200
4200
  }
4201
4201
 
4202
- interface Config extends PluginName<'fastify'> {
4202
+ interface Config$1 extends PluginName<'fastify'> {
4203
4203
  /**
4204
4204
  * Name of the generated file.
4205
4205
  * @default 'fastify'
@@ -4207,10 +4207,18 @@ interface Config extends PluginName<'fastify'> {
4207
4207
  output?: string;
4208
4208
  }
4209
4209
 
4210
+ interface Config extends PluginName<'zod'> {
4211
+ /**
4212
+ * Name of the generated file.
4213
+ * @default 'zod'
4214
+ */
4215
+ output?: string;
4216
+ }
4217
+
4210
4218
  /**
4211
4219
  * User-facing plugin types.
4212
4220
  */
4213
- 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>;
4221
+ 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>;
4214
4222
 
4215
4223
  declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
4216
4224
  type Client$2 = (typeof CLIENTS)[number];
@@ -4272,9 +4280,21 @@ interface ClientConfig {
4272
4280
  * Alternatively, you can define a configuration object with more options.
4273
4281
  */
4274
4282
  input: string | Record<string, unknown> | {
4283
+ /**
4284
+ * Prevent parts matching the regular expression from being processed.
4285
+ * You can select both operations and components by reference within
4286
+ * the bundled input. In case of conflicts, `exclude` takes precedence
4287
+ * over `include`.
4288
+ *
4289
+ * @example
4290
+ * operation: '^#/paths/api/v1/foo/get$'
4291
+ * schema: '^#/components/schemas/Foo$'
4292
+ */
4293
+ exclude?: string;
4275
4294
  /**
4276
4295
  * Process only parts matching the regular expression. You can select both
4277
- * operations and components by reference within the bundled input.
4296
+ * operations and components by reference within the bundled input. In
4297
+ * case of conflicts, `exclude` takes precedence over `include`.
4278
4298
  *
4279
4299
  * @example
4280
4300
  * operation: '^#/paths/api/v1/foo/get$'
package/dist/index.d.ts CHANGED
@@ -3802,7 +3802,7 @@ interface XMLObject {
3802
3802
  wrapped?: boolean;
3803
3803
  }
3804
3804
 
3805
- interface Config$9 extends PluginName<'@hey-api/schemas'> {
3805
+ interface Config$a extends PluginName<'@hey-api/schemas'> {
3806
3806
  /**
3807
3807
  * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
3808
3808
  * valid JavaScript/TypeScript identifier, e.g. if your schema name is
@@ -3970,7 +3970,7 @@ interface IRSchemaObject
3970
3970
  | 'void';
3971
3971
  }
3972
3972
 
3973
- interface Config$8 extends PluginName<'@hey-api/services'> {
3973
+ interface Config$9 extends PluginName<'@hey-api/services'> {
3974
3974
  /**
3975
3975
  * Group operation methods into service classes? When enabled, you can
3976
3976
  * select which classes to export with `services.include` and/or
@@ -4031,7 +4031,7 @@ interface Config$8 extends PluginName<'@hey-api/services'> {
4031
4031
  serviceNameBuilder?: string;
4032
4032
  }
4033
4033
 
4034
- interface Config$7 extends PluginName<'@hey-api/transformers'> {
4034
+ interface Config$8 extends PluginName<'@hey-api/transformers'> {
4035
4035
  /**
4036
4036
  * Convert date strings into Date objects?
4037
4037
  * @default false
@@ -4044,7 +4044,7 @@ interface Config$7 extends PluginName<'@hey-api/transformers'> {
4044
4044
  output?: string;
4045
4045
  }
4046
4046
 
4047
- interface Config$6 extends PluginName<'@hey-api/types'> {
4047
+ interface Config$7 extends PluginName<'@hey-api/types'> {
4048
4048
  /**
4049
4049
  * Generate enum definitions?
4050
4050
  * @default false
@@ -4078,7 +4078,7 @@ interface Config$6 extends PluginName<'@hey-api/types'> {
4078
4078
  tree?: boolean;
4079
4079
  }
4080
4080
 
4081
- interface Config$5
4081
+ interface Config$6
4082
4082
  extends PluginName<'@tanstack/angular-query-experimental'> {
4083
4083
  /**
4084
4084
  * 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 +4103,7 @@ interface Config$5
4103
4103
  queryOptions?: boolean;
4104
4104
  }
4105
4105
 
4106
- interface Config$4 extends PluginName<'@tanstack/react-query'> {
4106
+ interface Config$5 extends PluginName<'@tanstack/react-query'> {
4107
4107
  /**
4108
4108
  * 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.
4109
4109
  * @default true
@@ -4127,7 +4127,7 @@ interface Config$4 extends PluginName<'@tanstack/react-query'> {
4127
4127
  queryOptions?: boolean;
4128
4128
  }
4129
4129
 
4130
- interface Config$3 extends PluginName<'@tanstack/solid-query'> {
4130
+ interface Config$4 extends PluginName<'@tanstack/solid-query'> {
4131
4131
  /**
4132
4132
  * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
4133
4133
  * @default true
@@ -4151,7 +4151,7 @@ interface Config$3 extends PluginName<'@tanstack/solid-query'> {
4151
4151
  queryOptions?: boolean;
4152
4152
  }
4153
4153
 
4154
- interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
4154
+ interface Config$3 extends PluginName<'@tanstack/svelte-query'> {
4155
4155
  /**
4156
4156
  * Generate `createInfiniteQuery()` helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
4157
4157
  * @default true
@@ -4175,7 +4175,7 @@ interface Config$2 extends PluginName<'@tanstack/svelte-query'> {
4175
4175
  queryOptions?: boolean;
4176
4176
  }
4177
4177
 
4178
- interface Config$1 extends PluginName<'@tanstack/vue-query'> {
4178
+ interface Config$2 extends PluginName<'@tanstack/vue-query'> {
4179
4179
  /**
4180
4180
  * 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.
4181
4181
  * @default true
@@ -4199,7 +4199,7 @@ interface Config$1 extends PluginName<'@tanstack/vue-query'> {
4199
4199
  queryOptions?: boolean;
4200
4200
  }
4201
4201
 
4202
- interface Config extends PluginName<'fastify'> {
4202
+ interface Config$1 extends PluginName<'fastify'> {
4203
4203
  /**
4204
4204
  * Name of the generated file.
4205
4205
  * @default 'fastify'
@@ -4207,10 +4207,18 @@ interface Config extends PluginName<'fastify'> {
4207
4207
  output?: string;
4208
4208
  }
4209
4209
 
4210
+ interface Config extends PluginName<'zod'> {
4211
+ /**
4212
+ * Name of the generated file.
4213
+ * @default 'zod'
4214
+ */
4215
+ output?: string;
4216
+ }
4217
+
4210
4218
  /**
4211
4219
  * User-facing plugin types.
4212
4220
  */
4213
- 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>;
4221
+ 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>;
4214
4222
 
4215
4223
  declare const CLIENTS: readonly ["@hey-api/client-axios", "@hey-api/client-fetch", "legacy/angular", "legacy/axios", "legacy/fetch", "legacy/node", "legacy/xhr"];
4216
4224
  type Client$2 = (typeof CLIENTS)[number];
@@ -4272,9 +4280,21 @@ interface ClientConfig {
4272
4280
  * Alternatively, you can define a configuration object with more options.
4273
4281
  */
4274
4282
  input: string | Record<string, unknown> | {
4283
+ /**
4284
+ * Prevent parts matching the regular expression from being processed.
4285
+ * You can select both operations and components by reference within
4286
+ * the bundled input. In case of conflicts, `exclude` takes precedence
4287
+ * over `include`.
4288
+ *
4289
+ * @example
4290
+ * operation: '^#/paths/api/v1/foo/get$'
4291
+ * schema: '^#/components/schemas/Foo$'
4292
+ */
4293
+ exclude?: string;
4275
4294
  /**
4276
4295
  * Process only parts matching the regular expression. You can select both
4277
- * operations and components by reference within the bundled input.
4296
+ * operations and components by reference within the bundled input. In
4297
+ * case of conflicts, `exclude` takes precedence over `include`.
4278
4298
  *
4279
4299
  * @example
4280
4300
  * operation: '^#/paths/api/v1/foo/get$'