@atproto-labs/identity-resolver 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atproto-labs/identity-resolver
 
+## 0.3.0
+
+### Minor Changes
+
+- [#3982](https://github.com/bluesky-social/atproto/pull/3982) [`4c2d49917`](https://github.com/bluesky-social/atproto/commit/4c2d499178c61eb8a9d7f658e89fe68fa07f81e7) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Identity resolver's `resolve()` method returns value consistent with `com.atproto.identity.resolveIdentity`
+
+- [#3982](https://github.com/bluesky-social/atproto/pull/3982) [`4c2d49917`](https://github.com/bluesky-social/atproto/commit/4c2d499178c61eb8a9d7f658e89fe68fa07f81e7) Thanks [@matthieusieben](https://github.com/matthieusieben)! - `IdentityResolver` is now an interface. The `IdentityResolverProto` class is the default implementation for the `IdentityResolver` interface.
+
+### Patch Changes
+
+- [#3982](https://github.com/bluesky-social/atproto/pull/3982) [`4c2d49917`](https://github.com/bluesky-social/atproto/commit/4c2d499178c61eb8a9d7f658e89fe68fa07f81e7) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Export `HANDLE_INVALID` constant
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/atproto-identity-resolver.d.ts

@@ -0,0 +1,20 @@
+import { AtprotoDid, AtprotoIdentityDidMethods, DidDocument, DidResolver, ResolveDidOptions } from '@atproto-labs/did-resolver';
+import { HandleResolver, ResolveHandleOptions } from '@atproto-labs/handle-resolver';
+import { IdentityInfo, IdentityResolver, ResolveIdentityOptions } from './identity-resolver.js';
+/**
+ * Implementation of the official ATPROTO identity resolution strategy.
+ * This implementation relies on two primitives:
+ * - DID resolution (using the `DidResolver` interface)
+ * - Handle resolution (using the `HandleResolver` interface)
+ */
+export declare class AtprotoIdentityResolver implements IdentityResolver {
+    protected readonly didResolver: DidResolver<AtprotoIdentityDidMethods>;
+    protected readonly handleResolver: HandleResolver;
+    constructor(didResolver: DidResolver<AtprotoIdentityDidMethods>, handleResolver: HandleResolver);
+    resolve(input: string, options?: ResolveIdentityOptions): Promise<IdentityInfo>;
+    resolveFromDid(did: AtprotoDid, options?: ResolveDidOptions): Promise<IdentityInfo>;
+    resolveFromHandle(handle: string, options?: ResolveHandleOptions): Promise<IdentityInfo>;
+    getDocumentFromDid(did: AtprotoDid, options?: ResolveDidOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
+    getDocumentFromHandle(input: string, options?: ResolveHandleOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
+}
+//# sourceMappingURL=atproto-identity-resolver.d.ts.map

package/dist/atproto-identity-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"atproto-identity-resolver.d.ts","sourceRoot":"","sources":["../src/atproto-identity-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,WAAW,EACX,WAAW,EACX,iBAAiB,EAElB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,EACd,oBAAoB,EACrB,MAAM,+BAA+B,CAAA;AAGtC,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,wBAAwB,CAAA;AAO/B;;;;;GAKG;AACH,qBAAa,uBAAwB,YAAW,gBAAgB;IAE5D,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,yBAAyB,CAAC;IACtE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc;gBAD9B,WAAW,EAAE,WAAW,CAAC,yBAAyB,CAAC,EACnD,cAAc,EAAE,cAAc;IAGtC,OAAO,CAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,YAAY,CAAC;IAMX,cAAc,CACzB,GAAG,EAAE,UAAU,EACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,YAAY,CAAC;IAqBX,iBAAiB,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,YAAY,CAAC;IAYX,kBAAkB,CAC7B,GAAG,EAAE,UAAU,EACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAIrC,qBAAqB,CAChC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;CA8BnD"}

package/dist/atproto-identity-resolver.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AtprotoIdentityResolver = void 0;
+const did_resolver_1 = require("@atproto-labs/did-resolver");
+const constants_js_1 = require("./constants.js");
+const identity_resolver_error_js_1 = require("./identity-resolver-error.js");
+const util_js_1 = require("./util.js");
+// @TODO Move this to its own package as soon as we have a distinct
+// implementation based on XRPC calls to the
+// "com.atproto.identity.resolveIdentity" method.
+/**
+ * Implementation of the official ATPROTO identity resolution strategy.
+ * This implementation relies on two primitives:
+ * - DID resolution (using the `DidResolver` interface)
+ * - Handle resolution (using the `HandleResolver` interface)
+ */
+class AtprotoIdentityResolver {
+    constructor(didResolver, handleResolver) {
+        Object.defineProperty(this, "didResolver", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: didResolver
+        });
+        Object.defineProperty(this, "handleResolver", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: handleResolver
+        });
+    }
+    async resolve(input, options) {
+        return (0, did_resolver_1.isAtprotoDid)(input)
+            ? this.resolveFromDid(input, options)
+            : this.resolveFromHandle(input, options);
+    }
+    async resolveFromDid(did, options) {
+        const document = await this.getDocumentFromDid(did, options);
+        options?.signal?.throwIfAborted();
+        // We will only return the document's handle alias if it resolves to the
+        // same DID as the input.
+        const handle = (0, util_js_1.extractNormalizedHandle)(document);
+        const resolvedDid = handle
+            ? await this.handleResolver
+                .resolve(handle, options)
+                .catch(() => undefined) // Ignore errors (temporarily unavailable)
+            : undefined;
+        return {
+            did: document.id,
+            didDoc: document,
+            handle: handle && resolvedDid === did ? handle : constants_js_1.HANDLE_INVALID,
+        };
+    }
+    async resolveFromHandle(handle, options) {
+        const document = await this.getDocumentFromHandle(handle, options);
+        // @NOTE bi-directional resolution enforced in getDocumentFromHandle()
+        return {
+            did: document.id,
+            didDoc: document,
+            handle: (0, util_js_1.extractNormalizedHandle)(document) || constants_js_1.HANDLE_INVALID,
+        };
+    }
+    async getDocumentFromDid(did, options) {
+        return this.didResolver.resolve(did, options);
+    }
+    async getDocumentFromHandle(input, options) {
+        const handle = (0, util_js_1.asNormalizedHandle)(input);
+        if (!handle) {
+            throw new identity_resolver_error_js_1.IdentityResolverError(`Invalid handle "${input}" provided.`);
+        }
+        const did = await this.handleResolver.resolve(handle, options);
+        if (!did) {
+            throw new identity_resolver_error_js_1.IdentityResolverError(`Handle "${handle}" does not resolve to a DID`);
+        }
+        options?.signal?.throwIfAborted();
+        // Note: Not using "return this.resolveDid(did, options)" to make the extra
+        // check for the handle in the DID document:
+        const document = await this.didResolver.resolve(did, options);
+        // Enforce bi-directional resolution
+        if (handle !== (0, util_js_1.extractNormalizedHandle)(document)) {
+            throw new identity_resolver_error_js_1.IdentityResolverError(`Did document for "${did}" does not include the handle "${handle}"`);
+        }
+        return document;
+    }
+}
+exports.AtprotoIdentityResolver = AtprotoIdentityResolver;
+//# sourceMappingURL=atproto-identity-resolver.js.map

package/dist/atproto-identity-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"atproto-identity-resolver.js","sourceRoot":"","sources":["../src/atproto-identity-resolver.ts"],"names":[],"mappings":";;;AAAA,6DAOmC;AAKnC,iDAA+C;AAC/C,6EAAoE;AAMpE,uCAAuE;AAEvE,mEAAmE;AACnE,4CAA4C;AAC5C,iDAAiD;AAEjD;;;;;GAKG;AACH,MAAa,uBAAuB;IAClC,YACqB,WAAmD,EACnD,cAA8B;QADjD;;;;mBAAmB,WAAW;WAAwC;QACtE;;;;mBAAmB,cAAc;WAAgB;IAChD,CAAC;IAEG,KAAK,CAAC,OAAO,CAClB,KAAa,EACb,OAAgC;QAEhC,OAAO,IAAA,2BAAY,EAAC,KAAK,CAAC;YACxB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,GAAe,EACf,OAA2B;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE5D,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,wEAAwE;QACxE,yBAAyB;QACzB,MAAM,MAAM,GAAG,IAAA,iCAAuB,EAAC,QAAQ,CAAC,CAAA;QAChD,MAAM,WAAW,GAAG,MAAM;YACxB,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc;iBACtB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;iBACxB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,0CAA0C;YACtE,CAAC,CAAC,SAAS,CAAA;QAEb,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,MAAM,IAAI,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAc;SAChE,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,MAAc,EACd,OAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAElE,sEAAsE;QAEtE,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,IAAA,iCAAuB,EAAC,QAAQ,CAAC,IAAI,6BAAc;SAC5D,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,GAAe,EACf,OAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC/C,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,KAAa,EACb,OAA8B;QAE9B,MAAM,MAAM,GAAG,IAAA,4BAAkB,EAAC,KAAK,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,kDAAqB,CAAC,mBAAmB,KAAK,aAAa,CAAC,CAAA;QACxE,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE9D,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,kDAAqB,CAC7B,WAAW,MAAM,6BAA6B,CAC/C,CAAA;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,2EAA2E;QAC3E,4CAA4C;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE7D,oCAAoC;QACpC,IAAI,MAAM,KAAK,IAAA,iCAAuB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,kDAAqB,CAC7B,qBAAqB,GAAG,kCAAkC,MAAM,GAAG,CACpE,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AA9FD,0DA8FC"}

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const HANDLE_INVALID = "handle.invalid";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,mBAAmB,CAAA"}

package/dist/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDLE_INVALID = void 0;
+exports.HANDLE_INVALID = 'handle.invalid';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,gBAAgB,CAAA"}

package/dist/identity-resolver.d.ts

@@ -1,22 +1,20 @@
-import { AtprotoDid, AtprotoIdentityDidMethods, DidDocument, DidResolver, ResolveDidOptions } from '@atproto-labs/did-resolver';
-import { HandleResolver, ResolveHandleOptions } from '@atproto-labs/handle-resolver';
-export type ResolvedIdentity = {
-    document: DidDocument<AtprotoIdentityDidMethods>;
+import { AtprotoDid, AtprotoIdentityDidMethods, DidDocument } from '@atproto-labs/did-resolver';
+import { HANDLE_INVALID } from './constants';
+export type IdentityInfo = {
+    did: AtprotoDid;
+    didDoc: DidDocument<AtprotoIdentityDidMethods>;
     /**
-     * Will be defined if the document contains a handle alias that resolves
-     * to the document's DID.
+     * Will be 'handle.invalid' if the handle does not resolve to the
+     * same DID as the input, or if the handle is not present in the DID
+     * document.
      */
-    handle?: string;
+    handle: typeof HANDLE_INVALID | string;
 };
-export type ResolveIdentityOptions = ResolveDidOptions & ResolveHandleOptions;
-export declare class IdentityResolver {
-    readonly didResolver: DidResolver<AtprotoIdentityDidMethods>;
-    readonly handleResolver: HandleResolver;
-    constructor(didResolver: DidResolver<AtprotoIdentityDidMethods>, handleResolver: HandleResolver);
-    resolve(input: string, options?: ResolveIdentityOptions): Promise<ResolvedIdentity>;
-    resolveFromDid(did: AtprotoDid, options?: ResolveDidOptions): Promise<ResolvedIdentity>;
-    resolveFromHandle(handle: string, options?: ResolveHandleOptions): Promise<ResolvedIdentity>;
-    getDocumentFromDid(did: AtprotoDid, options?: ResolveDidOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
-    getDocumentFromHandle(input: string, options?: ResolveHandleOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
+export type ResolveIdentityOptions = {
+    signal?: AbortSignal;
+    noCache?: boolean;
+};
+export interface IdentityResolver {
+    resolve(identifier: string, options?: ResolveIdentityOptions): Promise<IdentityInfo>;
 }
 //# sourceMappingURL=identity-resolver.d.ts.map

package/dist/identity-resolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"identity-resolver.d.ts","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,WAAW,EACX,WAAW,EACX,iBAAiB,EAElB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,EACd,oBAAoB,EACrB,MAAM,+BAA+B,CAAA;AAItC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,WAAW,CAAC,yBAAyB,CAAC,CAAA;IAEhD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAE7E,qBAAa,gBAAgB;IAEzB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,yBAAyB,CAAC;IAC5D,QAAQ,CAAC,cAAc,EAAE,cAAc;gBAD9B,WAAW,EAAE,WAAW,CAAC,yBAAyB,CAAC,EACnD,cAAc,EAAE,cAAc;IAG5B,OAAO,CAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,gBAAgB,CAAC;IAMf,cAAc,CACzB,GAAG,EAAE,UAAU,EACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAoBf,iBAAiB,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAWf,kBAAkB,CAC7B,GAAG,EAAE,UAAU,EACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAIrC,qBAAqB,CAChC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;CA8BnD"}
+{"version":3,"file":"identity-resolver.d.ts","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,WAAW,EACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAI5C,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,UAAU,CAAA;IAEf,MAAM,EAAE,WAAW,CAAC,yBAAyB,CAAC,CAAA;IAE9C;;;;OAIG;IACH,MAAM,EAAE,OAAO,cAAc,GAAG,MAAM,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,YAAY,CAAC,CAAA;CACzB"}

package/dist/identity-resolver.js

@@ -1,75 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdentityResolver = void 0;
-const did_resolver_1 = require("@atproto-labs/did-resolver");
-const identity_resolver_error_1 = require("./identity-resolver-error");
-const util_1 = require("./util");
-class IdentityResolver {
-    constructor(didResolver, handleResolver) {
-        Object.defineProperty(this, "didResolver", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: didResolver
-        });
-        Object.defineProperty(this, "handleResolver", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: handleResolver
-        });
-    }
-    async resolve(input, options) {
-        return (0, did_resolver_1.isAtprotoDid)(input)
-            ? this.resolveFromDid(input, options)
-            : this.resolveFromHandle(input, options);
-    }
-    async resolveFromDid(did, options) {
-        const document = await this.getDocumentFromDid(did, options);
-        options?.signal?.throwIfAborted();
-        // We will only return the document's handle alias if it resolves to the
-        // same DID as the input.
-        const handle = (0, util_1.extractNormalizedHandle)(document);
-        const resolvedDid = handle
-            ? await this.handleResolver
-                .resolve(handle, options)
-                .catch(() => undefined) // Ignore errors (temporarily unavailable)
-            : undefined;
-        return {
-            document,
-            handle: resolvedDid === did ? handle : undefined,
-        };
-    }
-    async resolveFromHandle(handle, options) {
-        const document = await this.getDocumentFromHandle(handle, options);
-        // @NOTE bi-directional resolution enforced in getDocumentFromHandle()
-        return {
-            document,
-            handle: (0, util_1.extractNormalizedHandle)(document),
-        };
-    }
-    async getDocumentFromDid(did, options) {
-        return this.didResolver.resolve(did, options);
-    }
-    async getDocumentFromHandle(input, options) {
-        const handle = (0, util_1.asNormalizedHandle)(input);
-        if (!handle) {
-            throw new identity_resolver_error_1.IdentityResolverError(`Invalid handle "${input}" provided.`);
-        }
-        const did = await this.handleResolver.resolve(handle, options);
-        if (!did) {
-            throw new identity_resolver_error_1.IdentityResolverError(`Handle "${handle}" does not resolve to a DID`);
-        }
-        options?.signal?.throwIfAborted();
-        // Note: Not using "return this.resolveDid(did, options)" to make the extra
-        // check for the handle in the DID document:
-        const document = await this.didResolver.resolve(did, options);
-        // Enforce bi-directional resolution
-        if (handle !== (0, util_1.extractNormalizedHandle)(document)) {
-            throw new identity_resolver_error_1.IdentityResolverError(`Did document for "${did}" does not include the handle "${handle}"`);
-        }
-        return document;
-    }
-}
-exports.IdentityResolver = IdentityResolver;
 //# sourceMappingURL=identity-resolver.js.map

package/dist/identity-resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"identity-resolver.js","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":";;;AAAA,6DAOmC;AAKnC,uEAAiE;AACjE,iCAAoE;AAcpE,MAAa,gBAAgB;IAC3B,YACW,WAAmD,EACnD,cAA8B;QADvC;;;;mBAAS,WAAW;WAAwC;QAC5D;;;;mBAAS,cAAc;WAAgB;IACtC,CAAC;IAEG,KAAK,CAAC,OAAO,CAClB,KAAa,EACb,OAAgC;QAEhC,OAAO,IAAA,2BAAY,EAAC,KAAK,CAAC;YACxB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,GAAe,EACf,OAA2B;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE5D,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,wEAAwE;QACxE,yBAAyB;QACzB,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,QAAQ,CAAC,CAAA;QAChD,MAAM,WAAW,GAAG,MAAM;YACxB,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc;iBACtB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;iBACxB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,0CAA0C;YACtE,CAAC,CAAC,SAAS,CAAA;QAEb,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SACjD,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,MAAc,EACd,OAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAElE,sEAAsE;QAEtE,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,IAAA,8BAAuB,EAAC,QAAQ,CAAC;SAC1C,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,GAAe,EACf,OAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC/C,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,KAAa,EACb,OAA8B;QAE9B,MAAM,MAAM,GAAG,IAAA,yBAAkB,EAAC,KAAK,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,+CAAqB,CAAC,mBAAmB,KAAK,aAAa,CAAC,CAAA;QACxE,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE9D,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,+CAAqB,CAC7B,WAAW,MAAM,6BAA6B,CAC/C,CAAA;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,2EAA2E;QAC3E,4CAA4C;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE7D,oCAAoC;QACpC,IAAI,MAAM,KAAK,IAAA,8BAAuB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,+CAAqB,CAC7B,qBAAqB,GAAG,kCAAkC,MAAM,GAAG,CACpE,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AA5FD,4CA4FC"}
+{"version":3,"file":"identity-resolver.js","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export * from './atproto-identity-resolver.js';
+export * from './constants.js';
 export * from './identity-resolver-error.js';
 export * from './identity-resolver.js';
 export * from './util.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAA;AAC5C,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gBAAgB,CAAA;AAC9B,cAAc,8BAA8B,CAAA;AAC5C,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA"}

package/dist/index.js

@@ -14,6 +14,8 @@ 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("./atproto-identity-resolver.js"), exports);
+__exportStar(require("./constants.js"), exports);
 __exportStar(require("./identity-resolver-error.js"), exports);
 __exportStar(require("./identity-resolver.js"), exports);
 __exportStar(require("./util.js"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA4C;AAC5C,yDAAsC;AACtC,4CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iEAA8C;AAC9C,iDAA8B;AAC9B,+DAA4C;AAC5C,yDAAsC;AACtC,4CAAyB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto-labs/identity-resolver",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "description": "A library resolving ATPROTO identities",
   "keywords": [

package/src/atproto-identity-resolver.ts

@@ -0,0 +1,126 @@
+import {
+  AtprotoDid,
+  AtprotoIdentityDidMethods,
+  DidDocument,
+  DidResolver,
+  ResolveDidOptions,
+  isAtprotoDid,
+} from '@atproto-labs/did-resolver'
+import {
+  HandleResolver,
+  ResolveHandleOptions,
+} from '@atproto-labs/handle-resolver'
+import { HANDLE_INVALID } from './constants.js'
+import { IdentityResolverError } from './identity-resolver-error.js'
+import {
+  IdentityInfo,
+  IdentityResolver,
+  ResolveIdentityOptions,
+} from './identity-resolver.js'
+import { asNormalizedHandle, extractNormalizedHandle } from './util.js'
+
+// @TODO Move this to its own package as soon as we have a distinct
+// implementation based on XRPC calls to the
+// "com.atproto.identity.resolveIdentity" method.
+
+/**
+ * Implementation of the official ATPROTO identity resolution strategy.
+ * This implementation relies on two primitives:
+ * - DID resolution (using the `DidResolver` interface)
+ * - Handle resolution (using the `HandleResolver` interface)
+ */
+export class AtprotoIdentityResolver implements IdentityResolver {
+  constructor(
+    protected readonly didResolver: DidResolver<AtprotoIdentityDidMethods>,
+    protected readonly handleResolver: HandleResolver,
+  ) {}
+
+  public async resolve(
+    input: string,
+    options?: ResolveIdentityOptions,
+  ): Promise<IdentityInfo> {
+    return isAtprotoDid(input)
+      ? this.resolveFromDid(input, options)
+      : this.resolveFromHandle(input, options)
+  }
+
+  public async resolveFromDid(
+    did: AtprotoDid,
+    options?: ResolveDidOptions,
+  ): Promise<IdentityInfo> {
+    const document = await this.getDocumentFromDid(did, options)
+
+    options?.signal?.throwIfAborted()
+
+    // We will only return the document's handle alias if it resolves to the
+    // same DID as the input.
+    const handle = extractNormalizedHandle(document)
+    const resolvedDid = handle
+      ? await this.handleResolver
+          .resolve(handle, options)
+          .catch(() => undefined) // Ignore errors (temporarily unavailable)
+      : undefined
+
+    return {
+      did: document.id,
+      didDoc: document,
+      handle: handle && resolvedDid === did ? handle : HANDLE_INVALID,
+    }
+  }
+
+  public async resolveFromHandle(
+    handle: string,
+    options?: ResolveHandleOptions,
+  ): Promise<IdentityInfo> {
+    const document = await this.getDocumentFromHandle(handle, options)
+
+    // @NOTE bi-directional resolution enforced in getDocumentFromHandle()
+
+    return {
+      did: document.id,
+      didDoc: document,
+      handle: extractNormalizedHandle(document) || HANDLE_INVALID,
+    }
+  }
+
+  public async getDocumentFromDid(
+    did: AtprotoDid,
+    options?: ResolveDidOptions,
+  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
+    return this.didResolver.resolve(did, options)
+  }
+
+  public async getDocumentFromHandle(
+    input: string,
+    options?: ResolveHandleOptions,
+  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
+    const handle = asNormalizedHandle(input)
+    if (!handle) {
+      throw new IdentityResolverError(`Invalid handle "${input}" provided.`)
+    }
+
+    const did = await this.handleResolver.resolve(handle, options)
+
+    if (!did) {
+      throw new IdentityResolverError(
+        `Handle "${handle}" does not resolve to a DID`,
+      )
+    }
+
+    options?.signal?.throwIfAborted()
+
+    // Note: Not using "return this.resolveDid(did, options)" to make the extra
+    // check for the handle in the DID document:
+
+    const document = await this.didResolver.resolve(did, options)
+
+    // Enforce bi-directional resolution
+    if (handle !== extractNormalizedHandle(document)) {
+      throw new IdentityResolverError(
+        `Did document for "${did}" does not include the handle "${handle}"`,
+      )
+    }
+
+    return document
+  }
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const HANDLE_INVALID = 'handle.invalid'

package/src/identity-resolver.ts

@@ -2,119 +2,32 @@ import {
   AtprotoDid,
   AtprotoIdentityDidMethods,
   DidDocument,
-  DidResolver,
-  ResolveDidOptions,
-  isAtprotoDid,
 } from '@atproto-labs/did-resolver'
-import {
-  HandleResolver,
-  ResolveHandleOptions,
-} from '@atproto-labs/handle-resolver'
-import { IdentityResolverError } from './identity-resolver-error'
-import { asNormalizedHandle, extractNormalizedHandle } from './util'
+import { HANDLE_INVALID } from './constants'
+
+// Consistent with `com.atproto.identity.defs#identityInfo` returned by
+// `com.atproto.identity.resolveIdentity` endpoint.
+export type IdentityInfo = {
+  did: AtprotoDid
 
-export type ResolvedIdentity = {
-  document: DidDocument<AtprotoIdentityDidMethods>
+  didDoc: DidDocument<AtprotoIdentityDidMethods>
 
   /**
-   * Will be defined if the document contains a handle alias that resolves
-   * to the document's DID.
+   * Will be 'handle.invalid' if the handle does not resolve to the
+   * same DID as the input, or if the handle is not present in the DID
+   * document.
    */
-  handle?: string
+  handle: typeof HANDLE_INVALID | string
 }
 
-export type ResolveIdentityOptions = ResolveDidOptions & ResolveHandleOptions
-
-export class IdentityResolver {
-  constructor(
-    readonly didResolver: DidResolver<AtprotoIdentityDidMethods>,
-    readonly handleResolver: HandleResolver,
-  ) {}
+export type ResolveIdentityOptions = {
+  signal?: AbortSignal
+  noCache?: boolean
+}
 
-  public async resolve(
-    input: string,
+export interface IdentityResolver {
+  resolve(
+    identifier: string,
     options?: ResolveIdentityOptions,
-  ): Promise<ResolvedIdentity> {
-    return isAtprotoDid(input)
-      ? this.resolveFromDid(input, options)
-      : this.resolveFromHandle(input, options)
-  }
-
-  public async resolveFromDid(
-    did: AtprotoDid,
-    options?: ResolveDidOptions,
-  ): Promise<ResolvedIdentity> {
-    const document = await this.getDocumentFromDid(did, options)
-
-    options?.signal?.throwIfAborted()
-
-    // We will only return the document's handle alias if it resolves to the
-    // same DID as the input.
-    const handle = extractNormalizedHandle(document)
-    const resolvedDid = handle
-      ? await this.handleResolver
-          .resolve(handle, options)
-          .catch(() => undefined) // Ignore errors (temporarily unavailable)
-      : undefined
-
-    return {
-      document,
-      handle: resolvedDid === did ? handle : undefined,
-    }
-  }
-
-  public async resolveFromHandle(
-    handle: string,
-    options?: ResolveHandleOptions,
-  ): Promise<ResolvedIdentity> {
-    const document = await this.getDocumentFromHandle(handle, options)
-
-    // @NOTE bi-directional resolution enforced in getDocumentFromHandle()
-
-    return {
-      document,
-      handle: extractNormalizedHandle(document),
-    }
-  }
-
-  public async getDocumentFromDid(
-    did: AtprotoDid,
-    options?: ResolveDidOptions,
-  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
-    return this.didResolver.resolve(did, options)
-  }
-
-  public async getDocumentFromHandle(
-    input: string,
-    options?: ResolveHandleOptions,
-  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
-    const handle = asNormalizedHandle(input)
-    if (!handle) {
-      throw new IdentityResolverError(`Invalid handle "${input}" provided.`)
-    }
-
-    const did = await this.handleResolver.resolve(handle, options)
-
-    if (!did) {
-      throw new IdentityResolverError(
-        `Handle "${handle}" does not resolve to a DID`,
-      )
-    }
-
-    options?.signal?.throwIfAborted()
-
-    // Note: Not using "return this.resolveDid(did, options)" to make the extra
-    // check for the handle in the DID document:
-
-    const document = await this.didResolver.resolve(did, options)
-
-    // Enforce bi-directional resolution
-    if (handle !== extractNormalizedHandle(document)) {
-      throw new IdentityResolverError(
-        `Did document for "${did}" does not include the handle "${handle}"`,
-      )
-    }
-
-    return document
-  }
+  ): Promise<IdentityInfo>
 }

package/src/index.ts

@@ -1,3 +1,5 @@
+export * from './atproto-identity-resolver.js'
+export * from './constants.js'
 export * from './identity-resolver-error.js'
 export * from './identity-resolver.js'
 export * from './util.js'

package/tsconfig.build.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/identity-resolver-error.ts","./src/identity-resolver.ts","./src/index.ts","./src/util.ts"],"version":"5.8.2"}
+{"root":["./src/atproto-identity-resolver.ts","./src/constants.ts","./src/identity-resolver-error.ts","./src/identity-resolver.ts","./src/index.ts","./src/util.ts"],"version":"5.8.2"}