@infra-blocks/zod-utils 0.11.1-alpha.0 → 0.12.0-alpha.0

package/README.md

@@ -194,10 +194,13 @@ The `iso` module is an extension of `zod`'s own `iso` module. All schemas return
 
 ```typescript
 import { zu } from "@infra-blocks/zod-utils";
-import type { IsoCurrencyCode } from "@infra-blocks/zod-utils/iso";
+import type { IsoCurrencyCode, IsoAlpha3CountryCode } from "@infra-blocks/zod-utils/iso";
 
-const currency = zu.iso.currencyCode().parse("EUR");
-zu.iso.currencyCode().parse("eur"); // BOOOOOM => currency codes are case sensitive!
+zu.iso.currencyCode().parse("USD");
+zu.iso.currencyCode().parse("CAD");
+
+zu.iso.countryCode.alpha3("USA"); // The greatest country on earth.
+zu.iso.countryCode.alpha3("CAN"); // Its communist little brother.
 ```
 
 ### JSON

package/lib/cjs/index.d.ts

@@ -67,6 +67,11 @@ declare const zu: {
         currencyCode: () => z.core.$ZodBranded<z.ZodEnum<{
             [x: string]: string;
         }>, "IsoCurrencyCode">;
+        countryCode: {
+            alpha3: () => z.core.$ZodBranded<z.ZodEnum<{
+                [x: string]: string;
+            }>, "IsoAlpha3CountryCode">;
+        };
     };
     json: typeof import("./json/json.js").json & {
         array: typeof import("./json/json.js").array;

package/lib/cjs/iso/country-code.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+declare const alpha3CodeSchema: z.core.$ZodBranded<z.ZodEnum<{
+    [x: string]: string;
+}>, "IsoAlpha3CountryCode">;
+export type IsoAlpha3CountryCode = z.infer<typeof alpha3CodeSchema>;
+/**
+ * Returns a zod schema that validates that the input is a string that matches
+ * an ISO 3166 alpha 3 country code.
+ *
+ * The currency code is case-sensitive and all current currency codes are
+ * all uppercase.
+ *
+ * @returns A zod schema that validates ISO alpha 3 code strings and return the {@link IsoAlpha3CountryCode}
+ * branded type as output.
+ *
+ * @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+ */
+export declare const countryCode: {
+    alpha3: () => z.core.$ZodBranded<z.ZodEnum<{
+        [x: string]: string;
+    }>, "IsoAlpha3CountryCode">;
+};
+export {};

package/lib/cjs/iso/country-code.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countryCode = void 0;
+const iso_3166_1 = require("iso-3166");
+const zod_1 = require("zod");
+const ALPHA_3_CODES = iso_3166_1.iso31661.map((entry) => entry.alpha3);
+const alpha3CodeSchema = zod_1.z.enum(ALPHA_3_CODES).brand("IsoAlpha3CountryCode");
+/**
+ * Returns a zod schema that validates that the input is a string that matches
+ * an ISO 3166 alpha 3 country code.
+ *
+ * The currency code is case-sensitive and all current currency codes are
+ * all uppercase.
+ *
+ * @returns A zod schema that validates ISO alpha 3 code strings and return the {@link IsoAlpha3CountryCode}
+ * branded type as output.
+ *
+ * @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+ */
+exports.countryCode = {
+    alpha3: () => alpha3CodeSchema,
+};
+//# sourceMappingURL=country-code.js.map

package/lib/cjs/iso/country-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"country-code.js","sourceRoot":"","sources":["../../../src/iso/country-code.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AACpC,6BAAwB;AAExB,MAAM,aAAa,GAAG,mBAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAE5D,MAAM,gBAAgB,GAAG,OAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAI7E;;;;;;;;;;;GAWG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB;CAC/B,CAAC"}

package/lib/cjs/iso/index.d.ts

@@ -2,5 +2,10 @@ declare const module: {
     currencyCode: () => import("zod/v4/core").$ZodBranded<import("zod").ZodEnum<{
         [x: string]: string;
     }>, "IsoCurrencyCode">;
+    countryCode: {
+        alpha3: () => import("zod/v4/core").$ZodBranded<import("zod").ZodEnum<{
+            [x: string]: string;
+        }>, "IsoAlpha3CountryCode">;
+    };
 };
 export { module as iso };

package/lib/cjs/iso/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.iso = void 0;
+const country_code_js_1 = require("./country-code.js");
 const currency_code_js_1 = require("./currency-code.js");
 const module = {
     currencyCode: currency_code_js_1.currencyCode,
+    countryCode: country_code_js_1.countryCode,
 };
 exports.iso = module;
 //# sourceMappingURL=index.js.map

package/lib/cjs/iso/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/iso/index.ts"],"names":[],"mappings":";;;AAAA,yDAAkD;AAElD,MAAM,MAAM,GAAG;IACb,YAAY,EAAZ,+BAAY;CACb,CAAC;AAEiB,qBAAG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/iso/index.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAChD,yDAAkD;AAElD,MAAM,MAAM,GAAG;IACb,YAAY,EAAZ,+BAAY;IACZ,WAAW,EAAX,6BAAW;CACZ,CAAC;AAEiB,qBAAG"}

package/lib/cjs/iso/types.d.ts

@@ -1 +1,2 @@
+export { IsoAlpha3CountryCode } from "./country-code.js";
 export { IsoCurrencyCode } from "./currency-code.js";

package/lib/esm/index.d.ts

@@ -67,6 +67,11 @@ declare const zu: {
         currencyCode: () => z.core.$ZodBranded<z.ZodEnum<{
             [x: string]: string;
         }>, "IsoCurrencyCode">;
+        countryCode: {
+            alpha3: () => z.core.$ZodBranded<z.ZodEnum<{
+                [x: string]: string;
+            }>, "IsoAlpha3CountryCode">;
+        };
     };
     json: typeof import("./json/json.js").json & {
         array: typeof import("./json/json.js").array;

package/lib/esm/iso/country-code.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+declare const alpha3CodeSchema: z.core.$ZodBranded<z.ZodEnum<{
+    [x: string]: string;
+}>, "IsoAlpha3CountryCode">;
+export type IsoAlpha3CountryCode = z.infer<typeof alpha3CodeSchema>;
+/**
+ * Returns a zod schema that validates that the input is a string that matches
+ * an ISO 3166 alpha 3 country code.
+ *
+ * The currency code is case-sensitive and all current currency codes are
+ * all uppercase.
+ *
+ * @returns A zod schema that validates ISO alpha 3 code strings and return the {@link IsoAlpha3CountryCode}
+ * branded type as output.
+ *
+ * @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+ */
+export declare const countryCode: {
+    alpha3: () => z.core.$ZodBranded<z.ZodEnum<{
+        [x: string]: string;
+    }>, "IsoAlpha3CountryCode">;
+};
+export {};

package/lib/esm/iso/country-code.js

@@ -0,0 +1,20 @@
+import { iso31661 } from "iso-3166";
+import { z } from "zod";
+const ALPHA_3_CODES = iso31661.map((entry) => entry.alpha3);
+const alpha3CodeSchema = z.enum(ALPHA_3_CODES).brand("IsoAlpha3CountryCode");
+/**
+ * Returns a zod schema that validates that the input is a string that matches
+ * an ISO 3166 alpha 3 country code.
+ *
+ * The currency code is case-sensitive and all current currency codes are
+ * all uppercase.
+ *
+ * @returns A zod schema that validates ISO alpha 3 code strings and return the {@link IsoAlpha3CountryCode}
+ * branded type as output.
+ *
+ * @see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+ */
+export const countryCode = {
+    alpha3: () => alpha3CodeSchema,
+};
+//# sourceMappingURL=country-code.js.map

package/lib/esm/iso/country-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"country-code.js","sourceRoot":"","sources":["../../../src/iso/country-code.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAE5D,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAI7E;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB;CAC/B,CAAC"}

package/lib/esm/iso/index.d.ts

@@ -2,5 +2,10 @@ declare const module: {
     currencyCode: () => import("zod/v4/core").$ZodBranded<import("zod").ZodEnum<{
         [x: string]: string;
     }>, "IsoCurrencyCode">;
+    countryCode: {
+        alpha3: () => import("zod/v4/core").$ZodBranded<import("zod").ZodEnum<{
+            [x: string]: string;
+        }>, "IsoAlpha3CountryCode">;
+    };
 };
 export { module as iso };

package/lib/esm/iso/index.js

@@ -1,6 +1,8 @@
+import { countryCode } from "./country-code.js";
 import { currencyCode } from "./currency-code.js";
 const module = {
     currencyCode,
+    countryCode,
 };
 export { module as iso };
 //# sourceMappingURL=index.js.map

package/lib/esm/iso/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/iso/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,MAAM,GAAG;IACb,YAAY;CACb,CAAC;AAEF,OAAO,EAAE,MAAM,IAAI,GAAG,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/iso/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,MAAM,GAAG;IACb,YAAY;IACZ,WAAW;CACZ,CAAC;AAEF,OAAO,EAAE,MAAM,IAAI,GAAG,EAAE,CAAC"}

package/lib/esm/iso/types.d.ts

@@ -1 +1,2 @@
+export { IsoAlpha3CountryCode } from "./country-code.js";
 export { IsoCurrencyCode } from "./currency-code.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/zod-utils",
-  "version": "0.11.1-alpha.0",
+  "version": "0.12.0-alpha.0",
   "description": "Extensions to the zod package.",
   "keywords": [
     "zod",
@@ -63,6 +63,7 @@
   "dependencies": {
     "@infra-blocks/types": "^0.24.0",
     "currency-codes": "^2.2.0",
+    "iso-3166": "^4.4.0",
     "zod": "^4.2.1"
   },
   "devDependencies": {