@kubb/plugin-react-query 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/components.d.cts

@@ -1,7 +1,7 @@
 import { Operation } from '@kubb/oas';
 import { OperationSchemas } from '@kubb/plugin-oas';
 import { ReactNode } from 'react';
-import { P as PluginReactQuery, I as Infinite } from './types-5pnOmDmM.cjs';
+import { P as PluginReactQuery, I as Infinite } from './types-LhwfnVo7.cjs';
 import { FunctionParams } from '@kubb/react';
 import '@kubb/core';
 

package/dist/components.d.ts

@@ -1,7 +1,7 @@
 import { Operation } from '@kubb/oas';
 import { OperationSchemas } from '@kubb/plugin-oas';
 import { ReactNode } from 'react';
-import { P as PluginReactQuery, I as Infinite } from './types-5pnOmDmM.js';
+import { P as PluginReactQuery, I as Infinite } from './types-LhwfnVo7.js';
 import { FunctionParams } from '@kubb/react';
 import '@kubb/core';
 

package/dist/generators.d.cts

@@ -1,5 +1,5 @@
 import * as _kubb_plugin_oas from '@kubb/plugin-oas';
-import { P as PluginReactQuery } from './types-5pnOmDmM.cjs';
+import { P as PluginReactQuery } from './types-LhwfnVo7.cjs';
 import '@kubb/core';
 import '@kubb/oas';
 

package/dist/generators.d.ts

@@ -1,5 +1,5 @@
 import * as _kubb_plugin_oas from '@kubb/plugin-oas';
-import { P as PluginReactQuery } from './types-5pnOmDmM.js';
+import { P as PluginReactQuery } from './types-LhwfnVo7.js';
 import '@kubb/core';
 import '@kubb/oas';
 

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _kubb_core from '@kubb/core';
-import { O as Options, P as PluginReactQuery } from './types-5pnOmDmM.cjs';
+import { O as Options, P as PluginReactQuery } from './types-LhwfnVo7.cjs';
 import '@kubb/oas';
 import '@kubb/plugin-oas';
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _kubb_core from '@kubb/core';
-import { O as Options, P as PluginReactQuery } from './types-5pnOmDmM.js';
+import { O as Options, P as PluginReactQuery } from './types-LhwfnVo7.js';
 import '@kubb/oas';
 import '@kubb/plugin-oas';
 

package/dist/{types-5pnOmDmM.d.cts → types-LhwfnVo7.d.cts}

