@atproto/syntax 0.4.0 → 0.4.2

package/dist/index.js

@@ -14,11 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./handle"), exports);
-__exportStar(require("./did"), exports);
-__exportStar(require("./nsid"), exports);
-__exportStar(require("./aturi"), exports);
-__exportStar(require("./tid"), exports);
-__exportStar(require("./recordkey"), exports);
-__exportStar(require("./datetime"), exports);
+__exportStar(require("./handle.js"), exports);
+__exportStar(require("./did.js"), exports);
+__exportStar(require("./nsid.js"), exports);
+__exportStar(require("./aturi.js"), exports);
+__exportStar(require("./at-identifier.js"), exports);
+__exportStar(require("./tid.js"), exports);
+__exportStar(require("./recordkey.js"), exports);
+__exportStar(require("./datetime.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,wCAAqB;AACrB,yCAAsB;AACtB,0CAAuB;AACvB,wCAAqB;AACrB,8CAA2B;AAC3B,6CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,2CAAwB;AACxB,4CAAyB;AACzB,6CAA0B;AAC1B,qDAAkC;AAClC,2CAAwB;AACxB,iDAA8B;AAC9B,gDAA6B","sourcesContent":["export * from './handle.js'\nexport * from './did.js'\nexport * from './nsid.js'\nexport * from './aturi.js'\nexport * from './at-identifier.js'\nexport * from './tid.js'\nexport * from './recordkey.js'\nexport * from './datetime.js'\n"]}

package/dist/nsid.d.ts

@@ -1,15 +1,40 @@
+export type NsidString = `${string}.${string}.${string}`;
 export declare class NSID {
-    segments: string[];
-    static parse(nsid: string): NSID;
+    readonly segments: readonly string[];
+    static parse(input: string): NSID;
     static create(authority: string, name: string): NSID;
-    static isValid(nsid: string): boolean;
+    static isValid(nsid: string): nsid is `${string}.${string}.${string}`;
+    static from(input: {
+        toString: () => string;
+    }): NSID;
     constructor(nsid: string);
     get authority(): string;
     get name(): string | undefined;
     toString(): string;
 }
-export declare const ensureValidNsid: (nsid: string) => void;
-export declare const ensureValidNsidRegex: (nsid: string) => void;
+export declare function ensureValidNsid(nsid: string): asserts nsid is NsidString;
+export declare function parseNsid(nsid: string): string[];
+export declare function isValidNsid(nsid: string): nsid is NsidString;
+type ValidateResult<T> = {
+    success: true;
+    value: T;
+} | {
+    success: false;
+    message: string;
+};
+export declare function validateNsid(input: string): ValidateResult<string[]>;
+/**
+ * @deprecated Use {@link ensureValidNsid} if you care about error details,
+ * {@link parseNsid}/{@link NSID.parse} if you need the parsed segments, or
+ * {@link isValidNsid} if you just want a boolean.
+ */
+export declare function ensureValidNsidRegex(nsid: string): asserts nsid is NsidString;
+/**
+ * Regexp based validation that behaves identically to the previous code but
+ * provides less detailed error messages (while being 20% to 50% faster).
+ */
+export declare function validateNsidRegex(value: string): ValidateResult<NsidString>;
 export declare class InvalidNsidError extends Error {
 }
+export {};
 //# sourceMappingURL=nsid.d.ts.map

package/dist/nsid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nsid.d.ts","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":"AAaA,qBAAa,IAAI;IACf,QAAQ,EAAE,MAAM,EAAE,CAAK;IAEvB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIhC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAKpD,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;gBASzB,IAAI,EAAE,MAAM;IAKxB,IAAI,SAAS,WAKZ;IAED,IAAI,IAAI,uBAEP;IAED,QAAQ;CAGT;AAKD,eAAO,MAAM,eAAe,SAAU,MAAM,KAAG,IAqC9C,CAAA;AAED,eAAO,MAAM,oBAAoB,SAAU,MAAM,KAAG,IAanD,CAAA;AAED,qBAAa,gBAAiB,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"nsid.d.ts","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":"AAaA,MAAM,MAAM,UAAU,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAA;AAExD,qBAAa,IAAI;IACf,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;IAEpC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIjC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAKpD,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM;IAI3B,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;KAAE,GAAG,IAAI;gBAWxC,IAAI,EAAE,MAAM;IAIxB,IAAI,SAAS,WAKZ;IAED,IAAI,IAAI,uBAEP;IAED,QAAQ;CAGT;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU,CAGxE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAIhD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,UAAU,CAI5D;AAED,KAAK,cAAc,CAAC,CAAC,IACjB;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC3B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAKvC,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CA0DpE;AA4BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU,CAG7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,CAuB3E;AAED,qBAAa,gBAAiB,SAAQ,KAAK;CAAG"}

package/dist/nsid.js

