mobx-tanstack-query-api 0.38.2 → 0.39.1

package/cli.d.ts

@@ -149,7 +149,7 @@ interface GenerateQueryApiParams {
      * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#fetchschemarequestoptions)
      */
     fetchSchemaRequestOptions?: RequestInit;
-    otherCodegenParams?: AnyObject;
+    otherCodegenParams?: Partial<GenerateApiConfiguration['config']>;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#filterendpoints)
      */
@@ -199,6 +199,10 @@ interface GenerateQueryApiParams {
      * - `{ throw: boolean }`: set `throwContracts` to that boolean.
      * - `{ throw: string }`: set `throwContracts` to the expression (inserted as-is).
      * - `{ throw: { params?: boolean | string; data?: boolean | string } }`: set `throwContracts` to an object; each value is literal or expression (string inserted as-is).
+     *
+     * Optional `appendRule`: either a string (runtime) or a function (codegen-time).
+     * - **string**: expression inserted as-is → `contracts: <expr> ? <contractsVar> : undefined`. E.g. `"process.env.NODE_ENV === \"development\""`.
+     * - **function** (contractName, routeInfo) => boolean: at codegen time, if true → `contracts: <contractsVar>`, if false → `contracts: undefined`.
      */
     zodContracts?: boolean | {
         validate: boolean | string | {
@@ -209,8 +213,17 @@ interface GenerateQueryApiParams {
             params?: boolean | string;
             data?: boolean | string;
         };
+        /** String: runtime condition. Function: codegen-time filter for (contractName, routeInfo). */
+        appendRule?: string | ((contractName: string, routeInfo: ZodContractsRouteInfo) => boolean);
     };
 }
+/** Route info passed to zodContracts.appendRule at codegen time. */
+interface ZodContractsRouteInfo {
+    operationId: string;
+    path: string;
+    method: string;
+    contractName: string;
+}
 
 type AllImportFileParams = Record<KeyOfByValue<Required<GenerateQueryApiParams>, 'builtin' | ImportFileParams>, ImportFileParams>;
 
@@ -235,4 +248,4 @@ declare const generateApi: (params: GenerateQueryApiParams | GenerateQueryApiPar
 declare const defineConfig: (...configs: Maybe<GenerateQueryApiParams | GenerateQueryApiParams[]>[]) => GenerateQueryApiParams[];
 
 export { defineConfig, generateApi };
-export type { AllImportFileParams, BaseTmplParams, CodegenDataUtils, EndpointData, GenerateQueryApiParams, ImportFileParams, MetaInfo };
+export type { AllImportFileParams, BaseTmplParams, CodegenDataUtils, EndpointData, GenerateQueryApiParams, ImportFileParams, MetaInfo, ZodContractsRouteInfo };

package/cli.js

@@ -910,7 +910,26 @@ const newEndpointTmpl = ({
     openApiComponentsParameters: swaggerSchema?.components?.parameters ?? void 0,
     queryParamName: queryName
   }) : null;
-  const contractsLine = contractsVarName != null ? `contracts: ${contractsVarName},` : "";
+  const appendRuleOpt = zodContractsIsObject && zodContracts.appendRule != null ? zodContracts.appendRule : null;
+  const routeInfoForAppend = contractsVarName != null ? {
+    operationId: raw.operationId ?? "",
+    path: path2,
+    method,
+    contractName: contractsVarName
+  } : null;
+  const contractsLine = (() => {
+    if (contractsVarName == null) return "";
+    if (typeof appendRuleOpt === "string")
+      return `contracts: ${appendRuleOpt} ? ${contractsVarName} : undefined,`;
+    if (typeof appendRuleOpt === "function" && routeInfoForAppend) {
+      const include = appendRuleOpt(
+        routeInfoForAppend.contractName,
+        routeInfoForAppend
+      );
+      return include ? `contracts: ${contractsVarName},` : "contracts: undefined,";
+    }
+    return `contracts: ${contractsVarName},`;
+  })();
   const validateContractsLine = (() => {
     if (validateOpt === void 0) return "";
     if (typeof validateOpt === "string")
@@ -1488,12 +1507,25 @@ const generateApi = async (params) => {
     sortTypes: true,
     templates: paths.templates.toString(),
     primitiveTypeConstructs: (constructs) => {
-      return {
+      const result = {
         ...constructs,
         object: () => `Record<string, any>`,
-        float: () => `number`,
-        ...params.otherCodegenParams?.primitiveTypeConstructs?.(constructs)
+        float: () => `number`
       };
+      if (params.otherCodegenParams?.primitiveTypeConstructs) {
+        if (typeof params.otherCodegenParams?.primitiveTypeConstructs === "function") {
+          Object.assign(
+            result,
+            params.otherCodegenParams.primitiveTypeConstructs(result)
+          );
+        } else {
+          Object.assign(
+            result,
+            params.otherCodegenParams.primitiveTypeConstructs
+          );
+        }
+      }
+      return result;
     },
     requestOptions: params.fetchSchemaRequestOptions,
     ...params.otherCodegenParams
@@ -1507,6 +1539,34 @@ const generateApi = async (params) => {
     );
     return;
   }
+  const prepareConfig = (config) => {
+    config.routes.combined?.forEach((routeInfo) => {
+      routeInfo.routes.sort(
+        (routeA, routeB) => routeA.routeName.usage.localeCompare(routeB.routeName.usage)
+      );
+    });
+    return params.otherCodegenParams?.hooks?.onPrepareConfig?.(config);
+  };
+  const formatRouteName = (routeInfo, usageRouteName) => {
+    let formattedRouteName = usageRouteName;
+    if (params.addPathSegmentToRouteName === true || typeof params.addPathSegmentToRouteName === "number") {
+      const pathSegmentForSuffix = typeof params.addPathSegmentToRouteName === "number" ? params.addPathSegmentToRouteName : 0;
+      const pathSegments = routeInfo.route.split("/").filter(Boolean);
+      const { _: _2 } = codegenProcess.getRenderTemplateData().utils;
+      formattedRouteName = _2.camelCase(
+        `${pathSegments[pathSegmentForSuffix] || ""}_${formattedRouteName}`
+      );
+    }
+    const endpointName = formattedRouteName;
+    const resultRouteName = params?.formatEndpointName?.(endpointName, routeInfo) ?? swaggerTypescriptApiCodegenBaseParams?.hooks?.onFormatRouteName?.(
+      routeInfo,
+      endpointName
+    ) ?? endpointName;
+    return params.otherCodegenParams?.hooks?.onFormatRouteName?.(
+      routeInfo,
+      resultRouteName
+    ) ?? resultRouteName;
+  };
   const inputToCodegenInput = (input) => {
     const inputData = {};
     if (typeof input === "string") {
@@ -1523,32 +1583,11 @@ const generateApi = async (params) => {
       ...swaggerTypescriptApiCodegenBaseParams,
       ...inputToCodegenInput(params.mixinInput),
       hooks: {
-        onInit: (configuration) => {
+        onInit: (configuration, codegenProcess2) => {
           mixinSwaggerSchema = cloneDeep(configuration.swaggerSchema);
         },
-        onPrepareConfig: (config) => {
-          config.routes.combined?.forEach((routeInfo) => {
-            routeInfo.routes.sort(
-              (routeA, routeB) => routeA.routeName.usage.localeCompare(routeB.routeName.usage)
-            );
-          });
-        },
-        onFormatRouteName: (routeInfo, usageRouteName) => {
-          let formattedRouteName = usageRouteName;
-          if (params.addPathSegmentToRouteName === true || typeof params.addPathSegmentToRouteName === "number") {
-            const pathSegmentForSuffix = typeof params.addPathSegmentToRouteName === "number" ? params.addPathSegmentToRouteName : 0;
-            const pathSegments = routeInfo.route.split("/").filter(Boolean);
-            const { _: _2 } = codegenProcess.getRenderTemplateData().utils;
-            formattedRouteName = _2.camelCase(
-              `${pathSegments[pathSegmentForSuffix] || ""}_${formattedRouteName}`
-            );
-          }
-          const endpointName = formattedRouteName;
-          return params?.formatEndpointName?.(endpointName, routeInfo) ?? swaggerTypescriptApiCodegenBaseParams?.hooks?.onFormatRouteName?.(
-            routeInfo,
-            endpointName
-          ) ?? endpointName;
-        }
+        onPrepareConfig: prepareConfig,
+        onFormatRouteName: formatRouteName
       }
     });
   }
@@ -1574,32 +1613,8 @@ const generateApi = async (params) => {
           codeGenProcessFromInit
         );
       },
-      onPrepareConfig: (config) => {
-        config.routes.combined?.forEach((routeInfo) => {
-          routeInfo.routes.sort(
-            (routeA, routeB) => routeA.routeName.usage.localeCompare(routeB.routeName.usage)
-          );
-        });
-        return swaggerTypescriptApiCodegenBaseParams?.hooks?.onPrepareConfig?.(
-          config
-        );
-      },
-      onFormatRouteName: (routeInfo, usageRouteName) => {
-        let formattedRouteName = usageRouteName;
-        if (params.addPathSegmentToRouteName === true || typeof params.addPathSegmentToRouteName === "number") {
-          const pathSegmentForSuffix = typeof params.addPathSegmentToRouteName === "number" ? params.addPathSegmentToRouteName : 0;
-          const pathSegments = routeInfo.route.split("/").filter(Boolean);
-          const { _: _2 } = codegenProcess.getRenderTemplateData().utils;
-          formattedRouteName = _2.camelCase(
-            `${pathSegments[pathSegmentForSuffix] || ""}_${formattedRouteName}`
-          );
-        }
-        const endpointName = formattedRouteName;
-        return params?.formatEndpointName?.(endpointName, routeInfo) ?? swaggerTypescriptApiCodegenBaseParams?.hooks?.onFormatRouteName?.(
-          routeInfo,
-          endpointName
-        ) ?? endpointName;
-      }
+      onPrepareConfig: prepareConfig,
+      onFormatRouteName: formatRouteName
     }
   });
   const utils = codegenProcess.getRenderTemplateData().utils;