@kubb/plugin-vue-query 4.18.4 → 4.18.5

package/dist/components.d.cts

@@ -1,4 +1,4 @@
-import { c as Operation, i as Transformer, l as __name, o as OperationSchemas, r as PluginVueQuery, t as Infinite } from "./types-Cm8QPyAR.cjs";
+import { c as Operation, i as Transformer, l as __name, o as OperationSchemas, r as PluginVueQuery, t as Infinite } from "./types-CSXUFPjp.cjs";
 import { FunctionParams } from "@kubb/react-fabric";
 import { KubbNode } from "@kubb/react-fabric/types";
 

package/dist/components.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { c as Operation, i as Transformer, o as OperationSchemas, r as PluginVueQuery, t as Infinite } from "./types-Clkm8RVf.js";
+import { c as Operation, i as Transformer, o as OperationSchemas, r as PluginVueQuery, t as Infinite } from "./types-BSHLitv4.js";
 import { FunctionParams } from "@kubb/react-fabric";
 import { KubbNode } from "@kubb/react-fabric/types";
 

package/dist/generators.d.cts

@@ -1,4 +1,4 @@
-import { a as ReactGenerator, l as __name, r as PluginVueQuery } from "./types-Cm8QPyAR.cjs";
+import { a as ReactGenerator, l as __name, r as PluginVueQuery } from "./types-CSXUFPjp.cjs";
 
 //#region src/generators/infiniteQueryGenerator.d.ts
 declare const infiniteQueryGenerator: ReactGenerator<PluginVueQuery>;

package/dist/generators.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { a as ReactGenerator, r as PluginVueQuery } from "./types-Clkm8RVf.js";
+import { a as ReactGenerator, r as PluginVueQuery } from "./types-BSHLitv4.js";
 
 //#region src/generators/infiniteQueryGenerator.d.ts
 declare const infiniteQueryGenerator: ReactGenerator<PluginVueQuery>;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { l as __name, n as Options, r as PluginVueQuery, s as UserPluginWithLifeCycle } from "./types-Cm8QPyAR.cjs";
+import { l as __name, n as Options, r as PluginVueQuery, s as UserPluginWithLifeCycle } from "./types-CSXUFPjp.cjs";
 
 //#region src/plugin.d.ts
 declare const pluginVueQueryName = "plugin-vue-query";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-eQyhnF5A.js";
-import { n as Options, r as PluginVueQuery, s as UserPluginWithLifeCycle } from "./types-Clkm8RVf.js";
+import { n as Options, r as PluginVueQuery, s as UserPluginWithLifeCycle } from "./types-BSHLitv4.js";
 
 //#region src/plugin.d.ts
 declare const pluginVueQueryName = "plugin-vue-query";

package/dist/{types-Clkm8RVf.d.ts → types-BSHLitv4.d.ts}