@@ -7,38 +7,47 @@ number    = "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9" / "0"
 delim     = "."
 segment   = alpha *( alpha / number / "-" )
 authority = segment *( delim segment )
-name      = alpha *( alpha )
+name      = alpha *( alpha / number )
 nsid      = authority delim name
 
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidNsidError = exports.ensureValidNsidRegex = exports.ensureValidNsid = exports.NSID = void 0;
+exports.InvalidNsidError = exports.NSID = void 0;
+exports.ensureValidNsid = ensureValidNsid;
+exports.parseNsid = parseNsid;
+exports.isValidNsid = isValidNsid;
+exports.validateNsid = validateNsid;
+exports.ensureValidNsidRegex = ensureValidNsidRegex;
+exports.validateNsidRegex = validateNsidRegex;
 class NSID {
-    static parse(nsid) {
-        return new NSID(nsid);
+    static parse(input) {
+        return new NSID(input);
     }
     static create(authority, name) {
-        const segments = [...authority.split('.').reverse(), name].join('.');
-        return new NSID(segments);
+        const input = [...authority.split('.').reverse(), name].join('.');
+        return new NSID(input);
     }
     static isValid(nsid) {
-        try {
-            NSID.parse(nsid);
-            return true;
+        return isValidNsid(nsid);
+    }
+    static from(input) {
+        if (input instanceof NSID) {
+            // No need to clone, NSID is immutable
+            return input;
         }
-        catch (e) {
-            return false;
+        if (Array.isArray(input)) {
+            return new NSID(input.join('.'));
         }
+        return new NSID(String(input));
     }
     constructor(nsid) {
         Object.defineProperty(this, "segments", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: []
+            value: void 0
         });
-        (0, exports.ensureValidNsid)(nsid);
-        this.segments = nsid.split('.');
+        this.segments = parseNsid(nsid);
     }
     get authority() {
         return this.segments
@@ -54,53 +63,134 @@ class NSID {
     }
 }
 exports.NSID = NSID;
+function ensureValidNsid(nsid) {
+    const result = validateNsid(nsid);
+    if (!result.success)
+        throw new InvalidNsidError(result.message);
+}
+function parseNsid(nsid) {
+    const result = validateNsid(nsid);
+    if (!result.success)
+        throw new InvalidNsidError(result.message);
+    return result.value;
+}
+function isValidNsid(nsid) {
+    // Since the regex version is more performant for valid NSIDs, we use it when
+    // we don't care about error details.
+    return validateNsidRegex(nsid).success;
+}
 // Human readable constraints on NSID:
 // - a valid domain in reversed notation
 // - followed by an additional period-separated name, which is camel-case letters
-const ensureValidNsid = (nsid) => {
-    const toCheck = nsid;
-    // check that all chars are boring ASCII
-    if (!/^[a-zA-Z0-9.-]*$/.test(toCheck)) {
-        throw new InvalidNsidError('Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)');
+function validateNsid(input) {
+    if (input.length > 253 + 1 + 63) {
+        return {
+            success: false,
+            message: 'NSID is too long (317 chars max)',
+        };
     }
-    if (toCheck.length > 253 + 1 + 63) {
-        throw new InvalidNsidError('NSID is too long (317 chars max)');
+    if (hasDisallowedCharacters(input)) {
+        return {
+            success: false,
+            message: 'Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)',
+        };
     }
-    const labels = toCheck.split('.');
-    if (labels.length < 3) {
-        throw new InvalidNsidError('NSID needs at least three parts');
+    const segments = input.split('.');
+    if (segments.length < 3) {
+        return {
+            success: false,
+            message: 'NSID needs at least three parts',
+        };
     }
-    for (let i = 0; i < labels.length; i++) {
-        const l = labels[i];
+    for (const l of segments) {
         if (l.length < 1) {
-            throw new InvalidNsidError('NSID parts can not be empty');
+            return {
+                success: false,
+                message: 'NSID parts can not be empty',
+            };
         }
         if (l.length > 63) {
-            throw new InvalidNsidError('NSID part too long (max 63 chars)');
-        }
-        if (l.endsWith('-') || l.startsWith('-')) {
-            throw new InvalidNsidError('NSID parts can not start or end with hyphen');
-        }
-        if (/^[0-9]/.test(l) && i === 0) {
-            throw new InvalidNsidError('NSID first part may not start with a digit');
+            return {
+                success: false,
+                message: 'NSID part too long (max 63 chars)',
+            };
         }
-        if (!/^[a-zA-Z][a-zA-Z0-9]*$/.test(l) && i + 1 === labels.length) {
-            throw new InvalidNsidError('NSID name part must be only letters and digits (and no leading digit)');
+        if (startsWithHyphen(l) || endsWithHyphen(l)) {
+            return {
+                success: false,
+                message: 'NSID parts can not start or end with hyphen',
+            };
         }
     }
-};
-exports.ensureValidNsid = ensureValidNsid;
-const ensureValidNsidRegex = (nsid) => {
-    // simple regex to enforce most constraints via just regex and length.
-    // hand wrote this regex based on above constraints
-    if (!/^[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(\.[a-zA-Z]([a-zA-Z0-9]{0,62})?)$/.test(nsid)) {
-        throw new InvalidNsidError("NSID didn't validate via regex");
+    if (startsWithNumber(segments[0])) {
+        return {
+            success: false,
+            message: 'NSID first part may not start with a digit',
+        };
     }
-    if (nsid.length > 253 + 1 + 63) {
-        throw new InvalidNsidError('NSID is too long (317 chars max)');
+    if (!isValidIdentifier(segments[segments.length - 1])) {
+        return {
+            success: false,
+            message: 'NSID name part must be only letters and digits (and no leading digit)',
+        };
     }
-};
-exports.ensureValidNsidRegex = ensureValidNsidRegex;
+    return {
+        success: true,
+        value: segments,
+    };
+}
+function hasDisallowedCharacters(v) {
+    return !/^[a-zA-Z0-9.-]*$/.test(v);
+}
+function startsWithNumber(v) {
+    const charCode = v.charCodeAt(0);
+    return charCode >= 48 && charCode <= 57;
+}
+function startsWithHyphen(v) {
+    return v.charCodeAt(0) === 45; /* - */
+}
+function endsWithHyphen(v) {
+    return v.charCodeAt(v.length - 1) === 45; /* - */
+}
+function isValidIdentifier(v) {
+    // Note, since we already know that "v" only contains [a-zA-Z0-9-], we can
+    // simplify the following regex by checking only the first char and presence
+    // of "-".
+    // return /^[a-zA-Z][a-zA-Z0-9]*$/.test(v)
+    return !startsWithNumber(v) && !v.includes('-');
+}
+/**
+ * @deprecated Use {@link ensureValidNsid} if you care about error details,
+ * {@link parseNsid}/{@link NSID.parse} if you need the parsed segments, or
+ * {@link isValidNsid} if you just want a boolean.
+ */
+function ensureValidNsidRegex(nsid) {
+    const result = validateNsidRegex(nsid);
+    if (!result.success)
+        throw new InvalidNsidError(result.message);
+}
+/**
+ * Regexp based validation that behaves identically to the previous code but
+ * provides less detailed error messages (while being 20% to 50% faster).
+ */
+function validateNsidRegex(value) {
+    if (value.length > 253 + 1 + 63) {
+        return {
+            success: false,
+            message: 'NSID is too long (317 chars max)',
+        };
+    }
+    if (!/^[a-zA-Z](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?:\.[a-zA-Z](?:[a-zA-Z0-9]{0,62})?)$/.test(value)) {
+        return {
+            success: false,
+            message: "NSID didn't validate via regex",
+        };
+    }
+    return {
+        success: true,
+        value: value,
+    };
+}
 class InvalidNsidError extends Error {
 }
 exports.InvalidNsidError = InvalidNsidError;

package/dist/nsid.js.map

@@ -1 +1 @@
-{"version":3,"file":"nsid.js","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;EAWE;;;AAEF,MAAa,IAAI;IAGf,MAAM,CAAC,KAAK,CAAC,IAAY;QACvB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY;QAC3C,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACpE,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC3B,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC;YACH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAChB,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,YAAY,IAAY;QApBxB;;;;mBAAqB,EAAE;WAAA;QAqBrB,IAAA,uBAAe,EAAC,IAAI,CAAC,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ;aACjB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aAClC,OAAO,EAAE;aACT,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;CACF;AAxCD,oBAwCC;AAED,sCAAsC;AACtC,wCAAwC;AACxC,iFAAiF;AAC1E,MAAM,eAAe,GAAG,CAAC,IAAY,EAAQ,EAAE;IACpD,MAAM,OAAO,GAAG,IAAI,CAAA;IAEpB,wCAAwC;IACxC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,gBAAgB,CACxB,6EAA6E,CAC9E,CAAA;IACH,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAClC,MAAM,IAAI,gBAAgB,CAAC,kCAAkC,CAAC,CAAA;IAChE,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,gBAAgB,CAAC,iCAAiC,CAAC,CAAA;IAC/D,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACnB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,gBAAgB,CAAC,6BAA6B,CAAC,CAAA;QAC3D,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,gBAAgB,CAAC,mCAAmC,CAAC,CAAA;QACjE,CAAC;QACD,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,gBAAgB,CAAC,6CAA6C,CAAC,CAAA;QAC3E,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,gBAAgB,CAAC,4CAA4C,CAAC,CAAA;QAC1E,CAAC;QACD,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACjE,MAAM,IAAI,gBAAgB,CACxB,uEAAuE,CACxE,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AArCY,QAAA,eAAe,mBAqC3B;AAEM,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAQ,EAAE;IACzD,sEAAsE;IACtE,mDAAmD;IACnD,IACE,CAAC,4HAA4H,CAAC,IAAI,CAChI,IAAI,CACL,EACD,CAAC;QACD,MAAM,IAAI,gBAAgB,CAAC,gCAAgC,CAAC,CAAA;IAC9D,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAC/B,MAAM,IAAI,gBAAgB,CAAC,kCAAkC,CAAC,CAAA;IAChE,CAAC;AACH,CAAC,CAAA;AAbY,QAAA,oBAAoB,wBAahC;AAED,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C"}
+{"version":3,"file":"nsid.js","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;EAWE;;;AAmDF,0CAGC;AAED,8BAIC;AAED,kCAIC;AASD,oCA0DC;AAiCD,oDAGC;AAMD,8CAuBC;AAlMD,MAAa,IAAI;IAGf,MAAM,CAAC,KAAK,CAAC,KAAa;QACxB,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY;QAC3C,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACjE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,WAAW,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAiC;QAC3C,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,sCAAsC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,IAAI,CAAE,KAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;IAED,YAAY,IAAY;QA1Bf;;;;;WAA2B;QA2BlC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ;aACjB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aAClC,OAAO,EAAE;aACT,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;CACF;AA7CD,oBA6CC;AAED,SAAgB,eAAe,CAAC,IAAY;IAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC/D,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED,SAAgB,WAAW,CAAC,IAAY;IACtC,6EAA6E;IAC7E,qCAAqC;IACrC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAA;AACxC,CAAC;AAMD,sCAAsC;AACtC,wCAAwC;AACxC,iFAAiF;AACjF,SAAgB,YAAY,CAAC,KAAa;IACxC,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IACD,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,6EAA6E;SAChF,CAAA;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,iCAAiC;SAC3C,CAAA;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6BAA6B;aACvC,CAAA;QACH,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,mCAAmC;aAC7C,CAAA;QACH,CAAC;QACD,IAAI,gBAAgB,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6CAA6C;aACvD,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,4CAA4C;SACtD,CAAA;IACH,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,uEAAuE;SAC1E,CAAA;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,QAAQ;KAChB,CAAA;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,CAAS;IACxC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,QAAQ,IAAI,EAAE,IAAI,QAAQ,IAAI,EAAE,CAAA;AACzC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AACvC,CAAC;AAED,SAAS,cAAc,CAAC,CAAS;IAC/B,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AAClD,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAS;IAClC,0EAA0E;IAC1E,4EAA4E;IAC5E,UAAU;IAEV,0CAA0C;IAC1C,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACjD,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IAED,IACE,CAAC,sIAAsI,CAAC,IAAI,CAC1I,KAAK,CACN,EACD,CAAC;QACD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,gCAAgC;SAC1C,CAAA;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAmB;KAC3B,CAAA;AACH,CAAC;AAED,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C","sourcesContent":["/*\nGrammar:\n\nalpha     = \"a\" / \"b\" / \"c\" / \"d\" / \"e\" / \"f\" / \"g\" / \"h\" / \"i\" / \"j\" / \"k\" / \"l\" / \"m\" / \"n\" / \"o\" / \"p\" / \"q\" / \"r\" / \"s\" / \"t\" / \"u\" / \"v\" / \"w\" / \"x\" / \"y\" / \"z\" / \"A\" / \"B\" / \"C\" / \"D\" / \"E\" / \"F\" / \"G\" / \"H\" / \"I\" / \"J\" / \"K\" / \"L\" / \"M\" / \"N\" / \"O\" / \"P\" / \"Q\" / \"R\" / \"S\" / \"T\" / \"U\" / \"V\" / \"W\" / \"X\" / \"Y\" / \"Z\"\nnumber    = \"1\" / \"2\" / \"3\" / \"4\" / \"5\" / \"6\" / \"7\" / \"8\" / \"9\" / \"0\"\ndelim     = \".\"\nsegment   = alpha *( alpha / number / \"-\" )\nauthority = segment *( delim segment )\nname      = alpha *( alpha / number )\nnsid      = authority delim name\n\n*/\n\nexport type NsidString = `${string}.${string}.${string}`\n\nexport class NSID {\n  readonly segments: readonly string[]\n\n  static parse(input: string): NSID {\n    return new NSID(input)\n  }\n\n  static create(authority: string, name: string): NSID {\n    const input = [...authority.split('.').reverse(), name].join('.')\n    return new NSID(input)\n  }\n\n  static isValid(nsid: string) {\n    return isValidNsid(nsid)\n  }\n\n  static from(input: { toString: () => string }): NSID {\n    if (input instanceof NSID) {\n      // No need to clone, NSID is immutable\n      return input\n    }\n    if (Array.isArray(input)) {\n      return new NSID((input as string[]).join('.'))\n    }\n    return new NSID(String(input))\n  }\n\n  constructor(nsid: string) {\n    this.segments = parseNsid(nsid)\n  }\n\n  get authority() {\n    return this.segments\n      .slice(0, this.segments.length - 1)\n      .reverse()\n      .join('.')\n  }\n\n  get name() {\n    return this.segments.at(this.segments.length - 1)\n  }\n\n  toString() {\n    return this.segments.join('.')\n  }\n}\n\nexport function ensureValidNsid(nsid: string): asserts nsid is NsidString {\n  const result = validateNsid(nsid)\n  if (!result.success) throw new InvalidNsidError(result.message)\n}\n\nexport function parseNsid(nsid: string): string[] {\n  const result = validateNsid(nsid)\n  if (!result.success) throw new InvalidNsidError(result.message)\n  return result.value\n}\n\nexport function isValidNsid(nsid: string): nsid is NsidString {\n  // Since the regex version is more performant for valid NSIDs, we use it when\n  // we don't care about error details.\n  return validateNsidRegex(nsid).success\n}\n\ntype ValidateResult<T> =\n  | { success: true; value: T }\n  | { success: false; message: string }\n\n// Human readable constraints on NSID:\n// - a valid domain in reversed notation\n// - followed by an additional period-separated name, which is camel-case letters\nexport function validateNsid(input: string): ValidateResult<string[]> {\n  if (input.length > 253 + 1 + 63) {\n    return {\n      success: false,\n      message: 'NSID is too long (317 chars max)',\n    }\n  }\n  if (hasDisallowedCharacters(input)) {\n    return {\n      success: false,\n      message:\n        'Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)',\n    }\n  }\n  const segments = input.split('.')\n  if (segments.length < 3) {\n    return {\n      success: false,\n      message: 'NSID needs at least three parts',\n    }\n  }\n  for (const l of segments) {\n    if (l.length < 1) {\n      return {\n        success: false,\n        message: 'NSID parts can not be empty',\n      }\n    }\n    if (l.length > 63) {\n      return {\n        success: false,\n        message: 'NSID part too long (max 63 chars)',\n      }\n    }\n    if (startsWithHyphen(l) || endsWithHyphen(l)) {\n      return {\n        success: false,\n        message: 'NSID parts can not start or end with hyphen',\n      }\n    }\n  }\n  if (startsWithNumber(segments[0])) {\n    return {\n      success: false,\n      message: 'NSID first part may not start with a digit',\n    }\n  }\n  if (!isValidIdentifier(segments[segments.length - 1])) {\n    return {\n      success: false,\n      message:\n        'NSID name part must be only letters and digits (and no leading digit)',\n    }\n  }\n  return {\n    success: true,\n    value: segments,\n  }\n}\n\nfunction hasDisallowedCharacters(v: string) {\n  return !/^[a-zA-Z0-9.-]*$/.test(v)\n}\n\nfunction startsWithNumber(v: string) {\n  const charCode = v.charCodeAt(0)\n  return charCode >= 48 && charCode <= 57\n}\n\nfunction startsWithHyphen(v: string) {\n  return v.charCodeAt(0) === 45 /* - */\n}\n\nfunction endsWithHyphen(v: string) {\n  return v.charCodeAt(v.length - 1) === 45 /* - */\n}\n\nfunction isValidIdentifier(v: string) {\n  // Note, since we already know that \"v\" only contains [a-zA-Z0-9-], we can\n  // simplify the following regex by checking only the first char and presence\n  // of \"-\".\n\n  // return /^[a-zA-Z][a-zA-Z0-9]*$/.test(v)\n  return !startsWithNumber(v) && !v.includes('-')\n}\n\n/**\n * @deprecated Use {@link ensureValidNsid} if you care about error details,\n * {@link parseNsid}/{@link NSID.parse} if you need the parsed segments, or\n * {@link isValidNsid} if you just want a boolean.\n */\nexport function ensureValidNsidRegex(nsid: string): asserts nsid is NsidString {\n  const result = validateNsidRegex(nsid)\n  if (!result.success) throw new InvalidNsidError(result.message)\n}\n\n/**\n * Regexp based validation that behaves identically to the previous code but\n * provides less detailed error messages (while being 20% to 50% faster).\n */\nexport function validateNsidRegex(value: string): ValidateResult<NsidString> {\n  if (value.length > 253 + 1 + 63) {\n    return {\n      success: false,\n      message: 'NSID is too long (317 chars max)',\n    }\n  }\n\n  if (\n    !/^[a-zA-Z](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?:\\.[a-zA-Z](?:[a-zA-Z0-9]{0,62})?)$/.test(\n      value,\n    )\n  ) {\n    return {\n      success: false,\n      message: \"NSID didn't validate via regex\",\n    }\n  }\n\n  return {\n    success: true,\n    value: value as NsidString,\n  }\n}\n\nexport class InvalidNsidError extends Error {}\n"]}

package/dist/recordkey.d.ts

@@ -1,5 +1,6 @@
-export declare const ensureValidRecordKey: (rkey: string) => void;
-export declare const isValidRecordKey: (rkey: string) => boolean;
+export type RecordKeyString = string;
+export declare function ensureValidRecordKey(rkey: string): asserts rkey is RecordKeyString;
+export declare function isValidRecordKey(rkey: string): rkey is RecordKeyString;
 export declare class InvalidRecordKeyError extends Error {
 }
 //# sourceMappingURL=recordkey.d.ts.map

package/dist/recordkey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recordkey.d.ts","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,SAAU,MAAM,KAAG,IAUnD,CAAA;AAED,eAAO,MAAM,gBAAgB,SAAU,MAAM,KAAG,OAW/C,CAAA;AAED,qBAAa,qBAAsB,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"recordkey.d.ts","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,MAAM,CAAA;AAmBpC,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,IAAI,eAAe,CAgBjC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,eAAe,CAOtE;AAED,qBAAa,qBAAsB,SAAQ,KAAK;CAAG"}

package/dist/recordkey.js

@@ -1,31 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidRecordKeyError = exports.isValidRecordKey = exports.ensureValidRecordKey = void 0;
-const ensureValidRecordKey = (rkey) => {
-    if (rkey.length > 512 || rkey.length < 1) {
-        throw new InvalidRecordKeyError('record key must be 1 to 512 characters');
-    }
-    // simple regex to enforce most constraints via just regex and length.
-    if (!/^[a-zA-Z0-9_~.:-]{1,512}$/.test(rkey)) {
-        throw new InvalidRecordKeyError('record key syntax not valid (regex)');
+exports.InvalidRecordKeyError = void 0;
+exports.ensureValidRecordKey = ensureValidRecordKey;
+exports.isValidRecordKey = isValidRecordKey;
+const RECORD_KEY_MAX_LENGTH = 512;
+const RECORD_KEY_MIN_LENGTH = 1;
+const RECORD_KEY_INVALID_VALUES = new Set(['.', '..']);
+const RECORD_KEY_REGEX = /^[a-zA-Z0-9_~.:-]{1,512}$/;
+// https://atproto.com/specs/record-key#record-key-syntax
+// Regardless of the type, Record Keys must fulfill some baseline syntax constraints:
+// - restricted to a subset of ASCII characters -- the allowed characters are
+//   alphanumeric (A-Za-z0-9), period, dash, underscore, colon, or tilde (.-_:~)
+// - must have at least 1 and at most 512 characters
+// - the specific record key values . and .. are not allowed
+// - must be a permissible part of repository MST path string (the above
+//   constraints satisfy this condition)
+// - must be permissible to include in a path component of a URI (following
+//   RFC-3986, section 3.3). The above constraints satisfy this condition, by
+//   matching the "unreserved" characters allowed in generic URI paths.
+function ensureValidRecordKey(rkey) {
+    if (rkey.length > RECORD_KEY_MAX_LENGTH ||
+        rkey.length < RECORD_KEY_MIN_LENGTH) {
+        throw new InvalidRecordKeyError(`record key must be ${RECORD_KEY_MIN_LENGTH} to ${RECORD_KEY_MAX_LENGTH} characters`);
     }
-    if (rkey === '.' || rkey === '..')
+    if (RECORD_KEY_INVALID_VALUES.has(rkey)) {
         throw new InvalidRecordKeyError('record key can not be "." or ".."');
-};
-exports.ensureValidRecordKey = ensureValidRecordKey;
-const isValidRecordKey = (rkey) => {
-    try {
-        (0, exports.ensureValidRecordKey)(rkey);
     }
-    catch (err) {
-        if (err instanceof InvalidRecordKeyError) {
-            return false;
-        }
-        throw err;
+    // simple regex to enforce most constraints via just regex and length.
+    if (!RECORD_KEY_REGEX.test(rkey)) {
+        throw new InvalidRecordKeyError('record key syntax not valid (regex)');
     }
-    return true;
-};
-exports.isValidRecordKey = isValidRecordKey;
+}
+function isValidRecordKey(rkey) {
+    return (rkey.length >= RECORD_KEY_MIN_LENGTH &&
+        rkey.length <= RECORD_KEY_MAX_LENGTH &&
+        RECORD_KEY_REGEX.test(rkey) &&
+        !RECORD_KEY_INVALID_VALUES.has(rkey));
+}
 class InvalidRecordKeyError extends Error {
 }
 exports.InvalidRecordKeyError = InvalidRecordKeyError;

package/dist/recordkey.js.map

@@ -1 +1 @@
-{"version":3,"file":"recordkey.js","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":";;;AAAO,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAQ,EAAE;IACzD,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,qBAAqB,CAAC,wCAAwC,CAAC,CAAA;IAC3E,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,CAAC,CAAA;IACxE,CAAC;IACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI;QAC/B,MAAM,IAAI,qBAAqB,CAAC,mCAAmC,CAAC,CAAA;AACxE,CAAC,CAAA;AAVY,QAAA,oBAAoB,wBAUhC;AAEM,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAW,EAAE;IACxD,IAAI,CAAC;QACH,IAAA,4BAAoB,EAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,qBAAqB,EAAE,CAAC;YACzC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAXY,QAAA,gBAAgB,oBAW5B;AAED,MAAa,qBAAsB,SAAQ,KAAK;CAAG;AAAnD,sDAAmD"}
+{"version":3,"file":"recordkey.js","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":";;;AAmBA,oDAkBC;AAED,4CAOC;AA5CD,MAAM,qBAAqB,GAAG,GAAG,CAAA;AACjC,MAAM,qBAAqB,GAAG,CAAC,CAAA;AAC/B,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;AACtD,MAAM,gBAAgB,GAAG,2BAA2B,CAAA;AAEpD,yDAAyD;AACzD,qFAAqF;AACrF,6EAA6E;AAC7E,gFAAgF;AAChF,oDAAoD;AACpD,4DAA4D;AAC5D,wEAAwE;AACxE,wCAAwC;AACxC,2EAA2E;AAC3E,6EAA6E;AAC7E,uEAAuE;AAEvE,SAAgB,oBAAoB,CAClC,IAAY;IAEZ,IACE,IAAI,CAAC,MAAM,GAAG,qBAAqB;QACnC,IAAI,CAAC,MAAM,GAAG,qBAAqB,EACnC,CAAC;QACD,MAAM,IAAI,qBAAqB,CAC7B,sBAAsB,qBAAqB,OAAO,qBAAqB,aAAa,CACrF,CAAA;IACH,CAAC;IACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,qBAAqB,CAAC,mCAAmC,CAAC,CAAA;IACtE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,CAAC,CAAA;IACxE,CAAC;AACH,CAAC;AAED,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,OAAO,CACL,IAAI,CAAC,MAAM,IAAI,qBAAqB;QACpC,IAAI,CAAC,MAAM,IAAI,qBAAqB;QACpC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3B,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,CAAC,CACrC,CAAA;AACH,CAAC;AAED,MAAa,qBAAsB,SAAQ,KAAK;CAAG;AAAnD,sDAAmD","sourcesContent":["export type RecordKeyString = string\n\nconst RECORD_KEY_MAX_LENGTH = 512\nconst RECORD_KEY_MIN_LENGTH = 1\nconst RECORD_KEY_INVALID_VALUES = new Set(['.', '..'])\nconst RECORD_KEY_REGEX = /^[a-zA-Z0-9_~.:-]{1,512}$/\n\n// https://atproto.com/specs/record-key#record-key-syntax\n// Regardless of the type, Record Keys must fulfill some baseline syntax constraints:\n// - restricted to a subset of ASCII characters -- the allowed characters are\n//   alphanumeric (A-Za-z0-9), period, dash, underscore, colon, or tilde (.-_:~)\n// - must have at least 1 and at most 512 characters\n// - the specific record key values . and .. are not allowed\n// - must be a permissible part of repository MST path string (the above\n//   constraints satisfy this condition)\n// - must be permissible to include in a path component of a URI (following\n//   RFC-3986, section 3.3). The above constraints satisfy this condition, by\n//   matching the \"unreserved\" characters allowed in generic URI paths.\n\nexport function ensureValidRecordKey(\n  rkey: string,\n): asserts rkey is RecordKeyString {\n  if (\n    rkey.length > RECORD_KEY_MAX_LENGTH ||\n    rkey.length < RECORD_KEY_MIN_LENGTH\n  ) {\n    throw new InvalidRecordKeyError(\n      `record key must be ${RECORD_KEY_MIN_LENGTH} to ${RECORD_KEY_MAX_LENGTH} characters`,\n    )\n  }\n  if (RECORD_KEY_INVALID_VALUES.has(rkey)) {\n    throw new InvalidRecordKeyError('record key can not be \".\" or \"..\"')\n  }\n  // simple regex to enforce most constraints via just regex and length.\n  if (!RECORD_KEY_REGEX.test(rkey)) {\n    throw new InvalidRecordKeyError('record key syntax not valid (regex)')\n  }\n}\n\nexport function isValidRecordKey(rkey: string): rkey is RecordKeyString {\n  return (\n    rkey.length >= RECORD_KEY_MIN_LENGTH &&\n    rkey.length <= RECORD_KEY_MAX_LENGTH &&\n    RECORD_KEY_REGEX.test(rkey) &&\n    !RECORD_KEY_INVALID_VALUES.has(rkey)\n  )\n}\n\nexport class InvalidRecordKeyError extends Error {}\n"]}

package/dist/tid.d.ts

@@ -1,5 +1,6 @@
-export declare const ensureValidTid: (tid: string) => void;
-export declare const isValidTid: (tid: string) => boolean;
+export type TidString = string;
+export declare function ensureValidTid(tid: string): asserts tid is TidString;
+export declare function isValidTid(tid: string): tid is TidString;
 export declare class InvalidTidError extends Error {
 }
 //# sourceMappingURL=tid.d.ts.map

package/dist/tid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tid.d.ts","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,QAAS,MAAM,KAAG,IAQ5C,CAAA;AAED,eAAO,MAAM,UAAU,QAAS,MAAM,KAAG,OAExC,CAAA;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"tid.d.ts","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAK9B,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,SAAS,CAQpE;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,SAAS,CAExD;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG"}

package/dist/tid.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidTidError = exports.isValidTid = exports.ensureValidTid = void 0;
+exports.InvalidTidError = void 0;
+exports.ensureValidTid = ensureValidTid;
+exports.isValidTid = isValidTid;
 const TID_LENGTH = 13;
 const TID_REGEX = /^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$/;
-const ensureValidTid = (tid) => {
+function ensureValidTid(tid) {
     if (tid.length !== TID_LENGTH) {
         throw new InvalidTidError(`TID must be ${TID_LENGTH} characters`);
     }
@@ -11,12 +13,10 @@ const ensureValidTid = (tid) => {
     if (!TID_REGEX.test(tid)) {
         throw new InvalidTidError('TID syntax not valid (regex)');
     }
-};
-exports.ensureValidTid = ensureValidTid;
-const isValidTid = (tid) => {
+}
+function isValidTid(tid) {
     return tid.length === TID_LENGTH && TID_REGEX.test(tid);
-};
-exports.isValidTid = isValidTid;
+}
 class InvalidTidError extends Error {
 }
 exports.InvalidTidError = InvalidTidError;

package/dist/tid.js.map

@@ -1 +1 @@
-{"version":3,"file":"tid.js","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":";;;AAAA,MAAM,UAAU,GAAG,EAAE,CAAA;AACrB,MAAM,SAAS,GAAG,4DAA4D,CAAA;AAEvE,MAAM,cAAc,GAAG,CAAC,GAAW,EAAQ,EAAE;IAClD,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,eAAe,UAAU,aAAa,CAAC,CAAA;IACnE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC,CAAA;AARY,QAAA,cAAc,kBAQ1B;AAEM,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACzD,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB;AAED,MAAa,eAAgB,SAAQ,KAAK;CAAG;AAA7C,0CAA6C"}
+{"version":3,"file":"tid.js","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":";;;AAKA,wCAQC;AAED,gCAEC;AAfD,MAAM,UAAU,GAAG,EAAE,CAAA;AACrB,MAAM,SAAS,GAAG,4DAA4D,CAAA;AAE9E,SAAgB,cAAc,CAAC,GAAW;IACxC,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,eAAe,UAAU,aAAa,CAAC,CAAA;IACnE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED,SAAgB,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACzD,CAAC;AAED,MAAa,eAAgB,SAAQ,KAAK;CAAG;AAA7C,0CAA6C","sourcesContent":["export type TidString = string\n\nconst TID_LENGTH = 13\nconst TID_REGEX = /^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$/\n\nexport function ensureValidTid(tid: string): asserts tid is TidString {\n  if (tid.length !== TID_LENGTH) {\n    throw new InvalidTidError(`TID must be ${TID_LENGTH} characters`)\n  }\n  // simple regex to enforce most constraints via just regex and length.\n  if (!TID_REGEX.test(tid)) {\n    throw new InvalidTidError('TID syntax not valid (regex)')\n  }\n}\n\nexport function isValidTid(tid: string): tid is TidString {\n  return tid.length === TID_LENGTH && TID_REGEX.test(tid)\n}\n\nexport class InvalidTidError extends Error {}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/syntax",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "license": "MIT",
   "description": "Validation for atproto identifiers and formats: DID, handle, NSID, AT URI, etc",
   "keywords": [

package/src/at-identifier.ts

@@ -0,0 +1,22 @@
+import { DidString, ensureValidDidRegex } from './did.js'
+import {
+  HandleString,
+  InvalidHandleError,
+  ensureValidHandleRegex,
+} from './handle.js'
+
+export type AtIdentifierString = DidString | HandleString
+
+export function ensureValidAtIdentifier(
+  input: string,
+): asserts input is AtIdentifierString {
+  try {
+    if (input.startsWith('did:')) {
+      ensureValidDidRegex(input)
+    } else {
+      ensureValidHandleRegex(input)
+    }
+  } catch (cause) {
+    throw new InvalidHandleError('Invalid DID or handle', { cause })
+  }
+}