@atcute/identity 0.1.0

package/LICENSE

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @atcute/identity
+
+syntax, type definitions and schemas for atproto handles, DIDs and DID documents.

package/dist/did.d.ts

@@ -0,0 +1,14 @@
+import type { AtprotoDid, Did } from './types.js';
+export declare const DID_RE: RegExp;
+/**
+ * checks if it's a DID identifier
+ */
+export declare const isDid: (input: string) => input is Did;
+/**
+ * checks if it's a DID identifier that is supported by atproto
+ */
+export declare const isAtprotoDid: (input: string) => input is AtprotoDid;
+/**
+ * returns the DID's method
+ */
+export declare const extractDidMethod: <M extends string>(did: Did<M>) => M;

package/dist/did.js

@@ -0,0 +1,24 @@
+import { isPlcDid } from './methods/plc.js';
+import { isAtprotoWebDid } from './methods/web.js';
+export const DID_RE = /^(?=.{7,2048}$)did:([a-z]+):([a-zA-Z0-9._:%\-]*[a-zA-Z0-9._\-])$/;
+/**
+ * checks if it's a DID identifier
+ */
+export const isDid = (input) => {
+    return input.length >= 7 && input.length <= 2048 && DID_RE.test(input);
+};
+/**
+ * checks if it's a DID identifier that is supported by atproto
+ */
+export const isAtprotoDid = (input) => {
+    return isPlcDid(input) || isAtprotoWebDid(input);
+};
+/**
+ * returns the DID's method
+ */
+export const extractDidMethod = (did) => {
+    const isep = did.indexOf(':', 4);
+    const method = did.slice(4, isep);
+    return method;
+};
+//# sourceMappingURL=did.js.map

package/dist/did.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did.js","sourceRoot":"","sources":["../lib/did.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,MAAM,CAAC,MAAM,MAAM,GAAG,kEAAkE,CAAC;AAEzF;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAgB,EAAE;IACpD,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAuB,EAAE;IAClE,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAmB,GAAW,EAAK,EAAE;IACpE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAClC,OAAO,MAAW,CAAC;AACpB,CAAC,CAAC"}

package/dist/handle.d.ts

@@ -0,0 +1,3 @@
+import type { Handle } from './types.js';
+export declare const HANDLE_RE: RegExp;
+export declare const isHandle: (str: string) => str is Handle;

package/dist/handle.js

