@atproto-labs/identity-resolver 0.1.0 → 0.1.2-rc.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atproto-labs/identity-resolver
 
+## 0.1.1
+
+### Patch Changes
+
+- [#2633](https://github.com/bluesky-social/atproto/pull/2633) [`acc9093d2`](https://github.com/bluesky-social/atproto/commit/acc9093d2845eba02b68fb2f9db33e4f1b59bb10) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Use distinct type names to prevent conflicts
+
+- Updated dependencies [[`acc9093d2`](https://github.com/bluesky-social/atproto/commit/acc9093d2845eba02b68fb2f9db33e4f1b59bb10)]:
+  - @atproto-labs/handle-resolver@0.1.1
+  - @atproto-labs/did-resolver@0.1.1
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/identity-resolver.d.ts

@@ -1,14 +1,16 @@
-import { ResolveOptions as DidResolveOptions, DidResolver } from '@atproto-labs/did-resolver';
-import { ResolveOptions as HandleResolveOptions, HandleResolver, ResolvedHandle } from '@atproto-labs/handle-resolver';
+import { DidDocument, DidResolver, ResolveDidOptions } from '@atproto-labs/did-resolver';
+import { AtprotoIdentityDidMethods, HandleResolver, ResolvedHandle, ResolveHandleOptions } from '@atproto-labs/handle-resolver';
 export type ResolvedIdentity = {
     did: NonNullable<ResolvedHandle>;
     pds: URL;
 };
-export type ResolveOptions = DidResolveOptions & HandleResolveOptions;
+export type ResolveIdentityOptions = ResolveDidOptions & ResolveHandleOptions;
 export declare class IdentityResolver {
-    readonly didResolver: DidResolver<'plc' | 'web'>;
+    readonly didResolver: DidResolver<AtprotoIdentityDidMethods>;
     readonly handleResolver: HandleResolver;
-    constructor(didResolver: DidResolver<'plc' | 'web'>, handleResolver: HandleResolver);
-    resolve(input: string, options?: ResolveOptions): Promise<ResolvedIdentity>;
+    constructor(didResolver: DidResolver<AtprotoIdentityDidMethods>, handleResolver: HandleResolver);
+    resolve(input: string, options?: ResolveIdentityOptions): Promise<ResolvedIdentity>;
+    getDocumentFromDid(did: NonNullable<ResolvedHandle>, options?: ResolveDidOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
+    getDocumentFromHandle(input: string, options?: ResolveHandleOptions): Promise<DidDocument<AtprotoIdentityDidMethods>>;
 }
 //# 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,EAGL,cAAc,IAAI,iBAAiB,EACnC,WAAW,EAEZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,IAAI,oBAAoB,EACtC,cAAc,EACd,cAAc,EAEf,MAAM,+BAA+B,CAAA;AAGtC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,WAAW,CAAC,cAAc,CAAC,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;CACT,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAErE,qBAAa,gBAAgB;IAEzB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC;IAChD,QAAQ,CAAC,cAAc,EAAE,cAAc;gBAD9B,WAAW,EAAE,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC,EACvC,cAAc,EAAE,cAAc;IAG5B,OAAO,CAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;CA+B7B"}
+{"version":3,"file":"identity-resolver.d.ts","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EACX,WAAW,EAEX,iBAAiB,EAClB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,yBAAyB,EACzB,cAAc,EAEd,cAAc,EACd,oBAAoB,EACrB,MAAM,+BAA+B,CAAA;AAGtC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,WAAW,CAAC,cAAc,CAAC,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;CACT,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;IAsBf,kBAAkB,CAC7B,GAAG,EAAE,WAAW,CAAC,cAAc,CAAC,EAChC,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;CAyBnD"}

package/dist/identity-resolver.js

@@ -19,26 +19,44 @@ class IdentityResolver {
         });
     }
     async resolve(input, options) {
-        const did = (0, handle_resolver_1.isResolvedHandle)(input)
-            ? input // Already a did
-            : await this.handleResolver.resolve((0, syntax_1.normalizeAndEnsureValidHandle)(input), options);
-        options?.signal?.throwIfAborted();
+        const document = (0, handle_resolver_1.isResolvedHandle)(input)
+            ? await this.getDocumentFromDid(input, options)
+            : await this.getDocumentFromHandle(input, options);
+        const service = document.service?.find((isAtprotoPersonalDataServerService), document);
+        if (!service) {
+            throw new TypeError(`No valid "AtprotoPersonalDataServer" service found in "${document.id}" DID document`);
+        }
+        return {
+            did: document.id,
+            pds: new URL(service.serviceEndpoint),
+        };
+    }
+    async getDocumentFromDid(did, options) {
+        return this.didResolver.resolve(did, options);
+    }
+    async getDocumentFromHandle(input, options) {
+        const handle = (0, syntax_1.normalizeAndEnsureValidHandle)(input);
+        const did = await this.handleResolver.resolve(handle, options);
         if (!did) {
-            throw new TypeError(`Handle "${input}" does not resolve to a DID`);
+            throw new TypeError(`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);
-        const service = document.service?.find((isAtprotoPersonalDataServerService), document);
-        if (!service) {
-            throw new TypeError(`No valid "AtprotoPersonalDataServer" service found in "${did}" DID document`);
+        // Ensure that the handle is included in the document
+        if (!document.alsoKnownAs?.includes(`at://${handle}`)) {
+            throw new TypeError(`Did document for "${did}" does not include the handle "${handle}"`);
         }
-        const pds = new URL(service.serviceEndpoint);
-        return { did, pds };
+        return document;
     }
 }
 exports.IdentityResolver = IdentityResolver;
 function isAtprotoPersonalDataServerService(s) {
     return (typeof s.serviceEndpoint === 'string' &&
         s.type === 'AtprotoPersonalDataServer' &&
-        (s.id === '#atproto_pds' || s.id === `${this.id}#atproto_pds`));
+        (s.id.startsWith('#')
+            ? s.id === '#atproto_pds'
+            : s.id === `${this.id}#atproto_pds`));
 }
 //# 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":";;;AAOA,mEAKsC;AACtC,4CAA+D;AAS/D,MAAa,gBAAgB;IAC3B,YACW,WAAuC,EACvC,cAA8B;QADvC;;;;mBAAS,WAAW;WAA4B;QAChD;;;;mBAAS,cAAc;WAAgB;IACtC,CAAC;IAEG,KAAK,CAAC,OAAO,CAClB,KAAa,EACb,OAAwB;QAExB,MAAM,GAAG,GAAG,IAAA,kCAAgB,EAAC,KAAK,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,gBAAgB;YACxB,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAC/B,IAAA,sCAA6B,EAAC,KAAK,CAAC,EACpC,OAAO,CACR,CAAA;QAEL,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,SAAS,CAAC,WAAW,KAAK,6BAA6B,CAAC,CAAA;QACpE,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CACpC,CAAA,kCAAiD,CAAA,EACjD,QAAQ,CACT,CAAA;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,SAAS,CACjB,0DAA0D,GAAG,gBAAgB,CAC9E,CAAA;QACH,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QAE5C,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;IACrB,CAAC;CACF;AAxCD,4CAwCC;AAED,SAAS,kCAAkC,CAEzC,CAAa;IAMb,OAAO,CACL,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ;QACrC,CAAC,CAAC,IAAI,KAAK,2BAA2B;QACtC,CAAC,CAAC,CAAC,EAAE,KAAK,cAAc,IAAI,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,EAAE,cAAc,CAAC,CAC/D,CAAA;AACH,CAAC"}
+{"version":3,"file":"identity-resolver.js","sourceRoot":"","sources":["../src/identity-resolver.ts"],"names":[],"mappings":";;;AAOA,mEAMsC;AACtC,4CAA+D;AAS/D,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,MAAM,QAAQ,GAAG,IAAA,kCAAgB,EAAC,KAAK,CAAC;YACtC,CAAC,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC;YAC/C,CAAC,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAEpD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CACpC,CAAA,kCAA6D,CAAA,EAC7D,QAAQ,CACT,CAAA;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,SAAS,CACjB,0DAA0D,QAAQ,CAAC,EAAE,gBAAgB,CACtF,CAAA;QACH,CAAC;QAED,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,EAAE;YAChB,GAAG,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC;SACtC,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,GAAgC,EAChC,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,sCAA6B,EAAC,KAAK,CAAC,CAAA;QAEnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE9D,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,SAAS,CAAC,WAAW,MAAM,6BAA6B,CAAC,CAAA;QACrE,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,qDAAqD;QACrD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,MAAM,EAAE,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,SAAS,CACjB,qBAAqB,GAAG,kCAAkC,MAAM,GAAG,CACpE,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAlED,4CAkEC;AAED,SAAS,kCAAkC,CAEzC,CAAa;IAMb,OAAO,CACL,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ;QACrC,CAAC,CAAC,IAAI,KAAK,2BAA2B;QACtC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;YACnB,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,cAAc;YACzB,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,EAAE,cAAc,CAAC,CACvC,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto-labs/identity-resolver",
-  "version": "0.1.0",
+  "version": "0.1.2-rc.0",
   "license": "MIT",
   "description": "A library resolving ATPROTO identities",
   "keywords": [
@@ -25,8 +25,8 @@
     }
   },
   "dependencies": {
-    "@atproto-labs/did-resolver": "0.1.0",
-    "@atproto-labs/handle-resolver": "0.1.0",
+    "@atproto-labs/did-resolver": "0.1.2-rc.0",
+    "@atproto-labs/handle-resolver": "0.1.2-rc.0",
     "@atproto/syntax": "0.3.0"
   },
   "devDependencies": {

package/src/identity-resolver.ts

@@ -1,15 +1,16 @@
 import {
   Did,
   DidDocument,
-  ResolveOptions as DidResolveOptions,
   DidResolver,
   DidService,
+  ResolveDidOptions,
 } from '@atproto-labs/did-resolver'
 import {
-  ResolveOptions as HandleResolveOptions,
+  AtprotoIdentityDidMethods,
   HandleResolver,
-  ResolvedHandle,
   isResolvedHandle,
+  ResolvedHandle,
+  ResolveHandleOptions,
 } from '@atproto-labs/handle-resolver'
 import { normalizeAndEnsureValidHandle } from '@atproto/syntax'
 
@@ -18,47 +19,73 @@ export type ResolvedIdentity = {
   pds: URL
 }
 
-export type ResolveOptions = DidResolveOptions & HandleResolveOptions
+export type ResolveIdentityOptions = ResolveDidOptions & ResolveHandleOptions
 
 export class IdentityResolver {
   constructor(
-    readonly didResolver: DidResolver<'plc' | 'web'>,
+    readonly didResolver: DidResolver<AtprotoIdentityDidMethods>,
     readonly handleResolver: HandleResolver,
   ) {}
 
   public async resolve(
     input: string,
-    options?: ResolveOptions,
+    options?: ResolveIdentityOptions,
   ): Promise<ResolvedIdentity> {
-    const did = isResolvedHandle(input)
-      ? input // Already a did
-      : await this.handleResolver.resolve(
-          normalizeAndEnsureValidHandle(input),
-          options,
-        )
-
-    options?.signal?.throwIfAborted()
-
-    if (!did) {
-      throw new TypeError(`Handle "${input}" does not resolve to a DID`)
-    }
-
-    const document = await this.didResolver.resolve(did, options)
+    const document = isResolvedHandle(input)
+      ? await this.getDocumentFromDid(input, options)
+      : await this.getDocumentFromHandle(input, options)
 
     const service = document.service?.find(
-      isAtprotoPersonalDataServerService<'plc' | 'web'>,
+      isAtprotoPersonalDataServerService<AtprotoIdentityDidMethods>,
       document,
     )
 
     if (!service) {
       throw new TypeError(
-        `No valid "AtprotoPersonalDataServer" service found in "${did}" DID document`,
+        `No valid "AtprotoPersonalDataServer" service found in "${document.id}" DID document`,
       )
     }
 
-    const pds = new URL(service.serviceEndpoint)
+    return {
+      did: document.id,
+      pds: new URL(service.serviceEndpoint),
+    }
+  }
+
+  public async getDocumentFromDid(
+    did: NonNullable<ResolvedHandle>,
+    options?: ResolveDidOptions,
+  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
+    return this.didResolver.resolve(did, options)
+  }
+
+  public async getDocumentFromHandle(
+    input: string,
+    options?: ResolveHandleOptions,
+  ): Promise<DidDocument<AtprotoIdentityDidMethods>> {
+    const handle = normalizeAndEnsureValidHandle(input)
+
+    const did = await this.handleResolver.resolve(handle, options)
+
+    if (!did) {
+      throw new TypeError(`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)
+
+    // Ensure that the handle is included in the document
+    if (!document.alsoKnownAs?.includes(`at://${handle}`)) {
+      throw new TypeError(
+        `Did document for "${did}" does not include the handle "${handle}"`,
+      )
+    }
 
-    return { did, pds }
+    return document
   }
 }
 
@@ -73,6 +100,8 @@ function isAtprotoPersonalDataServerService<M extends string>(
   return (
     typeof s.serviceEndpoint === 'string' &&
     s.type === 'AtprotoPersonalDataServer' &&
-    (s.id === '#atproto_pds' || s.id === `${this.id}#atproto_pds`)
+    (s.id.startsWith('#')
+      ? s.id === '#atproto_pds'
+      : s.id === `${this.id}#atproto_pds`)
   )
 }