mobx-tanstack-query-api 0.37.1 → 0.38.1

package/cli.d.ts

@@ -184,6 +184,32 @@ interface GenerateQueryApiParams {
      * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#nobarrelfiles)
      */
     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.
+     * Requires `zod` to be installed.
+     *
+     * - `true`: generate contracts and set `validateContracts: 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).
+     *
+     * When using an object form, optional `throw` controls `throwContracts` (throw on validation errors vs warn):
+     * - `{ 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).
+     */
+    zodContracts?: boolean | {
+        validate: boolean | string | {
+            params?: boolean | string;
+            data?: boolean | string;
+        };
+        throw?: boolean | string | {
+            params?: boolean | string;
+            data?: boolean | string;
+        };
+    };
 }
 
 type AllImportFileParams = Record<KeyOfByValue<Required<GenerateQueryApiParams>, 'builtin' | ImportFileParams>, ImportFileParams>;