@povio/openapi-codegen-cli 2.0.8-rc.34 → 2.0.8-rc.35

package/README.md

@@ -92,7 +92,7 @@ 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)
-  --workspaceContext                  Allow generated hooks to resolve path/ACL params from OpenApiWorkspaceContext (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)
   --inlineEndpointsExcludeModules     Comma-separated modules/tags to keep as separate API files while inlineEndpoints=true
   --modelsOnly                        Generate only model files (default: false)
@@ -196,18 +196,18 @@ export default config;
 
 ### OpenApiWorkspaceContext (Path + ACL defaults)
 
-Enable `workspaceContext: true` in codegen config (or pass `--workspaceContext`) and wrap your app subtree with `OpenApiWorkspaceContext.Provider` if generated hooks frequently repeat workspace-scoped params (for example `officeId`).
+Set `workspaceContext` to a list of param names in codegen config (or pass `--workspaceContext officeId,projectId`) and wrap your app subtree with `OpenApiWorkspaceContext.Provider` if generated hooks frequently repeat workspace-scoped params.
 
 ```tsx
 import { OpenApiWorkspaceContext } from "@povio/openapi-codegen-cli";
-// openapi-codegen.config.ts -> { workspaceContext: true }
+// openapi-codegen.config.ts -> { workspaceContext: ["officeId", "projectId"] }
 
 <OpenApiWorkspaceContext.Provider values={{ officeId: "office_123" }}>
   <MyWorkspacePages />
 </OpenApiWorkspaceContext.Provider>;
 ```
 
-Generated query/mutation hooks can then omit matching path/ACL params and resolve them from `OpenApiWorkspaceContext`.
+Generated query/mutation hooks can then omit only those matching path/ACL params and resolve them from `OpenApiWorkspaceContext`. Params not listed in `workspaceContext` remain explicit and required.
 
 ### Generation Modes
 

package/dist/{config-KffSntOs.d.mts → config-DqD9ExKp.d.mts}

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

package/dist/{generate.runner-CTwFD7Th.mjs → generate.runner-QejaDLjW.mjs}

@@ -1,16 +1,18 @@
-import { S as Profiler, i as writeGenerateFileData, m as DEFAULT_GENERATE_OPTIONS, o as deepMerge, r as removeStaleGeneratedFiles, t as generateCodeFromOpenAPIDoc } from "./generateCodeFromOpenAPIDoc-B--xr_dZ.mjs";
+import { S as Profiler, i as writeGenerateFileData, m as DEFAULT_GENERATE_OPTIONS, o as deepMerge, r as removeStaleGeneratedFiles, t as generateCodeFromOpenAPIDoc } from "./generateCodeFromOpenAPIDoc-C2niF2V7.mjs";
 import path from "path";
 import SwaggerParser from "@apidevtools/swagger-parser";
 
 //#region src/generators/core/resolveConfig.ts
