@infra-blocks/zod-utils 0.30.0 → 0.31.0-alpha.0

package/README.md

@@ -55,6 +55,20 @@ zu.aws.region().parse("us-east-1");
 
 The `zu.codec` module contains codecs.
 
+#### bytes
+
+The `zu.codec.bytes(options)` utility is a factory returning a codec where the schemas are
+`z.string()` and `z.number()`. The transformations in both directions are handled by the
+[bytes](https://www.npmjs.com/package/bytes) package. When encoding, the codec passes the options
+provided to `bytes.format(number, options)`.
+
+```typescript
+import { zu } from "@infra-blocks/zod-utils";
+
+const item: number = zu.codec.bytes().parse("1tb"); // item is 1099511627776.
+zu.codec.bytes({ unit: "mb" }).encode(item); // result is "1048576mb".
+```
+
 #### csv
 
 The `zu.codec.csv()` utility is a codec transforming a string into an array of string using the string `split` method

package/lib/cjs/codec/bytes.d.ts

@@ -0,0 +1,14 @@
+import { type BytesOptions } from "bytes";
+import { z } from "zod";
+/**
+ * A codec factory that returns a codec parsing strings formatted
+ * as expected by the [bytes](https://www.npmjs.com/package/bytes) and turning them
+ * into their equivalent number in bytes.
+ *
+ * @param options - Those options are passed to `ms` when turning the milliseconds
+ * number into a formatted string.
+ *
+ * @returns A codec where the schemas are {@link z.string} and {@link z.number},
+ * and where the transforms between each are handled by the `ms` package.
+ */
+export declare const bytes: (options?: BytesOptions) => z.ZodCodec<z.ZodString, z.ZodNumber>;

package/lib/cjs/codec/bytes.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bytes = void 0;
+const bytes_1 = __importDefault(require("bytes"));
+const zod_1 = require("zod");
+/**
+ * A codec factory that returns a codec parsing strings formatted
+ * as expected by the [bytes](https://www.npmjs.com/package/bytes) and turning them
+ * into their equivalent number in bytes.
+ *
+ * @param options - Those options are passed to `ms` when turning the milliseconds
+ * number into a formatted string.
+ *
+ * @returns A codec where the schemas are {@link z.string} and {@link z.number},
+ * and where the transforms between each are handled by the `ms` package.
+ */
+const bytes = (options) => zod_1.z.codec(zod_1.z.string(), zod_1.z.number(), {
+    decode: (str) => bytes_1.default.parse(str) ?? zod_1.z.NEVER,
+    encode: (bytes) => bytes_1.default.format(bytes, options) ?? zod_1.z.NEVER,
+});
+exports.bytes = bytes;
+//# sourceMappingURL=bytes.js.map

package/lib/cjs/codec/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../../src/codec/bytes.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAgD;AAChD,6BAAwB;AAExB;;;;;;;;;;GAUG;AACI,MAAM,KAAK,GAAG,CAAC,OAAsB,EAAE,EAAE,CAC9C,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE;IAC9B,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,eAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,OAAC,CAAC,KAAK;IAC3C,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,eAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,OAAC,CAAC,KAAK;CAC1D,CAAC,CAAC;AAJQ,QAAA,KAAK,SAIb"}

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

@@ -1,4 +1,5 @@
 export declare const codec: {
+    bytes: (options?: import("bytes").BytesOptions) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodNumber>;
     csv: () => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodArray<import("zod").ZodString>>;
     jsonParse: <S extends import("zod").ZodType>(schema: S) => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "JsonString">, S>;
     ms: (options?: {

package/lib/cjs/codec/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.codec = void 0;
+const bytes_js_1 = require("./bytes.js");
 const csv_js_1 = require("./csv.js");
 const json_parse_js_1 = require("./json-parse.js");
 const ms_js_1 = require("./ms.js");
@@ -10,6 +11,7 @@ const string_to_json_js_1 = require("./string-to-json.js");
 const string_to_positive_integer_js_1 = require("./string-to-positive-integer.js");
 const string_to_url_js_1 = require("./string-to-url.js");
 exports.codec = {
+    bytes: bytes_js_1.bytes,
     csv: csv_js_1.csv,
     jsonParse: json_parse_js_1.jsonParse,
     ms: ms_js_1.ms,

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/codec/index.ts"],"names":[],"mappings":";;;AAAA,qCAA+B;AAC/B,mDAA4C;AAC5C,mCAA6B;AAC7B,+DAAuD;AACvD,iEAAyD;AACzD,2DAAmD;AACnD,mFAA0E;AAC1E,yDAAiD;AAEpC,QAAA,KAAK,GAAG;IACnB,GAAG,EAAH,YAAG;IACH,SAAS,EAAT,yBAAS;IACT,EAAE,EAAF,UAAE;IACF,cAAc,EAAd,oCAAc;IACd,eAAe,EAAf,sCAAe;IACf,YAAY,EAAZ,gCAAY;IACZ,uBAAuB,EAAvB,uDAAuB;IACvB,WAAW,EAAX,8BAAW;CACZ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/codec/index.ts"],"names":[],"mappings":";;;AAAA,yCAAmC;AACnC,qCAA+B;AAC/B,mDAA4C;AAC5C,mCAA6B;AAC7B,+DAAuD;AACvD,iEAAyD;AACzD,2DAAmD;AACnD,mFAA0E;AAC1E,yDAAiD;AAEpC,QAAA,KAAK,GAAG;IACnB,KAAK,EAAL,gBAAK;IACL,GAAG,EAAH,YAAG;IACH,SAAS,EAAT,yBAAS;IACT,EAAE,EAAF,UAAE;IACF,cAAc,EAAd,oCAAc;IACd,eAAe,EAAf,sCAAe;IACf,YAAY,EAAZ,gCAAY;IACZ,uBAAuB,EAAvB,uDAAuB;IACvB,WAAW,EAAX,8BAAW;CACZ,CAAC"}

package/lib/esm/codec/bytes.d.ts

@@ -0,0 +1,14 @@
+import { type BytesOptions } from "bytes";
+import { z } from "zod";
+/**
+ * A codec factory that returns a codec parsing strings formatted
+ * as expected by the [bytes](https://www.npmjs.com/package/bytes) and turning them
+ * into their equivalent number in bytes.
+ *
+ * @param options - Those options are passed to `ms` when turning the milliseconds
+ * number into a formatted string.
+ *
+ * @returns A codec where the schemas are {@link z.string} and {@link z.number},
+ * and where the transforms between each are handled by the `ms` package.
+ */
+export declare const bytes: (options?: BytesOptions) => z.ZodCodec<z.ZodString, z.ZodNumber>;

package/lib/esm/codec/bytes.js

@@ -0,0 +1,18 @@
+import impl from "bytes";
+import { z } from "zod";
+/**
+ * A codec factory that returns a codec parsing strings formatted
+ * as expected by the [bytes](https://www.npmjs.com/package/bytes) and turning them
+ * into their equivalent number in bytes.
+ *
+ * @param options - Those options are passed to `ms` when turning the milliseconds
+ * number into a formatted string.
+ *
+ * @returns A codec where the schemas are {@link z.string} and {@link z.number},
+ * and where the transforms between each are handled by the `ms` package.
+ */
+export const bytes = (options) => z.codec(z.string(), z.number(), {
+    decode: (str) => impl.parse(str) ?? z.NEVER,
+    encode: (bytes) => impl.format(bytes, options) ?? z.NEVER,
+});
+//# sourceMappingURL=bytes.js.map

package/lib/esm/codec/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../../src/codec/bytes.ts"],"names":[],"mappings":"AAAA,OAAO,IAA2B,MAAM,OAAO,CAAC;AAChD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,OAAsB,EAAE,EAAE,CAC9C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE;IAC9B,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK;IAC3C,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK;CAC1D,CAAC,CAAC"}

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

@@ -1,4 +1,5 @@
 export declare const codec: {
+    bytes: (options?: import("bytes").BytesOptions) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodNumber>;
     csv: () => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodArray<import("zod").ZodString>>;
     jsonParse: <S extends import("zod").ZodType>(schema: S) => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "JsonString">, S>;
     ms: (options?: {

package/lib/esm/codec/index.js

@@ -1,3 +1,4 @@
+import { bytes } from "./bytes.js";
 import { csv } from "./csv.js";
 import { jsonParse } from "./json-parse.js";
 import { ms } from "./ms.js";
@@ -7,6 +8,7 @@ import { stringToJson } from "./string-to-json.js";
 import { stringToPositiveInteger } from "./string-to-positive-integer.js";
 import { stringToUrl } from "./string-to-url.js";
 export const codec = {
+    bytes,
     csv,
     jsonParse,
     ms,

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/codec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,GAAG;IACH,SAAS;IACT,EAAE;IACF,cAAc;IACd,eAAe;IACf,YAAY;IACZ,uBAAuB;IACvB,WAAW;CACZ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/codec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK;IACL,GAAG;IACH,SAAS;IACT,EAAE;IACF,cAAc;IACd,eAAe;IACf,YAAY;IACZ,uBAAuB;IACvB,WAAW;CACZ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/zod-utils",
-  "version": "0.30.0",
+  "version": "0.31.0-alpha.0",
   "description": "Extensions to the zod package.",
   "keywords": [
     "zod",
@@ -37,11 +37,11 @@
     "test": "npm run test:unit",
     "test:coverage": "c8 npm run test",
     "test:coverage:lcov": "c8 --reporter=lcov npm run test",
-    "test:integration": "mocha --config test/integration/.mocharc.js 'test/integration/**/*.spec.ts'",
-    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
+    "test:unit": "node --import tsx --test 'test/unit/**/*.spec.ts'"
   },
   "dependencies": {
     "@infra-blocks/types": "^0.26.0",
+    "bytes": "^3.1.2",
     "currency-codes": "^2.2.0",
     "iso-3166": "^4.4.0",
     "ms": "^2.1.3",
@@ -50,12 +50,11 @@
   "devDependencies": {
     "@biomejs/biome": "^2.3.10",
     "@infra-blocks/test": "^0.6.0",
-    "@types/mocha": "^10.0.1",
+    "@types/bytes": "^3.1.5",
     "@types/ms": "^2.1.0",
     "@types/node": "^24.10.4",
     "c8": "^8.0.0",
     "lefthook": "^2.0.13",
-    "mocha": "^10.2.0",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   },