@atproto/did 0.1.0

package/dist/did.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.didSchema = exports.isDid = exports.checkDid = exports.checkDidMsid = exports.extractDidMethod = exports.checkDidMethod = exports.DID_PREFIX = void 0;
+const zod_1 = require("zod");
+const did_error_js_1 = require("./did-error.js");
+const DID_PREFIX = 'did:';
+exports.DID_PREFIX = DID_PREFIX;
+const DID_PREFIX_LENGTH = DID_PREFIX.length;
+/**
+ * DID Method-name check function.
+ *
+ * Check if the input is a valid DID method name, at the position between
+ * `start` (inclusive) and `end` (exclusive).
+ */
+function checkDidMethod(input, start = 0, end = input.length) {
+    if (!Number.isFinite(end) ||
+        !Number.isFinite(start) ||
+        end < start ||
+        end > input.length) {
+        throw new TypeError('Invalid start or end position');
+    }
+    if (end === start) {
+        throw new did_error_js_1.InvalidDidError(input, `Empty method name`);
+    }
+    let c;
+    for (let i = start; i < end; i++) {
+        c = input.charCodeAt(i);
+        if ((c < 0x61 || c > 0x7a) && // a-z
+            (c < 0x30 || c > 0x39) // 0-9
+        ) {
+            throw new did_error_js_1.InvalidDidError(input, `Invalid character at position ${i} in DID method name`);
+        }
+    }
+}
+exports.checkDidMethod = checkDidMethod;
+/**
+ * This method assumes the input is a valid Did
+ */
+function extractDidMethod(did) {
+    const msidSep = did.indexOf(':', DID_PREFIX_LENGTH);
+    const method = did.slice(DID_PREFIX_LENGTH, msidSep);
+    return method;
+}
+exports.extractDidMethod = extractDidMethod;
+/**
+ * DID Method-specific identifier check function.
+ *
+ * Check if the input is a valid DID method-specific identifier, at the position
+ * between `start` (inclusive) and `end` (exclusive).
+ */
+function checkDidMsid(input, start = 0, end = input.length) {
+    if (!Number.isFinite(end) ||
+        !Number.isFinite(start) ||
+        end < start ||
+        end > input.length) {
+        throw new TypeError('Invalid start or end position');
+    }
+    if (end === start) {
+        throw new did_error_js_1.InvalidDidError(input, `DID method-specific id must not be empty`);
+    }
+    let c;
+    for (let i = start; i < end; i++) {
+        c = input.charCodeAt(i);
+        // Check for frequent chars first
+        if ((c < 0x61 || c > 0x7a) && // a-z
+            (c < 0x41 || c > 0x5a) && // A-Z
+            (c < 0x30 || c > 0x39) && // 0-9
+            c !== 0x2e && // .
+            c !== 0x2d && // -
+            c !== 0x5f // _
+        ) {
+            // Less frequent chars are checked here
+            // ":"
+            if (c === 0x3a) {
+                if (i === end - 1) {
+                    throw new did_error_js_1.InvalidDidError(input, `DID cannot end with ":"`);
+                }
+                continue;
+            }
+            // pct-encoded
+            if (c === 0x25) {
+                c = input.charCodeAt(++i);
+                if ((c < 0x30 || c > 0x39) && (c < 0x41 || c > 0x46)) {
+                    throw new did_error_js_1.InvalidDidError(input, `Invalid pct-encoded character at position ${i}`);
+                }
+                c = input.charCodeAt(++i);
+                if ((c < 0x30 || c > 0x39) && (c < 0x41 || c > 0x46)) {
+                    throw new did_error_js_1.InvalidDidError(input, `Invalid pct-encoded character at position ${i}`);
+                }
+                // There must always be 2 HEXDIG after a "%"
+                if (i >= end) {
+                    throw new did_error_js_1.InvalidDidError(input, `Incomplete pct-encoded character at position ${i - 2}`);
+                }
+                continue;
+            }
+            throw new did_error_js_1.InvalidDidError(input, `Disallowed character in DID at position ${i}`);
+        }
+    }
+}
+exports.checkDidMsid = checkDidMsid;
+function checkDid(input) {
+    if (typeof input !== 'string') {
+        throw new did_error_js_1.InvalidDidError(typeof input, `DID must be a string`);
+    }
+    const { length } = input;
+    if (length > 2048) {
+        throw new did_error_js_1.InvalidDidError(input, `DID is too long (2048 chars max)`);
+    }
+    if (!input.startsWith(DID_PREFIX)) {
+        throw new did_error_js_1.InvalidDidError(input, `DID requires "${DID_PREFIX}" prefix`);
+    }
+    const idSep = input.indexOf(':', DID_PREFIX_LENGTH);
+    if (idSep === -1) {
+        throw new did_error_js_1.InvalidDidError(input, `Missing colon after method name`);
+    }
+    checkDidMethod(input, DID_PREFIX_LENGTH, idSep);
+    checkDidMsid(input, idSep + 1, length);
+}
+exports.checkDid = checkDid;
+function isDid(input) {
+    try {
+        checkDid(input);
+        return true;
+    }
+    catch (err) {
+        if (err instanceof did_error_js_1.DidError) {
+            return false;
+        }
+        throw err;
+    }
+}
+exports.isDid = isDid;
+exports.didSchema = zod_1.z
+    .string()
+    .superRefine((value, ctx) => {
+    try {
+        checkDid(value);
+        return true;
+    }
+    catch (err) {
+        ctx.addIssue({
+            code: zod_1.z.ZodIssueCode.custom,
+            message: err instanceof Error ? err.message : 'Unexpected error',
+        });
+        return false;
+    }
+});
+//# sourceMappingURL=did.js.map

