@kubb/plugin-vue-query 5.0.0-beta.77 → 5.0.0-beta.80

package/dist/index.d.ts

@@ -10,7 +10,7 @@ import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactory
  *   body and query parameters before the call; `response` validates the success response body and,
  *   on the non-throw path, the error body.
  */
-type ParserOptions = false | 'zod' | {
+type ValidatorOptions = false | 'zod' | {
   request?: 'zod';
   response?: 'zod';
 };
@@ -82,7 +82,7 @@ type Options$1 = OutputOptions & {
    *
    * @default false
    */
-  parser?: ParserOptions;
+  validator?: ValidatorOptions;
   /**
    * Generates a class-based SDK instead of the standalone functions. Each tag client is an instance
    * class whose constructor takes a client config and builds its own client, so every environment is
@@ -148,7 +148,7 @@ type ResolvedOptions$1 = {
   override: Array<Override<ResolvedOptions$1>>;
   group: Group | null;
   baseURL: Options$1['baseURL'];
-  parser: NonNullable<Options$1['parser']>;
+  validator: NonNullable<Options$1['validator']>;
   sdk: {
     mode: Mode;
     name: string | undefined;
@@ -382,11 +382,18 @@ type Options = OutputOptions & {
    * - `'client'` — no validation.
    * - `'zod'` — pipes responses through schemas from `@kubb/plugin-zod`.
    */
-  parser?: Options$1['parser'];
+  validator?: Options$1['validator'];
   /**
    * Override how composable names and file paths are built.
    */
   resolver?: Partial<ResolverVueQuery> & ThisType<ResolverVueQuery>;
+  /**
+   * Set to `false` to skip generating `use*` composable functions. `queryOptions`,
+   * `mutationOptions`, `queryKey`, and `mutationKey` helpers are still emitted.
+   *
+   * @default false
+   */
+  hooks?: boolean;
   /**
    * Macros applied to each operation node before printing.
    */
@@ -410,7 +417,7 @@ type ResolvedOptions = {
    * The resolved contract client the generators import and call.
    */
   client: ResolvedClient;
-  parser: NonNullable<Options['parser']>;
+  validator: NonNullable<Options['validator']>;
   /**
    * Only used for infinite
    */
@@ -419,6 +426,7 @@ type ResolvedOptions = {
   query: NonNullable<Required<Query>> | false;
   mutationKey: MutationKey | null;
   mutation: NonNullable<Required<Mutation>> | false;
+  hooks: boolean;
   resolver: ResolverVueQuery;
 };
 type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, ResolverVueQuery>;

package/dist/index.js

@@ -63,7 +63,7 @@ function toFilePath(name, caseLast = camelCase) {
 * JavaScript and Java reserved words.
 * @link https://github.com/jonschlinkert/reserved/blob/master/index.js
 */
-const reservedWords = new Set([
+const reservedWords = /* @__PURE__ */ new Set([
 	"abstract",
 	"arguments",
 	"boolean",
@@ -292,6 +292,23 @@ function caseParams(params, casing) {
 	caseParamsCache.set(params, result);
 	return result;
 }
+/**
+* Drops parameters that collapse to the same property identity once camelCased, keeping the first.
+*
+* Some specs declare the same parameter twice under different casings (for example AWS S3 lists both
+* `max-uploads` and `MaxUploads`). Both resolve to one output property, so emitting both would yield
+* an object type with a duplicate member, which TypeScript rejects. De-duplicate by the camelCased
+* identity so the resulting group is collision-free regardless of the names each caller carries.
+*/
+function dedupeByCasedName(params) {
+	const seen = /* @__PURE__ */ new Set();
+	return params.filter((param) => {
+		const key = camelCase(param.name);
+		if (seen.has(key)) return false;
+		seen.add(key);
+		return true;
+	});
+}
 //#endregion
 //#region ../../internals/shared/src/operation.ts
 /**
@@ -330,11 +347,27 @@ function getContentTypeInfo(node) {
 		hasFormData: contentTypes.some((ct) => ct === "multipart/form-data")
 	};
 }
+/**
+* The request-body counterpart for the primary success response: the content types it documents and
+* whether several are present, so the client can let a caller pick which one to accept.
+*/
+function getResponseContentTypeInfo(node) {
+	const contentTypes = getPrimarySuccessResponse(node)?.content?.map((e) => e.contentType) ?? [];
+	const isMultipleContentTypes = contentTypes.length > 1;
+	return {
+		contentTypes,
+		isMultipleContentTypes,
+		contentTypeUnion: isMultipleContentTypes ? contentTypes.map((ct) => JSON.stringify(ct)).join(" | ") : "",
+		defaultContentType: contentTypes[0] ?? "application/json",
+		hasFormData: contentTypes.some((ct) => ct === "multipart/form-data")
+	};
+}
 function buildRequestConfigType(node) {
-	const { isMultipleContentTypes, contentTypeUnion } = getContentTypeInfo(node);
+	const request = getContentTypeInfo(node);
+	const response = getResponseContentTypeInfo(node);
 	const configType = `Partial<Omit<RequestConfig, 'path' | 'query' | 'body' | 'headers' | 'url'>>`;
-	const contentTypeProp = isMultipleContentTypes ? `contentType?: ${contentTypeUnion}` : null;
-	return contentTypeProp ? `${configType} & { ${contentTypeProp} }` : configType;
+	const members = [request.isMultipleContentTypes ? `request?: ${request.contentTypeUnion}` : null, response.isMultipleContentTypes ? `response?: ${response.contentTypeUnion}` : null].filter(Boolean);
+	return members.length ? `${configType} & { contentType?: { ${members.join("; ")} } }` : configType;
 }
 /**
 * Builds the `client?:` option type shared by the generated query hooks (`useQuery`,
@@ -396,10 +429,10 @@ function buildOperationComments(node, options = {}) {
 function getOperationParameters(node, options = {}) {
 	const params = caseParams(node.parameters, options.paramsCasing === "original" ? void 0 : "camelcase");
 	return {
-		path: params.filter((param) => param.in === "path"),
-		query: params.filter((param) => param.in === "query"),
-		header: params.filter((param) => param.in === "header"),
-		cookie: params.filter((param) => param.in === "cookie")
+		path: dedupeByCasedName(params.filter((param) => param.in === "path")),
+		query: dedupeByCasedName(params.filter((param) => param.in === "query")),
+		header: dedupeByCasedName(params.filter((param) => param.in === "header")),
+		cookie: dedupeByCasedName(params.filter((param) => param.in === "cookie"))
 	};
 }
 function getStatusCodeNumber(statusCode) {
@@ -414,6 +447,15 @@ function isErrorStatusCode(statusCode) {
 	const code = getStatusCodeNumber(statusCode);
 	return code !== null && code >= 400;
 }
+function getSuccessResponses(responses) {
+	return responses.filter((response) => isSuccessStatusCode(response.statusCode));
+}
+function getOperationSuccessResponses(node) {
+	return getSuccessResponses(node.responses);
+}
+function getPrimarySuccessResponse(node) {
+	return getOperationSuccessResponses(node)[0] ?? null;
+}
 function resolveErrorNames(node, resolver) {
 	return node.responses.filter((response) => isErrorStatusCode(response.statusCode)).map((response) => resolver.resolveResponseStatusName(node, response.statusCode));
 }
@@ -487,14 +529,14 @@ function createGroupConfig(group) {
 	};
 }
 //#endregion
-//#region ../../internals/client/src/builders/parser.ts
+//#region ../../internals/client/src/builders/validatorOptions.ts
 /**
-* Returns `true` when any direction of the parser uses zod (used for dependency checks).
+* Returns `true` when any direction of the validator uses zod (used for dependency checks).
 */
-function isParserEnabled(parser) {
-	if (!parser) return false;
-	if (parser === "zod") return true;
-	return Boolean(parser.request || parser.response);
+function isValidatorEnabled(validator) {
+	if (!validator) return false;
+	if (validator === "zod") return true;
+	return Boolean(validator.request || validator.response);
 }
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
@@ -629,6 +671,19 @@ const requestGroupOrder$1 = [
 	"headers"
 ];
 /**
+* Widens a request-group member type so a generated TanStack hook accepts either the value or a
+* deferred value. Both plugins apply this through the `memberTypeWrapper` of `buildGroupedRequestParam`;
+* they only differ in how the deferred form is later resolved.
+*
+* `maybeRefOrGetter` is used by vue-query, which keeps the ref/getter live and unwraps it lazily with
+* `toValue` because vue-query keys are reactive. `maybeValueOrGetter` is used by react-query, which
+* resolves the getter once at the hook boundary and forwards a plain value because React Query hashes
+* keys structurally and cannot hold a function.
+*/
+function maybeRefOrGetter(type) {
+	return `MaybeRefOrGetter<${type}>`;
+}
+/**
 * Builds the grouped `{ path, query, body, headers }` parameter that mirrors the client
 * function signature. Only the groups the operation carries are emitted, typed from the
 * operation's `RequestConfig`. `keys` narrows the emitted groups, used by the query key which
@@ -750,12 +805,6 @@ const queryKeyTransformer = ({ node }) => {
 };
 //#endregion
 //#region src/utils.ts
-/**
-* Wraps a type string in `MaybeRefOrGetter<…>` so a vue-query signature accepts refs or getters.
-*/
-function maybeRefOrGetter(type) {
-	return `MaybeRefOrGetter<${type}>`;
-}
 const requestGroupOrder = [
 	"path",
 	"query",
@@ -1199,7 +1248,7 @@ const infiniteQueryGenerator = defineGenerator({
 	operation(node, ctx) {
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
-		const { output, query, mutation, infinite, parser, client, group } = ctx.options;
+		const { output, query, mutation, infinite, validator, client, group, hooks } = ctx.options;
 		const pluginTs = driver.getPlugin(pluginTsName);
 		if (!pluginTs) return null;
 		const tsResolver = driver.getResolver(pluginTsName);
@@ -1249,14 +1298,14 @@ const infiniteQueryGenerator = defineGenerator({
 				includeParams: false
 			})
 		].filter((name) => Boolean(name));
-		const pluginZod = isParserEnabled(parser) ? driver.getPlugin(pluginZodName) : null;
+		const pluginZod = isValidatorEnabled(validator) ? driver.getPlugin(pluginZodName) : null;
 		const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null;
 		const fileZod = zodResolver ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 			root,
 			output: pluginZod?.options?.output ?? output,
 			group: pluginZod?.options?.group ?? void 0
 		}) : null;
-		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, parser);
+		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, validator);
 		const calledClientName = contractOp.name;
 		return /* @__PURE__ */ jsxs(File, {
 			baseName: meta.file.baseName,
@@ -1338,30 +1387,32 @@ const infiniteQueryGenerator = defineGenerator({
 					initialPageParam: infiniteOptions.initialPageParam,
 					queryParam: infiniteOptions.queryParam
 				}),
-				/* @__PURE__ */ jsx(File.Import, {
-					name: ["useInfiniteQuery"],
-					path: importPath
-				}),
-				/* @__PURE__ */ jsx(File.Import, {
-					name: [
-						"QueryKey",
-						"QueryClient",
-						"UseInfiniteQueryOptions",
-						"UseInfiniteQueryReturnType"
-					],
-					path: importPath,
-					isTypeOnly: true
-				}),
-				/* @__PURE__ */ jsx(InfiniteQuery, {
-					name: queryName,
-					queryOptionsName,
-					queryKeyName,
-					queryKeyTypeName,
-					node,
-					tsResolver,
-					initialPageParam: infiniteOptions.initialPageParam,
-					queryParam: infiniteOptions.queryParam
-				})
+				hooks && /* @__PURE__ */ jsxs(Fragment, { children: [
+					/* @__PURE__ */ jsx(File.Import, {
+						name: ["useInfiniteQuery"],
+						path: importPath
+					}),
+					/* @__PURE__ */ jsx(File.Import, {
+						name: [
+							"QueryKey",
+							"QueryClient",
+							"UseInfiniteQueryOptions",
+							"UseInfiniteQueryReturnType"
+						],
+						path: importPath,
+						isTypeOnly: true
+					}),
+					/* @__PURE__ */ jsx(InfiniteQuery, {
+						name: queryName,
+						queryOptionsName,
+						queryKeyName,
+						queryKeyTypeName,
+						node,
+						tsResolver,
+						initialPageParam: infiniteOptions.initialPageParam,
+						queryParam: infiniteOptions.queryParam
+					})
+				] })
 			]
 		});
 	}
@@ -1379,7 +1430,7 @@ const mutationGenerator = defineGenerator({
 	operation(node, ctx) {
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
-		const { output, query, mutation, parser, client, group } = ctx.options;
+		const { output, query, mutation, validator, client, group, hooks } = ctx.options;
 		const pluginTs = driver.getPlugin(pluginTsName);
 		if (!pluginTs) return null;
 		const tsResolver = driver.getResolver(pluginTsName);
@@ -1414,14 +1465,14 @@ const mutationGenerator = defineGenerator({
 			order: "body-response-first",
 			includeParams: false
 		})].filter((name) => Boolean(name));
-		const pluginZod = isParserEnabled(parser) ? driver.getPlugin(pluginZodName) : null;
+		const pluginZod = isValidatorEnabled(validator) ? driver.getPlugin(pluginZodName) : null;
 		const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null;
 		const fileZod = zodResolver ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 			root,
 			output: pluginZod?.options?.output ?? output,
 			group: pluginZod?.options?.group ?? void 0
 		}) : null;
-		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, parser);
+		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, validator);
 		const calledClientName = contractOp.name;
 		const groups = getRequestGroups(node);
 		const hasRequestGroups = groups.path || groups.query || groups.body || groups.headers;
@@ -1482,7 +1533,7 @@ const mutationGenerator = defineGenerator({
 					node,
 					transformer: ctx.options.mutationKey
 				}),
-				mutation && /* @__PURE__ */ jsxs(Fragment, { children: [
+				mutation && hooks && /* @__PURE__ */ jsxs(Fragment, { children: [
 					/* @__PURE__ */ jsx(File.Import, {
 						name: ["useMutation"],
 						path: importPath
@@ -1518,7 +1569,7 @@ const queryGenerator = defineGenerator({
 	operation(node, ctx) {
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
-		const { output, query, mutation, parser, client, group } = ctx.options;
+		const { output, query, mutation, validator, client, group, hooks } = ctx.options;
 		const pluginTs = driver.getPlugin(pluginTsName);
 		if (!pluginTs) return null;
 		const tsResolver = driver.getResolver(pluginTsName);
@@ -1556,14 +1607,14 @@ const queryGenerator = defineGenerator({
 			order: "body-response-first",
 			includeParams: false
 		})].filter((name) => Boolean(name));
-		const pluginZod = isParserEnabled(parser) ? driver.getPlugin(pluginZodName) : null;
+		const pluginZod = isValidatorEnabled(validator) ? driver.getPlugin(pluginZodName) : null;
 		const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null;
 		const fileZod = zodResolver ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
 			root,
 			output: pluginZod?.options?.output ?? output,
 			group: pluginZod?.options?.group ?? void 0
 		}) : null;
-		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, parser);
+		const zodSchemaNames = resolveZodSchemaNames(node, zodResolver, validator);
 		const calledClientName = contractOp.name;
 		return /* @__PURE__ */ jsxs(File, {
 			baseName: meta.file.baseName,
@@ -1635,7 +1686,7 @@ const queryGenerator = defineGenerator({
 					node,
 					tsResolver
 				}),
-				query && /* @__PURE__ */ jsxs(Fragment, { children: [
+				query && hooks && /* @__PURE__ */ jsxs(Fragment, { children: [
 					/* @__PURE__ */ jsx(File.Import, {
 						name: ["useQuery"],
 						path: importPath
@@ -1771,7 +1822,7 @@ const pluginVueQuery = definePlugin((options) => {
 	const { output = {
 		path: "hooks",
 		barrel: { type: "named" }
-	}, group, exclude = [], include, override = [], parser = false, infinite = false, mutation = {}, query = {}, mutationKey = mutationKeyTransformer, queryKey = queryKeyTransformer, client, resolver: userResolver, macros: userMacros } = options;
+	}, group, exclude = [], include, override = [], validator = false, infinite = false, mutation = {}, query = {}, mutationKey = mutationKeyTransformer, queryKey = queryKeyTransformer, hooks = false, client, resolver: userResolver, macros: userMacros } = options;
 	const selectedGenerators = [
 		queryGenerator,
 		infiniteQueryGenerator,
@@ -1781,7 +1832,7 @@ const pluginVueQuery = definePlugin((options) => {
 	return {
 		name: pluginVueQueryName,
 		options,
-		dependencies: [pluginTsName, isParserEnabled(parser) ? pluginZodName : void 0].filter((dependency) => Boolean(dependency)),
+		dependencies: [pluginTsName, isValidatorEnabled(validator) ? pluginZodName : void 0].filter((dependency) => Boolean(dependency)),
 		hooks: { "kubb:plugin:setup"(ctx) {
 			const resolver = userResolver ? {
 				...resolverVueQuery,
@@ -1824,7 +1875,8 @@ const pluginVueQuery = definePlugin((options) => {
 					previousParam: null,
 					...infinite
 				} : false,
-				parser,
+				hooks,
+				validator,
 				group: groupConfig,
 				exclude,
 				include,