@kubb/plugin-react-query 5.2.0-canary.20261008T111956 → 5.2.1

package/dist/index.d.ts

@@ -13,8 +13,8 @@ import "@kubb/plugin-zod";
  *
  * - `contract` — a registered contract client plugin owns the `<op>` functions and the consumer
  *   imports and calls them.
- * - `error` — no client plugin is registered, several are registered without a selector, or the
- *   requested one is missing.
+ * - `error` — no client plugin is registered, several are registered without a selector, the
+ *   requested one is missing, or `client` is not a known selector.
  *
  * The `client` string selects explicitly (`'fetch'` / `'axios'`); when it is unset a lone registered
  * contract client plugin is picked up automatically.
@@ -36,9 +36,19 @@ type ResolvedContractClient = {
 //#endregion
 //#region ../../internals/tanstack-query/src/types.d.ts
 type ParamsCasing = 'camelcase' | undefined;
+/**
+ * The hook a key is built for. Plain and suspense queries can share a key, but an infinite query
+ * caches `InfiniteData` and must never share one with a plain query.
+ */
+type KeyVariant = 'query' | 'suspenseQuery' | 'infiniteQuery' | 'suspenseInfiniteQuery' | 'mutation';
+/**
+ * Builds query or mutation key segments for an operation node.
+ * Receives `variant` indicating which hook or composable the key is built for.
+ */
 type Transformer = (props: {
   node: ast.OperationNode;
   casing: ParamsCasing;
+  variant: KeyVariant;
 }) => Array<unknown>;
 /**
  * Configures the query side of a TanStack-family plugin: which HTTP methods produce query
@@ -287,7 +297,8 @@ type ResolverReactQuery = Resolver & {
 };
 type Suspense = object;
 /**
- * Builds the `queryKey` used by each generated query hook.
+ * Builds the `queryKey` used by each generated query hook. `variant` tells which hook the key is for,
+ * so infinite keys can stay apart from plain ones.
  *
  * @note String values are inlined verbatim into generated code. Wrap literal
  * strings in `JSON.stringify(...)`.
@@ -388,11 +399,12 @@ type Options = OutputOptions & {
    */
   resolver?: ResolverPatch<ResolverReactQuery>;
   /**
-   * Set to `false` to skip generating `use*` hook functions. `queryOptions`,
-   * `mutationOptions`, `queryKey`, and `mutationKey` helpers are still emitted.
-   * The resulting output uses only `@tanstack/react-query` factory imports
-   * (`queryOptions`, `infiniteQueryOptions`, `mutationOptions`) that are
-   * adapter-portable across React, Vue, Solid, and Svelte.
+   * Set to `true` to also generate `use*` hook functions. By default only the
+   * `queryOptions`, `mutationOptions`, `queryKey`, and `mutationKey` helpers are
+   * emitted, using `@tanstack/react-query` factory imports (`queryOptions`,
+   * `infiniteQueryOptions`, `mutationOptions`) that are adapter-portable across
+   * React, Vue, Solid, and Svelte. Infinite, suspense, and `customOptions` output
+   * needs `hooks: true` too.
    *
    * @default false
    */

package/dist/index.js

@@ -333,8 +333,8 @@ function createGroupConfig(group) {
 *
 * - `contract` — a registered contract client plugin owns the `<op>` functions and the consumer
 *   imports and calls them.
-* - `error` — no client plugin is registered, several are registered without a selector, or the
-*   requested one is missing.
+* - `error` — no client plugin is registered, several are registered without a selector, the
+*   requested one is missing, or `client` is not a known selector.
 *
 * The `client` string selects explicitly (`'fetch'` / `'axios'`); when it is unset a lone registered
 * contract client plugin is picked up automatically.
@@ -375,6 +375,10 @@ function resolveClient(options) {
 			pluginName
 		};
 	}
+	if (client !== void 0) return {
+		kind: "error",
+		message: `Option \`client\` is ${typeof client === "string" ? `'${client}'` : String(client)}, but it must be one of 'fetch', 'axios'. Drop \`client\` to use the registered client plugin.`
+	};
 	const registered = contractPlugins.filter(has);
 	if (registered.length === 1) return {
 		kind: "contract",
@@ -807,7 +811,8 @@ function MutationKey({ name, node, transformer }) {
 	const paramsSignature = declarationPrinter$6.print(paramsNode) ?? "";
 	const keys = (transformer ?? mutationKeyTransformer)({
 		node,
-		casing: "camelcase"
+		casing: "camelcase",
+		variant: "mutation"
 	});
 	return /* @__PURE__ */ jsx(File.Source, {
 		name,
@@ -878,23 +883,25 @@ function createMutationResolver() {
 //#endregion
 //#region ../../internals/tanstack-query/src/components/QueryKey.tsx
 const declarationPrinter$5 = functionPrinter({ mode: "declaration" });
-const queryKeyTransformer = ({ node }) => {
+const queryKeyTransformer = ({ node, variant }) => {
 	if (!node.path) return [];
-	const hasPathParams = getOperationParameters(node).path.length > 0;
-	const hasQueryParams = getOperationParameters(node).query.length > 0;
-	const hasRequestBody = !!node.requestBody?.content?.[0]?.schema;
-	return [
-		hasPathParams ? `{ url: '${Url.toPath(node.path)}', params: path }` : `{ url: '${Url.toPath(node.path)}' }`,
-		hasQueryParams ? "...(query ? [query] : [])" : null,
-		hasRequestBody ? "...(body ? [body] : [])" : null
-	].filter(Boolean);
+	const { path, query } = getOperationParameters(node);
+	const isInfinite = variant === "infiniteQuery" || variant === "suspenseInfiniteQuery";
+	const urlFields = [`url: '${Url.toPath(node.path)}'`];
+	if (path.length > 0) urlFields.push("params: path");
+	if (isInfinite) urlFields.push("infinite: true");
+	const result = [`{ ${urlFields.join(", ")} }`];
+	if (query.length > 0) result.push("...(query ? [query] : [])");
+	if (node.requestBody?.content?.[0]?.schema) result.push("...(body ? [body] : [])");
+	return result;
 };
-function QueryKey({ name, node, tsResolver, typeName, transformer }) {
+function QueryKey({ name, node, tsResolver, typeName, transformer, variant = "query" }) {
 	const paramsNode = buildQueryKeyParams(node, { resolver: tsResolver });
 	const paramsSignature = declarationPrinter$5.print(paramsNode) ?? "";
 	const keys = (transformer ?? queryKeyTransformer)({
 		node,
-		casing: "camelcase"
+		casing: "camelcase",
+		variant
 	});
 	return /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx(File.Source, {
 		name,
@@ -1519,8 +1526,7 @@ const infiniteQueryGenerator = defineGenerator({
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, query, infinite, client, group, customOptions } = ctx.options;
-		const pluginTs = driver.getPlugin(pluginTsName);
-		if (!pluginTs) return null;
+		const pluginTs = ctx.requirePlugin(pluginTsName);
 		const tsResolver = driver.getResolver(pluginTsName);
 		const infiniteOptions = infinite && typeof infinite === "object" ? infinite : null;
 		if (!infiniteOptions) return null;
@@ -1616,7 +1622,8 @@ const infiniteQueryGenerator = defineGenerator({
 					typeName: queryKeyTypeName,
 					node,
 					tsResolver,
-					transformer: ctx.options.queryKey
+					transformer: ctx.options.queryKey,
+					variant: "infiniteQuery"
 				}),
 				/* @__PURE__ */ jsx(File.Import, {
 					name: ["InfiniteData"],
@@ -1692,8 +1699,7 @@ const mutationGenerator = defineGenerator({
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, mutation, client, group, customOptions, hooks } = ctx.options;
-		const pluginTs = driver.getPlugin(pluginTsName);
-		if (!pluginTs) return null;
+		const pluginTs = ctx.requirePlugin(pluginTsName);
 		const tsResolver = driver.getResolver(pluginTsName);
 		const importPath = mutation ? mutation.importPath : "@tanstack/react-query";
 		const contractOp = resolveClientOperation({
@@ -1841,8 +1847,7 @@ const queryGenerator = defineGenerator({
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, query, client, group, customOptions, hooks } = ctx.options;
-		const pluginTs = driver.getPlugin(pluginTsName);
-		if (!pluginTs) return null;
+		const pluginTs = ctx.requirePlugin(pluginTsName);
 		const tsResolver = driver.getResolver(pluginTsName);
 		const importPath = query ? query.importPath : "@tanstack/react-query";
 		const contractOp = resolveClientOperation({
@@ -1927,7 +1932,8 @@ const queryGenerator = defineGenerator({
 					typeName: queryKeyTypeName,
 					node,
 					tsResolver,
-					transformer: ctx.options.queryKey
+					transformer: ctx.options.queryKey,
+					variant: "query"
 				}),
 				/* @__PURE__ */ jsx(File.Import, {
 					name: ["queryOptions"],
@@ -1998,8 +2004,7 @@ const suspenseInfiniteQueryGenerator = defineGenerator({
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, query, infinite, client, group, customOptions } = ctx.options;
-		const pluginTs = driver.getPlugin(pluginTsName);
-		if (!pluginTs) return null;
+		const pluginTs = ctx.requirePlugin(pluginTsName);
 		const tsResolver = driver.getResolver(pluginTsName);
 		const infiniteOptions = infinite && typeof infinite === "object" ? infinite : null;
 		if (!infiniteOptions) return null;
@@ -2091,7 +2096,8 @@ const suspenseInfiniteQueryGenerator = defineGenerator({
 					typeName: queryKeyTypeName,
 					node,
 					tsResolver,
-					transformer: ctx.options.queryKey
+					transformer: ctx.options.queryKey,
+					variant: "suspenseInfiniteQuery"
 				}),
 				/* @__PURE__ */ jsx(File.Import, {
 					name: ["InfiniteData"],
@@ -2171,8 +2177,7 @@ const suspenseQueryGenerator = defineGenerator({
 		if (!ast.isHttpOperationNode(node)) return null;
 		const { config, driver, resolver, root } = ctx;
 		const { output, query, client, group, customOptions } = ctx.options;
-		const pluginTs = driver.getPlugin(pluginTsName);
-		if (!pluginTs) return null;
+		const pluginTs = ctx.requirePlugin(pluginTsName);
 		const tsResolver = driver.getResolver(pluginTsName);
 		const importPath = query ? query.importPath : "@tanstack/react-query";
 		const contractOp = resolveClientOperation({
@@ -2257,7 +2262,8 @@ const suspenseQueryGenerator = defineGenerator({
 					typeName: queryKeyTypeName,
 					node,
 					tsResolver,
-					transformer: ctx.options.queryKey
+					transformer: ctx.options.queryKey,
+					variant: "suspenseQuery"
 				}),
 				/* @__PURE__ */ jsx(File.Import, {
 					name: ["queryOptions"],
@@ -2396,6 +2402,7 @@ const pluginReactQuery = definePlugin((options) => {
 		options,
 		dependencies: [pluginTsName],
 		hooks: { "kubb:plugin:setup"(ctx) {
+			ctx.requirePlugin(pluginTsName);
 			const resolver = userResolver ? Resolver.merge(resolverReactQuery, userResolver) : resolverReactQuery;
 			ctx.setOptions({
 				output,