@guillaume-docquier/tools-ts 9.1.0 → 10.0.0

package/README.md

@@ -37,12 +37,14 @@ external APIs, CLI input, local storage, or other unknown data.
 
 ### Zod Parsing
 
-Use these tools when constructing a value from trusted, typed data through a Zod schema. Install Zod in the consuming project to use them.
-
-| Export         | What it is                                                                       | Use it when                                                        |
-| -------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| typedParse     | Parses a typed, deeply unbranded value with a Zod schema and returns its output. | Invalid data is an internal invariant violation that should throw. |
-| safeTypedParse | The non-throwing counterpart, returning a Zod safe parse result.                 | Validation may fail and the caller will handle the result.         |
+Import these tools from `@guillaume-docquier/tools-ts/schemas`. Install Zod in the consuming project to use this optional subpath; the root entry point does not load Zod.
+
+| Export                                    | What it is                                                                       | Use it when                                                        |
+| ----------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| typedParse                                | Parses a typed, deeply unbranded value with a Zod schema and returns its output. | Invalid data is an internal invariant violation that should throw. |
+| safeTypedParse                            | The non-throwing counterpart, returning a Zod safe parse result.                 | Validation may fail and the caller will handle the result.         |
+| IntegerSchema and `Integer`               | Parses and brands whole numbers.                                                 | A value must be an integer, including zero or a negative integer.  |
+| PositiveNumberSchema and `PositiveNumber` | Parses and brands numbers greater than zero.                                     | A value must be positive but may be fractional.                    |
 
 ### Numeric Utilities
 

package/dist/entry.schemas.d.ts

@@ -0,0 +1,3 @@
+export { IntegerSchema, type Integer } from "./schemas/Integer.js";
+export { PositiveNumberSchema, type PositiveNumber } from "./schemas/PositiveNumber.js";
+export { typedParse, safeTypedParse } from "./schemas/typedParse.js";

package/dist/entry.schemas.js

@@ -0,0 +1,4 @@
+export { IntegerSchema } from "./schemas/Integer.js";
+export { PositiveNumberSchema } from "./schemas/PositiveNumber.js";
+export { typedParse, safeTypedParse } from "./schemas/typedParse.js";
+//# sourceMappingURL=entry.schemas.js.map

package/dist/entry.schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.schemas.js","sourceRoot":"","sources":["../src/entry.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAgB,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAAE,oBAAoB,EAAuB,MAAM,6BAA6B,CAAA;AACvF,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA"}

package/dist/entry.tools-ts.d.ts

@@ -13,7 +13,6 @@ export { Profile } from "./Profile.js";
 export { Range } from "./Range.js";
 export { Scalar } from "./Scalar.js";
 export { TypeGuard } from "./TypeGuard.js";
-export { typedParse, safeTypedParse } from "./typedParse.js";
 export { setTimeoutAsync } from "./setTimeoutAsync.js";
 export { noop, asyncNoop } from "./noop.js";
 export { Logger } from "./logging/Logger.js";

package/dist/entry.tools-ts.js

@@ -12,7 +12,6 @@ export { Profile } from "./Profile.js";
 export { Range } from "./Range.js";
 export { Scalar } from "./Scalar.js";
 export { TypeGuard } from "./TypeGuard.js";
-export { typedParse, safeTypedParse } from "./typedParse.js";
 export { setTimeoutAsync } from "./setTimeoutAsync.js";
 export { noop, asyncNoop } from "./noop.js";
 export { Logger } from "./logging/Logger.js";

package/dist/entry.tools-ts.js.map

