@infra-blocks/zod-utils 0.25.0 → 0.26.0-alpha.0

package/README.md

@@ -92,6 +92,25 @@ The `zu.codec.stringSplit(separator)` utility is a factory returning a codec whe
 `z.string()`, the second schema is `z.array(z.string())`, and the transformations back and forth
 are accomplished using `String.split` and `Array.join` respectively, using the provided separator.
 
+#### stringToBuffer
+
+The `zu.codec.stringToBuffer(encoding)` utility is a factory returning a codec where the first
+schema is `z.string()`, the secon schema is `z.instanceof(Buffer)`, and the transformations
+back and forth are accomplished using `Buffer.from` and `buffer.toString` with the provided
+encoding.
+
+```typescript
+import { zu } from "@infra-blocks/zod-utils";
+
+// Defaults to utf-8, because Buffer functions default to utf-8.
+const utf8Codec = zu.codec.stringToBuffer();
+// A specific encoding can be provided.
+const base64Codec = zu.codec.stringToBuffer("base64");
+
+utf8Codec.parse("1234"); // Returns Buffer.from("1234");
+base64codec.parse("1234"); // Returns Buffer.from("1234", "base64");
+```
+
 #### stringToInteger
 
 The `zu.codec.stringToInteger()` codec is taken almost verbatim

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

@@ -4,7 +4,8 @@ declare const codec: {
     ms: (options?: {
         long: boolean;
     }) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodNumber>;
-    stringtoInteger: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "IntegerString">, import("zod/v4/core").$ZodBranded<import("zod").ZodInt, "Integer">>;
+    stringToBuffer: (encoding?: BufferEncoding) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>;
+    stringToInteger: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "IntegerString">, import("zod/v4/core").$ZodBranded<import("zod").ZodInt, "Integer">>;
     stringToJson: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "JsonString">, import("zod").ZodType<import("../json/json.js").Json, unknown, import("zod/v4/core").$ZodTypeInternals<import("../json/json.js").Json, unknown>>>;
     stringToUrl: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodURL, "UrlString">, import("zod").ZodCustom<import("url").URL, import("url").URL>>;
 };

package/lib/cjs/codec/index.js

@@ -4,6 +4,7 @@ exports.codec = void 0;
 const csv_js_1 = require("./csv.js");
 const json_parse_js_1 = require("./json-parse.js");
 const ms_js_1 = require("./ms.js");
+const string_to_buffer_js_1 = require("./string-to-buffer.js");
 const string_to_integer_js_1 = require("./string-to-integer.js");
 const string_to_json_js_1 = require("./string-to-json.js");
 const string_to_url_js_1 = require("./string-to-url.js");
@@ -11,7 +12,8 @@ const codec = {
     csv: csv_js_1.csv,
     jsonParse: json_parse_js_1.jsonParse,
     ms: ms_js_1.ms,
-    stringtoInteger: string_to_integer_js_1.stringToInteger,
+    stringToBuffer: string_to_buffer_js_1.stringToBuffer,
+    stringToInteger: string_to_integer_js_1.stringToInteger,
     stringToJson: string_to_json_js_1.stringToJson,
     stringToUrl: string_to_url_js_1.stringToUrl,
 };

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,iEAAyD;AACzD,2DAAmD;AACnD,yDAAiD;AAEjD,MAAM,KAAK,GAAG;IACZ,GAAG,EAAH,YAAG;IACH,SAAS,EAAT,yBAAS;IACT,EAAE,EAAF,UAAE;IACF,eAAe,EAAE,sCAAe;IAChC,YAAY,EAAZ,gCAAY;IACZ,WAAW,EAAX,8BAAW;CACZ,CAAC;AAEO,sBAAK"}
+{"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,yDAAiD;AAEjD,MAAM,KAAK,GAAG;IACZ,GAAG,EAAH,YAAG;IACH,SAAS,EAAT,yBAAS;IACT,EAAE,EAAF,UAAE;IACF,cAAc,EAAd,oCAAc;IACd,eAAe,EAAf,sCAAe;IACf,YAAY,EAAZ,gCAAY;IACZ,WAAW,EAAX,8BAAW;CACZ,CAAC;AAEO,sBAAK"}

