@atproto/lex-schema 0.0.10 → 0.0.12

package/dist/schema/object.js

@@ -5,6 +5,23 @@ exports.object = object;
 const lex_data_1 = require("@atproto/lex-data");
 const core_js_1 = require("../core.js");
 const lazy_property_js_1 = require("../util/lazy-property.js");
+/**
+ * Schema for validating objects with a defined shape.
+ *
+ * Each property in the shape is validated against its corresponding schema.
+ * Properties wrapped in `optional()` are not required.
+ *
+ * @template TShape - The object shape type mapping property names to validators
+ *
+ * @example
+ * ```ts
+ * const schema = new ObjectSchema({
+ *   name: l.string(),
+ *   age: l.optional(l.integer()),
+ * })
+ * const result = schema.validate({ name: 'Alice' })
+ * ```
+ */
 class ObjectSchema extends core_js_1.Schema {
     shape;
     constructor(shape) {
@@ -47,6 +64,40 @@ class ObjectSchema extends core_js_1.Schema {
     }
 }
 exports.ObjectSchema = ObjectSchema;
+/**
+ * Creates an object schema with the specified property validators.
+ *
+ * Validates that the input is a plain object and each property matches
+ * its corresponding schema. Properties wrapped in `optional()` are not required.
+ *
+ * @param properties - Object mapping property names to their validators
+ * @returns A new {@link ObjectSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Basic object
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   email: l.string({ format: 'uri' }),
+ * })
+ *
+ * // With optional properties
+ * const profileSchema = l.object({
+ *   displayName: l.string(),
+ *   bio: l.optional(l.string({ maxLength: 256 })),
+ *   avatar: l.optional(l.blob({ accept: ['image/*'] })),
+ * })
+ *
+ * // Nested objects
+ * const postSchema = l.object({
+ *   text: l.string(),
+ *   author: l.object({
+ *     did: l.string({ format: 'did' }),
+ *     handle: l.string({ format: 'handle' }),
+ *   }),
+ * })
+ * ```
+ */
 /*@__NO_SIDE_EFFECTS__*/
 function object(properties) {
     return new ObjectSchema(properties);

package/dist/schema/object.js.map

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/schema/object.ts"],"names":[],"mappings":";;;AAyEA,wBAIC;AA7ED,gDAAiD;AACjD,wCAOmB;AACnB,+DAAuD;AAIvD,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,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\nexport type ObjectSchemaShape = Record<string, Validator>\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/*@__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":";;;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"]}

package/dist/schema/optional.d.ts

@@ -1,9 +1,51 @@
 import { InferInput, InferOutput, Schema, UnwrapValidator, ValidationContext, Validator } from '../core.js';
 import { WithDefaultSchema } from './with-default.js';
+/**
+ * Schema wrapper that makes a value optional (allows undefined).
+ *
+ * When the input is `undefined`, validation succeeds without running the
+ * inner validator. If the inner validator has a default value (via `withDefault`),
+ * that default will be applied in parse mode.
+ *
+ * @template TValidator - The wrapped validator type
+ *
+ * @example
+ * ```ts
+ * const schema = new OptionalSchema(l.string())
+ * schema.validate(undefined) // success
+ * schema.validate('hello')   // success
+ * ```
+ */
 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;
     constructor(validator: TValidator);
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<undefined> | import("../core.js").ValidationSuccess<InferInput<TValidator>>;
 }
+/**
+ * Creates an optional schema that allows undefined values.
+ *
+ * Wraps another schema to make it optional. When used in an object schema,
+ * properties with optional schemas are not required.
+ *
+ * @param validator - The validator to make optional
+ * @returns A new {@link OptionalSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Optional string
+ * const optionalBio = l.optional(l.string())
+ *
+ * // In an object - property is not required
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   bio: l.optional(l.string()),
+ * })
+ * userSchema.parse({ name: 'Alice' }) // Valid, bio is undefined
+ *
+ * // With default value
+ * const countSchema = l.optional(l.withDefault(l.integer(), 0))
+ * countSchema.parse(undefined) // Returns 0
+ * ```
+ */
 export declare const optional: <const TValidator extends Validator>(validator: TValidator) => OptionalSchema<TValidator>;
 //# sourceMappingURL=optional.d.ts.map

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,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,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;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"}

package/dist/schema/optional.js

@@ -3,6 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.optional = exports.OptionalSchema = void 0;
 const core_js_1 = require("../core.js");
 const memoize_js_1 = require("../util/memoize.js");
+/**
+ * Schema wrapper that makes a value optional (allows undefined).
+ *
+ * When the input is `undefined`, validation succeeds without running the
+ * inner validator. If the inner validator has a default value (via `withDefault`),
+ * that default will be applied in parse mode.
+ *
+ * @template TValidator - The wrapped validator type
+ *
+ * @example
+ * ```ts
+ * const schema = new OptionalSchema(l.string())
+ * schema.validate(undefined) // success
+ * schema.validate('hello')   // success
+ * ```
+ */
 class OptionalSchema extends core_js_1.Schema {
     validator;
     constructor(validator) {
@@ -27,6 +43,32 @@ class OptionalSchema extends core_js_1.Schema {
     }
 }
 exports.OptionalSchema = OptionalSchema;
+/**
+ * Creates an optional schema that allows undefined values.
+ *
+ * Wraps another schema to make it optional. When used in an object schema,
+ * properties with optional schemas are not required.
+ *
+ * @param validator - The validator to make optional
+ * @returns A new {@link OptionalSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Optional string
+ * const optionalBio = l.optional(l.string())
+ *
+ * // In an object - property is not required
+ * const userSchema = l.object({
+ *   name: l.string(),
+ *   bio: l.optional(l.string()),
+ * })
+ * userSchema.parse({ name: 'Alice' }) // Valid, bio is undefined
+ *
+ * // With default value
+ * const countSchema = l.optional(l.withDefault(l.integer(), 0))
+ * countSchema.parse(undefined) // Returns 0
+ * ```
+ */
 exports.optional = (0, memoize_js_1.memoizedTransformer)(function (validator) {
     return new OptionalSchema(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,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;AAEY,QAAA,QAAQ,GAAiB,IAAA,gCAAmB,EAAC,UAExD,SAAqB;IACrB,OAAO,IAAI,cAAc,CAAa,SAAS,CAAC,CAAA;AAClD,CAAC,CAAC,CAAA","sourcesContent":["import {\n  InferInput,\n  InferOutput,\n  Schema,\n  UnwrapValidator,\n  ValidationContext,\n  Validator,\n} from '../core.js'\nimport { memoizedTransformer } from '../util/memoize.js'\nimport { WithDefaultSchema } from './with-default.js'\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\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;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"]}

package/dist/schema/params.d.ts

@@ -1,14 +1,61 @@
-import { Infer, InferInput, InferOutput, Schema, ValidationContext, Validator, WithOptionalProperties } from '../core.js';
+import { Infer, InferInput, InferOutput, Schema, ValidationContext, WithOptionalProperties } from '../core.js';
+import { ArraySchema } from './array.js';
+import { BooleanSchema } from './boolean.js';
+import { IntegerSchema } from './integer.js';
+import { OptionalSchema } from './optional.js';
 import { StringSchema } from './string.js';
+import { WithDefaultSchema } from './with-default.js';
+/**
+ * Scalar types allowed in URL parameters: boolean, integer, or string.
+ */
 export type ParamScalar = Infer<typeof paramScalarSchema>;
-declare const paramScalarSchema: import("./union.js").UnionSchema<readonly [import("./boolean.js").BooleanSchema, import("./integer.js").IntegerSchema, StringSchema<{}>]>;
+declare const paramScalarSchema: import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>;
+/**
+ * A single parameter value: scalar or array of scalars.
+ */
 export type Param = Infer<typeof paramSchema>;
-export declare const paramSchema: import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [import("./boolean.js").BooleanSchema, import("./integer.js").IntegerSchema, StringSchema<{}>]>, import("./array.js").ArraySchema<import("./union.js").UnionSchema<readonly [import("./boolean.js").BooleanSchema, import("./integer.js").IntegerSchema, StringSchema<{}>]>>]>;
+/**
+ * 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<{}>]>>]>;
+/**
+ * Type for a params object with string keys and optional param values.
+ */
 export type Params = Infer<typeof paramsSchema>;
-export declare const paramsSchema: import("./dict.js").DictSchema<StringSchema<{}>, import("./optional.js").OptionalSchema<import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [import("./boolean.js").BooleanSchema, import("./integer.js").IntegerSchema, StringSchema<{}>]>, import("./array.js").ArraySchema<import("./union.js").UnionSchema<readonly [import("./boolean.js").BooleanSchema, import("./integer.js").IntegerSchema, StringSchema<{}>]>>]>>>;
+/**
+ * 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>;
+/**
+ * Type representing the shape of a params schema definition.
+ *
+ * Maps parameter names to their validators (must be Param or undefined).
+ */
 export type ParamsSchemaShape = {
-    [x: string]: Validator<Param | undefined>;
+    [x: string]: ParamValidator;
 };
+/**
+ * Schema for validating URL query parameters in Lexicon endpoints.
+ *
+ * Params are the query string parameters passed to queries, procedures,
+ * and subscriptions. Values must be scalars (boolean, integer, string)
+ * or arrays of scalars, as they need to be serializable to URL format.
+ *
+ * Provides methods for converting to/from URLSearchParams.
+ *
+ * @template TShape - The params shape type mapping names to validators
+ *
+ * @example
+ * ```ts
+ * const schema = new ParamsSchema({
+ *   limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),
+ *   cursor: l.optional(l.string()),
+ * })
+ * ```
+ */
 export declare class ParamsSchema<const TShape extends ParamsSchemaShape = ParamsSchemaShape> extends Schema<WithOptionalProperties<{
     [K in keyof TShape]: InferInput<TShape[K]>;
 }>, WithOptionalProperties<{
@@ -16,11 +63,46 @@ export declare class ParamsSchema<const TShape extends ParamsSchemaShape = Param
 }>> {
     readonly shape: TShape;
     constructor(shape: TShape);
-    get shapeValidators(): Map<string, Validator<Param | undefined>>;
+    get shapeValidators(): Map<string, ParamValidator>;
     validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Record<string, unknown>>;
-    fromURLSearchParams(urlSearchParams: URLSearchParams): InferOutput<this>;
+    fromURLSearchParams(iterable: Iterable<[string, string]>): InferOutput<this>;
     toURLSearchParams(input: InferInput<this>): URLSearchParams;
 }
+/**
+ * Creates a params schema for URL query parameters.
+ *
+ * Params schemas validate query string parameters for Lexicon endpoints.
+ * Values must be boolean, integer, string, or arrays of those types.
+ *
+ * @param properties - Object mapping parameter names to their validators
+ * @returns A new {@link ParamsSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Simple pagination params
+ * const paginationParams = l.params({
+ *   limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),
+ *   cursor: l.optional(l.string()),
+ * })
+ *
+ * // Required parameter
+ * const actorParams = l.params({
+ *   actor: l.string({ format: 'at-identifier' }),
+ * })
+ *
+ * // Array parameter (multiple values)
+ * const filterParams = l.params({
+ *   tags: l.optional(l.array(l.string())),
+ * })
+ *
+ * // Convert from URL
+ * const urlParams = new URLSearchParams('limit=25&cursor=abc')
+ * const validated = paginationParams.fromURLSearchParams(urlParams)
+ *
+ * // Convert to URL
+ * const searchParams = paginationParams.toURLSearchParams({ limit: 25 })
+ * ```
+ */
 export declare const params: <const TShape extends ParamsSchemaShape = {}>(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,EACjB,SAAS,EACT,sBAAsB,EACvB,MAAM,YAAY,CAAA;AAQnB,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAA;AAGlD,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACzD,QAAA,MAAM,iBAAiB,2IAA0C,CAAA;AAEjE,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAC7C,eAAO,MAAM,WAAW,qWAAuD,CAAA;AAE/E,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAC/C,eAAO,MAAM,YAAY,+bAAwC,CAAA;AAEjE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,CAAA;CAC1C,CAAA;AAED,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,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAI/D;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;IA0DxD,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC;IA6BxE,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,eAAe;CAmB5D;AAED,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,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"}

package/dist/schema/params.js

@@ -12,9 +12,35 @@ const integer_js_1 = require("./integer.js");
 const optional_js_1 = require("./optional.js");
 const string_js_1 = require("./string.js");
 const union_js_1 = require("./union.js");
+const with_default_js_1 = require("./with-default.js");
 const paramScalarSchema = (0, union_js_1.union)([(0, boolean_js_1.boolean)(), (0, integer_js_1.integer)(), (0, string_js_1.string)()]);
+/**
+ * Schema for validating individual parameter values.
+ */
 exports.paramSchema = (0, union_js_1.union)([paramScalarSchema, (0, array_js_1.array)(paramScalarSchema)]);
+/**
+ * Schema for validating arbitrary params objects.
+ */
 exports.paramsSchema = (0, dict_js_1.dict)((0, string_js_1.string)(), (0, optional_js_1.optional)(exports.paramSchema));
+/**
+ * Schema for validating URL query parameters in Lexicon endpoints.
+ *
+ * Params are the query string parameters passed to queries, procedures,
+ * and subscriptions. Values must be scalars (boolean, integer, string)
+ * or arrays of scalars, as they need to be serializable to URL format.
+ *
+ * Provides methods for converting to/from URLSearchParams.
+ *
+ * @template TShape - The params shape type mapping names to validators
+ *
+ * @example
+ * ```ts
+ * const schema = new ParamsSchema({
+ *   limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),
+ *   cursor: l.optional(l.string()),
+ * })
+ * ```
+ */
 class ParamsSchema extends core_js_1.Schema {
     shape;
     constructor(shape) {
@@ -26,7 +52,6 @@ class ParamsSchema extends core_js_1.Schema {
         return (0, lazy_property_js_1.lazyProperty)(this, 'shapeValidators', map);
     }
     validateInContext(input, ctx) {
-        // @TODO BETTER SUPPORT Input/Output
         if (!(0, lex_data_1.isPlainObject)(input)) {
             return ctx.issueInvalidType(input, 'object');
         }
@@ -73,11 +98,17 @@ class ParamsSchema extends core_js_1.Schema {
         }
         return ctx.success(copy ?? input);
     }
-    fromURLSearchParams(urlSearchParams) {
+    fromURLSearchParams(iterable) {
         const params = {};
-        for (const [key, value] of urlSearchParams.entries()) {
-            const validator = this.shapeValidators.get(key);
-            const coerced = validator instanceof string_js_1.StringSchema
+        // Compatibility with URLSearchParams not being iterable in some environments
+        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;
+            const scalarValidator = expectsArray
+                ? unwrapValidator(validator.validator)
+                : validator;
+            const coerced = scalarValidator instanceof string_js_1.StringSchema
                 ? value
                 : value === 'true'
                     ? true
@@ -86,14 +117,15 @@ class ParamsSchema extends core_js_1.Schema {
                         : /^-?\d+$/.test(value)
                             ? Number(value)
                             : value;
-            if (params[key] === undefined) {
-                params[key] = coerced;
+            const currentParam = params[key];
+            if (currentParam === undefined) {
+                params[key] = expectsArray ? [coerced] : coerced;
             }
-            else if (Array.isArray(params[key])) {
-                params[key].push(coerced);
+            else if (Array.isArray(currentParam)) {
+                currentParam.push(coerced);
             }
             else {
-                params[key] = [params[key], coerced];
+                params[key] = [currentParam, coerced];
             }
         }
         return this.parse(params);
@@ -117,7 +149,49 @@ class ParamsSchema extends core_js_1.Schema {
     }
 }
 exports.ParamsSchema = ParamsSchema;
+/**
+ * Creates a params schema for URL query parameters.
+ *
+ * Params schemas validate query string parameters for Lexicon endpoints.
+ * Values must be boolean, integer, string, or arrays of those types.
+ *
+ * @param properties - Object mapping parameter names to their validators
+ * @returns A new {@link ParamsSchema} instance
+ *
+ * @example
+ * ```ts
+ * // Simple pagination params
+ * const paginationParams = l.params({
+ *   limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),
+ *   cursor: l.optional(l.string()),
+ * })
+ *
+ * // Required parameter
+ * const actorParams = l.params({
+ *   actor: l.string({ format: 'at-identifier' }),
+ * })
+ *
+ * // Array parameter (multiple values)
+ * const filterParams = l.params({
+ *   tags: l.optional(l.array(l.string())),
+ * })
+ *
+ * // Convert from URL
+ * const urlParams = new URLSearchParams('limit=25&cursor=abc')
+ * const validated = paginationParams.fromURLSearchParams(urlParams)
+ *
+ * // Convert to URL
+ * const searchParams = paginationParams.toURLSearchParams({ limit: 25 })
+ * ```
+ */
 exports.params = (0, memoize_js_1.memoizedOptions)(function params(properties = {}) {
     return new ParamsSchema(properties);
 });
+function unwrapValidator(schema) {
+    while (schema instanceof optional_js_1.OptionalSchema ||
+        schema instanceof with_default_js_1.WithDefaultSchema) {
+        schema = schema.validator;
+    }
+    return schema;
+}
 //# sourceMappingURL=params.js.map

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,yCAAkC;AAClC,6CAAsC;AACtC,uCAAgC;AAChC,6CAAsC;AACtC,+CAAwC;AACxC,2CAAkD;AAClD,yCAAkC;AAGlC,MAAM,iBAAiB,GAAG,IAAA,gBAAK,EAAC,CAAC,IAAA,oBAAO,GAAE,EAAE,IAAA,oBAAO,GAAE,EAAE,IAAA,kBAAM,GAAE,CAAC,CAAC,CAAA;AAGpD,QAAA,WAAW,GAAG,IAAA,gBAAK,EAAC,CAAC,iBAAiB,EAAE,IAAA,gBAAK,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAGlE,QAAA,YAAY,GAAG,IAAA,cAAI,EAAC,IAAA,kBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,mBAAW,CAAC,CAAC,CAAA;AAMjE,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,oCAAoC;QACpC,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,eAAgC;QAClD,MAAM,MAAM,GAA0B,EAAE,CAAA;QAExC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAE/C,MAAM,OAAO,GACX,SAAS,YAAY,wBAAY;gBAC/B,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,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAA;YACvB,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAgB,EAAE,OAAO,CAAC,CAAA;YACrD,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;AA9HD,oCA8HC;AAEY,QAAA,MAAM,GAAiB,IAAA,4BAAe,EAAC,SAAS,MAAM,CAEjE,aAAqB,EAAY;IACjC,OAAO,IAAI,YAAY,CAAS,UAAU,CAAC,CAAA;AAC7C,CAAC,CAAC,CAAA","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 { array } from './array.js'\nimport { boolean } from './boolean.js'\nimport { dict } from './dict.js'\nimport { integer } from './integer.js'\nimport { optional } from './optional.js'\nimport { StringSchema, string } from './string.js'\nimport { union } from './union.js'\n\nexport type ParamScalar = Infer<typeof paramScalarSchema>\nconst paramScalarSchema = union([boolean(), integer(), string()])\n\nexport type Param = Infer<typeof paramSchema>\nexport const paramSchema = union([paramScalarSchema, array(paramScalarSchema)])\n\nexport type Params = Infer<typeof paramsSchema>\nexport const paramsSchema = dict(string(), optional(paramSchema))\n\nexport type ParamsSchemaShape = {\n  [x: string]: Validator<Param | undefined>\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, Validator<Param | undefined>> {\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    // @TODO BETTER SUPPORT Input/Output\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(urlSearchParams: URLSearchParams): InferOutput<this> {\n    const params: Record<string, Param> = {}\n\n    for (const [key, value] of urlSearchParams.entries()) {\n      const validator = this.shapeValidators.get(key)\n\n      const coerced: ParamScalar =\n        validator 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      if (params[key] === undefined) {\n        params[key] = coerced\n      } else if (Array.isArray(params[key])) {\n        params[key].push(coerced)\n      } else {\n        params[key] = [params[key] as ParamScalar, 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\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"]}
+{"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"]}