Upgrade zod from v3 to v4 (#136)

laurakoye · web-flow · commit 6532a1ddf22b · 2026-04-01T13:12:06.000-04:00
diff --git a/lib/src/formatters/shared/base.ts b/lib/src/formatters/shared/base.ts
@@ -130,7 +130,7 @@ export default class BaseFormatter<OutputFileType, APIDataType = unknown> {
 
   public async format(): Promise<void> {
     const data = await this.fetchAPIData();
-    const files = await this.transformAPIData(data);
+    const files = this.transformAPIData(data);
     await this.writeFiles(files);
   }
 
diff --git a/lib/src/http/variables.ts b/lib/src/http/variables.ts
@@ -9,49 +9,39 @@ const ZBaseVariable = z.object({
   name: z.string(),
 });
 
-const ZVariableNumber = ZBaseVariable.merge(
-  z.object({
-    type: z.literal("number"),
-    data: z.object({
-      example: z.union([z.number(), z.string()]),
-      fallback: z.union([z.number(), z.string()]).optional(),
-    }),
-  })
-);
+const ZVariableNumber = ZBaseVariable.extend({
+  type: z.literal("number"),
+  data: z.object({
+    example: z.union([z.number(), z.string()]),
+    fallback: z.union([z.number(), z.string()]).optional(),
+  }),
+});
 
-const ZVariableString = ZBaseVariable.merge(
-  z.object({
-    type: z.literal("string"),
-    data: z.object({
-      example: z.string(),
-      fallback: z.string().optional(),
-    }),
-  })
-);
+const ZVariableString = ZBaseVariable.extend({
+  type: z.literal("string"),
+  data: z.object({
+    example: z.string(),
+    fallback: z.string().optional(),
+  }),
+});
 
-const ZVariableHyperlink = ZBaseVariable.merge(
-  z.object({
-    type: z.literal("hyperlink"),
-    data: z.object({
-      text: z.string(),
-      url: z.string(),
-    }),
-  })
-);
+const ZVariableHyperlink = ZBaseVariable.extend({
+  type: z.literal("hyperlink"),
+  data: z.object({
+    text: z.string(),
+    url: z.string(),
+  }),
+});
 
-const ZVariableList = ZBaseVariable.merge(
-  z.object({
-    type: z.literal("list"),
-    data: z.array(z.string()),
-  })
-);
+const ZVariableList = ZBaseVariable.extend({
+  type: z.literal("list"),
+  data: z.array(z.string()),
+});
 
-const ZVariableMap = ZBaseVariable.merge(
-  z.object({
-    type: z.literal("map"),
-    data: z.record(z.string()),
-  })
-);
+const ZVariableMap = ZBaseVariable.extend({
+  type: z.literal("map"),
+  data: z.record(z.string(), z.string()),
+});
 
 const ZVariable = z.discriminatedUnion("type", [
   ZVariableString,
diff --git a/lib/src/outputs/android.ts b/lib/src/outputs/android.ts
@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { ZBaseOutputFilters } from "./shared";
 
-export const ZAndroidOutput = ZBaseOutputFilters.extend({
-  format: z.literal("android"),
-  framework: z.undefined(),
-}).strict();
+export const ZAndroidOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("android"),
+  }).shape
+);
diff --git a/lib/src/outputs/iosStrings.ts b/lib/src/outputs/iosStrings.ts
@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { ZBaseOutputFilters } from "./shared";
 
-export const ZIOSStringsOutput = ZBaseOutputFilters.extend({
-  format: z.literal("ios-strings"),
-  framework: z.undefined(),
-}).strict();
+export const ZIOSStringsOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("ios-strings"),
+  }).shape
+);
diff --git a/lib/src/outputs/iosStringsDict.ts b/lib/src/outputs/iosStringsDict.ts
@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { ZBaseOutputFilters } from "./shared";
 
-export const ZIOSStringsDictOutput = ZBaseOutputFilters.extend({
-  format: z.literal("ios-stringsdict"),
-  framework: z.undefined(),
-}).strict();
+export const ZIOSStringsDictOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("ios-stringsdict"),
+  }).shape
+);
diff --git a/lib/src/outputs/json.ts b/lib/src/outputs/json.ts
@@ -1,20 +1,27 @@
 import { z } from "zod";
 import { ZBaseOutputFilters } from "./shared";
 
-const ZBaseJSONOutput = ZBaseOutputFilters.extend({
-  format: z.literal("json"),
-  framework: z.undefined(),
-}).strict();
+const ZBaseJSONOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("json"),
+  }).shape
+);
 
-const Zi18NextJSONOutput = ZBaseJSONOutput.extend({
-  framework: z.literal("i18next"),
-  type: z.literal("module").or(z.literal("commonjs")).optional(),
-}).strict();
+const Zi18NextJSONOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("json"),
+    framework: z.literal("i18next"),
+    type: z.literal("module").or(z.literal("commonjs")).optional(),
+  }).shape
+);
 