@@ -26,7 +26,7 @@ type Options$1 = {
     override?: Array<Override<ResolvedOptions$1>>;
     /**
      * Create `operations.ts` file with all operations grouped by methods.
-     * @default `false`
+     * @default false
      */
     operations?: boolean;
     /**
@@ -38,27 +38,21 @@ type Options$1 = {
     importPath?: string;
     /**
      * ReturnType that will be used when calling the client.
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
      */
     dataReturnType?: 'data' | 'full';
     /**
      * How to pass your pathParams.
-     *
-     * `object` will return the pathParams as an object.
-     *
-     * `inline` will return the pathParams as comma separated params.
-     * @default `'inline'`
-     * @private
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
      */
     pathParamsType?: 'object' | 'inline';
     /**
      * Which parser can be used before returning the data
-     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
      * @default 'client'
      */
     parser?: 'client' | 'zod';
@@ -126,7 +120,7 @@ type Mutation = {
 type Infinite = {
     /**
      * Specify the params key used for `pageParam`.
-     * @default `'id'`
+     * @default 'id'
      */
     queryParam: string;
     /**
@@ -135,13 +129,14 @@ type Infinite = {
     cursorParam?: string | undefined;
     /**
      * The initial value, the value of the first page.
-     * @default `0`
+     * @default 0
      */
     initialPageParam: unknown;
 };
 type Options = {
     /**
-     * @default 'hooks'
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
      */
     output?: Output;
     /**
@@ -149,15 +144,6 @@ type Options = {
      */
     group?: Group;
     client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
-    /**
-     * ReturnType that needs to be used when calling client().
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
-     */
     /**
      * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
      */
@@ -172,12 +158,9 @@ type Options = {
     override?: Array<Override<ResolvedOptions>>;
     /**
      * How to pass your pathParams.
-     *
-     * `object` will return the pathParams as an object.
-     *
-     * `inline` will return the pathParams as comma separated params.
-     * @default `'inline'`
-     * @private
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
      */
     pathParamsType?: PluginClient['options']['pathParamsType'];
     /**

package/dist/{types-5pnOmDmM.d.ts → types-LhwfnVo7.d.ts}

@@ -26,7 +26,7 @@ type Options$1 = {
     override?: Array<Override<ResolvedOptions$1>>;
     /**
      * Create `operations.ts` file with all operations grouped by methods.
-     * @default `false`
+     * @default false
      */
     operations?: boolean;
     /**
@@ -38,27 +38,21 @@ type Options$1 = {
     importPath?: string;
     /**
      * ReturnType that will be used when calling the client.
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
      */
     dataReturnType?: 'data' | 'full';
     /**
      * How to pass your pathParams.
-     *
-     * `object` will return the pathParams as an object.
-     *
-     * `inline` will return the pathParams as comma separated params.
-     * @default `'inline'`
-     * @private
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
      */
     pathParamsType?: 'object' | 'inline';
     /**
      * Which parser can be used before returning the data
-     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
      * @default 'client'
      */
     parser?: 'client' | 'zod';
@@ -126,7 +120,7 @@ type Mutation = {
 type Infinite = {
     /**
      * Specify the params key used for `pageParam`.
-     * @default `'id'`
+     * @default 'id'
      */
     queryParam: string;
     /**
@@ -135,13 +129,14 @@ type Infinite = {
     cursorParam?: string | undefined;
     /**
      * The initial value, the value of the first page.
-     * @default `0`
+     * @default 0
      */
     initialPageParam: unknown;
 };
 type Options = {
     /**
-     * @default 'hooks'
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
      */
     output?: Output;
     /**
@@ -149,15 +144,6 @@ type Options = {
      */
     group?: Group;
     client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
-    /**
-     * ReturnType that needs to be used when calling client().
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
-     */
     /**
      * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
      */
@@ -172,12 +158,9 @@ type Options = {
     override?: Array<Override<ResolvedOptions>>;
     /**
      * How to pass your pathParams.
-     *
-     * `object` will return the pathParams as an object.
-     *
-     * `inline` will return the pathParams as comma separated params.
-     * @default `'inline'`
-     * @private
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
      */
     pathParamsType?: PluginClient['options']['pathParamsType'];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-react-query",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "description": "Generator react-query hooks",
   "keywords": [
     "faker",
@@ -62,24 +62,24 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.0.0-beta.3",
-    "@kubb/fs": "3.0.0-beta.3",
-    "@kubb/oas": "3.0.0-beta.3",
-    "@kubb/plugin-ts": "3.0.0-beta.3",
-    "@kubb/plugin-zod": "3.0.0-beta.3",
-    "@kubb/plugin-oas": "3.0.0-beta.3",
-    "@kubb/react": "3.0.0-beta.3"
+    "@kubb/core": "3.0.0-beta.5",
+    "@kubb/fs": "3.0.0-beta.5",
+    "@kubb/oas": "3.0.0-beta.5",
+    "@kubb/plugin-oas": "3.0.0-beta.5",
+    "@kubb/plugin-ts": "3.0.0-beta.5",
+    "@kubb/plugin-zod": "3.0.0-beta.5",
+    "@kubb/react": "3.0.0-beta.5"
   },
   "devDependencies": {
     "@types/react": "^18.3.11",
     "react": "^18.3.1",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@kubb/config-ts": "3.0.0-beta.3",
-    "@kubb/config-tsup": "3.0.0-beta.3"
+    "@kubb/config-ts": "3.0.0-beta.5",
+    "@kubb/config-tsup": "3.0.0-beta.5"
   },
   "peerDependencies": {
-    "@kubb/react": "3.0.0-beta.3"
+    "@kubb/react": "3.0.0-beta.5"
   },
   "engines": {
     "node": ">=20"

package/src/types.ts

@@ -49,7 +49,7 @@ type Mutation = {
 export type Infinite = {
   /**
    * Specify the params key used for `pageParam`.
-   * @default `'id'`
+   * @default 'id'
    */
   queryParam: string
   /**
@@ -58,14 +58,15 @@ export type Infinite = {
   cursorParam?: string | undefined
   /**
    * The initial value, the value of the first page.
-   * @default `0`
+   * @default 0
    */
   initialPageParam: unknown
 }
 
 export type Options = {
   /**
-   * @default 'hooks'
+   * Specify the export location for the files and define the behavior of the output
+   * @default { path: 'hooks', barrelType: 'named' }
    */
   output?: Output
   /**
@@ -74,16 +75,6 @@ export type Options = {
   group?: Group
 
   client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>
-  /**
-   * ReturnType that needs to be used when calling client().
-   *
-   * `Data` will return ResponseConfig[data].
-   *
-   * `Full` will return ResponseConfig.
-   * @default `'data'`
-   * @private
-   */
-
   /**
    * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
    */
@@ -98,12 +89,9 @@ export type Options = {
   override?: Array<Override<ResolvedOptions>>
   /**
    * How to pass your pathParams.
-   *
-   * `object` will return the pathParams as an object.
-   *
-   * `inline` will return the pathParams as comma separated params.
-   * @default `'inline'`
-   * @private
+   * - 'object' will return the pathParams as an object.
+   * - 'inline' will return the pathParams as comma separated params.
+   * @default 'inline'
    */
   pathParamsType?: PluginClient['options']['pathParamsType']