@hey-api/openapi-ts 0.54.0 → 0.54.2

package/dist/index.d.cts

@@ -3,6 +3,7 @@ type PluginNames =
   | '@hey-api/services'
   | '@hey-api/transformers'
   | '@hey-api/types'
+  | '@tanstack/angular-query-experimental'
   | '@tanstack/react-query'
   | '@tanstack/solid-query'
   | '@tanstack/svelte-query'
@@ -427,7 +428,7 @@ interface OpenApiV3_1_0 {
   /**
    * An element to hold various schemas for the document.
    */
-  components?: ComponentsObject;
+  components?: ComponentsObject$1;
   /**
    * Additional external documentation.
    */
@@ -443,7 +444,7 @@ interface OpenApiV3_1_0 {
   /**
    * **REQUIRED**. This string MUST be the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#versions version number} of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#infoVersion `info.version`} string.
    */
-  openapi: '3.1.0';
+  openapi: '3.1.0' | '3.1.1';
   /**
    * The available paths and operations for the API.
    */
@@ -643,7 +644,7 @@ interface CallbackObject {
  *             read:pets: read your pets
  * ```
  */
-interface ComponentsObject {
+interface ComponentsObject$1 {
   /**
    * An object to hold reusable {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object Callback Objects}.
    */
@@ -2507,7 +2508,7 @@ interface XMLObject {
   wrapped?: boolean;
 }
 
-interface Config$7 extends PluginName<'@hey-api/schemas'> {
+interface Config$8 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
@@ -2648,7 +2649,7 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$6 extends PluginName<'@hey-api/services'> {
+interface Config$7 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
@@ -2705,7 +2706,7 @@ interface Config$6 extends PluginName<'@hey-api/services'> {
   serviceNameBuilder?: string;
 }
 
-interface Config$5 extends PluginName<'@hey-api/transformers'> {
+interface Config$6 extends PluginName<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
    * @default false
@@ -2718,7 +2719,7 @@ interface Config$5 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$4 extends PluginName<'@hey-api/types'> {
+interface Config$5 extends PluginName<'@hey-api/types'> {
   /**
    * Generate enum definitions?
    * @default false
@@ -2746,6 +2747,31 @@ interface Config$4 extends PluginName<'@hey-api/types'> {
   tree?: boolean;
 }
 
+interface Config$4
+  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.
+   * @default true
+   */
+  infiniteQueryOptions?: boolean;
+  /**
+   * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/useMutation `useMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   * @default true
+   */
+  mutationOptions?: boolean;
+  /**
+   * Name of the generated file.
+   * @default '@tanstack/angular-query-experimental'
+   */
+  output?: string;
+  /**
+   * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/queryOptions `queryOptions()`} helpers?
+   * These will be generated from all requests.
+   * @default true
+   */
+  queryOptions?: boolean;
+}
+
 interface Config$3 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.
@@ -2845,7 +2871,7 @@ interface Config extends PluginName<'@tanstack/vue-query'> {
 /**
  * User-facing plugin types.
  */
-type UserPlugins = 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$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];
@@ -3200,14 +3226,6 @@ interface Client$1 {
     version: string;
 }
 
-interface OpenApiV3_0_3 {
-  /**
-   * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
-   */
-  openapi: '3.0.3';
-  // TODO
-}
-
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
  */
@@ -3283,6 +3301,26 @@ interface Client extends Omit<Client$1, 'operations'> {
     services: Service[];
 }
 
+/**
+ * This is the root object of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#openapi-description OpenAPI Description}.
+ *
+ * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#specification-extensions Specification Extensions}.
+ */
+interface OpenApiV3_0_0 {
+  /**
+   * An element to hold various Objects for the OpenAPI Description.
+   */
+  components?: ComponentsObject;
+  /**
+   * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
+   */
+  openapi: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.0.4';
+  // TODO
+}
+
+// TODO
+interface ComponentsObject {}
+
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
  * given language it will generate the client, including the typed models, validation schemas,
@@ -3299,4 +3337,4 @@ declare const _default: {
     defineConfig: (config: UserConfig) => UserConfig;
 };
 
-export { type OpenApiV3_0_3, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };
+export { type OpenApiV3_0_0, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ type PluginNames =
   | '@hey-api/services'
   | '@hey-api/transformers'
   | '@hey-api/types'
+  | '@tanstack/angular-query-experimental'
   | '@tanstack/react-query'
   | '@tanstack/solid-query'
   | '@tanstack/svelte-query'
@@ -427,7 +428,7 @@ interface OpenApiV3_1_0 {
   /**
    * An element to hold various schemas for the document.
    */
-  components?: ComponentsObject;
+  components?: ComponentsObject$1;
   /**
    * Additional external documentation.
    */
@@ -443,7 +444,7 @@ interface OpenApiV3_1_0 {
   /**
    * **REQUIRED**. This string MUST be the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#versions version number} of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#infoVersion `info.version`} string.
    */
-  openapi: '3.1.0';
+  openapi: '3.1.0' | '3.1.1';
   /**
    * The available paths and operations for the API.
    */
@@ -643,7 +644,7 @@ interface CallbackObject {
  *             read:pets: read your pets
  * ```
  */
-interface ComponentsObject {
+interface ComponentsObject$1 {
   /**
    * An object to hold reusable {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object Callback Objects}.
    */
@@ -2507,7 +2508,7 @@ interface XMLObject {
   wrapped?: boolean;
 }
 
-interface Config$7 extends PluginName<'@hey-api/schemas'> {
+interface Config$8 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
@@ -2648,7 +2649,7 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$6 extends PluginName<'@hey-api/services'> {
+interface Config$7 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
@@ -2705,7 +2706,7 @@ interface Config$6 extends PluginName<'@hey-api/services'> {
   serviceNameBuilder?: string;
 }
 
-interface Config$5 extends PluginName<'@hey-api/transformers'> {
+interface Config$6 extends PluginName<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
    * @default false
@@ -2718,7 +2719,7 @@ interface Config$5 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$4 extends PluginName<'@hey-api/types'> {
+interface Config$5 extends PluginName<'@hey-api/types'> {
   /**
    * Generate enum definitions?
    * @default false
@@ -2746,6 +2747,31 @@ interface Config$4 extends PluginName<'@hey-api/types'> {
   tree?: boolean;
 }
 
+interface Config$4
+  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.
+   * @default true
+   */
+  infiniteQueryOptions?: boolean;
+  /**
+   * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/useMutation `useMutation()`} helpers? These will be generated from DELETE, PATCH, POST, and PUT requests.
+   * @default true
+   */
+  mutationOptions?: boolean;
+  /**
+   * Name of the generated file.
+   * @default '@tanstack/angular-query-experimental'
+   */
+  output?: string;
+  /**
+   * Generate {@link https://tanstack.com/query/v5/docs/framework/angular/reference/queryOptions `queryOptions()`} helpers?
+   * These will be generated from all requests.
+   * @default true
+   */
+  queryOptions?: boolean;
+}
+
 interface Config$3 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.
@@ -2845,7 +2871,7 @@ interface Config extends PluginName<'@tanstack/vue-query'> {
 /**
  * User-facing plugin types.
  */
-type UserPlugins = 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$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];
@@ -3200,14 +3226,6 @@ interface Client$1 {
     version: string;
 }
 
-interface OpenApiV3_0_3 {
-  /**
-   * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
-   */
-  openapi: '3.0.3';
-  // TODO
-}
-
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
  */
@@ -3283,6 +3301,26 @@ interface Client extends Omit<Client$1, 'operations'> {
     services: Service[];
 }
 
+/**
+ * This is the root object of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#openapi-description OpenAPI Description}.
+ *
+ * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#specification-extensions Specification Extensions}.
+ */
+interface OpenApiV3_0_0 {
+  /**
+   * An element to hold various Objects for the OpenAPI Description.
+   */
+  components?: ComponentsObject;
+  /**
+   * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
+   */
+  openapi: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.0.4';
+  // TODO
+}
+
+// TODO
+interface ComponentsObject {}
+
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
  * given language it will generate the client, including the typed models, validation schemas,
@@ -3299,4 +3337,4 @@ declare const _default: {
     defineConfig: (config: UserConfig) => UserConfig;
 };
 
-export { type OpenApiV3_0_3, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };
+export { type OpenApiV3_0_0, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };