@atproto/lex-schema 0.0.10 → 0.0.12

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

@@ -1 +1 @@
-{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../../src/schema/blob.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,aAAa,EAGd,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,CAAA;AAEtC,qBAAa,UAAU,CACrB,KAAK,CAAC,QAAQ,SAAS,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,CAC/D,SAAQ,MAAM,CACd,QAAQ,SAAS;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,CAC3E;IACa,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ;gBAAlB,OAAO,CAAC,EAAE,QAAQ,YAAA;IAIvC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;IA2BxD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAKnC;AAaD,eAAO,MAAM,IAAI,GACf,CAAC,SAAS,iBAAiB;kBAAmB,KAAK;aACzC,CAAC,kBAEX,CAAA"}
+{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../../src/schema/blob.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,aAAa,EAGd,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,CAAA;AAEtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,UAAU,CACrB,KAAK,CAAC,QAAQ,SAAS,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,CAC/D,SAAQ,MAAM,CACd,QAAQ,SAAS;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,CAC3E;IACa,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ;gBAAlB,OAAO,CAAC,EAAE,QAAQ,YAAA;IAIvC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;IA2BxD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAKnC;AAaD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,IAAI,GACf,CAAC,SAAS,iBAAiB;kBAAmB,KAAK;aACzC,CAAC,kBAEX,CAAA"}

package/dist/schema/blob.js

@@ -4,6 +4,21 @@ exports.blob = exports.BlobSchema = void 0;
 const lex_data_1 = require("@atproto/lex-data");
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema for validating blob references in AT Protocol.
+ *
+ * Validates BlobRef objects which contain a CID reference to binary data,
+ * along with metadata like MIME type and size. Can optionally accept
+ * legacy blob reference format.
+ *
+ * @template TOptions - The configuration options type
+ *
+ * @example
+ * ```ts
+ * const schema = new BlobSchema({ accept: ['image/*'], maxSize: 1000000 })
+ * const result = schema.validate(blobRef)
+ * ```
+ */
 class BlobSchema extends core_js_1.Schema {
     options;
     constructor(options) {
@@ -51,6 +66,30 @@ function matchesMime(mime, accepted) {
     }
     return false;
 }
+/**
+ * Creates a blob schema for validating blob references with optional constraints.
+ *
+ * Blob references are used in AT Protocol to reference binary data stored
+ * separately from records. They contain a CID, MIME type, and size information.
+ *
+ * @param options - Optional configuration for MIME type filtering and size limits
+ * @returns A new {@link BlobSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic blob reference
+ * const fileSchema = l.blob()
+ *
+ * // Image files only
+ * const imageSchema = l.blob({ accept: ['image/png', 'image/jpeg', 'image/gif'] })
+ *
+ * // Any image type with size limit
+ * const avatarSchema = l.blob({ accept: ['image/*'], maxSize: 1000000 })
+ *
+ * // Allow legacy format
+ * const legacySchema = l.blob({ allowLegacy: true })
+ * ```
+ */
 exports.blob = (0, memoize_js_1.memoizedOptions)(function (options) {
     return new BlobSchema(options);
 });

package/dist/schema/blob.js.map

@@ -1 +1 @@
-{"version":3,"file":"blob.js","sourceRoot":"","sources":["../../src/schema/blob.ts"],"names":[],"mappings":";;;AAAA,gDAM0B;AAC1B,wCAAsD;AACtD,mDAAoD;AAoBpD,MAAa,UAEX,SAAQ,gBAET;IACsB;IAArB,YAAqB,OAAkB;QACrC,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAW;IAEvC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,MAAM,IAAI,GACP,KAAa,EAAE,KAAK,KAAK,SAAS;YACjC,CAAC,CAAC,IAAA,oBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;gBAC9B,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI;YACR,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,IAAI,IAAA,0BAAe,EAAC,KAAK,CAAC;gBAC5D,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,CAAA;QAEZ,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAA;QACnC,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,CAAA;QAChE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,CAAA;QACrC,IAAI,OAAO,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,CAAC;YAC7D,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAA;QACnC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACxB,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;CACF;AAzCD,gCAyCC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,QAAkB;IACnD,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACzC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IACxC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAEY,QAAA,IAAI,GAAiB,IAAA,4BAAe,EAAC,UAEhD,OAAW;IACX,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC,CAAC,CAAA","sourcesContent":["import {\n  BlobRef,\n  BlobRefCheckOptions,\n  LegacyBlobRef,\n  isBlobRef,\n  isLegacyBlobRef,\n} from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport type BlobSchemaOptions = BlobRefCheckOptions & {\n  /**\n   * Whether to allow legacy blob references format\n   * @see {@link LegacyBlobRef}\n   */\n  allowLegacy?: boolean\n  /**\n   * List of accepted mime types\n   */\n  accept?: string[]\n  /**\n   * Maximum size in bytes\n   */\n  maxSize?: number\n}\n\nexport type { BlobRef, LegacyBlobRef }\n\nexport class BlobSchema<\n  const TOptions extends BlobSchemaOptions = NonNullable<unknown>,\n> extends Schema<\n  TOptions extends { allowLegacy: true } ? BlobRef | LegacyBlobRef : BlobRef\n> {\n  constructor(readonly options?: TOptions) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    const blob: null | BlobRef | LegacyBlobRef =\n      (input as any)?.$type !== undefined\n        ? isBlobRef(input, this.options)\n          ? input\n          : null\n        : this.options?.allowLegacy === true && isLegacyBlobRef(input)\n          ? input\n          : null\n\n    if (!blob) {\n      return ctx.issueInvalidType(input, 'blob')\n    }\n\n    const accept = this.options?.accept\n    if (accept && !matchesMime(blob.mimeType, accept)) {\n      return ctx.issueInvalidPropertyValue(blob, 'mimeType', accept)\n    }\n\n    const maxSize = this.options?.maxSize\n    if (maxSize != null && 'size' in blob && blob.size > maxSize) {\n      return ctx.issueTooBig(blob, 'blob', maxSize, blob.size)\n    }\n\n    return ctx.success(blob)\n  }\n\n  matchesMime(mime: string): boolean {\n    const accept = this.options?.accept\n    if (!accept) return true\n    return matchesMime(mime, accept)\n  }\n}\n\nfunction matchesMime(mime: string, accepted: string[]): boolean {\n  if (accepted.includes('*/*')) return true\n  if (accepted.includes(mime)) return true\n  for (const value of accepted) {\n    if (value.endsWith('/*') && mime.startsWith(value.slice(0, -1))) {\n      return true\n    }\n  }\n  return false\n}\n\nexport const blob = /*#__PURE__*/ memoizedOptions(function <\n  O extends BlobSchemaOptions = { allowLegacy?: false },\n>(options?: O) {\n  return new BlobSchema(options)\n})\n"]}
+{"version":3,"file":"blob.js","sourceRoot":"","sources":["../../src/schema/blob.ts"],"names":[],"mappings":";;;AAAA,gDAM0B;AAC1B,wCAAsD;AACtD,mDAAoD;AA2BpD;;;;;;;;;;;;;;GAcG;AACH,MAAa,UAEX,SAAQ,gBAET;IACsB;IAArB,YAAqB,OAAkB;QACrC,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAW;IAEvC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,MAAM,IAAI,GACP,KAAa,EAAE,KAAK,KAAK,SAAS;YACjC,CAAC,CAAC,IAAA,oBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;gBAC9B,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI;YACR,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,IAAI,IAAA,0BAAe,EAAC,KAAK,CAAC;gBAC5D,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,CAAA;QAEZ,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAA;QACnC,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,CAAA;QAChE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,CAAA;QACrC,IAAI,OAAO,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,CAAC;YAC7D,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,CAAA;QACnC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACxB,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;CACF;AAzCD,gCAyCC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,QAAkB;IACnD,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACzC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IACxC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,IAAI,GAAiB,IAAA,4BAAe,EAAC,UAEhD,OAAW;IACX,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC,CAAC,CAAA","sourcesContent":["import {\n  BlobRef,\n  BlobRefCheckOptions,\n  LegacyBlobRef,\n  isBlobRef,\n  isLegacyBlobRef,\n} from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Configuration options for blob schema validation.\n *\n * @property allowLegacy - Whether to allow legacy blob references format\n * @property accept - List of accepted MIME types (supports wildcards like 'image/*' or '*\\/*')\n * @property maxSize - Maximum blob size in bytes\n */\nexport type BlobSchemaOptions = BlobRefCheckOptions & {\n  /**\n   * Whether to allow legacy blob references format\n   * @see {@link LegacyBlobRef}\n   */\n  allowLegacy?: boolean\n  /**\n   * List of accepted mime types\n   */\n  accept?: string[]\n  /**\n   * Maximum size in bytes\n   */\n  maxSize?: number\n}\n\nexport type { BlobRef, LegacyBlobRef }\n\n/**\n * Schema for validating blob references in AT Protocol.\n *\n * Validates BlobRef objects which contain a CID reference to binary data,\n * along with metadata like MIME type and size. Can optionally accept\n * legacy blob reference format.\n *\n * @template TOptions - The configuration options type\n *\n * @example\n * ```ts\n * const schema = new BlobSchema({ accept: ['image/*'], maxSize: 1000000 })\n * const result = schema.validate(blobRef)\n * ```\n */\nexport class BlobSchema<\n  const TOptions extends BlobSchemaOptions = NonNullable<unknown>,\n> extends Schema<\n  TOptions extends { allowLegacy: true } ? BlobRef | LegacyBlobRef : BlobRef\n> {\n  constructor(readonly options?: TOptions) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    const blob: null | BlobRef | LegacyBlobRef =\n      (input as any)?.$type !== undefined\n        ? isBlobRef(input, this.options)\n          ? input\n          : null\n        : this.options?.allowLegacy === true && isLegacyBlobRef(input)\n          ? input\n          : null\n\n    if (!blob) {\n      return ctx.issueInvalidType(input, 'blob')\n    }\n\n    const accept = this.options?.accept\n    if (accept && !matchesMime(blob.mimeType, accept)) {\n      return ctx.issueInvalidPropertyValue(blob, 'mimeType', accept)\n    }\n\n    const maxSize = this.options?.maxSize\n    if (maxSize != null && 'size' in blob && blob.size > maxSize) {\n      return ctx.issueTooBig(blob, 'blob', maxSize, blob.size)\n    }\n\n    return ctx.success(blob)\n  }\n\n  matchesMime(mime: string): boolean {\n    const accept = this.options?.accept\n    if (!accept) return true\n    return matchesMime(mime, accept)\n  }\n}\n\nfunction matchesMime(mime: string, accepted: string[]): boolean {\n  if (accepted.includes('*/*')) return true\n  if (accepted.includes(mime)) return true\n  for (const value of accepted) {\n    if (value.endsWith('/*') && mime.startsWith(value.slice(0, -1))) {\n      return true\n    }\n  }\n  return false\n}\n\n/**\n * Creates a blob schema for validating blob references with optional constraints.\n *\n * Blob references are used in AT Protocol to reference binary data stored\n * separately from records. They contain a CID, MIME type, and size information.\n *\n * @param options - Optional configuration for MIME type filtering and size limits\n * @returns A new {@link BlobSchema} instance\n *\n * @example\n * ```ts\n * // Basic blob reference\n * const fileSchema = l.blob()\n *\n * // Image files only\n * const imageSchema = l.blob({ accept: ['image/png', 'image/jpeg', 'image/gif'] })\n *\n * // Any image type with size limit\n * const avatarSchema = l.blob({ accept: ['image/*'], maxSize: 1000000 })\n *\n * // Allow legacy format\n * const legacySchema = l.blob({ allowLegacy: true })\n * ```\n */\nexport const blob = /*#__PURE__*/ memoizedOptions(function <\n  O extends BlobSchemaOptions = { allowLegacy?: false },\n>(options?: O) {\n  return new BlobSchema(options)\n})\n"]}

package/dist/schema/boolean.d.ts

@@ -1,6 +1,34 @@
 import { Schema, ValidationContext } from '../core.js';
+/**
+ * Schema for validating boolean values.
+ *
+ * Only accepts JavaScript `true` or `false` values. Does not perform
+ * any coercion from strings or numbers.
+ *
+ * @example
+ * ```ts
+ * const schema = new BooleanSchema()
+ * schema.validate(true)  // success
+ * schema.validate(false) // success
+ * schema.validate('true') // fails - no string coercion
+ * ```
+ */
 export declare class BooleanSchema extends Schema<boolean> {
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<boolean>;
 }
+/**
+ * Creates a boolean schema that validates true/false values.
+ *
+ * @returns A new {@link BooleanSchema} instance
+ *
+ * @example
+ * ```ts
+ * const enabledSchema = l.boolean()
+ *
+ * enabledSchema.parse(true)   // true
+ * enabledSchema.parse(false)  // false
+ * enabledSchema.parse('true') // throws - strings not accepted
+ * ```
+ */
 export declare const boolean: () => BooleanSchema;
 //# sourceMappingURL=boolean.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../src/schema/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,qBAAa,aAAc,SAAQ,MAAM,CAAC,OAAO,CAAC;IAChD,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED,eAAO,MAAM,OAAO,qBAElB,CAAA"}
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../src/schema/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;;;;;;;;;;;;GAaG;AACH,qBAAa,aAAc,SAAQ,MAAM,CAAC,OAAO,CAAC;IAChD,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO,qBAElB,CAAA"}

package/dist/schema/boolean.js

@@ -3,6 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.boolean = exports.BooleanSchema = void 0;
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema for validating boolean values.
+ *
+ * Only accepts JavaScript `true` or `false` values. Does not perform
+ * any coercion from strings or numbers.
+ *
+ * @example
+ * ```ts
+ * const schema = new BooleanSchema()
+ * schema.validate(true)  // success
+ * schema.validate(false) // success
+ * schema.validate('true') // fails - no string coercion
+ * ```
+ */
 class BooleanSchema extends core_js_1.Schema {
     validateInContext(input, ctx) {
         if (typeof input === 'boolean') {
@@ -12,6 +26,20 @@ class BooleanSchema extends core_js_1.Schema {
     }
 }
 exports.BooleanSchema = BooleanSchema;
+/**
+ * Creates a boolean schema that validates true/false values.
+ *
+ * @returns A new {@link BooleanSchema} instance
+ *
+ * @example
+ * ```ts
+ * const enabledSchema = l.boolean()
+ *
+ * enabledSchema.parse(true)   // true
+ * enabledSchema.parse(false)  // false
+ * enabledSchema.parse('true') // throws - strings not accepted
+ * ```
+ */
 exports.boolean = (0, memoize_js_1.memoizedOptions)(function () {
     return new BooleanSchema();
 });

package/dist/schema/boolean.js.map

@@ -1 +1 @@
-{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../src/schema/boolean.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD,MAAa,aAAc,SAAQ,gBAAe;IAChD,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC/C,CAAC;CACF;AARD,sCAQC;AAEY,QAAA,OAAO,GAAiB,IAAA,4BAAe,EAAC;IACnD,OAAO,IAAI,aAAa,EAAE,CAAA;AAC5B,CAAC,CAAC,CAAA","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport class BooleanSchema extends Schema<boolean> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (typeof input === 'boolean') {\n      return ctx.success(input)\n    }\n\n    return ctx.issueInvalidType(input, 'boolean')\n  }\n}\n\nexport const boolean = /*#__PURE__*/ memoizedOptions(function () {\n  return new BooleanSchema()\n})\n"]}
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../src/schema/boolean.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AACtD,mDAAoD;AAEpD;;;;;;;;;;;;;GAaG;AACH,MAAa,aAAc,SAAQ,gBAAe;IAChD,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC/C,CAAC;CACF;AARD,sCAQC;AAED;;;;;;;;;;;;;GAaG;AACU,QAAA,OAAO,GAAiB,IAAA,4BAAe,EAAC;IACnD,OAAO,IAAI,aAAa,EAAE,CAAA;AAC5B,CAAC,CAAC,CAAA","sourcesContent":["import { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Schema for validating boolean values.\n *\n * Only accepts JavaScript `true` or `false` values. Does not perform\n * any coercion from strings or numbers.\n *\n * @example\n * ```ts\n * const schema = new BooleanSchema()\n * schema.validate(true)  // success\n * schema.validate(false) // success\n * schema.validate('true') // fails - no string coercion\n * ```\n */\nexport class BooleanSchema extends Schema<boolean> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (typeof input === 'boolean') {\n      return ctx.success(input)\n    }\n\n    return ctx.issueInvalidType(input, 'boolean')\n  }\n}\n\n/**\n * Creates a boolean schema that validates true/false values.\n *\n * @returns A new {@link BooleanSchema} instance\n *\n * @example\n * ```ts\n * const enabledSchema = l.boolean()\n *\n * enabledSchema.parse(true)   // true\n * enabledSchema.parse(false)  // false\n * enabledSchema.parse('true') // throws - strings not accepted\n * ```\n */\nexport const boolean = /*#__PURE__*/ memoizedOptions(function () {\n  return new BooleanSchema()\n})\n"]}

package/dist/schema/bytes.d.ts

@@ -1,12 +1,50 @@
 import { Schema, ValidationContext } from '../core.js';
+/**
+ * Configuration options for bytes schema validation.
+ *
+ * @property minLength - Minimum length in bytes
+ * @property maxLength - Maximum length in bytes
+ */
 export type BytesSchemaOptions = {
     minLength?: number;
     maxLength?: number;
 };
+/**
+ * Schema for validating binary data as Uint8Array with optional length constraints.
+ *
+ * In "parse" mode, coerces various binary formats (Buffer, ArrayBuffer, etc.)
+ * into Uint8Array. In "validate" mode, only accepts Uint8Array directly.
+ *
+ * @example
+ * ```ts
+ * const schema = new BytesSchema({ maxLength: 1024 })
+ * const result = schema.validate(new Uint8Array([1, 2, 3]))
+ * ```
+ */
 export declare class BytesSchema extends Schema<Uint8Array> {
     readonly options: BytesSchemaOptions;
     constructor(options?: BytesSchemaOptions);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Uint8Array<ArrayBufferLike>>;
 }
+/**
+ * Creates a bytes schema for validating binary data with optional length constraints.
+ *
+ * Validates Uint8Array values and can coerce other binary formats in parse mode.
+ *
+ * @param options - Optional configuration for minimum and maximum byte length
+ * @returns A new {@link BytesSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic bytes schema
+ * const dataSchema = l.bytes()
+ *
+ * // With size constraints
+ * const avatarSchema = l.bytes({ maxLength: 1000000 }) // 1MB max
+ *
+ * // With minimum size
+ * const hashSchema = l.bytes({ minLength: 32, maxLength: 32 }) // Exactly 32 bytes
+ * ```
+ */
 export declare const bytes: (options?: BytesSchemaOptions) => BytesSchema;
 //# sourceMappingURL=bytes.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["../../src/schema/bytes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,qBAAa,WAAY,SAAQ,MAAM,CAAC,UAAU,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,kBAAkB;gBAA3B,OAAO,GAAE,kBAAuB;IAIrD,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAoBzD;AAED,eAAO,MAAM,KAAK,aACN,kBAAkB,gBAG5B,CAAA"}
+{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["../../src/schema/bytes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,MAAM,CAAC,UAAU,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,kBAAkB;gBAA3B,OAAO,GAAE,kBAAuB;IAIrD,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAoBzD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,aACN,kBAAkB,gBAG5B,CAAA"}

package/dist/schema/bytes.js

@@ -4,6 +4,18 @@ exports.bytes = exports.BytesSchema = void 0;
 const lex_data_1 = require("@atproto/lex-data");
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema for validating binary data as Uint8Array with optional length constraints.
+ *
+ * In "parse" mode, coerces various binary formats (Buffer, ArrayBuffer, etc.)
+ * into Uint8Array. In "validate" mode, only accepts Uint8Array directly.
+ *
+ * @example
+ * ```ts
+ * const schema = new BytesSchema({ maxLength: 1024 })
+ * const result = schema.validate(new Uint8Array([1, 2, 3]))
+ * ```
+ */
 class BytesSchema extends core_js_1.Schema {
     options;
     constructor(options = {}) {
@@ -28,6 +40,26 @@ class BytesSchema extends core_js_1.Schema {
     }
 }
 exports.BytesSchema = BytesSchema;
+/**
+ * Creates a bytes schema for validating binary data with optional length constraints.
+ *
+ * Validates Uint8Array values and can coerce other binary formats in parse mode.
+ *
+ * @param options - Optional configuration for minimum and maximum byte length
+ * @returns A new {@link BytesSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic bytes schema
+ * const dataSchema = l.bytes()
+ *
+ * // With size constraints
+ * const avatarSchema = l.bytes({ maxLength: 1000000 }) // 1MB max
+ *
+ * // With minimum size
+ * const hashSchema = l.bytes({ minLength: 32, maxLength: 32 }) // Exactly 32 bytes
+ * ```
+ */
 exports.bytes = (0, memoize_js_1.memoizedOptions)(function (options) {
     return new BytesSchema(options);
 });

package/dist/schema/bytes.js.map

@@ -1 +1 @@
-{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../src/schema/bytes.ts"],"names":[],"mappings":";;;AAAA,gDAA8D;AAC9D,wCAAsD;AACtD,mDAAoD;AAOpD,MAAa,WAAY,SAAQ,gBAAkB;IAC5B;IAArB,YAAqB,UAA8B,EAAE;QACnD,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAyB;IAErD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,mEAAmE;QACnE,MAAM,KAAK,GACT,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAA;QAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAClC,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACnE,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAClC,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACjE,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;CACF;AAzBD,kCAyBC;AAEY,QAAA,KAAK,GAAiB,IAAA,4BAAe,EAAC,UACjD,OAA4B;IAE5B,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC,CAAC,CAAA","sourcesContent":["import { asUint8Array, ifUint8Array } from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport type BytesSchemaOptions = {\n  minLength?: number\n  maxLength?: number\n}\n\nexport class BytesSchema extends Schema<Uint8Array> {\n  constructor(readonly options: BytesSchemaOptions = {}) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    // In \"parse\" mode, coerce different binary formats into Uint8Array\n    const bytes =\n      ctx.options.mode === 'parse' ? asUint8Array(input) : ifUint8Array(input)\n    if (!bytes) {\n      return ctx.issueInvalidType(input, 'bytes')\n    }\n\n    const { minLength } = this.options\n    if (minLength != null && bytes.length < minLength) {\n      return ctx.issueTooSmall(bytes, 'bytes', minLength, bytes.length)\n    }\n\n    const { maxLength } = this.options\n    if (maxLength != null && bytes.length > maxLength) {\n      return ctx.issueTooBig(bytes, 'bytes', maxLength, bytes.length)\n    }\n\n    return ctx.success(bytes)\n  }\n}\n\nexport const bytes = /*#__PURE__*/ memoizedOptions(function (\n  options?: BytesSchemaOptions,\n) {\n  return new BytesSchema(options)\n})\n"]}
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../src/schema/bytes.ts"],"names":[],"mappings":";;;AAAA,gDAA8D;AAC9D,wCAAsD;AACtD,mDAAoD;AAapD;;;;;;;;;;;GAWG;AACH,MAAa,WAAY,SAAQ,gBAAkB;IAC5B;IAArB,YAAqB,UAA8B,EAAE;QACnD,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAyB;IAErD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,mEAAmE;QACnE,MAAM,KAAK,GACT,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAA;QAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAClC,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACnE,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAClC,IAAI,SAAS,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YAClD,OAAO,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACjE,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;CACF;AAzBD,kCAyBC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,KAAK,GAAiB,IAAA,4BAAe,EAAC,UACjD,OAA4B;IAE5B,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC,CAAC,CAAA","sourcesContent":["import { asUint8Array, ifUint8Array } from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Configuration options for bytes schema validation.\n *\n * @property minLength - Minimum length in bytes\n * @property maxLength - Maximum length in bytes\n */\nexport type BytesSchemaOptions = {\n  minLength?: number\n  maxLength?: number\n}\n\n/**\n * Schema for validating binary data as Uint8Array with optional length constraints.\n *\n * In \"parse\" mode, coerces various binary formats (Buffer, ArrayBuffer, etc.)\n * into Uint8Array. In \"validate\" mode, only accepts Uint8Array directly.\n *\n * @example\n * ```ts\n * const schema = new BytesSchema({ maxLength: 1024 })\n * const result = schema.validate(new Uint8Array([1, 2, 3]))\n * ```\n */\nexport class BytesSchema extends Schema<Uint8Array> {\n  constructor(readonly options: BytesSchemaOptions = {}) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    // In \"parse\" mode, coerce different binary formats into Uint8Array\n    const bytes =\n      ctx.options.mode === 'parse' ? asUint8Array(input) : ifUint8Array(input)\n    if (!bytes) {\n      return ctx.issueInvalidType(input, 'bytes')\n    }\n\n    const { minLength } = this.options\n    if (minLength != null && bytes.length < minLength) {\n      return ctx.issueTooSmall(bytes, 'bytes', minLength, bytes.length)\n    }\n\n    const { maxLength } = this.options\n    if (maxLength != null && bytes.length > maxLength) {\n      return ctx.issueTooBig(bytes, 'bytes', maxLength, bytes.length)\n    }\n\n    return ctx.success(bytes)\n  }\n}\n\n/**\n * Creates a bytes schema for validating binary data with optional length constraints.\n *\n * Validates Uint8Array values and can coerce other binary formats in parse mode.\n *\n * @param options - Optional configuration for minimum and maximum byte length\n * @returns A new {@link BytesSchema} instance\n *\n * @example\n * ```ts\n * // Basic bytes schema\n * const dataSchema = l.bytes()\n *\n * // With size constraints\n * const avatarSchema = l.bytes({ maxLength: 1000000 }) // 1MB max\n *\n * // With minimum size\n * const hashSchema = l.bytes({ minLength: 32, maxLength: 32 }) // Exactly 32 bytes\n * ```\n */\nexport const bytes = /*#__PURE__*/ memoizedOptions(function (\n  options?: BytesSchemaOptions,\n) {\n  return new BytesSchema(options)\n})\n"]}

package/dist/schema/cid.d.ts

@@ -1,7 +1,27 @@
 import { CheckCidOptions, Cid, InferCheckedCid } from '@atproto/lex-data';
 import { Schema, ValidationContext } from '../core.js';
 export type { Cid };
+/**
+ * Configuration options for CID schema validation.
+ *
+ * @see CheckCidOptions from @atproto/lex-data for available options
+ */
 export type CidSchemaOptions = CheckCidOptions;
+/**
+ * Schema for validating Content Identifiers (CIDs).
+ *
+ * CIDs are self-describing content-addressed identifiers used in AT Protocol
+ * to reference data by its cryptographic hash. This schema validates that
+ * the input is a valid CID object.
+ *
+ * @template TOptions - The configuration options type
+ *
+ * @example
+ * ```ts
+ * const schema = new CidSchema()
+ * const result = schema.validate(someCid)
+ * ```
+ */
 export declare class CidSchema<const TOptions extends CidSchemaOptions = {
     flavor: undefined;
 }> extends Schema<InferCheckedCid<TOptions>> {
@@ -9,5 +29,23 @@ export declare class CidSchema<const TOptions extends CidSchemaOptions = {
     constructor(options?: TOptions | undefined);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Cid<0 | 1, number, number>>;
 }
+/**
+ * Creates a CID schema for validating Content Identifiers.
+ *
+ * CIDs are used throughout AT Protocol to reference content by its hash.
+ * This is commonly used for referencing blobs, commits, and other data.
+ *
+ * @param options - Optional configuration for CID validation
+ * @returns A new {@link CidSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic CID validation
+ * const cidSchema = l.cid()
+ *
+ * // Validate a CID from a blob reference
+ * const result = cidSchema.validate(blobRef.ref)
+ * ```
+ */
 export declare const cid: <O extends CidSchemaOptions = {}>(options?: O) => CidSchema<O>;
 //# sourceMappingURL=cid.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"cid.d.ts","sourceRoot":"","sources":["../../src/schema/cid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,eAAe,EAAS,MAAM,mBAAmB,CAAA;AAChF,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,YAAY,EAAE,GAAG,EAAE,CAAA;AAEnB,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAE9C,qBAAa,SAAS,CACpB,KAAK,CAAC,QAAQ,SAAS,gBAAgB,GAAG;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CAC/D,SAAQ,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ;gBAAlB,OAAO,CAAC,EAAE,QAAQ,YAAA;IAIvC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED,eAAO,MAAM,GAAG,GACd,CAAC,SAAS,gBAAgB,iBAChB,CAAC,iBAEX,CAAA"}
+{"version":3,"file":"cid.d.ts","sourceRoot":"","sources":["../../src/schema/cid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,eAAe,EAAS,MAAM,mBAAmB,CAAA;AAChF,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD,YAAY,EAAE,GAAG,EAAE,CAAA;AAEnB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAE9C;;;;;;;;;;;;;;GAcG;AACH,qBAAa,SAAS,CACpB,KAAK,CAAC,QAAQ,SAAS,gBAAgB,GAAG;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CAC/D,SAAQ,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ;gBAAlB,OAAO,CAAC,EAAE,QAAQ,YAAA;IAIvC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,GACd,CAAC,SAAS,gBAAgB,iBAChB,CAAC,iBAEX,CAAA"}

package/dist/schema/cid.js

@@ -4,6 +4,21 @@ exports.cid = exports.CidSchema = void 0;
 const lex_data_1 = require("@atproto/lex-data");
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema for validating Content Identifiers (CIDs).
+ *
+ * CIDs are self-describing content-addressed identifiers used in AT Protocol
+ * to reference data by its cryptographic hash. This schema validates that
+ * the input is a valid CID object.
+ *
+ * @template TOptions - The configuration options type
+ *
+ * @example
+ * ```ts
+ * const schema = new CidSchema()
+ * const result = schema.validate(someCid)
+ * ```
+ */
 class CidSchema extends core_js_1.Schema {
     options;
     constructor(options) {
@@ -18,6 +33,24 @@ class CidSchema extends core_js_1.Schema {
     }
 }
 exports.CidSchema = CidSchema;
+/**
+ * Creates a CID schema for validating Content Identifiers.
+ *
+ * CIDs are used throughout AT Protocol to reference content by its hash.
+ * This is commonly used for referencing blobs, commits, and other data.
+ *
+ * @param options - Optional configuration for CID validation
+ * @returns A new {@link CidSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic CID validation
+ * const cidSchema = l.cid()
+ *
+ * // Validate a CID from a blob reference
+ * const result = cidSchema.validate(blobRef.ref)
+ * ```
+ */
 exports.cid = (0, memoize_js_1.memoizedOptions)(function (options) {
     return new CidSchema(options);
 });

package/dist/schema/cid.js.map

@@ -1 +1 @@
-{"version":3,"file":"cid.js","sourceRoot":"","sources":["../../src/schema/cid.ts"],"names":[],"mappings":";;;AAAA,gDAAgF;AAChF,wCAAsD;AACtD,mDAAoD;AAMpD,MAAa,SAEX,SAAQ,gBAAiC;IACpB;IAArB,YAAqB,OAAkB;QACrC,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAW;IAEvC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,gBAAK,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC3C,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;CACF;AAdD,8BAcC;AAEY,QAAA,GAAG,GAAiB,IAAA,4BAAe,EAAC,UAE/C,OAAW;IACX,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;AAC/B,CAAC,CAAC,CAAA","sourcesContent":["import { CheckCidOptions, Cid, InferCheckedCid, isCid } from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport type { Cid }\n\nexport type CidSchemaOptions = CheckCidOptions\n\nexport class CidSchema<\n  const TOptions extends CidSchemaOptions = { flavor: undefined },\n> extends Schema<InferCheckedCid<TOptions>> {\n  constructor(readonly options?: TOptions) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isCid(input, this.options)) {\n      return ctx.issueInvalidType(input, 'cid')\n    }\n\n    return ctx.success(input)\n  }\n}\n\nexport const cid = /*#__PURE__*/ memoizedOptions(function <\n  O extends CidSchemaOptions = NonNullable<unknown>,\n>(options?: O) {\n  return new CidSchema(options)\n})\n"]}
+{"version":3,"file":"cid.js","sourceRoot":"","sources":["../../src/schema/cid.ts"],"names":[],"mappings":";;;AAAA,gDAAgF;AAChF,wCAAsD;AACtD,mDAAoD;AAWpD;;;;;;;;;;;;;;GAcG;AACH,MAAa,SAEX,SAAQ,gBAAiC;IACpB;IAArB,YAAqB,OAAkB;QACrC,KAAK,EAAE,CAAA;QADY,YAAO,GAAP,OAAO,CAAW;IAEvC,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,gBAAK,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC3C,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;CACF;AAdD,8BAcC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,GAAG,GAAiB,IAAA,4BAAe,EAAC,UAE/C,OAAW;IACX,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;AAC/B,CAAC,CAAC,CAAA","sourcesContent":["import { CheckCidOptions, Cid, InferCheckedCid, isCid } from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\nexport type { Cid }\n\n/**\n * Configuration options for CID schema validation.\n *\n * @see CheckCidOptions from @atproto/lex-data for available options\n */\nexport type CidSchemaOptions = CheckCidOptions\n\n/**\n * Schema for validating Content Identifiers (CIDs).\n *\n * CIDs are self-describing content-addressed identifiers used in AT Protocol\n * to reference data by its cryptographic hash. This schema validates that\n * the input is a valid CID object.\n *\n * @template TOptions - The configuration options type\n *\n * @example\n * ```ts\n * const schema = new CidSchema()\n * const result = schema.validate(someCid)\n * ```\n */\nexport class CidSchema<\n  const TOptions extends CidSchemaOptions = { flavor: undefined },\n> extends Schema<InferCheckedCid<TOptions>> {\n  constructor(readonly options?: TOptions) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isCid(input, this.options)) {\n      return ctx.issueInvalidType(input, 'cid')\n    }\n\n    return ctx.success(input)\n  }\n}\n\n/**\n * Creates a CID schema for validating Content Identifiers.\n *\n * CIDs are used throughout AT Protocol to reference content by its hash.\n * This is commonly used for referencing blobs, commits, and other data.\n *\n * @param options - Optional configuration for CID validation\n * @returns A new {@link CidSchema} instance\n *\n * @example\n * ```ts\n * // Basic CID validation\n * const cidSchema = l.cid()\n *\n * // Validate a CID from a blob reference\n * const result = cidSchema.validate(blobRef.ref)\n * ```\n */\nexport const cid = /*#__PURE__*/ memoizedOptions(function <\n  O extends CidSchemaOptions = NonNullable<unknown>,\n>(options?: O) {\n  return new CidSchema(options)\n})\n"]}

package/dist/schema/custom.d.ts

@@ -1,15 +1,80 @@
 import { Issue, PropertyKey, Schema, ValidationContext } from '../core.js';
+/**
+ * Context object provided to custom assertion functions.
+ *
+ * @property path - Current validation path as an array of property keys
+ * @property addIssue - Function to add additional validation issues
+ */
 export type CustomAssertionContext = {
     path: PropertyKey[];
     addIssue(issue: Issue): void;
 };
+/**
+ * Type guard function for custom schema validation.
+ *
+ * @template TValue - The type to validate/narrow to
+ */
 export type CustomAssertion<TValue> = (this: null, input: unknown, ctx: CustomAssertionContext) => input is TValue;
-export declare class CustomSchema<const TValue = unknown> extends Schema<TValue> {
+/**
+ * Schema with a custom validation function.
+ *
+ * Allows defining completely custom validation logic using a type guard
+ * assertion function. The function receives the input and validation context,
+ * and must return whether the input is valid.
+ *
+ * @template TValue - The validated output type
+ *
+ * @example
+ * ```ts
+ * const schema = new CustomSchema(
+ *   (input): input is Date => input instanceof Date,
+ *   'Expected a Date instance'
+ * )
+ * ```
+ */
+export declare class CustomSchema<out TValue = unknown> extends Schema<TValue> {
     private readonly assertion;
     private readonly message;
     private readonly path?;
     constructor(assertion: CustomAssertion<TValue>, message: string, path?: (PropertyKey | readonly PropertyKey[]) | undefined);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<TValue>;
 }
+/**
+ * Creates a custom schema with a user-defined validation function.
+ *
+ * Use this when the built-in schemas don't cover your validation needs.
+ * The assertion function must be a type guard that narrows the input type.
+ *
+ * @param assertion - Type guard function that validates the input
+ * @param message - Error message when validation fails
+ * @param path - Optional path to associate with validation errors
+ * @returns A new {@link CustomSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Validate Date instances
+ * const dateSchema = l.custom(
+ *   (input): input is Date => input instanceof Date && !isNaN(input.getTime()),
+ *   'Expected a valid Date'
+ * )
+ *
+ * // Validate specific object shape
+ * const pointSchema = l.custom(
+ *   (input): input is { x: number; y: number } =>
+ *     typeof input === 'object' &&
+ *     input !== null &&
+ *     typeof (input as any).x === 'number' &&
+ *     typeof (input as any).y === 'number',
+ *   'Expected a point with x and y coordinates'
+ * )
+ *
+ * // With custom path
+ * const validConfig = l.custom(
+ *   (input): input is Config => validateConfig(input),
+ *   'Invalid configuration',
+ *   ['config']
+ * )
+ * ```
+ */
 export declare function custom<TValue>(assertion: CustomAssertion<TValue>, message: string, path?: PropertyKey | readonly PropertyKey[]): CustomSchema<TValue>;
 //# sourceMappingURL=custom.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/schema/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EAEL,WAAW,EACX,MAAM,EACN,iBAAiB,EAClB,MAAM,YAAY,CAAA;AAEnB,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,WAAW,EAAE,CAAA;IACnB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,MAAM,IAAI,CACpC,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,sBAAsB,KACxB,KAAK,IAAI,MAAM,CAAA;AAEpB,qBAAa,YAAY,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAE,SAAQ,MAAM,CAAC,MAAM,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAFL,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,GAAE,WAAW,GAAG,SAAS,WAAW,EAAE,aAAA;IAK9D,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAGD,wBAAgB,MAAM,CAAC,MAAM,EAC3B,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE,wBAG5C"}
+{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/schema/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EAEL,WAAW,EACX,MAAM,EACN,iBAAiB,EAClB,MAAM,YAAY,CAAA;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,WAAW,EAAE,CAAA;IACnB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,IAAI,CACpC,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,sBAAsB,KACxB,KAAK,IAAI,MAAM,CAAA;AAEpB;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAY,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAE,SAAQ,MAAM,CAAC,MAAM,CAAC;IAElE,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAFL,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,GAAE,WAAW,GAAG,SAAS,WAAW,EAAE,aAAA;IAK9D,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,wBAAgB,MAAM,CAAC,MAAM,EAC3B,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE,wBAG5C"}

package/dist/schema/custom.js

@@ -3,6 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomSchema = void 0;
 exports.custom = custom;
 const core_js_1 = require("../core.js");
+/**
+ * Schema with a custom validation function.
+ *
+ * Allows defining completely custom validation logic using a type guard
+ * assertion function. The function receives the input and validation context,
+ * and must return whether the input is valid.
+ *
+ * @template TValue - The validated output type
+ *
+ * @example
+ * ```ts
+ * const schema = new CustomSchema(
+ *   (input): input is Date => input instanceof Date,
+ *   'Expected a Date instance'
+ * )
+ * ```
+ */
 class CustomSchema extends core_js_1.Schema {
     assertion;
     message;
@@ -22,6 +39,43 @@ class CustomSchema extends core_js_1.Schema {
     }
 }
 exports.CustomSchema = CustomSchema;
+/**
+ * Creates a custom schema with a user-defined validation function.
+ *
+ * Use this when the built-in schemas don't cover your validation needs.
+ * The assertion function must be a type guard that narrows the input type.
+ *
+ * @param assertion - Type guard function that validates the input
+ * @param message - Error message when validation fails
+ * @param path - Optional path to associate with validation errors
+ * @returns A new {@link CustomSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Validate Date instances
+ * const dateSchema = l.custom(
+ *   (input): input is Date => input instanceof Date && !isNaN(input.getTime()),
+ *   'Expected a valid Date'
+ * )
+ *
+ * // Validate specific object shape
+ * const pointSchema = l.custom(
+ *   (input): input is { x: number; y: number } =>
+ *     typeof input === 'object' &&
+ *     input !== null &&
+ *     typeof (input as any).x === 'number' &&
+ *     typeof (input as any).y === 'number',
+ *   'Expected a point with x and y coordinates'
+ * )
+ *
+ * // With custom path
+ * const validConfig = l.custom(
+ *   (input): input is Config => validateConfig(input),
+ *   'Invalid configuration',
+ *   ['config']
+ * )
+ * ```
+ */
 /*@__NO_SIDE_EFFECTS__*/
 function custom(assertion, message, path) {
     return new CustomSchema(assertion, message, path);

package/dist/schema/custom.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../src/schema/custom.ts"],"names":[],"mappings":";;;AAsCA,wBAMC;AA5CD,wCAMmB;AAanB,MAAa,YAAqC,SAAQ,gBAAc;IAEnD;IACA;IACA;IAHnB,YACmB,SAAkC,EAClC,OAAe,EACf,IAA2C;QAE5D,KAAK,EAAE,CAAA;QAJU,cAAS,GAAT,SAAS,CAAyB;QAClC,YAAO,GAAP,OAAO,CAAQ;QACf,SAAI,GAAJ,IAAI,CAAuC;IAG9D,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACtC,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,qBAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,GAAG,CAAC,OAAO,CAAC,KAAe,CAAC,CAAA;IACrC,CAAC;CACF;AAhBD,oCAgBC;AAED,wBAAwB;AACxB,SAAgB,MAAM,CACpB,SAAkC,EAClC,OAAe,EACf,IAA2C;IAE3C,OAAO,IAAI,YAAY,CAAS,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;AAC3D,CAAC","sourcesContent":["import {\n  Issue,\n  IssueCustom,\n  PropertyKey,\n  Schema,\n  ValidationContext,\n} from '../core.js'\n\nexport type CustomAssertionContext = {\n  path: PropertyKey[]\n  addIssue(issue: Issue): void\n}\n\nexport type CustomAssertion<TValue> = (\n  this: null,\n  input: unknown,\n  ctx: CustomAssertionContext,\n) => input is TValue\n\nexport class CustomSchema<const TValue = unknown> extends Schema<TValue> {\n  constructor(\n    private readonly assertion: CustomAssertion<TValue>,\n    private readonly message: string,\n    private readonly path?: PropertyKey | readonly PropertyKey[],\n  ) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!this.assertion.call(null, input, ctx)) {\n      const path = ctx.concatPath(this.path)\n      return ctx.issue(new IssueCustom(path, input, this.message))\n    }\n    return ctx.success(input as TValue)\n  }\n}\n\n/*@__NO_SIDE_EFFECTS__*/\nexport function custom<TValue>(\n  assertion: CustomAssertion<TValue>,\n  message: string,\n  path?: PropertyKey | readonly PropertyKey[],\n) {\n  return new CustomSchema<TValue>(assertion, message, path)\n}\n"]}
+{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../src/schema/custom.ts"],"names":[],"mappings":";;;AAuGA,wBAMC;AA7GD,wCAMmB;AAwBnB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAAmC,SAAQ,gBAAc;IAEjD;IACA;IACA;IAHnB,YACmB,SAAkC,EAClC,OAAe,EACf,IAA2C;QAE5D,KAAK,EAAE,CAAA;QAJU,cAAS,GAAT,SAAS,CAAyB;QAClC,YAAO,GAAP,OAAO,CAAQ;QACf,SAAI,GAAJ,IAAI,CAAuC;IAG9D,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACtC,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,qBAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,GAAG,CAAC,OAAO,CAAC,KAAe,CAAC,CAAA;IACrC,CAAC;CACF;AAhBD,oCAgBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAwB;AACxB,SAAgB,MAAM,CACpB,SAAkC,EAClC,OAAe,EACf,IAA2C;IAE3C,OAAO,IAAI,YAAY,CAAS,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;AAC3D,CAAC","sourcesContent":["import {\n  Issue,\n  IssueCustom,\n  PropertyKey,\n  Schema,\n  ValidationContext,\n} from '../core.js'\n\n/**\n * Context object provided to custom assertion functions.\n *\n * @property path - Current validation path as an array of property keys\n * @property addIssue - Function to add additional validation issues\n */\nexport type CustomAssertionContext = {\n  path: PropertyKey[]\n  addIssue(issue: Issue): void\n}\n\n/**\n * Type guard function for custom schema validation.\n *\n * @template TValue - The type to validate/narrow to\n */\nexport type CustomAssertion<TValue> = (\n  this: null,\n  input: unknown,\n  ctx: CustomAssertionContext,\n) => input is TValue\n\n/**\n * Schema with a custom validation function.\n *\n * Allows defining completely custom validation logic using a type guard\n * assertion function. The function receives the input and validation context,\n * and must return whether the input is valid.\n *\n * @template TValue - The validated output type\n *\n * @example\n * ```ts\n * const schema = new CustomSchema(\n *   (input): input is Date => input instanceof Date,\n *   'Expected a Date instance'\n * )\n * ```\n */\nexport class CustomSchema<out TValue = unknown> extends Schema<TValue> {\n  constructor(\n    private readonly assertion: CustomAssertion<TValue>,\n    private readonly message: string,\n    private readonly path?: PropertyKey | readonly PropertyKey[],\n  ) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!this.assertion.call(null, input, ctx)) {\n      const path = ctx.concatPath(this.path)\n      return ctx.issue(new IssueCustom(path, input, this.message))\n    }\n    return ctx.success(input as TValue)\n  }\n}\n\n/**\n * Creates a custom schema with a user-defined validation function.\n *\n * Use this when the built-in schemas don't cover your validation needs.\n * The assertion function must be a type guard that narrows the input type.\n *\n * @param assertion - Type guard function that validates the input\n * @param message - Error message when validation fails\n * @param path - Optional path to associate with validation errors\n * @returns A new {@link CustomSchema} instance\n *\n * @example\n * ```ts\n * // Validate Date instances\n * const dateSchema = l.custom(\n *   (input): input is Date => input instanceof Date && !isNaN(input.getTime()),\n *   'Expected a valid Date'\n * )\n *\n * // Validate specific object shape\n * const pointSchema = l.custom(\n *   (input): input is { x: number; y: number } =>\n *     typeof input === 'object' &&\n *     input !== null &&\n *     typeof (input as any).x === 'number' &&\n *     typeof (input as any).y === 'number',\n *   'Expected a point with x and y coordinates'\n * )\n *\n * // With custom path\n * const validConfig = l.custom(\n *   (input): input is Config => validateConfig(input),\n *   'Invalid configuration',\n *   ['config']\n * )\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function custom<TValue>(\n  assertion: CustomAssertion<TValue>,\n  message: string,\n  path?: PropertyKey | readonly PropertyKey[],\n) {\n  return new CustomSchema<TValue>(assertion, message, path)\n}\n"]}

package/dist/schema/dict.d.ts

@@ -1,8 +1,23 @@
 import { InferInput, InferOutput, Schema, ValidationContext, Validator } from '../core.js';
 /**
+ * Schema for validating dictionary/map-like objects with dynamic keys.
+ *
+ * Unlike `ObjectSchema` which validates a fixed set of properties, `DictSchema`
+ * validates objects where any string key is allowed, with both keys and values
+ * validated against their respective schemas.
+ *
  * @note There is no dictionary in Lexicon schemas. This is a custom extension
  * to allow map-like objects when using the lex library programmatically (i.e.
  * not code generated from a lexicon schema).
+ *
+ * @template TKey - The validator type for dictionary keys (must validate strings)
+ * @template TValue - The validator type for dictionary values
+ *
+ * @example
+ * ```ts
+ * const schema = new DictSchema(l.string(), l.integer())
+ * const result = schema.validate({ a: 1, b: 2, c: 3 })
+ * ```
  */
 export declare class DictSchema<const TKey extends Validator<string> = any, const TValue extends Validator = any> extends Schema<Record<InferInput<TKey>, InferInput<TValue>>, Record<InferInput<TKey>, InferOutput<TValue>>> {
     readonly keySchema: TKey;
@@ -14,5 +29,34 @@ export declare class DictSchema<const TKey extends Validator<string> = any, cons
         };
     }): import("../core.js").ValidationResult<Record<string, unknown>>;
 }
+/**
+ * Creates a dictionary schema for validating map-like objects.
+ *
+ * Validates objects where all keys match the key schema and all values
+ * match the value schema. Useful for dynamic key-value mappings.
+ *
+ * @param key - Schema to validate each key (must be a string validator)
+ * @param value - Schema to validate each value
+ * @returns A new {@link DictSchema} instance
+ *
+ * @example
+ * ```ts
+ * // String to number mapping
+ * const scoresSchema = l.dict(l.string(), l.integer())
+ * scoresSchema.parse({ alice: 100, bob: 85 })
+ *
+ * // Constrained keys
+ * const langSchema = l.dict(
+ *   l.string({ minLength: 2, maxLength: 5 }), // Language codes
+ *   l.string() // Translations
+ * )
+ *
+ * // Complex values
+ * const usersById = l.dict(
+ *   l.string({ format: 'did' }),
+ *   l.object({ name: l.string(), age: l.integer() })
+ * )
+ * ```
+ */
 export declare function dict<const TKey extends Validator<string>, const TValue extends Validator>(key: TKey, value: TValue): DictSchema<TKey, TValue>;
 //# sourceMappingURL=dict.d.ts.map