@@ -37,7 +37,7 @@ declare class Oas extends BaseOas {
   getResponseSchema(operation: Operation$1, statusCode: string | number): SchemaObject$1;
   getRequestSchema(operation: Operation$1): SchemaObject$1 | undefined;
   getParametersSchema(operation: Operation$1, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-  valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
+  validate(): Promise<oas_normalize_lib_types0.ValidationResult>;
   flattenSchema(schema: SchemaObject$1 | null): SchemaObject$1 | null;
 }
 //#endregion
@@ -339,7 +339,7 @@ type Config<TInput = Input> = {
   input: TInput;
   output: {
     /**
-     * The path where all generated files will be exported.
+     * The path where all generated files receives exported.
      * This can be an absolute path or a path relative to the specified root option.
      */
     path: string;
@@ -354,41 +354,39 @@ type Config<TInput = Input> = {
     write?: boolean;
     /**
      * Specifies the formatting tool to be used.
-     * @default prettier
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome or prettier (in that order of preference).
-     * - 'prettier': Uses Prettier for code formatting.
-     * - 'biome': Uses Biome for code formatting.
-     *
+     * - 'auto' automatically detects and uses biome or prettier (in that order of preference).
+     * - 'prettier' uses Prettier for code formatting.
+     * - 'biome' uses Biome for code formatting.
+     * - 'oxfmt' uses Oxfmt for code formatting.
+     * - false disables code formatting.
+     * @default 'prettier'
      */
     format?: 'auto' | 'prettier' | 'biome' | 'oxfmt' | false;
     /**
      * Specifies the linter that should be used to analyze the code.
-     * The accepted values indicate different linting tools.
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome, oxlint, or eslint (in that order of preference).
-     * - 'eslint': Represents the use of ESLint, a widely used JavaScript linter.
-     * - 'biome': Represents the Biome linter, a modern tool for code scanning.
-     * - 'oxlint': Represents the Oxlint tool for linting purposes.
-     *
+     * - 'auto' automatically detects and uses biome, oxlint, or eslint (in that order of preference).
+     * - 'eslint' uses ESLint for linting.
+     * - 'biome' uses Biome for linting.
+     * - 'oxlint' uses Oxlint for linting.
+     * - false disables linting.
+     * @default 'auto'
      */
     lint?: 'auto' | 'eslint' | 'biome' | 'oxlint' | false;
     /**
-     * Override the extension to the generated imports and exports, by default each plugin will add an extension
+     * Overrides the extension for generated imports and exports. By default, each plugin adds an extension.
      * @default { '.ts': '.ts'}
      */
     extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>;
     /**
-     * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+     * Configures how `index.ts` files are created, including disabling barrel file generation. Each plugin has its own `barrelType` option; this setting controls the root barrel file (e.g., `src/gen/index.ts`).
      * @default 'named'
      */
     barrelType?: Exclude<BarrelType, 'propagate'> | false;
     /**
-     * Add a default banner to the beginning of every generated file. This makes it clear that the file was generated by Kubb.
-     * - 'simple': will only add banner with link to Kubb
-     * - 'full': will add source, title, description and the OpenAPI version used
+     * Adds a default banner to the start of every generated file indicating it was generated by Kubb.
+     * - 'simple' adds banner with link to Kubb.
+     * - 'full' adds source, title, description, and OpenAPI version.
+     * - false disables banner generation.
      * @default 'simple'
      */
     defaultBanner?: 'simple' | 'full' | false;
@@ -401,17 +399,17 @@ type Config<TInput = Input> = {
     override?: boolean;
   };
   /**
-   * An array of Kubb plugins that will be used in the generation.
+   * An array of Kubb plugins that used in the generation.
    * Each plugin may include additional configurable options(defined in the plugin itself).
-   * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details.
+   * If a plugin depends on another plugin, an error is returned if the required dependency is missing. See pre for more details.
    */
   plugins?: Array<Plugin>;
   /**
-   * Hooks that will be called when a specific action is triggered in Kubb.
+   * Hooks triggered when a specific action occurs in Kubb.
    */
   hooks?: {
     /**
-     * Hook that will be triggered at the end of all executions.
+     * Hook that triggers at the end of all executions.
      * Useful for running Prettier or ESLint to format/lint your code.
      */
     done?: string | Array<string>;
@@ -440,7 +438,7 @@ TContext = any,
 TResolvePathOptions extends object = object> = {
   name: TName;
   /**
-   * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
+   * Same behavior like what has been done with `QueryKey` in `@tanstack/react-query`
    */
   key: PluginKey<TName | string>;
   options: TOptions;
@@ -461,12 +459,12 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
    */
   options: TOptions['resolvedOptions'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   inject?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
@@ -484,12 +482,12 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
    */
   key: TOptions['key'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   /**
@@ -539,10 +537,12 @@ type ResolveNameParams = {
   name: string;
   pluginKey?: Plugin['key'];
   /**
-   * `file` will be used to customize the name of the created file(use of camelCase)
-   * `function` can be used to customize the exported functions(use of camelCase)
-   * `type` is a special type for TypeScript(use of PascalCase)
-   * `const` can be used for variables(use of camelCase)
+   * Specifies the type of entity being named.
+   * - 'file' customizes the name of the created file (uses camelCase).
+   * - 'function' customizes the exported function names (uses camelCase).
+   * - 'type' customizes TypeScript types (uses PascalCase).
+   * - 'const' customizes variable names (uses camelCase).
+   * @default undefined
    */
   type?: 'file' | 'function' | 'type' | 'const';
 };
@@ -597,11 +597,14 @@ type GroupContext = {
 };
 type Group = {
   /**
-   * Define a type where to group the files on
+   * Defines the type where to group the files.
+   * - 'tag' groups files by OpenAPI tags.
+   * - 'path' groups files by OpenAPI paths.
+   * @default undefined
    */
   type: 'tag' | 'path';
   /**
-   * Return the name of a group based on the group name, this will be used for the file and name generation
+   * Return the name of a group based on the group name, this used for the file and name generation
    */
   name?: (context: GroupContext) => string;
 };
@@ -673,7 +676,7 @@ declare class PluginManager {
     parameters: PluginParameter<H>;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
@@ -685,7 +688,7 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): Promise<SafeParseResult<H>>;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
@@ -697,15 +700,15 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): SafeParseResult<H>;
   /**
-   * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
+   * Runs all plugins in parallel based on `this.plugin` order and `pre`/`post` settings.
    */
-  hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
+  hookParallel<H extends PluginLifecycleHooks, TOutput = void>({
     hookName,
     parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-  }): Promise<Awaited<TOuput>[]>;
+  }): Promise<Awaited<TOutput>[]>;
   /**
    * Chains plugins
    */
@@ -974,8 +977,8 @@ type SchemaKeywordMapper = {
        */
       path: KubbFile.Path;
       /**
-       * When true `File.Import` will be used.
-       * When false a reference will be used inside the current file.
+       * When true `File.Import` is used.
+       * When false a reference is used inside the current file.
        */
       isImportable: boolean;
     };
@@ -1107,7 +1110,7 @@ type SchemaGeneratorOptions = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and name(propertName) and return FakerMeta array
+     * Receive schema and name(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1186,7 +1189,7 @@ type Options$1 = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1211,16 +1214,17 @@ type Options$1 = {
    */
   operations?: boolean;
   /**
-   * Export urls that are used by operation x
-   * `export` will make them part of your barrel file
-   * false will not make them exportable
+   * Export urls that are used by operation x.
+   * - 'export' makes them part of your barrel file.
+   * - false does not make them exportable.
+   * @default false
    * @example getGetPetByIdUrl
    */
   urlType?: 'export' | false;
   /**
-   * Path to the client import path that will be used to do the API calls.
-   * It will be used as `import client from '${client.importPath}'`.
-   * It allows both relative and absolute path but be aware that we will not change the path.
+   * Client import path for API calls.
+   * Used as `import client from '${client.importPath}'`.
+   * Accepts relative and absolute paths; path changes are not performed.
    */
   importPath?: string;
   /**
@@ -1228,49 +1232,50 @@ type Options$1 = {
    */
   baseURL?: string;
   /**
-   * ReturnType that will be used when calling the client.
-   * - 'data' will return ResponseConfig[data].
-   * - 'full' will return ResponseConfig.
+   * ReturnType that is used when calling the client.
+   * - 'data' returns ResponseConfig[data].
+   * - 'full' returns ResponseConfig.
    * @default 'data'
    */
   dataReturnType?: 'data' | 'full';
   /**
    * How to style your params, by default no casing is applied
-   * - 'camelcase' will use camelcase for the params names
+   * - 'camelcase' uses camelcase for the params names
    */
   paramsCasing?: 'camelcase';
   /**
-   * How to pass your params
-   * - 'object' will return the params and pathParams as an object.
-   * - 'inline' will return the params as comma separated params.
+   * How to pass your params.
+   * - 'object' returns the params and pathParams as an object.
+   * - 'inline' returns the params as comma separated params.
    * @default 'inline'
    */
   paramsType?: 'object' | 'inline';
   /**
    * How to pass your pathParams.
-   * - 'object' will return the pathParams as an object.
-   * - 'inline' will return the pathParams as comma separated params.
+   * - 'object' returns the pathParams as an object.
+   * - 'inline' returns 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.
+   * Which parser can be used before returning the data.
+   * - 'client' returns the data as-is from the client.
+   * - 'zod' uses @kubb/plugin-zod to parse the data.
    * @default 'client'
    */
   parser?: 'client' | 'zod';
   /**
-   * Which client should be used to do the HTTP calls
-   * - 'axios' will use `@kubb/plugin-client/templates/axios` to fetch data.
-   * - 'fetch' will use `@kubb/plugin-client/templates/fetch` to fetch data.
+   * Which client should be used to do the HTTP calls.
+   * - 'axios' uses axios client for HTTP requests.
+   * - 'fetch' uses native fetch API for HTTP requests.
    * @default 'axios'
    */
   client?: 'axios' | 'fetch';
   /**
-   * How to generate the client code
-   * - 'function' will generate standalone functions for each operation.
-   * - 'class' will generate a class with methods for each operation.
-   * - 'staticClass' will generate a class with static methods for each operation.
+   * How to generate the client code.
+   * - 'function' generates standalone functions for each operation.
+   * - 'class' generates a class with methods for each operation.
+   * - 'staticClass' generates a class with static methods for each operation.
    * @default 'function'
    */
   clientType?: 'function' | 'class' | 'staticClass';
@@ -1278,7 +1283,7 @@ type Options$1 = {
    * Bundle the selected client into the generated `.kubb` directory.
    * When disabled the generated clients will import the shared runtime from `@kubb/plugin-client/clients/*`.
    * @default false
-   * In version 5 of Kubb this will be by default true
+   * In version 5 of Kubb this is by default true
    */
   bundle?: boolean;
   transformers?: {
@@ -1331,10 +1336,10 @@ type Query = {
    */
   methods: Array<HttpMethod>;
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string;
@@ -1346,10 +1351,10 @@ type Mutation = {
    */
   methods: Array<HttpMethod>;
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string;
@@ -1361,17 +1366,17 @@ type Infinite = {
    */
   queryParam: string;
   /**
-   * Which field of the data will be used, set it to undefined when no cursor is known.
+   * Which field of the data is used, set it to undefined when no cursor is known.
    * @deprecated Use `nextParam` and `previousParam` instead for more flexible pagination handling.
    */
   cursorParam?: string | undefined;
   /**
-   * Which field of the data will be used to get the cursor for the next page.
+   * Which field of the data is used to get the cursor for the next page.
    * Supports dot notation (e.g. 'pagination.next.id') or array path (e.g. ['pagination', 'next', 'id']) to access nested fields.
    */
   nextParam?: string | string[] | undefined;
   /**
-   * Which field of the data will be used to get the cursor for the previous page.
+   * Which field of the data is used to get the cursor for the previous page.
    * Supports dot notation (e.g. 'pagination.prev.id') or array path (e.g. ['pagination', 'prev', 'id']) to access nested fields.
    */
   previousParam?: string | string[] | undefined;
@@ -1389,7 +1394,7 @@ type Options = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1411,40 +1416,40 @@ type Options = {
   override?: Array<Override<ResolvedOptions>>;
   /**
    * How to style your params, by default no casing is applied
-   * - 'camelcase' will use camelcase for the params names
+   * - 'camelcase' uses camelcase for the params names
    */
   paramsCasing?: 'camelcase';
   /**
    * How to pass your params
-   * - 'object' will return the params and pathParams as an object.
-   * - 'inline' will return the params as comma separated params.
+   * - 'object' returns the params and pathParams as an object.
+   * - 'inline' returns the params as comma separated params.
    * @default 'inline'
    */
   paramsType?: 'object' | 'inline';
   /**
    * How to pass your pathParams.
-   * - 'object' will return the pathParams as an object.
-   * - 'inline' will return the pathParams as comma separated params.
+   * - 'object' returns the pathParams as an object.
+   * - 'inline': returns the pathParams as comma separated params.
    * @default 'inline'
    */
   pathParamsType?: PluginClient['options']['pathParamsType'];
   /**
-   * When set, an infiniteQuery hooks will be added.
+   * When set, an infiniteQuery hooks is added.
    */
   infinite?: Partial<Infinite> | false;
   queryKey?: QueryKey;
   /**
-   * Override some useQuery behaviours.
+   * Override some useQuery behaviors.
    */
   query?: Partial<Query> | false;
   mutationKey?: MutationKey;
   /**
-   * Override some useMutation behaviours.
+   * Override some useMutation behaviors.
    */
   mutation?: Mutation | false;
   /**
    * Which parser should be used before returning the data to `@tanstack/query`.
-   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+   * `'zod'` uses `@kubb/plugin-zod` to parse the data.
    */
   parser?: PluginClient['options']['parser'];
   transformers?: {
@@ -1478,4 +1483,4 @@ type ResolvedOptions = {
 type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { ReactGenerator as a, Operation$1 as c, Transformer as i, Options as n, OperationSchemas as o, PluginVueQuery as r, UserPluginWithLifeCycle as s, Infinite as t };
-//# sourceMappingURL=types-Clkm8RVf.d.ts.map
+//# sourceMappingURL=types-BSHLitv4.d.ts.map

package/dist/{types-Cm8QPyAR.d.cts → types-CSXUFPjp.d.cts}

@@ -38,7 +38,7 @@ declare class Oas extends BaseOas {
   getResponseSchema(operation: Operation$1, statusCode: string | number): SchemaObject$1;
   getRequestSchema(operation: Operation$1): SchemaObject$1 | undefined;
   getParametersSchema(operation: Operation$1, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-  valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
+  validate(): Promise<oas_normalize_lib_types0.ValidationResult>;
   flattenSchema(schema: SchemaObject$1 | null): SchemaObject$1 | null;
 }
 //#endregion
@@ -340,7 +340,7 @@ type Config<TInput = Input> = {
   input: TInput;
   output: {
     /**
-     * The path where all generated files will be exported.
+     * The path where all generated files receives exported.
      * This can be an absolute path or a path relative to the specified root option.
      */
     path: string;
@@ -355,41 +355,39 @@ type Config<TInput = Input> = {
     write?: boolean;
     /**
      * Specifies the formatting tool to be used.
-     * @default prettier
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome or prettier (in that order of preference).
-     * - 'prettier': Uses Prettier for code formatting.
-     * - 'biome': Uses Biome for code formatting.
-     *
+     * - 'auto' automatically detects and uses biome or prettier (in that order of preference).
+     * - 'prettier' uses Prettier for code formatting.
+     * - 'biome' uses Biome for code formatting.
+     * - 'oxfmt' uses Oxfmt for code formatting.
+     * - false disables code formatting.
+     * @default 'prettier'
      */
     format?: 'auto' | 'prettier' | 'biome' | 'oxfmt' | false;
     /**
      * Specifies the linter that should be used to analyze the code.
-     * The accepted values indicate different linting tools.
-     *
-     * Possible values:
-     * - 'auto': Automatically detects and uses biome, oxlint, or eslint (in that order of preference).
-     * - 'eslint': Represents the use of ESLint, a widely used JavaScript linter.
-     * - 'biome': Represents the Biome linter, a modern tool for code scanning.
-     * - 'oxlint': Represents the Oxlint tool for linting purposes.
-     *
+     * - 'auto' automatically detects and uses biome, oxlint, or eslint (in that order of preference).
+     * - 'eslint' uses ESLint for linting.
+     * - 'biome' uses Biome for linting.
+     * - 'oxlint' uses Oxlint for linting.
+     * - false disables linting.
+     * @default 'auto'
      */
     lint?: 'auto' | 'eslint' | 'biome' | 'oxlint' | false;
     /**
-     * Override the extension to the generated imports and exports, by default each plugin will add an extension
+     * Overrides the extension for generated imports and exports. By default, each plugin adds an extension.
      * @default { '.ts': '.ts'}
      */
     extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>;
     /**
-     * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+     * Configures how `index.ts` files are created, including disabling barrel file generation. Each plugin has its own `barrelType` option; this setting controls the root barrel file (e.g., `src/gen/index.ts`).
      * @default 'named'
      */
     barrelType?: Exclude<BarrelType, 'propagate'> | false;
     /**
-     * Add a default banner to the beginning of every generated file. This makes it clear that the file was generated by Kubb.
-     * - 'simple': will only add banner with link to Kubb
-     * - 'full': will add source, title, description and the OpenAPI version used
+     * Adds a default banner to the start of every generated file indicating it was generated by Kubb.
+     * - 'simple' adds banner with link to Kubb.
+     * - 'full' adds source, title, description, and OpenAPI version.
+     * - false disables banner generation.
      * @default 'simple'
      */
     defaultBanner?: 'simple' | 'full' | false;
@@ -402,17 +400,17 @@ type Config<TInput = Input> = {
     override?: boolean;
   };
   /**
-   * An array of Kubb plugins that will be used in the generation.
+   * An array of Kubb plugins that used in the generation.
    * Each plugin may include additional configurable options(defined in the plugin itself).
-   * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details.
+   * If a plugin depends on another plugin, an error is returned if the required dependency is missing. See pre for more details.
    */
   plugins?: Array<Plugin>;
   /**
-   * Hooks that will be called when a specific action is triggered in Kubb.
+   * Hooks triggered when a specific action occurs in Kubb.
    */
   hooks?: {
     /**
-     * Hook that will be triggered at the end of all executions.
+     * Hook that triggers at the end of all executions.
      * Useful for running Prettier or ESLint to format/lint your code.
      */
     done?: string | Array<string>;
@@ -441,7 +439,7 @@ TContext = any,
 TResolvePathOptions extends object = object> = {
   name: TName;
   /**
-   * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
+   * Same behavior like what has been done with `QueryKey` in `@tanstack/react-query`
    */
   key: PluginKey<TName | string>;
   options: TOptions;
@@ -462,12 +460,12 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
    */
   options: TOptions['resolvedOptions'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   inject?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
@@ -485,12 +483,12 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
    */
   key: TOptions['key'];
   /**
-   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins.
+   * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin is executed after these plugins.
    * Can be used to validate dependent plugins.
    */
   pre?: Array<string>;
   /**
-   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
+   * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin is executed before these plugins.
    */
   post?: Array<string>;
   /**
@@ -540,10 +538,12 @@ type ResolveNameParams = {
   name: string;
   pluginKey?: Plugin['key'];
   /**
-   * `file` will be used to customize the name of the created file(use of camelCase)
-   * `function` can be used to customize the exported functions(use of camelCase)
-   * `type` is a special type for TypeScript(use of PascalCase)
-   * `const` can be used for variables(use of camelCase)
+   * Specifies the type of entity being named.
+   * - 'file' customizes the name of the created file (uses camelCase).
+   * - 'function' customizes the exported function names (uses camelCase).
+   * - 'type' customizes TypeScript types (uses PascalCase).
+   * - 'const' customizes variable names (uses camelCase).
+   * @default undefined
    */
   type?: 'file' | 'function' | 'type' | 'const';
 };
@@ -598,11 +598,14 @@ type GroupContext = {
 };
 type Group = {
   /**
-   * Define a type where to group the files on
+   * Defines the type where to group the files.
+   * - 'tag' groups files by OpenAPI tags.
+   * - 'path' groups files by OpenAPI paths.
+   * @default undefined
    */
   type: 'tag' | 'path';
   /**
-   * Return the name of a group based on the group name, this will be used for the file and name generation
+   * Return the name of a group based on the group name, this used for the file and name generation
    */
   name?: (context: GroupContext) => string;
 };
@@ -674,7 +677,7 @@ declare class PluginManager {
     parameters: PluginParameter<H>;
   }): Array<ReturnType<ParseResult<H>>> | null;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirst<H extends PluginLifecycleHooks>({
     hookName,
@@ -686,7 +689,7 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): Promise<SafeParseResult<H>>;
   /**
-   * First non-null result stops and will return it's value.
+   * Returns the first non-null result.
    */
   hookFirstSync<H extends PluginLifecycleHooks>({
     hookName,
@@ -698,15 +701,15 @@ declare class PluginManager {
     skipped?: ReadonlySet<Plugin> | null;
   }): SafeParseResult<H>;
   /**
-   * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
+   * Runs all plugins in parallel based on `this.plugin` order and `pre`/`post` settings.
    */
-  hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
+  hookParallel<H extends PluginLifecycleHooks, TOutput = void>({
     hookName,
     parameters
   }: {
     hookName: H;
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
-  }): Promise<Awaited<TOuput>[]>;
+  }): Promise<Awaited<TOutput>[]>;
   /**
    * Chains plugins
    */
@@ -975,8 +978,8 @@ type SchemaKeywordMapper = {
        */
       path: KubbFile.Path;
       /**
-       * When true `File.Import` will be used.
-       * When false a reference will be used inside the current file.
+       * When true `File.Import` is used.
+       * When false a reference is used inside the current file.
        */
       isImportable: boolean;
     };
@@ -1108,7 +1111,7 @@ type SchemaGeneratorOptions = {
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     /**
-     * Receive schema and name(propertName) and return FakerMeta array
+     * Receive schema and name(propertyName) and return FakerMeta array
      * TODO TODO add docs
      * @beta
      */
@@ -1187,7 +1190,7 @@ type Options$1 = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1212,16 +1215,17 @@ type Options$1 = {
    */
   operations?: boolean;
   /**
-   * Export urls that are used by operation x
-   * `export` will make them part of your barrel file
-   * false will not make them exportable
+   * Export urls that are used by operation x.
+   * - 'export' makes them part of your barrel file.
+   * - false does not make them exportable.
+   * @default false
    * @example getGetPetByIdUrl
    */
   urlType?: 'export' | false;
   /**
-   * Path to the client import path that will be used to do the API calls.
-   * It will be used as `import client from '${client.importPath}'`.
-   * It allows both relative and absolute path but be aware that we will not change the path.
+   * Client import path for API calls.
+   * Used as `import client from '${client.importPath}'`.
+   * Accepts relative and absolute paths; path changes are not performed.
    */
   importPath?: string;
   /**
@@ -1229,49 +1233,50 @@ type Options$1 = {
    */
   baseURL?: string;
   /**
-   * ReturnType that will be used when calling the client.
-   * - 'data' will return ResponseConfig[data].
-   * - 'full' will return ResponseConfig.
+   * ReturnType that is used when calling the client.
+   * - 'data' returns ResponseConfig[data].
+   * - 'full' returns ResponseConfig.
    * @default 'data'
    */
   dataReturnType?: 'data' | 'full';
   /**
    * How to style your params, by default no casing is applied
-   * - 'camelcase' will use camelcase for the params names
+   * - 'camelcase' uses camelcase for the params names
    */
   paramsCasing?: 'camelcase';
   /**
-   * How to pass your params
-   * - 'object' will return the params and pathParams as an object.
-   * - 'inline' will return the params as comma separated params.
+   * How to pass your params.
+   * - 'object' returns the params and pathParams as an object.
+   * - 'inline' returns the params as comma separated params.
    * @default 'inline'
    */
   paramsType?: 'object' | 'inline';
   /**
    * How to pass your pathParams.
-   * - 'object' will return the pathParams as an object.
-   * - 'inline' will return the pathParams as comma separated params.
+   * - 'object' returns the pathParams as an object.
+   * - 'inline' returns 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.
+   * Which parser can be used before returning the data.
+   * - 'client' returns the data as-is from the client.
+   * - 'zod' uses @kubb/plugin-zod to parse the data.
    * @default 'client'
    */
   parser?: 'client' | 'zod';
   /**
-   * Which client should be used to do the HTTP calls
-   * - 'axios' will use `@kubb/plugin-client/templates/axios` to fetch data.
-   * - 'fetch' will use `@kubb/plugin-client/templates/fetch` to fetch data.
+   * Which client should be used to do the HTTP calls.
+   * - 'axios' uses axios client for HTTP requests.
+   * - 'fetch' uses native fetch API for HTTP requests.
    * @default 'axios'
    */
   client?: 'axios' | 'fetch';
   /**
-   * How to generate the client code
-   * - 'function' will generate standalone functions for each operation.
-   * - 'class' will generate a class with methods for each operation.
-   * - 'staticClass' will generate a class with static methods for each operation.
+   * How to generate the client code.
+   * - 'function' generates standalone functions for each operation.
+   * - 'class' generates a class with methods for each operation.
+   * - 'staticClass' generates a class with static methods for each operation.
    * @default 'function'
    */
   clientType?: 'function' | 'class' | 'staticClass';
@@ -1279,7 +1284,7 @@ type Options$1 = {
    * Bundle the selected client into the generated `.kubb` directory.
    * When disabled the generated clients will import the shared runtime from `@kubb/plugin-client/clients/*`.
    * @default false
-   * In version 5 of Kubb this will be by default true
+   * In version 5 of Kubb this is by default true
    */
   bundle?: boolean;
   transformers?: {
@@ -1332,10 +1337,10 @@ type Query = {
    */
   methods: Array<HttpMethod>;
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string;
@@ -1347,10 +1352,10 @@ type Mutation = {
    */
   methods: Array<HttpMethod>;
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string;
@@ -1362,17 +1367,17 @@ type Infinite = {
    */
   queryParam: string;
   /**
-   * Which field of the data will be used, set it to undefined when no cursor is known.
+   * Which field of the data is used, set it to undefined when no cursor is known.
    * @deprecated Use `nextParam` and `previousParam` instead for more flexible pagination handling.
    */
   cursorParam?: string | undefined;
   /**
-   * Which field of the data will be used to get the cursor for the next page.
+   * Which field of the data is used to get the cursor for the next page.
    * Supports dot notation (e.g. 'pagination.next.id') or array path (e.g. ['pagination', 'next', 'id']) to access nested fields.
    */
   nextParam?: string | string[] | undefined;
   /**
-   * Which field of the data will be used to get the cursor for the previous page.
+   * Which field of the data is used to get the cursor for the previous page.
    * Supports dot notation (e.g. 'pagination.prev.id') or array path (e.g. ['pagination', 'prev', 'id']) to access nested fields.
    */
   previousParam?: string | string[] | undefined;
@@ -1390,7 +1395,7 @@ type Options = {
   output?: Output<Oas>;
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType;
   /**
@@ -1412,40 +1417,40 @@ type Options = {
   override?: Array<Override<ResolvedOptions>>;
   /**
    * How to style your params, by default no casing is applied
-   * - 'camelcase' will use camelcase for the params names
+   * - 'camelcase' uses camelcase for the params names
    */
   paramsCasing?: 'camelcase';
   /**
    * How to pass your params
-   * - 'object' will return the params and pathParams as an object.
-   * - 'inline' will return the params as comma separated params.
+   * - 'object' returns the params and pathParams as an object.
+   * - 'inline' returns the params as comma separated params.
    * @default 'inline'
    */
   paramsType?: 'object' | 'inline';
   /**
    * How to pass your pathParams.
-   * - 'object' will return the pathParams as an object.
-   * - 'inline' will return the pathParams as comma separated params.
+   * - 'object' returns the pathParams as an object.
+   * - 'inline': returns the pathParams as comma separated params.
    * @default 'inline'
    */
   pathParamsType?: PluginClient['options']['pathParamsType'];
   /**
-   * When set, an infiniteQuery hooks will be added.
+   * When set, an infiniteQuery hooks is added.
    */
   infinite?: Partial<Infinite> | false;
   queryKey?: QueryKey;
   /**
-   * Override some useQuery behaviours.
+   * Override some useQuery behaviors.
    */
   query?: Partial<Query> | false;
   mutationKey?: MutationKey;
   /**
-   * Override some useMutation behaviours.
+   * Override some useMutation behaviors.
    */
   mutation?: Mutation | false;
   /**
    * Which parser should be used before returning the data to `@tanstack/query`.
-   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+   * `'zod'` uses `@kubb/plugin-zod` to parse the data.
    */
   parser?: PluginClient['options']['parser'];
   transformers?: {
@@ -1479,4 +1484,4 @@ type ResolvedOptions = {
 type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { ReactGenerator as a, Operation$1 as c, Transformer as i, __name as l, Options as n, OperationSchemas as o, PluginVueQuery as r, UserPluginWithLifeCycle as s, Infinite as t };
-//# sourceMappingURL=types-Cm8QPyAR.d.cts.map
+//# sourceMappingURL=types-CSXUFPjp.d.cts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-vue-query",
-  "version": "4.18.4",
+  "version": "4.18.5",
   "description": "Vue Query hooks generator plugin for Kubb, creating type-safe API client hooks from OpenAPI specifications for Vue.js applications.",
   "keywords": [
     "vue-query",
@@ -70,12 +70,12 @@
   "dependencies": {
     "@kubb/react-fabric": "0.12.4",
     "remeda": "^2.33.4",
-    "@kubb/core": "4.18.4",
-    "@kubb/oas": "4.18.4",
-    "@kubb/plugin-client": "4.18.4",
-    "@kubb/plugin-oas": "4.18.4",
-    "@kubb/plugin-ts": "4.18.4",
-    "@kubb/plugin-zod": "4.18.4"
+    "@kubb/core": "4.18.5",
+    "@kubb/oas": "4.18.5",
+    "@kubb/plugin-client": "4.18.5",
+    "@kubb/plugin-oas": "4.18.5",
+    "@kubb/plugin-ts": "4.18.5",
+    "@kubb/plugin-zod": "4.18.5"
   },
   "peerDependencies": {
     "@kubb/react-fabric": "0.12.4"

package/src/types.ts

@@ -30,10 +30,10 @@ type Query = {
    */
   methods: Array<HttpMethod>
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string
@@ -46,10 +46,10 @@ type Mutation = {
    */
   methods: Array<HttpMethod>
   /**
-   * Path to the useQuery that will be used to do the useQuery functionality.
-   * It will be used as `import { useQuery } from '${importPath}'`.
-   * It allows both relative and absolute path.
-   * the path will be applied as is, so relative path should be based on the file being generated.
+   * Path to the useQuery hook for useQuery functionality.
+   * Used as `import { useQuery } from '${importPath}'`.
+   * Accepts relative and absolute paths.
+   * Path is used as-is; relative paths are based on the generated file location.
    * @default '@tanstack/react-query'
    */
   importPath?: string
@@ -62,17 +62,17 @@ export type Infinite = {
    */
   queryParam: string
   /**
-   * Which field of the data will be used, set it to undefined when no cursor is known.
+   * Which field of the data is used, set it to undefined when no cursor is known.
    * @deprecated Use `nextParam` and `previousParam` instead for more flexible pagination handling.
    */
   cursorParam?: string | undefined
   /**
-   * Which field of the data will be used to get the cursor for the next page.
+   * Which field of the data is used to get the cursor for the next page.
    * Supports dot notation (e.g. 'pagination.next.id') or array path (e.g. ['pagination', 'next', 'id']) to access nested fields.
    */
   nextParam?: string | string[] | undefined
   /**
-   * Which field of the data will be used to get the cursor for the previous page.
+   * Which field of the data is used to get the cursor for the previous page.
    * Supports dot notation (e.g. 'pagination.prev.id') or array path (e.g. ['pagination', 'prev', 'id']) to access nested fields.
    */
   previousParam?: string | string[] | undefined
@@ -91,7 +91,7 @@ export type Options = {
   output?: Output<Oas>
   /**
    * Define which contentType should be used.
-   * By default, the first JSON valid mediaType will be used
+   * By default, the first JSON valid mediaType is used
    */
   contentType?: contentType
   /**
@@ -113,40 +113,40 @@ export type Options = {
   override?: Array<Override<ResolvedOptions>>
   /**
    * How to style your params, by default no casing is applied
-   * - 'camelcase' will use camelcase for the params names
+   * - 'camelcase' uses camelcase for the params names
    */
   paramsCasing?: 'camelcase'
   /**
    * How to pass your params
-   * - 'object' will return the params and pathParams as an object.
-   * - 'inline' will return the params as comma separated params.
+   * - 'object' returns the params and pathParams as an object.
+   * - 'inline' returns the params as comma separated params.
    * @default 'inline'
    */
   paramsType?: 'object' | 'inline'
   /**
    * How to pass your pathParams.
-   * - 'object' will return the pathParams as an object.
-   * - 'inline' will return the pathParams as comma separated params.
+   * - 'object' returns the pathParams as an object.
+   * - 'inline': returns the pathParams as comma separated params.
    * @default 'inline'
    */
   pathParamsType?: PluginClient['options']['pathParamsType']
   /**
-   * When set, an infiniteQuery hooks will be added.
+   * When set, an infiniteQuery hooks is added.
    */
   infinite?: Partial<Infinite> | false
   queryKey?: QueryKey
   /**
-   * Override some useQuery behaviours.
+   * Override some useQuery behaviors.
    */
   query?: Partial<Query> | false
   mutationKey?: MutationKey
   /**
-   * Override some useMutation behaviours.
+   * Override some useMutation behaviors.
    */
   mutation?: Mutation | false
   /**
    * Which parser should be used before returning the data to `@tanstack/query`.
-   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+   * `'zod'` uses `@kubb/plugin-zod` to parse the data.
    */
   parser?: PluginClient['options']['parser']
   transformers?: {