@kubb/plugin-vue-query 3.0.0-alpha.20

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginVueQuery } from './types-CmetQDTc.js';
+import '@kubb/oas';
+import '@kubb/plugin-oas';
+
+declare const pluginVueQueryName = "plugin-vue-query";
+declare const pluginVueQuery: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginVueQuery>;
+
+export { PluginVueQuery, pluginVueQuery, pluginVueQueryName };

package/dist/index.js

@@ -0,0 +1,131 @@
+import { queryGenerator, infiniteQueryGenerator, mutationGenerator } from './chunk-3HD4DCDR.js';
+import './chunk-BKYBSBUA.js';
+import path from 'node:path';
+import { createPlugin, FileManager, PluginManager } from '@kubb/core';
+import { camelCase, pascalCase } from '@kubb/core/transformers';
+import { renderTemplate } from '@kubb/core/utils';
+import { pluginOasName, OperationGenerator } from '@kubb/plugin-oas';
+import { pluginTsName } from '@kubb/plugin-ts';
+import { pluginZodName } from '@kubb/plugin-zod';
+
+var pluginVueQueryName = "plugin-vue-query";
+var pluginVueQuery = createPlugin((options) => {
+  const {
+    output = { path: "hooks" },
+    group,
+    exclude = [],
+    include,
+    override = [],
+    parser = "client",
+    infinite,
+    transformers = {},
+    pathParamsType = "inline",
+    mutation = {},
+    query = {}
+  } = options;
+  const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`;
+  return {
+    name: pluginVueQueryName,
+    options: {
+      output: {
+        exportType: "barrelNamed",
+        ...output
+      },
+      baseURL: void 0,
+      client: {
+        importPath: "@kubb/plugin-client/client",
+        dataReturnType: "data",
+        pathParamsType: "inline",
+        ...options.client
+      },
+      infinite: infinite ? {
+        queryParam: "id",
+        initialPageParam: 0,
+        cursorParam: void 0,
+        ...infinite
+      } : false,
+      query: {
+        key: (key) => key,
+        methods: ["get"],
+        importPath: "@tanstack/vue-query",
+        ...query
+      },
+      mutation: {
+        methods: ["post", "put", "patch", "delete"],
+        importPath: "@tanstack/vue-query",
+        ...mutation
+      },
+      pathParamsType,
+      parser
+    },
+    pre: [pluginOasName, pluginTsName, parser === "zod" ? pluginZodName : void 0].filter(Boolean),
+    resolvePath(baseName, pathMode, options2) {
+      const root = path.resolve(this.config.root, this.config.output.path);
+      const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path));
+      if (mode === "single") {
+        return path.resolve(root, output.path);
+      }
+      if (options2?.tag && group?.type === "tag") {
+        const tag = camelCase(options2.tag);
+        return path.resolve(root, renderTemplate(template, { tag }), baseName);
+      }
+      return path.resolve(root, output.path, baseName);
+    },
+    resolveName(name, type) {
+      let resolvedName = camelCase(name);
+      if (type === "file" || type === "function") {
+        resolvedName = camelCase(name, {
+          isFile: type === "file"
+        });
+      }
+      if (type === "type") {
+        resolvedName = pascalCase(name);
+      }
+      if (type) {
+        return transformers?.name?.(resolvedName, type) || resolvedName;
+      }
+      return resolvedName;
+    },
+    async buildStart() {
+      const [swaggerPlugin] = PluginManager.getDependedPlugins(this.plugins, [pluginOasName]);
+      const oas = await swaggerPlugin.context.getOas();
+      const root = path.resolve(this.config.root, this.config.output.path);
+      const mode = FileManager.getMode(path.resolve(root, output.path));
+      const baseURL = await swaggerPlugin.context.getBaseURL();
+      const operationGenerator = new OperationGenerator(
+        {
+          ...this.plugin.options,
+          baseURL
+        },
+        {
+          oas,
+          pluginManager: this.pluginManager,
+          plugin: this.plugin,
+          contentType: swaggerPlugin.context.contentType,
+          exclude,
+          include,
+          override,
+          mode
+        }
+      );
+      const files = await operationGenerator.build(queryGenerator, infiniteQueryGenerator, mutationGenerator);
+      await this.addFile(...files);
+      if (this.config.output.exportType) {
+        const barrelFiles = await this.fileManager.getBarrelFiles({
+          root,
+          output,
+          files: this.fileManager.files,
+          meta: {
+            pluginKey: this.plugin.key
+          },
+          logger: this.logger
+        });
+        await this.addFile(...barrelFiles);
+      }
+    }
+  };
+});
+
+export { pluginVueQuery, pluginVueQueryName };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"names":["options"],"mappings":";;;;;;;;;;AAeO,IAAM,kBAAqB,GAAA,mBAAA;AAErB,IAAA,cAAA,GAAiB,YAA6B,CAAA,CAAC,OAAY,KAAA;AACtE,EAAM,MAAA;AAAA,IACJ,MAAA,GAAS,EAAE,IAAA,EAAM,OAAQ,EAAA;AAAA,IACzB,KAAA;AAAA,IACA,UAAU,EAAC;AAAA,IACX,OAAA;AAAA,IACA,WAAW,EAAC;AAAA,IACZ,MAAS,GAAA,QAAA;AAAA,IACT,QAAA;AAAA,IACA,eAAe,EAAC;AAAA,IAChB,cAAiB,GAAA,QAAA;AAAA,IACjB,WAAW,EAAC;AAAA,IACZ,QAAQ,EAAC;AAAA,GACP,GAAA,OAAA,CAAA;AACJ,EAAA,MAAM,WAAW,KAAO,EAAA,MAAA,GAAS,MAAM,MAAS,GAAA,CAAA,EAAG,OAAO,IAAI,CAAA,kBAAA,CAAA,CAAA;AAE9D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,kBAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,aAAA;AAAA,QACZ,GAAG,MAAA;AAAA,OACL;AAAA,MACA,OAAS,EAAA,KAAA,CAAA;AAAA,MACT,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,4BAAA;AAAA,QACZ,cAAgB,EAAA,MAAA;AAAA,QAChB,cAAgB,EAAA,QAAA;AAAA,QAChB,GAAG,OAAQ,CAAA,MAAA;AAAA,OACb;AAAA,MACA,UAAU,QACN,GAAA;AAAA,QACE,UAAY,EAAA,IAAA;AAAA,QACZ,gBAAkB,EAAA,CAAA;AAAA,QAClB,WAAa,EAAA,KAAA,CAAA;AAAA,QACb,GAAG,QAAA;AAAA,OAEL,GAAA,KAAA;AAAA,MACJ,KAAO,EAAA;AAAA,QACL,GAAA,EAAK,CAAC,GAAmB,KAAA,GAAA;AAAA,QACzB,OAAA,EAAS,CAAC,KAAK,CAAA;AAAA,QACf,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG,KAAA;AAAA,OACL;AAAA,MACA,QAAU,EAAA;AAAA,QACR,OAAS,EAAA,CAAC,MAAQ,EAAA,KAAA,EAAO,SAAS,QAAQ,CAAA;AAAA,QAC1C,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG,QAAA;AAAA,OACL;AAAA,MACA,cAAA;AAAA,MACA,MAAA;AAAA,KACF;AAAA,IACA,GAAA,EAAK,CAAC,aAAA,EAAe,YAAc,EAAA,MAAA,KAAW,QAAQ,aAAgB,GAAA,KAAA,CAAS,CAAE,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA,IAC/F,WAAA,CAAY,QAAU,EAAA,QAAA,EAAUA,QAAS,EAAA;AACvC,MAAM,MAAA,IAAA,GAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,WAAY,CAAA,OAAA,CAAQ,KAAK,OAAQ,CAAA,IAAA,EAAM,MAAO,CAAA,IAAI,CAAC,CAAA,CAAA;AAE5E,MAAA,IAAI,SAAS,QAAU,EAAA;AAKrB,QAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AAAA,OACvC;AAEA,MAAA,IAAIA,QAAS,EAAA,GAAA,IAAO,KAAO,EAAA,IAAA,KAAS,KAAO,EAAA;AACzC,QAAM,MAAA,GAAA,GAAM,SAAUA,CAAAA,QAAAA,CAAQ,GAAG,CAAA,CAAA;AAEjC,QAAO,OAAA,IAAA,CAAK,QAAQ,IAAM,EAAA,cAAA,CAAe,UAAU,EAAE,GAAA,EAAK,CAAA,EAAG,QAAQ,CAAA,CAAA;AAAA,OACvE;AAEA,MAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,QAAQ,CAAA,CAAA;AAAA,KACjD;AAAA,IACA,WAAA,CAAY,MAAM,IAAM,EAAA;AACtB,MAAI,IAAA,YAAA,GAAe,UAAU,IAAI,CAAA,CAAA;AAEjC,MAAI,IAAA,IAAA,KAAS,MAAU,IAAA,IAAA,KAAS,UAAY,EAAA;AAC1C,QAAA,YAAA,GAAe,UAAU,IAAM,EAAA;AAAA,UAC7B,QAAQ,IAAS,KAAA,MAAA;AAAA,SAClB,CAAA,CAAA;AAAA,OACH;AACA,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAA,YAAA,GAAe,WAAW,IAAI,CAAA,CAAA;AAAA,OAChC;AAEA,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,OAAO,YAAc,EAAA,IAAA,GAAO,YAAc,EAAA,IAAI,CAAK,IAAA,YAAA,CAAA;AAAA,OACrD;AAEA,MAAO,OAAA,YAAA,CAAA;AAAA,KACT;AAAA,IACA,MAAM,UAAa,GAAA;AACjB,MAAM,MAAA,CAAC,aAAa,CAAyB,GAAA,aAAA,CAAc,mBAA8B,IAAK,CAAA,OAAA,EAAS,CAAC,aAAa,CAAC,CAAA,CAAA;AAEtH,MAAA,MAAM,GAAM,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,MAAO,EAAA,CAAA;AAC/C,MAAM,MAAA,IAAA,GAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,OAAQ,CAAA,IAAA,CAAK,QAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAC,CAAA,CAAA;AAChE,MAAA,MAAM,OAAU,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,UAAW,EAAA,CAAA;AAEvD,MAAA,MAAM,qBAAqB,IAAI,kBAAA;AAAA,QAC7B;AAAA,UACE,GAAG,KAAK,MAAO,CAAA,OAAA;AAAA,UACf,OAAA;AAAA,SACF;AAAA,QACA;AAAA,UACE,GAAA;AAAA,UACA,eAAe,IAAK,CAAA,aAAA;AAAA,UACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,UACnC,OAAA;AAAA,UACA,OAAA;AAAA,UACA,QAAA;AAAA,UACA,IAAA;AAAA,SACF;AAAA,OACF,CAAA;AAEA,MAAA,MAAM,QAAQ,MAAM,kBAAA,CAAmB,KAAM,CAAA,cAAA,EAAgB,wBAAwB,iBAAiB,CAAA,CAAA;AACtG,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,KAAK,CAAA,CAAA;AAE3B,MAAI,IAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,UAAY,EAAA;AACjC,QAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,CAAA;AAAA,UACxD,IAAA;AAAA,UACA,MAAA;AAAA,UACA,KAAA,EAAO,KAAK,WAAY,CAAA,KAAA;AAAA,UACxB,IAAM,EAAA;AAAA,YACJ,SAAA,EAAW,KAAK,MAAO,CAAA,GAAA;AAAA,WACzB;AAAA,UACA,QAAQ,IAAK,CAAA,MAAA;AAAA,SACd,CAAA,CAAA;AAED,QAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA,CAAA;AAAA,OACnC;AAAA,KACF;AAAA,GACF,CAAA;AACF,CAAC","file":"index.js","sourcesContent":["import path from 'node:path'\n\nimport { FileManager, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase, pascalCase } from '@kubb/core/transformers'\nimport { renderTemplate } from '@kubb/core/utils'\nimport { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'\n\nimport { pluginTsName } from '@kubb/plugin-ts'\nimport { pluginZodName } from '@kubb/plugin-zod'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas } from '@kubb/plugin-oas'\nimport { infiniteQueryGenerator, mutationGenerator, queryGenerator } from './generators'\nimport type { PluginVueQuery } from './types.ts'\n\nexport const pluginVueQueryName = 'plugin-vue-query' satisfies PluginVueQuery['name']\n\nexport const pluginVueQuery = createPlugin<PluginVueQuery>((options) => {\n  const {\n    output = { path: 'hooks' },\n    group,\n    exclude = [],\n    include,\n    override = [],\n    parser = 'client',\n    infinite,\n    transformers = {},\n    pathParamsType = 'inline',\n    mutation = {},\n    query = {},\n  } = options\n  const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`\n\n  return {\n    name: pluginVueQueryName,\n    options: {\n      output: {\n        exportType: 'barrelNamed',\n        ...output,\n      },\n      baseURL: undefined,\n      client: {\n        importPath: '@kubb/plugin-client/client',\n        dataReturnType: 'data',\n        pathParamsType: 'inline',\n        ...options.client,\n      },\n      infinite: infinite\n        ? {\n            queryParam: 'id',\n            initialPageParam: 0,\n            cursorParam: undefined,\n            ...infinite,\n          }\n        : false,\n      query: {\n        key: (key: unknown[]) => key,\n        methods: ['get'],\n        importPath: '@tanstack/vue-query',\n        ...query,\n      },\n      mutation: {\n        methods: ['post', 'put', 'patch', 'delete'],\n        importPath: '@tanstack/vue-query',\n        ...mutation,\n      },\n      pathParamsType,\n      parser,\n    },\n    pre: [pluginOasName, pluginTsName, parser === 'zod' ? pluginZodName : undefined].filter(Boolean),\n    resolvePath(baseName, pathMode, options) {\n      const root = path.resolve(this.config.root, this.config.output.path)\n      const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))\n\n      if (mode === 'single') {\n        /**\n         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend\n         * Other plugins then need to call addOrAppend instead of just add from the fileManager class\n         */\n        return path.resolve(root, output.path)\n      }\n\n      if (options?.tag && group?.type === 'tag') {\n        const tag = camelCase(options.tag)\n\n        return path.resolve(root, renderTemplate(template, { tag }), baseName)\n      }\n\n      return path.resolve(root, output.path, baseName)\n    },\n    resolveName(name, type) {\n      let resolvedName = camelCase(name)\n\n      if (type === 'file' || type === 'function') {\n        resolvedName = camelCase(name, {\n          isFile: type === 'file',\n        })\n      }\n      if (type === 'type') {\n        resolvedName = pascalCase(name)\n      }\n\n      if (type) {\n        return transformers?.name?.(resolvedName, type) || resolvedName\n      }\n\n      return resolvedName\n    },\n    async buildStart() {\n      const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n\n      const oas = await swaggerPlugin.context.getOas()\n      const root = path.resolve(this.config.root, this.config.output.path)\n      const mode = FileManager.getMode(path.resolve(root, output.path))\n      const baseURL = await swaggerPlugin.context.getBaseURL()\n\n      const operationGenerator = new OperationGenerator(\n        {\n          ...this.plugin.options,\n          baseURL,\n        },\n        {\n          oas,\n          pluginManager: this.pluginManager,\n          plugin: this.plugin,\n          contentType: swaggerPlugin.context.contentType,\n          exclude,\n          include,\n          override,\n          mode,\n        },\n      )\n\n      const files = await operationGenerator.build(queryGenerator, infiniteQueryGenerator, mutationGenerator)\n      await this.addFile(...files)\n\n      if (this.config.output.exportType) {\n        const barrelFiles = await this.fileManager.getBarrelFiles({\n          root,\n          output,\n          files: this.fileManager.files,\n          meta: {\n            pluginKey: this.plugin.key,\n          },\n          logger: this.logger,\n        })\n\n        await this.addFile(...barrelFiles)\n      }\n    },\n  }\n})\n"]}

