@infra-blocks/zod-utils 0.5.0-alpha.3 → 0.6.0-alpha.0

package/README.md

@@ -10,6 +10,9 @@ This package exposes various utilities extending the [zod](https://www.npmjs.com
 
 - [geojson](#geojson)
 - [json](#json)
+- [csv](#csv)
+- [typeGuard](#type-guard)
+- [validate](#validate)
 
 ### GeoJson
 
@@ -220,3 +223,51 @@ const jsonObject: JsonObject = zu.json.object().parse({ hello: "world" });
 zu.json.object().parse(5); // Boom.
 zu.json.object().parse([]); // Boom.
 ```
+
+### CSV
+
+The `csv` utility is nothing but a shorthand for `z.string().transform(s => s.split(","))`, which
+is commonly written, in my experience. One can stop retyping all those letters and replace them
+with a simple `zu.csv()` call.
+
+```typescript
+import { zu } from "@infra-blocks/zod-utils";
+
+const items = zu.csv().parse("one,two,three"); // items is ["one", "two", "three"]
+```
+
+### Type Guard
+
+The `typeGuard` utility allows to obtain a function that will act as a type guard for the type
+that the wrapped schema outputs. It is most useful with branded types, where the information
+about the rules of the type is contained within it. Example:
+
+```typescript
+import { z } from "zod";
+import { zu } from "@infra-blocks/zod-utils";
+import { expectTypeOf } from "expect-type"
+
+export type Min5String = z.infer<typeof schema>;
+
+const schema = z.string().min(5).brand("Min5String");
+const isMin5String = zu.typeGuard(schema);
+const myString = "toto-stfu";
+if (isMin5String(myString)) {
+  // Here, the type of myString extends Min5String (it's actually `"toto-stfu" & z.$brand<"Min5String">`
+  // instead of `string & z.$brand<"Min5String">`)
+  expectTypeOf(myString).toExtend<Min5String>();
+} else {
+  expectTypeOf(myString).toEqual<"toto-stfu">();
+}
+```
+
+It can still be used with vanilla types, but then the guarantees returned by a type guard are
+not as strong. In our specific case, the type guard would assert that `myString` is a `string`,
+despite the fact that it also checked that its length has to be greater than 5. That information
+has been lost.
+
+### Validate
+
+The validate API is very similar to the [type guard](#type-guard) one, except it doesn't bind
+to a schema. The schema is passed as argument. Where you would write `zu.typeGuard(schema)(value)`,
+you instead write `zu.validate(schema, value)`. Both behave the same.

package/lib/cjs/geojson/bounding-box.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.boundingBox = void 0;
+exports.boundingBox = boundingBox;
 const zod_1 = require("zod");
 const twoDimensionalBoundingBox = zod_1.z.tuple([
     zod_1.z.number(),
@@ -23,5 +23,4 @@ const boundingBoxSchema = zod_1.z.union([
 function boundingBox() {
     return boundingBoxSchema;
 }
-exports.boundingBox = boundingBox;
 //# sourceMappingURL=bounding-box.js.map

package/lib/cjs/geojson/bounding-box.js.map

@@ -1 +1 @@
-{"version":3,"file":"bounding-box.js","sourceRoot":"","sources":["../../../src/geojson/bounding-box.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,MAAM,yBAAyB,GAAG,OAAC,CAAC,KAAK,CAAC;IACxC,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,OAAC,CAAC,KAAK,CAAC;IAC1C,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,OAAC,CAAC,KAAK,CAAC;IAChC,yBAAyB;IACzB,2BAA2B;CAC5B,CAAC,CAAC;AAIH,SAAgB,WAAW;IACzB,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAFD,kCAEC"}
+{"version":3,"file":"bounding-box.js","sourceRoot":"","sources":["../../../src/geojson/bounding-box.ts"],"names":[],"mappings":";;AAyBA,kCAEC;AA3BD,6BAAwB;AAExB,MAAM,yBAAyB,GAAG,OAAC,CAAC,KAAK,CAAC;IACxC,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,OAAC,CAAC,KAAK,CAAC;IAC1C,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,OAAC,CAAC,KAAK,CAAC;IAChC,yBAAyB;IACzB,2BAA2B;CAC5B,CAAC,CAAC;AAIH,SAAgB,WAAW;IACzB,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}

package/lib/cjs/geojson/coordinate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.coordinate = void 0;
+exports.coordinate = coordinate;
 const zod_1 = require("zod");
 const twoDimensionalCoordinate = zod_1.z.tuple([zod_1.z.number(), zod_1.z.number()]);
 const threeDimensionalCoordinate = zod_1.z.tuple([
@@ -12,5 +12,4 @@ const schema = zod_1.z.union([twoDimensionalCoordinate, threeDimensionalCoordina
 function coordinate() {
     return schema;
 }
-exports.coordinate = coordinate;
 //# sourceMappingURL=coordinate.js.map

package/lib/cjs/geojson/coordinate.js.map

@@ -1 +1 @@
-{"version":3,"file":"coordinate.js","sourceRoot":"","sources":["../../../src/geojson/coordinate.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,MAAM,wBAAwB,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACnE,MAAM,0BAA0B,GAAG,OAAC,CAAC,KAAK,CAAC;IACzC,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,wBAAwB,EAAE,0BAA0B,CAAC,CAAC,CAAC;AAI/E,SAAgB,UAAU;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"coordinate.js","sourceRoot":"","sources":["../../../src/geojson/coordinate.ts"],"names":[],"mappings":";;AAaA,gCAEC;AAfD,6BAAwB;AAExB,MAAM,wBAAwB,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACnE,MAAM,0BAA0B,GAAG,OAAC,CAAC,KAAK,CAAC;IACzC,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,wBAAwB,EAAE,0BAA0B,CAAC,CAAC,CAAC;AAI/E,SAAgB,UAAU;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/cjs/geojson/feature-collection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.featureCollection = void 0;
+exports.featureCollection = featureCollection;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const feature_js_1 = require("./feature.js");
@@ -11,5 +11,4 @@ const featureCollectionSchema = base_js_1.schemaWithBoundingBox.extend({
 function featureCollection() {
     return featureCollectionSchema;
 }
-exports.featureCollection = featureCollection;
 //# sourceMappingURL=feature-collection.js.map

package/lib/cjs/geojson/feature-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature-collection.js","sourceRoot":"","sources":["../../../src/geojson/feature-collection.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,6CAAuC;AAEvC,MAAM,uBAAuB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;IACpC,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,oBAAO,GAAE,CAAC;CAC7B,CAAC,CAAC;AAIH,SAAgB,iBAAiB;IAC/B,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"feature-collection.js","sourceRoot":"","sources":["../../../src/geojson/feature-collection.ts"],"names":[],"mappings":";;AAWA,8CAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,6CAAuC;AAEvC,MAAM,uBAAuB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;IACpC,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,oBAAO,GAAE,CAAC;CAC7B,CAAC,CAAC;AAIH,SAAgB,iBAAiB;IAC/B,OAAO,uBAAuB,CAAC;AACjC,CAAC"}

package/lib/cjs/geojson/feature.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.feature = void 0;
+exports.feature = feature;
 const zod_1 = require("zod");
 const index_js_1 = require("../json/index.js");
 const base_js_1 = require("./base.js");
@@ -14,5 +14,4 @@ const featureSchema = base_js_1.schemaWithBoundingBox.extend({
 function feature() {
     return featureSchema;
 }
-exports.feature = feature;
 //# sourceMappingURL=feature.js.map

package/lib/cjs/geojson/feature.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../src/geojson/feature.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,+CAAwC;AACxC,uCAAkD;AAClD,+CAAyC;AAEzC,MAAM,aAAa,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,QAAQ,EAAE,IAAA,sBAAQ,GAAE,CAAC,QAAQ,EAAE;IAC/B,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAChD,UAAU,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,IAAA,eAAI,GAAE,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAIH,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC;AAFD,0BAEC"}
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../src/geojson/feature.ts"],"names":[],"mappings":";;AAcA,0BAEC;AAhBD,6BAAwB;AACxB,+CAAwC;AACxC,uCAAkD;AAClD,+CAAyC;AAEzC,MAAM,aAAa,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,QAAQ,EAAE,IAAA,sBAAQ,GAAE,CAAC,QAAQ,EAAE;IAC/B,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAChD,UAAU,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,IAAA,eAAI,GAAE,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAIH,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/lib/cjs/geojson/geojson.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.geojson = void 0;
+exports.geojson = geojson;
 const zod_1 = require("zod");
 const feature_collection_js_1 = require("./feature-collection.js");
 const feature_js_1 = require("./feature.js");
@@ -9,5 +9,4 @@ const geojsonSchema = zod_1.z.union([(0, geometry_js_1.geometry)(), (0, feature_
 function geojson() {
     return geojsonSchema;
 }
-exports.geojson = geojson;
 //# sourceMappingURL=geojson.js.map

package/lib/cjs/geojson/geojson.js.map

@@ -1 +1 @@
-{"version":3,"file":"geojson.js","sourceRoot":"","sources":["../../../src/geojson/geojson.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,mEAA4D;AAC5D,6CAAuC;AACvC,+CAAyC;AAEzC,MAAM,aAAa,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,IAAA,sBAAQ,GAAE,EAAE,IAAA,oBAAO,GAAE,EAAE,IAAA,yCAAiB,GAAE,CAAC,CAAC,CAAC;AAI5E,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC;AAFD,0BAEC"}
+{"version":3,"file":"geojson.js","sourceRoot":"","sources":["../../../src/geojson/geojson.ts"],"names":[],"mappings":";;AASA,0BAEC;AAXD,6BAAwB;AACxB,mEAA4D;AAC5D,6CAAuC;AACvC,+CAAyC;AAEzC,MAAM,aAAa,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,IAAA,sBAAQ,GAAE,EAAE,IAAA,oBAAO,GAAE,EAAE,IAAA,yCAAiB,GAAE,CAAC,CAAC,CAAC;AAI5E,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/lib/cjs/geojson/geometry.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.geometry = exports.geometryCollection = void 0;
+exports.geometryCollection = geometryCollection;
+exports.geometry = geometry;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const line_string_js_1 = require("./line-string.js");
@@ -16,7 +17,6 @@ const geometryCollectionSchema = base_js_1.schemaWithBoundingBox.extend({
 function geometryCollection() {
     return geometryCollectionSchema;
 }
-exports.geometryCollection = geometryCollection;
 const geometrySchema = zod_1.z.union([
     (0, line_string_js_1.lineString)(),
     (0, multi_line_string_js_1.multiLineString)(),
@@ -29,5 +29,4 @@ const geometrySchema = zod_1.z.union([
 function geometry() {
     return geometrySchema;
 }
-exports.geometry = geometry;
 //# sourceMappingURL=geometry.js.map

package/lib/cjs/geojson/geometry.js.map

@@ -1 +1 @@
-{"version":3,"file":"geometry.js","sourceRoot":"","sources":["../../../src/geojson/geometry.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,qDAA8C;AAC9C,iEAAyD;AACzD,qDAA8C;AAC9C,yDAAkD;AAClD,yCAAmC;AACnC,6CAAuC;AAEvC,MAAM,wBAAwB,GAC5B,+BAAqB,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;IACrC,UAAU,EAAE,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;CAC9C,CAAC,CAAC;AAcL,SAAgB,kBAAkB;IAChC,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAFD,gDAEC;AAED,MAAM,cAAc,GAAG,OAAC,CAAC,KAAK,CAAC;IAC7B,IAAA,2BAAU,GAAE;IACZ,IAAA,sCAAe,GAAE;IACjB,IAAA,2BAAU,GAAE;IACZ,IAAA,+BAAY,GAAE;IACd,IAAA,gBAAK,GAAE;IACP,IAAA,oBAAO,GAAE;IACT,kBAAkB,EAAE;CACrB,CAAC,CAAC;AAIH,SAAgB,QAAQ;IACtB,OAAO,cAAc,CAAC;AACxB,CAAC;AAFD,4BAEC"}
+{"version":3,"file":"geometry.js","sourceRoot":"","sources":["../../../src/geojson/geometry.ts"],"names":[],"mappings":";;AA2BA,gDAEC;AAcD,4BAEC;AA7CD,6BAAwB;AACxB,uCAAkD;AAClD,qDAA8C;AAC9C,iEAAyD;AACzD,qDAA8C;AAC9C,yDAAkD;AAClD,yCAAmC;AACnC,6CAAuC;AAEvC,MAAM,wBAAwB,GAC5B,+BAAqB,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;IACrC,UAAU,EAAE,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;CAC9C,CAAC,CAAC;AAcL,SAAgB,kBAAkB;IAChC,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAED,MAAM,cAAc,GAAG,OAAC,CAAC,KAAK,CAAC;IAC7B,IAAA,2BAAU,GAAE;IACZ,IAAA,sCAAe,GAAE;IACjB,IAAA,2BAAU,GAAE;IACZ,IAAA,+BAAY,GAAE;IACd,IAAA,gBAAK,GAAE;IACP,IAAA,oBAAO,GAAE;IACT,kBAAkB,EAAE;CACrB,CAAC,CAAC;AAIH,SAAgB,QAAQ;IACtB,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/lib/cjs/geojson/line-string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lineString = void 0;
+exports.lineString = lineString;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const coordinate_js_1 = require("./coordinate.js");
@@ -11,5 +11,4 @@ const lineStringSchema = base_js_1.schemaWithBoundingBox.extend({
 function lineString() {
     return lineStringSchema;
 }
-exports.lineString = lineString;
 //# sourceMappingURL=line-string.js.map

package/lib/cjs/geojson/line-string.js.map

@@ -1 +1 @@
-{"version":3,"file":"line-string.js","sourceRoot":"","sources":["../../../src/geojson/line-string.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,gBAAgB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACpD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAC7B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,0BAAU,GAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CAC1C,CAAC,CAAC;AAIH,SAAgB,UAAU;IACxB,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"line-string.js","sourceRoot":"","sources":["../../../src/geojson/line-string.ts"],"names":[],"mappings":";;AAWA,gCAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,gBAAgB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACpD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAC7B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,0BAAU,GAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CAC1C,CAAC,CAAC;AAIH,SAAgB,UAAU;IACxB,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/lib/cjs/geojson/multi-line-string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.multiLineString = void 0;
+exports.multiLineString = multiLineString;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const line_string_js_1 = require("./line-string.js");
@@ -11,5 +11,4 @@ const multiLineStringSchema = base_js_1.schemaWithBoundingBox.extend({
 function multiLineString() {
     return multiLineStringSchema;
 }
-exports.multiLineString = multiLineString;
 //# sourceMappingURL=multi-line-string.js.map

package/lib/cjs/geojson/multi-line-string.js.map

@@ -1 +1 @@
-{"version":3,"file":"multi-line-string.js","sourceRoot":"","sources":["../../../src/geojson/multi-line-string.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,qDAA8C;AAE9C,MAAM,qBAAqB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACzD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAClC,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,2BAAU,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CACrD,CAAC,CAAC;AAIH,SAAgB,eAAe;IAC7B,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAFD,0CAEC"}
+{"version":3,"file":"multi-line-string.js","sourceRoot":"","sources":["../../../src/geojson/multi-line-string.ts"],"names":[],"mappings":";;AAWA,0CAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,qDAA8C;AAE9C,MAAM,qBAAqB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACzD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAClC,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,2BAAU,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CACrD,CAAC,CAAC;AAIH,SAAgB,eAAe;IAC7B,OAAO,qBAAqB,CAAC;AAC/B,CAAC"}

package/lib/cjs/geojson/multi-point.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.multiPoint = void 0;
+exports.multiPoint = multiPoint;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const point_js_1 = require("./point.js");
@@ -11,5 +11,4 @@ const multiPointSchema = base_js_1.schemaWithBoundingBox.extend({
 function multiPoint() {
     return multiPointSchema;
 }
-exports.multiPoint = multiPoint;
 //# sourceMappingURL=multi-point.js.map

package/lib/cjs/geojson/multi-point.js.map

@@ -1 +1 @@
-{"version":3,"file":"multi-point.js","sourceRoot":"","sources":["../../../src/geojson/multi-point.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,yCAAmC;AAEnC,MAAM,gBAAgB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACpD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAC7B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,gBAAK,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CAChD,CAAC,CAAC;AAIH,SAAgB,UAAU;IACxB,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"multi-point.js","sourceRoot":"","sources":["../../../src/geojson/multi-point.ts"],"names":[],"mappings":";;AAWA,gCAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,yCAAmC;AAEnC,MAAM,gBAAgB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACpD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAC7B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,gBAAK,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CAChD,CAAC,CAAC;AAIH,SAAgB,UAAU;IACxB,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/lib/cjs/geojson/multi-polygon.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.multiPolygon = void 0;
+exports.multiPolygon = multiPolygon;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const polygon_js_1 = require("./polygon.js");
@@ -11,5 +11,4 @@ const multiPolygonSchema = base_js_1.schemaWithBoundingBox.extend({
 function multiPolygon() {
     return multiPolygonSchema;
 }
-exports.multiPolygon = multiPolygon;
 //# sourceMappingURL=multi-polygon.js.map

package/lib/cjs/geojson/multi-polygon.js.map

@@ -1 +1 @@
-{"version":3,"file":"multi-polygon.js","sourceRoot":"","sources":["../../../src/geojson/multi-polygon.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,6CAAuC;AAEvC,MAAM,kBAAkB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACtD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,cAAc,CAAC;IAC/B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,oBAAO,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CAClD,CAAC,CAAC;AAIH,SAAgB,YAAY;IAC1B,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"multi-polygon.js","sourceRoot":"","sources":["../../../src/geojson/multi-polygon.ts"],"names":[],"mappings":";;AAWA,oCAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,6CAAuC;AAEvC,MAAM,kBAAkB,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACtD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,cAAc,CAAC;IAC/B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,IAAA,oBAAO,GAAE,CAAC,KAAK,CAAC,WAAW,CAAC;CAClD,CAAC,CAAC;AAIH,SAAgB,YAAY;IAC1B,OAAO,kBAAkB,CAAC;AAC5B,CAAC"}

package/lib/cjs/geojson/point.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.point = void 0;
+exports.point = point;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const coordinate_js_1 = require("./coordinate.js");
@@ -11,5 +11,4 @@ const pointSchema = base_js_1.schemaWithBoundingBox.extend({
 function point() {
     return pointSchema;
 }
-exports.point = point;
 //# sourceMappingURL=point.js.map

package/lib/cjs/geojson/point.js.map

@@ -1 +1 @@
-{"version":3,"file":"point.js","sourceRoot":"","sources":["../../../src/geojson/point.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,WAAW,GAAG,+BAAqB,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,WAAW,EAAE,IAAA,0BAAU,GAAE;CAC1B,CAAC,CAAC;AAIH,SAAgB,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC;AAFD,sBAEC"}
+{"version":3,"file":"point.js","sourceRoot":"","sources":["../../../src/geojson/point.ts"],"names":[],"mappings":";;AAWA,sBAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,WAAW,GAAG,+BAAqB,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,WAAW,EAAE,IAAA,0BAAU,GAAE;CAC1B,CAAC,CAAC;AAIH,SAAgB,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/lib/cjs/geojson/polygon.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.polygon = void 0;
+exports.polygon = polygon;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.js");
 const coordinate_js_1 = require("./coordinate.js");
@@ -11,5 +11,4 @@ const polygonSchema = base_js_1.schemaWithBoundingBox.extend({
 function polygon() {
     return polygonSchema;
 }
-exports.polygon = polygon;
 //# sourceMappingURL=polygon.js.map

package/lib/cjs/geojson/polygon.js.map

@@ -1 +1 @@
-{"version":3,"file":"polygon.js","sourceRoot":"","sources":["../../../src/geojson/polygon.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,aAAa,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,IAAA,0BAAU,GAAE,CAAC,CAAC;CAC5C,CAAC,CAAC;AAIH,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC;AAFD,0BAEC"}
+{"version":3,"file":"polygon.js","sourceRoot":"","sources":["../../../src/geojson/polygon.ts"],"names":[],"mappings":";;AAWA,0BAEC;AAbD,6BAAwB;AACxB,uCAAkD;AAClD,mDAA6C;AAE7C,MAAM,aAAa,GAAG,+BAAqB,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,IAAA,0BAAU,GAAE,CAAC,CAAC;CAC5C,CAAC,CAAC;AAIH,SAAgB,OAAO;IACrB,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/lib/cjs/index.d.ts

@@ -1,5 +1,40 @@
 import { z } from "zod";
+import { TypeGuard } from "@infra-blocks/types";
+/**
+ * Returns a string schema that transforms its input using a string split on commas.
+ *
+ * @returns A CSV schema.
+ */
 declare function csv(): z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>;
+/**
+ * Returns a type guard function using the provided schema as the source of truth.
+ *
+ * It uses the `validate` function internally.
+ *
+ * @param schema - The schema used to verify the inputs will be of the correct type.
+ *
+ * @returns A type guard function that uses the provided schema to asserts whether the
+ * input is of the proper type or not.
+ *
+ * @note Type guards work best with branded types. Given two schemas, z.string().min(5),
+ * and z.string().min(5).brand("Min5String"), the former type guard would only assert
+ * that the input is string (even if the length check is also done), whereas in the
+ * former case, that information is also carried with the type.
+ */
+declare function typeGuard<S extends z.ZodType>(schema: S): TypeGuard<z.infer<S>>;
+/**
+ * Validates that the value satisfies the provided schema.
+ *
+ * Upon success, the value's type is narrowed to the schema's output type.
+ *
+ * It uses `safeParse` internally.
+ *
+ * @param schema - The schema to validate against.
+ * @param value - The value to validate.
+ *
+ * @returns Whether the value satisfies the schema.
+ */
+declare function validate<S extends z.ZodType>(schema: S, value: unknown): value is z.infer<S>;
 declare const zu: {
     geojson: {
         (): z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
@@ -111,5 +146,7 @@ declare const zu: {
         stringified: typeof import("./json/json.js").stringifiedJson;
     };
     csv: typeof csv;
+    typeGuard: typeof typeGuard;
+    validate: typeof validate;
 };
 export { zu };

package/lib/cjs/index.js

@@ -5,13 +5,56 @@ const zod_1 = require("zod");
 const index_js_1 = require("./json/index.js");
 const index_js_2 = require("./geojson/index.js");
 const csvSchema = zod_1.z.string().transform((str) => str.split(","));
+csvSchema.brand("Toto");
+/**
+ * Returns a string schema that transforms its input using a string split on commas.
+ *
+ * @returns A CSV schema.
+ */
 function csv() {
     return csvSchema;
 }
+/**
+ * Returns a type guard function using the provided schema as the source of truth.
+ *
+ * It uses the `validate` function internally.
+ *
+ * @param schema - The schema used to verify the inputs will be of the correct type.
+ *
+ * @returns A type guard function that uses the provided schema to asserts whether the
+ * input is of the proper type or not.
+ *
+ * @note Type guards work best with branded types. Given two schemas, z.string().min(5),
+ * and z.string().min(5).brand("Min5String"), the former type guard would only assert
+ * that the input is string (even if the length check is also done), whereas in the
+ * former case, that information is also carried with the type.
+ */
+function typeGuard(schema) {
+    return (value) => {
+        return validate(schema, value);
+    };
+}
+/**
+ * Validates that the value satisfies the provided schema.
+ *
+ * Upon success, the value's type is narrowed to the schema's output type.
+ *
+ * It uses `safeParse` internally.
+ *
+ * @param schema - The schema to validate against.
+ * @param value - The value to validate.
+ *
+ * @returns Whether the value satisfies the schema.
+ */
+function validate(schema, value) {
+    return schema.safeParse(value).success;
+}
 const zu = {
     geojson: index_js_2.geojson,
     json: index_js_1.json,
     csv,
+    typeGuard,
+    validate,
 };
 exports.zu = zu;
 //# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,8CAAuC;AACvC,iDAA6C;AAE7C,MAAM,SAAS,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAEhE,SAAS,GAAG;IACV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,EAAE,GAAG;IACT,OAAO,EAAP,kBAAO;IACP,IAAI,EAAJ,eAAI;IACJ,GAAG;CACJ,CAAC;AAEO,gBAAE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,8CAAuC;AACvC,iDAA6C;AAG7C,MAAM,SAAS,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAEhE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAExB;;;;GAIG;AACH,SAAS,GAAG;IACV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,SAAS,CAAsB,MAAS;IAC/C,OAAO,CAAC,KAAc,EAAuB,EAAE;QAC7C,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,QAAQ,CACf,MAAS,EACT,KAAc;IAEd,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;AACzC,CAAC;AAED,MAAM,EAAE,GAAG;IACT,OAAO,EAAP,kBAAO;IACP,IAAI,EAAJ,eAAI;IACJ,GAAG;IACH,SAAS;IACT,QAAQ;CACT,CAAC;AAEO,gBAAE"}

package/lib/cjs/json/json.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringifiedJson = exports.stringifiedJsonSchema = exports.array = exports.object = exports.json = exports.primitive = void 0;
+exports.stringifiedJsonSchema = void 0;
+exports.primitive = primitive;
+exports.json = json;
+exports.object = object;
+exports.array = array;
+exports.stringifiedJson = stringifiedJson;
 const zod_1 = require("zod");
 const primitiveSchema = zod_1.z.union([
     zod_1.z.string(),
@@ -11,22 +16,18 @@ const primitiveSchema = zod_1.z.union([
 function primitive() {
     return primitiveSchema;
 }
-exports.primitive = primitive;
 const jsonSchema = zod_1.z.lazy(() => zod_1.z.union([primitive(), zod_1.z.array(jsonSchema), zod_1.z.record(zod_1.z.string(), jsonSchema)]));
 function json() {
     return jsonSchema;
 }
-exports.json = json;
 const objectSchema = zod_1.z.record(zod_1.z.string(), jsonSchema);
 function object() {
     return objectSchema;
 }
-exports.object = object;
 const arraySchema = zod_1.z.array(jsonSchema);
 function array() {
     return arraySchema;
 }
-exports.array = array;
 exports.stringifiedJsonSchema = zod_1.z
     .string()
     .transform((str, ctx) => {
@@ -41,5 +42,4 @@ exports.stringifiedJsonSchema = zod_1.z
 function stringifiedJson() {
     return exports.stringifiedJsonSchema;
 }
-exports.stringifiedJson = stringifiedJson;
 //# sourceMappingURL=json.js.map

package/lib/cjs/json/json.js.map

@@ -1 +1 @@
-{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/json/json.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,MAAM,eAAe,GAAG,OAAC,CAAC,KAAK,CAAC;IAC9B,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,OAAO,EAAE;IACX,OAAC,CAAC,IAAI,EAAE;CACT,CAAC,CAAC;AAEH,SAAgB,SAAS;IACvB,OAAO,eAAe,CAAC;AACzB,CAAC;AAFD,8BAEC;AAMD,MAAM,UAAU,GAAoB,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC9C,OAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAC9E,CAAC;AACF,SAAgB,IAAI;IAClB,OAAO,UAAU,CAAC;AACpB,CAAC;AAFD,oBAEC;AAED,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;AACtD,SAAgB,MAAM;IACpB,OAAO,YAAY,CAAC;AACtB,CAAC;AAFD,wBAEC;AAED,MAAM,WAAW,GAAG,OAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AACxC,SAAgB,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC;AAFD,sBAEC;AAEY,QAAA,qBAAqB,GAA4B,OAAC;KAC5D,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC;KAChC;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1D,OAAO,OAAC,CAAC,KAAK,CAAC;KAChB;AACH,CAAC,CAAC,CAAC;AAEL,SAAgB,eAAe;IAC7B,OAAO,6BAAqB,CAAC;AAC/B,CAAC;AAFD,0CAEC"}
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/json/json.ts"],"names":[],"mappings":";;;AASA,8BAEC;AASD,oBAEC;AAGD,wBAEC;AAGD,sBAEC;AAaD,0CAEC;AA/CD,6BAAwB;AAExB,MAAM,eAAe,GAAG,OAAC,CAAC,KAAK,CAAC;IAC9B,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,OAAO,EAAE;IACX,OAAC,CAAC,IAAI,EAAE;CACT,CAAC,CAAC;AAEH,SAAgB,SAAS;IACvB,OAAO,eAAe,CAAC;AACzB,CAAC;AAMD,MAAM,UAAU,GAAoB,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC9C,OAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAC9E,CAAC;AACF,SAAgB,IAAI;IAClB,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;AACtD,SAAgB,MAAM;IACpB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,WAAW,GAAG,OAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AACxC,SAAgB,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC;AAEY,QAAA,qBAAqB,GAA4B,OAAC;KAC5D,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1D,OAAO,OAAC,CAAC,KAAK,CAAC;IACjB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,SAAgB,eAAe;IAC7B,OAAO,6BAAqB,CAAC;AAC/B,CAAC"}

package/lib/esm/index.d.ts

@@ -1,5 +1,40 @@
 import { z } from "zod";
+import { TypeGuard } from "@infra-blocks/types";
+/**
+ * Returns a string schema that transforms its input using a string split on commas.
+ *
+ * @returns A CSV schema.
+ */
 declare function csv(): z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>;
+/**
+ * Returns a type guard function using the provided schema as the source of truth.
+ *
+ * It uses the `validate` function internally.
+ *
+ * @param schema - The schema used to verify the inputs will be of the correct type.
+ *
+ * @returns A type guard function that uses the provided schema to asserts whether the
+ * input is of the proper type or not.
+ *
+ * @note Type guards work best with branded types. Given two schemas, z.string().min(5),
+ * and z.string().min(5).brand("Min5String"), the former type guard would only assert
+ * that the input is string (even if the length check is also done), whereas in the
+ * former case, that information is also carried with the type.
+ */
+declare function typeGuard<S extends z.ZodType>(schema: S): TypeGuard<z.infer<S>>;
+/**
+ * Validates that the value satisfies the provided schema.
+ *
+ * Upon success, the value's type is narrowed to the schema's output type.
+ *
+ * It uses `safeParse` internally.
+ *
+ * @param schema - The schema to validate against.
+ * @param value - The value to validate.
+ *
+ * @returns Whether the value satisfies the schema.
+ */
+declare function validate<S extends z.ZodType>(schema: S, value: unknown): value is z.infer<S>;
 declare const zu: {
     geojson: {
         (): z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
@@ -111,5 +146,7 @@ declare const zu: {
         stringified: typeof import("./json/json.js").stringifiedJson;
     };
     csv: typeof csv;
+    typeGuard: typeof typeGuard;
+    validate: typeof validate;
 };
 export { zu };

package/lib/esm/index.js

@@ -2,13 +2,56 @@ import { z } from "zod";
 import { json } from "./json/index.js";
 import { geojson } from "./geojson/index.js";
 const csvSchema = z.string().transform((str) => str.split(","));
+csvSchema.brand("Toto");
+/**
+ * Returns a string schema that transforms its input using a string split on commas.
+ *
+ * @returns A CSV schema.
+ */
 function csv() {
     return csvSchema;
 }
+/**
+ * Returns a type guard function using the provided schema as the source of truth.
+ *
+ * It uses the `validate` function internally.
+ *
+ * @param schema - The schema used to verify the inputs will be of the correct type.
+ *
+ * @returns A type guard function that uses the provided schema to asserts whether the
+ * input is of the proper type or not.
+ *
+ * @note Type guards work best with branded types. Given two schemas, z.string().min(5),
+ * and z.string().min(5).brand("Min5String"), the former type guard would only assert
+ * that the input is string (even if the length check is also done), whereas in the
+ * former case, that information is also carried with the type.
+ */
+function typeGuard(schema) {
+    return (value) => {
+        return validate(schema, value);
+    };
+}
+/**
+ * Validates that the value satisfies the provided schema.
+ *
+ * Upon success, the value's type is narrowed to the schema's output type.
+ *
+ * It uses `safeParse` internally.
+ *
+ * @param schema - The schema to validate against.
+ * @param value - The value to validate.
+ *
+ * @returns Whether the value satisfies the schema.
+ */
+function validate(schema, value) {
+    return schema.safeParse(value).success;
+}
 const zu = {
     geojson,
     json,
     csv,
+    typeGuard,
+    validate,
 };
 export { zu };
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAEhE,SAAS,GAAG;IACV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,EAAE,GAAG;IACT,OAAO;IACP,IAAI;IACJ,GAAG;CACJ,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAG7C,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAEhE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAExB;;;;GAIG;AACH,SAAS,GAAG;IACV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,SAAS,CAAsB,MAAS;IAC/C,OAAO,CAAC,KAAc,EAAuB,EAAE;QAC7C,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,QAAQ,CACf,MAAS,EACT,KAAc;IAEd,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;AACzC,CAAC;AAED,MAAM,EAAE,GAAG;IACT,OAAO;IACP,IAAI;IACJ,GAAG;IACH,SAAS;IACT,QAAQ;CACT,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,CAAC"}

package/lib/esm/json/json.js.map

@@ -1 +1 @@
-{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/json/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC;IAC9B,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,OAAO,EAAE;IACX,CAAC,CAAC,IAAI,EAAE;CACT,CAAC,CAAC;AAEH,MAAM,UAAU,SAAS;IACvB,OAAO,eAAe,CAAC;AACzB,CAAC;AAMD,MAAM,UAAU,GAAoB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC9C,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAC9E,CAAC;AACF,MAAM,UAAU,IAAI;IAClB,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;AACtD,MAAM,UAAU,MAAM;IACpB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AACxC,MAAM,UAAU,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAA4B,CAAC;KAC5D,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC;KAChC;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,KAAK,CAAC;KAChB;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe;IAC7B,OAAO,qBAAqB,CAAC;AAC/B,CAAC"}
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/json/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC;IAC9B,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,OAAO,EAAE;IACX,CAAC,CAAC,IAAI,EAAE;CACT,CAAC,CAAC;AAEH,MAAM,UAAU,SAAS;IACvB,OAAO,eAAe,CAAC;AACzB,CAAC;AAMD,MAAM,UAAU,GAAoB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC9C,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAC9E,CAAC;AACF,MAAM,UAAU,IAAI;IAClB,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;AACtD,MAAM,UAAU,MAAM;IACpB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AACxC,MAAM,UAAU,KAAK;IACnB,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAA4B,CAAC;KAC5D,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,KAAK,CAAC;IACjB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe;IAC7B,OAAO,qBAAqB,CAAC;AAC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/zod-utils",
-  "version": "0.5.0-alpha.3",
+  "version": "0.6.0-alpha.0",
   "description": "Extensions to the zod package.",
   "keywords": [
     "zod",
@@ -50,10 +50,11 @@
     "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
   },
   "dependencies": {
+    "@infra-blocks/types": "^0.24.0",
     "zod": "^4.2.1"
   },
   "devDependencies": {
-    "@infra-blocks/test": "^0.3.1",
+    "@infra-blocks/test": "^0.6.0",
     "@types/lodash": "^4.17.0",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.10.3",
@@ -68,7 +69,7 @@
     "mocha": "^10.2.0",
     "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=18.0.0"