@atproto/lex-schema 0.0.4 → 0.0.5

package/dist/validation/validator.d.ts

@@ -10,7 +10,7 @@ export type ValidationOptions = {
     /** @default true */
     allowTransform?: boolean;
 };
-export type Infer<T extends Validator> = T['_lex']['output'];
+export type Infer<T extends Validator> = T['__lex']['output'];
 export interface Validator<Output = any> {
     /**
      * This property is used for type inference purposes and does not actually
@@ -18,7 +18,7 @@ export interface Validator<Output = any> {
      *
      * @deprecated **INTERNAL API, DO NOT USE**.
      */
-    readonly ['_lex']: {
+    readonly ['__lex']: {
         output: Output;
     };
     /**
@@ -70,7 +70,8 @@ export declare class ValidatorContext {
     validateChild<I extends object, K extends PropertyKey & keyof I, V extends Validator>(input: I, key: K, validator: V): ValidationResult<Infer<V>>;
     addIssue(issue: Issue): void;
     success<V>(value: V): ValidationResult<V>;
-    failure(issue: Issue): ValidationFailure;
+    failure(reason: ValidationError): ValidationFailure;
+    issue(issue: Issue): ValidationFailure;
     issueInvalidValue(input: unknown, values: readonly unknown[]): ValidationFailure;
     issueInvalidType(input: unknown, expected: string): ValidationFailure;
     issueRequiredKey(input: object, key: PropertyKey): ValidationFailure;

package/dist/validation/validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validation/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAoB,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,EAOL,cAAc,EACf,MAAM,uBAAuB,CAAA;AAE9B,MAAM,MAAM,iBAAiB,CAAC,KAAK,GAAG,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAA;AAC9D,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,GAAG,IACpC,iBAAiB,CAAC,KAAK,CAAC,GACxB,iBAAiB,CAAA;AAErB,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,WAAW,EAAE,CAAA;IAEpB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE5D,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,GAAG;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iBAAiB,CACf,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,gBAAgB,GACpB,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAC5B;AAED,qBAAa,gBAAgB;IAiBL,QAAQ,CAAC,OAAO,EAAE,iBAAiB;IAhBzD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,EACf,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EACvB,OAAO,GAAE,iBAAsB,GAC9B,gBAAgB,CAAC,CAAC,CAAC;IAKtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IAErC,SAAS,aAAsB,OAAO,EAAE,iBAAiB;IAKzD,IAAI,IAAI,kBAEP;IAED,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE;IAKtD;;;;OAIG;IACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAoCzE,aAAa,CACX,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,EAC/B,CAAC,SAAS,SAAS,EACnB,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAU7D,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI5B,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAIzC,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,iBAAiB;IAIxC,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,OAAO,EAAE;IAI5D,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IAIjD,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW;IAIhD,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAI/D,WAAW,CACT,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM;IAKhB,aAAa,CACX,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM;IAKhB,yBAAyB,CAAC,CAAC,EACzB,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,CAAC,GAAG,WAAW,EAC/B,MAAM,EAAE,SAAS,OAAO,EAAE;IAO5B,wBAAwB,CAAC,CAAC,EACxB,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,CAAC,GAAG,WAAW,EAC/B,QAAQ,EAAE,MAAM;CAMnB"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validation/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAoB,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,EAOL,cAAc,EACf,MAAM,uBAAuB,CAAA;AAE9B,MAAM,MAAM,iBAAiB,CAAC,KAAK,GAAG,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAA;AAC9D,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,GAAG,IACpC,iBAAiB,CAAC,KAAK,CAAC,GACxB,iBAAiB,CAAA;AAErB,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,WAAW,EAAE,CAAA;IAEpB,oBAAoB;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE7D,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,GAAG;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iBAAiB,CACf,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,gBAAgB,GACpB,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAC5B;AAED,qBAAa,gBAAgB;IAiBL,QAAQ,CAAC,OAAO,EAAE,iBAAiB;IAhBzD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,EACf,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EACvB,OAAO,GAAE,iBAAsB,GAC9B,gBAAgB,CAAC,CAAC,CAAC;IAKtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IAErC,SAAS,aAAsB,OAAO,EAAE,iBAAiB;IAKzD,IAAI,IAAI,kBAEP;IAED,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE;IAKtD;;;;OAIG;IACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAoCzE,aAAa,CACX,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,EAC/B,CAAC,SAAS,SAAS,EACnB,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAU7D,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI5B,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAIzC,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,iBAAiB;IAInD,KAAK,CAAC,KAAK,EAAE,KAAK;IAIlB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,OAAO,EAAE;IAI5D,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IAIjD,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW;IAIhD,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAI/D,WAAW,CACT,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM;IAKhB,aAAa,CACX,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM;IAKhB,yBAAyB,CAAC,CAAC,EACzB,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,CAAC,GAAG,WAAW,EAC/B,MAAM,EAAE,SAAS,OAAO,EAAE;IAO5B,wBAAwB,CAAC,CAAC,EACxB,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,CAAC,GAAG,WAAW,EAC/B,QAAQ,EAAE,MAAM;CAMnB"}

package/dist/validation/validator.js

@@ -79,36 +79,39 @@ class ValidatorContext {
     success(value) {
         return (0, core_js_1.success)(value);
     }
-    failure(issue) {
-        return (0, core_js_1.failure)(new validation_error_js_1.ValidationError([...this.issues, issue]));
+    failure(reason) {
+        return (0, core_js_1.failure)(reason);
+    }
+    issue(issue) {
+        return this.failure(new validation_error_js_1.ValidationError([...this.issues, issue]));
     }
     issueInvalidValue(input, values) {
-        return this.failure(new validation_issue_js_1.IssueInvalidValue(this.path, input, values));
+        return this.issue(new validation_issue_js_1.IssueInvalidValue(this.path, input, values));
     }
     issueInvalidType(input, expected) {
-        return this.failure(new validation_issue_js_1.IssueInvalidType(this.path, input, [expected]));
+        return this.issue(new validation_issue_js_1.IssueInvalidType(this.path, input, [expected]));
     }
     issueRequiredKey(input, key) {
-        return this.failure(new validation_issue_js_1.IssueRequiredKey(this.path, input, key));
+        return this.issue(new validation_issue_js_1.IssueRequiredKey(this.path, input, key));
     }
     issueInvalidFormat(input, format, msg) {
-        return this.failure(new validation_issue_js_1.IssueInvalidFormat(this.path, input, format, msg));
+        return this.issue(new validation_issue_js_1.IssueInvalidFormat(this.path, input, format, msg));
     }
     issueTooBig(input, type, max, actual) {
-        return this.failure(new validation_issue_js_1.IssueTooBig(this.path, input, max, type, actual));
+        return this.issue(new validation_issue_js_1.IssueTooBig(this.path, input, max, type, actual));
     }
     issueTooSmall(input, type, min, actual) {
-        return this.failure(new validation_issue_js_1.IssueTooSmall(this.path, input, min, type, actual));
+        return this.issue(new validation_issue_js_1.IssueTooSmall(this.path, input, min, type, actual));
     }
     issueInvalidPropertyValue(input, property, values) {
         const value = input[property];
         const path = this.concatPath(property);
-        return this.failure(new validation_issue_js_1.IssueInvalidValue(path, value, values));
+        return this.issue(new validation_issue_js_1.IssueInvalidValue(path, value, values));
     }
     issueInvalidPropertyType(input, property, expected) {
         const value = input[property];
         const path = this.concatPath(property);
-        return this.failure(new validation_issue_js_1.IssueInvalidType(path, value, [expected]));
+        return this.issue(new validation_issue_js_1.IssueInvalidType(path, value, [expected]));
     }
 }
 exports.ValidatorContext = ValidatorContext;

package/dist/validation/validator.js.map

@@ -1 +1 @@
-{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/validation/validator.ts"],"names":[],"mappings":";;;AAAA,wCAA2E;AAE3E,+DAAuD;AACvD,+DAS8B;AA0D9B,MAAa,gBAAgB;IAiBI;IAhB/B;;;OAGG;IACH,MAAM,CAAC,QAAQ,CACb,KAAc,EACd,SAAuB,EACvB,UAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC7C,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC3C,CAAC;IAEgB,WAAW,CAAe;IAC1B,MAAM,GAAY,EAAE,CAAA;IAErC,YAA+B,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;QACvD,yEAAyE;QACzE,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAED,UAAU,CAAC,IAA2C;QACpD,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,IAAI,CAAA;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAI,KAAc,EAAE,SAAuB;QACjD,mEAAmE;QACnE,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAEvD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB;YACE,mBAAmB;YACnB,IAAI,CAAC,OAAO,EAAE,cAAc,KAAK,KAAK;gBACtC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAC/B,CAAC;gBACD,+DAA+D;gBAC/D,mEAAmE;gBACnE,sEAAsE;gBACtE,2BAA2B;gBAE3B,sEAAsE;gBACtE,iEAAiE;gBACjE,iEAAiE;gBACjE,WAAW;gBAEX,qEAAqE;gBACrE,iEAAiE;gBACjE,sEAAsE;gBACtE,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YACtD,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,sEAAsE;gBACtE,4CAA4C;gBAC5C,OAAO,IAAA,iBAAO,EAAC,IAAI,qCAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,MAA6B,CAAA;IACtC,CAAC;IAED,aAAa,CAIX,KAAQ,EAAE,GAAM,EAAE,SAAY;QAC9B,wEAAwE;QACxE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;QAC7C,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,KAAY;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED,OAAO,CAAI,KAAQ;QACjB,OAAO,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,OAAO,CAAC,KAAY;QAClB,OAAO,IAAA,iBAAO,EAAC,IAAI,qCAAe,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,MAA0B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IACtE,CAAC;IAED,gBAAgB,CAAC,KAAc,EAAE,QAAgB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,sCAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,gBAAgB,CAAC,KAAa,EAAE,GAAgB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,sCAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;IAClE,CAAC;IAED,kBAAkB,CAAC,KAAc,EAAE,MAAc,EAAE,GAAY;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,wCAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAC5E,CAAC;IAED,WAAW,CACT,KAAc,EACd,IAAoB,EACpB,GAAW,EACX,MAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,iCAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IAC3E,CAAC;IAED,aAAa,CACX,KAAc,EACd,IAAoB,EACpB,GAAW,EACX,MAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,mCAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IAC7E,CAAC;IAED,yBAAyB,CACvB,KAAQ,EACR,QAA+B,EAC/B,MAA0B;QAE1B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,uCAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IACjE,CAAC;IAED,wBAAwB,CACtB,KAAQ,EACR,QAA+B,EAC/B,QAAgB;QAEhB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,sCAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IACpE,CAAC;CACF;AAvJD,4CAuJC","sourcesContent":["import { ResultFailure, ResultSuccess, failure, success } from '../core.js'\nimport { PropertyKey } from './property-key.js'\nimport { ValidationError } from './validation-error.js'\nimport {\n  Issue,\n  IssueInvalidFormat,\n  IssueInvalidType,\n  IssueInvalidValue,\n  IssueRequiredKey,\n  IssueTooBig,\n  IssueTooSmall,\n  MeasurableType,\n} from './validation-issue.js'\n\nexport type ValidationSuccess<Value = any> = ResultSuccess<Value>\nexport type ValidationFailure = ResultFailure<ValidationError>\nexport type ValidationResult<Value = any> =\n  | ValidationSuccess<Value>\n  | ValidationFailure\n\nexport type ValidationOptions = {\n  path?: PropertyKey[]\n\n  /** @default true */\n  allowTransform?: boolean\n}\n\nexport type Infer<T extends Validator> = T['_lex']['output']\n\nexport interface Validator<Output = any> {\n  /**\n   * This property is used for type inference purposes and does not actually\n   * exist at runtime.\n   *\n   * @deprecated **INTERNAL API, DO NOT USE**.\n   */\n  readonly ['_lex']: { output: Output }\n\n  /**\n   * @internal **INTERNAL API**: use {@link ValidatorContext.validate} instead\n   *\n   * This method is implemented by subclasses to perform transformation and\n   * validation of the input value. Do not call this method directly; as the\n   * {@link ValidatorContext.options.allowTransform} option will **not** be\n   * enforced. See {@link ValidatorContext.validate} for details. When\n   * delegating validation from one validator sub-class implementation to\n   * another schema, {@link ValidatorContext.validate} must be used instead of\n   * calling {@link Validator.validateInContext}. This will allow to stop the\n   * validation process if the value was transformed (by the other schema) but\n   * transformations are not allowed.\n   *\n   * By convention, the {@link ValidationResult} must return the original input\n   * value if validation was successful and no transformation was applied (i.e.\n   * the input already conformed to the schema). If a default value, or any\n   * other transformation was applied, the returned value c&an be different from\n   * the input.\n   *\n   * This convention allows the {@link Validator.check check} and\n   * {@link Validator.assert assert} methods to check whether the input value\n   * exactly matches the schema (without defaults or transformations), by\n   * checking if the returned value is strictly equal to the input.\n   *\n   * @see {@link ValidatorContext.validate}\n   */\n  validateInContext(\n    input: unknown,\n    ctx: ValidatorContext,\n  ): ValidationResult<Output>\n}\n\nexport class ValidatorContext {\n  /**\n   * Creates a new validation context and validates the input using the\n   * provided validator.\n   */\n  static validate<V>(\n    input: unknown,\n    validator: Validator<V>,\n    options: ValidationOptions = {},\n  ): ValidationResult<V> {\n    const context = new ValidatorContext(options)\n    return context.validate(input, validator)\n  }\n\n  private readonly currentPath: PropertyKey[]\n  private readonly issues: Issue[] = []\n\n  protected constructor(readonly options: ValidationOptions) {\n    // Create a copy because we will be mutating the array during validation.\n    this.currentPath = options?.path != null ? Array.from(options.path) : []\n  }\n\n  get path() {\n    return Array.from(this.currentPath)\n  }\n\n  concatPath(path?: PropertyKey | readonly PropertyKey[]) {\n    if (path == null) return this.path\n    return this.currentPath.concat(path)\n  }\n\n  /**\n   * This is basically the entry point for validation within a context. Use this\n   * method instead of {@link Validator.validateInContext} directly, because\n   * this method enforces the {@link ValidationOptions.allowTransform} option.\n   */\n  validate<V>(input: unknown, validator: Validator<V>): ValidationResult<V> {\n    // This is the only place where validateInContext should be called.\n    const result = validator.validateInContext(input, this)\n\n    if (result.success) {\n      if (\n        // Defaults to true\n        this.options?.allowTransform === false &&\n        !Object.is(result.value, input)\n      ) {\n        // If the value changed, it means that a default (or some other\n        // transformation) was applied, meaning that the original value did\n        // *not* match the (output) schema. When \"allowTransform\" is false, we\n        // consider this a failure.\n\n        // This check is the reason why Validator.validateInContext should not\n        // be used directly, and ValidatorContext.validate should be used\n        // instead, even when delegating validation from one validator to\n        // another.\n\n        // This if block comes before the next one because 'this.issues' will\n        // end-up being appended to the returned ValidationError (see the\n        // \"failure\" method below), resulting in a more complete error report.\n        return this.issueInvalidValue(input, [result.value])\n      }\n\n      if (this.issues.length > 0) {\n        // Validator returned a success but issues were added via the context.\n        // This means the overall validation failed.\n        return failure(new ValidationError(Array.from(this.issues)))\n      }\n    }\n\n    return result as ValidationResult<V>\n  }\n\n  validateChild<\n    I extends object,\n    K extends PropertyKey & keyof I,\n    V extends Validator,\n  >(input: I, key: K, validator: V): ValidationResult<Infer<V>> {\n    // Instead of creating a new context, we just push/pop the path segment.\n    this.currentPath.push(key)\n    try {\n      return this.validate(input[key], validator)\n    } finally {\n      this.currentPath.length--\n    }\n  }\n\n  addIssue(issue: Issue): void {\n    this.issues.push(issue)\n  }\n\n  success<V>(value: V): ValidationResult<V> {\n    return success(value)\n  }\n\n  failure(issue: Issue): ValidationFailure {\n    return failure(new ValidationError([...this.issues, issue]))\n  }\n\n  issueInvalidValue(input: unknown, values: readonly unknown[]) {\n    return this.failure(new IssueInvalidValue(this.path, input, values))\n  }\n\n  issueInvalidType(input: unknown, expected: string) {\n    return this.failure(new IssueInvalidType(this.path, input, [expected]))\n  }\n\n  issueRequiredKey(input: object, key: PropertyKey) {\n    return this.failure(new IssueRequiredKey(this.path, input, key))\n  }\n\n  issueInvalidFormat(input: unknown, format: string, msg?: string) {\n    return this.failure(new IssueInvalidFormat(this.path, input, format, msg))\n  }\n\n  issueTooBig(\n    input: unknown,\n    type: MeasurableType,\n    max: number,\n    actual: number,\n  ) {\n    return this.failure(new IssueTooBig(this.path, input, max, type, actual))\n  }\n\n  issueTooSmall(\n    input: unknown,\n    type: MeasurableType,\n    min: number,\n    actual: number,\n  ) {\n    return this.failure(new IssueTooSmall(this.path, input, min, type, actual))\n  }\n\n  issueInvalidPropertyValue<I>(\n    input: I,\n    property: keyof I & PropertyKey,\n    values: readonly unknown[],\n  ) {\n    const value = input[property]\n    const path = this.concatPath(property)\n    return this.failure(new IssueInvalidValue(path, value, values))\n  }\n\n  issueInvalidPropertyType<I>(\n    input: I,\n    property: keyof I & PropertyKey,\n    expected: string,\n  ) {\n    const value = input[property]\n    const path = this.concatPath(property)\n    return this.failure(new IssueInvalidType(path, value, [expected]))\n  }\n}\n"]}
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/validation/validator.ts"],"names":[],"mappings":";;;AAAA,wCAA2E;AAE3E,+DAAuD;AACvD,+DAS8B;AA0D9B,MAAa,gBAAgB;IAiBI;IAhB/B;;;OAGG;IACH,MAAM,CAAC,QAAQ,CACb,KAAc,EACd,SAAuB,EACvB,UAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC7C,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC3C,CAAC;IAEgB,WAAW,CAAe;IAC1B,MAAM,GAAY,EAAE,CAAA;IAErC,YAA+B,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;QACvD,yEAAyE;QACzE,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAED,UAAU,CAAC,IAA2C;QACpD,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,IAAI,CAAA;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAI,KAAc,EAAE,SAAuB;QACjD,mEAAmE;QACnE,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAEvD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB;YACE,mBAAmB;YACnB,IAAI,CAAC,OAAO,EAAE,cAAc,KAAK,KAAK;gBACtC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAC/B,CAAC;gBACD,+DAA+D;gBAC/D,mEAAmE;gBACnE,sEAAsE;gBACtE,2BAA2B;gBAE3B,sEAAsE;gBACtE,iEAAiE;gBACjE,iEAAiE;gBACjE,WAAW;gBAEX,qEAAqE;gBACrE,iEAAiE;gBACjE,sEAAsE;gBACtE,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YACtD,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,sEAAsE;gBACtE,4CAA4C;gBAC5C,OAAO,IAAA,iBAAO,EAAC,IAAI,qCAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,MAA6B,CAAA;IACtC,CAAC;IAED,aAAa,CAIX,KAAQ,EAAE,GAAM,EAAE,SAAY;QAC9B,wEAAwE;QACxE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;QAC7C,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,KAAY;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED,OAAO,CAAI,KAAQ;QACjB,OAAO,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,OAAO,CAAC,MAAuB;QAC7B,OAAO,IAAA,iBAAO,EAAC,MAAM,CAAC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,KAAY;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,qCAAe,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACnE,CAAC;IAED,iBAAiB,CAAC,KAAc,EAAE,MAA0B;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IACpE,CAAC;IAED,gBAAgB,CAAC,KAAc,EAAE,QAAgB;QAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,sCAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IACvE,CAAC;IAED,gBAAgB,CAAC,KAAa,EAAE,GAAgB;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,sCAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;IAChE,CAAC;IAED,kBAAkB,CAAC,KAAc,EAAE,MAAc,EAAE,GAAY;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,wCAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,WAAW,CACT,KAAc,EACd,IAAoB,EACpB,GAAW,EACX,MAAc;QAEd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,iCAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,aAAa,CACX,KAAc,EACd,IAAoB,EACpB,GAAW,EACX,MAAc;QAEd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,mCAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IAC3E,CAAC;IAED,yBAAyB,CACvB,KAAQ,EACR,QAA+B,EAC/B,MAA0B;QAE1B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,uCAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED,wBAAwB,CACtB,KAAQ,EACR,QAA+B,EAC/B,QAAgB;QAEhB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,sCAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IAClE,CAAC;CACF;AA3JD,4CA2JC","sourcesContent":["import { ResultFailure, ResultSuccess, failure, success } from '../core.js'\nimport { PropertyKey } from './property-key.js'\nimport { ValidationError } from './validation-error.js'\nimport {\n  Issue,\n  IssueInvalidFormat,\n  IssueInvalidType,\n  IssueInvalidValue,\n  IssueRequiredKey,\n  IssueTooBig,\n  IssueTooSmall,\n  MeasurableType,\n} from './validation-issue.js'\n\nexport type ValidationSuccess<Value = any> = ResultSuccess<Value>\nexport type ValidationFailure = ResultFailure<ValidationError>\nexport type ValidationResult<Value = any> =\n  | ValidationSuccess<Value>\n  | ValidationFailure\n\nexport type ValidationOptions = {\n  path?: PropertyKey[]\n\n  /** @default true */\n  allowTransform?: boolean\n}\n\nexport type Infer<T extends Validator> = T['__lex']['output']\n\nexport interface Validator<Output = any> {\n  /**\n   * This property is used for type inference purposes and does not actually\n   * exist at runtime.\n   *\n   * @deprecated **INTERNAL API, DO NOT USE**.\n   */\n  readonly ['__lex']: { output: Output }\n\n  /**\n   * @internal **INTERNAL API**: use {@link ValidatorContext.validate} instead\n   *\n   * This method is implemented by subclasses to perform transformation and\n   * validation of the input value. Do not call this method directly; as the\n   * {@link ValidatorContext.options.allowTransform} option will **not** be\n   * enforced. See {@link ValidatorContext.validate} for details. When\n   * delegating validation from one validator sub-class implementation to\n   * another schema, {@link ValidatorContext.validate} must be used instead of\n   * calling {@link Validator.validateInContext}. This will allow to stop the\n   * validation process if the value was transformed (by the other schema) but\n   * transformations are not allowed.\n   *\n   * By convention, the {@link ValidationResult} must return the original input\n   * value if validation was successful and no transformation was applied (i.e.\n   * the input already conformed to the schema). If a default value, or any\n   * other transformation was applied, the returned value c&an be different from\n   * the input.\n   *\n   * This convention allows the {@link Validator.check check} and\n   * {@link Validator.assert assert} methods to check whether the input value\n   * exactly matches the schema (without defaults or transformations), by\n   * checking if the returned value is strictly equal to the input.\n   *\n   * @see {@link ValidatorContext.validate}\n   */\n  validateInContext(\n    input: unknown,\n    ctx: ValidatorContext,\n  ): ValidationResult<Output>\n}\n\nexport class ValidatorContext {\n  /**\n   * Creates a new validation context and validates the input using the\n   * provided validator.\n   */\n  static validate<V>(\n    input: unknown,\n    validator: Validator<V>,\n    options: ValidationOptions = {},\n  ): ValidationResult<V> {\n    const context = new ValidatorContext(options)\n    return context.validate(input, validator)\n  }\n\n  private readonly currentPath: PropertyKey[]\n  private readonly issues: Issue[] = []\n\n  protected constructor(readonly options: ValidationOptions) {\n    // Create a copy because we will be mutating the array during validation.\n    this.currentPath = options?.path != null ? Array.from(options.path) : []\n  }\n\n  get path() {\n    return Array.from(this.currentPath)\n  }\n\n  concatPath(path?: PropertyKey | readonly PropertyKey[]) {\n    if (path == null) return this.path\n    return this.currentPath.concat(path)\n  }\n\n  /**\n   * This is basically the entry point for validation within a context. Use this\n   * method instead of {@link Validator.validateInContext} directly, because\n   * this method enforces the {@link ValidationOptions.allowTransform} option.\n   */\n  validate<V>(input: unknown, validator: Validator<V>): ValidationResult<V> {\n    // This is the only place where validateInContext should be called.\n    const result = validator.validateInContext(input, this)\n\n    if (result.success) {\n      if (\n        // Defaults to true\n        this.options?.allowTransform === false &&\n        !Object.is(result.value, input)\n      ) {\n        // If the value changed, it means that a default (or some other\n        // transformation) was applied, meaning that the original value did\n        // *not* match the (output) schema. When \"allowTransform\" is false, we\n        // consider this a failure.\n\n        // This check is the reason why Validator.validateInContext should not\n        // be used directly, and ValidatorContext.validate should be used\n        // instead, even when delegating validation from one validator to\n        // another.\n\n        // This if block comes before the next one because 'this.issues' will\n        // end-up being appended to the returned ValidationError (see the\n        // \"failure\" method below), resulting in a more complete error report.\n        return this.issueInvalidValue(input, [result.value])\n      }\n\n      if (this.issues.length > 0) {\n        // Validator returned a success but issues were added via the context.\n        // This means the overall validation failed.\n        return failure(new ValidationError(Array.from(this.issues)))\n      }\n    }\n\n    return result as ValidationResult<V>\n  }\n\n  validateChild<\n    I extends object,\n    K extends PropertyKey & keyof I,\n    V extends Validator,\n  >(input: I, key: K, validator: V): ValidationResult<Infer<V>> {\n    // Instead of creating a new context, we just push/pop the path segment.\n    this.currentPath.push(key)\n    try {\n      return this.validate(input[key], validator)\n    } finally {\n      this.currentPath.length--\n    }\n  }\n\n  addIssue(issue: Issue): void {\n    this.issues.push(issue)\n  }\n\n  success<V>(value: V): ValidationResult<V> {\n    return success(value)\n  }\n\n  failure(reason: ValidationError): ValidationFailure {\n    return failure(reason)\n  }\n\n  issue(issue: Issue) {\n    return this.failure(new ValidationError([...this.issues, issue]))\n  }\n\n  issueInvalidValue(input: unknown, values: readonly unknown[]) {\n    return this.issue(new IssueInvalidValue(this.path, input, values))\n  }\n\n  issueInvalidType(input: unknown, expected: string) {\n    return this.issue(new IssueInvalidType(this.path, input, [expected]))\n  }\n\n  issueRequiredKey(input: object, key: PropertyKey) {\n    return this.issue(new IssueRequiredKey(this.path, input, key))\n  }\n\n  issueInvalidFormat(input: unknown, format: string, msg?: string) {\n    return this.issue(new IssueInvalidFormat(this.path, input, format, msg))\n  }\n\n  issueTooBig(\n    input: unknown,\n    type: MeasurableType,\n    max: number,\n    actual: number,\n  ) {\n    return this.issue(new IssueTooBig(this.path, input, max, type, actual))\n  }\n\n  issueTooSmall(\n    input: unknown,\n    type: MeasurableType,\n    min: number,\n    actual: number,\n  ) {\n    return this.issue(new IssueTooSmall(this.path, input, min, type, actual))\n  }\n\n  issueInvalidPropertyValue<I>(\n    input: I,\n    property: keyof I & PropertyKey,\n    values: readonly unknown[],\n  ) {\n    const value = input[property]\n    const path = this.concatPath(property)\n    return this.issue(new IssueInvalidValue(path, value, values))\n  }\n\n  issueInvalidPropertyType<I>(\n    input: I,\n    property: keyof I & PropertyKey,\n    expected: string,\n  ) {\n    const value = input[property]\n    const path = this.concatPath(property)\n    return this.issue(new IssueInvalidType(path, value, [expected]))\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-schema",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "description": "Lexicon schema system for AT Lexicons",
   "keywords": [
@@ -37,7 +37,7 @@
   "dependencies": {
     "tslib": "^2.8.1",
     "@atproto/syntax": "0.4.2",
-    "@atproto/lex-data": "0.0.3"
+    "@atproto/lex-data": "0.0.4"
   },
   "devDependencies": {
     "jest": "^28.1.2"

package/src/core/$type.ts

@@ -1,4 +1,5 @@
 import { NsidString } from './string-format.js'
+import { OmitKey } from './types.js'
 
 export type $Type<
   N extends NsidString = NsidString,
@@ -20,3 +21,6 @@ export function $type<N extends NsidString, H extends string>(
 ): $Type<N, H> {
   return (hash === 'main' ? nsid : `${nsid}#${hash}`) as $Type<N, H>
 }
+
+export type $Typed<V, T extends string = string> = V & { $type: T }
+export type Un$Typed<V extends { $type?: string }> = OmitKey<V, '$type'>

package/src/core/result.ts

@@ -1,5 +1,5 @@
 export type ResultSuccess<V = any> = { success: true; value: V }
-export type ResultFailure<E = Error> = { success: false; error: E }
+export type ResultFailure<E = Error> = { success: false; reason: E }
 
 export type Result<V = any, E = Error> = ResultSuccess<V> | ResultFailure<E>
 
@@ -9,13 +9,13 @@ export function success<V>(value: V): ResultSuccess<V> {
 }
 
 /*@__NO_SIDE_EFFECTS__*/
-export function failure<E>(error: E): ResultFailure<E> {
-  return { success: false, error }
+export function failure<E>(reason: E): ResultFailure<E> {
+  return { success: false, reason }
 }
 
 /*@__NO_SIDE_EFFECTS__*/
-export function failureError<T>(result: ResultFailure<T>): T {
-  return result.error
+export function failureReason<T>(result: ResultFailure<T>): T {
+  return result.reason
 }
 
 /*@__NO_SIDE_EFFECTS__*/
@@ -31,9 +31,9 @@ export function successValue<T>(result: ResultSuccess<T>): T {
  * @example
  *
  * ```ts
- * declare function someFunction(): Promise<ResultSuccess<string>>
+ * declare function someFunction(): Promise<string>
  *
- * const result = await someFunction().catch(catchall)
+ * const result = await someFunction().then(success, catchall)
  * if (result.success) {
  *   console.log(result.value) // string
  * } else {
@@ -58,9 +58,10 @@ export function catchall(err: unknown): ResultFailure<Error> {
  * class FooError extends Error {}
  * class BarError extends Error {}
  *
- * declare function someFunction(): Promise<ResultSuccess<string>>
+ * declare function someFunction(): Promise<string>
  *
  * const result = await someFunction()
+ *   .then(success)
  *   .catch(createCatcher(FooError))
  *   .catch(createCatcher(BarError))
  *

package/src/core/string-format.ts

@@ -1,4 +1,4 @@
-import { ensureValidCidString, isLanguage } from '@atproto/lex-data'
+import { ensureValidCidString, isLanguageString } from '@atproto/lex-data'
 import {
   AtIdentifierString,
   AtUriString,
@@ -17,16 +17,25 @@ import {
   ensureValidRecordKey,
   ensureValidTid,
 } from '@atproto/syntax'
-
-type AssertFn<T> = <I extends string>(input: I) => asserts input is I & T
-type CastFn<T> = <I extends string>(input: I) => I & T
+import {
+  AssertFn,
+  CastFn,
+  CheckFn,
+  createAssertFunction,
+  createCastFunction,
+  createCheckFunction,
+} from '../util/assertion-util.js'
+
+// Format utilities missing from @atproto/syntax
+export type CidString = string
+export type LanguageString = string
+export type UriString = `${string}:${string}`
 
 /*@__NO_SIDE_EFFECTS__*/
-function createCastFunction<T>(assertFn: AssertFn<T>): CastFn<T> {
-  return <I extends string>(input: I) => {
-    assertFn(input)
-    return input as I & T
-  }
+export function isUriString<T extends string>(
+  input: T,
+): input is T & UriString {
+  return /^\w+:(?:\/\/)?[^\s/][^\s]*$/.test(input)
 }
 
 // Re-export utility typed as assertion functions so that TypeScript can
@@ -41,61 +50,72 @@ export type {
   NsidString,
   RecordKeyString,
   TidString,
-}
-
-export const assertDid: AssertFn<DidString> = ensureValidDid
-export const assertAtUri: AssertFn<AtUriString> = ensureValidAtUri
-export const assertAtIdentifier: AssertFn<AtIdentifierString> =
-  ensureValidAtIdentifier
-export const assertNsid: AssertFn<NsidString> = ensureValidNsid
-export const assertTid: AssertFn<TidString> = ensureValidTid
-export const assertRecordKey: AssertFn<RecordKeyString> = ensureValidRecordKey
-export const assertDatetime: AssertFn<DatetimeString> = ensureValidDatetime
-export const assertCidString: AssertFn<string> = ensureValidCidString
-export const assertHandle: AssertFn<HandleString> = ensureValidHandle
+} from '@atproto/syntax'
 
 // Export utilities for formats missing from @atproto/syntax
 
-export type CidString = string
-export type UriString = `${string}:${string}`
-export type LanguageString = string
-
-/*@__NO_SIDE_EFFECTS__*/
-export function assertUri(input: string): asserts input is UriString {
-  if (!/^\w+:(?:\/\/)?[^\s/][^\s]*$/.test(input)) {
-    throw new Error('Invalid URI')
-  }
-}
-
-/*@__NO_SIDE_EFFECTS__*/
-export function assertLanguage(input: string): asserts input is LanguageString {
-  if (!isLanguage(input)) {
-    throw new Error('Invalid BCP 47 string')
-  }
-}
-
-export const asDid: CastFn<DidString> =
-  /*#__PURE__*/ createCastFunction(ensureValidDid)
-export const asAtUri: CastFn<AtUriString> =
+export const assertAtIdentifierString: AssertFn<AtIdentifierString> =
+  ensureValidAtIdentifier
+export const assertAtUriString: AssertFn<AtUriString> = ensureValidAtUri
+export const assertCidString: AssertFn<CidString> = ensureValidCidString
+export const assertDatetimeString: AssertFn<DatetimeString> =
+  ensureValidDatetime
+export const assertDidString: AssertFn<DidString> = ensureValidDid
+export const assertHandleString: AssertFn<HandleString> = ensureValidHandle
+export const assertLanguageString: AssertFn<LanguageString> =
+  createAssertFunction<LanguageString>(
+    isLanguageString,
+    'Invalid BCP 47 string',
+  )
+export const assertNsidString: AssertFn<NsidString> = ensureValidNsid
+export const assertRecordKeyString: AssertFn<RecordKeyString> =
+  ensureValidRecordKey
+export const assertTidString: AssertFn<TidString> = ensureValidTid
+export const assertUriString: AssertFn<UriString> =
+  createAssertFunction<UriString>(isUriString, 'Invalid URI')
+
+export const asAtIdentifierString: CastFn<AtIdentifierString> =
+  /*#__PURE__*/ createCastFunction(assertAtIdentifierString)
+export const asAtUriString: CastFn<AtUriString> =
   /*#__PURE__*/ createCastFunction(ensureValidAtUri)
-export const asNsid: CastFn<NsidString> =
-  /*#__PURE__*/ createCastFunction(ensureValidNsid)
-export const asTid: CastFn<TidString> =
-  /*#__PURE__*/ createCastFunction(ensureValidTid)
-export const asRecordKey: CastFn<RecordKeyString> =
-  /*#__PURE__*/ createCastFunction(ensureValidRecordKey)
-export const asDatetime: CastFn<DatetimeString> =
-  /*#__PURE__*/ createCastFunction(ensureValidDatetime)
-export const asCidString: CastFn<string> =
+export const asCidString: CastFn<CidString> =
   /*#__PURE__*/ createCastFunction(ensureValidCidString)
-export const asHandle: CastFn<HandleString> =
+export const asDatetimeString: CastFn<DatetimeString> =
+  /*#__PURE__*/ createCastFunction(ensureValidDatetime)
+export const asDidString: CastFn<DidString> =
+  /*#__PURE__*/ createCastFunction(ensureValidDid)
+export const asHandleString: CastFn<HandleString> =
   /*#__PURE__*/ createCastFunction(ensureValidHandle)
-export const asUri: CastFn<UriString> =
-  /*#__PURE__*/ createCastFunction(assertUri)
-export const asLanguage: CastFn<LanguageString> =
-  /*#__PURE__*/ createCastFunction(assertLanguage)
-export const asAtIdentifier: CastFn<AtIdentifierString> =
-  /*#__PURE__*/ createCastFunction(assertAtIdentifier)
+export const asLanguageString: CastFn<LanguageString> =
+  /*#__PURE__*/ createCastFunction(assertLanguageString)
+export const asNsidString: CastFn<NsidString> =
+  /*#__PURE__*/ createCastFunction(ensureValidNsid)
+export const asRecordKeyString: CastFn<RecordKeyString> =
+  /*#__PURE__*/ createCastFunction(ensureValidRecordKey)
+export const asTidString: CastFn<TidString> =
+  /*#__PURE__*/ createCastFunction(ensureValidTid)
+export const asUriString: CastFn<UriString> =
+  /*#__PURE__*/ createCastFunction(assertUriString)
+
+export { isLanguageString }
+export const isAtIdentifierString: CheckFn<AtIdentifierString> =
+  /*#__PURE__*/ createCheckFunction(assertAtIdentifierString)
+export const isAtUriString: CheckFn<AtUriString> =
+  /*#__PURE__*/ createCheckFunction(assertAtIdentifierString)
+export const isCidString: CheckFn<CidString> =
+  /*#__PURE__*/ createCheckFunction(assertCidString)
+export const isDatetimeString: CheckFn<DatetimeString> =
+  /*#__PURE__*/ createCheckFunction(assertDatetimeString)
+export const isDidString: CheckFn<DidString> =
+  /*#__PURE__*/ createCheckFunction(assertDidString)
+export const isHandleString: CheckFn<HandleString> =
+  /*#__PURE__*/ createCheckFunction(assertHandleString)
+export const isNsidString: CheckFn<NsidString> =
+  /*#__PURE__*/ createCheckFunction(assertNsidString)
+export const isRecordKeyString: CheckFn<RecordKeyString> =
+  /*#__PURE__*/ createCheckFunction(assertRecordKeyString)
+export const isTidString: CheckFn<TidString> =
+  /*#__PURE__*/ createCheckFunction(assertTidString)
 
 // String formatting types and utilities
 
@@ -135,17 +155,17 @@ export type InferStringFormat<F> =
                   string
 
 const formatters = /*#__PURE__*/ new Map<StringFormat, (str: string) => void>([
-  ['datetime', assertDatetime],
-  ['uri', assertUri],
-  ['at-uri', assertAtUri],
-  ['did', assertDid],
-  ['handle', assertHandle],
-  ['at-identifier', assertAtIdentifier],
-  ['nsid', assertNsid],
+  ['at-identifier', assertAtIdentifierString],
+  ['at-uri', assertAtUriString],
   ['cid', assertCidString],
-  ['language', assertLanguage],
-  ['tid', assertTid],
-  ['record-key', assertRecordKey],
+  ['datetime', assertDatetimeString],
+  ['did', assertDidString],
+  ['handle', assertHandleString],
+  ['language', assertLanguageString],
+  ['nsid', assertNsidString],
+  ['record-key', assertRecordKeyString],
+  ['tid', assertTidString],
+  ['uri', assertUriString],
 ] as const)
 
 /*@__NO_SIDE_EFFECTS__*/

package/src/core/types.ts

@@ -26,3 +26,7 @@ export type WithOptionalProperties<P> = Simplify<
     -readonly [K in keyof P as undefined extends P[K] ? K : never]?: P[K]
   }
 >
+
+export type OmitKey<T, K extends keyof T> = {
+  [K2 in keyof T as K2 extends K ? never : K2]: T[K2]
+}

package/src/external.ts

@@ -31,7 +31,7 @@ import {
   ParamsSchema,
   ParamsSchemaShape,
   Payload,
-  PayloadBody,
+  PayloadSchema,
   Permission,
   PermissionOptions,
   PermissionSet,
@@ -57,9 +57,10 @@ import {
   UnknownSchema,
   refine,
 } from './schema.js'
-import { Infer, PropertyKey, Validator } from './validation.js'
+import { Infer, PropertyKey, Schema, Validator } from './validation.js'
 
 export * from './core.js'
+export * from './helpers.js'
 export * from './schema.js'
 export * from './validation.js'
 
@@ -262,7 +263,7 @@ export function typedUnion<
 export function typedObject<
   const N extends NsidString,
   const H extends string,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(nsid: N, hash: H, schema: S): TypedObjectSchema<$Type<N, H>, S>
 export function typedObject<V extends { $type?: $Type }>(
   nsid: V extends { $type?: infer T extends string }
@@ -281,7 +282,7 @@ export function typedObject<V extends { $type?: $Type }>(
 export function typedObject<
   const N extends NsidString,
   const H extends string,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(nsid: N, hash: H, schema: S) {
   return new TypedObjectSchema<$Type<N, H>, S>($type(nsid, hash), schema)
 }
@@ -305,7 +306,7 @@ type AsNsid<T> = T extends `${string}#${string}` ? never : T
 export function record<
   const K extends LexiconRecordKey,
   const T extends NsidString,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(key: K, type: AsNsid<T>, schema: S): RecordSchema<K, T, S>
 export function record<
   const K extends LexiconRecordKey,
@@ -319,7 +320,7 @@ export function record<
 export function record<
   const K extends LexiconRecordKey,
   const T extends NsidString,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(key: K, type: T, schema: S) {
   return new RecordSchema<K, T, S>(key, type, schema)
 }
@@ -334,7 +335,7 @@ export function params<
 /*@__NO_SIDE_EFFECTS__*/
 export function payload<
   const E extends string | undefined = undefined,
-  const S extends PayloadBody<E> = undefined,
+  const S extends PayloadSchema<E> = undefined,
 >(encoding: E = undefined as E, schema: S = undefined as S) {
   return new Payload<E, S>(encoding, schema)
 }
@@ -364,7 +365,7 @@ export function procedure<
 export function subscription<
   const N extends NsidString,
   const P extends ParamsSchema,
-  const M extends undefined | RefSchema | TypedUnionSchema | ObjectSchema,
+  const M extends Schema,
   const E extends undefined | readonly string[] = undefined,
 >(nsid: N, parameters: P, message: M, errors: E = undefined as E) {
   return new Subscription<N, P, M, E>(nsid, parameters, message, errors)