package/dist/types-CmetQDTc.d.cts

@@ -0,0 +1,173 @@
+import { PluginFactoryOptions, Output, ResolveNameParams } from '@kubb/core';
+import { HttpMethod } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
+
+type Query = {
+    /**
+     * Customize the queryKey, here you can specify a suffix.
+     */
+    key: (key: unknown[]) => unknown[];
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    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.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Mutation = {
+    /**
+     * Define which HttpMethods can be used for mutations
+     * @default ['post', 'put', 'delete']
+     */
+    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.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Infinite = {
+    /**
+     * Specify the params key used for `pageParam`.
+     * Used inside `useInfiniteQuery`, `createInfiniteQueries`, `createInfiniteQuery`
+     * @default `'id'`
+     */
+    queryParam: string;
+    /**
+     * Which field of the data will be used, set it to undefined when no cursor is known.
+     */
+    cursorParam?: string | undefined;
+    /**
+     * The initial value, the value of the first page.
+     * @default `0`
+     */
+    initialPageParam: unknown;
+};
+type Options = {
+    /**
+     * @default 'hooks'
+     */
+    output?: Output;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped @tanstack/query hooks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `hooks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Hooks"`
+         */
+        exportAs?: string;
+    };
+    client?: {
+        /**
+         * Path to the client 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.
+         * the path will be applied as is, so relative path should be based on the file being generated.
+         * @default '@kubb/plugin-client/client'
+         */
+        importPath?: string;
+        /**
+         * ReturnType that needs to be used when calling client().
+         *
+         * `Data` will return ResponseConfig[data].
+         *
+         * `Full` will return ResponseConfig.
+         * @default `'data'`
+         * @private
+         */
+        dataReturnType?: 'data' | 'full';
+    };
+    /**
+     * 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.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    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
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * When set, an infiniteQuery hooks will be added.
+     */
+    infinite?: Partial<Infinite> | false;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query> | false;
+    /**
+     * Override some useMutation behaviours.
+     */
+    mutation?: Mutation | false;
+    /**
+     * Which parser can be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: 'client' | 'zod';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+};
+type ResolvedOptions = {
+    output: Output;
+    baseURL: string | undefined;
+    client: Required<NonNullable<PluginVueQuery['options']['client']>>;
+    parser: Required<NonNullable<Options['parser']>>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    /**
+     * Only used of infinite
+     */
+    infinite: NonNullable<Infinite> | false;
+    query: NonNullable<Required<Query>> | false;
+    mutation: NonNullable<Required<Mutation>> | false;
+};
+type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Infinite as I, Options as O, PluginVueQuery as P };

