@povio/openapi-codegen-cli 3.0.0-rc.1 → 3.0.0-rc.2

package/README.md

@@ -92,7 +92,10 @@ yarn openapi-codegen generate --config my-config.ts
   --axiosRequestConfig                Include Axios request config parameters in query hooks (default: false)
   --infiniteQueries                   Generate infinite queries for paginated API endpoints (default: false)
   --mutationEffects                   Add mutation effects options to mutation hooks (default: true)
-  --mutationScope                     Serialize mutations for the same path-param resource via TanStack scope.id (default: false)
+  --mutationScope                     Serialize mutations for the same path-param resource via TanStack scope.id (default: false).
+                                      In config files also accepts { include: string[] } or { exclude: string[] } to opt specific
+                                      operations in/out of scoping. Use "Tag/operationId" format for precision (e.g. "EmployeeSettings/update")
+                                      or just "operationId" to match across all tags. Cannot specify both include and exclude.
   --mutationDefaultOnError            Use OpenApiQueryConfig.onError as the default onError for mutation hooks (default: false)
   --workspaceContext                  Comma-separated list of path/ACL params that generated hooks may resolve from OpenApiWorkspaceContext
   --inlineEndpoints                   Inline endpoint implementations into generated query files (default: false)

package/dist/{config-CKmoJbQB.d.mts → config-C1ME3Ay4.d.mts}

@@ -1,4 +1,4 @@
-import { t as GenerateOptions } from "./options-C6CNQ6tq.mjs";
+import { t as GenerateOptions } from "./options-BPAjzilp.mjs";
 
 //#region src/generators/types/config.d.ts
 type OpenAPICodegenConfig = Partial<GenerateOptions>;

package/dist/{generate.runner-B0iop_CE.mjs → generate.runner-BsNMtOTd.mjs}

@@ -1,4 +1,4 @@
-import { S as Profiler, h as deepMerge, i as writeGenerateFileData, p as DEFAULT_GENERATE_OPTIONS, r as removeStaleGeneratedFiles, t as generateCodeFromOpenAPIDoc } from "./generateCodeFromOpenAPIDoc-BKIXvJIW.mjs";
+import { S as Profiler, h as deepMerge, i as writeGenerateFileData, p as DEFAULT_GENERATE_OPTIONS, r as removeStaleGeneratedFiles, t as generateCodeFromOpenAPIDoc } from "./generateCodeFromOpenAPIDoc-CbBWYEZG.mjs";
 import path from "path";
 import SwaggerParser from "@apidevtools/swagger-parser";
 

package/dist/{generateCodeFromOpenAPIDoc-BKIXvJIW.mjs → generateCodeFromOpenAPIDoc-CbBWYEZG.mjs}