@@ -1 +1 @@
-{"version":3,"file":"entry.tools-ts.js","sourceRoot":"","sources":["../src/entry.tools-ts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAI5C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAA8B,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAKvE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,IAAI,EAAmB,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,GAAG,EAAiB,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAY,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAgB,OAAO,EAAgE,MAAM,YAAY,CAAA;AAChH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"entry.tools-ts.js","sourceRoot":"","sources":["../src/entry.tools-ts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAI5C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAA8B,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAKvE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,IAAI,EAAmB,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,GAAG,EAAiB,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAY,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAgB,OAAO,EAAgE,MAAM,YAAY,CAAA;AAChH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/dist/schemas/Integer.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { type Branded } from "../Brand.js";
+/**
+ * A whole number, including zero and negative numbers.
+ */
+export type Integer = Branded<"Integer", number>;
+/**
+ * Parses a number as an integer.
+ */
+export declare const IntegerSchema: z.ZodPipe<z.ZodInt, z.ZodTransform<Integer, number>>;

package/dist/schemas/Integer.js

@@ -0,0 +1,7 @@
+import { z } from "zod";
+import { branded } from "../Brand.js";
+/**
+ * Parses a number as an integer.
+ */
+export const IntegerSchema = z.int().transform(branded);
+//# sourceMappingURL=Integer.js.map

package/dist/schemas/Integer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Integer.js","sourceRoot":"","sources":["../../src/schemas/Integer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAA;AAOnD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,OAAgB,CAAC,CAAA"}

package/dist/schemas/PositiveNumber.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { type Branded } from "../Brand.js";
+/**
+ * A number greater than zero; zero is neither positive nor negative.
+ */
+export type PositiveNumber = Branded<"PositiveNumber", number>;
+/**
+ * Parses a number greater than zero, including positive fractions.
+ */
+export declare const PositiveNumberSchema: z.ZodPipe<z.ZodNumber, z.ZodTransform<PositiveNumber, number>>;

package/dist/schemas/PositiveNumber.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { branded } from "../Brand.js";
+/**
+ * Parses a number greater than zero, including positive fractions.
+ */
+export const PositiveNumberSchema = z
+    .number()
+    .positive()
+    .transform(branded);
+//# sourceMappingURL=PositiveNumber.js.map

package/dist/schemas/PositiveNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PositiveNumber.js","sourceRoot":"","sources":["../../src/schemas/PositiveNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAA;AAOnD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,SAAS,CAAC,OAAuB,CAAC,CAAA"}

package/dist/{typedParse.d.ts → schemas/typedParse.d.ts}

@@ -1,5 +1,5 @@
 import type { z } from "zod";
-import type { DeepUnbranded } from "./Brand.js";
+import type { DeepUnbranded } from "../Brand.js";
 /**
  * We use zod schemas on unknown inputs to parse & validate the data.
  * However, when you have already parsed data (usually because it is trusted data) and want to validate, using schema.parse is bad because the parameter is `unknown`, so you don't get feedback from TypeScript.

package/dist/schemas/typedParse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedParse.js","sourceRoot":"","sources":["../../src/schemas/typedParse.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,UAAU,CAA4B,MAAe,EAAE,KAAuC;IAC5G,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAe,EACf,KAAuC;IAEvC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guillaume-docquier/tools-ts",
-  "version": "9.1.0",
+  "version": "10.0.0",
   "description": "My personal collection of typescript tools",
   "homepage": "https://github.com/Guillaume-Docquier/tools-ts",
   "license": "MIT",
@@ -18,6 +18,11 @@
       "types": "./dist/entry.tools-ts.d.ts",
       "import": "./dist/entry.tools-ts.js",
       "require": "./dist/entry.tools-ts.js"
+    },
+    "./schemas": {
+      "types": "./dist/entry.schemas.d.ts",
+      "import": "./dist/entry.schemas.js",
+      "require": "./dist/entry.schemas.js"
     }
   },
   "publishConfig": {

package/dist/typedParse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedParse.js","sourceRoot":"","sources":["../src/typedParse.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,UAAU,CAA4B,MAAe,EAAE,KAAuC;IAC5G,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAe,EACf,KAAuC;IAEvC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC"}