@atproto/lex-schema 0.0.11 → 0.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +54 -0
- package/dist/core/$type.d.ts +149 -0
- package/dist/core/$type.d.ts.map +1 -1
- package/dist/core/$type.js +44 -0
- package/dist/core/$type.js.map +1 -1
- package/dist/core/record-key.d.ts +44 -0
- package/dist/core/record-key.d.ts.map +1 -1
- package/dist/core/record-key.js +30 -0
- package/dist/core/record-key.js.map +1 -1
- package/dist/core/result.d.ts +85 -4
- package/dist/core/result.d.ts.map +1 -1
- package/dist/core/result.js +60 -4
- package/dist/core/result.js.map +1 -1
- package/dist/core/schema.d.ts +232 -5
- package/dist/core/schema.d.ts.map +1 -1
- package/dist/core/schema.js +197 -4
- package/dist/core/schema.js.map +1 -1
- package/dist/core/string-format.d.ts +244 -11
- package/dist/core/string-format.d.ts.map +1 -1
- package/dist/core/string-format.js +150 -0
- package/dist/core/string-format.js.map +1 -1
- package/dist/core/types.d.ts +90 -3
- package/dist/core/types.d.ts.map +1 -1
- package/dist/core/types.js.map +1 -1
- package/dist/core/validation-error.d.ts +60 -0
- package/dist/core/validation-error.d.ts.map +1 -1
- package/dist/core/validation-error.js +60 -0
- package/dist/core/validation-error.js.map +1 -1
- package/dist/core/validation-issue.d.ts +61 -0
- package/dist/core/validation-issue.d.ts.map +1 -1
- package/dist/core/validation-issue.js +54 -1
- package/dist/core/validation-issue.js.map +1 -1
- package/dist/core/validator.d.ts +356 -11
- package/dist/core/validator.d.ts.map +1 -1
- package/dist/core/validator.js +203 -4
- package/dist/core/validator.js.map +1 -1
- package/dist/helpers.d.ts +12 -28
- package/dist/helpers.d.ts.map +1 -1
- package/dist/helpers.js.map +1 -1
- package/dist/schema/array.d.ts +46 -0
- package/dist/schema/array.d.ts.map +1 -1
- package/dist/schema/array.js +16 -1
- package/dist/schema/array.js.map +1 -1
- package/dist/schema/blob.d.ts +50 -2
- package/dist/schema/blob.d.ts.map +1 -1
- package/dist/schema/blob.js +44 -2
- package/dist/schema/blob.js.map +1 -1
- package/dist/schema/boolean.d.ts +29 -0
- package/dist/schema/boolean.d.ts.map +1 -1
- package/dist/schema/boolean.js +30 -1
- package/dist/schema/boolean.js.map +1 -1
- package/dist/schema/bytes.d.ts +39 -0
- package/dist/schema/bytes.d.ts.map +1 -1
- package/dist/schema/bytes.js +34 -1
- package/dist/schema/bytes.js.map +1 -1
- package/dist/schema/cid.d.ts +39 -0
- package/dist/schema/cid.d.ts.map +1 -1
- package/dist/schema/cid.js +35 -1
- package/dist/schema/cid.js.map +1 -1
- package/dist/schema/custom.d.ts +67 -1
- package/dist/schema/custom.d.ts.map +1 -1
- package/dist/schema/custom.js +55 -0
- package/dist/schema/custom.js.map +1 -1
- package/dist/schema/dict.d.ts +45 -0
- package/dist/schema/dict.d.ts.map +1 -1
- package/dist/schema/dict.js +46 -1
- package/dist/schema/dict.js.map +1 -1
- package/dist/schema/discriminated-union.d.ts +59 -0
- package/dist/schema/discriminated-union.d.ts.map +1 -1
- package/dist/schema/discriminated-union.js +47 -1
- package/dist/schema/discriminated-union.js.map +1 -1
- package/dist/schema/enum.d.ts +49 -0
- package/dist/schema/enum.d.ts.map +1 -1
- package/dist/schema/enum.js +49 -0
- package/dist/schema/enum.js.map +1 -1
- package/dist/schema/integer.d.ts +43 -0
- package/dist/schema/integer.d.ts.map +1 -1
- package/dist/schema/integer.js +38 -1
- package/dist/schema/integer.js.map +1 -1
- package/dist/schema/intersection.d.ts +55 -0
- package/dist/schema/intersection.d.ts.map +1 -1
- package/dist/schema/intersection.js +50 -0
- package/dist/schema/intersection.js.map +1 -1
- package/dist/schema/lex-map.d.ts +37 -0
- package/dist/schema/lex-map.d.ts.map +1 -0
- package/dist/schema/lex-map.js +60 -0
- package/dist/schema/lex-map.js.map +1 -0
- package/dist/schema/lex-value.d.ts +35 -0
- package/dist/schema/lex-value.d.ts.map +1 -0
- package/dist/schema/lex-value.js +87 -0
- package/dist/schema/lex-value.js.map +1 -0
- package/dist/schema/literal.d.ts +45 -0
- package/dist/schema/literal.d.ts.map +1 -1
- package/dist/schema/literal.js +45 -0
- package/dist/schema/literal.js.map +1 -1
- package/dist/schema/never.d.ts +43 -0
- package/dist/schema/never.d.ts.map +1 -1
- package/dist/schema/never.js +44 -1
- package/dist/schema/never.js.map +1 -1
- package/dist/schema/null.d.ts +30 -0
- package/dist/schema/null.d.ts.map +1 -1
- package/dist/schema/null.js +31 -1
- package/dist/schema/null.js.map +1 -1
- package/dist/schema/nullable.d.ts +42 -0
- package/dist/schema/nullable.d.ts.map +1 -1
- package/dist/schema/nullable.js +42 -0
- package/dist/schema/nullable.js.map +1 -1
- package/dist/schema/object.d.ts +57 -0
- package/dist/schema/object.d.ts.map +1 -1
- package/dist/schema/object.js +53 -1
- package/dist/schema/object.js.map +1 -1
- package/dist/schema/optional.d.ts +43 -0
- package/dist/schema/optional.d.ts.map +1 -1
- package/dist/schema/optional.js +43 -0
- package/dist/schema/optional.js.map +1 -1
- package/dist/schema/params.d.ts +96 -12
- package/dist/schema/params.d.ts.map +1 -1
- package/dist/schema/params.js +155 -21
- package/dist/schema/params.js.map +1 -1
- package/dist/schema/payload.d.ts +111 -15
- package/dist/schema/payload.d.ts.map +1 -1
- package/dist/schema/payload.js +73 -3
- package/dist/schema/payload.js.map +1 -1
- package/dist/schema/permission-set.d.ts +58 -0
- package/dist/schema/permission-set.d.ts.map +1 -1
- package/dist/schema/permission-set.js +50 -0
- package/dist/schema/permission-set.js.map +1 -1
- package/dist/schema/permission.d.ts +42 -0
- package/dist/schema/permission.d.ts.map +1 -1
- package/dist/schema/permission.js +39 -0
- package/dist/schema/permission.js.map +1 -1
- package/dist/schema/procedure.d.ts +64 -0
- package/dist/schema/procedure.d.ts.map +1 -1
- package/dist/schema/procedure.js +64 -0
- package/dist/schema/procedure.js.map +1 -1
- package/dist/schema/query.d.ts +55 -0
- package/dist/schema/query.d.ts.map +1 -1
- package/dist/schema/query.js +55 -0
- package/dist/schema/query.js.map +1 -1
- package/dist/schema/record.d.ts +76 -25
- package/dist/schema/record.d.ts.map +1 -1
- package/dist/schema/record.js +21 -0
- package/dist/schema/record.js.map +1 -1
- package/dist/schema/ref.d.ts +51 -0
- package/dist/schema/ref.d.ts.map +1 -1
- package/dist/schema/ref.js +18 -0
- package/dist/schema/ref.js.map +1 -1
- package/dist/schema/refine.d.ts +58 -9
- package/dist/schema/refine.d.ts.map +1 -1
- package/dist/schema/refine.js.map +1 -1
- package/dist/schema/regexp.d.ts +45 -0
- package/dist/schema/regexp.d.ts.map +1 -1
- package/dist/schema/regexp.js +46 -1
- package/dist/schema/regexp.js.map +1 -1
- package/dist/schema/string.d.ts +72 -6
- package/dist/schema/string.d.ts.map +1 -1
- package/dist/schema/string.js +56 -8
- package/dist/schema/string.js.map +1 -1
- package/dist/schema/subscription.d.ts +72 -2
- package/dist/schema/subscription.d.ts.map +1 -1
- package/dist/schema/subscription.js +59 -0
- package/dist/schema/subscription.js.map +1 -1
- package/dist/schema/token.d.ts +48 -0
- package/dist/schema/token.d.ts.map +1 -1
- package/dist/schema/token.js +49 -1
- package/dist/schema/token.js.map +1 -1
- package/dist/schema/typed-object.d.ts +73 -23
- package/dist/schema/typed-object.d.ts.map +1 -1
- package/dist/schema/typed-object.js +20 -1
- package/dist/schema/typed-object.js.map +1 -1
- package/dist/schema/typed-ref.d.ts +54 -0
- package/dist/schema/typed-ref.d.ts.map +1 -1
- package/dist/schema/typed-ref.js +16 -0
- package/dist/schema/typed-ref.js.map +1 -1
- package/dist/schema/typed-union.d.ts +51 -1
- package/dist/schema/typed-union.d.ts.map +1 -1
- package/dist/schema/typed-union.js +52 -2
- package/dist/schema/typed-union.js.map +1 -1
- package/dist/schema/union.d.ts +46 -0
- package/dist/schema/union.d.ts.map +1 -1
- package/dist/schema/union.js +41 -0
- package/dist/schema/union.js.map +1 -1
- package/dist/schema/unknown.d.ts +34 -0
- package/dist/schema/unknown.d.ts.map +1 -1
- package/dist/schema/unknown.js +34 -0
- package/dist/schema/unknown.js.map +1 -1
- package/dist/schema/with-default.d.ts +45 -0
- package/dist/schema/with-default.d.ts.map +1 -1
- package/dist/schema/with-default.js +45 -0
- package/dist/schema/with-default.js.map +1 -1
- package/dist/schema.d.ts +2 -1
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +2 -1
- package/dist/schema.js.map +1 -1
- package/dist/util/if-any.d.ts +2 -0
- package/dist/util/if-any.d.ts.map +1 -0
- package/dist/util/if-any.js +3 -0
- package/dist/util/if-any.js.map +1 -0
- package/package.json +3 -3
- package/src/core/$type.ts +150 -18
- package/src/core/record-key.ts +44 -0
- package/src/core/result.ts +86 -4
- package/src/core/schema.ts +244 -9
- package/src/core/string-format.ts +259 -13
- package/src/core/types.ts +91 -3
- package/src/core/validation-error.ts +60 -0
- package/src/core/validation-issue.ts +68 -2
- package/src/core/validator.ts +373 -12
- package/src/helpers.test.ts +110 -29
- package/src/helpers.ts +54 -25
- package/src/schema/array.test.ts +94 -79
- package/src/schema/array.ts +48 -1
- package/src/schema/blob.ts +50 -1
- package/src/schema/boolean.ts +31 -1
- package/src/schema/bytes.ts +41 -1
- package/src/schema/cid.ts +41 -1
- package/src/schema/custom.ts +68 -1
- package/src/schema/dict.ts +47 -1
- package/src/schema/discriminated-union.ts +61 -1
- package/src/schema/enum.ts +50 -0
- package/src/schema/integer.ts +45 -1
- package/src/schema/intersection.ts +56 -0
- package/src/schema/{unknown-object.test.ts → lex-map.test.ts} +9 -9
- package/src/schema/lex-map.ts +63 -0
- package/src/schema/lex-value.test.ts +81 -0
- package/src/schema/lex-value.ts +86 -0
- package/src/schema/literal.ts +46 -0
- package/src/schema/never.ts +45 -1
- package/src/schema/null.ts +32 -1
- package/src/schema/nullable.ts +43 -0
- package/src/schema/object.ts +59 -1
- package/src/schema/optional.ts +44 -0
- package/src/schema/params.test.ts +133 -38
- package/src/schema/params.ts +237 -37
- package/src/schema/payload.test.ts +3 -3
- package/src/schema/payload.ts +145 -42
- package/src/schema/permission-set.ts +58 -0
- package/src/schema/permission.ts +42 -0
- package/src/schema/procedure.ts +64 -0
- package/src/schema/query.ts +55 -0
- package/src/schema/record.ts +82 -16
- package/src/schema/ref.ts +52 -0
- package/src/schema/refine.ts +58 -9
- package/src/schema/regexp.ts +47 -1
- package/src/schema/string.test.ts +99 -2
- package/src/schema/string.ts +108 -15
- package/src/schema/subscription.ts +72 -2
- package/src/schema/token.ts +50 -1
- package/src/schema/typed-object.ts +81 -16
- package/src/schema/typed-ref.ts +55 -0
- package/src/schema/typed-union.ts +58 -3
- package/src/schema/union.ts +47 -0
- package/src/schema/unknown.ts +35 -0
- package/src/schema/with-default.ts +46 -0
- package/src/schema.ts +2 -1
- package/src/util/if-any.ts +3 -0
- package/dist/schema/unknown-object.d.ts +0 -8
- package/dist/schema/unknown-object.d.ts.map +0 -1
- package/dist/schema/unknown-object.js +0 -19
- package/dist/schema/unknown-object.js.map +0 -1
- package/src/schema/unknown-object.ts +0 -19
|
@@ -1 +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;
|
|
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;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
CHANGED
|
@@ -3,8 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.optional = exports.OptionalSchema = void 0;
|
|
4
4
|
const core_js_1 = require("../core.js");
|
|
5
5
|
const memoize_js_1 = require("../util/memoize.js");
|
|
6
|
+
/**
|
|
7
|
+
* Schema wrapper that makes a value optional (allows undefined).
|
|
8
|
+
*
|
|
9
|
+
* When the input is `undefined`, validation succeeds without running the
|
|
10
|
+
* inner validator. If the inner validator has a default value (via `withDefault`),
|
|
11
|
+
* that default will be applied in parse mode.
|
|
12
|
+
*
|
|
13
|
+
* @template TValidator - The wrapped validator type
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const schema = new OptionalSchema(l.string())
|
|
18
|
+
* schema.validate(undefined) // success
|
|
19
|
+
* schema.validate('hello') // success
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
6
22
|
class OptionalSchema extends core_js_1.Schema {
|
|
7
23
|
validator;
|
|
24
|
+
type = 'optional';
|
|
8
25
|
constructor(validator) {
|
|
9
26
|
super();
|
|
10
27
|
this.validator = validator;
|
|
@@ -27,6 +44,32 @@ class OptionalSchema extends core_js_1.Schema {
|
|
|
27
44
|
}
|
|
28
45
|
}
|
|
29
46
|
exports.OptionalSchema = OptionalSchema;
|
|
47
|
+
/**
|
|
48
|
+
* Creates an optional schema that allows undefined values.
|
|
49
|
+
*
|
|
50
|
+
* Wraps another schema to make it optional. When used in an object schema,
|
|
51
|
+
* properties with optional schemas are not required.
|
|
52
|
+
*
|
|
53
|
+
* @param validator - The validator to make optional
|
|
54
|
+
* @returns A new {@link OptionalSchema} instance
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* // Optional string
|
|
59
|
+
* const optionalBio = l.optional(l.string())
|
|
60
|
+
*
|
|
61
|
+
* // In an object - property is not required
|
|
62
|
+
* const userSchema = l.object({
|
|
63
|
+
* name: l.string(),
|
|
64
|
+
* bio: l.optional(l.string()),
|
|
65
|
+
* })
|
|
66
|
+
* userSchema.parse({ name: 'Alice' }) // Valid, bio is undefined
|
|
67
|
+
*
|
|
68
|
+
* // With default value
|
|
69
|
+
* const countSchema = l.optional(l.withDefault(l.integer(), 0))
|
|
70
|
+
* countSchema.parse(undefined) // Returns 0
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
30
73
|
exports.optional = (0, memoize_js_1.memoizedTransformer)(function (validator) {
|
|
31
74
|
return new OptionalSchema(validator);
|
|
32
75
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"optional.js","sourceRoot":"","sources":["../../src/schema/optional.ts"],"names":[],"mappings":";;;AAAA,wCAOmB;AACnB,mDAAwD;AAGxD,MAAa,cAA6C,SAAQ,gBAKjE;
|
|
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;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
CHANGED
|
@@ -1,28 +1,112 @@
|
|
|
1
|
-
import { Infer, InferInput, InferOutput, Schema, ValidationContext, Validator, WithOptionalProperties } from '../core.js';
|
|
1
|
+
import { Infer, InferInput, InferOutput, ParseOptions, Schema, ValidationContext, Validator, WithOptionalProperties } from '../core.js';
|
|
2
|
+
import { ArraySchema } from './array.js';
|
|
3
|
+
import { BooleanSchema } from './boolean.js';
|
|
4
|
+
import { EnumSchema } from './enum.js';
|
|
5
|
+
import { IntegerSchema } from './integer.js';
|
|
6
|
+
import { LiteralSchema } from './literal.js';
|
|
7
|
+
import { OptionalSchema } from './optional.js';
|
|
2
8
|
import { StringSchema } from './string.js';
|
|
9
|
+
import { WithDefaultSchema } from './with-default.js';
|
|
10
|
+
/**
|
|
11
|
+
* Scalar types allowed in URL parameters: boolean, integer, or string.
|
|
12
|
+
*/
|
|
3
13
|
export type ParamScalar = Infer<typeof paramScalarSchema>;
|
|
4
|
-
declare const paramScalarSchema: import("./union.js").UnionSchema<readonly [
|
|
14
|
+
declare const paramScalarSchema: import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>;
|
|
15
|
+
/**
|
|
16
|
+
* A single parameter value: scalar or array of scalars.
|
|
17
|
+
*/
|
|
5
18
|
export type Param = Infer<typeof paramSchema>;
|
|
6
|
-
|
|
19
|
+
/**
|
|
20
|
+
* Schema for validating individual parameter values.
|
|
21
|
+
*/
|
|
22
|
+
export declare const paramSchema: import("./union.js").UnionSchema<readonly [import("./union.js").UnionSchema<readonly [BooleanSchema, IntegerSchema, StringSchema<{}>]>, ArraySchema<BooleanSchema>, ArraySchema<IntegerSchema>, ArraySchema<StringSchema<{}>>]>;
|
|
23
|
+
/**
|
|
24
|
+
* Type for a params object with string keys and optional param values.
|
|
25
|
+
*/
|
|
7
26
|
export type Params = Infer<typeof paramsSchema>;
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
27
|
+
/**
|
|
28
|
+
* Schema for validating arbitrary params objects.
|
|
29
|
+
*/
|
|
30
|
+
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<{}>>]>>>;
|
|
31
|
+
export type ParamScalarValidator = LiteralSchema<string> | LiteralSchema<number> | LiteralSchema<boolean> | EnumSchema<string> | EnumSchema<number> | StringSchema<any> | BooleanSchema | IntegerSchema;
|
|
32
|
+
type AsArrayParamSchema<TSchema extends Validator> = TSchema extends any ? ArraySchema<TSchema> : never;
|
|
33
|
+
export type ParamValueValidator = ParamScalarValidator | AsArrayParamSchema<ParamScalarValidator>;
|
|
34
|
+
export type ParamValidator = ParamValueValidator | OptionalSchema<ParamValueValidator> | OptionalSchema<WithDefaultSchema<ParamValueValidator>> | WithDefaultSchema<ParamValueValidator>;
|
|
35
|
+
/**
|
|
36
|
+
* Type representing the shape of a params schema definition.
|
|
37
|
+
*
|
|
38
|
+
* Maps parameter names to their validators (must be Param or undefined).
|
|
39
|
+
*/
|
|
40
|
+
export type ParamsShape = {
|
|
41
|
+
[x: string]: ParamValidator;
|
|
11
42
|
};
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
43
|
+
/**
|
|
44
|
+
* Schema for validating URL query parameters in Lexicon endpoints.
|
|
45
|
+
*
|
|
46
|
+
* Params are the query string parameters passed to queries, procedures,
|
|
47
|
+
* and subscriptions. Values must be scalars (boolean, integer, string)
|
|
48
|
+
* or arrays of scalars, as they need to be serializable to URL format.
|
|
49
|
+
*
|
|
50
|
+
* Provides methods for converting to/from URLSearchParams.
|
|
51
|
+
*
|
|
52
|
+
* @template TShape - The params shape type mapping names to validators
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* const schema = new ParamsSchema({
|
|
57
|
+
* limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),
|
|
58
|
+
* cursor: l.optional(l.string()),
|
|
59
|
+
* })
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
export declare class ParamsSchema<const TShape extends ParamsShape = ParamsShape> extends Schema<WithOptionalProperties<{
|
|
15
63
|
[K in keyof TShape]: InferInput<TShape[K]>;
|
|
16
64
|
}>, WithOptionalProperties<{
|
|
17
65
|
[K in keyof TShape]: InferOutput<TShape[K]>;
|
|
18
66
|
}>> {
|
|
19
67
|
readonly shape: TShape;
|
|
68
|
+
readonly type: "params";
|
|
20
69
|
constructor(shape: TShape);
|
|
21
|
-
get shapeValidators(): Map<string,
|
|
70
|
+
get shapeValidators(): Map<string, ParamValidator>;
|
|
22
71
|
validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<Record<string, unknown>>;
|
|
23
|
-
fromURLSearchParams(
|
|
72
|
+
fromURLSearchParams(input: string | Iterable<[string, string]>, options?: ParseOptions): InferOutput<this>;
|
|
24
73
|
toURLSearchParams(input: InferInput<this>): URLSearchParams;
|
|
25
74
|
}
|
|
26
|
-
|
|
75
|
+
/**
|
|
76
|
+
* Creates a params schema for URL query parameters.
|
|
77
|
+
*
|
|
78
|
+
* Params schemas validate query string parameters for Lexicon endpoints.
|
|
79
|
+
* Values must be boolean, integer, string, or arrays of those types.
|
|
80
|
+
*
|
|
81
|
+
* @param properties - Object mapping parameter names to their validators
|
|
82
|
+
* @returns A new {@link ParamsSchema} instance
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* // Simple pagination params
|
|
87
|
+
* const paginationParams = l.params({
|
|
88
|
+
* limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),
|
|
89
|
+
* cursor: l.optional(l.string()),
|
|
90
|
+
* })
|
|
91
|
+
*
|
|
92
|
+
* // Required parameter
|
|
93
|
+
* const actorParams = l.params({
|
|
94
|
+
* actor: l.string({ format: 'at-identifier' }),
|
|
95
|
+
* })
|
|
96
|
+
*
|
|
97
|
+
* // Array parameter (multiple values)
|
|
98
|
+
* const filterParams = l.params({
|
|
99
|
+
* tags: l.optional(l.array(l.string())),
|
|
100
|
+
* })
|
|
101
|
+
*
|
|
102
|
+
* // Convert from URL
|
|
103
|
+
* const urlParams = new URLSearchParams('limit=25&cursor=abc')
|
|
104
|
+
* const validated = paginationParams.fromURLSearchParams(urlParams)
|
|
105
|
+
*
|
|
106
|
+
* // Convert to URL
|
|
107
|
+
* const searchParams = paginationParams.toURLSearchParams({ limit: 25 })
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
export declare const params: <const TShape extends ParamsShape = {}>(properties?: TShape) => ParamsSchema<TShape>;
|
|
27
111
|
export {};
|
|
28
112
|
//# sourceMappingURL=params.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,UAAU,EACV,WAAW,
|
|
1
|
+
{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/schema/params.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,UAAU,EACV,WAAW,EAIX,YAAY,EACZ,MAAM,EACN,iBAAiB,EAEjB,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;IA+BpB,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
CHANGED
|
@@ -8,15 +8,49 @@ const memoize_js_1 = require("../util/memoize.js");
|
|
|
8
8
|
const array_js_1 = require("./array.js");
|
|
9
9
|
const boolean_js_1 = require("./boolean.js");
|
|
10
10
|
const dict_js_1 = require("./dict.js");
|
|
11
|
+
const enum_js_1 = require("./enum.js");
|
|
11
12
|
const integer_js_1 = require("./integer.js");
|
|
13
|
+
const literal_js_1 = require("./literal.js");
|
|
12
14
|
const optional_js_1 = require("./optional.js");
|
|
13
15
|
const string_js_1 = require("./string.js");
|
|
14
16
|
const union_js_1 = require("./union.js");
|
|
17
|
+
const with_default_js_1 = require("./with-default.js");
|
|
15
18
|
const paramScalarSchema = (0, union_js_1.union)([(0, boolean_js_1.boolean)(), (0, integer_js_1.integer)(), (0, string_js_1.string)()]);
|
|
16
|
-
|
|
19
|
+
/**
|
|
20
|
+
* Schema for validating individual parameter values.
|
|
21
|
+
*/
|
|
22
|
+
exports.paramSchema = (0, union_js_1.union)([
|
|
23
|
+
paramScalarSchema,
|
|
24
|
+
(0, array_js_1.array)((0, boolean_js_1.boolean)()),
|
|
25
|
+
(0, array_js_1.array)((0, integer_js_1.integer)()),
|
|
26
|
+
(0, array_js_1.array)((0, string_js_1.string)()),
|
|
27
|
+
]);
|
|
28
|
+
/**
|
|
29
|
+
* Schema for validating arbitrary params objects.
|
|
30
|
+
*/
|
|
17
31
|
exports.paramsSchema = (0, dict_js_1.dict)((0, string_js_1.string)(), (0, optional_js_1.optional)(exports.paramSchema));
|
|
32
|
+
/**
|
|
33
|
+
* Schema for validating URL query parameters in Lexicon endpoints.
|
|
34
|
+
*
|
|
35
|
+
* Params are the query string parameters passed to queries, procedures,
|
|
36
|
+
* and subscriptions. Values must be scalars (boolean, integer, string)
|
|
37
|
+
* or arrays of scalars, as they need to be serializable to URL format.
|
|
38
|
+
*
|
|
39
|
+
* Provides methods for converting to/from URLSearchParams.
|
|
40
|
+
*
|
|
41
|
+
* @template TShape - The params shape type mapping names to validators
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const schema = new ParamsSchema({
|
|
46
|
+
* limit: l.optional(l.integer({ minimum: 1, maximum: 100 })),
|
|
47
|
+
* cursor: l.optional(l.string()),
|
|
48
|
+
* })
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
18
51
|
class ParamsSchema extends core_js_1.Schema {
|
|
19
52
|
shape;
|
|
53
|
+
type = 'params';
|
|
20
54
|
constructor(shape) {
|
|
21
55
|
super();
|
|
22
56
|
this.shape = shape;
|
|
@@ -26,9 +60,8 @@ class ParamsSchema extends core_js_1.Schema {
|
|
|
26
60
|
return (0, lazy_property_js_1.lazyProperty)(this, 'shapeValidators', map);
|
|
27
61
|
}
|
|
28
62
|
validateInContext(input, ctx) {
|
|
29
|
-
// @TODO BETTER SUPPORT Input/Output
|
|
30
63
|
if (!(0, lex_data_1.isPlainObject)(input)) {
|
|
31
|
-
return ctx.
|
|
64
|
+
return ctx.issueUnexpectedType(input, 'object');
|
|
32
65
|
}
|
|
33
66
|
// Lazily copy value
|
|
34
67
|
let copy;
|
|
@@ -73,30 +106,30 @@ class ParamsSchema extends core_js_1.Schema {
|
|
|
73
106
|
}
|
|
74
107
|
return ctx.success(copy ?? input);
|
|
75
108
|
}
|
|
76
|
-
fromURLSearchParams(
|
|
109
|
+
fromURLSearchParams(input, options) {
|
|
77
110
|
const params = {};
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
if (
|
|
90
|
-
params[
|
|
111
|
+
const iterable = typeof input === 'string' ? new URLSearchParams(input) : input;
|
|
112
|
+
const entries = iterable instanceof URLSearchParams ? iterable.entries() : iterable;
|
|
113
|
+
for (const [name, value] of entries) {
|
|
114
|
+
const validator = this.shapeValidators.get(name);
|
|
115
|
+
const innerValidator = validator ? unwrapSchema(validator) : undefined;
|
|
116
|
+
const expectsArray = innerValidator instanceof array_js_1.ArraySchema;
|
|
117
|
+
const scalarValidator = expectsArray
|
|
118
|
+
? unwrapSchema(innerValidator.validator)
|
|
119
|
+
: innerValidator;
|
|
120
|
+
const coerced = coerceParam(name, value, scalarValidator, options);
|
|
121
|
+
const currentParam = params[name];
|
|
122
|
+
if (currentParam === undefined) {
|
|
123
|
+
params[name] = expectsArray ? [coerced] : coerced;
|
|
91
124
|
}
|
|
92
|
-
else if (Array.isArray(
|
|
93
|
-
|
|
125
|
+
else if (Array.isArray(currentParam)) {
|
|
126
|
+
currentParam.push(coerced);
|
|
94
127
|
}
|
|
95
128
|
else {
|
|
96
|
-
params[
|
|
129
|
+
params[name] = [currentParam, coerced];
|
|
97
130
|
}
|
|
98
131
|
}
|
|
99
|
-
return this.parse(params);
|
|
132
|
+
return this.parse(params, options);
|
|
100
133
|
}
|
|
101
134
|
toURLSearchParams(input) {
|
|
102
135
|
const urlSearchParams = new URLSearchParams();
|
|
@@ -117,7 +150,108 @@ class ParamsSchema extends core_js_1.Schema {
|
|
|
117
150
|
}
|
|
118
151
|
}
|
|
119
152
|
exports.ParamsSchema = ParamsSchema;
|
|
153
|
+
function coerceParam(name, param, schema, options) {
|
|
154
|
+
let issue;
|
|
155
|
+
if (!schema) {
|
|
156
|
+
// The param is unknown (not defined in schema), so we don't apply any
|
|
157
|
+
// coercion and just return the string value.
|
|
158
|
+
return param;
|
|
159
|
+
}
|
|
160
|
+
else if (schema instanceof string_js_1.StringSchema) {
|
|
161
|
+
return param;
|
|
162
|
+
}
|
|
163
|
+
else if (schema instanceof integer_js_1.IntegerSchema) {
|
|
164
|
+
if (/^-?\d+$/.test(param))
|
|
165
|
+
return Number(param);
|
|
166
|
+
issue = new core_js_1.IssueInvalidType(paramPath(name, options), param, ['integer']);
|
|
167
|
+
}
|
|
168
|
+
else if (schema instanceof boolean_js_1.BooleanSchema) {
|
|
169
|
+
if (param === 'true')
|
|
170
|
+
return true;
|
|
171
|
+
if (param === 'false')
|
|
172
|
+
return false;
|
|
173
|
+
issue = new core_js_1.IssueInvalidType(paramPath(name, options), param, ['boolean']);
|
|
174
|
+
}
|
|
175
|
+
else if (schema instanceof literal_js_1.LiteralSchema) {
|
|
176
|
+
const { value } = schema;
|
|
177
|
+
if (String(value) === param)
|
|
178
|
+
return value;
|
|
179
|
+
issue = new core_js_1.IssueInvalidValue(paramPath(name, options), param, [value]);
|
|
180
|
+
}
|
|
181
|
+
else if (schema instanceof enum_js_1.EnumSchema) {
|
|
182
|
+
const { values } = schema;
|
|
183
|
+
for (const value of values) {
|
|
184
|
+
if (String(value) === param)
|
|
185
|
+
return value;
|
|
186
|
+
}
|
|
187
|
+
issue = new core_js_1.IssueInvalidValue(paramPath(name, options), param, values);
|
|
188
|
+
}
|
|
189
|
+
else {
|
|
190
|
+
// This should never happen. If it *does*, it means that the user of
|
|
191
|
+
// lex-schema is mixing different versions of the lib, which is not
|
|
192
|
+
// supported. Throwing an error here is better than silently accepting
|
|
193
|
+
// invalid params and causing unexpected behavior down the line (ie. error
|
|
194
|
+
// message returning the string value instead of the expected
|
|
195
|
+
// boolean/number/string value).
|
|
196
|
+
throw new Error(`Unsupported schema type for param coercion: ${schema}`);
|
|
197
|
+
}
|
|
198
|
+
// We were not able to coerce the param to the expected type. There is no
|
|
199
|
+
// point in returning the original string value since it doesn't conform to
|
|
200
|
+
// the expected schema, so we throw a validation error instead. We could
|
|
201
|
+
// return the "param" here, which would cause the validation to fail later on
|
|
202
|
+
// (see fromURLSearchParams()'s return statement). The main benefit of
|
|
203
|
+
// returning the original "param" value is that the error path would include
|
|
204
|
+
// the index of the param in case of array params (e.g. "tags[1]"), which
|
|
205
|
+
// could be helpful for debugging. The cost overhead is not worth it though
|
|
206
|
+
// (IMO).
|
|
207
|
+
throw new core_js_1.ValidationError([issue]);
|
|
208
|
+
}
|
|
209
|
+
function paramPath(key, options) {
|
|
210
|
+
return options?.path ? [...options.path, key] : [key];
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Creates a params schema for URL query parameters.
|
|
214
|
+
*
|
|
215
|
+
* Params schemas validate query string parameters for Lexicon endpoints.
|
|
216
|
+
* Values must be boolean, integer, string, or arrays of those types.
|
|
217
|
+
*
|
|
218
|
+
* @param properties - Object mapping parameter names to their validators
|
|
219
|
+
* @returns A new {@link ParamsSchema} instance
|
|
220
|
+
*
|
|
221
|
+
* @example
|
|
222
|
+
* ```ts
|
|
223
|
+
* // Simple pagination params
|
|
224
|
+
* const paginationParams = l.params({
|
|
225
|
+
* limit: l.optional(l.withDefault(l.integer({ minimum: 1, maximum: 100 }), 50)),
|
|
226
|
+
* cursor: l.optional(l.string()),
|
|
227
|
+
* })
|
|
228
|
+
*
|
|
229
|
+
* // Required parameter
|
|
230
|
+
* const actorParams = l.params({
|
|
231
|
+
* actor: l.string({ format: 'at-identifier' }),
|
|
232
|
+
* })
|
|
233
|
+
*
|
|
234
|
+
* // Array parameter (multiple values)
|
|
235
|
+
* const filterParams = l.params({
|
|
236
|
+
* tags: l.optional(l.array(l.string())),
|
|
237
|
+
* })
|
|
238
|
+
*
|
|
239
|
+
* // Convert from URL
|
|
240
|
+
* const urlParams = new URLSearchParams('limit=25&cursor=abc')
|
|
241
|
+
* const validated = paginationParams.fromURLSearchParams(urlParams)
|
|
242
|
+
*
|
|
243
|
+
* // Convert to URL
|
|
244
|
+
* const searchParams = paginationParams.toURLSearchParams({ limit: 25 })
|
|
245
|
+
* ```
|
|
246
|
+
*/
|
|
120
247
|
exports.params = (0, memoize_js_1.memoizedOptions)(function params(properties = {}) {
|
|
121
248
|
return new ParamsSchema(properties);
|
|
122
249
|
});
|
|
250
|
+
function unwrapSchema(schema) {
|
|
251
|
+
while (schema instanceof optional_js_1.OptionalSchema ||
|
|
252
|
+
schema instanceof with_default_js_1.WithDefaultSchema) {
|
|
253
|
+
return unwrapSchema(schema.validator);
|
|
254
|
+
}
|
|
255
|
+
return schema;
|
|
256
|
+
}
|
|
123
257
|
//# sourceMappingURL=params.js.map
|
|
@@ -1 +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,YAIX,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;AAhID,oCAgIC;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 = {\n [x: string]: Validator<Param | undefined>\n },\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"]}
|
|
1
|
+
{"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,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;AApID,oCAoIC;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,yBAAe,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;AACpC,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 ParseOptions,\n Schema,\n ValidationContext,\n ValidationError,\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 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 ValidationError([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"]}
|