@atproto/lex-schema 0.0.12 → 0.0.14

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;;;;;;;;;;;;;;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"]}
+{"version":3,"file":"nullable.js","sourceRoot":"","sources":["../../src/schema/nullable.ts"],"names":[],"mappings":";;;AAAA,wCAMmB;AACnB,mDAAwD;AAExD;;;;;;;;;;;;;;GAcG;AACH,MAAa,cAAmD,SAAQ,gBAGvE;IAGsB;IAFZ,IAAI,GAAG,UAAmB,CAAA;IAEnC,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;AAjBD,wCAiBC;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  readonly type = 'nullable' as const\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

@@ -28,6 +28,7 @@ export declare class ObjectSchema<const TShape extends ObjectSchemaShape = any>
     [K in keyof TShape]: InferOutput<TShape[K]>;
 }>> {
     readonly shape: TShape;
+    readonly type: "object";
     constructor(shape: TShape);
     get validatorsMap(): Map<string, Validator>;
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Record<string, unknown>>;

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;;;;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"}
+{"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;IAGa,QAAQ,CAAC,KAAK,EAAE,MAAM;IAFlC,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;gBAEZ,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"}

package/dist/schema/object.js

@@ -24,6 +24,7 @@ const lazy_property_js_1 = require("../util/lazy-property.js");
  */
 class ObjectSchema extends core_js_1.Schema {
     shape;
+    type = 'object';
     constructor(shape) {
         super();
         this.shape = shape;
@@ -34,7 +35,7 @@ class ObjectSchema extends core_js_1.Schema {
     }
     validateInContext(input, ctx) {
         if (!(0, lex_data_1.isPlainObject)(input)) {
-            return ctx.issueInvalidType(input, 'object');
+            return ctx.issueUnexpectedType(input, 'object');
         }
         // Lazily copy value
         let copy;

package/dist/schema/object.js.map

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/schema/object.ts"],"names":[],"mappings":";;;AAiIA,wBAIC;AArID,gDAAiD;AACjD,wCAOmB;AACnB,+DAAuD;AASvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAEX,SAAQ,gBAOT;IACsB;IAArB,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,IAAI,aAAa;QACf,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/C,OAAO,IAAA,+BAAY,EAAC,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,CAAA;IACjD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,oBAAoB;QACpB,IAAI,IAAyC,CAAA;QAE7C,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;oBACpB,sCAAsC;oBACtC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACzC,CAAC;gBAED,OAAO,MAAM,CAAA;YACf,CAAC;YAED,uEAAuE;YACvE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;gBAClD,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,CAAA;IACnC,CAAC;CACF;AAzDD,oCAyDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAwB;AACxB,SAAgB,MAAM,CACpB,UAAkB;IAElB,OAAO,IAAI,YAAY,CAAS,UAAU,CAAC,CAAA;AAC7C,CAAC","sourcesContent":["import { isPlainObject } from '@atproto/lex-data'\nimport {\n  InferInput,\n  InferOutput,\n  Schema,\n  ValidationContext,\n  Validator,\n  WithOptionalProperties,\n} from '../core.js'\nimport { lazyProperty } from '../util/lazy-property.js'\n\n/**\n * Type representing the shape of an object schema.\n *\n * Maps property names to their corresponding validators.\n */\nexport type ObjectSchemaShape = Record<string, Validator>\n\n/**\n * Schema for validating objects with a defined shape.\n *\n * Each property in the shape is validated against its corresponding schema.\n * Properties wrapped in `optional()` are not required.\n *\n * @template TShape - The object shape type mapping property names to validators\n *\n * @example\n * ```ts\n * const schema = new ObjectSchema({\n *   name: l.string(),\n *   age: l.optional(l.integer()),\n * })\n * const result = schema.validate({ name: 'Alice' })\n * ```\n */\nexport class ObjectSchema<\n  const TShape extends ObjectSchemaShape = any,\n> extends Schema<\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferInput<TShape[K]>\n  }>,\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferOutput<TShape[K]>\n  }>\n> {\n  constructor(readonly shape: TShape) {\n    super()\n  }\n\n  get validatorsMap(): Map<string, Validator> {\n    const map = new Map(Object.entries(this.shape))\n\n    return lazyProperty(this, 'validatorsMap', map)\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isPlainObject(input)) {\n      return ctx.issueInvalidType(input, 'object')\n    }\n\n    // Lazily copy value\n    let copy: undefined | Record<string, unknown>\n\n    for (const [key, propDef] of this.validatorsMap) {\n      const result = ctx.validateChild(input, key, propDef)\n      if (!result.success) {\n        if (!(key in input)) {\n          // Transform into \"required key\" issue\n          return ctx.issueRequiredKey(input, key)\n        }\n\n        return result\n      }\n\n      // Skip copying if key is not present in input (and value is undefined)\n      if (result.value === undefined && !(key in input)) {\n        continue\n      }\n\n      if (!Object.is(result.value, input[key])) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    return ctx.success(copy ?? input)\n  }\n}\n\n/**\n * Creates an object schema with the specified property validators.\n *\n * Validates that the input is a plain object and each property matches\n * its corresponding schema. Properties wrapped in `optional()` are not required.\n *\n * @param properties - Object mapping property names to their validators\n * @returns A new {@link ObjectSchema} instance\n *\n * @example\n * ```ts\n * // Basic object\n * const userSchema = l.object({\n *   name: l.string(),\n *   email: l.string({ format: 'uri' }),\n * })\n *\n * // With optional properties\n * const profileSchema = l.object({\n *   displayName: l.string(),\n *   bio: l.optional(l.string({ maxLength: 256 })),\n *   avatar: l.optional(l.blob({ accept: ['image/*'] })),\n * })\n *\n * // Nested objects\n * const postSchema = l.object({\n *   text: l.string(),\n *   author: l.object({\n *     did: l.string({ format: 'did' }),\n *     handle: l.string({ format: 'handle' }),\n *   }),\n * })\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function object<const TShape extends ObjectSchemaShape>(\n  properties: TShape,\n) {\n  return new ObjectSchema<TShape>(properties)\n}\n"]}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/schema/object.ts"],"names":[],"mappings":";;;AAmIA,wBAIC;AAvID,gDAAiD;AACjD,wCAOmB;AACnB,+DAAuD;AASvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAEX,SAAQ,gBAOT;IAGsB;IAFZ,IAAI,GAAG,QAAiB,CAAA;IAEjC,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,IAAI,aAAa;QACf,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/C,OAAO,IAAA,+BAAY,EAAC,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,CAAA;IACjD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACjD,CAAC;QAED,oBAAoB;QACpB,IAAI,IAAyC,CAAA;QAE7C,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;oBACpB,sCAAsC;oBACtC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACzC,CAAC;gBAED,OAAO,MAAM,CAAA;YACf,CAAC;YAED,uEAAuE;YACvE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;gBAClD,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,CAAA;IACnC,CAAC;CACF;AA3DD,oCA2DC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAwB;AACxB,SAAgB,MAAM,CACpB,UAAkB;IAElB,OAAO,IAAI,YAAY,CAAS,UAAU,CAAC,CAAA;AAC7C,CAAC","sourcesContent":["import { isPlainObject } from '@atproto/lex-data'\nimport {\n  InferInput,\n  InferOutput,\n  Schema,\n  ValidationContext,\n  Validator,\n  WithOptionalProperties,\n} from '../core.js'\nimport { lazyProperty } from '../util/lazy-property.js'\n\n/**\n * Type representing the shape of an object schema.\n *\n * Maps property names to their corresponding validators.\n */\nexport type ObjectSchemaShape = Record<string, Validator>\n\n/**\n * Schema for validating objects with a defined shape.\n *\n * Each property in the shape is validated against its corresponding schema.\n * Properties wrapped in `optional()` are not required.\n *\n * @template TShape - The object shape type mapping property names to validators\n *\n * @example\n * ```ts\n * const schema = new ObjectSchema({\n *   name: l.string(),\n *   age: l.optional(l.integer()),\n * })\n * const result = schema.validate({ name: 'Alice' })\n * ```\n */\nexport class ObjectSchema<\n  const TShape extends ObjectSchemaShape = any,\n> extends Schema<\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferInput<TShape[K]>\n  }>,\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferOutput<TShape[K]>\n  }>\n> {\n  readonly type = 'object' as const\n\n  constructor(readonly shape: TShape) {\n    super()\n  }\n\n  get validatorsMap(): Map<string, Validator> {\n    const map = new Map(Object.entries(this.shape))\n\n    return lazyProperty(this, 'validatorsMap', map)\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isPlainObject(input)) {\n      return ctx.issueUnexpectedType(input, 'object')\n    }\n\n    // Lazily copy value\n    let copy: undefined | Record<string, unknown>\n\n    for (const [key, propDef] of this.validatorsMap) {\n      const result = ctx.validateChild(input, key, propDef)\n      if (!result.success) {\n        if (!(key in input)) {\n          // Transform into \"required key\" issue\n          return ctx.issueRequiredKey(input, key)\n        }\n\n        return result\n      }\n\n      // Skip copying if key is not present in input (and value is undefined)\n      if (result.value === undefined && !(key in input)) {\n        continue\n      }\n\n      if (!Object.is(result.value, input[key])) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    return ctx.success(copy ?? input)\n  }\n}\n\n/**\n * Creates an object schema with the specified property validators.\n *\n * Validates that the input is a plain object and each property matches\n * its corresponding schema. Properties wrapped in `optional()` are not required.\n *\n * @param properties - Object mapping property names to their validators\n * @returns A new {@link ObjectSchema} instance\n *\n * @example\n * ```ts\n * // Basic object\n * const userSchema = l.object({\n *   name: l.string(),\n *   email: l.string({ format: 'uri' }),\n * })\n *\n * // With optional properties\n * const profileSchema = l.object({\n *   displayName: l.string(),\n *   bio: l.optional(l.string({ maxLength: 256 })),\n *   avatar: l.optional(l.blob({ accept: ['image/*'] })),\n * })\n *\n * // Nested objects\n * const postSchema = l.object({\n *   text: l.string(),\n *   author: l.object({\n *     did: l.string({ format: 'did' }),\n *     handle: l.string({ format: 'handle' }),\n *   }),\n * })\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function object<const TShape extends ObjectSchemaShape>(\n  properties: TShape,\n) {\n  return new ObjectSchema<TShape>(properties)\n}\n"]}

package/dist/schema/optional.d.ts

@@ -18,6 +18,7 @@ import { WithDefaultSchema } from './with-default.js';
  */
 export declare class OptionalSchema<TValidator extends Validator> extends Schema<InferInput<TValidator> | undefined, UnwrapValidator<TValidator> extends WithDefaultSchema<infer TValidator> ? InferOutput<TValidator> : InferOutput<TValidator> | undefined> {
     readonly validator: TValidator;
+    readonly type: "optional";
     constructor(validator: TValidator);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<undefined> | import("../core.js").ValidationSuccess<InferInput<TValidator>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"optional.d.ts","sourceRoot":"","sources":["../../src/schema/optional.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,eAAe,EACf,iBAAiB,EACjB,SAAS,EACV,MAAM,YAAY,CAAA;AAEnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAc,CAAC,UAAU,SAAS,SAAS,CAAE,SAAQ,MAAM,CACtE,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,EAClC,eAAe,CAAC,UAAU,CAAC,SAAS,iBAAiB,CAAC,MAAM,UAAU,CAAC,GACnE,WAAW,CAAC,UAAU,CAAC,GACvB,WAAW,CAAC,UAAU,CAAC,GAAG,SAAS,CACxC;IACa,QAAQ,CAAC,SAAS,EAAE,UAAU;gBAArB,SAAS,EAAE,UAAU;IAI1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAoBzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,QAAQ,SACb,UAAU,SAAS,SAAS,aACvB,UAAU,+BAErB,CAAA"}
+{"version":3,"file":"optional.d.ts","sourceRoot":"","sources":["../../src/schema/optional.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,eAAe,EACf,iBAAiB,EACjB,SAAS,EACV,MAAM,YAAY,CAAA;AAEnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAc,CAAC,UAAU,SAAS,SAAS,CAAE,SAAQ,MAAM,CACtE,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,EAClC,eAAe,CAAC,UAAU,CAAC,SAAS,iBAAiB,CAAC,MAAM,UAAU,CAAC,GACnE,WAAW,CAAC,UAAU,CAAC,GACvB,WAAW,CAAC,UAAU,CAAC,GAAG,SAAS,CACxC;IAGa,QAAQ,CAAC,SAAS,EAAE,UAAU;IAF1C,QAAQ,CAAC,IAAI,EAAG,UAAU,CAAS;gBAEd,SAAS,EAAE,UAAU;IAI1C,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAoBzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,QAAQ,SACb,UAAU,SAAS,SAAS,aACvB,UAAU,+BAErB,CAAA"}

package/dist/schema/optional.js

@@ -21,6 +21,7 @@ const memoize_js_1 = require("../util/memoize.js");
  */
 class OptionalSchema extends core_js_1.Schema {
     validator;
+    type = 'optional';
     constructor(validator) {
         super();
         this.validator = validator;

package/dist/schema/optional.js.map

@@ -1 +1 @@
-{"version":3,"file":"optional.js","sourceRoot":"","sources":["../../src/schema/optional.ts"],"names":[],"mappings":";;;AAAA,wCAOmB;AACnB,mDAAwD;AAGxD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,cAA6C,SAAQ,gBAKjE;IACsB;IAArB,YAAqB,SAAqB;QACxC,KAAK,EAAE,CAAA;QADY,cAAS,GAAT,SAAS,CAAY;IAE1C,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,0EAA0E;QAC1E,IAAI,KAAK,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,0EAA0E;QAC1E,8BAA8B;QAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QAElD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AA9BD,wCA8BC;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  UnwrapValidator,\n  ValidationContext,\n  Validator,\n} from '../core.js'\nimport { memoizedTransformer } from '../util/memoize.js'\nimport { WithDefaultSchema } from './with-default.js'\n\n/**\n * Schema wrapper that makes a value optional (allows undefined).\n *\n * When the input is `undefined`, validation succeeds without running the\n * inner validator. If the inner validator has a default value (via `withDefault`),\n * that default will be applied in parse mode.\n *\n * @template TValidator - The wrapped validator type\n *\n * @example\n * ```ts\n * const schema = new OptionalSchema(l.string())\n * schema.validate(undefined) // success\n * schema.validate('hello')   // success\n * ```\n */\nexport class OptionalSchema<TValidator extends Validator> extends Schema<\n  InferInput<TValidator> | undefined,\n  UnwrapValidator<TValidator> extends WithDefaultSchema<infer TValidator>\n    ? InferOutput<TValidator>\n    : InferOutput<TValidator> | undefined\n> {\n  constructor(readonly validator: TValidator) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    // Optimization: No need to apply child schema defaults in validation mode\n    if (input === undefined && ctx.options.mode === 'validate') {\n      return ctx.success(input)\n    }\n\n    // @NOTE The inner schema might apply a default value so we need to run it\n    // even if input is undefined.\n    const result = ctx.validate(input, this.validator)\n\n    if (result.success) {\n      return result\n    }\n\n    if (input === undefined) {\n      return ctx.success(input)\n    }\n\n    return result\n  }\n}\n\n/**\n * Creates an optional schema that allows undefined values.\n *\n * Wraps another schema to make it optional. When used in an object schema,\n * properties with optional schemas are not required.\n *\n * @param validator - The validator to make optional\n * @returns A new {@link OptionalSchema} instance\n *\n * @example\n * ```ts\n * // Optional string\n * const optionalBio = l.optional(l.string())\n *\n * // In an object - property is not required\n * const userSchema = l.object({\n *   name: l.string(),\n *   bio: l.optional(l.string()),\n * })\n * userSchema.parse({ name: 'Alice' }) // Valid, bio is undefined\n *\n * // With default value\n * const countSchema = l.optional(l.withDefault(l.integer(), 0))\n * countSchema.parse(undefined) // Returns 0\n * ```\n */\nexport const optional = /*#__PURE__*/ memoizedTransformer(function <\n  const TValidator extends Validator,\n>(validator: TValidator) {\n  return new OptionalSchema<TValidator>(validator)\n})\n"]}
+{"version":3,"file":"optional.js","sourceRoot":"","sources":["../../src/schema/optional.ts"],"names":[],"mappings":";;;AAAA,wCAOmB;AACnB,mDAAwD;AAGxD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,cAA6C,SAAQ,gBAKjE;IAGsB;IAFZ,IAAI,GAAG,UAAmB,CAAA;IAEnC,YAAqB,SAAqB;QACxC,KAAK,EAAE,CAAA;QADY,cAAS,GAAT,SAAS,CAAY;IAE1C,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,0EAA0E;QAC1E,IAAI,KAAK,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,0EAA0E;QAC1E,8BAA8B;QAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QAElD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAhCD,wCAgCC;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  UnwrapValidator,\n  ValidationContext,\n  Validator,\n} from '../core.js'\nimport { memoizedTransformer } from '../util/memoize.js'\nimport { WithDefaultSchema } from './with-default.js'\n\n/**\n * Schema wrapper that makes a value optional (allows undefined).\n *\n * When the input is `undefined`, validation succeeds without running the\n * inner validator. If the inner validator has a default value (via `withDefault`),\n * that default will be applied in parse mode.\n *\n * @template TValidator - The wrapped validator type\n *\n * @example\n * ```ts\n * const schema = new OptionalSchema(l.string())\n * schema.validate(undefined) // success\n * schema.validate('hello')   // success\n * ```\n */\nexport class OptionalSchema<TValidator extends Validator> extends Schema<\n  InferInput<TValidator> | undefined,\n  UnwrapValidator<TValidator> extends WithDefaultSchema<infer TValidator>\n    ? InferOutput<TValidator>\n    : InferOutput<TValidator> | undefined\n> {\n  readonly type = 'optional' as const\n\n  constructor(readonly validator: TValidator) {\n    super()\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    // Optimization: No need to apply child schema defaults in validation mode\n    if (input === undefined && ctx.options.mode === 'validate') {\n      return ctx.success(input)\n    }\n\n    // @NOTE The inner schema might apply a default value so we need to run it\n    // even if input is undefined.\n    const result = ctx.validate(input, this.validator)\n\n    if (result.success) {\n      return result\n    }\n\n    if (input === undefined) {\n      return ctx.success(input)\n    }\n\n    return result\n  }\n}\n\n/**\n * Creates an optional schema that allows undefined values.\n *\n * Wraps another schema to make it optional. When used in an object schema,\n * properties with optional schemas are not required.\n *\n * @param validator - The validator to make optional\n * @returns A new {@link OptionalSchema} instance\n *\n * @example\n * ```ts\n * // Optional string\n * const optionalBio = l.optional(l.string())\n *\n * // In an object - property is not required\n * const userSchema = l.object({\n *   name: l.string(),\n *   bio: l.optional(l.string()),\n * })\n * userSchema.parse({ name: 'Alice' }) // Valid, bio is undefined\n *\n * // With default value\n * const countSchema = l.optional(l.withDefault(l.integer(), 0))\n * countSchema.parse(undefined) // Returns 0\n * ```\n */\nexport const optional = /*#__PURE__*/ memoizedTransformer(function <\n  const TValidator extends Validator,\n>(validator: TValidator) {\n  return new OptionalSchema<TValidator>(validator)\n})\n"]}

package/dist/schema/params.d.ts

@@ -1,7 +1,9 @@
-import { Infer, InferInput, InferOutput, Schema, ValidationContext, WithOptionalProperties } from '../core.js';
+import { Infer, InferInput, InferOutput, ParseOptions, Schema, ValidationContext, Validator, WithOptionalProperties } from '../core.js';
 import { ArraySchema } from './array.js';
 import { BooleanSchema } from './boolean.js';
+import { EnumSchema } from './enum.js';
 import { IntegerSchema } from './integer.js';
+import { LiteralSchema } from './literal.js';
 import { OptionalSchema } from './optional.js';
 import { StringSchema } from './string.js';
 import { WithDefaultSchema } from './with-default.js';
@@ -17,7 +19,7 @@ export type Param = Infer<typeof paramSchema>;
 /**
  * Schema for validating individual parameter values.
  */
-export declare const paramSchema: import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>, ArraySchema<import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>>]>;
+export declare const paramSchema: import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>, ArraySchema<BooleanSchema>, ArraySchema<IntegerSchema>, ArraySchema<StringSchema<{}>>]>;
 /**
  * Type for a params object with string keys and optional param values.
  */
@@ -25,16 +27,17 @@ export type Params = Infer<typeof paramsSchema>;
 /**
  * Schema for validating arbitrary params objects.
  */
-export declare const paramsSchema: import("./dict.js").DictSchema<StringSchema<{}>, OptionalSchema<import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>, ArraySchema<import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>>]>>>;
-type ParamScalarValidator = StringSchema | BooleanSchema | IntegerSchema;
-type ParamValueValidator = ParamScalarValidator | ArraySchema<ParamScalarValidator>;
-type ParamValidator = ParamValueValidator | OptionalSchema<ParamValueValidator> | OptionalSchema<WithDefaultSchema<ParamValueValidator>> | WithDefaultSchema<ParamValueValidator>;
+export declare const paramsSchema: import("./dict.js").DictSchema<StringSchema<{}>, OptionalSchema<import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>, ArraySchema<BooleanSchema>, ArraySchema<IntegerSchema>, ArraySchema<StringSchema<{}>>]>>>;
+export type ParamScalarValidator = LiteralSchema<string> | LiteralSchema<number> | LiteralSchema<boolean> | EnumSchema<string> | EnumSchema<number> | StringSchema<any> | BooleanSchema | IntegerSchema;
+type AsArrayParamSchema<TSchema extends Validator> = TSchema extends any ? ArraySchema<TSchema> : never;
+export type ParamValueValidator = ParamScalarValidator | AsArrayParamSchema<ParamScalarValidator>;
+export type ParamValidator = ParamValueValidator | OptionalSchema<ParamValueValidator> | OptionalSchema<WithDefaultSchema<ParamValueValidator>> | WithDefaultSchema<ParamValueValidator>;
 /**
  * Type representing the shape of a params schema definition.
  *
  * Maps parameter names to their validators (must be Param or undefined).
  */
-export type ParamsSchemaShape = {
+export type ParamsShape = {
     [x: string]: ParamValidator;
 };
 /**
@@ -56,16 +59,17 @@ export type ParamsSchemaShape = {
  * })
  * ```
  */
-export declare class ParamsSchema<const TShape extends ParamsSchemaShape = ParamsSchemaShape> extends Schema<WithOptionalProperties<{
+export declare class ParamsSchema<const TShape extends ParamsShape = ParamsShape> extends Schema<WithOptionalProperties<{
     [K in keyof TShape]: InferInput<TShape[K]>;
 }>, WithOptionalProperties<{
     [K in keyof TShape]: InferOutput<TShape[K]>;
 }>> {
     readonly shape: TShape;
+    readonly type: "params";
     constructor(shape: TShape);
     get shapeValidators(): Map<string, ParamValidator>;
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Record<string, unknown>>;
-    fromURLSearchParams(iterable: Iterable<[string, string]>): InferOutput<this>;
+    fromURLSearchParams(input: string | Iterable<[string, string]>, options?: ParseOptions): InferOutput<this>;
     toURLSearchParams(input: InferInput<this>): URLSearchParams;
 }
 /**
@@ -103,6 +107,6 @@ export declare class ParamsSchema<const TShape extends ParamsSchemaShape = Param
  * const searchParams = paginationParams.toURLSearchParams({ limit: 25 })
  * ```
  */
-export declare const params: <const TShape extends ParamsSchemaShape = {}>(properties?: TShape) => ParamsSchema<TShape>;
+export declare const params: <const TShape extends ParamsShape = {}>(properties?: TShape) => ParamsSchema<TShape>;
 export {};
 //# sourceMappingURL=params.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,UAAU,EACV,WAAW,EACX,MAAM,EACN,iBAAiB,EAEjB,sBAAsB,EACvB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,WAAW,EAAS,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAW,MAAM,cAAc,CAAA;AAErD,OAAO,EAAE,aAAa,EAAW,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,cAAc,EAAY,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAA;AAElD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACzD,QAAA,MAAM,iBAAiB,6FAA0C,CAAA;AAEjE;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,WAAW,oPAAuD,CAAA;AAE/E;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,YAAY,sTAAwC,CAAA;AAKjE,KAAK,oBAAoB,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,CAAA;AACxE,KAAK,mBAAmB,GACpB,oBAAoB,GACpB,WAAW,CAAC,oBAAoB,CAAC,CAAA;AACrC,KAAK,cAAc,GACf,mBAAmB,GACnB,cAAc,CAAC,mBAAmB,CAAC,GACnC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,GACtD,iBAAiB,CAAC,mBAAmB,CAAC,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,YAAY,CACvB,KAAK,CAAC,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,CAC1D,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,eAAe,IAAI,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAIjD;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;IAyDxD,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC;IAsC5E,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,eAAe;CAmB5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,MAAM,SACX,MAAM,SAAS,iBAAiB,oBAC1B,MAAM,yBAElB,CAAA"}
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,UAAU,EACV,WAAW,EAKX,YAAY,EACZ,MAAM,EACN,iBAAiB,EACjB,SAAS,EACT,sBAAsB,EACvB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,WAAW,EAAS,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAW,MAAM,cAAc,CAAA;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAW,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAY,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAA;AAElD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACzD,QAAA,MAAM,iBAAiB,6FAA0C,CAAA;AAEjE;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,WAAW,iOAKtB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,YAAY,mSAAwC,CAAA;AAEjE,MAAM,MAAM,oBAAoB,GAI5B,aAAa,CAAC,MAAM,CAAC,GACrB,aAAa,CAAC,MAAM,CAAC,GACrB,aAAa,CAAC,OAAO,CAAC,GACtB,UAAU,CAAC,MAAM,CAAC,GAClB,UAAU,CAAC,MAAM,CAAC,GAElB,YAAY,CAAC,GAAG,CAAC,GACjB,aAAa,GACb,aAAa,CAAA;AAEjB,KAAK,kBAAkB,CAAC,OAAO,SAAS,SAAS,IAO/C,OAAO,SAAS,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;AAEpD,MAAM,MAAM,mBAAmB,GAC3B,oBAAoB,GACpB,kBAAkB,CAAC,oBAAoB,CAAC,CAAA;AAE5C,MAAM,MAAM,cAAc,GACtB,mBAAmB,GACnB,cAAc,CAAC,mBAAmB,CAAC,GACnC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,GACtD,iBAAiB,CAAC,mBAAmB,CAAC,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,YAAY,CACvB,KAAK,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,CAC9C,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;IAGa,QAAQ,CAAC,KAAK,EAAE,MAAM;IAFlC,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;gBAEZ,KAAK,EAAE,MAAM;IAIlC,IAAI,eAAe,IAAI,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAIjD;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;IAyDxD,mBAAmB,CACjB,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAC1C,OAAO,CAAC,EAAE,YAAY,GACrB,WAAW,CAAC,IAAI,CAAC;IAkCpB,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,eAAe;CAmB5D;AA2DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,MAAM,SACX,MAAM,SAAS,WAAW,oBACpB,MAAM,yBAElB,CAAA"}

package/dist/schema/params.js

@@ -8,7 +8,9 @@ const memoize_js_1 = require("../util/memoize.js");
 const array_js_1 = require("./array.js");
 const boolean_js_1 = require("./boolean.js");
 const dict_js_1 = require("./dict.js");
+const enum_js_1 = require("./enum.js");
 const integer_js_1 = require("./integer.js");
+const literal_js_1 = require("./literal.js");
 const optional_js_1 = require("./optional.js");
 const string_js_1 = require("./string.js");
 const union_js_1 = require("./union.js");
@@ -17,7 +19,12 @@ const paramScalarSchema = (0, union_js_1.union)([(0, boolean_js_1.boolean)(), (0
 /**
  * Schema for validating individual parameter values.
  */
-exports.paramSchema = (0, union_js_1.union)([paramScalarSchema, (0, array_js_1.array)(paramScalarSchema)]);
+exports.paramSchema = (0, union_js_1.union)([
+    paramScalarSchema,
+    (0, array_js_1.array)((0, boolean_js_1.boolean)()),
+    (0, array_js_1.array)((0, integer_js_1.integer)()),
+    (0, array_js_1.array)((0, string_js_1.string)()),
+]);
 /**
  * Schema for validating arbitrary params objects.
  */
@@ -43,6 +50,7 @@ exports.paramsSchema = (0, dict_js_1.dict)((0, string_js_1.string)(), (0, option
  */
 class ParamsSchema extends core_js_1.Schema {
     shape;
+    type = 'params';
     constructor(shape) {
         super();
         this.shape = shape;
@@ -53,7 +61,7 @@ class ParamsSchema extends core_js_1.Schema {
     }
     validateInContext(input, ctx) {
         if (!(0, lex_data_1.isPlainObject)(input)) {
-            return ctx.issueInvalidType(input, 'object');
+            return ctx.issueUnexpectedType(input, 'object');
         }
         // Lazily copy value
         let copy;
@@ -98,37 +106,33 @@ class ParamsSchema extends core_js_1.Schema {
         }
         return ctx.success(copy ?? input);
     }
-    fromURLSearchParams(iterable) {
+    fromURLSearchParams(input, options) {
         const params = {};
-        // Compatibility with URLSearchParams not being iterable in some environments
+        const iterable = typeof input === 'string' ? new URLSearchParams(input) : input;
         const entries = iterable instanceof URLSearchParams ? iterable.entries() : iterable;
-        for (const [key, value] of entries) {
-            const validator = unwrapValidator(this.shapeValidators.get(key));
-            const expectsArray = validator instanceof array_js_1.ArraySchema;
+        for (const [name, value] of entries) {
+            // Ignore empty strings
+            if (!value)
+                continue;
+            const validator = this.shapeValidators.get(name);
+            const innerValidator = validator ? unwrapSchema(validator) : undefined;
+            const expectsArray = innerValidator instanceof array_js_1.ArraySchema;
             const scalarValidator = expectsArray
-                ? unwrapValidator(validator.validator)
-                : validator;
-            const coerced = scalarValidator instanceof string_js_1.StringSchema
-                ? value
-                : value === 'true'
-                    ? true
-                    : value === 'false'
-                        ? false
-                        : /^-?\d+$/.test(value)
-                            ? Number(value)
-                            : value;
-            const currentParam = params[key];
+                ? unwrapSchema(innerValidator.validator)
+                : innerValidator;
+            const coerced = coerceParam(name, value, scalarValidator, options);
+            const currentParam = params[name];
             if (currentParam === undefined) {
-                params[key] = expectsArray ? [coerced] : coerced;
+                params[name] = expectsArray ? [coerced] : coerced;
             }
             else if (Array.isArray(currentParam)) {
                 currentParam.push(coerced);
             }
             else {
-                params[key] = [currentParam, coerced];
+                params[name] = [currentParam, coerced];
             }
         }
-        return this.parse(params);
+        return this.parse(params, options);
     }
     toURLSearchParams(input) {
         const urlSearchParams = new URLSearchParams();
@@ -149,6 +153,65 @@ class ParamsSchema extends core_js_1.Schema {
     }
 }
 exports.ParamsSchema = ParamsSchema;
+function coerceParam(name, param, schema, options) {
+    let issue;
+    if (!schema) {
+        // The param is unknown (not defined in schema), so we don't apply any
+        // coercion and just return the string value.
+        return param;
+    }
+    else if (schema instanceof string_js_1.StringSchema) {
+        return param;
+    }
+    else if (schema instanceof integer_js_1.IntegerSchema) {
+        if (/^-?\d+$/.test(param))
+            return Number(param);
+        issue = new core_js_1.IssueInvalidType(paramPath(name, options), param, ['integer']);
+    }
+    else if (schema instanceof boolean_js_1.BooleanSchema) {
+        if (param === 'true')
+            return true;
+        if (param === 'false')
+            return false;
+        issue = new core_js_1.IssueInvalidType(paramPath(name, options), param, ['boolean']);
+    }
+    else if (schema instanceof literal_js_1.LiteralSchema) {
+        const { value } = schema;
+        if (String(value) === param)
+            return value;
+        issue = new core_js_1.IssueInvalidValue(paramPath(name, options), param, [value]);
+    }
+    else if (schema instanceof enum_js_1.EnumSchema) {
+        const { values } = schema;
+        for (const value of values) {
+            if (String(value) === param)
+                return value;
+        }
+        issue = new core_js_1.IssueInvalidValue(paramPath(name, options), param, values);
+    }
+    else {
+        // This should never happen. If it *does*, it means that the user of
+        // lex-schema is mixing different versions of the lib, which is not
+        // supported. Throwing an error here is better than silently accepting
+        // invalid params and causing unexpected behavior down the line (ie. error
+        // message returning the string value instead of the expected
+        // boolean/number/string value).
+        throw new Error(`Unsupported schema type for param coercion: ${schema}`);
+    }
+    // We were not able to coerce the param to the expected type. There is no
+    // point in returning the original string value since it doesn't conform to
+    // the expected schema, so we throw a validation error instead. We could
+    // return the "param" here, which would cause the validation to fail later on
+    // (see fromURLSearchParams()'s return statement). The main benefit of
+    // returning the original "param" value is that the error path would include
+    // the index of the param in case of array params (e.g. "tags[1]"), which
+    // could be helpful for debugging. The cost overhead is not worth it though
+    // (IMO).
+    throw new core_js_1.LexValidationError([issue]);
+}
+function paramPath(key, options) {
+    return options?.path ? [...options.path, key] : [key];
+}
 /**
  * Creates a params schema for URL query parameters.
  *
@@ -187,10 +250,10 @@ exports.ParamsSchema = ParamsSchema;
 exports.params = (0, memoize_js_1.memoizedOptions)(function params(properties = {}) {
     return new ParamsSchema(properties);
 });
-function unwrapValidator(schema) {
+function unwrapSchema(schema) {
     while (schema instanceof optional_js_1.OptionalSchema ||
         schema instanceof with_default_js_1.WithDefaultSchema) {
-        schema = schema.validator;
+        return unwrapSchema(schema.validator);
     }
     return schema;
 }

package/dist/schema/params.js.map

@@ -1 +1 @@
-{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,wCAQmB;AACnB,+DAAuD;AACvD,mDAAoD;AACpD,yCAA+C;AAC/C,6CAAqD;AACrD,uCAAgC;AAChC,6CAAqD;AACrD,+CAAwD;AACxD,2CAAkD;AAClD,yCAAkC;AAClC,uDAAqD;AAMrD,MAAM,iBAAiB,GAAG,IAAA,gBAAK,EAAC,CAAC,IAAA,oBAAO,GAAE,EAAE,IAAA,oBAAO,GAAE,EAAE,IAAA,kBAAM,GAAE,CAAC,CAAC,CAAA;AAOjE;;GAEG;AACU,QAAA,WAAW,GAAG,IAAA,gBAAK,EAAC,CAAC,iBAAiB,EAAE,IAAA,gBAAK,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAO/E;;GAEG;AACU,QAAA,YAAY,GAAG,IAAA,cAAI,EAAC,IAAA,kBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,mBAAW,CAAC,CAAC,CAAA;AAwBjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,YAEX,SAAQ,gBAOT;IACsB;IAArB,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,IAAI,eAAe;QACjB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/C,OAAO,IAAA,+BAAY,EAAC,IAAI,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAA;IACnD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,oBAAoB;QACpB,IAAI,IAAyC,CAAA;QAE7C,2DAA2D;QAC3D,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,SAAQ;YAE3C,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,mBAAW,CAAC,CAAA;YACzD,IAAI,CAAC,MAAM,CAAC,OAAO;gBAAE,OAAO,MAAM,CAAA;YAElC,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;oBACpB,sCAAsC;oBACtC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACzC,CAAC;gBAED,OAAO,MAAM,CAAA;YACf,CAAC;YAED,uEAAuE;YACvE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;gBAClD,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,gBAAgB;gBAChB,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,CAAA;IACnC,CAAC;IAED,mBAAmB,CAAC,QAAoC;QACtD,MAAM,MAAM,GAA0B,EAAE,CAAA;QAExC,6EAA6E;QAC7E,MAAM,OAAO,GACX,QAAQ,YAAY,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;QAErE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;YAChE,MAAM,YAAY,GAAG,SAAS,YAAY,sBAAW,CAAA;YACrD,MAAM,eAAe,GAAG,YAAY;gBAClC,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC;gBACtC,CAAC,CAAC,SAAS,CAAA;YAEb,MAAM,OAAO,GACX,eAAe,YAAY,wBAAY;gBACrC,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,KAAK,KAAK,MAAM;oBAChB,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,KAAK,KAAK,OAAO;wBACjB,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;4BACrB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;4BACf,CAAC,CAAC,KAAK,CAAA;YAEjB,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;YAChC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;YAClD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBACvC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC3B,CAAC;IAED,iBAAiB,CAAC,KAAuB;QACvC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAE7C,oEAAoE;QACpE,kDAAkD;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAEhC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;CACF;AAtID,oCAsIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACU,QAAA,MAAM,GAAiB,IAAA,4BAAe,EAAC,SAAS,MAAM,CAEjE,aAAqB,EAAY;IACjC,OAAO,IAAI,YAAY,CAAS,UAAU,CAAC,CAAA;AAC7C,CAAC,CAAC,CAAA;AAEF,SAAS,eAAe,CAAC,MAAkB;IACzC,OACE,MAAM,YAAY,4BAAc;QAChC,MAAM,YAAY,mCAAiB,EACnC,CAAC;QACD,MAAM,GAAG,MAAM,CAAC,SAAS,CAAA;IAC3B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import { isPlainObject } from '@atproto/lex-data'\nimport {\n  Infer,\n  InferInput,\n  InferOutput,\n  Schema,\n  ValidationContext,\n  Validator,\n  WithOptionalProperties,\n} from '../core.js'\nimport { lazyProperty } from '../util/lazy-property.js'\nimport { memoizedOptions } from '../util/memoize.js'\nimport { ArraySchema, array } from './array.js'\nimport { BooleanSchema, boolean } from './boolean.js'\nimport { dict } from './dict.js'\nimport { IntegerSchema, integer } from './integer.js'\nimport { OptionalSchema, optional } from './optional.js'\nimport { StringSchema, string } from './string.js'\nimport { union } from './union.js'\nimport { WithDefaultSchema } from './with-default.js'\n\n/**\n * Scalar types allowed in URL parameters: boolean, integer, or string.\n */\nexport type ParamScalar = Infer<typeof paramScalarSchema>\nconst paramScalarSchema = union([boolean(), integer(), string()])\n\n/**\n * A single parameter value: scalar or array of scalars.\n */\nexport type Param = Infer<typeof paramSchema>\n\n/**\n * Schema for validating individual parameter values.\n */\nexport const paramSchema = union([paramScalarSchema, array(paramScalarSchema)])\n\n/**\n * Type for a params object with string keys and optional param values.\n */\nexport type Params = Infer<typeof paramsSchema>\n\n/**\n * Schema for validating arbitrary params objects.\n */\nexport const paramsSchema = dict(string(), optional(paramSchema))\n\n// @NOTE In order to properly coerce URLSearchParams, we need to distinguish\n// between scalar and array validators, requiring to be able to detect which\n// schema types are being used, restricting the allowed param validators here.\ntype ParamScalarValidator = StringSchema | BooleanSchema | IntegerSchema\ntype ParamValueValidator =\n  | ParamScalarValidator\n  | ArraySchema<ParamScalarValidator>\ntype ParamValidator =\n  | ParamValueValidator\n  | OptionalSchema<ParamValueValidator>\n  | OptionalSchema<WithDefaultSchema<ParamValueValidator>>\n  | WithDefaultSchema<ParamValueValidator>\n\n/**\n * Type representing the shape of a params schema definition.\n *\n * Maps parameter names to their validators (must be Param or undefined).\n */\nexport type ParamsSchemaShape = {\n  [x: string]: ParamValidator\n}\n\n/**\n * Schema for validating URL query parameters in Lexicon endpoints.\n *\n * Params are the query string parameters passed to queries, procedures,\n * and subscriptions. Values must be scalars (boolean, integer, string)\n * or arrays of scalars, as they need to be serializable to URL format.\n *\n * Provides methods for converting to/from URLSearchParams.\n *\n * @template TShape - The params shape type mapping names to validators\n *\n * @example\n * ```ts\n * const schema = new ParamsSchema({\n *   limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),\n *   cursor: l.optional(l.string()),\n * })\n * ```\n */\nexport class ParamsSchema<\n  const TShape extends ParamsSchemaShape = ParamsSchemaShape,\n> extends Schema<\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferInput<TShape[K]>\n  }>,\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferOutput<TShape[K]>\n  }>\n> {\n  constructor(readonly shape: TShape) {\n    super()\n  }\n\n  get shapeValidators(): Map<string, ParamValidator> {\n    const map = new Map(Object.entries(this.shape))\n\n    return lazyProperty(this, 'shapeValidators', map)\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isPlainObject(input)) {\n      return ctx.issueInvalidType(input, 'object')\n    }\n\n    // Lazily copy value\n    let copy: undefined | Record<string, unknown>\n\n    // Ensure that non-specified params conform to param schema\n    for (const key in input) {\n      if (this.shapeValidators.has(key)) continue\n\n      const result = ctx.validateChild(input, key, paramSchema)\n      if (!result.success) return result\n\n      if (result.value !== input[key]) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    for (const [key, propDef] of this.shapeValidators) {\n      const result = ctx.validateChild(input, key, propDef)\n      if (!result.success) {\n        if (!(key in input)) {\n          // Transform into \"required key\" issue\n          return ctx.issueRequiredKey(input, key)\n        }\n\n        return result\n      }\n\n      // Skip copying if key is not present in input (and value is undefined)\n      if (result.value === undefined && !(key in input)) {\n        continue\n      }\n\n      if (!Object.is(result.value, input[key])) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        // Copy on write\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    return ctx.success(copy ?? input)\n  }\n\n  fromURLSearchParams(iterable: Iterable<[string, string]>): InferOutput<this> {\n    const params: Record<string, Param> = {}\n\n    // Compatibility with URLSearchParams not being iterable in some environments\n    const entries =\n      iterable instanceof URLSearchParams ? iterable.entries() : iterable\n\n    for (const [key, value] of entries) {\n      const validator = unwrapValidator(this.shapeValidators.get(key))\n      const expectsArray = validator instanceof ArraySchema\n      const scalarValidator = expectsArray\n        ? unwrapValidator(validator.validator)\n        : validator\n\n      const coerced: ParamScalar =\n        scalarValidator instanceof StringSchema\n          ? value\n          : value === 'true'\n            ? true\n            : value === 'false'\n              ? false\n              : /^-?\\d+$/.test(value)\n                ? Number(value)\n                : value\n\n      const currentParam = params[key]\n      if (currentParam === undefined) {\n        params[key] = expectsArray ? [coerced] : coerced\n      } else if (Array.isArray(currentParam)) {\n        currentParam.push(coerced)\n      } else {\n        params[key] = [currentParam, coerced]\n      }\n    }\n\n    return this.parse(params)\n  }\n\n  toURLSearchParams(input: InferInput<this>): URLSearchParams {\n    const urlSearchParams = new URLSearchParams()\n\n    // @NOTE We apply defaults here to ensure that server with different\n    // defaults still receive all expected parameters.\n    const params = this.parse(input)\n\n    for (const [key, value] of Object.entries(params)) {\n      if (Array.isArray(value)) {\n        for (const v of value) {\n          urlSearchParams.append(key, String(v))\n        }\n      } else if (value !== undefined) {\n        urlSearchParams.append(key, String(value))\n      }\n    }\n\n    return urlSearchParams\n  }\n}\n\n/**\n * Creates a params schema for URL query parameters.\n *\n * Params schemas validate query string parameters for Lexicon endpoints.\n * Values must be boolean, integer, string, or arrays of those types.\n *\n * @param properties - Object mapping parameter names to their validators\n * @returns A new {@link ParamsSchema} instance\n *\n * @example\n * ```ts\n * // Simple pagination params\n * const paginationParams = l.params({\n *   limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),\n *   cursor: l.optional(l.string()),\n * })\n *\n * // Required parameter\n * const actorParams = l.params({\n *   actor: l.string({ format: 'at-identifier' }),\n * })\n *\n * // Array parameter (multiple values)\n * const filterParams = l.params({\n *   tags: l.optional(l.array(l.string())),\n * })\n *\n * // Convert from URL\n * const urlParams = new URLSearchParams('limit=25&cursor=abc')\n * const validated = paginationParams.fromURLSearchParams(urlParams)\n *\n * // Convert to URL\n * const searchParams = paginationParams.toURLSearchParams({ limit: 25 })\n * ```\n */\nexport const params = /*#__PURE__*/ memoizedOptions(function params<\n  const TShape extends ParamsSchemaShape = NonNullable<unknown>,\n>(properties: TShape = {} as TShape) {\n  return new ParamsSchema<TShape>(properties)\n})\n\nfunction unwrapValidator(schema?: Validator): Validator | undefined {\n  while (\n    schema instanceof OptionalSchema ||\n    schema instanceof WithDefaultSchema\n  ) {\n    schema = schema.validator\n  }\n  return schema\n}\n"]}
+{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,wCAamB;AACnB,+DAAuD;AACvD,mDAAoD;AACpD,yCAA+C;AAC/C,6CAAqD;AACrD,uCAAgC;AAChC,uCAAsC;AACtC,6CAAqD;AACrD,6CAA4C;AAC5C,+CAAwD;AACxD,2CAAkD;AAClD,yCAAkC;AAClC,uDAAqD;AAMrD,MAAM,iBAAiB,GAAG,IAAA,gBAAK,EAAC,CAAC,IAAA,oBAAO,GAAE,EAAE,IAAA,oBAAO,GAAE,EAAE,IAAA,kBAAM,GAAE,CAAC,CAAC,CAAA;AAOjE;;GAEG;AACU,QAAA,WAAW,GAAG,IAAA,gBAAK,EAAC;IAC/B,iBAAiB;IACjB,IAAA,gBAAK,EAAC,IAAA,oBAAO,GAAE,CAAC;IAChB,IAAA,gBAAK,EAAC,IAAA,oBAAO,GAAE,CAAC;IAChB,IAAA,gBAAK,EAAC,IAAA,kBAAM,GAAE,CAAC;CAChB,CAAC,CAAA;AAOF;;GAEG;AACU,QAAA,YAAY,GAAG,IAAA,cAAI,EAAC,IAAA,kBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,mBAAW,CAAC,CAAC,CAAA;AA4CjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,YAEX,SAAQ,gBAOT;IAGsB;IAFZ,IAAI,GAAG,QAAiB,CAAA;IAEjC,YAAqB,KAAa;QAChC,KAAK,EAAE,CAAA;QADY,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,IAAI,eAAe;QACjB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/C,OAAO,IAAA,+BAAY,EAAC,IAAI,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAA;IACnD,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACjD,CAAC;QAED,oBAAoB;QACpB,IAAI,IAAyC,CAAA;QAE7C,2DAA2D;QAC3D,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,SAAQ;YAE3C,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,mBAAW,CAAC,CAAA;YACzD,IAAI,CAAC,MAAM,CAAC,OAAO;gBAAE,OAAO,MAAM,CAAA;YAElC,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;oBACpB,sCAAsC;oBACtC,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACzC,CAAC;gBAED,OAAO,MAAM,CAAA;YACf,CAAC;YAED,uEAAuE;YACvE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;gBAClD,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,sEAAsE;oBACtE,OAAO,GAAG,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBAClE,CAAC;gBAED,gBAAgB;gBAChB,IAAI,KAAK,EAAE,GAAG,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,CAAA;IACnC,CAAC;IAED,mBAAmB,CACjB,KAA0C,EAC1C,OAAsB;QAEtB,MAAM,MAAM,GAA4B,EAAE,CAAA;QAE1C,MAAM,QAAQ,GACZ,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAChE,MAAM,OAAO,GACX,QAAQ,YAAY,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;QAErE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACpC,uBAAuB;YACvB,IAAI,CAAC,KAAK;gBAAE,SAAQ;YAEpB,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YAChD,MAAM,cAAc,GAAG,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YACtE,MAAM,YAAY,GAAG,cAAc,YAAY,sBAAW,CAAA;YAC1D,MAAM,eAAe,GAAG,YAAY;gBAClC,CAAC,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC;gBACxC,CAAC,CAAC,cAAc,CAAA;YAElB,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;YAElE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;YACnD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBACvC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,CAAC;IAED,iBAAiB,CAAC,KAAuB;QACvC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAE7C,oEAAoE;QACpE,kDAAkD;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAEhC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;CACF;AAvID,oCAuIC;AAED,SAAS,WAAW,CAClB,IAAY,EACZ,KAAa,EACb,MAA6B,EAC7B,OAAsB;IAEtB,IAAI,KAAY,CAAA;IAEhB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,sEAAsE;QACtE,6CAA6C;QAC7C,OAAO,KAAK,CAAA;IACd,CAAC;SAAM,IAAI,MAAM,YAAY,wBAAY,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAA;IACd,CAAC;SAAM,IAAI,MAAM,YAAY,0BAAa,EAAE,CAAC;QAC3C,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;QAC/C,KAAK,GAAG,IAAI,0BAAgB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAC5E,CAAC;SAAM,IAAI,MAAM,YAAY,0BAAa,EAAE,CAAC;QAC3C,IAAI,KAAK,KAAK,MAAM;YAAE,OAAO,IAAI,CAAA;QACjC,IAAI,KAAK,KAAK,OAAO;YAAE,OAAO,KAAK,CAAA;QACnC,KAAK,GAAG,IAAI,0BAAgB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAC5E,CAAC;SAAM,IAAI,MAAM,YAAY,0BAAa,EAAE,CAAC;QAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;QACxB,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;YAAE,OAAO,KAAK,CAAA;QACzC,KAAK,GAAG,IAAI,2BAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IACzE,CAAC;SAAM,IAAI,MAAM,YAAY,oBAAU,EAAE,CAAC;QACxC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;QACzB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBAAE,OAAO,KAAK,CAAA;QAC3C,CAAC;QACD,KAAK,GAAG,IAAI,2BAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IACxE,CAAC;SAAM,CAAC;QACN,oEAAoE;QACpE,mEAAmE;QACnE,sEAAsE;QACtE,0EAA0E;QAC1E,6DAA6D;QAC7D,gCAAgC;QAChC,MAAM,IAAI,KAAK,CAAC,+CAA+C,MAAM,EAAE,CAAC,CAAA;IAC1E,CAAC;IAED,yEAAyE;IACzE,2EAA2E;IAC3E,wEAAwE;IACxE,6EAA6E;IAC7E,sEAAsE;IACtE,4EAA4E;IAC5E,yEAAyE;IACzE,2EAA2E;IAC3E,SAAS;IACT,MAAM,IAAI,4BAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;AACvC,CAAC;AAED,SAAS,SAAS,CAAC,GAAW,EAAE,OAAsB;IACpD,OAAO,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACU,QAAA,MAAM,GAAiB,IAAA,4BAAe,EAAC,SAAS,MAAM,CAEjE,aAAqB,EAAY;IACjC,OAAO,IAAI,YAAY,CAAS,UAAU,CAAC,CAAA;AAC7C,CAAC,CAAC,CAAA;AASF,SAAS,YAAY,CAAsB,MAAS;IAClD,OACE,MAAM,YAAY,4BAAc;QAChC,MAAM,YAAY,mCAAiB,EACnC,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACvC,CAAC;IACD,OAAO,MAAyB,CAAA;AAClC,CAAC","sourcesContent":["import { isPlainObject } from '@atproto/lex-data'\nimport {\n  Infer,\n  InferInput,\n  InferOutput,\n  Issue,\n  IssueInvalidType,\n  IssueInvalidValue,\n  LexValidationError,\n  ParseOptions,\n  Schema,\n  ValidationContext,\n  Validator,\n  WithOptionalProperties,\n} from '../core.js'\nimport { lazyProperty } from '../util/lazy-property.js'\nimport { memoizedOptions } from '../util/memoize.js'\nimport { ArraySchema, array } from './array.js'\nimport { BooleanSchema, boolean } from './boolean.js'\nimport { dict } from './dict.js'\nimport { EnumSchema } from './enum.js'\nimport { IntegerSchema, integer } from './integer.js'\nimport { LiteralSchema } from './literal.js'\nimport { OptionalSchema, optional } from './optional.js'\nimport { StringSchema, string } from './string.js'\nimport { union } from './union.js'\nimport { WithDefaultSchema } from './with-default.js'\n\n/**\n * Scalar types allowed in URL parameters: boolean, integer, or string.\n */\nexport type ParamScalar = Infer<typeof paramScalarSchema>\nconst paramScalarSchema = union([boolean(), integer(), string()])\n\n/**\n * A single parameter value: scalar or array of scalars.\n */\nexport type Param = Infer<typeof paramSchema>\n\n/**\n * Schema for validating individual parameter values.\n */\nexport const paramSchema = union([\n  paramScalarSchema,\n  array(boolean()),\n  array(integer()),\n  array(string()),\n])\n\n/**\n * Type for a params object with string keys and optional param values.\n */\nexport type Params = Infer<typeof paramsSchema>\n\n/**\n * Schema for validating arbitrary params objects.\n */\nexport const paramsSchema = dict(string(), optional(paramSchema))\n\nexport type ParamScalarValidator =\n  // @NOTE In order to properly coerce URLSearchParams, we need to distinguish\n  // between scalar and array validators, requiring to be able to detect which\n  // schema types are being used, restricting the allowed param validators here.\n  | LiteralSchema<string>\n  | LiteralSchema<number>\n  | LiteralSchema<boolean>\n  | EnumSchema<string>\n  | EnumSchema<number>\n  // | EnumSchema<boolean> // Boolean lexicon definitions don't allow \"enum\"\n  | StringSchema<any>\n  | BooleanSchema\n  | IntegerSchema\n\ntype AsArrayParamSchema<TSchema extends Validator> =\n  // This allows to \"distribute\" any union of scalar validators into a union of\n  // arrays of those validators, instead of an array of union. If TSchema is\n  // BooleanSchema | IntegerSchema, we want the result to be\n  // ArraySchema<BooleanSchema> | ArraySchema<IntegerSchema>, not\n  // ArraySchema<BooleanSchema | IntegerSchema>, since the latter would allow\n  // arrays with mixed types (e.g. [true, 42]), which we don't want.\n  TSchema extends any ? ArraySchema<TSchema> : never\n\nexport type ParamValueValidator =\n  | ParamScalarValidator\n  | AsArrayParamSchema<ParamScalarValidator>\n\nexport type ParamValidator =\n  | ParamValueValidator\n  | OptionalSchema<ParamValueValidator>\n  | OptionalSchema<WithDefaultSchema<ParamValueValidator>>\n  | WithDefaultSchema<ParamValueValidator>\n\n/**\n * Type representing the shape of a params schema definition.\n *\n * Maps parameter names to their validators (must be Param or undefined).\n */\nexport type ParamsShape = {\n  [x: string]: ParamValidator\n}\n\n/**\n * Schema for validating URL query parameters in Lexicon endpoints.\n *\n * Params are the query string parameters passed to queries, procedures,\n * and subscriptions. Values must be scalars (boolean, integer, string)\n * or arrays of scalars, as they need to be serializable to URL format.\n *\n * Provides methods for converting to/from URLSearchParams.\n *\n * @template TShape - The params shape type mapping names to validators\n *\n * @example\n * ```ts\n * const schema = new ParamsSchema({\n *   limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),\n *   cursor: l.optional(l.string()),\n * })\n * ```\n */\nexport class ParamsSchema<\n  const TShape extends ParamsShape = ParamsShape,\n> extends Schema<\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferInput<TShape[K]>\n  }>,\n  WithOptionalProperties<{\n    [K in keyof TShape]: InferOutput<TShape[K]>\n  }>\n> {\n  readonly type = 'params' as const\n\n  constructor(readonly shape: TShape) {\n    super()\n  }\n\n  get shapeValidators(): Map<string, ParamValidator> {\n    const map = new Map(Object.entries(this.shape))\n\n    return lazyProperty(this, 'shapeValidators', map)\n  }\n\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (!isPlainObject(input)) {\n      return ctx.issueUnexpectedType(input, 'object')\n    }\n\n    // Lazily copy value\n    let copy: undefined | Record<string, unknown>\n\n    // Ensure that non-specified params conform to param schema\n    for (const key in input) {\n      if (this.shapeValidators.has(key)) continue\n\n      const result = ctx.validateChild(input, key, paramSchema)\n      if (!result.success) return result\n\n      if (result.value !== input[key]) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    for (const [key, propDef] of this.shapeValidators) {\n      const result = ctx.validateChild(input, key, propDef)\n      if (!result.success) {\n        if (!(key in input)) {\n          // Transform into \"required key\" issue\n          return ctx.issueRequiredKey(input, key)\n        }\n\n        return result\n      }\n\n      // Skip copying if key is not present in input (and value is undefined)\n      if (result.value === undefined && !(key in input)) {\n        continue\n      }\n\n      if (!Object.is(result.value, input[key])) {\n        if (ctx.options.mode === 'validate') {\n          // In \"validate\" mode, we can't modify the input, so we issue an error\n          return ctx.issueInvalidPropertyValue(input, key, [result.value])\n        }\n\n        // Copy on write\n        copy ??= { ...input }\n        copy[key] = result.value\n      }\n    }\n\n    return ctx.success(copy ?? input)\n  }\n\n  fromURLSearchParams(\n    input: string | Iterable<[string, string]>,\n    options?: ParseOptions,\n  ): InferOutput<this> {\n    const params: Record<string, unknown> = {}\n\n    const iterable =\n      typeof input === 'string' ? new URLSearchParams(input) : input\n    const entries =\n      iterable instanceof URLSearchParams ? iterable.entries() : iterable\n\n    for (const [name, value] of entries) {\n      // Ignore empty strings\n      if (!value) continue\n\n      const validator = this.shapeValidators.get(name)\n      const innerValidator = validator ? unwrapSchema(validator) : undefined\n      const expectsArray = innerValidator instanceof ArraySchema\n      const scalarValidator = expectsArray\n        ? unwrapSchema(innerValidator.validator)\n        : innerValidator\n\n      const coerced = coerceParam(name, value, scalarValidator, options)\n\n      const currentParam = params[name]\n      if (currentParam === undefined) {\n        params[name] = expectsArray ? [coerced] : coerced\n      } else if (Array.isArray(currentParam)) {\n        currentParam.push(coerced)\n      } else {\n        params[name] = [currentParam, coerced]\n      }\n    }\n\n    return this.parse(params, options)\n  }\n\n  toURLSearchParams(input: InferInput<this>): URLSearchParams {\n    const urlSearchParams = new URLSearchParams()\n\n    // @NOTE We apply defaults here to ensure that server with different\n    // defaults still receive all expected parameters.\n    const params = this.parse(input)\n\n    for (const [key, value] of Object.entries(params)) {\n      if (Array.isArray(value)) {\n        for (const v of value) {\n          urlSearchParams.append(key, String(v))\n        }\n      } else if (value !== undefined) {\n        urlSearchParams.append(key, String(value))\n      }\n    }\n\n    return urlSearchParams\n  }\n}\n\nfunction coerceParam(\n  name: string,\n  param: string,\n  schema?: ParamScalarValidator,\n  options?: ParseOptions,\n): ParamScalar {\n  let issue: Issue\n\n  if (!schema) {\n    // The param is unknown (not defined in schema), so we don't apply any\n    // coercion and just return the string value.\n    return param\n  } else if (schema instanceof StringSchema) {\n    return param\n  } else if (schema instanceof IntegerSchema) {\n    if (/^-?\\d+$/.test(param)) return Number(param)\n    issue = new IssueInvalidType(paramPath(name, options), param, ['integer'])\n  } else if (schema instanceof BooleanSchema) {\n    if (param === 'true') return true\n    if (param === 'false') return false\n    issue = new IssueInvalidType(paramPath(name, options), param, ['boolean'])\n  } else if (schema instanceof LiteralSchema) {\n    const { value } = schema\n    if (String(value) === param) return value\n    issue = new IssueInvalidValue(paramPath(name, options), param, [value])\n  } else if (schema instanceof EnumSchema) {\n    const { values } = schema\n    for (const value of values) {\n      if (String(value) === param) return value\n    }\n    issue = new IssueInvalidValue(paramPath(name, options), param, values)\n  } else {\n    // This should never happen. If it *does*, it means that the user of\n    // lex-schema is mixing different versions of the lib, which is not\n    // supported. Throwing an error here is better than silently accepting\n    // invalid params and causing unexpected behavior down the line (ie. error\n    // message returning the string value instead of the expected\n    // boolean/number/string value).\n    throw new Error(`Unsupported schema type for param coercion: ${schema}`)\n  }\n\n  // We were not able to coerce the param to the expected type. There is no\n  // point in returning the original string value since it doesn't conform to\n  // the expected schema, so we throw a validation error instead. We could\n  // return the \"param\" here, which would cause the validation to fail later on\n  // (see fromURLSearchParams()'s return statement). The main benefit of\n  // returning the original \"param\" value is that the error path would include\n  // the index of the param in case of array params (e.g. \"tags[1]\"), which\n  // could be helpful for debugging. The cost overhead is not worth it though\n  // (IMO).\n  throw new LexValidationError([issue])\n}\n\nfunction paramPath(key: string, options?: ParseOptions) {\n  return options?.path ? [...options.path, key] : [key]\n}\n\n/**\n * Creates a params schema for URL query parameters.\n *\n * Params schemas validate query string parameters for Lexicon endpoints.\n * Values must be boolean, integer, string, or arrays of those types.\n *\n * @param properties - Object mapping parameter names to their validators\n * @returns A new {@link ParamsSchema} instance\n *\n * @example\n * ```ts\n * // Simple pagination params\n * const paginationParams = l.params({\n *   limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),\n *   cursor: l.optional(l.string()),\n * })\n *\n * // Required parameter\n * const actorParams = l.params({\n *   actor: l.string({ format: 'at-identifier' }),\n * })\n *\n * // Array parameter (multiple values)\n * const filterParams = l.params({\n *   tags: l.optional(l.array(l.string())),\n * })\n *\n * // Convert from URL\n * const urlParams = new URLSearchParams('limit=25&cursor=abc')\n * const validated = paginationParams.fromURLSearchParams(urlParams)\n *\n * // Convert to URL\n * const searchParams = paginationParams.toURLSearchParams({ limit: 25 })\n * ```\n */\nexport const params = /*#__PURE__*/ memoizedOptions(function params<\n  const TShape extends ParamsShape = NonNullable<unknown>,\n>(properties: TShape = {} as TShape) {\n  return new ParamsSchema<TShape>(properties)\n})\n\ntype UnwrapSchema<S extends Validator> =\n  S extends OptionalSchema<infer U>\n    ? UnwrapSchema<U>\n    : S extends WithDefaultSchema<infer U>\n      ? UnwrapSchema<U>\n      : S\n\nfunction unwrapSchema<S extends Validator>(schema: S): UnwrapSchema<S> {\n  while (\n    schema instanceof OptionalSchema ||\n    schema instanceof WithDefaultSchema\n  ) {\n    return unwrapSchema(schema.validator)\n  }\n  return schema as UnwrapSchema<S>\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../src/schema/payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAA;AAElD,YAAY,EAAE,QAAQ,EAAE,CAAA;AAExB,KAAK,UAAU,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,SAAS,KAAK,GAC/D,GAAG,MAAM,IAAI,MAAM,EAAE,GACrB,SAAS,SAAS,GAAG,MAAM,CAAC,SAAS,MAAM,IAAI,GAC7C,GAAG,CAAC,IAAI,MAAM,EAAE,GAChB,SAAS,CAAA;AAEf,KAAK,UAAU,CACb,SAAS,SAAS,MAAM,EACxB,OAAO,EACP,OAAO,IACL,OAAO,SAAS,MAAM,GACtB,KAAK,CAAC,OAAO,CAAC,GACd,SAAS,SAAS,kBAAkB,GAClC,QAAQ,GACR,OAAO,CAAA;AAEb;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,OAAO,EAAE,OAAO,IACxD,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,OAAO,CAAC,GACpD,SAAS,SAAS,MAAM,GACtB;IACE,QAAQ,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;IAC/B,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;CAC9C,GACD,SAAS,GACX,KAAK,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAAC,QAAQ,SAAS,OAAO,IACvD,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,GAAG,CAAC,GAC1C,SAAS,SAAS,MAAM,GACtB,UAAU,CAAC,SAAS,CAAC,GACrB,SAAS,GACX,KAAK,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,QAAQ,SAAS,OAAO,EAAE,OAAO,IAC5D,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,OAAO,CAAC,GACpD,SAAS,SAAS,MAAM,GACtB,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,GACvC,SAAS,GACX,KAAK,CAAA;AAEX;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,IAAI,CAAC,SAAS,SAAS,GACzE,SAAS,GACT,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;AAEhC;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,OAAO,CAClB,KAAK,CAAC,SAAS,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC/D,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC;IAGvE,QAAQ,CAAC,QAAQ,EAAE,SAAS;IAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO;gBADf,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,OAAO;IAO1B;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO;CA6B1D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,wBAAgB,OAAO,CACrB,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAC9C,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,EAC5C,QAAQ,GAAE,CAAkB,EAAE,SAAS,GAAE,CAAkB,iBAE5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,wBAAgB,WAAW,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC,EACzD,UAAU,EAAE,CAAC,GAAG,OAAO,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAE7D"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../src/schema/payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAA;AAElD,YAAY,EAAE,QAAQ,EAAE,CAAA;AAExB,KAAK,UAAU,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,SAAS,KAAK,GAC/D,GAAG,MAAM,IAAI,MAAM,EAAE,GACrB,SAAS,SAAS,GAAG,MAAM,CAAC,SAAS,MAAM,IAAI,GAC7C,GAAG,CAAC,IAAI,MAAM,EAAE,GAChB,SAAS,CAAA;AAEf,KAAK,UAAU,CACb,SAAS,SAAS,MAAM,EACxB,OAAO,EACP,OAAO,IACL,OAAO,SAAS,MAAM,GACtB,KAAK,CAAC,OAAO,CAAC,GACd,SAAS,SAAS,kBAAkB,GAClC,QAAQ,GACR,OAAO,CAAA;AAEb;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,OAAO,EAAE,OAAO,IACxD,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,OAAO,CAAC,GACpD,SAAS,SAAS,MAAM,GACtB;IACE,QAAQ,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;IAC/B,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;CAC9C,GACD,SAAS,GACX,KAAK,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAAC,QAAQ,SAAS,OAAO,IACvD,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,GAAG,CAAC,GAC1C,SAAS,SAAS,MAAM,GACtB,UAAU,CAAC,SAAS,CAAC,GACrB,SAAS,GACX,KAAK,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,QAAQ,SAAS,OAAO,EAAE,OAAO,IAC5D,QAAQ,SAAS,OAAO,CAAC,MAAM,SAAS,EAAE,MAAM,OAAO,CAAC,GACpD,SAAS,SAAS,MAAM,GACtB,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,GACvC,SAAS,GACX,KAAK,CAAA;AAEX;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,IAAI,CAAC,SAAS,SAAS,GACzE,SAAS,GACT,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;AAEhC;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,OAAO,CAClB,KAAK,CAAC,SAAS,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC/D,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC;IAGvE,QAAQ,CAAC,QAAQ,EAAE,SAAS;IAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO;gBADf,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,OAAO;IAO1B;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO;CA4B1D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,wBAAgB,OAAO,CACrB,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAC9C,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,EAC5C,QAAQ,GAAE,CAAkB,EAAE,SAAS,GAAE,CAAkB,iBAE5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,wBAAgB,WAAW,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC,EACzD,UAAU,EAAE,CAAC,GAAG,OAAO,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAE7D"}

package/dist/schema/payload.js

@@ -36,20 +36,20 @@ class Payload {
      * encoding.
      */
     matchesEncoding(contentType) {
-        const mime = contentType?.split(';', 1)[0].trim();
         const { encoding } = this;
         // Handle undefined cases
         if (encoding === undefined) {
             // Expecting no body
-            return mime === undefined;
+            return contentType == null;
         }
-        else if (mime === undefined) {
+        else if (contentType == null) {
             // Expecting a body, but got no content-type
             return false;
         }
         if (encoding === '*/*') {
             return true;
         }
+        const mime = contentType?.split(';', 1)[0].trim();
         if (encoding.endsWith('/*')) {
             return mime.startsWith(encoding.slice(0, -1));
         }

package/dist/schema/payload.js.map

@@ -1 +1 @@
-{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../src/schema/payload.ts"],"names":[],"mappings":";;;AAwKA,0BAKC;AA4BD,kCAIC;AA3MD,2CAAkD;AAwElD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,OAAO;IAKP;IACA;IAFX,YACW,QAAmB,EACnB,MAAe;QADf,aAAQ,GAAR,QAAQ,CAAW;QACnB,WAAM,GAAN,MAAM,CAAS;QAExB,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACnD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAA;QAC5E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,WAA+B;QAC7C,MAAM,IAAI,GAAG,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAEjD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAEzB,yBAAyB;QACzB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,oBAAoB;YACpB,OAAO,IAAI,KAAK,SAAS,CAAA;QAC3B,CAAC;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,4CAA4C;YAC5C,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QAED,gEAAgE;QAChE,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,QAAQ,KAAK,IAAI,CAAA;IAC1B,CAAC;CACF;AA9CD,0BA8CC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAwB;AACxB,SAAgB,OAAO,CAGrB,WAAc,SAAc,EAAE,YAAe,SAAc;IAC3D,OAAO,IAAI,OAAO,CAAO,QAAQ,EAAE,SAAS,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAwB;AACxB,SAAgB,WAAW,CAEzB,UAAa;IACb,OAAO,OAAO,CAAC,kBAAkB,EAAE,IAAA,kBAAM,EAAC,UAAU,CAAC,CAAC,CAAA;AACxD,CAAC","sourcesContent":["import { LexValue } from '@atproto/lex-data'\nimport { Infer, Schema, Validator } from '../core.js'\nimport { ObjectSchema, object } from './object.js'\n\nexport type { LexValue }\n\ntype ToBodyMime<TEncoding extends string> = TEncoding extends '*/*'\n  ? `${string}/${string}`\n  : TEncoding extends `${infer T extends string}/*`\n    ? `${T}/${string}`\n    : TEncoding\n\ntype ToBodyType<\n  TEncoding extends string,\n  TSchema,\n  TBinary,\n> = TSchema extends Schema\n  ? Infer<TSchema>\n  : TEncoding extends `application/json`\n    ? LexValue\n    : TBinary\n\n/**\n * Infers the type of a Payload's encoding and body.\n *\n * @template TPayload - The Payload type\n * @template TBody - Fallback body type for non-JSON encodings\n */\nexport type InferPayload<TPayload extends Payload, TBinary> =\n  TPayload extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? {\n          encoding: ToBodyMime<TEncoding>\n          body: ToBodyType<TEncoding, TSchema, TBinary>\n        }\n      : undefined\n    : never\n\n/**\n * Converts schema encoding patterns to data encoding types.\n *\n * Handles wildcards like '*\\/*' and 'image/*' in MIME types.\n *\n * @template TPayload - The Payload type\n */\nexport type InferPayloadEncoding<TPayload extends Payload> =\n  TPayload extends Payload<infer TEncoding, any>\n    ? TEncoding extends string\n      ? ToBodyMime<TEncoding>\n      : undefined\n    : never\n\n/**\n * Infers the body type from a Payload and fallback type.\n *\n * @template TPayload - The Payload type\n * @template TBody - Fallback body type for non-JSON encodings without schema\n */\nexport type InferPayloadBody<TPayload extends Payload, TBinary> =\n  TPayload extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? ToBodyType<TEncoding, TSchema, TBinary>\n      : undefined\n    : never\n\n/**\n * Determines valid schema type based on encoding presence.\n *\n * @template E - The encoding string type, or undefined\n */\nexport type PayloadSchema<E extends string | undefined> = E extends undefined\n  ? undefined\n  : Schema<LexValue> | undefined\n\n/**\n * Represents a payload definition for Lexicon endpoints.\n *\n * Payloads define the body format for HTTP requests and responses.\n * They consist of an encoding (MIME type) and an optional schema\n * for validating the body content.\n *\n * @template TEncoding - The MIME type string, or undefined for no body\n * @template TPayload - The schema type for body validation\n *\n * @example\n * ```ts\n * const jsonPayload = new Payload('application/json', l.object({ data: l.string() }))\n * const binaryPayload = new Payload('image/*', undefined)\n * const noPayload = new Payload(undefined, undefined)\n * ```\n */\nexport class Payload<\n  const TEncoding extends string | undefined = string | undefined,\n  const TSchema extends PayloadSchema<TEncoding> = PayloadSchema<TEncoding>,\n> {\n  constructor(\n    readonly encoding: TEncoding,\n    readonly schema: TSchema,\n  ) {\n    if (encoding === undefined && schema !== undefined) {\n      throw new TypeError('schema cannot be defined when encoding is undefined')\n    }\n  }\n\n  /**\n   * Checks whether the given content-type matches the expected payload schema's\n   * encoding.\n   */\n  matchesEncoding(contentType: string | undefined): boolean {\n    const mime = contentType?.split(';', 1)[0].trim()\n\n    const { encoding } = this\n\n    // Handle undefined cases\n    if (encoding === undefined) {\n      // Expecting no body\n      return mime === undefined\n    } else if (mime === undefined) {\n      // Expecting a body, but got no content-type\n      return false\n    }\n\n    if (encoding === '*/*') {\n      return true\n    }\n\n    if (encoding.endsWith('/*')) {\n      return mime.startsWith(encoding.slice(0, -1))\n    }\n\n    // Invalid: Lexicon can only specify \"*/*\" or \"type/*\" wildcards\n    if (encoding.includes('*')) {\n      return false\n    }\n\n    return encoding === mime\n  }\n}\n\n/**\n * Creates a payload definition for Lexicon endpoint bodies.\n *\n * Defines the expected MIME type and optional validation schema for\n * request or response bodies.\n *\n * @param encoding - MIME type string (e.g., 'application/json', 'image/*'), or undefined for no body\n * @param validator - Optional schema for validating the body content. Must be undefined if encoding is undefined.\n * @returns A new {@link Payload} instance\n *\n * @example\n * ```ts\n * // JSON payload with schema\n * const output = l.payload('application/json', l.object({\n *   posts: l.array(postSchema),\n *   cursor: l.optional(l.string()),\n * }))\n *\n * // Binary payload (no schema validation)\n * const blobInput = l.payload('*\\/*', undefined)\n *\n * // Image payload with wildcard\n * const imageInput = l.payload('image/*', undefined)\n *\n * // No payload (for endpoints without body)\n * const noBody = l.payload()\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function payload<\n  const E extends string | undefined = undefined,\n  const S extends PayloadSchema<E> = undefined,\n>(encoding: E = undefined as E, validator: S = undefined as S) {\n  return new Payload<E, S>(encoding, validator)\n}\n\n/**\n * Creates a JSON payload with an object schema.\n *\n * Convenience function for the common case of JSON request/response bodies.\n * Equivalent to `l.payload('application/json', l.object(properties))`.\n *\n * @param properties - Object mapping property names to validators\n * @returns A new {@link Payload} instance with 'application/json' encoding\n *\n * @example\n * ```ts\n * // Query output\n * const profileOutput = l.jsonPayload({\n *   did: l.string({ format: 'did' }),\n *   handle: l.string({ format: 'handle' }),\n *   displayName: l.optional(l.string()),\n * })\n *\n * // Procedure input\n * const createPostInput = l.jsonPayload({\n *   text: l.string({ maxGraphemes: 300 }),\n *   createdAt: l.string({ format: 'datetime' }),\n * })\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function jsonPayload<\n  P extends Record<string, Validator<undefined | LexValue>>,\n>(properties: P): Payload<'application/json', ObjectSchema<P>> {\n  return payload('application/json', object(properties))\n}\n"]}
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../src/schema/payload.ts"],"names":[],"mappings":";;;AAuKA,0BAKC;AA4BD,kCAIC;AA1MD,2CAAkD;AAwElD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,OAAO;IAKP;IACA;IAFX,YACW,QAAmB,EACnB,MAAe;QADf,aAAQ,GAAR,QAAQ,CAAW;QACnB,WAAM,GAAN,MAAM,CAAS;QAExB,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACnD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAA;QAC5E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,WAA+B;QAC7C,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAEzB,yBAAyB;QACzB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,oBAAoB;YACpB,OAAO,WAAW,IAAI,IAAI,CAAA;QAC5B,CAAC;aAAM,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YAC/B,4CAA4C;YAC5C,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,IAAI,GAAG,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QACjD,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QAED,gEAAgE;QAChE,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,QAAQ,KAAK,IAAI,CAAA;IAC1B,CAAC;CACF;AA7CD,0BA6CC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAwB;AACxB,SAAgB,OAAO,CAGrB,WAAc,SAAc,EAAE,YAAe,SAAc;IAC3D,OAAO,IAAI,OAAO,CAAO,QAAQ,EAAE,SAAS,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAwB;AACxB,SAAgB,WAAW,CAEzB,UAAa;IACb,OAAO,OAAO,CAAC,kBAAkB,EAAE,IAAA,kBAAM,EAAC,UAAU,CAAC,CAAC,CAAA;AACxD,CAAC","sourcesContent":["import { LexValue } from '@atproto/lex-data'\nimport { Infer, Schema, Validator } from '../core.js'\nimport { ObjectSchema, object } from './object.js'\n\nexport type { LexValue }\n\ntype ToBodyMime<TEncoding extends string> = TEncoding extends '*/*'\n  ? `${string}/${string}`\n  : TEncoding extends `${infer T extends string}/*`\n    ? `${T}/${string}`\n    : TEncoding\n\ntype ToBodyType<\n  TEncoding extends string,\n  TSchema,\n  TBinary,\n> = TSchema extends Schema\n  ? Infer<TSchema>\n  : TEncoding extends `application/json`\n    ? LexValue\n    : TBinary\n\n/**\n * Infers the type of a Payload's encoding and body.\n *\n * @template TPayload - The Payload type\n * @template TBody - Fallback body type for non-JSON encodings\n */\nexport type InferPayload<TPayload extends Payload, TBinary> =\n  TPayload extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? {\n          encoding: ToBodyMime<TEncoding>\n          body: ToBodyType<TEncoding, TSchema, TBinary>\n        }\n      : undefined\n    : never\n\n/**\n * Converts schema encoding patterns to data encoding types.\n *\n * Handles wildcards like '*\\/*' and 'image/*' in MIME types.\n *\n * @template TPayload - The Payload type\n */\nexport type InferPayloadEncoding<TPayload extends Payload> =\n  TPayload extends Payload<infer TEncoding, any>\n    ? TEncoding extends string\n      ? ToBodyMime<TEncoding>\n      : undefined\n    : never\n\n/**\n * Infers the body type from a Payload and fallback type.\n *\n * @template TPayload - The Payload type\n * @template TBody - Fallback body type for non-JSON encodings without schema\n */\nexport type InferPayloadBody<TPayload extends Payload, TBinary> =\n  TPayload extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? ToBodyType<TEncoding, TSchema, TBinary>\n      : undefined\n    : never\n\n/**\n * Determines valid schema type based on encoding presence.\n *\n * @template E - The encoding string type, or undefined\n */\nexport type PayloadSchema<E extends string | undefined> = E extends undefined\n  ? undefined\n  : Schema<LexValue> | undefined\n\n/**\n * Represents a payload definition for Lexicon endpoints.\n *\n * Payloads define the body format for HTTP requests and responses.\n * They consist of an encoding (MIME type) and an optional schema\n * for validating the body content.\n *\n * @template TEncoding - The MIME type string, or undefined for no body\n * @template TPayload - The schema type for body validation\n *\n * @example\n * ```ts\n * const jsonPayload = new Payload('application/json', l.object({ data: l.string() }))\n * const binaryPayload = new Payload('image/*', undefined)\n * const noPayload = new Payload(undefined, undefined)\n * ```\n */\nexport class Payload<\n  const TEncoding extends string | undefined = string | undefined,\n  const TSchema extends PayloadSchema<TEncoding> = PayloadSchema<TEncoding>,\n> {\n  constructor(\n    readonly encoding: TEncoding,\n    readonly schema: TSchema,\n  ) {\n    if (encoding === undefined && schema !== undefined) {\n      throw new TypeError('schema cannot be defined when encoding is undefined')\n    }\n  }\n\n  /**\n   * Checks whether the given content-type matches the expected payload schema's\n   * encoding.\n   */\n  matchesEncoding(contentType: string | undefined): boolean {\n    const { encoding } = this\n\n    // Handle undefined cases\n    if (encoding === undefined) {\n      // Expecting no body\n      return contentType == null\n    } else if (contentType == null) {\n      // Expecting a body, but got no content-type\n      return false\n    }\n\n    if (encoding === '*/*') {\n      return true\n    }\n\n    const mime = contentType?.split(';', 1)[0].trim()\n    if (encoding.endsWith('/*')) {\n      return mime.startsWith(encoding.slice(0, -1))\n    }\n\n    // Invalid: Lexicon can only specify \"*/*\" or \"type/*\" wildcards\n    if (encoding.includes('*')) {\n      return false\n    }\n\n    return encoding === mime\n  }\n}\n\n/**\n * Creates a payload definition for Lexicon endpoint bodies.\n *\n * Defines the expected MIME type and optional validation schema for\n * request or response bodies.\n *\n * @param encoding - MIME type string (e.g., 'application/json', 'image/*'), or undefined for no body\n * @param validator - Optional schema for validating the body content. Must be undefined if encoding is undefined.\n * @returns A new {@link Payload} instance\n *\n * @example\n * ```ts\n * // JSON payload with schema\n * const output = l.payload('application/json', l.object({\n *   posts: l.array(postSchema),\n *   cursor: l.optional(l.string()),\n * }))\n *\n * // Binary payload (no schema validation)\n * const blobInput = l.payload('*\\/*', undefined)\n *\n * // Image payload with wildcard\n * const imageInput = l.payload('image/*', undefined)\n *\n * // No payload (for endpoints without body)\n * const noBody = l.payload()\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function payload<\n  const E extends string | undefined = undefined,\n  const S extends PayloadSchema<E> = undefined,\n>(encoding: E = undefined as E, validator: S = undefined as S) {\n  return new Payload<E, S>(encoding, validator)\n}\n\n/**\n * Creates a JSON payload with an object schema.\n *\n * Convenience function for the common case of JSON request/response bodies.\n * Equivalent to `l.payload('application/json', l.object(properties))`.\n *\n * @param properties - Object mapping property names to validators\n * @returns A new {@link Payload} instance with 'application/json' encoding\n *\n * @example\n * ```ts\n * // Query output\n * const profileOutput = l.jsonPayload({\n *   did: l.string({ format: 'did' }),\n *   handle: l.string({ format: 'handle' }),\n *   displayName: l.optional(l.string()),\n * })\n *\n * // Procedure input\n * const createPostInput = l.jsonPayload({\n *   text: l.string({ maxGraphemes: 300 }),\n *   createdAt: l.string({ format: 'datetime' }),\n * })\n * ```\n */\n/*@__NO_SIDE_EFFECTS__*/\nexport function jsonPayload<\n  P extends Record<string, Validator<undefined | LexValue>>,\n>(properties: P): Payload<'application/json', ObjectSchema<P>> {\n  return payload('application/json', object(properties))\n}\n"]}

package/dist/schema/record.d.ts

@@ -5,6 +5,13 @@ import { $Typed, InferInput, InferOutput, LexiconRecordKey, NsidString, Schema,
  * @template R - The RecordSchema type
  */
 export type InferRecordKey<R extends RecordSchema> = R extends RecordSchema<infer TKey> ? RecordKeySchemaOutput<TKey> : never;
+export type TypedRecord<TType extends NsidString, TValue extends {
+    $type?: unknown;
+} = {
+    $type?: unknown;
+}> = TValue extends {
+    $type: TType;
+} ? TValue : $Typed<Exclude<TValue, Unknown$TypedObject>, TType>;
 /**
  * Schema for AT Protocol records with a type identifier and key constraints.
  *
@@ -31,29 +38,24 @@ export declare class RecordSchema<const TKey extends LexiconRecordKey = any, con
     readonly key: TKey;
     readonly $type: TType;
     readonly schema: TShape;
+    readonly type: "record";
     keySchema: RecordKeySchema<TKey>;
     constructor(key: TKey, $type: TType, schema: TShape);
-    isTypeOf<X extends {
-        $type?: unknown;
-    }>(value: X): value is X extends {
-        $type: TType;
-    } ? X : $Typed<Exclude<X, Unknown$TypedObject>, TType>;
+    validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationFailure | import("../core.js").ValidationSuccess<InferInput<TShape>>;
     build(input: Omit<InferInput<this>, '$type'>): $Typed<InferOutput<this>, TType>;
-    $isTypeOf<X extends {
+    isTypeOf<TValue extends {
         $type?: unknown;
-    }>(value: X): value is X extends {
-        $type: TType;
-    } ? X : Exclude<X, Unknown$TypedObject> & {
-        $type: TType;
-    } extends infer T ? { [K in keyof T]: (Exclude<X, Unknown$TypedObject> & {
-        $type: TType;
-    })[K]; } : never;
-    $build(input: Omit<InferInput<this>, '$type'>): InferOutput<this> & {
-        $type: TType;
-    } extends infer T ? { [K in keyof T]: (InferOutput<this> & {
-        $type: TType;
-    })[K]; } : never;
-    validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationFailure | import("../core.js").ValidationSuccess<InferInput<TShape>>;
+    }>(value: TValue): value is TypedRecord<TType, TValue>;
+    /**
+     * Bound alias for {@link build} for compatibility with generated utilities.
+     * @see {@link build}
+     */
+    get $build(): typeof this.build;
+    /**
+     * Bound alias for {@link isTypeOf} for compatibility with generated utilities.
+     * @see {@link isTypeOf}
+     */
+    get $isTypeOf(): typeof this.isTypeOf;
 }
 export type RecordKeySchemaOutput<Key extends LexiconRecordKey> = Key extends 'any' ? string : Key extends 'tid' ? TidString : Key extends 'nsid' ? NsidString : Key extends `literal:${infer L extends string}` ? L : never;
 export type RecordKeySchema<Key extends LexiconRecordKey> = Schema<RecordKeySchemaOutput<Key>>;