package/dist/did.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did.js","sourceRoot":"","sources":["../src/did.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,iDAA0D;AAE1D,MAAM,UAAU,GAAG,MAAM,CAAA;AAEhB,gCAAU;AADnB,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAA;AA2E3C;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,KAAa,EACb,KAAK,GAAG,CAAC,EACT,GAAG,GAAG,KAAK,CAAC,MAAM;IAElB,IACE,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QACrB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QACvB,GAAG,GAAG,KAAK;QACX,GAAG,GAAG,KAAK,CAAC,MAAM,EAClB,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,+BAA+B,CAAC,CAAA;IACtD,CAAC;IACD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAClB,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAA;IACvD,CAAC;IAED,IAAI,CAAS,CAAA;IACb,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACvB,IACE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,MAAM;YAChC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM;UAC7B,CAAC;YACD,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,iCAAiC,CAAC,qBAAqB,CACxD,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AA9BD,wCA8BC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAgB,GAAM;IACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAA;IACnD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;IACpD,OAAO,MAA6C,CAAA;AACtD,CAAC;AAJD,4CAIC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,KAAK,GAAG,CAAC,EACT,GAAG,GAAG,KAAK,CAAC,MAAM;IAElB,IACE,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QACrB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QACvB,GAAG,GAAG,KAAK;QACX,GAAG,GAAG,KAAK,CAAC,MAAM,EAClB,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,+BAA+B,CAAC,CAAA;IACtD,CAAC;IACD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAClB,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,0CAA0C,CAAC,CAAA;IAC9E,CAAC;IAED,IAAI,CAAS,CAAA;IACb,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QAEvB,iCAAiC;QACjC,IACE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,MAAM;YAChC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,MAAM;YAChC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,MAAM;YAChC,CAAC,KAAK,IAAI,IAAI,IAAI;YAClB,CAAC,KAAK,IAAI,IAAI,IAAI;YAClB,CAAC,KAAK,IAAI,CAAC,IAAI;UACf,CAAC;YACD,uCAAuC;YAEvC,MAAM;YACN,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,EAAE,CAAC;oBAClB,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAA;gBAC7D,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,cAAc;YACd,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACf,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;gBACzB,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrD,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,6CAA6C,CAAC,EAAE,CACjD,CAAA;gBACH,CAAC;gBAED,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;gBACzB,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrD,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,6CAA6C,CAAC,EAAE,CACjD,CAAA;gBACH,CAAC;gBAED,4CAA4C;gBAC5C,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;oBACb,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,gDAAgD,CAAC,GAAG,CAAC,EAAE,CACxD,CAAA;gBACH,CAAC;gBAED,SAAQ;YACV,CAAC;YAED,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,2CAA2C,CAAC,EAAE,CAC/C,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AA3ED,oCA2EC;AAED,SAAgB,QAAQ,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,8BAAe,CAAC,OAAO,KAAK,EAAE,sBAAsB,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAA;IACtE,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,iBAAiB,UAAU,UAAU,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAA;IACnD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAA;IACrE,CAAC;IAED,cAAc,CAAC,KAAK,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAA;IAC/C,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,CAAC,CAAA;AACxC,CAAC;AArBD,4BAqBC;AAED,SAAgB,KAAK,CAAC,KAAc;IAClC,IAAI,CAAC;QACH,QAAQ,CAAC,KAAK,CAAC,CAAA;QACf,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,uBAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAVD,sBAUC;AAEY,QAAA,SAAS,GAAG,OAAC;KACvB,MAAM,EAAE;KACR,WAAW,CAAC,CAAC,KAAa,EAAE,GAAoB,EAAgB,EAAE;IACjE,IAAI,CAAC;QACH,QAAQ,CAAC,KAAK,CAAC,CAAA;QACf,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;YAC3B,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB;SACjE,CAAC,CAAA;QACF,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './did-document.js';
+export * from './did-error.js';
+export * from './did.js';
+export * from './methods.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./did-document.js"), exports);
+__exportStar(require("./did-error.js"), exports);
+__exportStar(require("./did.js"), exports);
+__exportStar(require("./methods.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,iDAA8B;AAC9B,2CAAwB;AACxB,+CAA4B"}

package/dist/methods/plc.d.ts

@@ -0,0 +1,6 @@
+import { Did } from '../did.js';
+declare const DID_PLC_PREFIX = "did:plc:";
+export { DID_PLC_PREFIX };
+export declare function isDidPlc(input: unknown): input is Did<'plc'>;
+export declare function checkDidPlc(input: string): asserts input is Did<'plc'>;
+//# sourceMappingURL=plc.d.ts.map

package/dist/methods/plc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plc.d.ts","sourceRoot":"","sources":["../../src/methods/plc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAE/B,QAAA,MAAM,cAAc,aAAa,CAAA;AAIjC,OAAO,EAAE,cAAc,EAAE,CAAA;AAEzB,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAQ5D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAoBtE"}

package/dist/methods/plc.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkDidPlc = exports.isDidPlc = exports.DID_PLC_PREFIX = void 0;
+const did_error_js_1 = require("../did-error.js");
+const DID_PLC_PREFIX = `did:plc:`;
+exports.DID_PLC_PREFIX = DID_PLC_PREFIX;
+const DID_PLC_PREFIX_LENGTH = DID_PLC_PREFIX.length;
+const DID_PLC_LENGTH = 32;
+function isDidPlc(input) {
+    if (typeof input !== 'string')
+        return false;
+    try {
+        checkDidPlc(input);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isDidPlc = isDidPlc;
+function checkDidPlc(input) {
+    if (input.length !== DID_PLC_LENGTH) {
+        throw new did_error_js_1.InvalidDidError(input, `did:plc must be ${DID_PLC_LENGTH} characters long`);
+    }
+    if (!input.startsWith(DID_PLC_PREFIX)) {
+        throw new did_error_js_1.InvalidDidError(input, `Invalid did:plc prefix`);
+    }
+    let c;
+    for (let i = DID_PLC_PREFIX_LENGTH; i < DID_PLC_LENGTH; i++) {
+        c = input.charCodeAt(i);
+        // Base32 encoding ([a-z2-7])
+        if ((c < 0x61 || c > 0x7a) && (c < 0x32 || c > 0x37)) {
+            throw new did_error_js_1.InvalidDidError(input, `Invalid character at position ${i}`);
+        }
+    }
+}
+exports.checkDidPlc = checkDidPlc;
+//# sourceMappingURL=plc.js.map

package/dist/methods/plc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plc.js","sourceRoot":"","sources":["../../src/methods/plc.ts"],"names":[],"mappings":";;;AAAA,kDAAiD;AAGjD,MAAM,cAAc,GAAG,UAAU,CAAA;AAIxB,wCAAc;AAHvB,MAAM,qBAAqB,GAAG,cAAc,CAAC,MAAM,CAAA;AACnD,MAAM,cAAc,GAAG,EAAE,CAAA;AAIzB,SAAgB,QAAQ,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,IAAI,CAAC;QACH,WAAW,CAAC,KAAK,CAAC,CAAA;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AARD,4BAQC;AAED,SAAgB,WAAW,CAAC,KAAa;IACvC,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;QACpC,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,mBAAmB,cAAc,kBAAkB,CACpD,CAAA;IACH,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAA;IAC5D,CAAC;IAED,IAAI,CAAS,CAAA;IACb,KAAK,IAAI,CAAC,GAAG,qBAAqB,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5D,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACvB,6BAA6B;QAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,8BAAe,CAAC,KAAK,EAAE,iCAAiC,CAAC,EAAE,CAAC,CAAA;QACxE,CAAC;IACH,CAAC;AACH,CAAC;AApBD,kCAoBC"}

package/dist/methods/web.d.ts

@@ -0,0 +1,16 @@
+import { Did } from '../did.js';
+export declare const DID_WEB_PREFIX = "did:web:";
+/**
+ * This function checks if the input is a valid Web DID, as per DID spec.
+ * ATPROTO adds additional constraints to allowed DID values for the `did:web`
+ * method. Use {@link isAtprotoDidWeb} if that's what you need.
+ */
+export declare function isDidWeb(input: unknown): input is Did<'web'>;
+/**
+ * @see {@link https://atproto.com/specs/did#blessed-did-methods}
+ */
+export declare function isAtprotoDidWeb(input: unknown): input is Did<'web'>;
+export declare function checkDidWeb(input: string): asserts input is Did<'web'>;
+export declare function didWebToUrl(did: string): URL;
+export declare function urlToDidWeb(url: URL): Did<'web'>;
+//# sourceMappingURL=web.d.ts.map

package/dist/methods/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../src/methods/web.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAgB,MAAM,WAAW,CAAA;AAE7C,eAAO,MAAM,cAAc,aAAa,CAAA;AAExC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAQ5D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAoBnE;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAEtE;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAmB5C;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAOhD"}

package/dist/methods/web.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlToDidWeb = exports.didWebToUrl = exports.checkDidWeb = exports.isAtprotoDidWeb = exports.isDidWeb = exports.DID_WEB_PREFIX = void 0;
+const did_error_js_1 = require("../did-error.js");
+const did_js_1 = require("../did.js");
+exports.DID_WEB_PREFIX = `did:web:`;
+/**
+ * This function checks if the input is a valid Web DID, as per DID spec.
+ * ATPROTO adds additional constraints to allowed DID values for the `did:web`
+ * method. Use {@link isAtprotoDidWeb} if that's what you need.
+ */
+function isDidWeb(input) {
+    if (typeof input !== 'string')
+        return false;
+    try {
+        didWebToUrl(input);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isDidWeb = isDidWeb;
+/**
+ * @see {@link https://atproto.com/specs/did#blessed-did-methods}
+ */
+function isAtprotoDidWeb(input) {
+    // Optimization: make cheap checks first
+    if (typeof input !== 'string') {
+        return false;
+    }
+    // Path are not allowed
+    if (input.includes(':', exports.DID_WEB_PREFIX.length)) {
+        return false;
+    }
+    // Port numbers are not allowed, except for localhost
+    if (input.includes('%3A', exports.DID_WEB_PREFIX.length) &&
+        !input.startsWith('did:web:localhost%3A')) {
+        return false;
+    }
+    return isDidWeb(input);
+}
+exports.isAtprotoDidWeb = isAtprotoDidWeb;
+function checkDidWeb(input) {
+    didWebToUrl(input);
+}
+exports.checkDidWeb = checkDidWeb;
+function didWebToUrl(did) {
+    if (!did.startsWith(exports.DID_WEB_PREFIX)) {
+        throw new did_error_js_1.InvalidDidError(did, `did:web must start with ${exports.DID_WEB_PREFIX}`);
+    }
+    if (did.charAt(exports.DID_WEB_PREFIX.length) === ':') {
+        throw new did_error_js_1.InvalidDidError(did, 'did:web MSID must not start with a colon');
+    }
+    // Make sure every char is valid (per DID spec)
+    (0, did_js_1.checkDidMsid)(did, exports.DID_WEB_PREFIX.length);
+    try {
+        const msid = did.slice(exports.DID_WEB_PREFIX.length);
+        const parts = msid.split(':').map(decodeURIComponent);
+        return new URL(`https://${parts.join('/')}`);
+    }
+    catch (cause) {
+        throw new did_error_js_1.InvalidDidError(did, 'Invalid Web DID', cause);
+    }
+}
+exports.didWebToUrl = didWebToUrl;
+function urlToDidWeb(url) {
+    const path = url.pathname === '/'
+        ? ''
+        : url.pathname.slice(1).split('/').map(encodeURIComponent).join(':');
+    return `did:web:${encodeURIComponent(url.host)}${path ? `:${path}` : ''}`;
+}
+exports.urlToDidWeb = urlToDidWeb;
+//# sourceMappingURL=web.js.map

package/dist/methods/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/methods/web.ts"],"names":[],"mappings":";;;AAAA,kDAAiD;AACjD,sCAA6C;AAEhC,QAAA,cAAc,GAAG,UAAU,CAAA;AAExC;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,IAAI,CAAC;QACH,WAAW,CAAC,KAAK,CAAC,CAAA;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AARD,4BAQC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC5C,wCAAwC;IACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,uBAAuB;IACvB,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,sBAAc,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,qDAAqD;IACrD,IACE,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAc,CAAC,MAAM,CAAC;QAC5C,CAAC,KAAK,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzC,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AApBD,0CAoBC;AAED,SAAgB,WAAW,CAAC,KAAa;IACvC,WAAW,CAAC,KAAK,CAAC,CAAA;AACpB,CAAC;AAFD,kCAEC;AAED,SAAgB,WAAW,CAAC,GAAW;IACrC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,sBAAc,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,8BAAe,CAAC,GAAG,EAAE,2BAA2B,sBAAc,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,CAAC,sBAAc,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;QAC9C,MAAM,IAAI,8BAAe,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAA;IAC5E,CAAC;IAED,+CAA+C;IAC/C,IAAA,qBAAY,EAAC,GAAG,EAAE,sBAAc,CAAC,MAAM,CAAC,CAAA;IAExC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAA;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QACrD,OAAO,IAAI,GAAG,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,8BAAe,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAA;IAC1D,CAAC;AACH,CAAC;AAnBD,kCAmBC;AAED,SAAgB,WAAW,CAAC,GAAQ;IAClC,MAAM,IAAI,GACR,GAAG,CAAC,QAAQ,KAAK,GAAG;QAClB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAExE,OAAO,WAAW,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;AAC3E,CAAC;AAPD,kCAOC"}

package/dist/methods.d.ts

@@ -0,0 +1,3 @@
+export * from './methods/plc.js';
+export * from './methods/web.js';
+//# sourceMappingURL=methods.d.ts.map

package/dist/methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.d.ts","sourceRoot":"","sources":["../src/methods.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA"}

package/dist/methods.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./methods/plc.js"), exports);
+__exportStar(require("./methods/web.js"), exports);
+//# sourceMappingURL=methods.js.map

package/dist/methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.js","sourceRoot":"","sources":["../src/methods.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,mDAAgC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@atproto/did",
+  "version": "0.1.0",
+  "license": "MIT",
+  "description": "DID resolution and verification library",
+  "keywords": [
+    "atproto",
+    "did",
+    "validation",
+    "types"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/did"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json"
+  }
+}

package/src/did-document.ts

@@ -0,0 +1,151 @@
+import { z } from 'zod'
+
+import { Did, didSchema } from './did.js'
+
+/**
+ * RFC3968 compliant URI
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc3986}
+ */
+const rfc3968UriSchema = z.string().refine((data) => {
+  try {
+    new URL(data)
+    return true
+  } catch {
+    return false
+  }
+}, 'RFC3968 compliant URI')
+
+const didControllerSchema = z.union([didSchema, z.array(didSchema)])
+
+/**
+ * @note this schema might be too permissive
+ */
+const didRelativeUriSchema = z.union([
+  rfc3968UriSchema,
+  z.string().regex(/^#[^#]+$/),
+])
+
+const didVerificationMethodSchema = z.object({
+  id: didRelativeUriSchema,
+  type: z.string().min(1),
+  controller: didControllerSchema,
+  publicKeyJwk: z.record(z.string(), z.unknown()).optional(),
+  publicKeyMultibase: z.string().optional(),
+})
+
+/**
+ * The value of the id property MUST be a URI conforming to [RFC3986]. A
+ * conforming producer MUST NOT produce multiple service entries with the same
+ * id. A conforming consumer MUST produce an error if it detects multiple
+ * service entries with the same id.
+ *
+ * @note Normally, only rfc3968UriSchema should be allowed here. However, the
+ *   did:plc uses relative URI. For this reason, we also allow relative URIs
+ *   here.
+ */
+const didServiceIdSchema = didRelativeUriSchema
+
+/**
+ * The value of the type property MUST be a string or a set of strings. In order
+ * to maximize interoperability, the service type and its associated properties
+ * SHOULD be registered in the DID Specification Registries
+ * [DID-SPEC-REGISTRIES].
+ */
+const didServiceTypeSchema = z.union([z.string(), z.array(z.string())])
+
+/**
+ * The value of the serviceEndpoint property MUST be a string, a map, or a set
+ * composed of one or more strings and/or maps. All string values MUST be valid
+ * URIs conforming to [RFC3986] and normalized according to the Normalization
+ * and Comparison rules in RFC3986 and to any normalization rules in its
+ * applicable URI scheme specification.
+ */
+const didServiceEndpointSchema = z.union([
+  rfc3968UriSchema,
+  z.record(z.string(), rfc3968UriSchema),
+  z
+    .array(z.union([rfc3968UriSchema, z.record(z.string(), rfc3968UriSchema)]))
+    .nonempty(),
+])
+
+/**
+ * Each service map MUST contain id, type, and serviceEndpoint properties.
+ * @see {@link https://www.w3.org/TR/did-core/#services}
+ */
+const didServiceSchema = z.object({
+  id: didServiceIdSchema,
+  type: didServiceTypeSchema,
+  serviceEndpoint: didServiceEndpointSchema,
+})
+
+export type DidService = z.infer<typeof didServiceSchema>
+
+const didAuthenticationSchema = z.union([
+  //
+  didRelativeUriSchema,
+  didVerificationMethodSchema,
+])
+
+/**
+ * @note This schema is incomplete
+ * @see {@link https://www.w3.org/TR/did-core/#production-0}
+ */
+export const didDocumentSchema = z.object({
+  '@context': z.union([
+    z.literal('https://www.w3.org/ns/did/v1'),
+    z
+      .array(z.string().url())
+      .nonempty()
+      .refine((data) => data[0] === 'https://www.w3.org/ns/did/v1', {
+        message: 'First @context must be https://www.w3.org/ns/did/v1',
+      }),
+  ]),
+  id: didSchema,
+  controller: didControllerSchema.optional(),
+  alsoKnownAs: z.array(rfc3968UriSchema).optional(),
+  service: z.array(didServiceSchema).optional(),
+  authentication: z.array(didAuthenticationSchema).optional(),
+  verificationMethod: z
+    .array(z.union([didVerificationMethodSchema, didRelativeUriSchema]))
+    .optional(),
+})
+
+export type DidDocument<Method extends string = string> = z.infer<
+  typeof didDocumentSchema
+> & { id: Did<Method> }
+
+// @TODO: add other refinements ?
+export const didDocumentValidator = didDocumentSchema
+  .superRefine((data, ctx) => {
+    if (data.service) {
+      for (let i = 0; i < data.service.length; i++) {
+        if (data.service[i].id === data.id) {
+          ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Service id must be different from the document id`,
+            path: ['service', i, 'id'],
+          })
+        }
+      }
+    }
+  })
+  .superRefine((data, ctx) => {
+    if (data.service) {
+      const normalizedIds = data.service.map((s) =>
+        s.id?.startsWith('#') ? `${data.id}${s.id}` : s.id,
+      )
+
+      for (let i = 0; i < normalizedIds.length; i++) {
+        for (let j = i + 1; j < normalizedIds.length; j++) {
+          if (normalizedIds[i] === normalizedIds[j]) {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              message: `Duplicate service id (${normalizedIds[j]}) found in the document`,
+              path: ['service', j, 'id'],
+            })
+          }
+        }
+      }
+    }
+  })

package/src/did-error.ts

@@ -0,0 +1,49 @@
+export class DidError extends Error {
+  constructor(
+    public readonly did: string,
+    message: string,
+    public readonly code: string,
+    public readonly status = 400,
+    cause?: unknown,
+  ) {
+    super(message, { cause })
+  }
+
+  /**
+   * For compatibility with error handlers in common HTTP frameworks.
+   */
+  get statusCode() {
+    return this.status
+  }
+
+  override toString() {
+    return `${this.constructor.name} ${this.code} (${this.did}): ${this.message}`
+  }
+
+  static from(cause: unknown, did: string): DidError {
+    if (cause instanceof DidError) {
+      return cause
+    }
+
+    const message =
+      cause instanceof Error
+        ? cause.message
+        : typeof cause === 'string'
+          ? cause
+          : 'An unknown error occurred'
+
+    const status =
+      (typeof cause?.['statusCode'] === 'number'
+        ? cause['statusCode']
+        : undefined) ??
+      (typeof cause?.['status'] === 'number' ? cause['status'] : undefined)
+
+    return new DidError(did, message, 'did-unknown-error', status, cause)
+  }
+}
+
+export class InvalidDidError extends DidError {
+  constructor(did: string, message: string, cause?: unknown) {
+    super(did, message, 'did-invalid', 400, cause)
+  }
+}