-function resolveConfig({ fileConfig = {}, params: { includeTags, excludeTags, inlineEndpointsExcludeModules, ...options } }) {
+function resolveConfig({ fileConfig = {}, params: { includeTags, excludeTags, inlineEndpointsExcludeModules, workspaceContext, ...options } }) {
 	const resolvedConfig = deepMerge(DEFAULT_GENERATE_OPTIONS, fileConfig ?? {}, {
 		...options,
 		includeTags: includeTags?.split(","),
 		excludeTags: excludeTags?.split(","),
-		inlineEndpointsExcludeModules: inlineEndpointsExcludeModules?.split(",")
+		inlineEndpointsExcludeModules: inlineEndpointsExcludeModules?.split(","),
+		workspaceContext: workspaceContext?.split(",")
 	});
 	resolvedConfig.checkAcl = resolvedConfig.acl && resolvedConfig.checkAcl;
+	resolvedConfig.workspaceContext = Array.from(new Set((resolvedConfig.workspaceContext ?? []).map((value) => value.trim()).filter(Boolean)));
 	return resolvedConfig;
 }
 

package/dist/{generateCodeFromOpenAPIDoc-B--xr_dZ.mjs → generateCodeFromOpenAPIDoc-C2niF2V7.mjs}

@@ -645,7 +645,7 @@ const DEFAULT_GENERATE_OPTIONS = {
 	queryTypesImportPath: PACKAGE_IMPORT_PATH,
 	axiosRequestConfig: false,
 	mutationEffects: true,
-	workspaceContext: false,
+	workspaceContext: [],
 	prefetchQueries: true,
 	infiniteQueries: false,
 	infiniteQueryParamNames: { page: "page" },
@@ -1248,6 +1248,7 @@ const hasEndpointConfig = (endpoint, resolver) => {
 };
 const getEndpointPath = (endpoint) => endpoint.path.replace(/:([a-zA-Z0-9_]+)/g, "${$1}");
 function mapEndpointParamsToFunctionParams(resolver, endpoint, options) {
+	const optionalPathParams = options?.optionalPathParams ? new Set(options.optionalPathParams) : void 0;
 	const params = endpoint.parameters.map((param) => {
 		let type = "string";
 		if (isNamedZodSchema(param.zodSchema)) type = getImportedZodSchemaInferedTypeName(resolver, param.zodSchema, void 0, options?.modelNamespaceTag);
@@ -1286,7 +1287,7 @@ function mapEndpointParamsToFunctionParams(resolver, endpoint, options) {
 	}).filter((param) => (!options?.excludeBodyParam || param.name !== BODY_PARAMETER_NAME) && (!options?.excludePageParam || param.name !== resolver.options.infiniteQueryParamNames.page) && (!options?.includeOnlyRequiredParams || param.required)).map((param) => ({
 		...param,
 		name: options?.replacePageParam && param.name === resolver.options.infiniteQueryParamNames.page ? "pageParam" : param.name,
-		required: options?.optionalPathParams && param.paramType === "Path" ? false : param.required && (param.paramType === "Path" || !options?.pathParamsRequiredOnly)
+		required: param.paramType === "Path" && optionalPathParams?.has(param.name) ? false : param.required && (param.paramType === "Path" || !options?.pathParamsRequiredOnly)
 	}));
 }
 function getEndpointConfig(endpoint) {
@@ -4114,13 +4115,16 @@ function getEndpointParamMapping(resolver, endpoint, options) {
 		endpointCache = /* @__PURE__ */ new Map();
 		resolverCache.set(endpoint, endpointCache);
 	}
-	const key = JSON.stringify(Object.entries(options ?? {}).sort(([left], [right]) => left.localeCompare(right)).map(([optionName, optionValue]) => [optionName, Boolean(optionValue)]));
+	const key = JSON.stringify(Object.entries(options ?? {}).sort(([left], [right]) => left.localeCompare(right)).map(([optionName, optionValue]) => [optionName, optionValue]));
 	const cached = endpointCache.get(key);
 	if (cached) return cached;
 	const computed = mapEndpointParamsToFunctionParams(resolver, endpoint, options);
 	endpointCache.set(key, computed);
 	return computed;
 }
+function getWorkspaceContextAllowList(workspaceContext) {
+	return new Set(workspaceContext);
+}
 function renderImport(importData) {
 	const namedImports = [...importData.bindings, ...(importData.typeBindings ?? []).map((binding) => importData.typeOnly ? binding : `type ${binding}`)];
 	const names = [...importData.defaultImport ? [importData.defaultImport] : [], ...namedImports.length > 0 ? [`{ ${namedImports.join(", ")} }`] : []].join(", ");
@@ -4157,11 +4161,12 @@ function renderEndpointParamDescription(endpointParam) {
 	return strs.join(". ");
 }
 function getWorkspaceParamNames(resolver, endpoint) {
+	const allowList = getWorkspaceContextAllowList(resolver.options.workspaceContext);
 	const endpointParams = getEndpointParamMapping(resolver, endpoint, {});
 	const endpointParamNames = new Set(endpointParams.map((param) => param.name));
 	const workspaceParamNames = endpointParams.filter((param) => param.paramType === "Path").map((param) => param.name);
 	const aclParamNames = (getAbilityConditionsTypes(endpoint) ?? []).map((condition) => invalidVariableNameCharactersToCamel(condition.name)).filter((name) => endpointParamNames.has(name));
-	return getUniqueArray([...workspaceParamNames, ...aclParamNames]);
+	return getUniqueArray([...workspaceParamNames, ...aclParamNames]).filter((name) => allowList.has(name));
 }
 function getWorkspaceParamReplacements(resolver, endpoint) {
 	return Object.fromEntries(getWorkspaceParamNames(resolver, endpoint).map((name) => [name, `${name}FromWorkspace`]));

package/dist/generator.d.mts

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

package/dist/generator.mjs

@@ -1,4 +1,4 @@
-import { a as getDataFromOpenAPIDoc, b as invalidVariableNameCharactersToCamel, c as isQuery, f as getTagImportPath, g as GenerateType, h as getNamespaceName, l as getSchemaTsMetaType, m as DEFAULT_GENERATE_OPTIONS, p as getQueryName, s as isMutation, t as generateCodeFromOpenAPIDoc, u as getTsTypeBase, v as isMediaTypeAllowed, x as formatTag, y as isParamMediaTypeAllowed } from "./generateCodeFromOpenAPIDoc-B--xr_dZ.mjs";
+import { a as getDataFromOpenAPIDoc, b as invalidVariableNameCharactersToCamel, c as isQuery, f as getTagImportPath, g as GenerateType, h as getNamespaceName, l as getSchemaTsMetaType, m as DEFAULT_GENERATE_OPTIONS, p as getQueryName, s as isMutation, t as generateCodeFromOpenAPIDoc, u as getTsTypeBase, v as isMediaTypeAllowed, x as formatTag, y as isParamMediaTypeAllowed } from "./generateCodeFromOpenAPIDoc-C2niF2V7.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-CXeVTk1T.mjs";
-import "./options-D9TC-n26.mjs";
-import { t as OpenAPICodegenConfig } from "./config-KffSntOs.mjs";
+import "./options-D3n-bZbj.mjs";
+import { t as OpenAPICodegenConfig } from "./config-DqD9ExKp.mjs";
 import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, CreateAxiosDefaults } from "axios";
 import { z } from "zod";
 import "i18next";

package/dist/{options-D9TC-n26.d.mts → options-D3n-bZbj.d.mts}

@@ -39,7 +39,7 @@ interface QueriesGenerateOptions {
   queryTypesImportPath: string;
   axiosRequestConfig?: boolean;
   mutationEffects?: boolean;
-  workspaceContext?: boolean;
+  workspaceContext?: string[];
   prefetchQueries?: boolean;
 }
 interface InfiniteQueriesGenerateOptions {

package/dist/sh.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { C as VALIDATION_ERROR_TYPE_TITLE, S as Profiler, _ as groupByType, a as getDataFromOpenAPIDoc, d as getTagFileName, g as GenerateType, n as getOutputFileName } from "./generateCodeFromOpenAPIDoc-B--xr_dZ.mjs";
-import { n as resolveConfig, t as runGenerate } from "./generate.runner-CTwFD7Th.mjs";
+import { C as VALIDATION_ERROR_TYPE_TITLE, S as Profiler, _ as groupByType, a as getDataFromOpenAPIDoc, d as getTagFileName, g as GenerateType, n as getOutputFileName } from "./generateCodeFromOpenAPIDoc-C2niF2V7.mjs";
+import { n as resolveConfig, t as runGenerate } from "./generate.runner-QejaDLjW.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 "2.0.8-rc.34";
+	return "2.0.8-rc.35";
 }
 
 //#endregion
@@ -389,10 +389,7 @@ __decorate([YargOption({
 	envAlias: "mutationEffects",
 	type: "boolean"
 }), __decorateMetadata("design:type", Boolean)], GenerateOptions.prototype, "mutationEffects", void 0);
-__decorate([YargOption({
-	envAlias: "workspaceContext",
-	type: "boolean"
-}), __decorateMetadata("design:type", Boolean)], GenerateOptions.prototype, "workspaceContext", void 0);
+__decorate([YargOption({ envAlias: "workspaceContext" }), __decorateMetadata("design:type", String)], GenerateOptions.prototype, "workspaceContext", void 0);
 __decorate([YargOption({
 	envAlias: "parseRequestParams",
 	type: "boolean"

package/dist/vite.d.mts

@@ -1,5 +1,5 @@
-import { r as GenerateFileFormatter } from "./options-D9TC-n26.mjs";
-import { t as OpenAPICodegenConfig } from "./config-KffSntOs.mjs";
+import { r as GenerateFileFormatter } from "./options-D3n-bZbj.mjs";
+import { t as OpenAPICodegenConfig } from "./config-DqD9ExKp.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-B--xr_dZ.mjs";
-import { t as runGenerate } from "./generate.runner-CTwFD7Th.mjs";
+import { S as Profiler } from "./generateCodeFromOpenAPIDoc-C2niF2V7.mjs";
+import { t as runGenerate } from "./generate.runner-QejaDLjW.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": "2.0.8-rc.34",
+  "version": "2.0.8-rc.35",
   "keywords": [
     "codegen",
     "openapi",