mobx-tanstack-query-api 0.40.1 → 0.41.1

package/cli.d.ts

@@ -1,5 +1,5 @@
 import { ParsedRoute, ModelType, RawRouteInfo, GenerateApiConfiguration, GenerateApiParams } from 'swagger-typescript-api';
-import { AnyObject, PartialKeys, Maybe, KeyOfByValue, Defined } from 'yummies/types';
+import { AnyObject, PartialKeys, Maybe, MaybeFn, KeyOfByValue, Defined } from 'yummies/types';
 import { LoDashStatic } from '/home/runner/work/mobx-tanstack-query-api/mobx-tanstack-query-api/node_modules/.pnpm/@types+lodash@4.17.24/node_modules/@types/lodash/index.d.ts';
 
 type AnyFilterOptionFn = (...args: any[]) => boolean;
@@ -27,6 +27,7 @@ interface ImportFileParams {
 
 type TypeInfo = PartialKeys<ModelType, 'rawContent'>;
 
+type RuntimeExpressionOrBoolean = string | boolean;
 interface GenerateQueryApiParams {
     /**
      * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#output)
@@ -186,15 +187,15 @@ interface GenerateQueryApiParams {
      */
     noBarrelFiles?: boolean;
     /**
-     * Generate Zod contracts (params + data schemas) for each endpoint and add `contracts` to the endpoint config.
-     * When truthy, can also enable validation via `validateContracts` in the endpoint config.
+     * Generate Zod contracts (params + data schemas) for each endpoint and add `contract` to the endpoint config.
+     * When truthy, can also enable validation via `validateContract` in the endpoint config.
      * Requires `zod` to be installed.
      *
-     * - `true`: generate contracts and set `validateContracts: true` (validate params + data).
+     * - `true`: generate contracts and set `validateContract: true` (validate params + data).
      * - `false`: no contracts, no validation.
-     * - `{ validate: boolean }`: set `validateContracts` to that boolean.
-     * - `{ validate: string }`: set `validateContracts` to the expression (inserted as-is). E.g. `"process.env.NODE_ENV === 'development'"`.
-     * - `{ validate: { params?: boolean | string; data?: boolean | string } }`: set `validateContracts` to an object; each value is literal or expression (string inserted as-is).
+     * - `{ validate: boolean }`: set `validateContract` to that boolean.
+     * - `{ validate: string }`: set `validateContract` to the expression (inserted as-is). E.g. `"process.env.NODE_ENV === 'development'"`.
+     * - `{ validate: { params?: boolean | string; data?: boolean | string } }`: set `validateContract` to an object; each value is literal or expression (string inserted as-is).
      *
      * When using an object form, optional `throw` controls `throwContracts` (throw on validation errors vs warn):
      * - `{ throw: boolean }`: set `throwContracts` to that boolean.
@@ -202,20 +203,35 @@ interface GenerateQueryApiParams {
      * - `{ 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`.
+     * - **string**: expression inserted as-is → `contract: <expr> ? <contractVar> : undefined`. E.g. `"process.env.NODE_ENV === \"development\""`.
+     * - **function** (contractName, routeInfo) => boolean: at codegen time, if true → `contract: <contractVar>`, if false → `contract: undefined`.
+     *
+     * Optional `suffix`: suffix for generated shared Zod schema variables.
+     * Shared schema names are based on data contract names in camelCase, e.g. `DispatchReceiptDC` -> `dispatchReceiptDc`.
+     * Default: `""`.
      */
     zodContracts?: boolean | {
-        validate: boolean | string | {
-            params?: boolean | string;
-            data?: boolean | string;
-        };
-        throw?: boolean | string | {
-            params?: boolean | string;
-            data?: boolean | string;
-        };
+        validate: MaybeFn<RuntimeExpressionOrBoolean | {
+            params?: RuntimeExpressionOrBoolean;
+            data?: RuntimeExpressionOrBoolean;
+        }, [
+            contractName: string,
+            routeInfo: ZodContractsRouteInfo
+        ]>;
+        throw?: MaybeFn<RuntimeExpressionOrBoolean | {
+            params?: RuntimeExpressionOrBoolean;
+            data?: RuntimeExpressionOrBoolean;
+        }, [
+            contractName: string,
+            routeInfo: ZodContractsRouteInfo
+        ]>;
         /** String: runtime condition. Function: codegen-time filter for (contractName, routeInfo). */
-        appendRule?: string | ((contractName: string, routeInfo: ZodContractsRouteInfo) => boolean);
+        appendRule?: MaybeFn<RuntimeExpressionOrBoolean, [
+            contractName: string,
+            routeInfo: ZodContractsRouteInfo
+        ]>;
+        /** Suffix for generated shared Zod schema variables. Default: "". */
+        suffix?: string;
     };
 }
 /** Route info passed to zodContracts.appendRule at codegen time. */