@kubb/plugin-react-query
Version:
React Query hooks generator plugin for Kubb, creating type-safe API client hooks from OpenAPI specifications for React applications.
144 lines (142 loc) • 4.71 kB
JavaScript
import { queryGenerator, suspenseQueryGenerator, infiniteQueryGenerator, mutationGenerator } from './chunk-2LUZUNTA.js';
import { MutationKey, QueryKey } from './chunk-LT467H44.js';
import path from 'path';
import { createPlugin, PluginManager, FileManager } from '@kubb/core';
import { camelCase, pascalCase } from '@kubb/core/transformers';
import { pluginOasName, OperationGenerator } from '@kubb/plugin-oas';
import { pluginTsName } from '@kubb/plugin-ts';
import { pluginZodName } from '@kubb/plugin-zod';
var pluginReactQueryName = "plugin-react-query";
var pluginReactQuery = createPlugin((options) => {
const {
output = { path: "hooks", barrelType: "named" },
group,
exclude = [],
include,
override = [],
parser = "client",
suspense = {},
infinite = false,
transformers = {},
paramsType = "inline",
pathParamsType = paramsType === "object" ? "object" : options.pathParamsType || "inline",
generators = [queryGenerator, suspenseQueryGenerator, infiniteQueryGenerator, mutationGenerator].filter(Boolean),
mutation = {},
query = {},
mutationKey = MutationKey.getTransformer,
queryKey = QueryKey.getTransformer,
paramsCasing,
contentType
} = options;
return {
name: pluginReactQueryName,
options: {
output,
client: {
importPath: "@kubb/plugin-client/clients/axios",
dataReturnType: "data",
pathParamsType,
...options.client
},
infinite: infinite ? {
queryParam: "id",
initialPageParam: 0,
cursorParam: void 0,
...infinite
} : false,
suspense,
queryKey,
query: query === false ? false : {
methods: ["get"],
importPath: "@tanstack/react-query",
...query
},
mutationKey,
mutation: {
methods: ["post", "put", "patch", "delete"],
importPath: "@tanstack/react-query",
...mutation
},
paramsType,
pathParamsType,
parser,
paramsCasing,
group
},
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 (group && (options2?.group?.path || options2?.group?.tag)) {
const groupName = group?.name ? group.name : (ctx) => {
if (group?.type === "path") {
return `${ctx.group.split("/")[1]}`;
}
return `${camelCase(ctx.group)}Controller`;
};
return path.resolve(
root,
output.path,
groupName({
group: group.type === "path" ? options2.group.path : options2.group.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();
if (baseURL) {
this.plugin.options.client.baseURL = baseURL;
}
const operationGenerator = new OperationGenerator(this.plugin.options, {
oas,
pluginManager: this.pluginManager,
plugin: this.plugin,
contentType,
exclude,
include,
override,
mode
});
const files = await operationGenerator.build(...generators);
await this.addFile(...files);
const barrelFiles = await this.fileManager.getBarrelFiles({
type: output.barrelType ?? "named",
root,
output,
meta: {
pluginKey: this.plugin.key
},
logger: this.logger
});
await this.addFile(...barrelFiles);
}
};
});
export { pluginReactQuery, pluginReactQueryName };
//# sourceMappingURL=index.js.map
//# sourceMappingURL=index.js.map