@atproto/lex-schema 0.0.10 → 0.0.12

package/dist/schema/intersection.js

@@ -3,6 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntersectionSchema = void 0;
 exports.intersection = intersection;
 const core_js_1 = require("../core.js");
+/**
+ * Schema for combining an object schema with a dictionary schema.
+ *
+ * Validates that the input matches both the fixed object shape and allows
+ * additional properties that match the dictionary schema. Properties defined
+ * in the object schema are validated by the object, and remaining properties
+ * are validated by the dictionary.
+ *
+ * @template Left - The ObjectSchema type for fixed properties
+ * @template Right - The DictSchema type for additional properties
+ *
+ * @example
+ * ```ts
+ * const schema = new IntersectionSchema(
+ *   l.object({ name: l.string() }),
+ *   l.dict(l.string(), l.integer())
+ * )
+ * // Validates: { name: 'test', score: 100, count: 5 }
+ * ```
+ */
 class IntersectionSchema extends core_js_1.Schema {
     left;
     right;
@@ -21,6 +41,35 @@ class IntersectionSchema extends core_js_1.Schema {
     }
 }
 exports.IntersectionSchema = IntersectionSchema;
+/**
+ * Creates an intersection schema combining fixed object properties with dynamic dictionary properties.
+ *
+ * Useful for objects that have a known set of properties plus additional
+ * arbitrary properties that follow a pattern.
+ *
+ * @param left - Object schema defining the fixed, known properties
+ * @param right - Dictionary schema for validating additional properties
+ * @returns A new {@link IntersectionSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Object with fixed and dynamic properties
+ * const configSchema = l.intersection(
+ *   l.object({
+ *     version: l.integer(),
+ *     name: l.string(),
+ *   }),
+ *   l.dict(l.string(), l.string()) // Additional string properties
+ * )
+ *
+ * configSchema.parse({
+ *   version: 1,
+ *   name: 'my-config',
+ *   customField: 'value',
+ *   anotherField: 'another',
+ * })
+ * ```
+ */
 /*@__NO_SIDE_EFFECTS__*/
 function intersection(left, right) {
     return new IntersectionSchema(left, right);

package/dist/schema/intersection.js.map

@@ -1 +1 @@
-{"version":3,"file":"intersection.js","sourceRoot":"","sources":["../../src/schema/intersection.ts"],"names":[],"mappings":";;;AAmDA,oCAKC;AAxDD,wCAMmB;AAoBnB,MAAa,kBAGX,SAAQ,gBAGT;IAEsB;IACA;IAFrB,YACqB,IAAU,EACV,KAAY;QAE/B,KAAK,EAAE,CAAA;QAHY,SAAI,GAAJ,IAAI,CAAM;QACV,UAAK,GAAL,KAAK,CAAO;IAGjC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QACjD,IAAI,CAAC,UAAU,CAAC,OAAO;YAAE,OAAO,UAAU,CAAA;QAE1C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE;YACzD,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;SACrC,CAAC,CAAA;IACJ,CAAC;CACF;AAtBD,gDAsBC;AAED,wBAAwB;AACxB,SAAgB,YAAY,CAG1B,IAAU,EAAE,KAAY;IACxB,OAAO,IAAI,kBAAkB,CAAc,IAAI,EAAE,KAAK,CAAC,CAAA;AACzD,CAAC","sourcesContent":["import {\n  InferInput,\n  InferOutput,\n  Schema,\n  Simplify,\n  ValidationContext,\n} from '../core.js'\nimport { DictSchema } from './dict.js'\nimport { ObjectSchema } from './object.js'\n\n/**\n * Allows to more accurately represent the intersection of two object types\n * where both types may share some keys, and one of them uses an index\n * signature.\n *\n * @see {@link https://www.typescriptlang.org/play/?#code/C4TwDgpgBAglC8UDeUBmB7dAuKByARgIYBOuUAvlAGTJQDaA+lAJYB2UAzsMWwOYC6OVgFcAtvgjEKAKGkATCAGMANiWiL0rLlEI4YsjVuBQA1hBA4uPVrwRQARBnT2Dm7QDdCy4dESE6ZiD8UAD0IVAi4pJQABQcABbowspyUBIORMT2AJSyEAAeYOjExqCQUACSrMCSHErAzJoAPNJQsFAFNaxyHFAASkrFck1WfAA0UMKsJqzoAO6sAHxjrVAAQh35XT39g8TDozYTUzPzSyuLdqtwVKttMYHoqO00j88bnRDdvawQ7pJ3NpQAD860BbRwSHBQLadAA0ix2G91oJ1vDggAfWABcxPF5QOH8aFtci5aRlaAwVDMfIQVKIKo1Yh1RQNZq0Jw4AgkMjkCYoRiIzjcPioyISKTkRayBQqNRQQzaQgAMRpdL01NpclcRignm8EFVWrsKrVchxQVC4XF0SxmSAA Playground link}\n */\nexport type Intersect<A, B> = B[keyof B] extends never\n  ? A\n  : keyof A & keyof B extends never\n    ? // If A and B don't overlap, just return A & B\n      A & B\n    : // Otherwise, properly represent the fact that accessing using an\n      // index signature could return a value from either A or B\n      A & { [K in keyof B]: B[K] | A[keyof A & K] }\n\nexport class IntersectionSchema<\n  const Left extends ObjectSchema = any,\n  const Right extends DictSchema = any,\n> extends Schema<\n  Simplify<Intersect<InferInput<Left>, InferInput<Right>>>,\n  Simplify<Intersect<InferOutput<Left>, InferOutput<Right>>>\n> {\n  constructor(\n    protected readonly left: Left,\n    protected readonly right: Right,\n  ) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    const leftResult = ctx.validate(input, this.left)\n    if (!leftResult.success) return leftResult\n\n    return this.right.validateInContext(leftResult.value, ctx, {\n      ignoredKeys: this.left.validatorsMap,\n    })\n  }\n}\n\n/*@__NO_SIDE_EFFECTS__*/\nexport function intersection<\n  const Left extends ObjectSchema,\n  const Right extends DictSchema,\n>(left: Left, right: Right) {\n  return new IntersectionSchema<Left, Right>(left, right)\n}\n"]}
+{"version":3,"file":"intersection.js","sourceRoot":"","sources":["../../src/schema/intersection.ts"],"names":[],"mappings":";;;AAyGA,oCAKC;AA9GD,wCAMmB;AAyBnB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,kBAGX,SAAQ,gBAGT;IAEsB;IACA;IAFrB,YACqB,IAAU,EACV,KAAY;QAE/B,KAAK,EAAE,CAAA;QAHY,SAAI,GAAJ,IAAI,CAAM;QACV,UAAK,GAAL,KAAK,CAAO;IAGjC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QACjD,IAAI,CAAC,UAAU,CAAC,OAAO;YAAE,OAAO,UAAU,CAAA;QAE1C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE;YACzD,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;SACrC,CAAC,CAAA;IACJ,CAAC;CACF;AAtBD,gDAsBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAwB;AACxB,SAAgB,YAAY,CAG1B,IAAU,EAAE,KAAY;IACxB,OAAO,IAAI,kBAAkB,CAAc,IAAI,EAAE,KAAK,CAAC,CAAA;AACzD,CAAC","sourcesContent":["import {\n  InferInput,\n  InferOutput,\n  Schema,\n  Simplify,\n  ValidationContext,\n} from '../core.js'\nimport { DictSchema } from './dict.js'\nimport { ObjectSchema } from './object.js'\n\n/**\n * Type utility for computing the intersection of two object types.\n *\n * Allows to more accurately represent the intersection of two object types\n * where both types may share some keys, and one of them uses an index\n * signature.\n *\n * @template A - First object type (typically from ObjectSchema)\n * @template B - Second object type (typically from DictSchema)\n *\n * @see {@link https://www.typescriptlang.org/play/?#code/C4TwDgpgBAglC8UDeUBmB7dAuKByARgIYBOuUAvlAGTJQDaA+lAJYB2UAzsMWwOYC6OVgFcAtvgjEKAKGkATCAGMANiWiL0rLlEI4YsjVuBQA1hBA4uPVrwRQARBnT2Dm7QDdCy4dESE6ZiD8UAD0IVAi4pJQABQcABbowspyUBIORMT2AJSyEAAeYOjExqCQUACSrMCSHErAzJoAPNJQsFAFNaxyHFAASkrFck1WfAA0UMKsJqzoAO6sAHxjrVAAQh35XT39g8TDozYTUzPzSyuLdqtwVKttMYHoqO00j88bnRDdvawQ7pJ3NpQAD860BbRwSHBQLadAA0ix2G91oJ1vDggAfWABcxPF5QOH8aFtci5aRlaAwVDMfIQVKIKo1Yh1RQNZq0Jw4AgkMjkCYoRiIzjcPioyISKTkRayBQqNRQQzaQgAMRpdL01NpclcRignm8EFVWrsKrVchxQVC4XF0SxmSAA Playground link}\n */\nexport type Intersect<A, B> = B[keyof B] extends never\n  ? A\n  : keyof A & keyof B extends never\n    ? // If A and B don't overlap, just return A & B\n      A & B\n    : // Otherwise, properly represent the fact that accessing using an\n      // index signature could return a value from either A or B\n      A & { [K in keyof B]: B[K] | A[keyof A & K] }\n\n/**\n * Schema for combining an object schema with a dictionary schema.\n *\n * Validates that the input matches both the fixed object shape and allows\n * additional properties that match the dictionary schema. Properties defined\n * in the object schema are validated by the object, and remaining properties\n * are validated by the dictionary.\n *\n * @template Left - The ObjectSchema type for fixed properties\n * @template Right - The DictSchema type for additional properties\n *\n * @example\n * ```ts\n * const schema = new IntersectionSchema(\n *   l.object({ name: l.string() }),\n *   l.dict(l.string(), l.integer())\n * )\n * // Validates: { name: 'test', score: 100, count: 5 }\n * ```\n */\nexport class IntersectionSchema<\n  const Left extends ObjectSchema = any,\n  const Right extends DictSchema = any,\n> extends Schema<\n  Simplify<Intersect<InferInput<Left>, InferInput<Right>>>,\n  Simplify<Intersect<InferOutput<Left>, InferOutput<Right>>>\n> {\n  constructor(\n    protected readonly left: Left,\n    protected readonly right: Right,\n  ) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    const leftResult = ctx.validate(input, this.left)\n    if (!leftResult.success) return leftResult\n\n    return this.right.validateInContext(leftResult.value, ctx, {\n      ignoredKeys: this.left.validatorsMap,\n    })\n  }\n}\n\n/**\n * Creates an intersection schema combining fixed object properties with dynamic dictionary properties.\n *\n * Useful for objects that have a known set of properties plus additional\n * arbitrary properties that follow a pattern.\n *\n * @param left - Object schema defining the fixed, known properties\n * @param right - Dictionary schema for validating additional properties\n * @returns A new {@link IntersectionSchema} instance\n *\n * @example\n * ```ts\n * // Object with fixed and dynamic properties\n * const configSchema = l.intersection(\n *   l.object({\n *     version: l.integer(),\n *     name: l.string(),\n *   }),\n *   l.dict(l.string(), l.string()) // Additional string properties\n * )\n *\n * configSchema.parse({\n *   version: 1,\n *   name: 'my-config',\n *   customField: 'value',\n *   anotherField: 'another',\n * })\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function intersection<\n  const Left extends ObjectSchema,\n  const Right extends DictSchema,\n>(left: Left, right: Right) {\n  return new IntersectionSchema<Left, Right>(left, right)\n}\n"]}

package/dist/schema/literal.d.ts

@@ -1,8 +1,52 @@
 import { Schema, ValidationContext } from '../core.js';
+/**
+ * Schema that only accepts a specific literal value.
+ *
+ * Validates that the input is exactly equal to the specified value using
+ * strict equality (===).
+ *
+ * @template TValue - The literal type (null, string, number, or boolean)
+ *
+ * @example
+ * ```ts
+ * const schema = new LiteralSchema('admin')
+ * schema.validate('admin') // success
+ * schema.validate('user')  // fails
+ * ```
+ */
 export declare class LiteralSchema<const TValue extends null | string | number | boolean> extends Schema<TValue> {
     readonly value: TValue;
     constructor(value: TValue);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<TValue>;
 }
+/**
+ * Creates a literal schema that only accepts the exact specified value.
+ *
+ * Useful for discriminator fields in unions, constant values, or type narrowing.
+ *
+ * @param value - The exact value that must be matched
+ * @returns A new {@link LiteralSchema} instance
+ *
+ * @example
+ * ```ts
+ * // String literal
+ * const roleSchema = l.literal('admin')
+ *
+ * // Number literal
+ * const versionSchema = l.literal(1)
+ *
+ * // Boolean literal
+ * const enabledSchema = l.literal(true)
+ *
+ * // Null literal
+ * const nullSchema = l.literal(null)
+ *
+ * // In discriminated unions
+ * const actionSchema = l.discriminatedUnion('type', [
+ *   l.object({ type: l.literal('create'), data: l.unknown() }),
+ *   l.object({ type: l.literal('delete'), id: l.string() }),
+ * ])
+ * ```
+ */
 export declare function literal<const V extends null | string | number | boolean>(value: V): LiteralSchema<V>;
 //# sourceMappingURL=literal.d.ts.map

package/dist/schema/literal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"literal.d.ts","sourceRoot":"","sources":["../../src/schema/literal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEtD,qBAAa,aAAa,CACxB,KAAK,CAAC,MAAM,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CACrD,SAAQ,MAAM,CAAC,MAAM,CAAC;IACV,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAIlC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAGD,wBAAgB,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EACtE,KAAK,EAAE,CAAC,oBAGT"}
+{"version":3,"file":"literal.d.ts","sourceRoot":"","sources":["../../src/schema/literal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEtD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,aAAa,CACxB,KAAK,CAAC,MAAM,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CACrD,SAAQ,MAAM,CAAC,MAAM,CAAC;IACV,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAIlC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,wBAAgB,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EACtE,KAAK,EAAE,CAAC,oBAGT"}

package/dist/schema/literal.js

@@ -3,6 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LiteralSchema = void 0;
 exports.literal = literal;
 const core_js_1 = require("../core.js");
+/**
+ * Schema that only accepts a specific literal value.
+ *
+ * Validates that the input is exactly equal to the specified value using
+ * strict equality (===).
+ *
+ * @template TValue - The literal type (null, string, number, or boolean)
+ *
+ * @example
+ * ```ts
+ * const schema = new LiteralSchema('admin')
+ * schema.validate('admin') // success
+ * schema.validate('user')  // fails
+ * ```
+ */
 class LiteralSchema extends core_js_1.Schema {
     value;
     constructor(value) {
@@ -17,6 +32,35 @@ class LiteralSchema extends core_js_1.Schema {
     }
 }
 exports.LiteralSchema = LiteralSchema;
+/**
+ * Creates a literal schema that only accepts the exact specified value.
+ *
+ * Useful for discriminator fields in unions, constant values, or type narrowing.
+ *
+ * @param value - The exact value that must be matched
+ * @returns A new {@link LiteralSchema} instance
+ *
+ * @example
+ * ```ts
+ * // String literal
+ * const roleSchema = l.literal('admin')
+ *
+ * // Number literal
+ * const versionSchema = l.literal(1)
+ *
+ * // Boolean literal
+ * const enabledSchema = l.literal(true)
+ *
+ * // Null literal
+ * const nullSchema = l.literal(null)
+ *
+ * // In discriminated unions
+ * const actionSchema = l.discriminatedUnion('type', [
+ *   l.object({ type: l.literal('create'), data: l.unknown() }),
+ *   l.object({ type: l.literal('delete'), id: l.string() }),
+ * ])
+ * ```
+ */
 /*@__NO_SIDE_EFFECTS__*/
 function literal(value) {
     return new LiteralSchema(value);

package/dist/schema/literal.js.map

@@ -1 +1 @@
-{"version":3,"file":"literal.js","sourceRoot":"","sources":["../../src/schema/literal.ts"],"names":[],"mappings":";;;AAmBA,0BAIC;AAvBD,wCAAsD;AAEtD,MAAa,aAEX,SAAQ,gBAAc;IACD;IAArB,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QACnD,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;CACF;AAdD,sCAcC;AAED,wBAAwB;AACxB,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,aAAa,CAAI,KAAK,CAAC,CAAA;AACpC,CAAC","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\n\nexport class LiteralSchema<\n  const TValue extends null | string | number | boolean,\n> extends Schema<TValue> {\n  constructor(readonly value: TValue) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input !== this.value) {\n      return ctx.issueInvalidValue(input, [this.value])\n    }\n\n    return ctx.success(this.value)\n  }\n}\n\n/*@__NO_SIDE_EFFECTS__*/\nexport function literal<const V extends null | string | number | boolean>(\n  value: V,\n) {\n  return new LiteralSchema<V>(value)\n}\n"]}
+{"version":3,"file":"literal.js","sourceRoot":"","sources":["../../src/schema/literal.ts"],"names":[],"mappings":";;;AA+DA,0BAIC;AAnED,wCAAsD;AAEtD;;;;;;;;;;;;;;GAcG;AACH,MAAa,aAEX,SAAQ,gBAAc;IACD;IAArB,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QACnD,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;CACF;AAdD,sCAcC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAwB;AACxB,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,aAAa,CAAI,KAAK,CAAC,CAAA;AACpC,CAAC","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\n\n/**\n * Schema that only accepts a specific literal value.\n *\n * Validates that the input is exactly equal to the specified value using\n * strict equality (===).\n *\n * @template TValue - The literal type (null, string, number, or boolean)\n *\n * @example\n * ```ts\n * const schema = new LiteralSchema('admin')\n * schema.validate('admin') // success\n * schema.validate('user')  // fails\n * ```\n */\nexport class LiteralSchema<\n  const TValue extends null | string | number | boolean,\n> extends Schema<TValue> {\n  constructor(readonly value: TValue) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input !== this.value) {\n      return ctx.issueInvalidValue(input, [this.value])\n    }\n\n    return ctx.success(this.value)\n  }\n}\n\n/**\n * Creates a literal schema that only accepts the exact specified value.\n *\n * Useful for discriminator fields in unions, constant values, or type narrowing.\n *\n * @param value - The exact value that must be matched\n * @returns A new {@link LiteralSchema} instance\n *\n * @example\n * ```ts\n * // String literal\n * const roleSchema = l.literal('admin')\n *\n * // Number literal\n * const versionSchema = l.literal(1)\n *\n * // Boolean literal\n * const enabledSchema = l.literal(true)\n *\n * // Null literal\n * const nullSchema = l.literal(null)\n *\n * // In discriminated unions\n * const actionSchema = l.discriminatedUnion('type', [\n *   l.object({ type: l.literal('create'), data: l.unknown() }),\n *   l.object({ type: l.literal('delete'), id: l.string() }),\n * ])\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function literal<const V extends null | string | number | boolean>(\n  value: V,\n) {\n  return new LiteralSchema<V>(value)\n}\n"]}

package/dist/schema/never.d.ts

@@ -1,6 +1,48 @@
 import { Schema, ValidationContext } from '../core.js';
+/**
+ * Schema that always fails validation.
+ *
+ * Represents an impossible type - no value can satisfy this schema.
+ * Useful for exhaustiveness checking or marking impossible branches.
+ *
+ * @example
+ * ```ts
+ * const schema = new NeverSchema()
+ * schema.validate(anything) // always fails
+ * ```
+ */
 export declare class NeverSchema extends Schema<never> {
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationFailure;
 }
+/**
+ * Creates a never schema that always fails validation.
+ *
+ * Useful for exhaustiveness checking in TypeScript or marking impossible
+ * code paths.
+ *
+ * @returns A new {@link NeverSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Exhaustiveness checking
+ * type Status = 'active' | 'inactive'
+ *
+ * function handleStatus(status: Status) {
+ *   switch (status) {
+ *     case 'active': return 'Active'
+ *     case 'inactive': return 'Inactive'
+ *     default:
+ *       // TypeScript will error if we miss a case
+ *       l.never().parse(status)
+ *   }
+ * }
+ *
+ * // In impossible union branches
+ * const schema = l.object({
+ *   type: l.literal('fixed'),
+ *   dynamic: l.never(), // This property can never exist
+ * })
+ * ```
+ */
 export declare const never: () => NeverSchema;
 //# sourceMappingURL=never.d.ts.map

package/dist/schema/never.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"never.d.ts","sourceRoot":"","sources":["../../src/schema/never.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,qBAAa,WAAY,SAAQ,MAAM,CAAC,KAAK,CAAC;IAC5C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAGzD;AAED,eAAO,MAAM,KAAK,mBAEhB,CAAA"}
+{"version":3,"file":"never.d.ts","sourceRoot":"","sources":["../../src/schema/never.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,MAAM,CAAC,KAAK,CAAC;IAC5C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAGzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,KAAK,mBAEhB,CAAA"}

package/dist/schema/never.js

@@ -3,12 +3,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.never = exports.NeverSchema = void 0;
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema that always fails validation.
+ *
+ * Represents an impossible type - no value can satisfy this schema.
+ * Useful for exhaustiveness checking or marking impossible branches.
+ *
+ * @example
+ * ```ts
+ * const schema = new NeverSchema()
+ * schema.validate(anything) // always fails
+ * ```
+ */
 class NeverSchema extends core_js_1.Schema {
     validateInContext(input, ctx) {
         return ctx.issueInvalidType(input, 'never');
     }
 }
 exports.NeverSchema = NeverSchema;
+/**
+ * Creates a never schema that always fails validation.
+ *
+ * Useful for exhaustiveness checking in TypeScript or marking impossible
+ * code paths.
+ *
+ * @returns A new {@link NeverSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Exhaustiveness checking
+ * type Status = 'active' | 'inactive'
+ *
+ * function handleStatus(status: Status) {
+ *   switch (status) {
+ *     case 'active': return 'Active'
+ *     case 'inactive': return 'Inactive'
+ *     default:
+ *       // TypeScript will error if we miss a case
+ *       l.never().parse(status)
+ *   }
+ * }
+ *
+ * // In impossible union branches
+ * const schema = l.object({
+ *   type: l.literal('fixed'),
+ *   dynamic: l.never(), // This property can never exist
+ * })
+ * ```
+ */
 exports.never = (0, memoize_js_1.memoizedOptions)(function () {
     return new NeverSchema();
 });

package/dist/schema/never.js.map

@@ -1 +1 @@
-{"version":3,"file":"never.js","sourceRoot":"","sources":["../../src/schema/never.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD,MAAa,WAAY,SAAQ,gBAAa;IAC5C,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC7C,CAAC;CACF;AAJD,kCAIC;AAEY,QAAA,KAAK,GAAiB,IAAA,4BAAe,EAAC;IACjD,OAAO,IAAI,WAAW,EAAE,CAAA;AAC1B,CAAC,CAAC,CAAA","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport class NeverSchema extends Schema<never> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    return ctx.issueInvalidType(input, 'never')\n  }\n}\n\nexport const never = /*#__PURE__*/ memoizedOptions(function () {\n  return new NeverSchema()\n})\n"]}
+{"version":3,"file":"never.js","sourceRoot":"","sources":["../../src/schema/never.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD;;;;;;;;;;;GAWG;AACH,MAAa,WAAY,SAAQ,gBAAa;IAC5C,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC7C,CAAC;CACF;AAJD,kCAIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,KAAK,GAAiB,IAAA,4BAAe,EAAC;IACjD,OAAO,IAAI,WAAW,EAAE,CAAA;AAC1B,CAAC,CAAC,CAAA","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Schema that always fails validation.\n *\n * Represents an impossible type - no value can satisfy this schema.\n * Useful for exhaustiveness checking or marking impossible branches.\n *\n * @example\n * ```ts\n * const schema = new NeverSchema()\n * schema.validate(anything) // always fails\n * ```\n */\nexport class NeverSchema extends Schema<never> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    return ctx.issueInvalidType(input, 'never')\n  }\n}\n\n/**\n * Creates a never schema that always fails validation.\n *\n * Useful for exhaustiveness checking in TypeScript or marking impossible\n * code paths.\n *\n * @returns A new {@link NeverSchema} instance\n *\n * @example\n * ```ts\n * // Exhaustiveness checking\n * type Status = 'active' | 'inactive'\n *\n * function handleStatus(status: Status) {\n *   switch (status) {\n *     case 'active': return 'Active'\n *     case 'inactive': return 'Inactive'\n *     default:\n *       // TypeScript will error if we miss a case\n *       l.never().parse(status)\n *   }\n * }\n *\n * // In impossible union branches\n * const schema = l.object({\n *   type: l.literal('fixed'),\n *   dynamic: l.never(), // This property can never exist\n * })\n * ```\n */\nexport const never = /*#__PURE__*/ memoizedOptions(function () {\n  return new NeverSchema()\n})\n"]}

package/dist/schema/null.d.ts

@@ -1,7 +1,36 @@
 import { Schema, ValidationContext } from '../core.js';
+/**
+ * Schema for validating null values.
+ *
+ * Only accepts the JavaScript `null` value. Rejects `undefined` and all
+ * other values.
+ *
+ * @example
+ * ```ts
+ * const schema = new NullSchema()
+ * schema.validate(null)      // success
+ * schema.validate(undefined) // fails
+ * ```
+ */
 export declare class NullSchema extends Schema<null> {
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<null>;
 }
+/**
+ * Creates a null schema that only accepts the null value.
+ *
+ * Useful for explicitly representing null in union types or optional fields.
+ *
+ * @returns A new {@link NullSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Explicit null
+ * const nullOnlySchema = l.null()
+ *
+ * // Nullable string (string or null)
+ * const nullableStringSchema = l.union([l.string(), l.null()])
+ * ```
+ */
 export declare const nullSchema: () => NullSchema;
 export { nullSchema as null };
 //# sourceMappingURL=null.d.ts.map

package/dist/schema/null.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"null.d.ts","sourceRoot":"","sources":["../../src/schema/null.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,qBAAa,UAAW,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED,eAAO,MAAM,UAAU,kBAErB,CAAA;AAEF,OAAO,EAAE,UAAU,IAAI,IAAI,EAAE,CAAA"}
+{"version":3,"file":"null.d.ts","sourceRoot":"","sources":["../../src/schema/null.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,UAAU,kBAErB,CAAA;AAEF,OAAO,EAAE,UAAU,IAAI,IAAI,EAAE,CAAA"}

package/dist/schema/null.js

@@ -3,6 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.null = exports.nullSchema = exports.NullSchema = void 0;
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema for validating null values.
+ *
+ * Only accepts the JavaScript `null` value. Rejects `undefined` and all
+ * other values.
+ *
+ * @example
+ * ```ts
+ * const schema = new NullSchema()
+ * schema.validate(null)      // success
+ * schema.validate(undefined) // fails
+ * ```
+ */
 class NullSchema extends core_js_1.Schema {
     validateInContext(input, ctx) {
         if (input !== null) {
@@ -12,6 +25,22 @@ class NullSchema extends core_js_1.Schema {
     }
 }
 exports.NullSchema = NullSchema;
+/**
+ * Creates a null schema that only accepts the null value.
+ *
+ * Useful for explicitly representing null in union types or optional fields.
+ *
+ * @returns A new {@link NullSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Explicit null
+ * const nullOnlySchema = l.null()
+ *
+ * // Nullable string (string or null)
+ * const nullableStringSchema = l.union([l.string(), l.null()])
+ * ```
+ */
 exports.nullSchema = (0, memoize_js_1.memoizedOptions)(function () {
     return new NullSchema();
 });

package/dist/schema/null.js.map

@@ -1 +1 @@
-{"version":3,"file":"null.js","sourceRoot":"","sources":["../../src/schema/null.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD,MAAa,UAAW,SAAQ,gBAAY;IAC1C,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;CACF;AARD,gCAQC;AAEY,QAAA,UAAU,GAAiB,IAAA,4BAAe,EAAC;IACtD,OAAO,IAAI,UAAU,EAAE,CAAA;AACzB,CAAC,CAAC,CAAA;AAEqB,eAJV,kBAAU,CAII","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport class NullSchema extends Schema<null> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input !== null) {\n      return ctx.issueInvalidType(input, 'null')\n    }\n\n    return ctx.success(null)\n  }\n}\n\nexport const nullSchema = /*#__PURE__*/ memoizedOptions(function () {\n  return new NullSchema()\n})\n\nexport { nullSchema as null }\n"]}
+{"version":3,"file":"null.js","sourceRoot":"","sources":["../../src/schema/null.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD;;;;;;;;;;;;GAYG;AACH,MAAa,UAAW,SAAQ,gBAAY;IAC1C,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;CACF;AARD,gCAQC;AAED;;;;;;;;;;;;;;;GAeG;AACU,QAAA,UAAU,GAAiB,IAAA,4BAAe,EAAC;IACtD,OAAO,IAAI,UAAU,EAAE,CAAA;AACzB,CAAC,CAAC,CAAA;AAEqB,eAJV,kBAAU,CAII","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Schema for validating null values.\n *\n * Only accepts the JavaScript `null` value. Rejects `undefined` and all\n * other values.\n *\n * @example\n * ```ts\n * const schema = new NullSchema()\n * schema.validate(null)      // success\n * schema.validate(undefined) // fails\n * ```\n */\nexport class NullSchema extends Schema<null> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input !== null) {\n      return ctx.issueInvalidType(input, 'null')\n    }\n\n    return ctx.success(null)\n  }\n}\n\n/**\n * Creates a null schema that only accepts the null value.\n *\n * Useful for explicitly representing null in union types or optional fields.\n *\n * @returns A new {@link NullSchema} instance\n *\n * @example\n * ```ts\n * // Explicit null\n * const nullOnlySchema = l.null()\n *\n * // Nullable string (string or null)\n * const nullableStringSchema = l.union([l.string(), l.null()])\n * ```\n */\nexport const nullSchema = /*#__PURE__*/ memoizedOptions(function () {\n  return new NullSchema()\n})\n\nexport { nullSchema as null }\n"]}

package/dist/schema/nullable.d.ts

@@ -1,8 +1,49 @@
 import { InferInput, InferOutput, Schema, ValidationContext, Validator } from '../core.js';
+/**
+ * Schema wrapper that allows null values in addition to the wrapped schema.
+ *
+ * When the input is `null`, validation succeeds immediately. Otherwise,
+ * the input is validated against the wrapped schema.
+ *
+ * @template TValidator - The wrapped validator type
+ *
+ * @example
+ * ```ts
+ * const schema = new NullableSchema(l.string())
+ * schema.validate(null)    // success
+ * schema.validate('hello') // success
+ * ```
+ */
 export declare class NullableSchema<const TValidator extends Validator> extends Schema<InferInput<TValidator> | null, InferOutput<TValidator> | null> {
     readonly validator: TValidator;
     constructor(validator: TValidator);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationFailure | import("../core.js").ValidationSuccess<null> | import("../core.js").ValidationSuccess<InferInput<TValidator>>;
 }
+/**
+ * Creates a nullable schema that accepts null in addition to the wrapped type.
+ *
+ * Wraps another schema to allow null values. Different from `optional()` which
+ * allows undefined.
+ *
+ * @param validator - The validator to make nullable
+ * @returns A new {@link NullableSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Nullable string
+ * const nullableString = l.nullable(l.string())
+ * nullableString.parse(null)    // null
+ * nullableString.parse('hello') // 'hello'
+ *
+ * // In an object
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   deletedAt: l.nullable(l.string({ format: 'datetime' })),
+ * })
+ *
+ * // Combine with optional for null or undefined
+ * const maybeString = l.optional(l.nullable(l.string()))
+ * ```
+ */
 export declare const nullable: <const TValidator extends Validator>(validator: TValidator) => NullableSchema<TValidator>;
 //# sourceMappingURL=nullable.d.ts.map

package/dist/schema/nullable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nullable.d.ts","sourceRoot":"","sources":["../../src/schema/nullable.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,iBAAiB,EACjB,SAAS,EACV,MAAM,YAAY,CAAA;AAGnB,qBAAa,cAAc,CAAC,KAAK,CAAC,UAAU,SAAS,SAAS,CAAE,SAAQ,MAAM,CAC5E,UAAU,CAAC,UAAU,CAAC,GAAG,IAAI,EAC7B,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI,CAC/B;IACa,QAAQ,CAAC,SAAS,EAAE,UAAU;gBAArB,SAAS,EAAE,UAAU;IAI1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED,eAAO,MAAM,QAAQ,SACb,UAAU,SAAS,SAAS,aACvB,UAAU,+BAErB,CAAA"}
+{"version":3,"file":"nullable.d.ts","sourceRoot":"","sources":["../../src/schema/nullable.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,iBAAiB,EACjB,SAAS,EACV,MAAM,YAAY,CAAA;AAGnB;;;;;;;;;;;;;;GAcG;AACH,qBAAa,cAAc,CAAC,KAAK,CAAC,UAAU,SAAS,SAAS,CAAE,SAAQ,MAAM,CAC5E,UAAU,CAAC,UAAU,CAAC,GAAG,IAAI,EAC7B,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI,CAC/B;IACa,QAAQ,CAAC,SAAS,EAAE,UAAU;gBAArB,SAAS,EAAE,UAAU;IAI1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,QAAQ,SACb,UAAU,SAAS,SAAS,aACvB,UAAU,+BAErB,CAAA"}

package/dist/schema/nullable.js

@@ -3,6 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.nullable = exports.NullableSchema = void 0;
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema wrapper that allows null values in addition to the wrapped schema.
+ *
+ * When the input is `null`, validation succeeds immediately. Otherwise,
+ * the input is validated against the wrapped schema.
+ *
+ * @template TValidator - The wrapped validator type
+ *
+ * @example
+ * ```ts
+ * const schema = new NullableSchema(l.string())
+ * schema.validate(null)    // success
+ * schema.validate('hello') // success
+ * ```
+ */
 class NullableSchema extends core_js_1.Schema {
     validator;
     constructor(validator) {
@@ -17,6 +32,32 @@ class NullableSchema extends core_js_1.Schema {
     }
 }
 exports.NullableSchema = NullableSchema;
+/**
+ * Creates a nullable schema that accepts null in addition to the wrapped type.
+ *
+ * Wraps another schema to allow null values. Different from `optional()` which
+ * allows undefined.
+ *
+ * @param validator - The validator to make nullable
+ * @returns A new {@link NullableSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Nullable string
+ * const nullableString = l.nullable(l.string())
+ * nullableString.parse(null)    // null
+ * nullableString.parse('hello') // 'hello'
+ *
+ * // In an object
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   deletedAt: l.nullable(l.string({ format: 'datetime' })),
+ * })
+ *
+ * // Combine with optional for null or undefined
+ * const maybeString = l.optional(l.nullable(l.string()))
+ * ```
+ */
 exports.nullable = (0, memoize_js_1.memoizedTransformer)(function (validator) {
     return new NullableSchema(validator);
 });

package/dist/schema/nullable.js.map

@@ -1 +1 @@
-{"version":3,"file":"nullable.js","sourceRoot":"","sources":["../../src/schema/nullable.ts"],"names":[],"mappings":";;;AAAA,wCAMmB;AACnB,mDAAwD;AAExD,MAAa,cAAmD,SAAQ,gBAGvE;IACsB;IAArB,YAAqB,SAAqB;QACxC,KAAK,EAAE,CAAA;QADY,cAAS,GAAT,SAAS,CAAY;IAE1C,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1B,CAAC;QAED,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC5C,CAAC;CACF;AAfD,wCAeC;AAEY,QAAA,QAAQ,GAAiB,IAAA,gCAAmB,EAAC,UAExD,SAAqB;IACrB,OAAO,IAAI,cAAc,CAAa,SAAS,CAAC,CAAA;AAClD,CAAC,CAAC,CAAA","sourcesContent":["import {\n  InferInput,\n  InferOutput,\n  Schema,\n  ValidationContext,\n  Validator,\n} from '../core.js'\nimport { memoizedTransformer } from '../util/memoize.js'\n\nexport class NullableSchema<const TValidator extends Validator> extends Schema<\n  InferInput<TValidator> | null,\n  InferOutput<TValidator> | null\n> {\n  constructor(readonly validator: TValidator) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input === null) {\n      return ctx.success(null)\n    }\n\n    return ctx.validate(input, this.validator)\n  }\n}\n\nexport const nullable = /*#__PURE__*/ memoizedTransformer(function <\n  const TValidator extends Validator,\n>(validator: TValidator) {\n  return new NullableSchema<TValidator>(validator)\n})\n"]}
+{"version":3,"file":"nullable.js","sourceRoot":"","sources":["../../src/schema/nullable.ts"],"names":[],"mappings":";;;AAAA,wCAMmB;AACnB,mDAAwD;AAExD;;;;;;;;;;;;;;GAcG;AACH,MAAa,cAAmD,SAAQ,gBAGvE;IACsB;IAArB,YAAqB,SAAqB;QACxC,KAAK,EAAE,CAAA;QADY,cAAS,GAAT,SAAS,CAAY;IAE1C,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1B,CAAC;QAED,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC5C,CAAC;CACF;AAfD,wCAeC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,QAAQ,GAAiB,IAAA,gCAAmB,EAAC,UAExD,SAAqB;IACrB,OAAO,IAAI,cAAc,CAAa,SAAS,CAAC,CAAA;AAClD,CAAC,CAAC,CAAA","sourcesContent":["import {\n  InferInput,\n  InferOutput,\n  Schema,\n  ValidationContext,\n  Validator,\n} from '../core.js'\nimport { memoizedTransformer } from '../util/memoize.js'\n\n/**\n * Schema wrapper that allows null values in addition to the wrapped schema.\n *\n * When the input is `null`, validation succeeds immediately. Otherwise,\n * the input is validated against the wrapped schema.\n *\n * @template TValidator - The wrapped validator type\n *\n * @example\n * ```ts\n * const schema = new NullableSchema(l.string())\n * schema.validate(null)    // success\n * schema.validate('hello') // success\n * ```\n */\nexport class NullableSchema<const TValidator extends Validator> extends Schema<\n  InferInput<TValidator> | null,\n  InferOutput<TValidator> | null\n> {\n  constructor(readonly validator: TValidator) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (input === null) {\n      return ctx.success(null)\n    }\n\n    return ctx.validate(input, this.validator)\n  }\n}\n\n/**\n * Creates a nullable schema that accepts null in addition to the wrapped type.\n *\n * Wraps another schema to allow null values. Different from `optional()` which\n * allows undefined.\n *\n * @param validator - The validator to make nullable\n * @returns A new {@link NullableSchema} instance\n *\n * @example\n * ```ts\n * // Nullable string\n * const nullableString = l.nullable(l.string())\n * nullableString.parse(null)    // null\n * nullableString.parse('hello') // 'hello'\n *\n * // In an object\n * const userSchema = l.object({\n *   name: l.string(),\n *   deletedAt: l.nullable(l.string({ format: 'datetime' })),\n * })\n *\n * // Combine with optional for null or undefined\n * const maybeString = l.optional(l.nullable(l.string()))\n * ```\n */\nexport const nullable = /*#__PURE__*/ memoizedTransformer(function <\n  const TValidator extends Validator,\n>(validator: TValidator) {\n  return new NullableSchema<TValidator>(validator)\n})\n"]}

package/dist/schema/object.d.ts

@@ -1,5 +1,27 @@
 import { InferInput, InferOutput, Schema, ValidationContext, Validator, WithOptionalProperties } from '../core.js';
+/**
+ * Type representing the shape of an object schema.
+ *
+ * Maps property names to their corresponding validators.
+ */
 export type ObjectSchemaShape = Record<string, Validator>;
+/**
+ * Schema for validating objects with a defined shape.
+ *
+ * Each property in the shape is validated against its corresponding schema.
+ * Properties wrapped in `optional()` are not required.
+ *
+ * @template TShape - The object shape type mapping property names to validators
+ *
+ * @example
+ * ```ts
+ * const schema = new ObjectSchema({
+ *   name: l.string(),
+ *   age: l.optional(l.integer()),
+ * })
+ * const result = schema.validate({ name: 'Alice' })
+ * ```
+ */
 export declare class ObjectSchema<const TShape extends ObjectSchemaShape = any> extends Schema<WithOptionalProperties<{
     [K in keyof TShape]: InferInput<TShape[K]>;
 }>, WithOptionalProperties<{
@@ -10,5 +32,39 @@ export declare class ObjectSchema<const TShape extends ObjectSchemaShape = any>
     get validatorsMap(): Map<string, Validator>;
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Record<string, unknown>>;
 }
+/**
+ * Creates an object schema with the specified property validators.
+ *
+ * Validates that the input is a plain object and each property matches
+ * its corresponding schema. Properties wrapped in `optional()` are not required.
+ *
+ * @param properties - Object mapping property names to their validators
+ * @returns A new {@link ObjectSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic object
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   email: l.string({ format: 'uri' }),
+ * })
+ *
+ * // With optional properties
+ * const profileSchema = l.object({
+ *   displayName: l.string(),
+ *   bio: l.optional(l.string({ maxLength: 256 })),
+ *   avatar: l.optional(l.blob({ accept: ['image/*'] })),
+ * })
+ *
+ * // Nested objects
+ * const postSchema = l.object({
+ *   text: l.string(),
+ *   author: l.object({
+ *     did: l.string({ format: 'did' }),
+ *     handle: l.string({ format: 'handle' }),
+ *   }),
+ * })
+ * ```
+ */
 export declare function object<const TShape extends ObjectSchemaShape>(properties: TShape): ObjectSchema<TShape>;
 //# sourceMappingURL=object.d.ts.map

package/dist/schema/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/schema/object.ts"],"names":[],"mappings":"AACA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,iBAAiB,EACjB,SAAS,EACT,sBAAsB,EACvB,MAAM,YAAY,CAAA;AAGnB,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAEzD,qBAAa,YAAY,CACvB,KAAK,CAAC,MAAM,SAAS,iBAAiB,GAAG,GAAG,CAC5C,SAAQ,MAAM,CACd,sBAAsB,CAAC;KACpB,CAAC,IAAI,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC,EACF,sBAAsB,CAAC;KACpB,CAAC,IAAI,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC,CACH;IACa,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAIlC,IAAI,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAI1C;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAqCzD;AAGD,wBAAgB,MAAM,CAAC,KAAK,CAAC,MAAM,SAAS,iBAAiB,EAC3D,UAAU,EAAE,MAAM,wBAGnB"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/schema/object.ts"],"names":[],"mappings":"AACA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,iBAAiB,EACjB,SAAS,EACT,sBAAsB,EACvB,MAAM,YAAY,CAAA;AAGnB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAEzD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAY,CACvB,KAAK,CAAC,MAAM,SAAS,iBAAiB,GAAG,GAAG,CAC5C,SAAQ,MAAM,CACd,sBAAsB,CAAC;KACpB,CAAC,IAAI,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC,EACF,sBAAsB,CAAC;KACpB,CAAC,IAAI,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC,CACH;IACa,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAIlC,IAAI,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAI1C;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAqCzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,wBAAgB,MAAM,CAAC,KAAK,CAAC,MAAM,SAAS,iBAAiB,EAC3D,UAAU,EAAE,MAAM,wBAGnB"}