@@ -0,0 +1,5 @@
+export const HANDLE_RE = /^(?=.{4,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+([a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])$/;
+export const isHandle = (str) => {
+    return str.length >= 3 && str.length <= 253 && HANDLE_RE.test(str);
+};
+//# sourceMappingURL=handle.js.map

package/dist/handle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle.js","sourceRoot":"","sources":["../lib/handle.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,SAAS,GACrB,4GAA4G,CAAC;AAE9G,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAiB,EAAE;IACtD,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpE,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * as defs from './typedefs.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './did.js';
+export * from './methods/plc.js';
+export * from './methods/web.js';
+export * from './handle.js';

package/dist/index.js

@@ -0,0 +1,8 @@
+export * as defs from './typedefs.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './did.js';
+export * from './methods/plc.js';
+export * from './methods/web.js';
+export * from './handle.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC"}

package/dist/methods/plc.d.ts

@@ -0,0 +1,6 @@
+import type { Did } from '../types.js';
+export declare const PLC_DID_RE: RegExp;
+/**
+ * checks if input is a did:plc identifier
+ */
+export declare const isPlcDid: (input: string) => input is Did<"plc">;

package/dist/methods/plc.js

@@ -0,0 +1,8 @@
+export const PLC_DID_RE = /^did:plc:([a-z2-7]{24})$/;
+/**
+ * checks if input is a did:plc identifier
+ */
+export const isPlcDid = (input) => {
+    return input.length === 32 && PLC_DID_RE.test(input);
+};
+//# sourceMappingURL=plc.js.map

package/dist/methods/plc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plc.js","sourceRoot":"","sources":["../../lib/methods/plc.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAErD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAuB,EAAE;IAC9D,OAAO,KAAK,CAAC,MAAM,KAAK,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACtD,CAAC,CAAC"}

package/dist/methods/web.d.ts

@@ -0,0 +1,21 @@
+import type { Did } from '../types.js';
+export declare const WEB_DID_RE: RegExp;
+export declare const ATPROTO_WEB_DID_RE: RegExp;
+/**
+ * checks if input is a did:web identifier, note that you should probably use
+ * `isAtprotoDidWeb` for atproto-related cases as atproto only supports a subset
+ * of the did:web specification (namely, no custom paths)
+ */
+export declare const isWebDid: (input: string) => input is Did<"web">;
+/**
+ * checks if input is a did:web identifier that is supported by atproto
+ */
+export declare const isAtprotoWebDid: (input: string) => input is Did<"web">;
+/**
+ * normalize a did:web identifier
+ */
+export declare const normalizeWebDid: (did: Did<"web">) => Did<"web">;
+/**
+ * converts did:web identifier into the DID document's URL
+ */
+export declare const webDidToDocumentUrl: (did: Did<"web">) => URL;

package/dist/methods/web.js

@@ -0,0 +1,46 @@
+export const WEB_DID_RE = /^did:web:([a-zA-Z0-9%\-]+(?:(?:\.[a-zA-Z0-9%\-]+)*(?:\.[a-zA-Z]{2,}))?)?((?::[a-zA-Z0-9\-%.]+)+)?$/;
+export const ATPROTO_WEB_DID_RE = /^did:web:([a-zA-Z0-9\-]+(?:\.[a-zA-Z0-9\-]+)*(?:\.[a-zA-Z]{2,})|localhost(?:%3[aA]\d+)?)$/;
+/**
+ * checks if input is a did:web identifier, note that you should probably use
+ * `isAtprotoDidWeb` for atproto-related cases as atproto only supports a subset
+ * of the did:web specification (namely, no custom paths)
+ */
+export const isWebDid = (input) => {
+    return input.length >= 9 && WEB_DID_RE.test(input);
+};
+/**
+ * checks if input is a did:web identifier that is supported by atproto
+ */
+export const isAtprotoWebDid = (input) => {
+    return input.length >= 12 && ATPROTO_WEB_DID_RE.test(input);
+};
+/**
+ * normalize a did:web identifier
+ */
+export const normalizeWebDid = (did) => {
+    const [host, ...paths] = did.slice(8).split(':').map(decodeURIComponent);
+    let normalized = `did:web:${encodeURIComponent(host.toLowerCase())}`;
+    if (paths.length > 0) {
+        normalized += `:${paths.join(':')}`;
+    }
+    return normalized;
+};
+/**
+ * converts did:web identifier into the DID document's URL
+ */
+export const webDidToDocumentUrl = (did) => {
+    const [host, ...paths] = did.slice(8).split(':').map(decodeURIComponent);
+    let pathname = '/' + paths.join('/');
+    if (pathname === '/') {
+        pathname = `/.well-known/did.json`;
+    }
+    else {
+        pathname += `/did.json`;
+    }
+    const url = new URL(`https://${host}${pathname}`);
+    if (url.hostname === 'localhost') {
+        url.protocol = 'http:';
+    }
+    return url;
+};
+//# sourceMappingURL=web.js.map

package/dist/methods/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../lib/methods/web.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,UAAU,GACtB,oGAAoG,CAAC;AAEtG,MAAM,CAAC,MAAM,kBAAkB,GAC9B,2FAA2F,CAAC;AAE7F;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAuB,EAAE;IAC9D,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAa,EAAuB,EAAE;IACrE,OAAO,KAAK,CAAC,MAAM,IAAI,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAe,EAAc,EAAE;IAC9D,MAAM,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAEzE,IAAI,UAAU,GAAG,WAAW,kBAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;IACrE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,UAAU,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,UAAwB,CAAC;AACjC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAe,EAAO,EAAE;IAC3D,MAAM,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAEzE,IAAI,QAAQ,GAAG,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrC,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACtB,QAAQ,GAAG,uBAAuB,CAAC;IACpC,CAAC;SAAM,CAAC;QACP,QAAQ,IAAI,WAAW,CAAC;IACzB,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,QAAQ,EAAE,CAAC,CAAC;IAClD,IAAI,GAAG,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QAClC,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC;IACxB,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC"}

package/dist/typedefs.d.ts

@@ -0,0 +1,11 @@
+import * as v from '@badrap/valita';
+import * as t from './types.js';
+export declare const FRAGMENT_RE: RegExp;
+export declare const MULTIBASE_RE: RegExp;
+export declare const rfc3968UriSchema: v.Type<string>;
+export declare const didRelativeUri: v.Type<string>;
+export declare const multibaseString: v.Type<string>;
+export declare const didString: v.Type<`did:${string}:${string}`>;
+export declare const verificationMethod: v.Type<t.VerificationMethod>;
+export declare const service: v.Type<t.Service>;
+export declare const didDocument: v.Type<t.DidDocument>;

package/dist/typedefs.js

@@ -0,0 +1,122 @@
+import * as v from '@badrap/valita';
+import { isDid } from './did.js';
+import * as t from './types.js';
+export const FRAGMENT_RE = /^#[^#]+$/;
+export const MULTIBASE_RE = /^z[a-km-zA-HJ-NP-Z1-9]+$/;
+export const rfc3968UriSchema = v.string().assert((input) => {
+    return URL.canParse(input);
+}, `must be a url`);
+export const didRelativeUri = v.string().assert((input) => {
+    return FRAGMENT_RE.test(input) || URL.canParse(input);
+}, `must be a did relative uri`);
+export const multibaseString = v.string().assert((input) => {
+    return MULTIBASE_RE.test(input);
+}, `must be a base58 multibase`);
+export const didString = v.string().assert(isDid, `must be a did`);
+export const verificationMethod = v
+    .object({
+    id: didRelativeUri,
+    type: v.string(),
+    controller: didString,
+    publicKeyMultibase: multibaseString.optional(),
+    publicKeyJwk: v.record().optional(),
+})
+    .chain((input) => {
+    switch (input.type) {
+        case 'Multikey': {
+            if (input.publicKeyMultibase === undefined) {
+                return v.err({ message: `missing multikey`, path: ['publicKeyMultibase'] });
+            }
+            break;
+        }
+        case 'EcdsaSecp256k1VerificationKey2019':
+        case 'EcdsaSecp256r1VerificationKey2019': {
+            if (input.publicKeyMultibase === undefined) {
+                return v.err({ message: `missing multibase key`, path: ['publicKeyMultibase'] });
+            }
+            break;
+        }
+    }
+    return v.ok(input);
+});
+export const service = v.object({
+    // should've only been RFC3968, but did:plc uses relative URIs.
+    id: didRelativeUri,
+    type: v.union(v.string(), v.array(v.string())),
+    serviceEndpoint: v.union(rfc3968UriSchema, v.record(rfc3968UriSchema), v.array(v.union(rfc3968UriSchema, v.record(rfc3968UriSchema)))),
+});
+export const didDocument = v
+    .object({
+    '@context': v.array(rfc3968UriSchema),
+    id: didString,
+    alsoKnownAs: v
+        .array(rfc3968UriSchema)
+        .chain((input) => {
+        for (let i = 0, len = input.length; i < len; i++) {
+            const aka = input[i];
+            for (let j = 0; j < i; j++) {
+                if (aka === input[j]) {
+                    return v.err({
+                        message: `duplicate "${aka}" aka entry`,
+                        path: [i],
+                    });
+                }
+            }
+        }
+        return v.ok(input);
+    })
+        .optional(),
+    verificationMethod: v
+        .array(verificationMethod)
+        .chain((input) => {
+        for (let i = 0, len = input.length; i < len; i++) {
+            const method = input[i];
+            const methodId = method.id;
+            for (let j = 0; j < i; j++) {
+                if (methodId === input[i].id) {
+                    return v.err({
+                        message: `duplicate "${methodId}" verification method`,
+                        path: [i, 'id'],
+                    });
+                }
+            }
+        }
+        return v.ok(input);
+    })
+        .optional(),
+    service: v.array(service).optional(),
+    controller: v.union(didString, v.array(didString)).optional(),
+    authentication: v.array(v.union(didRelativeUri, verificationMethod)).optional(),
+})
+    .chain((input) => {
+    const { id: did, service: services } = input;
+    let newServices;
+    if (services) {
+        for (let i = 0, len = services.length; i < len; i++) {
+            const service = services[i];
+            let id = service.id;
+            if (id[0] === '#') {
+                id = did + id;
+                if (newServices !== undefined) {
+                    newServices[i] = { ...service, id };
+                }
+                else {
+                    newServices = services.with(i, { ...service, id });
+                }
+            }
+            for (let j = 0; j < i; j++) {
+                if (id === (newServices ?? services)[j].id) {
+                    return v.err({
+                        message: `duplicate "${id}" service`,
+                        path: ['service', i, 'id'],
+                    });
+                }
+            }
+        }
+    }
+    if (newServices !== undefined) {
+        return v.ok({ ...input, service: newServices });
+    }
+    return v.ok(input);
+});
+//# sourceMappingURL=typedefs.js.map

package/dist/typedefs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedefs.js","sourceRoot":"","sources":["../lib/typedefs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,gBAAgB,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC;AAEhC,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AACtC,MAAM,CAAC,MAAM,YAAY,GAAG,0BAA0B,CAAC;AAEvD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAC3D,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,EAAE,eAAe,CAAC,CAAC;AAEpB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IACzD,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC,EAAE,4BAA4B,CAAC,CAAC;AAEjC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAC1D,OAAO,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC,EAAE,4BAA4B,CAAC,CAAC;AAEjC,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AAEnE,MAAM,CAAC,MAAM,kBAAkB,GAAiC,CAAC;KAC/D,MAAM,CAAC;IACP,EAAE,EAAE,cAAc;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,SAAS;IACrB,kBAAkB,EAAE,eAAe,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC;KACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,UAAU,CAAC,CAAC,CAAC;YACjB,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAC5C,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YAC7E,CAAC;YAED,MAAM;QACP,CAAC;QACD,KAAK,mCAAmC,CAAC;QACzC,KAAK,mCAAmC,CAAC,CAAC,CAAC;YAC1C,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAC5C,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YAClF,CAAC;YAED,MAAM;QACP,CAAC;IACF,CAAC;IAED,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,OAAO,GAAsB,CAAC,CAAC,MAAM,CAAC;IAClD,+DAA+D;IAC/D,EAAE,EAAE,cAAc;IAClB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,eAAe,EAAE,CAAC,CAAC,KAAK,CACvB,gBAAgB,EAChB,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAC1B,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAC9D;CACD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAA0B,CAAC;KACjD,MAAM,CAAC;IACP,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAErC,EAAE,EAAE,SAAS;IAEb,WAAW,EAAE,CAAC;SACZ,KAAK,CAAC,gBAAgB,CAAC;SACvB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5B,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBACtB,OAAO,CAAC,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,cAAc,GAAG,aAAa;wBACvC,IAAI,EAAE,CAAC,CAAC,CAAC;qBACT,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,CAAC;SACD,QAAQ,EAAE;IACZ,kBAAkB,EAAE,CAAC;SACnB,KAAK,CAAC,kBAAkB,CAAC;SACzB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC;YAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5B,IAAI,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;oBAC9B,OAAO,CAAC,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,cAAc,QAAQ,uBAAuB;wBACtD,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC;qBACf,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,CAAC;SACD,QAAQ,EAAE;IACZ,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;IAEpC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7D,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC/E,CAAC;KACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAE7C,IAAI,WAAoC,CAAC;IAEzC,IAAI,QAAQ,EAAE,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAE5B,IAAI,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;YACpB,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBACnB,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC;gBAEd,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC/B,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACP,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;gBACpD,CAAC;YACF,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5B,IAAI,EAAE,KAAK,CAAC,WAAW,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;oBAC5C,OAAO,CAAC,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,cAAc,EAAE,WAAW;wBACpC,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC;qBAC1B,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+export type Handle = `${string}.${string}`;
+export type Did<TMethod extends string = string> = `did:${TMethod}:${string}`;
+export type AtprotoDid = Did<'plc' | 'web'>;
+export interface VerificationMethod {
+    id: string;
+    type: string;
+    controller: Did;
+    publicKeyMultibase?: string;
+    publicKeyJwk?: Record<string, unknown>;
+}
+export interface Service {
+    id: string;
+    type: string | string[];
+    serviceEndpoint: string | Record<string, string> | (string | Record<string, string>)[];
+}
+export interface DidDocument {
+    '@context': string[];
+    id: Did;
+    controller?: Did | Did[];
+    alsoKnownAs?: string[];
+    verificationMethod?: VerificationMethod[];
+    authentication?: (string | VerificationMethod)[];
+    service?: Service[];
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -0,0 +1,16 @@
+import * as t from './types.js';
+export interface VerificationMaterial {
+    type: string;
+    publicKeyMultibase: string;
+}
+export declare const isAtprotoServiceEndpoint: (input: string) => boolean;
+export declare const getAtprotoVerificationMaterial: (doc: t.DidDocument) => VerificationMaterial | undefined;
+export declare const getAtprotoServiceEndpoint: (doc: t.DidDocument, predicate: {
+    id: `#${string}`;
+    type?: string;
+}) => string | undefined;
+export declare const getPdsEndpoint: (doc: t.DidDocument) => string | undefined;
+export declare const getLabelerEndpoint: (doc: t.DidDocument) => string | undefined;
+export declare const getBlueskyChatEndpoint: (doc: t.DidDocument) => string | undefined;
+export declare const getBlueskyFeedgenEndpoint: (doc: t.DidDocument) => string | undefined;
+export declare const getBlueskyNotificationEndpoint: (doc: t.DidDocument) => string | undefined;

package/dist/utils.js

@@ -0,0 +1,87 @@
+import * as t from './types.js';
+export const isAtprotoServiceEndpoint = (input) => {
+    const url = URL.parse(input);
+    return (url !== null &&
+        (url.protocol === 'https:' || url.protocol === 'http:') &&
+        url.pathname === '/' &&
+        url.search === '' &&
+        url.hash === '');
+};
+export const getAtprotoVerificationMaterial = (doc) => {
+    const verificationMethods = doc.verificationMethod;
+    if (!verificationMethods) {
+        return;
+    }
+    const expectedId = `${doc.id}#atproto`;
+    for (let idx = 0, len = verificationMethods.length; idx < len; idx++) {
+        const { id, type, publicKeyMultibase } = verificationMethods[idx];
+        if (id !== expectedId) {
+            continue;
+        }
+        if (publicKeyMultibase === undefined) {
+            continue;
+        }
+        return { type, publicKeyMultibase };
+    }
+};
+export const getAtprotoServiceEndpoint = (doc, predicate) => {
+    const services = doc.service;
+    if (!services) {
+        return;
+    }
+    const expectedId = doc.id + predicate.id;
+    const expectedType = predicate.type;
+    for (let idx = 0, len = services.length; idx < len; idx++) {
+        const { id, type, serviceEndpoint } = services[idx];
+        if (id !== expectedId) {
+            continue;
+        }
+        if (expectedType !== undefined) {
+            if (Array.isArray(type)) {
+                if (!type.includes(expectedType)) {
+                    continue;
+                }
+            }
+            else {
+                if (type !== expectedType) {
+                    continue;
+                }
+            }
+        }
+        if (typeof serviceEndpoint !== 'string' || !isAtprotoServiceEndpoint(serviceEndpoint)) {
+            continue;
+        }
+        return serviceEndpoint;
+    }
+};
+export const getPdsEndpoint = (doc) => {
+    return getAtprotoServiceEndpoint(doc, {
+        id: '#atproto_pds',
+        type: 'AtprotoPersonalDataServer',
+    });
+};
+export const getLabelerEndpoint = (doc) => {
+    return getAtprotoServiceEndpoint(doc, {
+        id: '#atproto_labeler',
+        type: 'AtprotoLabeler',
+    });
+};
+export const getBlueskyChatEndpoint = (doc) => {
+    return getAtprotoServiceEndpoint(doc, {
+        id: '#bsky_chat',
+        type: 'BskyChatService',
+    });
+};
+export const getBlueskyFeedgenEndpoint = (doc) => {
+    return getAtprotoServiceEndpoint(doc, {
+        id: '#bsky_fg',
+        type: 'BskyFeedGenerator',
+    });
+};
+export const getBlueskyNotificationEndpoint = (doc) => {
+    return getAtprotoServiceEndpoint(doc, {
+        id: '#bsky_notif',
+        type: 'BskyNotificationService',
+    });
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC;AAOhC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAa,EAAW,EAAE;IAClE,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE7B,OAAO,CACN,GAAG,KAAK,IAAI;QACZ,CAAC,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;QACvD,GAAG,CAAC,QAAQ,KAAK,GAAG;QACpB,GAAG,CAAC,MAAM,KAAK,EAAE;QACjB,GAAG,CAAC,IAAI,KAAK,EAAE,CACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAkB,EAAoC,EAAE;IACtG,MAAM,mBAAmB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1B,OAAO;IACR,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,GAAG,CAAC,EAAE,UAAU,CAAC;IAEvC,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,mBAAmB,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACtE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAElE,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;YACvB,SAAS;QACV,CAAC;QAED,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACtC,SAAS;QACV,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACrC,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACxC,GAAkB,EAClB,SAA8C,EACzB,EAAE;IACvB,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,OAAO;IACR,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC;IACzC,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC;IAEpC,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAC3D,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEpD,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;YACvB,SAAS;QACV,CAAC;QAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;oBAClC,SAAS;gBACV,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;oBAC3B,SAAS;gBACV,CAAC;YACF,CAAC;QACF,CAAC;QAED,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,CAAC,wBAAwB,CAAC,eAAe,CAAC,EAAE,CAAC;YACvF,SAAS;QACV,CAAC;QAED,OAAO,eAAe,CAAC;IACxB,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAkB,EAAsB,EAAE;IACxE,OAAO,yBAAyB,CAAC,GAAG,EAAE;QACrC,EAAE,EAAE,cAAc;QAClB,IAAI,EAAE,2BAA2B;KACjC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAkB,EAAsB,EAAE;IAC5E,OAAO,yBAAyB,CAAC,GAAG,EAAE;QACrC,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,gBAAgB;KACtB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAkB,EAAsB,EAAE;IAChF,OAAO,yBAAyB,CAAC,GAAG,EAAE;QACrC,EAAE,EAAE,YAAY;QAChB,IAAI,EAAE,iBAAiB;KACvB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,GAAkB,EAAsB,EAAE;IACnF,OAAO,yBAAyB,CAAC,GAAG,EAAE;QACrC,EAAE,EAAE,UAAU;QACd,IAAI,EAAE,mBAAmB;KACzB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAkB,EAAsB,EAAE;IACxF,OAAO,yBAAyB,CAAC,GAAG,EAAE;QACrC,EAAE,EAAE,aAAa;QACjB,IAAI,EAAE,yBAAyB;KAC/B,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/lib/did.ts

@@ -0,0 +1,29 @@
+import type { AtprotoDid, Did } from './types.js';
+
+import { isPlcDid } from './methods/plc.js';
+import { isAtprotoWebDid } from './methods/web.js';
+
+export const DID_RE = /^(?=.{7,2048}$)did:([a-z]+):([a-zA-Z0-9._:%\-]*[a-zA-Z0-9._\-])$/;
+
+/**
+ * checks if it's a DID identifier
+ */
+export const isDid = (input: string): input is Did => {
+	return input.length >= 7 && input.length <= 2048 && DID_RE.test(input);
+};
+
+/**
+ * checks if it's a DID identifier that is supported by atproto
+ */
+export const isAtprotoDid = (input: string): input is AtprotoDid => {
+	return isPlcDid(input) || isAtprotoWebDid(input);
+};
+
+/**
+ * returns the DID's method
+ */
+export const extractDidMethod = <M extends string>(did: Did<M>): M => {
+	const isep = did.indexOf(':', 4);
+	const method = did.slice(4, isep);
+	return method as M;
+};

package/lib/handle.ts

@@ -0,0 +1,8 @@
+import type { Handle } from './types.js';
+
+export const HANDLE_RE =
+	/^(?=.{4,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+([a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])$/;
+
+export const isHandle = (str: string): str is Handle => {
+	return str.length >= 3 && str.length <= 253 && HANDLE_RE.test(str);
+};

package/lib/index.ts

@@ -0,0 +1,10 @@
+export * as defs from './typedefs.js';
+export * from './types.js';
+
+export * from './utils.js';
+
+export * from './did.js';
+export * from './methods/plc.js';
+export * from './methods/web.js';
+
+export * from './handle.js';

package/lib/methods/plc.ts

@@ -0,0 +1,10 @@
+import type { Did } from '../types.js';
+
+export const PLC_DID_RE = /^did:plc:([a-z2-7]{24})$/;
+
+/**
+ * checks if input is a did:plc identifier
+ */
+export const isPlcDid = (input: string): input is Did<'plc'> => {
+	return input.length === 32 && PLC_DID_RE.test(input);
+};

package/lib/methods/web.ts

@@ -0,0 +1,58 @@
+import type { Did } from '../types.js';
+
+export const WEB_DID_RE =
+	/^did:web:([a-zA-Z0-9%\-]+(?:(?:\.[a-zA-Z0-9%\-]+)*(?:\.[a-zA-Z]{2,}))?)?((?::[a-zA-Z0-9\-%.]+)+)?$/;
+
+export const ATPROTO_WEB_DID_RE =
+	/^did:web:([a-zA-Z0-9\-]+(?:\.[a-zA-Z0-9\-]+)*(?:\.[a-zA-Z]{2,})|localhost(?:%3[aA]\d+)?)$/;
+
+/**
+ * checks if input is a did:web identifier, note that you should probably use
+ * `isAtprotoDidWeb` for atproto-related cases as atproto only supports a subset
+ * of the did:web specification (namely, no custom paths)
+ */
+export const isWebDid = (input: string): input is Did<'web'> => {
+	return input.length >= 9 && WEB_DID_RE.test(input);
+};
+
+/**
+ * checks if input is a did:web identifier that is supported by atproto
+ */
+export const isAtprotoWebDid = (input: string): input is Did<'web'> => {
+	return input.length >= 12 && ATPROTO_WEB_DID_RE.test(input);
+};
+
+/**
+ * normalize a did:web identifier
+ */
+export const normalizeWebDid = (did: Did<'web'>): Did<'web'> => {
+	const [host, ...paths] = did.slice(8).split(':').map(decodeURIComponent);
+
+	let normalized = `did:web:${encodeURIComponent(host.toLowerCase())}`;
+	if (paths.length > 0) {
+		normalized += `:${paths.join(':')}`;
+	}
+
+	return normalized as Did<'web'>;
+};
+
+/**
+ * converts did:web identifier into the DID document's URL
+ */
+export const webDidToDocumentUrl = (did: Did<'web'>): URL => {
+	const [host, ...paths] = did.slice(8).split(':').map(decodeURIComponent);
+
+	let pathname = '/' + paths.join('/');
+	if (pathname === '/') {
+		pathname = `/.well-known/did.json`;
+	} else {
+		pathname += `/did.json`;
+	}
+
+	const url = new URL(`https://${host}${pathname}`);
+	if (url.hostname === 'localhost') {
+		url.protocol = 'http:';
+	}
+
+	return url;
+};

package/lib/typedefs.ts

@@ -0,0 +1,150 @@
+import * as v from '@badrap/valita';
+
+import { isDid } from './did.js';
+import * as t from './types.js';
+
+export const FRAGMENT_RE = /^#[^#]+$/;
+export const MULTIBASE_RE = /^z[a-km-zA-HJ-NP-Z1-9]+$/;
+
+export const rfc3968UriSchema = v.string().assert((input) => {
+	return URL.canParse(input);
+}, `must be a url`);
+
+export const didRelativeUri = v.string().assert((input) => {
+	return FRAGMENT_RE.test(input) || URL.canParse(input);
+}, `must be a did relative uri`);
+
+export const multibaseString = v.string().assert((input) => {
+	return MULTIBASE_RE.test(input);
+}, `must be a base58 multibase`);
+
+export const didString = v.string().assert(isDid, `must be a did`);
+
+export const verificationMethod: v.Type<t.VerificationMethod> = v
+	.object({
+		id: didRelativeUri,
+		type: v.string(),
+		controller: didString,
+		publicKeyMultibase: multibaseString.optional(),
+		publicKeyJwk: v.record().optional(),
+	})
+	.chain((input) => {
+		switch (input.type) {
+			case 'Multikey': {
+				if (input.publicKeyMultibase === undefined) {
+					return v.err({ message: `missing multikey`, path: ['publicKeyMultibase'] });
+				}
+
+				break;
+			}
+			case 'EcdsaSecp256k1VerificationKey2019':
+			case 'EcdsaSecp256r1VerificationKey2019': {
+				if (input.publicKeyMultibase === undefined) {
+					return v.err({ message: `missing multibase key`, path: ['publicKeyMultibase'] });
+				}
+
+				break;
+			}
+		}
+
+		return v.ok(input);
+	});
+
+export const service: v.Type<t.Service> = v.object({
+	// should've only been RFC3968, but did:plc uses relative URIs.
+	id: didRelativeUri,
+	type: v.union(v.string(), v.array(v.string())),
+	serviceEndpoint: v.union(
+		rfc3968UriSchema,
+		v.record(rfc3968UriSchema),
+		v.array(v.union(rfc3968UriSchema, v.record(rfc3968UriSchema))),
+	),
+});
+
+export const didDocument: v.Type<t.DidDocument> = v
+	.object({
+		'@context': v.array(rfc3968UriSchema),
+
+		id: didString,
+
+		alsoKnownAs: v
+			.array(rfc3968UriSchema)
+			.chain((input) => {
+				for (let i = 0, len = input.length; i < len; i++) {
+					const aka = input[i];
+
+					for (let j = 0; j < i; j++) {
+						if (aka === input[j]) {
+							return v.err({
+								message: `duplicate "${aka}" aka entry`,
+								path: [i],
+							});
+						}
+					}
+				}
+
+				return v.ok(input);
+			})
+			.optional(),
+		verificationMethod: v
+			.array(verificationMethod)
+			.chain((input) => {
+				for (let i = 0, len = input.length; i < len; i++) {
+					const method = input[i];
+					const methodId = method.id;
+
+					for (let j = 0; j < i; j++) {
+						if (methodId === input[i].id) {
+							return v.err({
+								message: `duplicate "${methodId}" verification method`,
+								path: [i, 'id'],
+							});
+						}
+					}
+				}
+
+				return v.ok(input);
+			})
+			.optional(),
+		service: v.array(service).optional(),
+
+		controller: v.union(didString, v.array(didString)).optional(),
+		authentication: v.array(v.union(didRelativeUri, verificationMethod)).optional(),
+	})
+	.chain((input) => {
+		const { id: did, service: services } = input;
+
+		let newServices: t.Service[] | undefined;
+
+		if (services) {
+			for (let i = 0, len = services.length; i < len; i++) {
+				const service = services[i];
+
+				let id = service.id;
+				if (id[0] === '#') {
+					id = did + id;
+
+					if (newServices !== undefined) {
+						newServices[i] = { ...service, id };
+					} else {
+						newServices = services.with(i, { ...service, id });
+					}
+				}
+
+				for (let j = 0; j < i; j++) {
+					if (id === (newServices ?? services)[j].id) {
+						return v.err({
+							message: `duplicate "${id}" service`,
+							path: ['service', i, 'id'],
+						});
+					}
+				}
+			}
+		}
+
+		if (newServices !== undefined) {
+			return v.ok({ ...input, service: newServices });
+		}
+
+		return v.ok(input);
+	});

package/lib/types.ts

@@ -0,0 +1,29 @@
+export type Handle = `${string}.${string}`;
+
+export type Did<TMethod extends string = string> = `did:${TMethod}:${string}`;
+
+export type AtprotoDid = Did<'plc' | 'web'>;
+
+export interface VerificationMethod {
+	id: string;
+	type: string;
+	controller: Did;
+	publicKeyMultibase?: string;
+	publicKeyJwk?: Record<string, unknown>;
+}
+
+export interface Service {
+	id: string;
+	type: string | string[];
+	serviceEndpoint: string | Record<string, string> | (string | Record<string, string>)[];
+}
+
+export interface DidDocument {
+	'@context': string[];
+	id: Did;
+	controller?: Did | Did[];
+	alsoKnownAs?: string[];
+	verificationMethod?: VerificationMethod[];
+	authentication?: (string | VerificationMethod)[];
+	service?: Service[];
+}

package/lib/utils.ts

@@ -0,0 +1,115 @@
+import * as t from './types.js';
+
+export interface VerificationMaterial {
+	type: string;
+	publicKeyMultibase: string;
+}
+
+export const isAtprotoServiceEndpoint = (input: string): boolean => {
+	const url = URL.parse(input);
+
+	return (
+		url !== null &&
+		(url.protocol === 'https:' || url.protocol === 'http:') &&
+		url.pathname === '/' &&
+		url.search === '' &&
+		url.hash === ''
+	);
+};
+
+export const getAtprotoVerificationMaterial = (doc: t.DidDocument): VerificationMaterial | undefined => {
+	const verificationMethods = doc.verificationMethod;
+	if (!verificationMethods) {
+		return;
+	}
+
+	const expectedId = `${doc.id}#atproto`;
+
+	for (let idx = 0, len = verificationMethods.length; idx < len; idx++) {
+		const { id, type, publicKeyMultibase } = verificationMethods[idx];
+
+		if (id !== expectedId) {
+			continue;
+		}
+
+		if (publicKeyMultibase === undefined) {
+			continue;
+		}
+
+		return { type, publicKeyMultibase };
+	}
+};
+
+export const getAtprotoServiceEndpoint = (
+	doc: t.DidDocument,
+	predicate: { id: `#${string}`; type?: string },
+): string | undefined => {
+	const services = doc.service;
+	if (!services) {
+		return;
+	}
+
+	const expectedId = doc.id + predicate.id;
+	const expectedType = predicate.type;
+
+	for (let idx = 0, len = services.length; idx < len; idx++) {
+		const { id, type, serviceEndpoint } = services[idx];
+
+		if (id !== expectedId) {
+			continue;
+		}
+
+		if (expectedType !== undefined) {
+			if (Array.isArray(type)) {
+				if (!type.includes(expectedType)) {
+					continue;
+				}
+			} else {
+				if (type !== expectedType) {
+					continue;
+				}
+			}
+		}
+
+		if (typeof serviceEndpoint !== 'string' || !isAtprotoServiceEndpoint(serviceEndpoint)) {
+			continue;
+		}
+
+		return serviceEndpoint;
+	}
+};
+
+export const getPdsEndpoint = (doc: t.DidDocument): string | undefined => {
+	return getAtprotoServiceEndpoint(doc, {
+		id: '#atproto_pds',
+		type: 'AtprotoPersonalDataServer',
+	});
+};
+
+export const getLabelerEndpoint = (doc: t.DidDocument): string | undefined => {
+	return getAtprotoServiceEndpoint(doc, {
+		id: '#atproto_labeler',
+		type: 'AtprotoLabeler',
+	});
+};
+
+export const getBlueskyChatEndpoint = (doc: t.DidDocument): string | undefined => {
+	return getAtprotoServiceEndpoint(doc, {
+		id: '#bsky_chat',
+		type: 'BskyChatService',
+	});
+};
+
+export const getBlueskyFeedgenEndpoint = (doc: t.DidDocument): string | undefined => {
+	return getAtprotoServiceEndpoint(doc, {
+		id: '#bsky_fg',
+		type: 'BskyFeedGenerator',
+	});
+};
+
+export const getBlueskyNotificationEndpoint = (doc: t.DidDocument): string | undefined => {
+	return getAtprotoServiceEndpoint(doc, {
+		id: '#bsky_notif',
+		type: 'BskyNotificationService',
+	});
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "type": "module",
+  "name": "@atcute/identity",
+  "version": "0.1.0",
+  "description": "syntax, type definitions and schemas for atproto handles, DIDs and DID documents",
+  "keywords": [
+    "atproto",
+    "did"
+  ],
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/mary-ext/atcute",
+    "directory": "packages/identity/identity"
+  },
+  "files": [
+    "dist/",
+    "lib/",
+    "!lib/**/*.bench.ts",
+    "!lib/**/*.test.ts"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@types/bun": "^1.2.1"
+  },
+  "dependencies": {
+    "@badrap/valita": "^0.4.2"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "test": "bun test --coverage",
+    "prepublish": "rm -rf dist; pnpm run build"
+  }
+}