package/dist/types-CmetQDTc.d.ts

@@ -0,0 +1,173 @@
+import { PluginFactoryOptions, Output, ResolveNameParams } from '@kubb/core';
+import { HttpMethod } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
+
+type Query = {
+    /**
+     * Customize the queryKey, here you can specify a suffix.
+     */
+    key: (key: unknown[]) => unknown[];
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    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.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Mutation = {
+    /**
+     * Define which HttpMethods can be used for mutations
+     * @default ['post', 'put', 'delete']
+     */
+    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.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Infinite = {
+    /**
+     * Specify the params key used for `pageParam`.
+     * Used inside `useInfiniteQuery`, `createInfiniteQueries`, `createInfiniteQuery`
+     * @default `'id'`
+     */
+    queryParam: string;
+    /**
+     * Which field of the data will be used, set it to undefined when no cursor is known.
+     */
+    cursorParam?: string | undefined;
+    /**
+     * The initial value, the value of the first page.
+     * @default `0`
+     */
+    initialPageParam: unknown;
+};
+type Options = {
+    /**
+     * @default 'hooks'
+     */
+    output?: Output;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped @tanstack/query hooks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `hooks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Hooks"`
+         */
+        exportAs?: string;
+    };
+    client?: {
+        /**
+         * Path to the client 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.
+         * the path will be applied as is, so relative path should be based on the file being generated.
+         * @default '@kubb/plugin-client/client'
+         */
+        importPath?: string;
+        /**
+         * ReturnType that needs to be used when calling client().
+         *
+         * `Data` will return ResponseConfig[data].
+         *
+         * `Full` will return ResponseConfig.
+         * @default `'data'`
+         * @private
+         */
+        dataReturnType?: 'data' | 'full';
+    };
+    /**
+     * 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.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    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
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * When set, an infiniteQuery hooks will be added.
+     */
+    infinite?: Partial<Infinite> | false;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query> | false;
+    /**
+     * Override some useMutation behaviours.
+     */
+    mutation?: Mutation | false;
+    /**
+     * Which parser can be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: 'client' | 'zod';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+};
+type ResolvedOptions = {
+    output: Output;
+    baseURL: string | undefined;
+    client: Required<NonNullable<PluginVueQuery['options']['client']>>;
+    parser: Required<NonNullable<Options['parser']>>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    /**
+     * Only used of infinite
+     */
+    infinite: NonNullable<Infinite> | false;
+    query: NonNullable<Required<Query>> | false;
+    mutation: NonNullable<Required<Mutation>> | false;
+};
+type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Infinite as I, Options as O, PluginVueQuery as P };

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@kubb/plugin-vue-query",
+  "version": "3.0.0-alpha.20",
+  "description": "Generator vue-query hooks",
+  "keywords": [
+    "faker",
+    "faker.js",
+    "msw",
+    "mock",
+    "mocking",
+    "plugins",
+    "kubb",
+    "codegen",
+    "swagger",
+    "openapi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-vue-query"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
+    "./components": {
+      "import": "./dist/components.js",
+      "require": "./dist/components.cjs",
+      "default": "./dist/components.cjs"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "components": [
+        "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "@kubb/core": "3.0.0-alpha.20",
+    "@kubb/oas": "3.0.0-alpha.20",
+    "@kubb/fs": "3.0.0-alpha.20",
+    "@kubb/plugin-oas": "3.0.0-alpha.20",
+    "@kubb/plugin-ts": "3.0.0-alpha.20",
+    "@kubb/react": "3.0.0-alpha.20",
+    "@kubb/plugin-zod": "3.0.0-alpha.20"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.6",
+    "react": "^18.3.1",
+    "tsup": "^8.2.4",
+    "typescript": "^5.6.2",
+    "@kubb/config-ts": "3.0.0-alpha.20",
+    "@kubb/config-tsup": "3.0.0-alpha.20"
+  },
+  "peerDependencies": {
+    "@kubb/react": "3.0.0-alpha.20"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "npx rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}