@@ -4034,6 +4034,10 @@ function renderModelJsDocs({ name, zodSchema, tag, resolver }) {
 const endpointParamMappingCache = /* @__PURE__ */ new WeakMap();
 function generateQueries(params) {
 	const { resolver, data, tag } = params;
+	const mutationScopeOption = resolver.options.mutationScope;
+	if (mutationScopeOption && typeof mutationScopeOption === "object") {
+		if ("include" in mutationScopeOption && "exclude" in mutationScopeOption) throw new Error("mutationScope cannot specify both 'include' and 'exclude'");
+	}
 	const inlineEndpoints = shouldInlineEndpointsForTag(tag, resolver.options);
 	const endpoints = data.get(tag)?.endpoints;
 	if (!endpoints || endpoints.length === 0) return;
@@ -4541,6 +4545,27 @@ function renderMutation({ resolver, endpoint, inlineEndpoints, precomputed }) {
 	const destructuredVariables = precomputed?.destructuredVariables ?? getDestructuredVariables(resolver, endpoint, updateQueryEndpoints);
 	const hasMutationFnBody = endpoint.mediaUpload || hasAclCheck || Object.keys(workspaceParamReplacements).length > 0;
 	const mutationVariablesType = endpoint.mediaUpload ? `${endpointParams}${endpointParams ? "; " : ""}abortController?: AbortController; onUploadProgress?: (progress: { loaded: number; total: number }) => void` : endpointParams;
+	const isPost = endpoint.method === "post";
+	const mutationScopeOption = resolver.options.mutationScope;
+	const operationId = getEndpointName(endpoint);
+	const scopeMatchKey = `${tag}/${operationId}`;
+	let scopeEnabled = false;
+	if (!isPost && mutationScopeOption) {
+		if (mutationScopeOption === true) scopeEnabled = true;
+		else if (typeof mutationScopeOption === "object" && "include" in mutationScopeOption) scopeEnabled = mutationScopeOption.include.some((id) => id === operationId || id === scopeMatchKey);
+		else if (typeof mutationScopeOption === "object" && "exclude" in mutationScopeOption) scopeEnabled = !mutationScopeOption.exclude.some((id) => id === operationId || id === scopeMatchKey);
+	}
+	const scopePathParams = scopeEnabled ? mapEndpointParamsToFunctionParams(resolver, endpoint, {}).filter((p) => p.paramType === "Path") : [];
+	const isScoped = scopePathParams.length > 0;
+	const nonPathEndpointParams = isScoped ? renderEndpointParams(resolver, endpoint, {
+		includeFileParam: true,
+		optionalPathParams: resolver.options.workspaceContext,
+		modelNamespaceTag: tag,
+		excludePathParams: true
+	}) : endpointParams;
+	const nonPathMutationVariablesType = isScoped ? endpoint.mediaUpload ? `${nonPathEndpointParams}${nonPathEndpointParams ? "; " : ""}abortController?: AbortController; onUploadProgress?: (progress: { loaded: number; total: number }) => void` : nonPathEndpointParams : mutationVariablesType;
+	const pathParamFirstArg = isScoped ? `{ ${scopePathParams.map((p) => p.name).join(", ")} }: { ${scopePathParams.map((p) => `${p.name}: ${p.type}`).join("; ")} }, ` : "";
+	const mutationOptionsTypeArg = isScoped ? nonPathMutationVariablesType ? `, { ${nonPathMutationVariablesType} }` : "" : `, { ${mutationVariablesType} }`;
 	const lines = [];
 	lines.push(renderQueryJsDocs({
 		resolver,
@@ -4548,7 +4573,7 @@ function renderMutation({ resolver, endpoint, inlineEndpoints, precomputed }) {
 		mode: "mutation",
 		tag
 	}));
-	lines.push(`export const ${getQueryName(endpoint, true)} = (options?: AppMutationOptions<typeof ${endpointFunction}, { ${mutationVariablesType} }>${hasMutationEffects ? ` & ${MUTATION_EFFECTS.optionsType}` : ""}${hasAxiosRequestConfig ? `, ${AXIOS_REQUEST_CONFIG_NAME}?: ${AXIOS_REQUEST_CONFIG_TYPE}` : ""}) => {`);
+	lines.push(`export const ${getQueryName(endpoint, true)} = (${pathParamFirstArg}options?: AppMutationOptions<typeof ${endpointFunction}${mutationOptionsTypeArg}>${hasMutationEffects ? ` & ${MUTATION_EFFECTS.optionsType}` : ""}${hasAxiosRequestConfig ? `, ${AXIOS_REQUEST_CONFIG_NAME}?: ${AXIOS_REQUEST_CONFIG_TYPE}` : ""}) => {`);
 	if (hasMutationDefaultOnError) lines.push("  const queryConfig = OpenApiQueryConfig.useConfig();");
 	if (hasAclCheck) lines.push(`  const { checkAcl } = ${ACL_CHECK_HOOK}();`);
 	lines.push(...renderWorkspaceContextDestructure({
@@ -4559,7 +4584,13 @@ function renderMutation({ resolver, endpoint, inlineEndpoints, precomputed }) {
 	if (hasMutationEffects) lines.push(`  const { runMutationEffects } = useMutationEffects<typeof ${QUERY_MODULE_ENUM}.${tag}>({ currentModule: ${QUERIES_MODULE_NAME} });`);
 	lines.push("");
 	lines.push(`  return ${QUERY_HOOKS.mutation}({`);
-	const mutationFnArg = endpointParams ? `{ ${destructuredMutationArgs}${endpoint.mediaUpload ? `${destructuredMutationArgs ? ", " : ""}abortController, onUploadProgress` : ""} }` : "";
+	const nonPathDestructuredArgs = isScoped ? renderEndpointArgs(resolver, endpoint, {
+		includeFileParam: true,
+		excludePathParams: true
+	}) : destructuredMutationArgs;
+	const effectiveParams = isScoped ? nonPathEndpointParams : endpointParams;
+	const effectiveArgs = isScoped ? nonPathDestructuredArgs : destructuredMutationArgs;
+	const mutationFnArg = effectiveParams || endpoint.mediaUpload ? `{ ${effectiveArgs}${endpoint.mediaUpload ? `${effectiveArgs ? ", " : ""}abortController, onUploadProgress` : ""} }` : "";
 	lines.push(`    mutationFn: ${endpoint.mediaUpload ? "async " : ""}(${mutationFnArg}) => ${hasMutationFnBody ? "{ " : ""}`);
 	lines.push(...renderWorkspaceParamCoalescing({
 		replacements: workspaceParamReplacements,
@@ -4596,12 +4627,18 @@ function renderMutation({ resolver, endpoint, inlineEndpoints, precomputed }) {
 	} else lines.push(`      ${hasMutationFnBody ? "return " : ""}${endpointFunction}(${resolvedEndpointArgs}${hasAxiosRequestConfig ? `${resolvedEndpointArgs ? ", " : ""}${AXIOS_REQUEST_CONFIG_NAME}` : ""})`);
 	if (hasMutationFnBody) lines.push("    },");
 	else lines.push(",");
+	if (isScoped) {
+		const scopePathParamInterpolations = scopePathParams.map((p) => `:\${${p.name}}`).join("");
+		lines.push(`    scope: { id: \`${getEndpointName(endpoint)}${scopePathParamInterpolations}\` },`);
+	}
 	lines.push("    ...options,");
 	if (hasMutationDefaultOnError) lines.push("    onError: options?.onError ?? queryConfig.onError,");
 	if (hasMutationEffects) {
 		lines.push("    onSuccess: async (resData, variables, onMutateResult, context) => {");
 		if (updateQueryEndpoints.length > 0) {
-			if (destructuredVariables.length > 0) lines.push(`      const { ${destructuredVariables.join(", ")} } = variables;`);
+			const scopedPathParamNames = new Set(scopePathParams.map((p) => p.name));
+			const variablesDestructure = destructuredVariables.filter((v) => !scopedPathParamNames.has(v));
+			if (variablesDestructure.length > 0) lines.push(`      const { ${variablesDestructure.join(", ")} } = variables;`);
 			lines.push(...renderWorkspaceParamCoalescing({
 				replacements: workspaceParamReplacements,
 				indent: "      "

package/dist/generator.d.mts

@@ -1,4 +1,4 @@
-import { n as GenerateFileData, t as GenerateOptions } from "./options-C6CNQ6tq.mjs";
+import { n as GenerateFileData, t as GenerateOptions } from "./options-BPAjzilp.mjs";
 import { OpenAPIV3 } from "openapi-types";
 
 //#region src/generators/types/metadata.d.ts

package/dist/generator.mjs

@@ -1,4 +1,4 @@
-import { _ as getNamespaceName, a as getDataFromOpenAPIDoc, b as isParamMediaTypeAllowed, c as getSchemaTsMetaType, d as getTagImportPath, f as getQueryName, g as invalidVariableNameCharactersToCamel, l as getTsTypeBase, o as isMutation, p as DEFAULT_GENERATE_OPTIONS, s as isQuery, t as generateCodeFromOpenAPIDoc, v as GenerateType, x as formatTag, y as isMediaTypeAllowed } from "./generateCodeFromOpenAPIDoc-BKIXvJIW.mjs";
+import { _ as getNamespaceName, a as getDataFromOpenAPIDoc, b as isParamMediaTypeAllowed, c as getSchemaTsMetaType, d as getTagImportPath, f as getQueryName, g as invalidVariableNameCharactersToCamel, l as getTsTypeBase, o as isMutation, p as DEFAULT_GENERATE_OPTIONS, s as isQuery, t as generateCodeFromOpenAPIDoc, v as GenerateType, x as formatTag, y as isMediaTypeAllowed } from "./generateCodeFromOpenAPIDoc-CbBWYEZG.mjs";
 import SwaggerParser from "@apidevtools/swagger-parser";
 
 //#region src/generators/core/getMetadataFromOpenAPIDoc.ts

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { a as GeneralErrorCodes, i as ErrorHandlerOptions, n as ErrorEntry, o as SharedErrorHandler, r as ErrorHandler, t as ApplicationException } from "./error-handling-CvW_FecB.mjs";
-import "./options-C6CNQ6tq.mjs";
-import { t as OpenAPICodegenConfig } from "./config-CKmoJbQB.mjs";
+import "./options-BPAjzilp.mjs";
+import { t as OpenAPICodegenConfig } from "./config-C1ME3Ay4.mjs";
 import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, CreateAxiosDefaults } from "axios";
 import { z } from "zod";
 import "i18next";

package/dist/{options-C6CNQ6tq.d.mts → options-BPAjzilp.d.mts}

@@ -42,7 +42,11 @@ interface QueriesGenerateOptions {
   mutationDefaultOnError?: boolean;
   workspaceContext?: string[];
   prefetchQueries?: boolean;
-  mutationScope?: boolean;
+  mutationScope?: boolean | {
+    include: string[];
+  } | {
+    exclude: string[];
+  };
 }
 interface InfiniteQueriesGenerateOptions {
   infiniteQueries?: boolean;

package/dist/sh.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { C as VALIDATION_ERROR_TYPE_TITLE, S as Profiler, a as getDataFromOpenAPIDoc, m as groupByType, n as getOutputFileName, u as getTagFileName, v as GenerateType } from "./generateCodeFromOpenAPIDoc-BKIXvJIW.mjs";
-import { n as resolveConfig, t as runGenerate } from "./generate.runner-B0iop_CE.mjs";
+import { C as VALIDATION_ERROR_TYPE_TITLE, S as Profiler, a as getDataFromOpenAPIDoc, m as groupByType, n as getOutputFileName, u as getTagFileName, v as GenerateType } from "./generateCodeFromOpenAPIDoc-CbBWYEZG.mjs";
+import { n as resolveConfig, t as runGenerate } from "./generate.runner-BsNMtOTd.mjs";
 import { createRequire } from "node:module";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
@@ -39,7 +39,7 @@ function logBanner(message) {
 * Fetch the version from package.json
 */
 function getVersion() {
-	return "3.0.0-rc.1";
+	return "3.0.0-rc.2";
 }
 
 //#endregion

package/dist/vite.d.mts

@@ -1,5 +1,5 @@
-import { r as GenerateFileFormatter } from "./options-C6CNQ6tq.mjs";
-import { t as OpenAPICodegenConfig } from "./config-CKmoJbQB.mjs";
+import { r as GenerateFileFormatter } from "./options-BPAjzilp.mjs";
+import { t as OpenAPICodegenConfig } from "./config-C1ME3Ay4.mjs";
 import { Plugin } from "vite";
 
 //#region src/vite/openapi-codegen.plugin.d.ts

package/dist/vite.mjs

@@ -1,5 +1,5 @@
-import { S as Profiler } from "./generateCodeFromOpenAPIDoc-BKIXvJIW.mjs";
-import { t as runGenerate } from "./generate.runner-B0iop_CE.mjs";
+import { S as Profiler } from "./generateCodeFromOpenAPIDoc-CbBWYEZG.mjs";
+import { t as runGenerate } from "./generate.runner-BsNMtOTd.mjs";
 import path from "path";
 
 //#region src/vite/openapi-codegen.plugin.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.2",
   "keywords": [
     "codegen",
     "openapi",