@earendil-works/pi-schema 0.0.0 → 1.5.1

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Changelog
 
-## [Unreleased]
+## [1.5.1] - 2026-11-09
+
+### Added
+
+- `unsafe<T>(schema)` types a schema as accepting `T` without checking it, as TypeBox's `Type.Unsafe` does.
+- `recursive<T>(id, build)` builds a schema that contains itself (a tree), with its type given as `T`.
+- `Validator.validate(value)` returns `{ ok: true, value }` or `{ ok: false, errors }` without coercing, on every validator.
+- `Static` types TypeBox's `Enum`, `Tuple`, `BigInt` and `Undefined` schemas.
+- TypeBox's JavaScript types validate and coerce as TypeBox does: `{ type: "bigint" }` (`Type.BigInt`) and `{ type: "undefined" }` (`Type.Undefined`), with `Value.Convert`'s rules for both; the number keywords apply to numbers and bigints alike, with bounds of either kind. The `bigint()` builder builds the former.
+- `equal(a, b)`: JSON equality as `const`, `enum` and `uniqueItems` compare, a drop-in for TypeBox's `Value.Equal`.
+
+### Changed
+
+- Faster checks, still without eval: object and array loops run `const`, small `enum`s, type lists, number bounds, string lengths and patterns inline instead of calling a closure; a closed object looks up keys in declared order first; `anyOf` branches that are bare types (as `nullable` builds) run as one type test. Checks take about 16% less time across the benchmark's speed cases, up to 30% less for tagged unions and 45% less for nullable properties.
+
+### Fixed
+
+- A `number` or `integer` no longer accepts `NaN`, `Infinity` or `-Infinity`, as in TypeBox; before, an unbounded `num()` accepted them. JSON has neither, so only values built in code are affected. Errors name the value (`expected number, got NaN`).
+- The third-party licenses are in `THIRD_PARTY_NOTICES/`, renamed from `LICENSES/`, which Vite's license notices read as the package's license file, failing browser builds that bundle the package.
+- A required property set to `undefined` is valid when its schema takes `undefined` (a union with `Type.Undefined()`, `Type.Unknown()`, `Type.Any()`), as in TypeBox; before, it was always missing. An optional one set to `undefined` still counts as absent.
+- Fixed local `$ref`s in schemas whose root `$id` is a relative path with a directory, such as `schemas/tool.json`: the `$id` was applied twice, so `compile` threw and `unresolvedRefs: "reject"` rejected valid tool arguments. Relative `$id`s are now also applied once with `unevaluatedProperties`/`unevaluatedItems`, when explaining errors under nested resources, and on the first coercion of a schema with `$dynamicRef` ([#11697](https://github.com/earendil-works/pi/issues/11697))
+
+## [1.5.0] - 2026-11-02
 
 ### Added
 

package/README.md

@@ -47,7 +47,8 @@ or not.
 
 `check(value)` is the fast path: a boolean, no allocations for most schemas, and a plain function you can pass
 around. `errors(value)` explains a failure and returns `[]` for a valid value. It is built on the first failure and
-kept, so a schema whose values always pass never pays for it.
+kept, so a schema whose values always pass never pays for it. `validate(value)` combines the two without changing
+the value: `{ ok: true, value }` or `{ ok: false, errors }`.
 
 ### Builders
 
@@ -65,6 +66,9 @@ kept, so a schema whose values always pass never pays for it.
 | `union([...])` | `{ anyOf: [...] }` | the union |
 | `nullable(schema)` | `{ anyOf: [schema, { type: "null" }] }` | `T \| null` |
 | `bytes({ minLength, maxLength })` | `{ type: "bytes", ... }` | `Uint8Array` |
+| `bigint({ minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf })` | `{ type: "bigint", ... }`, bigint bounds | `bigint` |
+| `unsafe<T>(schema)` | `schema` as given (`{}` by default) | `T`, unchecked |
+| `recursive<T>(id, (self) => schema)` | `schema` with `$id: id`; `self` is `{ $ref: id }` | `T` |
 
 Every builder also takes `title`, `description`, `examples`, `deprecated` and `default`. A `default` is an annotation;
 validation never inserts it.
@@ -77,11 +81,20 @@ compile(Block).errors({ kind: "video" });
 // [{ path: "/kind", keyword: "anyOf", message: 'expected one of ["text","image"]' }]
 ```
 
+A recursive schema needs its type spelled out, since TypeScript cannot infer one from the builders. Its `id` must be
+unique among the recursive schemas within one schema:
+
+```typescript
+type Tree = { name: string; children: Tree[] };
+const Tree = recursive<Tree>("Tree", (self) => obj({ name: str(), children: arr(self) }));
+```
+
 `Static` also types schemas built with TypeBox 1.x, read from TypeBox's type shapes (pi-schema does not import
 TypeBox): `String`, `Number`, `Integer`, `Boolean`, `Null`, `Literal`, `Array`, `Object` (with `Type.Optional` and
-`Type.Readonly` properties), `Union`, `Record`, `Unsafe`, `Unknown` and `Any` give TypeBox's own static type, so
-`Static<typeof Type.Object({ path: Type.String() })>` is `{ path: string }`. Other TypeBox kinds (`Enum`, `Tuple`,
-`Intersect`, `Cyclic`, ...) give `unknown` where they stand. Other JSON Schema objects give `unknown`.
+`Type.Readonly` properties), `Union`, `Record`, `Enum`, `Tuple`, `BigInt`, `Undefined`, `Unsafe`, `Unknown` and `Any`
+give TypeBox's own static type, so `Static<typeof Type.Object({ path: Type.String() })>` is `{ path: string }`. Other
+TypeBox kinds (`Intersect`, `Cyclic`, `Ref`, ...) give `unknown` where they stand. Other JSON Schema objects give
+`unknown`.
 
 ### Options
 
@@ -116,8 +129,8 @@ import Type from "typebox";
 const user = compile(Type.Object({ name: Type.String(), tags: Type.Array(Type.String()) }));
 ```
 
-TypeBox's JavaScript-only types (`BigInt`, `Undefined`, `Function`, ...), refinements and codecs are not JSON Schema
-and are not supported.
+TypeBox's `BigInt` and `Undefined` are supported (see Values). Its other JavaScript-only types (`Function`, `Symbol`,
+...), refinements and codecs are not JSON Schema and are not supported.
 
 ### Coercion
 
@@ -151,6 +164,9 @@ Three passes run in order:
    - `integer`: as `number`, then truncated (`"3.5"` and `3.5` become 3).
    - `boolean`: `"true"`/`"false"` (any case), `"1"`/`"0"`, 1/0, `null` to `false`.
    - `null`: `"null"`, `"undefined"`, `""`, `"0"`, 0 and `false`.
+   - `bigint`: integer strings (`"12"`, `"12n"`; `"12.9"` truncated), numbers truncated, `"true"`/`"false"` and
+     booleans to 1n/0n, `null` to 0n.
+   - `undefined`: `"undefined"`, `"null"`, `""`, `"0"`, 0, 0n, `false` and `null`.
    - `array`: a single value becomes a one-item array, then each item converts; a tuple (`prefixItems` or an `items`
      array) converts its items and never wraps.
    - `object`: each property converts by `properties`, `patternProperties` or `additionalProperties`.
@@ -171,9 +187,16 @@ coerced by any pass.
 
 ### Values
 
-- A property whose value is `undefined` counts as absent, as in TypeBox.
+- An optional property whose value is `undefined` counts as absent, as in TypeBox. A required property set to
+  `undefined` is present: valid when its schema takes `undefined` (`Type.Undefined()` in it, `Type.Unknown()`,
+  `Type.Any()`), else missing.
 - `{ type: "bytes", minLength, maxLength }` matches a `Uint8Array` of that length, an extension for values that never
   pass through JSON.
+- `{ type: "bigint" }` (TypeBox's `Type.BigInt`) matches a `bigint`. The number keywords (`minimum`, `maximum`,
+  `exclusiveMinimum`, `exclusiveMaximum`, `multipleOf`) apply to numbers and bigints alike, with bounds of either kind,
+  as in TypeBox.
+- `{ type: "undefined" }` (TypeBox's `Type.Undefined`) matches `undefined`.
+- `equal(a, b)` is JSON equality as `const`, `enum` and `uniqueItems` compare (TypeBox's `Value.Equal`).
 
 ## Supported keywords
 
@@ -293,4 +316,4 @@ schemas that arrive later.
 `npm test` runs the official test suite (drafts 2020-12 and 7, including the optional and format tests, vendored in
 `test/fixtures/`) and the package's own tests.
 
-The format checks are adapted from TypeBox 1.3.27 (MIT); its license is in `LICENSES/`.
+The format checks are adapted from TypeBox 1.3.27 (MIT); its license is in `THIRD_PARTY_NOTICES/`.

package/dist/builders.d.ts

@@ -49,6 +49,19 @@ export interface NumberBounds {
 export declare function num(options?: Annotations<number> & NumberBounds): Schema<number>;
 /** An integer within optional bounds. */
 export declare function int(options?: Annotations<number> & NumberBounds): Schema<number>;
+/** Bounds of a bigint: TypeBox's `Type.BigInt` options. */
+export interface BigintBounds {
+    readonly minimum?: bigint;
+    readonly maximum?: bigint;
+    readonly exclusiveMinimum?: bigint;
+    readonly exclusiveMaximum?: bigint;
+    readonly multipleOf?: bigint;
+}
+/**
+ * A bigint within optional bounds (`{ type: "bigint" }`, as TypeBox's `Type.BigInt`): an extension of JSON Schema for
+ * values that never pass through JSON, such as 64-bit integers a Parquet reader decodes.
+ */
+export declare function bigint(options?: Annotations<bigint> & BigintBounds): Schema<bigint>;
 /** A boolean. */
 export declare function bool(options?: Annotations<boolean>): Schema<boolean>;
 /** `null`. */
@@ -80,6 +93,22 @@ export declare function tuple<const S extends readonly Schema[]>(items: S, optio
 }>;
 /** An object with string keys and values of `value` (a record). */
 export declare function map<T>(value: Schema<T>, options?: Annotations<Record<string, T>>): Schema<Record<string, T>>;
+/**
+ * `schema` typed as accepting `T`, for values the builders cannot express (a type checked elsewhere, a schema from
+ * another system). The schema is returned as it is: nothing checks that its values are `T`.
+ */
+export declare function unsafe<T>(schema?: Schema): Schema<T>;
+/**
+ * A schema that contains itself, as a tree's children are trees: `build` receives a reference to the schema it
+ * returns. TypeScript cannot infer a recursive type from the builders, so `T` is given:
+ * `recursive<Tree>("Tree", (tree) => obj({ name: str(), children: arr(tree) }))`. `id` becomes the schema's `$id`
+ * and the target of the reference, so it must be unique among the recursive schemas within one schema.
+ *
+ * The counterpart of TypeBox's `Type.Cyclic` + `Type.Ref`, with other JSON: an `$id` on the schema instead of `$defs`
+ * and a root `$ref`. It validates the same values. The JSON differs only where a schema is published, and its type is
+ * written once instead of inferred, which a recursive schema (a file tree) needs only once.
+ */
+export declare function recursive<T>(id: string, build: (self: Schema<T>) => Schema<T>): Schema<T>;
 /** A Uint8Array with optional length bounds (an extension of JSON Schema for values that never pass through JSON). */
 export declare function bytes(options?: Annotations<Uint8Array> & LengthBounds): Schema<Uint8Array>;
 /** An optional property of obj(): `{ name: opt(str()) }` may omit `name` or set it to undefined. */

package/dist/builders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,CAAC,MAAM,MAAM,EAAE,OAAO,MAAM,CAAC;AACpC,OAAO,CAAC,MAAM,aAAa,EAAE,OAAO,MAAM,CAAC;AAE3C,oHAAoH;AACpH,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,OAAO,IAAI;IAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAItG;;;GAGG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAAE,GAC9F,aAAa,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,SAAS,CAAC,GAChB,OAAO,GACP,CAAC,GACF,OAAO,CAAC;AAEZ,oGAAoG;AACpG,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,kFAAkF;AAClF,wBAAgB,GAAG,CAClB,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAY,GAAG;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACxG,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,uCAAuC;AACvC,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAEpF;AAED,yCAAyC;AACzC,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAEpF;AAED,iBAAiB;AACjB,wBAAgB,IAAI,CAAC,OAAO,GAAE,WAAW,CAAC,OAAO,CAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAExE;AAED,cAAc;AACd,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,IAAI,CAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAEjE;AAED,iBAAiB;AACjB,wBAAgB,OAAO,CAAC,OAAO,GAAE,WAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,CAElE;AAED,2DAA2D;AAC3D,wBAAgB,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EACnE,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,WAAW,CAAC,CAAC,CAAM,GAC1B,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,+BAA+B;AAC/B,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,EAAE,EAClF,MAAM,EAAE,CAAC,EACT,OAAO,GAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAM,GAClC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAEnB;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACtD,OAAO,EAAE,CAAC,EACV,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAE3B;AAED,0BAA0B;AAC1B,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,WAAW,CAAC,CAAC,GAAG,IAAI,CAAM,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAEpG;AAED,yEAAyE;AACzE,wBAAgB,GAAG,CAAC,CAAC,EACpB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAChB,OAAO,GAAE,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAC1B,GACJ,MAAM,CAAC,CAAC,EAAE,CAAC,CAEb;AAED,+DAA+D;AAC/D,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACtD,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,WAAW,CAAC;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAM,GACnE,MAAM,CAAC;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,CAEpD;AAED,mEAAmE;AACnE,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAEhH;AAED,sHAAsH;AACtH,wBAAgB,KAAK,CAAC,OAAO,GAAE,WAAW,CAAC,UAAU,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,CAE9F;AAED,oGAAoG;AACpG,qBAAa,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9C,SAAiB,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnB,YAAY,MAAM,EAAE,CAAC,EAEpB;CACD;AAED,2CAA2C;AAC3C,wBAAgB,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAE5D;AAED,qEAAqE;AACrE,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAC;AAExE,yCAAyC;AACzC,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,UAAU,IAAI,QAAQ,CACxD;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG;IACjF,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAC3F,MAAM,CAAC,CAAC,CAAC,GACT,KAAK;CACR,CACD,CAAC;AAEF,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAEjD;;;GAGG;AACH,wBAAgB,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,UAAU,EAC7C,UAAU,EAAE,CAAC,EACb,OAAO,GAAE,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GACtE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAkBzB"}
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,CAAC,MAAM,MAAM,EAAE,OAAO,MAAM,CAAC;AACpC,OAAO,CAAC,MAAM,aAAa,EAAE,OAAO,MAAM,CAAC;AAE3C,oHAAoH;AACpH,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,OAAO,IAAI;IAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAItG;;;GAGG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAAE,GAC9F,aAAa,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,SAAS,CAAC,GAChB,OAAO,GACP,CAAC,GACF,OAAO,CAAC;AAEZ,oGAAoG;AACpG,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,kFAAkF;AAClF,wBAAgB,GAAG,CAClB,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAY,GAAG;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACxG,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,uCAAuC;AACvC,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAEpF;AAED,yCAAyC;AACzC,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAEpF;AAED,2DAA2D;AAC3D,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAEvF;AAED,iBAAiB;AACjB,wBAAgB,IAAI,CAAC,OAAO,GAAE,WAAW,CAAC,OAAO,CAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAExE;AAED,cAAc;AACd,wBAAgB,GAAG,CAAC,OAAO,GAAE,WAAW,CAAC,IAAI,CAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAEjE;AAED,iBAAiB;AACjB,wBAAgB,OAAO,CAAC,OAAO,GAAE,WAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,CAElE;AAED,2DAA2D;AAC3D,wBAAgB,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EACnE,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,WAAW,CAAC,CAAC,CAAM,GAC1B,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,+BAA+B;AAC/B,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,EAAE,EAClF,MAAM,EAAE,CAAC,EACT,OAAO,GAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAM,GAClC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAEnB;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACtD,OAAO,EAAE,CAAC,EACV,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAE3B;AAED,0BAA0B;AAC1B,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,WAAW,CAAC,CAAC,GAAG,IAAI,CAAM,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAEpG;AAED,yEAAyE;AACzE,wBAAgB,GAAG,CAAC,CAAC,EACpB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAChB,OAAO,GAAE,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAC1B,GACJ,MAAM,CAAC,CAAC,EAAE,CAAC,CAEb;AAED,+DAA+D;AAC/D,wBAAgB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACtD,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,WAAW,CAAC;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAM,GACnE,MAAM,CAAC;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,CAEpD;AAED,mEAAmE;AACnE,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAEhH;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAE,MAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAGxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAEzF;AAED,sHAAsH;AACtH,wBAAgB,KAAK,CAAC,OAAO,GAAE,WAAW,CAAC,UAAU,CAAC,GAAG,YAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,CAE9F;AAED,oGAAoG;AACpG,qBAAa,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9C,SAAiB,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnB,YAAY,MAAM,EAAE,CAAC,EAEpB;CACD;AAED,2CAA2C;AAC3C,wBAAgB,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAE5D;AAED,qEAAqE;AACrE,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAC;AAExE,yCAAyC;AACzC,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,UAAU,IAAI,QAAQ,CACxD;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG;IACjF,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAC3F,MAAM,CAAC,CAAC,CAAC,GACT,KAAK;CACR,CACD,CAAC;AAEF,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAEjD;;;GAGG;AACH,wBAAgB,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,UAAU,EAC7C,UAAU,EAAE,CAAC,EACb,OAAO,GAAE,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GACtE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAkBzB"}

package/dist/builders.js

@@ -13,6 +13,13 @@ export function num(options = {}) {
 export function int(options = {}) {
     return { type: "integer", ...options };
 }
+/**
+ * A bigint within optional bounds (`{ type: "bigint" }`, as TypeBox's `Type.BigInt`): an extension of JSON Schema for
+ * values that never pass through JSON, such as 64-bit integers a Parquet reader decodes.
+ */
+export function bigint(options = {}) {
+    return { type: "bigint", ...options };
+}
 /** A boolean. */
 export function bool(options = {}) {
     return { type: "boolean", ...options };
@@ -56,6 +63,27 @@ export function tuple(items, options = {}) {
 export function map(value, options = {}) {
     return { type: "object", additionalProperties: value, ...options };
 }
+/**
+ * `schema` typed as accepting `T`, for values the builders cannot express (a type checked elsewhere, a schema from
+ * another system). The schema is returned as it is: nothing checks that its values are `T`.
+ */
+export function unsafe(schema = {}) {
+    // The brand is type-level only; asserting it is what this builder is for.
+    return schema;
+}
+/**
+ * A schema that contains itself, as a tree's children are trees: `build` receives a reference to the schema it
+ * returns. TypeScript cannot infer a recursive type from the builders, so `T` is given:
+ * `recursive<Tree>("Tree", (tree) => obj({ name: str(), children: arr(tree) }))`. `id` becomes the schema's `$id`
+ * and the target of the reference, so it must be unique among the recursive schemas within one schema.
+ *
+ * The counterpart of TypeBox's `Type.Cyclic` + `Type.Ref`, with other JSON: an `$id` on the schema instead of `$defs`
+ * and a root `$ref`. It validates the same values. The JSON differs only where a schema is published, and its type is
+ * written once instead of inferred, which a recursive schema (a file tree) needs only once.
+ */
+export function recursive(id, build) {
+    return { ...build({ $ref: id }), $id: id };
+}
 /** A Uint8Array with optional length bounds (an extension of JSON Schema for values that never pass through JSON). */
 export function bytes(options = {}) {
     return { type: "bytes", ...options };

package/dist/builders.js.map

@@ -1 +1 @@
-{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,mHAAmH;AACnH,uFAAuF;AAwCvF,kFAAkF;AAClF,MAAM,UAAU,GAAG,CAClB,OAAO,GAAiG,EAAE;IAE1G,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAWD,uCAAuC;AACvC,MAAM,UAAU,GAAG,CAAC,OAAO,GAAuC,EAAE;IACnE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAED,yCAAyC;AACzC,MAAM,UAAU,GAAG,CAAC,OAAO,GAAuC,EAAE;IACnE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;AACxC,CAAC;AAED,iBAAiB;AACjB,MAAM,UAAU,IAAI,CAAC,OAAO,GAAyB,EAAE;IACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;AACxC,CAAC;AAED,cAAc;AACd,MAAM,UAAU,GAAG,CAAC,OAAO,GAAsB,EAAE;IAClD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,iBAAiB;AACjB,MAAM,UAAU,OAAO,CAAC,OAAO,GAAgB,EAAE;IAChD,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACvB,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG,CAClB,KAAQ,EACR,OAAO,GAAmB,EAAE;IAE5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,KAAK,CACpB,MAAS,EACT,OAAO,GAA2B,EAAE;IAEpC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CACpB,OAAU,EACV,OAAO,GAAmC,EAAE;IAE5C,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAED,0BAA0B;AAC1B,MAAM,UAAU,QAAQ,CAAI,MAAiB,EAAE,OAAO,GAA0B,EAAE;IACjF,OAAO,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;AAC1D,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,GAAG,CAClB,KAAgB,EAChB,OAAO,GAIH,EAAE;IAEN,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,KAAK,CACpB,KAAQ,EACR,OAAO,GAA4D,EAAE;IAErE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AAChG,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,GAAG,CAAI,KAAgB,EAAE,OAAO,GAAmC,EAAE;IACpF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AACpE,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,KAAK,CAAC,OAAO,GAA2C,EAAE;IACzE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACtC,CAAC;AAED,oGAAoG;AACpG,MAAM,OAAO,QAAQ;IAEX,MAAM,CAAI;IAEnB,YAAY,MAAS;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;CACD;AAED,2CAA2C;AAC3C,MAAM,UAAU,GAAG,CAAmB,MAAS;IAC9C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAgBD;;;GAGG;AACH,MAAM,UAAU,GAAG,CAClB,UAAa,EACb,OAAO,GAA+D,EAAE;IAExE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3D,IAAI,QAAQ,YAAY,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC3D,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACF,CAAC;IACD,OAAO;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,KAAK;QACjB,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;QACzD,GAAG,WAAW;KACd,CAAC;AACH,CAAC","sourcesContent":["// Schema builders: short functions that return plain JSON Schema objects and carry the static type of the values\n// they accept, so `Static<typeof schema>` is the TypeScript type a valid value has. The objects are ordinary data:\n// they serialize with JSON.stringify and compile with compile() like any other schema.\n\nimport type { TypeBoxStatic } from \"./typebox-static.ts\";\n\ndeclare const STATIC: unique symbol;\ndeclare const OPTIONAL_TYPE: unique symbol;\n\n/** A JSON Schema object whose valid values have type `T` (a type-level brand; nothing extra exists at run time). */\nexport type Schema<T = unknown> = { readonly [keyword: string]: unknown } & { readonly [STATIC]?: T };\n\n// TypeBox is tested first and in its own branch: a builder brand's fallback through TypeBoxStatic would leave\n// `Static<S>` of a generic `S` (constrained to builder schemas) unresolvable to its constraint's types.\n/**\n * The type of the values `S` accepts: the type a builder recorded; for a TypeBox schema (`'~kind'` or `'~unsafe'`),\n * TypeBox's static type for the common kinds (see `TypeBoxStatic`); else `unknown`.\n */\nexport type Static<S> = S extends { readonly \"~kind\": unknown } | { readonly \"~unsafe\": unknown }\n\t? TypeBoxStatic<S>\n\t: S extends { readonly [STATIC]?: infer T }\n\t\t? unknown extends T\n\t\t\t? unknown\n\t\t\t: T\n\t\t: unknown;\n\n/** Annotations every builder accepts: they describe the schema and never change what it accepts. */\nexport interface Annotations<T = unknown> {\n\treadonly title?: string;\n\treadonly description?: string;\n\treadonly examples?: readonly T[];\n\treadonly deprecated?: boolean;\n\t/** A default value, an annotation for tools and forms; validation never inserts it. */\n\treadonly default?: T;\n}\n\n/** Length bounds of a string, an array or bytes. */\nexport interface LengthBounds {\n\treadonly minLength?: number;\n\treadonly maxLength?: number;\n}\n\n/** A string, with optional length bounds (in code points), pattern and format. */\nexport function str(\n\toptions: Annotations<string> & LengthBounds & { readonly pattern?: string; readonly format?: string } = {},\n): Schema<string> {\n\treturn { type: \"string\", ...options };\n}\n\n/** Bounds of a number. */\nexport interface NumberBounds {\n\treadonly minimum?: number;\n\treadonly maximum?: number;\n\treadonly exclusiveMinimum?: number;\n\treadonly exclusiveMaximum?: number;\n\treadonly multipleOf?: number;\n}\n\n/** A number within optional bounds. */\nexport function num(options: Annotations<number> & NumberBounds = {}): Schema<number> {\n\treturn { type: \"number\", ...options };\n}\n\n/** An integer within optional bounds. */\nexport function int(options: Annotations<number> & NumberBounds = {}): Schema<number> {\n\treturn { type: \"integer\", ...options };\n}\n\n/** A boolean. */\nexport function bool(options: Annotations<boolean> = {}): Schema<boolean> {\n\treturn { type: \"boolean\", ...options };\n}\n\n/** `null`. */\nexport function nul(options: Annotations<null> = {}): Schema<null> {\n\treturn { type: \"null\", ...options };\n}\n\n/** Any value. */\nexport function unknown(options: Annotations = {}): Schema<unknown> {\n\treturn { ...options };\n}\n\n/** Exactly `value` (a string, number, boolean or null). */\nexport function lit<const V extends string | number | boolean | null>(\n\tvalue: V,\n\toptions: Annotations<V> = {},\n): Schema<V> {\n\treturn { const: value, ...options };\n}\n\n/** One of the given values. */\nexport function oneOf<const V extends readonly (string | number | boolean | null)[]>(\n\tvalues: V,\n\toptions: Annotations<V[number]> = {},\n): Schema<V[number]> {\n\treturn { enum: values, ...options };\n}\n\n/**\n * Any of the given schemas. A union of objects tagged by a `lit()` property (`{ kind: lit(\"text\"), ... }`) is checked\n * by the tag: only the branch it selects runs, and its errors are the ones reported.\n */\nexport function union<const S extends readonly Schema[]>(\n\tschemas: S,\n\toptions: Annotations<Static<S[number]>> = {},\n): Schema<Static<S[number]>> {\n\treturn { anyOf: schemas, ...options };\n}\n\n/** `schema` or `null`. */\nexport function nullable<T>(schema: Schema<T>, options: Annotations<T | null> = {}): Schema<T | null> {\n\treturn { anyOf: [schema, { type: \"null\" }], ...options };\n}\n\n/** An array of `items`, with optional length bounds and unique items. */\nexport function arr<T>(\n\titems: Schema<T>,\n\toptions: Annotations<T[]> & {\n\t\treadonly minItems?: number;\n\t\treadonly maxItems?: number;\n\t\treadonly uniqueItems?: boolean;\n\t} = {},\n): Schema<T[]> {\n\treturn { type: \"array\", items, ...options };\n}\n\n/** A fixed-length array whose items match `items` in order. */\nexport function tuple<const S extends readonly Schema[]>(\n\titems: S,\n\toptions: Annotations<{ -readonly [K in keyof S]: Static<S[K]> }> = {},\n): Schema<{ -readonly [K in keyof S]: Static<S[K]> }> {\n\treturn { type: \"array\", prefixItems: items, items: false, minItems: items.length, ...options };\n}\n\n/** An object with string keys and values of `value` (a record). */\nexport function map<T>(value: Schema<T>, options: Annotations<Record<string, T>> = {}): Schema<Record<string, T>> {\n\treturn { type: \"object\", additionalProperties: value, ...options };\n}\n\n/** A Uint8Array with optional length bounds (an extension of JSON Schema for values that never pass through JSON). */\nexport function bytes(options: Annotations<Uint8Array> & LengthBounds = {}): Schema<Uint8Array> {\n\treturn { type: \"bytes\", ...options };\n}\n\n/** An optional property of obj(): `{ name: opt(str()) }` may omit `name` or set it to undefined. */\nexport class Optional<S extends Schema = Schema> {\n\tdeclare readonly [OPTIONAL_TYPE]?: S;\n\treadonly schema: S;\n\n\tconstructor(schema: S) {\n\t\tthis.schema = schema;\n\t}\n}\n\n/** Marks an obj() property as optional. */\nexport function opt<S extends Schema>(schema: S): Optional<S> {\n\treturn new Optional(schema);\n}\n\n/** The properties of obj(): a schema or an opt() schema per name. */\nexport type Properties = { readonly [name: string]: Schema | Optional };\n\n/** The value type of an obj() schema. */\nexport type StaticObject<P extends Properties> = Simplify<\n\t{ -readonly [K in keyof P as P[K] extends Optional ? never : K]: Static<P[K]> } & {\n\t\t-readonly [K in keyof P as P[K] extends Optional ? K : never]?: P[K] extends Optional<infer S>\n\t\t\t? Static<S>\n\t\t\t: never;\n\t}\n>;\n\ntype Simplify<T> = { [K in keyof T]: T[K] } & {};\n\n/**\n * A closed object: the given properties (required unless opt()) and no others. `open: true` allows other\n * properties, as tool schemas from other systems often do.\n */\nexport function obj<const P extends Properties>(\n\tproperties: P,\n\toptions: Annotations<StaticObject<P>> & { readonly open?: boolean } = {},\n): Schema<StaticObject<P>> {\n\tconst { open, ...annotations } = options;\n\tconst props: Record<string, Schema> = {};\n\tconst required: string[] = [];\n\tfor (const [name, property] of Object.entries(properties)) {\n\t\tif (property instanceof Optional) props[name] = property.schema;\n\t\telse {\n\t\t\tprops[name] = property;\n\t\t\trequired.push(name);\n\t\t}\n\t}\n\treturn {\n\t\ttype: \"object\",\n\t\tproperties: props,\n\t\t...(required.length > 0 ? { required } : {}),\n\t\t...(open === true ? {} : { additionalProperties: false }),\n\t\t...annotations,\n\t};\n}\n"]}
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,mHAAmH;AACnH,uFAAuF;AAwCvF,kFAAkF;AAClF,MAAM,UAAU,GAAG,CAClB,OAAO,GAAiG,EAAE;IAE1G,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAWD,uCAAuC;AACvC,MAAM,UAAU,GAAG,CAAC,OAAO,GAAuC,EAAE;IACnE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAED,yCAAyC;AACzC,MAAM,UAAU,GAAG,CAAC,OAAO,GAAuC,EAAE;IACnE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;AACxC,CAAC;AAWD;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,OAAO,GAAuC,EAAE;IACtE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAED,iBAAiB;AACjB,MAAM,UAAU,IAAI,CAAC,OAAO,GAAyB,EAAE;IACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC;AACxC,CAAC;AAED,cAAc;AACd,MAAM,UAAU,GAAG,CAAC,OAAO,GAAsB,EAAE;IAClD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,iBAAiB;AACjB,MAAM,UAAU,OAAO,CAAC,OAAO,GAAgB,EAAE;IAChD,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACvB,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG,CAClB,KAAQ,EACR,OAAO,GAAmB,EAAE;IAE5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,KAAK,CACpB,MAAS,EACT,OAAO,GAA2B,EAAE;IAEpC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CACpB,OAAU,EACV,OAAO,GAAmC,EAAE;IAE5C,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACvC,CAAC;AAED,0BAA0B;AAC1B,MAAM,UAAU,QAAQ,CAAI,MAAiB,EAAE,OAAO,GAA0B,EAAE;IACjF,OAAO,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;AAC1D,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,GAAG,CAClB,KAAgB,EAChB,OAAO,GAIH,EAAE;IAEN,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,KAAK,CACpB,KAAQ,EACR,OAAO,GAA4D,EAAE;IAErE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AAChG,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,GAAG,CAAI,KAAgB,EAAE,OAAO,GAAmC,EAAE;IACpF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAI,MAAM,GAAW,EAAE;IAC5C,0EAA0E;IAC1E,OAAO,MAAmB,CAAC;AAC5B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAI,EAAU,EAAE,KAAqC;IAC7E,OAAO,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;AAC5C,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,KAAK,CAAC,OAAO,GAA2C,EAAE;IACzE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;AACtC,CAAC;AAED,oGAAoG;AACpG,MAAM,OAAO,QAAQ;IAEX,MAAM,CAAI;IAEnB,YAAY,MAAS;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;CACD;AAED,2CAA2C;AAC3C,MAAM,UAAU,GAAG,CAAmB,MAAS;IAC9C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAgBD;;;GAGG;AACH,MAAM,UAAU,GAAG,CAClB,UAAa,EACb,OAAO,GAA+D,EAAE;IAExE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3D,IAAI,QAAQ,YAAY,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;aAC3D,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACF,CAAC;IACD,OAAO;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,KAAK;QACjB,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;QACzD,GAAG,WAAW;KACd,CAAC;AACH,CAAC","sourcesContent":["// Schema builders: short functions that return plain JSON Schema objects and carry the static type of the values\n// they accept, so `Static<typeof schema>` is the TypeScript type a valid value has. The objects are ordinary data:\n// they serialize with JSON.stringify and compile with compile() like any other schema.\n\nimport type { TypeBoxStatic } from \"./typebox-static.ts\";\n\ndeclare const STATIC: unique symbol;\ndeclare const OPTIONAL_TYPE: unique symbol;\n\n/** A JSON Schema object whose valid values have type `T` (a type-level brand; nothing extra exists at run time). */\nexport type Schema<T = unknown> = { readonly [keyword: string]: unknown } & { readonly [STATIC]?: T };\n\n// TypeBox is tested first and in its own branch: a builder brand's fallback through TypeBoxStatic would leave\n// `Static<S>` of a generic `S` (constrained to builder schemas) unresolvable to its constraint's types.\n/**\n * The type of the values `S` accepts: the type a builder recorded; for a TypeBox schema (`'~kind'` or `'~unsafe'`),\n * TypeBox's static type for the common kinds (see `TypeBoxStatic`); else `unknown`.\n */\nexport type Static<S> = S extends { readonly \"~kind\": unknown } | { readonly \"~unsafe\": unknown }\n\t? TypeBoxStatic<S>\n\t: S extends { readonly [STATIC]?: infer T }\n\t\t? unknown extends T\n\t\t\t? unknown\n\t\t\t: T\n\t\t: unknown;\n\n/** Annotations every builder accepts: they describe the schema and never change what it accepts. */\nexport interface Annotations<T = unknown> {\n\treadonly title?: string;\n\treadonly description?: string;\n\treadonly examples?: readonly T[];\n\treadonly deprecated?: boolean;\n\t/** A default value, an annotation for tools and forms; validation never inserts it. */\n\treadonly default?: T;\n}\n\n/** Length bounds of a string, an array or bytes. */\nexport interface LengthBounds {\n\treadonly minLength?: number;\n\treadonly maxLength?: number;\n}\n\n/** A string, with optional length bounds (in code points), pattern and format. */\nexport function str(\n\toptions: Annotations<string> & LengthBounds & { readonly pattern?: string; readonly format?: string } = {},\n): Schema<string> {\n\treturn { type: \"string\", ...options };\n}\n\n/** Bounds of a number. */\nexport interface NumberBounds {\n\treadonly minimum?: number;\n\treadonly maximum?: number;\n\treadonly exclusiveMinimum?: number;\n\treadonly exclusiveMaximum?: number;\n\treadonly multipleOf?: number;\n}\n\n/** A number within optional bounds. */\nexport function num(options: Annotations<number> & NumberBounds = {}): Schema<number> {\n\treturn { type: \"number\", ...options };\n}\n\n/** An integer within optional bounds. */\nexport function int(options: Annotations<number> & NumberBounds = {}): Schema<number> {\n\treturn { type: \"integer\", ...options };\n}\n\n/** Bounds of a bigint: TypeBox's `Type.BigInt` options. */\nexport interface BigintBounds {\n\treadonly minimum?: bigint;\n\treadonly maximum?: bigint;\n\treadonly exclusiveMinimum?: bigint;\n\treadonly exclusiveMaximum?: bigint;\n\treadonly multipleOf?: bigint;\n}\n\n/**\n * A bigint within optional bounds (`{ type: \"bigint\" }`, as TypeBox's `Type.BigInt`): an extension of JSON Schema for\n * values that never pass through JSON, such as 64-bit integers a Parquet reader decodes.\n */\nexport function bigint(options: Annotations<bigint> & BigintBounds = {}): Schema<bigint> {\n\treturn { type: \"bigint\", ...options };\n}\n\n/** A boolean. */\nexport function bool(options: Annotations<boolean> = {}): Schema<boolean> {\n\treturn { type: \"boolean\", ...options };\n}\n\n/** `null`. */\nexport function nul(options: Annotations<null> = {}): Schema<null> {\n\treturn { type: \"null\", ...options };\n}\n\n/** Any value. */\nexport function unknown(options: Annotations = {}): Schema<unknown> {\n\treturn { ...options };\n}\n\n/** Exactly `value` (a string, number, boolean or null). */\nexport function lit<const V extends string | number | boolean | null>(\n\tvalue: V,\n\toptions: Annotations<V> = {},\n): Schema<V> {\n\treturn { const: value, ...options };\n}\n\n/** One of the given values. */\nexport function oneOf<const V extends readonly (string | number | boolean | null)[]>(\n\tvalues: V,\n\toptions: Annotations<V[number]> = {},\n): Schema<V[number]> {\n\treturn { enum: values, ...options };\n}\n\n/**\n * Any of the given schemas. A union of objects tagged by a `lit()` property (`{ kind: lit(\"text\"), ... }`) is checked\n * by the tag: only the branch it selects runs, and its errors are the ones reported.\n */\nexport function union<const S extends readonly Schema[]>(\n\tschemas: S,\n\toptions: Annotations<Static<S[number]>> = {},\n): Schema<Static<S[number]>> {\n\treturn { anyOf: schemas, ...options };\n}\n\n/** `schema` or `null`. */\nexport function nullable<T>(schema: Schema<T>, options: Annotations<T | null> = {}): Schema<T | null> {\n\treturn { anyOf: [schema, { type: \"null\" }], ...options };\n}\n\n/** An array of `items`, with optional length bounds and unique items. */\nexport function arr<T>(\n\titems: Schema<T>,\n\toptions: Annotations<T[]> & {\n\t\treadonly minItems?: number;\n\t\treadonly maxItems?: number;\n\t\treadonly uniqueItems?: boolean;\n\t} = {},\n): Schema<T[]> {\n\treturn { type: \"array\", items, ...options };\n}\n\n/** A fixed-length array whose items match `items` in order. */\nexport function tuple<const S extends readonly Schema[]>(\n\titems: S,\n\toptions: Annotations<{ -readonly [K in keyof S]: Static<S[K]> }> = {},\n): Schema<{ -readonly [K in keyof S]: Static<S[K]> }> {\n\treturn { type: \"array\", prefixItems: items, items: false, minItems: items.length, ...options };\n}\n\n/** An object with string keys and values of `value` (a record). */\nexport function map<T>(value: Schema<T>, options: Annotations<Record<string, T>> = {}): Schema<Record<string, T>> {\n\treturn { type: \"object\", additionalProperties: value, ...options };\n}\n\n/**\n * `schema` typed as accepting `T`, for values the builders cannot express (a type checked elsewhere, a schema from\n * another system). The schema is returned as it is: nothing checks that its values are `T`.\n */\nexport function unsafe<T>(schema: Schema = {}): Schema<T> {\n\t// The brand is type-level only; asserting it is what this builder is for.\n\treturn schema as Schema<T>;\n}\n\n/**\n * A schema that contains itself, as a tree's children are trees: `build` receives a reference to the schema it\n * returns. TypeScript cannot infer a recursive type from the builders, so `T` is given:\n * `recursive<Tree>(\"Tree\", (tree) => obj({ name: str(), children: arr(tree) }))`. `id` becomes the schema's `$id`\n * and the target of the reference, so it must be unique among the recursive schemas within one schema.\n *\n * The counterpart of TypeBox's `Type.Cyclic` + `Type.Ref`, with other JSON: an `$id` on the schema instead of `$defs`\n * and a root `$ref`. It validates the same values. The JSON differs only where a schema is published, and its type is\n * written once instead of inferred, which a recursive schema (a file tree) needs only once.\n */\nexport function recursive<T>(id: string, build: (self: Schema<T>) => Schema<T>): Schema<T> {\n\treturn { ...build({ $ref: id }), $id: id };\n}\n\n/** A Uint8Array with optional length bounds (an extension of JSON Schema for values that never pass through JSON). */\nexport function bytes(options: Annotations<Uint8Array> & LengthBounds = {}): Schema<Uint8Array> {\n\treturn { type: \"bytes\", ...options };\n}\n\n/** An optional property of obj(): `{ name: opt(str()) }` may omit `name` or set it to undefined. */\nexport class Optional<S extends Schema = Schema> {\n\tdeclare readonly [OPTIONAL_TYPE]?: S;\n\treadonly schema: S;\n\n\tconstructor(schema: S) {\n\t\tthis.schema = schema;\n\t}\n}\n\n/** Marks an obj() property as optional. */\nexport function opt<S extends Schema>(schema: S): Optional<S> {\n\treturn new Optional(schema);\n}\n\n/** The properties of obj(): a schema or an opt() schema per name. */\nexport type Properties = { readonly [name: string]: Schema | Optional };\n\n/** The value type of an obj() schema. */\nexport type StaticObject<P extends Properties> = Simplify<\n\t{ -readonly [K in keyof P as P[K] extends Optional ? never : K]: Static<P[K]> } & {\n\t\t-readonly [K in keyof P as P[K] extends Optional ? K : never]?: P[K] extends Optional<infer S>\n\t\t\t? Static<S>\n\t\t\t: never;\n\t}\n>;\n\ntype Simplify<T> = { [K in keyof T]: T[K] } & {};\n\n/**\n * A closed object: the given properties (required unless opt()) and no others. `open: true` allows other\n * properties, as tool schemas from other systems often do.\n */\nexport function obj<const P extends Properties>(\n\tproperties: P,\n\toptions: Annotations<StaticObject<P>> & { readonly open?: boolean } = {},\n): Schema<StaticObject<P>> {\n\tconst { open, ...annotations } = options;\n\tconst props: Record<string, Schema> = {};\n\tconst required: string[] = [];\n\tfor (const [name, property] of Object.entries(properties)) {\n\t\tif (property instanceof Optional) props[name] = property.schema;\n\t\telse {\n\t\t\tprops[name] = property;\n\t\t\trequired.push(name);\n\t\t}\n\t}\n\treturn {\n\t\ttype: \"object\",\n\t\tproperties: props,\n\t\t...(required.length > 0 ? { required } : {}),\n\t\t...(open === true ? {} : { additionalProperties: false }),\n\t\t...annotations,\n\t};\n}\n"]}

package/dist/checks.d.ts

@@ -5,19 +5,28 @@ export declare const IS_ARRAY: Check;
 export declare const IS_OBJECT: Check;
 /** Whether `v` is a JSON object: not null, an array or bytes. */
 export declare function isObject(v: unknown): v is Record<string, unknown>;
-/** The check of a `type` name; `bytes` (a Uint8Array) extends JSON Schema for values that never pass through JSON. */
+/**
+ * The check of a `type` name. `bytes` (a Uint8Array), `bigint` (TypeBox's `Type.BigInt`) and `undefined` (TypeBox's
+ * `Type.Undefined`) extend JSON Schema for values that never pass through JSON. A `number` is finite, as in TypeBox:
+ * JSON has no NaN or Infinity, so only a value built in code can be one.
+ */
 export declare const TYPE_CHECKS: ReadonlyMap<string, Check>;
-/** Leaf checks that object and array loops run inline by code instead of calling them. */
-export declare const LEAF_CODES: ReadonlyMap<Check, number>;
+/**
+ * A leaf check as a code and its argument, which object and array loops run by `leafOk` instead of calling the
+ * check: a call through a list of checks is not inlined, a switch is.
+ */
+export type Leaf = readonly [code: number, arg: unknown];
+/** The leaf form of `check`, undefined when it is not a leaf. */
+export declare function leafOf(check: Check): Leaf | undefined;
 /** Whether a combined object or array check also checks the type: not at all, strictly, or passing other types. */
 export declare const GUARD_NONE = 0;
 export declare const GUARD_STRICT = 1;
 export declare const GUARD_LOOSE = 2;
 export type Guard = typeof GUARD_NONE | typeof GUARD_STRICT | typeof GUARD_LOOSE;
 /** Flags of a declared property in an object check's entries: its leaf code and two bits. */
-export declare const CODE = 7;
-export declare const REQUIRED = 8;
-export declare const INHERITED = 16;
+export declare const CODE = 15;
+export declare const REQUIRED = 16;
+export declare const INHERITED = 32;
 /** All of `parts`; two and three parts get closures without a loop. */
 export declare function and(parts: readonly Check[]): Check;
 /** A check whose implementation is set later: the indirection a recursive reference goes through. */
@@ -28,16 +37,31 @@ export declare function indirect(slot: {
 export declare function scopedCheck(scope: string[], uri: string, check: Check): Check;
 /** Any of the named types. */
 export declare function typeCheck(types: readonly unknown[]): Check;
+/** The bits of the named types; unknown names add none. */
+export declare function typeMask(types: readonly unknown[]): number;
+/** `anyOf` whose bare-type branches have the types of `mask`: those by one type test, the others by their checks. */
+export declare function maskedAnyCheck(mask: number, checks: readonly Check[]): Check;
 /** A Uint8Array within the length bounds. */
 export declare function bytesCheck(min: number, max: number): Check;
 /** The number of Unicode code points of `s`: JSON Schema string lengths count code points, not UTF-16 units. */
 export declare function codePoints(s: string): number;
 /** The string keywords: length bounds, pattern and format. */
 export declare function stringCheck(strict: boolean, min: number, max: number, re: RegExp | undefined, format: ((value: string) => boolean) | undefined): Check;
-/** The number keywords. `mode`: 0 passes other types, 1 requires a number, 2 an integer. */
-export declare function numberCheck(mode: 0 | 1 | 2, min: number, max: number, xmin: number, xmax: number, multipleOf: number | undefined): Check;
-/** Whether `v` is a multiple of `d`, exactly for decimals: 0.0075 / 0.0001 is 74.99999999999999 in floating point. */
-export declare function isMultiple(v: number, d: number): boolean;
+/** A number bound: a number, or a bigint (TypeBox's `Type.BigInt` writes its bounds as bigints). */
+export type Bound = number | bigint;
+/**
+ * The number keywords, for numbers and bigints alike (as TypeBox applies them): bounds of either kind compare with
+ * values of either kind. `mode`: 0 passes other types, 1 requires a number, 2 an integer, 3 a bigint.
+ */
+export declare function numberCheck(mode: 0 | 1 | 2 | 3, min: Bound, max: Bound, xmin: Bound, xmax: Bound, multipleOf: Bound | undefined): Check;
+/**
+ * Whether `v` is a multiple of `d`, exactly for decimals: 0.0075 / 0.0001 is 74.99999999999999 in floating point. With
+ * a bigint on either side, exact integer arithmetic; a bigint is no multiple of 0 or of a fraction.
+ *
+ * Deliberately unlike TypeBox, which throws there (`BigInt(0.5)`, division by zero): a check answers for every value
+ * and never throws, and no real schema pairs a bigint with a fractional or zero `multipleOf`.
+ */
+export declare function isMultiple(v: Bound, d: Bound): boolean;
 /** `inner` for objects; other values pass unless `strict`. */
 export declare function guardObject(inner: Check, strict: boolean): Check;
 /** `inner` for arrays; other values pass unless `strict`. */
@@ -82,6 +106,9 @@ export declare function notCheck(check: Check): Check;
 export declare function ifCheck(cond: Check, then: Check, otherwise: Check): Check;
 /** A union of objects tagged by a const on `key`: the tag selects the one branch that can match. */
 export declare function taggedCheck(key: string, tags: readonly unknown[], checks: readonly Check[]): Check;
-/** JSON equality: same primitives, arrays with equal items in order, objects with the same keys and equal values. */
+/**
+ * JSON equality, as `const`, `enum` and `uniqueItems` compare: the same primitives, arrays with equal items in order,
+ * objects with the same keys and equal values (key order does not matter).
+ */
 export declare function deepEqual(a: unknown, b: unknown): boolean;
 //# sourceMappingURL=checks.d.ts.map

package/dist/checks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../src/checks.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,eAAO,MAAM,MAAM,EAAE,KAAkB,CAAC;AACxC,eAAO,MAAM,KAAK,EAAE,KAAmB,CAAC;AAMxC,eAAO,MAAM,QAAQ,EAAE,KAA+B,CAAC;AAEvD,eAAO,MAAM,SAAS,EAAE,KAA0B,CAAC;AAEnD,iEAAiE;AACjE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEjE;AAED,sHAAsH;AACtH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CASjD,CAAC;AAEH,0FAA0F;AAC1F,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,KAAK,EAAE,MAAM,CAOhD,CAAC;AAmBH,mHAAmH;AACnH,eAAO,MAAM,UAAU,IAAI,CAAC;AAC5B,eAAO,MAAM,YAAY,IAAI,CAAC;AAC9B,eAAO,MAAM,WAAW,IAAI,CAAC;AAC7B,MAAM,MAAM,KAAK,GAAG,OAAO,UAAU,GAAG,OAAO,YAAY,GAAG,OAAO,WAAW,CAAC;AAEjF,6FAA6F;AAC7F,eAAO,MAAM,IAAI,IAAI,CAAC;AACtB,eAAO,MAAM,QAAQ,IAAI,CAAC;AAC1B,eAAO,MAAM,SAAS,KAAK,CAAC;AAE5B,uEAAuE;AACvE,wBAAgB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAoBlD;AAED,qGAAqG;AACrG,wBAAgB,QAAQ,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CAAE,GAAG,KAAK,CAElE;AAED,4GAA4G;AAC5G,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAO7E;AAED,8BAA8B;AAC9B,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,KAAK,CAO1D;AAED,6CAA6C;AAC7C,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1D;AAED,gHAAgH;AAChH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAW5C;AAUD,8DAA8D;AAC9D,wBAAgB,WAAW,CAC1B,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,GAC9C,KAAK,CAaP;AAED,4FAA4F;AAC5F,wBAAgB,WAAW,CAC1B,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EACf,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GAAG,SAAS,GAC5B,KAAK,CAMP;AAED,sHAAsH;AACtH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAOxD;AASD,8DAA8D;AAC9D,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,KAAK,CAEhE;AAED,6DAA6D;AAC7D,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,KAAK,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC7B,OAAO,EAAE,SAAS,OAAO,EAAE,EAC3B,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,KAAK,GACV,KAAK,CAuBP;AAED,oHAAoH;AACpH,wBAAgB,UAAU,CACzB,OAAO,EAAE,SAAS,OAAO,EAAE,EAC3B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,aAAa,EAAE,SAAS,MAAM,EAAE,EAChC,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,EAC/C,UAAU,EAAE,KAAK,GAAG,SAAS,EAC7B,KAAK,EAAE,KAAK,GACV,KAAK,CA8BP;AAED,6DAA6D;AAC7D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAKtD;AAED,8DAA8D;AAC9D,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAMlE;AAED,8CAA8C;AAC9C,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,CAOxG;AAED,6CAA6C;AAC7C,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,KAAK,CAK3F;AAED,qGAAqG;AACrG,wBAAgB,SAAS,CACxB,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,KAAK,EAAE,EACxB,IAAI,EAAE,KAAK,GAAG,SAAS,GACrB,KAAK,CAiBP;AAED,+DAA+D;AAC/D,wBAAgB,UAAU,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAEnF;AAED,mDAAmD;AACnD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAE3D;AAED,oDAAoD;AACpD,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAO3E;AAED,uCAAuC;AACvC,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAI/C;AAED,gGAAgG;AAChG,wBAAgB,SAAS,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,KAAK,CAW3D;AAED,eAAe;AACf,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAGhD;AAED,eAAe;AACf,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAKxD;AAED,eAAe;AACf,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAMxD;AAED,aAAa;AACb,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAE5C;AAED,+BAA+B;AAC/B,wBAAgB,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,KAAK,CAEzE;AAED,oGAAoG;AACpG,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAOlG;AAED,qHAAqH;AACrH,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAkBzD"}
+{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../src/checks.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,eAAO,MAAM,MAAM,EAAE,KAAkB,CAAC;AACxC,eAAO,MAAM,KAAK,EAAE,KAAmB,CAAC;AAMxC,eAAO,MAAM,QAAQ,EAAE,KAA+B,CAAC;AAIvD,eAAO,MAAM,SAAS,EAAE,KAA0B,CAAC;AAEnD,iEAAiE;AACjE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEjE;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAWjD,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AAWzD,iEAAiE;AACjE,wBAAgB,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,CAErD;AA6DD,mHAAmH;AACnH,eAAO,MAAM,UAAU,IAAI,CAAC;AAC5B,eAAO,MAAM,YAAY,IAAI,CAAC;AAC9B,eAAO,MAAM,WAAW,IAAI,CAAC;AAC7B,MAAM,MAAM,KAAK,GAAG,OAAO,UAAU,GAAG,OAAO,YAAY,GAAG,OAAO,WAAW,CAAC;AAEjF,6FAA6F;AAC7F,eAAO,MAAM,IAAI,KAAK,CAAC;AACvB,eAAO,MAAM,QAAQ,KAAK,CAAC;AAC3B,eAAO,MAAM,SAAS,KAAK,CAAC;AAE5B,uEAAuE;AACvE,wBAAgB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAoBlD;AAED,qGAAqG;AACrG,wBAAgB,QAAQ,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CAAE,GAAG,KAAK,CAElE;AAED,4GAA4G;AAC5G,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAO7E;AAED,8BAA8B;AAC9B,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,KAAK,CAG1D;AAeD,2DAA2D;AAC3D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,CAI1D;AA0BD,qHAAqH;AACrH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAI5E;AAED,6CAA6C;AAC7C,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1D;AAED,gHAAgH;AAChH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAW5C;AAUD,8DAA8D;AAC9D,wBAAgB,WAAW,CAC1B,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,GAC9C,KAAK,CAeP;AAED,oGAAoG;AACpG,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,wBAAgB,WAAW,CAC1B,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EACnB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,KAAK,EACX,UAAU,EAAE,KAAK,GAAG,SAAS,GAC3B,KAAK,CAWP;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO,CAatD;AASD,8DAA8D;AAC9D,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,KAAK,CAEhE;AAED,6DAA6D;AAC7D,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,KAAK,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC7B,OAAO,EAAE,SAAS,OAAO,EAAE,EAC3B,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,KAAK,GACV,KAAK,CA+BP;AAED,oHAAoH;AACpH,wBAAgB,UAAU,CACzB,OAAO,EAAE,SAAS,OAAO,EAAE,EAC3B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,aAAa,EAAE,SAAS,MAAM,EAAE,EAChC,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,EAC/C,UAAU,EAAE,KAAK,GAAG,SAAS,EAC7B,KAAK,EAAE,KAAK,GACV,KAAK,CA+BP;AAED,6DAA6D;AAC7D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAKtD;AAED,8DAA8D;AAC9D,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAMlE;AAED,8CAA8C;AAC9C,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,CAOxG;AAED,6CAA6C;AAC7C,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,KAAK,CAK3F;AAID,qGAAqG;AACrG,wBAAgB,SAAS,CACxB,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,KAAK,EAAE,EACxB,IAAI,EAAE,KAAK,GAAG,SAAS,GACrB,KAAK,CAiBP;AAED,+DAA+D;AAC/D,wBAAgB,UAAU,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAEnF;AAED,mDAAmD;AACnD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAE3D;AAED,oDAAoD;AACpD,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,CAO3E;AAED,uCAAuC;AACvC,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAI/C;AAED,gGAAgG;AAChG,wBAAgB,SAAS,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,KAAK,CAW3D;AAED,eAAe;AACf,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAGhD;AAED,eAAe;AACf,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAKxD;AAED,eAAe;AACf,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAMxD;AAED,aAAa;AACb,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAE5C;AAED,+BAA+B;AAC/B,wBAAgB,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,KAAK,CAEzE;AAED,oGAAoG;AACpG,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,CAOlG;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAkBzD"}