package/lib/cjs/codec/string-to-buffer.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const stringToBuffer: (encoding?: BufferEncoding) => z.ZodCodec<z.ZodString, z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>;

package/lib/cjs/codec/string-to-buffer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToBuffer = void 0;
+const zod_1 = require("zod");
+const stringToBuffer = (encoding) => {
+    return zod_1.z.codec(zod_1.z.string(), zod_1.z.instanceof(Buffer), {
+        decode: (str) => Buffer.from(str, encoding),
+        encode: (buf) => buf.toString(encoding),
+    });
+};
+exports.stringToBuffer = stringToBuffer;
+//# sourceMappingURL=string-to-buffer.js.map

package/lib/cjs/codec/string-to-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-to-buffer.js","sourceRoot":"","sources":["../../../src/codec/string-to-buffer.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEjB,MAAM,cAAc,GAAG,CAAC,QAAyB,EAAE,EAAE;IAC1D,OAAO,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC/C,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC;QAC3C,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;KACxC,CAAC,CAAC;AACL,CAAC,CAAC;AALW,QAAA,cAAc,kBAKzB"}

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

@@ -4,7 +4,8 @@ declare const codec: {
     ms: (options?: {
         long: boolean;
     }) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodNumber>;
-    stringtoInteger: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "IntegerString">, import("zod/v4/core").$ZodBranded<import("zod").ZodInt, "Integer">>;
+    stringToBuffer: (encoding?: BufferEncoding) => import("zod").ZodCodec<import("zod").ZodString, import("zod").ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>;
+    stringToInteger: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "IntegerString">, import("zod/v4/core").$ZodBranded<import("zod").ZodInt, "Integer">>;
     stringToJson: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodString, "JsonString">, import("zod").ZodType<import("../json/json.js").Json, unknown, import("zod/v4/core").$ZodTypeInternals<import("../json/json.js").Json, unknown>>>;
     stringToUrl: () => import("zod").ZodCodec<import("zod/v4/core").$ZodBranded<import("zod").ZodURL, "UrlString">, import("zod").ZodCustom<import("url").URL, import("url").URL>>;
 };

package/lib/esm/codec/index.js

@@ -1,6 +1,7 @@
 import { csv } from "./csv.js";
 import { jsonParse } from "./json-parse.js";
 import { ms } from "./ms.js";
+import { stringToBuffer } from "./string-to-buffer.js";
 import { stringToInteger } from "./string-to-integer.js";
 import { stringToJson } from "./string-to-json.js";
 import { stringToUrl } from "./string-to-url.js";
@@ -8,7 +9,8 @@ const codec = {
     csv,
     jsonParse,
     ms,
-    stringtoInteger: stringToInteger,
+    stringToBuffer,
+    stringToInteger,
     stringToJson,
     stringToUrl,
 };

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,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,KAAK,GAAG;IACZ,GAAG;IACH,SAAS;IACT,EAAE;IACF,eAAe,EAAE,eAAe;IAChC,YAAY;IACZ,WAAW;CACZ,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"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,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,KAAK,GAAG;IACZ,GAAG;IACH,SAAS;IACT,EAAE;IACF,cAAc;IACd,eAAe;IACf,YAAY;IACZ,WAAW;CACZ,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/lib/esm/codec/string-to-buffer.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const stringToBuffer: (encoding?: BufferEncoding) => z.ZodCodec<z.ZodString, z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>;

package/lib/esm/codec/string-to-buffer.js

@@ -0,0 +1,8 @@
+import { z } from "zod";
+export const stringToBuffer = (encoding) => {
+    return z.codec(z.string(), z.instanceof(Buffer), {
+        decode: (str) => Buffer.from(str, encoding),
+        encode: (buf) => buf.toString(encoding),
+    });
+};
+//# sourceMappingURL=string-to-buffer.js.map

package/lib/esm/codec/string-to-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-to-buffer.js","sourceRoot":"","sources":["../../../src/codec/string-to-buffer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAyB,EAAE,EAAE;IAC1D,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC/C,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC;QAC3C,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;KACxC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/zod-utils",
-  "version": "0.25.0",
+  "version": "0.26.0-alpha.0",
   "description": "Extensions to the zod package.",
   "keywords": [
     "zod",