@kubb/plugin-vue-query 3.0.0-beta.10 → 3.0.0-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-PGNSMLGU.cjs → chunk-A7SD37VK.cjs} +103 -97
- package/dist/chunk-A7SD37VK.cjs.map +1 -0
- package/dist/{chunk-DWWRCRGY.js → chunk-DHJLKFYS.js} +22 -10
- package/dist/chunk-DHJLKFYS.js.map +1 -0
- package/dist/{chunk-5MY3SE2R.cjs → chunk-J4RZRRHQ.cjs} +22 -10
- package/dist/chunk-J4RZRRHQ.cjs.map +1 -0
- package/dist/{chunk-YQOJHRKU.js → chunk-O4EGNKUX.js} +95 -89
- package/dist/chunk-O4EGNKUX.js.map +1 -0
- package/dist/components.cjs +8 -8
- package/dist/components.d.cts +7 -5
- package/dist/components.d.ts +7 -5
- package/dist/components.js +1 -1
- package/dist/generators.cjs +5 -5
- package/dist/generators.d.cts +1 -1
- package/dist/generators.d.ts +1 -1
- package/dist/generators.js +2 -2
- package/dist/index.cjs +20 -22
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +19 -21
- package/dist/index.js.map +1 -1
- package/dist/{types-Dx6yZliF.d.cts → types-C8LfCZUP.d.cts} +187 -22
- package/dist/{types-Dx6yZliF.d.ts → types-C8LfCZUP.d.ts} +187 -22
- package/package.json +11 -11
- package/src/components/MutationKey.tsx +11 -5
- package/src/components/QueryKey.tsx +17 -7
- package/src/generators/__snapshots__/clientDataReturnTypeFull.ts +1 -1
- package/src/generators/__snapshots__/clientGetImportPath.ts +1 -1
- package/src/generators/__snapshots__/clientPostImportPath.ts +2 -2
- package/src/generators/__snapshots__/findByTags.ts +1 -1
- package/src/generators/__snapshots__/findByTagsObject.ts +1 -1
- package/src/generators/__snapshots__/findByTagsPathParamsObject.ts +1 -1
- package/src/generators/__snapshots__/findByTagsWithCustomQueryKey.ts +2 -2
- package/src/generators/__snapshots__/findByTagsWithZod.ts +1 -1
- package/src/generators/__snapshots__/findInfiniteByTags.ts +1 -1
- package/src/generators/__snapshots__/findInfiniteByTagsCursor.ts +1 -1
- package/src/generators/__snapshots__/postAsQuery.ts +1 -1
- package/src/generators/__snapshots__/updatePetById.ts +2 -2
- package/src/generators/__snapshots__/updatePetByIdPathParamsObject.ts +2 -2
- package/src/generators/infiniteQueryGenerator.tsx +38 -33
- package/src/generators/mutationGenerator.tsx +22 -16
- package/src/generators/queryGenerator.tsx +22 -18
- package/src/plugin.ts +18 -19
- package/src/types.ts +26 -13
- package/dist/chunk-5MY3SE2R.cjs.map +0 -1
- package/dist/chunk-DWWRCRGY.js.map +0 -1
- package/dist/chunk-PGNSMLGU.cjs.map +0 -1
- package/dist/chunk-YQOJHRKU.js.map +0 -1
package/dist/generators.d.ts
CHANGED
package/dist/generators.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { infiniteQueryGenerator, mutationGenerator, queryGenerator } from './chunk-
|
|
2
|
-
import './chunk-
|
|
1
|
+
export { infiniteQueryGenerator, mutationGenerator, queryGenerator } from './chunk-O4EGNKUX.js';
|
|
2
|
+
import './chunk-DHJLKFYS.js';
|
|
3
3
|
//# sourceMappingURL=generators.js.map
|
|
4
4
|
//# sourceMappingURL=generators.js.map
|
package/dist/index.cjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
4
|
-
require('./chunk-
|
|
3
|
+
var chunkA7SD37VK_cjs = require('./chunk-A7SD37VK.cjs');
|
|
4
|
+
var chunkJ4RZRRHQ_cjs = require('./chunk-J4RZRRHQ.cjs');
|
|
5
5
|
var path = require('path');
|
|
6
6
|
var core = require('@kubb/core');
|
|
7
7
|
var transformers = require('@kubb/core/transformers');
|
|
@@ -28,13 +28,14 @@ var pluginVueQuery = core.createPlugin((options) => {
|
|
|
28
28
|
pathParamsType = "inline",
|
|
29
29
|
mutation = {},
|
|
30
30
|
query = {},
|
|
31
|
-
|
|
31
|
+
mutationKey = chunkJ4RZRRHQ_cjs.MutationKey.getTransformer,
|
|
32
|
+
queryKey = chunkJ4RZRRHQ_cjs.QueryKey.getTransformer,
|
|
33
|
+
generators = [chunkA7SD37VK_cjs.queryGenerator, chunkA7SD37VK_cjs.infiniteQueryGenerator, chunkA7SD37VK_cjs.mutationGenerator].filter(Boolean)
|
|
32
34
|
} = options;
|
|
33
35
|
return {
|
|
34
36
|
name: pluginVueQueryName,
|
|
35
37
|
options: {
|
|
36
38
|
output,
|
|
37
|
-
baseURL: void 0,
|
|
38
39
|
client: {
|
|
39
40
|
importPath: "@kubb/plugin-client/client",
|
|
40
41
|
dataReturnType: "data",
|
|
@@ -47,14 +48,14 @@ var pluginVueQuery = core.createPlugin((options) => {
|
|
|
47
48
|
cursorParam: void 0,
|
|
48
49
|
...infinite
|
|
49
50
|
} : false,
|
|
51
|
+
queryKey,
|
|
50
52
|
query: {
|
|
51
|
-
key: (key) => key,
|
|
52
53
|
methods: ["get"],
|
|
53
54
|
importPath: "@tanstack/vue-query",
|
|
54
55
|
...query
|
|
55
56
|
},
|
|
57
|
+
mutationKey,
|
|
56
58
|
mutation: {
|
|
57
|
-
key: (key) => key,
|
|
58
59
|
methods: ["post", "put", "patch", "delete"],
|
|
59
60
|
importPath: "@tanstack/vue-query",
|
|
60
61
|
...mutation
|
|
@@ -97,22 +98,19 @@ var pluginVueQuery = core.createPlugin((options) => {
|
|
|
97
98
|
const root = path__default.default.resolve(this.config.root, this.config.output.path);
|
|
98
99
|
const mode = core.FileManager.getMode(path__default.default.resolve(root, output.path));
|
|
99
100
|
const baseURL = await swaggerPlugin.context.getBaseURL();
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
mode
|
|
114
|
-
}
|
|
115
|
-
);
|
|
101
|
+
if (baseURL) {
|
|
102
|
+
this.plugin.options.client.baseURL = baseURL;
|
|
103
|
+
}
|
|
104
|
+
const operationGenerator = new pluginOas.OperationGenerator(this.plugin.options, {
|
|
105
|
+
oas,
|
|
106
|
+
pluginManager: this.pluginManager,
|
|
107
|
+
plugin: this.plugin,
|
|
108
|
+
contentType: swaggerPlugin.context.contentType,
|
|
109
|
+
exclude,
|
|
110
|
+
include,
|
|
111
|
+
override,
|
|
112
|
+
mode
|
|
113
|
+
});
|
|
116
114
|
const files = await operationGenerator.build(...generators);
|
|
117
115
|
await this.addFile(...files);
|
|
118
116
|
const barrelFiles = await this.fileManager.getBarrelFiles({
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/plugin.ts"],"names":["createPlugin","transformers","queryGenerator","infiniteQueryGenerator","mutationGenerator","pluginOasName","pluginTsName","pluginZodName","options","path","FileManager","camelCase","pascalCase","PluginManager","OperationGenerator"],"mappings":";;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts"],"names":["createPlugin","transformers","MutationKey","QueryKey","queryGenerator","infiniteQueryGenerator","mutationGenerator","pluginOasName","pluginTsName","pluginZodName","options","path","FileManager","camelCase","pascalCase","PluginManager","OperationGenerator"],"mappings":";;;;;;;;;;;;;;;AAeO,IAAM,kBAAqB,GAAA;AAErB,IAAA,cAAA,GAAiBA,iBAA6B,CAAA,CAAC,OAAY,KAAA;AACtE,EAAM,MAAA;AAAA,IACJ,MAAS,GAAA,EAAE,IAAM,EAAA,OAAA,EAAS,YAAY,OAAQ,EAAA;AAAA,IAC9C,KAAA;AAAA,IACA,UAAU,EAAC;AAAA,IACX,OAAA;AAAA,IACA,WAAW,EAAC;AAAA,IACZ,MAAS,GAAA,QAAA;AAAA,IACT,QAAA;AAAA,kBACAC,iBAAe,EAAC;AAAA,IAChB,UAAa,GAAA,QAAA;AAAA,IACb,cAAiB,GAAA,QAAA;AAAA,IACjB,WAAW,EAAC;AAAA,IACZ,QAAQ,EAAC;AAAA,IACT,cAAcC,6BAAY,CAAA,cAAA;AAAA,IAC1B,WAAWC,0BAAS,CAAA,cAAA;AAAA,IACpB,aAAa,CAACC,gCAAA,EAAgBC,0CAAwBC,mCAAiB,CAAA,CAAE,OAAO,OAAO;AAAA,GACrF,GAAA,OAAA;AAEJ,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,kBAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,MAAA;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,4BAAA;AAAA,QACZ,cAAgB,EAAA,MAAA;AAAA,QAChB,cAAgB,EAAA,QAAA;AAAA,QAChB,GAAG,OAAQ,CAAA;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;AAAA,OAEL,GAAA,KAAA;AAAA,MACJ,QAAA;AAAA,MACA,KAAO,EAAA;AAAA,QACL,OAAA,EAAS,CAAC,KAAK,CAAA;AAAA,QACf,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG;AAAA,OACL;AAAA,MACA,WAAA;AAAA,MACA,QAAU,EAAA;AAAA,QACR,OAAS,EAAA,CAAC,MAAQ,EAAA,KAAA,EAAO,SAAS,QAAQ,CAAA;AAAA,QAC1C,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG;AAAA,OACL;AAAA,MACA,UAAA;AAAA,MACA,cAAA,EAAgB,UAAe,KAAA,QAAA,GAAW,QAAW,GAAA,cAAA;AAAA,MACrD;AAAA,KACF;AAAA,IACA,GAAA,EAAK,CAACC,uBAAA,EAAeC,qBAAc,EAAA,MAAA,KAAW,QAAQC,uBAAgB,GAAA,KAAA,CAAS,CAAE,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA,IAC/F,WAAA,CAAY,QAAU,EAAA,QAAA,EAAUC,QAAS,EAAA;AACvC,MAAM,MAAA,IAAA,GAAOC,sBAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAYC,gBAAY,CAAA,OAAA,CAAQD,sBAAK,OAAQ,CAAA,IAAA,EAAM,MAAO,CAAA,IAAI,CAAC,CAAA;AAE5E,MAAA,IAAID,QAAS,EAAA,GAAA,IAAO,KAAO,EAAA,IAAA,KAAS,KAAO,EAAA;AACzC,QAAM,MAAA,SAAA,GAA2B,OAAO,IAAO,GAAA,KAAA,CAAM,OAAO,CAAC,GAAA,KAAQ,CAAG,EAAA,GAAA,CAAI,KAAK,CAAA,UAAA,CAAA;AAEjF,QAAA,OAAOC,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,SAAU,CAAA,EAAE,KAAO,EAAAE,sBAAA,CAAUH,QAAQ,CAAA,GAAG,CAAE,EAAC,GAAG,QAAQ,CAAA;AAAA;AAG/F,MAAA,IAAI,SAAS,QAAU,EAAA;AAKrB,QAAA,OAAOC,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAA;AAAA;AAGvC,MAAA,OAAOA,qBAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,QAAQ,CAAA;AAAA,KACjD;AAAA,IACA,WAAA,CAAY,MAAM,IAAM,EAAA;AACtB,MAAI,IAAA,YAAA,GAAeE,uBAAU,IAAI,CAAA;AAEjC,MAAI,IAAA,IAAA,KAAS,MAAU,IAAA,IAAA,KAAS,UAAY,EAAA;AAC1C,QAAA,YAAA,GAAeA,uBAAU,IAAM,EAAA;AAAA,UAC7B,QAAQ,IAAS,KAAA;AAAA,SAClB,CAAA;AAAA;AAEH,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAA,YAAA,GAAeC,wBAAW,IAAI,CAAA;AAAA;AAGhC,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,OAAOb,cAAc,EAAA,IAAA,GAAO,YAAc,EAAA,IAAI,CAAK,IAAA,YAAA;AAAA;AAGrD,MAAO,OAAA,YAAA;AAAA,KACT;AAAA,IACA,MAAM,UAAa,GAAA;AACjB,MAAM,MAAA,CAAC,aAAa,CAAyB,GAAAc,kBAAA,CAAc,mBAA8B,IAAK,CAAA,OAAA,EAAS,CAACR,uBAAa,CAAC,CAAA;AAEtH,MAAA,MAAM,GAAM,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,MAAO,EAAA;AAC/C,MAAM,MAAA,IAAA,GAAOI,sBAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAOC,iBAAY,OAAQ,CAAAD,qBAAA,CAAK,QAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAC,CAAA;AAChE,MAAA,MAAM,OAAU,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,UAAW,EAAA;AAEvD,MAAA,IAAI,OAAS,EAAA;AACX,QAAK,IAAA,CAAA,MAAA,CAAO,OAAQ,CAAA,MAAA,CAAO,OAAU,GAAA,OAAA;AAAA;AAEvC,MAAA,MAAM,kBAAqB,GAAA,IAAIK,4BAAmB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QACrE,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,KAAQ,GAAA,MAAM,kBAAmB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AAC1D,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,KAAK,CAAA;AAE3B,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,CAAA;AAAA,QACxD,IAAA,EAAM,OAAO,UAAc,IAAA,OAAA;AAAA,QAC3B,IAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO,KAAK,WAAY,CAAA,KAAA;AAAA,QACxB,IAAM,EAAA;AAAA,UACJ,SAAA,EAAW,KAAK,MAAO,CAAA;AAAA,SACzB;AAAA,QACA,QAAQ,IAAK,CAAA;AAAA,OACd,CAAA;AAED,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAAA;AACnC,GACF;AACF,CAAC","file":"index.cjs","sourcesContent":["import path from 'node:path'\n\nimport { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase, pascalCase } from '@kubb/core/transformers'\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 { MutationKey, QueryKey } from './components'\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', barrelType: 'named' },\n group,\n exclude = [],\n include,\n override = [],\n parser = 'client',\n infinite,\n transformers = {},\n paramsType = 'inline',\n pathParamsType = 'inline',\n mutation = {},\n query = {},\n mutationKey = MutationKey.getTransformer,\n queryKey = QueryKey.getTransformer,\n generators = [queryGenerator, infiniteQueryGenerator, mutationGenerator].filter(Boolean),\n } = options\n\n return {\n name: pluginVueQueryName,\n options: {\n output,\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 queryKey,\n query: {\n methods: ['get'],\n importPath: '@tanstack/vue-query',\n ...query,\n },\n mutationKey,\n mutation: {\n methods: ['post', 'put', 'patch', 'delete'],\n importPath: '@tanstack/vue-query',\n ...mutation,\n },\n paramsType,\n pathParamsType: paramsType === 'object' ? 'object' : 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 (options?.tag && group?.type === 'tag') {\n const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`\n\n return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)\n }\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 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 if (baseURL) {\n this.plugin.options.client.baseURL = baseURL\n }\n const operationGenerator = new OperationGenerator(this.plugin.options, {\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 const files = await operationGenerator.build(...generators)\n await this.addFile(...files)\n\n const barrelFiles = await this.fileManager.getBarrelFiles({\n type: output.barrelType ?? 'named',\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"]}
|
package/dist/index.d.cts
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { queryGenerator, infiniteQueryGenerator, mutationGenerator } from './chunk-
|
|
2
|
-
import './chunk-
|
|
1
|
+
import { queryGenerator, infiniteQueryGenerator, mutationGenerator } from './chunk-O4EGNKUX.js';
|
|
2
|
+
import { MutationKey, QueryKey } from './chunk-DHJLKFYS.js';
|
|
3
3
|
import path from 'node:path';
|
|
4
4
|
import { createPlugin, FileManager, PluginManager } from '@kubb/core';
|
|
5
5
|
import { camelCase, pascalCase } from '@kubb/core/transformers';
|
|
@@ -22,13 +22,14 @@ var pluginVueQuery = createPlugin((options) => {
|
|
|
22
22
|
pathParamsType = "inline",
|
|
23
23
|
mutation = {},
|
|
24
24
|
query = {},
|
|
25
|
+
mutationKey = MutationKey.getTransformer,
|
|
26
|
+
queryKey = QueryKey.getTransformer,
|
|
25
27
|
generators = [queryGenerator, infiniteQueryGenerator, mutationGenerator].filter(Boolean)
|
|
26
28
|
} = options;
|
|
27
29
|
return {
|
|
28
30
|
name: pluginVueQueryName,
|
|
29
31
|
options: {
|
|
30
32
|
output,
|
|
31
|
-
baseURL: void 0,
|
|
32
33
|
client: {
|
|
33
34
|
importPath: "@kubb/plugin-client/client",
|
|
34
35
|
dataReturnType: "data",
|
|
@@ -41,14 +42,14 @@ var pluginVueQuery = createPlugin((options) => {
|
|
|
41
42
|
cursorParam: void 0,
|
|
42
43
|
...infinite
|
|
43
44
|
} : false,
|
|
45
|
+
queryKey,
|
|
44
46
|
query: {
|
|
45
|
-
key: (key) => key,
|
|
46
47
|
methods: ["get"],
|
|
47
48
|
importPath: "@tanstack/vue-query",
|
|
48
49
|
...query
|
|
49
50
|
},
|
|
51
|
+
mutationKey,
|
|
50
52
|
mutation: {
|
|
51
|
-
key: (key) => key,
|
|
52
53
|
methods: ["post", "put", "patch", "delete"],
|
|
53
54
|
importPath: "@tanstack/vue-query",
|
|
54
55
|
...mutation
|
|
@@ -91,22 +92,19 @@ var pluginVueQuery = createPlugin((options) => {
|
|
|
91
92
|
const root = path.resolve(this.config.root, this.config.output.path);
|
|
92
93
|
const mode = FileManager.getMode(path.resolve(root, output.path));
|
|
93
94
|
const baseURL = await swaggerPlugin.context.getBaseURL();
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
mode
|
|
108
|
-
}
|
|
109
|
-
);
|
|
95
|
+
if (baseURL) {
|
|
96
|
+
this.plugin.options.client.baseURL = baseURL;
|
|
97
|
+
}
|
|
98
|
+
const operationGenerator = new OperationGenerator(this.plugin.options, {
|
|
99
|
+
oas,
|
|
100
|
+
pluginManager: this.pluginManager,
|
|
101
|
+
plugin: this.plugin,
|
|
102
|
+
contentType: swaggerPlugin.context.contentType,
|
|
103
|
+
exclude,
|
|
104
|
+
include,
|
|
105
|
+
override,
|
|
106
|
+
mode
|
|
107
|
+
});
|
|
110
108
|
const files = await operationGenerator.build(...generators);
|
|
111
109
|
await this.addFile(...files);
|
|
112
110
|
const barrelFiles = await this.fileManager.getBarrelFiles({
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/plugin.ts"],"names":["options"],"mappings":";;;;;;;;;
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts"],"names":["options"],"mappings":";;;;;;;;;AAeO,IAAM,kBAAqB,GAAA;AAErB,IAAA,cAAA,GAAiB,YAA6B,CAAA,CAAC,OAAY,KAAA;AACtE,EAAM,MAAA;AAAA,IACJ,MAAS,GAAA,EAAE,IAAM,EAAA,OAAA,EAAS,YAAY,OAAQ,EAAA;AAAA,IAC9C,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,UAAa,GAAA,QAAA;AAAA,IACb,cAAiB,GAAA,QAAA;AAAA,IACjB,WAAW,EAAC;AAAA,IACZ,QAAQ,EAAC;AAAA,IACT,cAAc,WAAY,CAAA,cAAA;AAAA,IAC1B,WAAW,QAAS,CAAA,cAAA;AAAA,IACpB,aAAa,CAAC,cAAA,EAAgB,wBAAwB,iBAAiB,CAAA,CAAE,OAAO,OAAO;AAAA,GACrF,GAAA,OAAA;AAEJ,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,kBAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,MAAA;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,4BAAA;AAAA,QACZ,cAAgB,EAAA,MAAA;AAAA,QAChB,cAAgB,EAAA,QAAA;AAAA,QAChB,GAAG,OAAQ,CAAA;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;AAAA,OAEL,GAAA,KAAA;AAAA,MACJ,QAAA;AAAA,MACA,KAAO,EAAA;AAAA,QACL,OAAA,EAAS,CAAC,KAAK,CAAA;AAAA,QACf,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG;AAAA,OACL;AAAA,MACA,WAAA;AAAA,MACA,QAAU,EAAA;AAAA,QACR,OAAS,EAAA,CAAC,MAAQ,EAAA,KAAA,EAAO,SAAS,QAAQ,CAAA;AAAA,QAC1C,UAAY,EAAA,qBAAA;AAAA,QACZ,GAAG;AAAA,OACL;AAAA,MACA,UAAA;AAAA,MACA,cAAA,EAAgB,UAAe,KAAA,QAAA,GAAW,QAAW,GAAA,cAAA;AAAA,MACrD;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;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,WAAY,CAAA,OAAA,CAAQ,KAAK,OAAQ,CAAA,IAAA,EAAM,MAAO,CAAA,IAAI,CAAC,CAAA;AAE5E,MAAA,IAAIA,QAAS,EAAA,GAAA,IAAO,KAAO,EAAA,IAAA,KAAS,KAAO,EAAA;AACzC,QAAM,MAAA,SAAA,GAA2B,OAAO,IAAO,GAAA,KAAA,CAAM,OAAO,CAAC,GAAA,KAAQ,CAAG,EAAA,GAAA,CAAI,KAAK,CAAA,UAAA,CAAA;AAEjF,QAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,SAAU,CAAA,EAAE,KAAO,EAAA,SAAA,CAAUA,QAAQ,CAAA,GAAG,CAAE,EAAC,GAAG,QAAQ,CAAA;AAAA;AAG/F,MAAA,IAAI,SAAS,QAAU,EAAA;AAKrB,QAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAA;AAAA;AAGvC,MAAA,OAAO,IAAK,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAA,CAAO,MAAM,QAAQ,CAAA;AAAA,KACjD;AAAA,IACA,WAAA,CAAY,MAAM,IAAM,EAAA;AACtB,MAAI,IAAA,YAAA,GAAe,UAAU,IAAI,CAAA;AAEjC,MAAI,IAAA,IAAA,KAAS,MAAU,IAAA,IAAA,KAAS,UAAY,EAAA;AAC1C,QAAA,YAAA,GAAe,UAAU,IAAM,EAAA;AAAA,UAC7B,QAAQ,IAAS,KAAA;AAAA,SAClB,CAAA;AAAA;AAEH,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAA,YAAA,GAAe,WAAW,IAAI,CAAA;AAAA;AAGhC,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,OAAO,YAAc,EAAA,IAAA,GAAO,YAAc,EAAA,IAAI,CAAK,IAAA,YAAA;AAAA;AAGrD,MAAO,OAAA,YAAA;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;AAEtH,MAAA,MAAM,GAAM,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,MAAO,EAAA;AAC/C,MAAM,MAAA,IAAA,GAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,OAAO,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA;AACnE,MAAM,MAAA,IAAA,GAAO,YAAY,OAAQ,CAAA,IAAA,CAAK,QAAQ,IAAM,EAAA,MAAA,CAAO,IAAI,CAAC,CAAA;AAChE,MAAA,MAAM,OAAU,GAAA,MAAM,aAAc,CAAA,OAAA,CAAQ,UAAW,EAAA;AAEvD,MAAA,IAAI,OAAS,EAAA;AACX,QAAK,IAAA,CAAA,MAAA,CAAO,OAAQ,CAAA,MAAA,CAAO,OAAU,GAAA,OAAA;AAAA;AAEvC,MAAA,MAAM,kBAAqB,GAAA,IAAI,kBAAmB,CAAA,IAAA,CAAK,OAAO,OAAS,EAAA;AAAA,QACrE,GAAA;AAAA,QACA,eAAe,IAAK,CAAA,aAAA;AAAA,QACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,WAAA,EAAa,cAAc,OAAQ,CAAA,WAAA;AAAA,QACnC,OAAA;AAAA,QACA,OAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,KAAQ,GAAA,MAAM,kBAAmB,CAAA,KAAA,CAAM,GAAG,UAAU,CAAA;AAC1D,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,KAAK,CAAA;AAE3B,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,CAAA;AAAA,QACxD,IAAA,EAAM,OAAO,UAAc,IAAA,OAAA;AAAA,QAC3B,IAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO,KAAK,WAAY,CAAA,KAAA;AAAA,QACxB,IAAM,EAAA;AAAA,UACJ,SAAA,EAAW,KAAK,MAAO,CAAA;AAAA,SACzB;AAAA,QACA,QAAQ,IAAK,CAAA;AAAA,OACd,CAAA;AAED,MAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,GAAG,WAAW,CAAA;AAAA;AACnC,GACF;AACF,CAAC","file":"index.js","sourcesContent":["import path from 'node:path'\n\nimport { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase, pascalCase } from '@kubb/core/transformers'\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 { MutationKey, QueryKey } from './components'\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', barrelType: 'named' },\n group,\n exclude = [],\n include,\n override = [],\n parser = 'client',\n infinite,\n transformers = {},\n paramsType = 'inline',\n pathParamsType = 'inline',\n mutation = {},\n query = {},\n mutationKey = MutationKey.getTransformer,\n queryKey = QueryKey.getTransformer,\n generators = [queryGenerator, infiniteQueryGenerator, mutationGenerator].filter(Boolean),\n } = options\n\n return {\n name: pluginVueQueryName,\n options: {\n output,\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 queryKey,\n query: {\n methods: ['get'],\n importPath: '@tanstack/vue-query',\n ...query,\n },\n mutationKey,\n mutation: {\n methods: ['post', 'put', 'patch', 'delete'],\n importPath: '@tanstack/vue-query',\n ...mutation,\n },\n paramsType,\n pathParamsType: paramsType === 'object' ? 'object' : 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 (options?.tag && group?.type === 'tag') {\n const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`\n\n return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)\n }\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 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 if (baseURL) {\n this.plugin.options.client.baseURL = baseURL\n }\n const operationGenerator = new OperationGenerator(this.plugin.options, {\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 const files = await operationGenerator.build(...generators)\n await this.addFile(...files)\n\n const barrelFiles = await this.fileManager.getBarrelFiles({\n type: output.barrelType ?? 'named',\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"]}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
|
|
2
|
-
import { HttpMethod } from '@kubb/oas';
|
|
3
|
-
import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
|
|
2
|
+
import { HttpMethod, Operation } from '@kubb/oas';
|
|
3
|
+
import { ResolvePathOptions, Exclude, Include, Override, Generator, OperationSchemas } from '@kubb/plugin-oas';
|
|
4
4
|
|
|
5
|
-
type Options$
|
|
5
|
+
type Options$2 = {
|
|
6
6
|
/**
|
|
7
7
|
* Specify the export location for the files and define the behavior of the output
|
|
8
8
|
* @default { path: 'clients', barrelType: 'named' }
|
|
@@ -23,7 +23,7 @@ type Options$1 = {
|
|
|
23
23
|
/**
|
|
24
24
|
* Array containing override parameters to override `options` based on tags/operations/methods/paths.
|
|
25
25
|
*/
|
|
26
|
-
override?: Array<Override<ResolvedOptions$
|
|
26
|
+
override?: Array<Override<ResolvedOptions$2>>;
|
|
27
27
|
/**
|
|
28
28
|
* Create `operations.ts` file with all operations grouped by methods.
|
|
29
29
|
* @default false
|
|
@@ -36,6 +36,10 @@ type Options$1 = {
|
|
|
36
36
|
* @default '@kubb/plugin-client/client'
|
|
37
37
|
*/
|
|
38
38
|
importPath?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Allows you to set a custom base url for all generated calls.
|
|
41
|
+
*/
|
|
42
|
+
baseURL?: string;
|
|
39
43
|
/**
|
|
40
44
|
* ReturnType that will be used when calling the client.
|
|
41
45
|
* - 'data' will return ResponseConfig[data].
|
|
@@ -74,23 +78,183 @@ type Options$1 = {
|
|
|
74
78
|
*/
|
|
75
79
|
generators?: Array<Generator<PluginClient>>;
|
|
76
80
|
};
|
|
77
|
-
type ResolvedOptions$
|
|
81
|
+
type ResolvedOptions$2 = {
|
|
78
82
|
output: Output;
|
|
79
|
-
group?: Options$
|
|
83
|
+
group?: Options$2['group'];
|
|
80
84
|
baseURL: string | undefined;
|
|
81
|
-
parser: NonNullable<Options$
|
|
82
|
-
importPath: NonNullable<Options$
|
|
83
|
-
dataReturnType: NonNullable<Options$
|
|
85
|
+
parser: NonNullable<Options$2['parser']>;
|
|
86
|
+
importPath: NonNullable<Options$2['importPath']>;
|
|
87
|
+
dataReturnType: NonNullable<Options$2['dataReturnType']>;
|
|
88
|
+
pathParamsType: NonNullable<Options$2['pathParamsType']>;
|
|
89
|
+
paramsType: NonNullable<Options$2['paramsType']>;
|
|
90
|
+
};
|
|
91
|
+
type PluginClient = PluginFactoryOptions<'plugin-client', Options$2, ResolvedOptions$2, never, ResolvePathOptions>;
|
|
92
|
+
|
|
93
|
+
type TransformerProps$1 = {
|
|
94
|
+
operation: Operation;
|
|
95
|
+
schemas: OperationSchemas;
|
|
96
|
+
};
|
|
97
|
+
type Transformer$1 = (props: TransformerProps$1) => unknown[];
|
|
98
|
+
type Suspense = object;
|
|
99
|
+
/**
|
|
100
|
+
* Customize the queryKey
|
|
101
|
+
*/
|
|
102
|
+
type QueryKey$1 = Transformer$1;
|
|
103
|
+
/**
|
|
104
|
+
* Customize the mutationKey
|
|
105
|
+
*/
|
|
106
|
+
type MutationKey$1 = Transformer$1;
|
|
107
|
+
type Query$1 = {
|
|
108
|
+
/**
|
|
109
|
+
* Define which HttpMethods can be used for queries
|
|
110
|
+
* @default ['get']
|
|
111
|
+
*/
|
|
112
|
+
methods: Array<HttpMethod>;
|
|
113
|
+
/**
|
|
114
|
+
* Path to the useQuery that will be used to do the useQuery functionality.
|
|
115
|
+
* It will be used as `import { useQuery } from '${importPath}'`.
|
|
116
|
+
* It allows both relative and absolute path.
|
|
117
|
+
* the path will be applied as is, so relative path should be based on the file being generated.
|
|
118
|
+
* @default '@tanstack/react-query'
|
|
119
|
+
*/
|
|
120
|
+
importPath?: string;
|
|
121
|
+
};
|
|
122
|
+
type Mutation$1 = {
|
|
123
|
+
/**
|
|
124
|
+
* Define which HttpMethods can be used for mutations
|
|
125
|
+
* @default ['post', 'put', 'delete']
|
|
126
|
+
*/
|
|
127
|
+
methods: Array<HttpMethod>;
|
|
128
|
+
/**
|
|
129
|
+
* Path to the useQuery that will be used to do the useQuery functionality.
|
|
130
|
+
* It will be used as `import { useQuery } from '${importPath}'`.
|
|
131
|
+
* It allows both relative and absolute path.
|
|
132
|
+
* the path will be applied as is, so relative path should be based on the file being generated.
|
|
133
|
+
* @default '@tanstack/react-query'
|
|
134
|
+
*/
|
|
135
|
+
importPath?: string;
|
|
136
|
+
};
|
|
137
|
+
type Infinite$1 = {
|
|
138
|
+
/**
|
|
139
|
+
* Specify the params key used for `pageParam`.
|
|
140
|
+
* @default 'id'
|
|
141
|
+
*/
|
|
142
|
+
queryParam: string;
|
|
143
|
+
/**
|
|
144
|
+
* Which field of the data will be used, set it to undefined when no cursor is known.
|
|
145
|
+
*/
|
|
146
|
+
cursorParam?: string | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* The initial value, the value of the first page.
|
|
149
|
+
* @default 0
|
|
150
|
+
*/
|
|
151
|
+
initialPageParam: unknown;
|
|
152
|
+
};
|
|
153
|
+
type Options$1 = {
|
|
154
|
+
/**
|
|
155
|
+
* Specify the export location for the files and define the behavior of the output
|
|
156
|
+
* @default { path: 'hooks', barrelType: 'named' }
|
|
157
|
+
*/
|
|
158
|
+
output?: Output;
|
|
159
|
+
/**
|
|
160
|
+
* Group the @tanstack/query hooks based on the provided name.
|
|
161
|
+
*/
|
|
162
|
+
group?: Group;
|
|
163
|
+
client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
|
|
164
|
+
/**
|
|
165
|
+
* Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
|
|
166
|
+
*/
|
|
167
|
+
exclude?: Array<Exclude>;
|
|
168
|
+
/**
|
|
169
|
+
* Array containing include parameters to include tags/operations/methods/paths.
|
|
170
|
+
*/
|
|
171
|
+
include?: Array<Include>;
|
|
172
|
+
/**
|
|
173
|
+
* Array containing override parameters to override `options` based on tags/operations/methods/paths.
|
|
174
|
+
*/
|
|
175
|
+
override?: Array<Override<ResolvedOptions$1>>;
|
|
176
|
+
/**
|
|
177
|
+
* How to pass your params
|
|
178
|
+
* - 'object' will return the params and pathParams as an object.
|
|
179
|
+
* - 'inline' will return the params as comma separated params.
|
|
180
|
+
* @default 'inline'
|
|
181
|
+
*/
|
|
182
|
+
paramsType?: 'object' | 'inline';
|
|
183
|
+
/**
|
|
184
|
+
* How to pass your pathParams.
|
|
185
|
+
* - 'object' will return the pathParams as an object.
|
|
186
|
+
* - 'inline' will return the pathParams as comma separated params.
|
|
187
|
+
* @default 'inline'
|
|
188
|
+
*/
|
|
189
|
+
pathParamsType?: PluginClient['options']['pathParamsType'];
|
|
190
|
+
/**
|
|
191
|
+
* When set, an infiniteQuery hooks will be added.
|
|
192
|
+
*/
|
|
193
|
+
infinite?: Partial<Infinite$1> | false;
|
|
194
|
+
/**
|
|
195
|
+
* When set, a suspenseQuery hooks will be added.
|
|
196
|
+
*/
|
|
197
|
+
suspense?: Partial<Suspense> | false;
|
|
198
|
+
queryKey?: QueryKey$1;
|
|
199
|
+
/**
|
|
200
|
+
* Override some useQuery behaviours.
|
|
201
|
+
*/
|
|
202
|
+
query?: Partial<Query$1> | false;
|
|
203
|
+
mutationKey?: MutationKey$1;
|
|
204
|
+
/**
|
|
205
|
+
* Override some useMutation behaviours.
|
|
206
|
+
*/
|
|
207
|
+
mutation?: Partial<Mutation$1> | false;
|
|
208
|
+
/**
|
|
209
|
+
* Which parser should be used before returning the data to `@tanstack/query`.
|
|
210
|
+
* `'zod'` will use `@kubb/plugin-zod` to parse the data.
|
|
211
|
+
*/
|
|
212
|
+
parser?: PluginClient['options']['parser'];
|
|
213
|
+
transformers?: {
|
|
214
|
+
/**
|
|
215
|
+
* Customize the names based on the type that is provided by the plugin.
|
|
216
|
+
*/
|
|
217
|
+
name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
|
|
218
|
+
};
|
|
219
|
+
/**
|
|
220
|
+
* Define some generators next to the react-query generators
|
|
221
|
+
*/
|
|
222
|
+
generators?: Array<Generator<PluginReactQuery>>;
|
|
223
|
+
};
|
|
224
|
+
type ResolvedOptions$1 = {
|
|
225
|
+
output: Output;
|
|
226
|
+
client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
|
|
227
|
+
baseURL?: string;
|
|
228
|
+
};
|
|
229
|
+
parser: Required<NonNullable<Options$1['parser']>>;
|
|
84
230
|
pathParamsType: NonNullable<Options$1['pathParamsType']>;
|
|
85
231
|
paramsType: NonNullable<Options$1['paramsType']>;
|
|
232
|
+
/**
|
|
233
|
+
* Only used of infinite
|
|
234
|
+
*/
|
|
235
|
+
infinite: NonNullable<Infinite$1> | false;
|
|
236
|
+
suspense: Suspense | false;
|
|
237
|
+
queryKey: QueryKey$1 | undefined;
|
|
238
|
+
query: NonNullable<Required<Query$1>> | false;
|
|
239
|
+
mutationKey: MutationKey$1 | undefined;
|
|
240
|
+
mutation: NonNullable<Required<Mutation$1>> | false;
|
|
86
241
|
};
|
|
87
|
-
type
|
|
242
|
+
type PluginReactQuery = PluginFactoryOptions<'plugin-react-query', Options$1, ResolvedOptions$1, never, ResolvePathOptions>;
|
|
88
243
|
|
|
244
|
+
type TransformerProps = {
|
|
245
|
+
operation: Operation;
|
|
246
|
+
schemas: OperationSchemas;
|
|
247
|
+
};
|
|
248
|
+
type Transformer = (props: TransformerProps) => unknown[];
|
|
249
|
+
/**
|
|
250
|
+
* Customize the queryKey
|
|
251
|
+
*/
|
|
252
|
+
type QueryKey = Transformer;
|
|
253
|
+
/**
|
|
254
|
+
* Customize the mutationKey
|
|
255
|
+
*/
|
|
256
|
+
type MutationKey = Transformer;
|
|
89
257
|
type Query = {
|
|
90
|
-
/**
|
|
91
|
-
* Customize the queryKey, here you can specify a suffix.
|
|
92
|
-
*/
|
|
93
|
-
key: (key: unknown[]) => unknown[];
|
|
94
258
|
/**
|
|
95
259
|
* Define which HttpMethods can be used for queries
|
|
96
260
|
* @default ['get']
|
|
@@ -106,10 +270,6 @@ type Query = {
|
|
|
106
270
|
importPath?: string;
|
|
107
271
|
};
|
|
108
272
|
type Mutation = {
|
|
109
|
-
/**
|
|
110
|
-
* Customize the queryKey, here you can specify a suffix.
|
|
111
|
-
*/
|
|
112
|
-
key: (key: unknown[]) => unknown[];
|
|
113
273
|
/**
|
|
114
274
|
* Define which HttpMethods can be used for mutations
|
|
115
275
|
* @default ['post', 'put', 'delete']
|
|
@@ -150,7 +310,7 @@ type Options = {
|
|
|
150
310
|
* Group the @tanstack/query hooks based on the provided name.
|
|
151
311
|
*/
|
|
152
312
|
group?: Group;
|
|
153
|
-
client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
|
|
313
|
+
client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
|
|
154
314
|
/**
|
|
155
315
|
* Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
|
|
156
316
|
*/
|
|
@@ -181,10 +341,12 @@ type Options = {
|
|
|
181
341
|
* When set, an infiniteQuery hooks will be added.
|
|
182
342
|
*/
|
|
183
343
|
infinite?: Partial<Infinite> | false;
|
|
344
|
+
queryKey?: QueryKey;
|
|
184
345
|
/**
|
|
185
346
|
* Override some useQuery behaviours.
|
|
186
347
|
*/
|
|
187
348
|
query?: Partial<Query> | false;
|
|
349
|
+
mutationKey?: MutationKey;
|
|
188
350
|
/**
|
|
189
351
|
* Override some useMutation behaviours.
|
|
190
352
|
*/
|
|
@@ -207,8 +369,9 @@ type Options = {
|
|
|
207
369
|
};
|
|
208
370
|
type ResolvedOptions = {
|
|
209
371
|
output: Output;
|
|
210
|
-
|
|
211
|
-
|
|
372
|
+
client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
|
|
373
|
+
baseURL?: string;
|
|
374
|
+
};
|
|
212
375
|
parser: Required<NonNullable<Options['parser']>>;
|
|
213
376
|
paramsType: NonNullable<Options['paramsType']>;
|
|
214
377
|
pathParamsType: NonNullable<Options['pathParamsType']>;
|
|
@@ -216,9 +379,11 @@ type ResolvedOptions = {
|
|
|
216
379
|
* Only used of infinite
|
|
217
380
|
*/
|
|
218
381
|
infinite: NonNullable<Infinite> | false;
|
|
382
|
+
queryKey: QueryKey | undefined;
|
|
219
383
|
query: NonNullable<Required<Query>> | false;
|
|
384
|
+
mutationKey: MutationKey | undefined;
|
|
220
385
|
mutation: NonNullable<Required<Mutation>> | false;
|
|
221
386
|
};
|
|
222
387
|
type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
|
|
223
388
|
|
|
224
|
-
export type { Infinite as I, Options as O, PluginVueQuery as P };
|
|
389
|
+
export type { Infinite as I, Options as O, PluginVueQuery as P, Transformer as T };
|