-const ZVueI18nJSONOutput = ZBaseJSONOutput.extend({
-  framework: z.literal("vue-i18n"),
-  type: z.literal("module").or(z.literal("commonjs")).optional(),
-}).strict();
+const ZVueI18nJSONOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("json"),
+    framework: z.literal("vue-i18n"),
+    type: z.literal("module").or(z.literal("commonjs")).optional(),
+  }).shape
+);
 
 export const ZJSONOutput = z.discriminatedUnion("framework", [
   ZBaseJSONOutput,
diff --git a/lib/src/outputs/jsonICU.ts b/lib/src/outputs/jsonICU.ts
@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { ZBaseOutputFilters } from "./shared";
 
-export const ZJSONICUOutput = ZBaseOutputFilters.extend({
-  format: z.literal("json_icu"),
-  framework: z.undefined(),
-}).strict();
+export const ZJSONICUOutput = z.strictObject(
+  ZBaseOutputFilters.extend({
+    format: z.literal("json_icu"),
+  }).shape
+);
diff --git a/lib/src/outputs/shared.ts b/lib/src/outputs/shared.ts
@@ -6,6 +6,7 @@ import { ZTagsFilter, ZTextStatus } from "../http/types";
  * They are all optional by default unless otherwise specified in the output config.
  */
 export const ZBaseOutputFilters = z.object({
+  framework: z.undefined().optional(),
   projects: z.array(z.object({ id: z.string() })).optional(),
   components: z
     .object({
diff --git a/lib/src/services/apiToken/promptForApiToken.ts b/lib/src/services/apiToken/promptForApiToken.ts
@@ -14,11 +14,11 @@ export const validate = async (token: string) => {
  * @returns The collected token
  */
 export default async function promptForApiToken() {
+  // @ts-expect-error - Enquirer types are not updated for the validate function
   const response = await prompt<{ token: string }>({
     type: "input",
     name: "token",
     message: "What is your API key?",
-    // @ts-expect-error - Enquirer types are not updated for the validate function
     validate,
   });
 
diff --git a/lib/src/services/projectConfig.ts b/lib/src/services/projectConfig.ts
@@ -7,9 +7,11 @@ import { ZBaseOutputFilters } from "../outputs/shared";
 import { ZOutput } from "../outputs";
 import DittoError, { ErrorType } from "../utils/DittoError";
 
-const ZProjectConfigYAML = ZBaseOutputFilters.extend({
-  outputs: z.array(ZOutput),
-}).strict();
+const ZProjectConfigYAML = z.strictObject(
+  ZBaseOutputFilters.extend({
+    outputs: z.array(ZOutput),
+  }).shape
+);
 
 export type ProjectConfigYAML = z.infer<typeof ZProjectConfigYAML>;
 
@@ -63,7 +65,7 @@ function readProjectConfigData(
     throw new DittoError({
       type: ErrorType.ConfigParseError,
       data: {
-        formattedError: JSON.stringify(parsedYAML.error.flatten(), null, 2),
+        formattedError: z.prettifyError(parsedYAML.error),
         messagePrefix: "There is an error in your project config file.",
       },
     });
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dittowords/cli",
-  "version": "5.5.0",
+  "version": "5.5.1",
   "description": "Command Line Interface for Ditto (dittowords.com).",
   "license": "MIT",
   "main": "bin/ditto.js",
@@ -81,7 +81,7 @@
     "js-yaml": "^4.1.0",
     "memfs": "^4.7.7",
     "ora": "^5.0.0",
-    "zod": "^3.24.2"
+    "zod": "^4.0.0"
   },
   "lint-staged": {
     "src/**/*.{js,jsx,ts,tsx,css,json}": "prettier --write"
diff --git a/yarn.lock b/yarn.lock
@@ -4695,7 +4695,7 @@ yocto-queue@^0.1.0:
   resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b"
   integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==
 
-zod@^3.24.2:
-  version "3.24.2"
-  resolved "https://registry.yarnpkg.com/zod/-/zod-3.24.2.tgz#8efa74126287c675e92f46871cfc8d15c34372b3"
-  integrity sha512-lY7CDW43ECgW9u1TcT3IoXHflywfVqDYze4waEz812jR/bZ8FHDsl7pFQoSZTz5N+2NqRXs8GBwnAwo3ZNxqhQ==
+zod@^4.0.0:
+  version "4.3.6"
+  resolved "https://registry.yarnpkg.com/zod/-/zod-4.3.6.tgz#89c56e0aa7d2b05107d894412227087885ab112a"
+  integrity sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ export default class BaseFormatter<OutputFileType, APIDataType = unknown> {`
`130`	`130`
`131`	`131`	`public async format(): Promise<void> {`
`132`	`132`	`const data = await this.fetchAPIData();`
`133`		`- const files = await this.transformAPIData(data);`
	`133`	`+ const files = this.transformAPIData(data);`
`134`	`134`	`await this.writeFiles(files);`
`135`	`135`	`}`
`136`	`136`