@atcute/identity-resolver-node 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,36 @@
+# @atcute/identity-resolver-node
+
+additional atproto identity resolvers for Node.js
+
+```ts
+// handle resolution
+const handleResolver = new CompositeHandleResolver({
+	strategy: 'race',
+	methods: {
+		dns: new NodeDnsHandleResolver(),
+		http: new WellKnownHandleResolver(),
+	},
+});
+
+try {
+	const handle = await didResolver.resolve('bsky.app');
+	//    ^? 'did:plc:z72i7hdynmk6r22z27h6tvur'
+} catch (err) {
+	if (err instanceof DidNotFoundError) {
+		// handle returned no did
+	}
+	if (err instanceof InvalidResolvedHandleError) {
+		// handle returned a did, but isn't a valid atproto did
+	}
+	if (err instanceof AmbiguousHandleError) {
+		// handle returned multiple did values
+	}
+	if (err instanceof FailedHandleResolutionError) {
+		// handle resolution had thrown something unexpected (fetch error)
+	}
+
+	if (err instanceof HandleResolutionError) {
+		// the errors above extend this class, so you can do a catch-all.
+	}
+}
+```

package/dist/did/methods/node.d.ts

@@ -0,0 +1,11 @@
+import { type AtprotoDid, type Handle } from '@atcute/identity';
+import { type HandleResolver, type ResolveHandleOptions } from '@atcute/identity-resolver';
+export interface NodeDnsHandleResolverOptions {
+    nameservers?: string[];
+}
+export declare class NodeDnsHandleResolver implements HandleResolver {
+    #private;
+    get nameservers(): string[] | undefined;
+    constructor({ nameservers }?: NodeDnsHandleResolverOptions);
+    resolve(handle: Handle, options?: ResolveHandleOptions): Promise<AtprotoDid>;
+}

package/dist/did/methods/node.js

@@ -0,0 +1,53 @@
+import dns from 'node:dns/promises';
+import { isAtprotoDid } from '@atcute/identity';
+import { AmbiguousHandleError, DidNotFoundError, FailedHandleResolutionError, InvalidResolvedHandleError, } from '@atcute/identity-resolver';
+const SUBDOMAIN = '_atproto';
+const PREFIX = 'did=';
+export class NodeDnsHandleResolver {
+    #resolver = null;
+    get nameservers() {
+        return this.#resolver?.getServers();
+    }
+    constructor({ nameservers } = {}) {
+        if (nameservers) {
+            this.#resolver = new dns.Resolver();
+            this.#resolver.setServers(nameservers);
+        }
+    }
+    async resolve(handle, options) {
+        let results;
+        try {
+            const signal = options?.signal;
+            const resolver = this.#resolver ?? dns;
+            results = await resolver.resolveTxt(`${SUBDOMAIN}.${handle}`);
+            signal?.throwIfAborted();
+        }
+        catch (cause) {
+            if (cause instanceof Error && 'code' in cause && cause.code === 'ENOTFOUND') {
+                throw new DidNotFoundError(handle);
+            }
+            throw new FailedHandleResolutionError(handle, { cause });
+        }
+        const records = results.map((record) => record.join('').replace(/^"|"$/g, '').replace(/\\"/g, '"'));
+        for (let i = 0, il = records.length; i < il; i++) {
+            const data = records[i];
+            if (!data.startsWith(PREFIX)) {
+                continue;
+            }
+            for (let j = i + 1; j < il; j++) {
+                const data = records[j];
+                if (data.startsWith(PREFIX)) {
+                    throw new AmbiguousHandleError(handle);
+                }
+            }
+            const did = data.slice(PREFIX.length);
+            if (!isAtprotoDid(did)) {
+                throw new InvalidResolvedHandleError(handle, did);
+            }
+            return did;
+        }
+        // theoretically this shouldn't happen, it should've returned ENOTFOUND
+        throw new DidNotFoundError(handle);
+    }
+}
+//# sourceMappingURL=node.js.map

package/dist/did/methods/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../../../lib/did/methods/node.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,mBAAmB,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAgC,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EACN,oBAAoB,EACpB,gBAAgB,EAChB,2BAA2B,EAC3B,0BAA0B,GAG1B,MAAM,2BAA2B,CAAC;AAEnC,MAAM,SAAS,GAAG,UAAU,CAAC;AAC7B,MAAM,MAAM,GAAG,MAAM,CAAC;AAMtB,MAAM,OAAO,qBAAqB;IACjC,SAAS,GAAwB,IAAI,CAAC;IAEtC,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC;IACrC,CAAC;IAED,YAAY,EAAE,WAAW,KAAmC,EAAE;QAC7D,IAAI,WAAW,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACpC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACxC,CAAC;IACF,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,OAA8B;QAC3D,IAAI,OAAmB,CAAC;QAExB,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;YAEvC,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC;YAC9D,MAAM,EAAE,cAAc,EAAE,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC7E,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;YAED,MAAM,IAAI,2BAA2B,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACpG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAExB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,SAAS;YACV,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;gBACjC,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBACxB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC7B,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;gBACxC,CAAC;YACF,CAAC;YAED,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACnD,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC;QAED,uEAAuE;QACvE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACD"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './did/methods/node.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './did/methods/node.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,cAAc,uBAAuB,CAAC"}

package/lib/did/methods/node.ts

@@ -0,0 +1,77 @@
+import dns from 'node:dns/promises';
+
+import { isAtprotoDid, type AtprotoDid, type Handle } from '@atcute/identity';
+import {
+	AmbiguousHandleError,
+	DidNotFoundError,
+	FailedHandleResolutionError,
+	InvalidResolvedHandleError,
+	type HandleResolver,
+	type ResolveHandleOptions,
+} from '@atcute/identity-resolver';
+
+const SUBDOMAIN = '_atproto';
+const PREFIX = 'did=';
+
+export interface NodeDnsHandleResolverOptions {
+	nameservers?: string[];
+}
+
+export class NodeDnsHandleResolver implements HandleResolver {
+	#resolver: dns.Resolver | null = null;
+
+	get nameservers(): string[] | undefined {
+		return this.#resolver?.getServers();
+	}
+
+	constructor({ nameservers }: NodeDnsHandleResolverOptions = {}) {
+		if (nameservers) {
+			this.#resolver = new dns.Resolver();
+			this.#resolver.setServers(nameservers);
+		}
+	}
+
+	async resolve(handle: Handle, options?: ResolveHandleOptions): Promise<AtprotoDid> {
+		let results: string[][];
+
+		try {
+			const signal = options?.signal;
+			const resolver = this.#resolver ?? dns;
+
+			results = await resolver.resolveTxt(`${SUBDOMAIN}.${handle}`);
+			signal?.throwIfAborted();
+		} catch (cause) {
+			if (cause instanceof Error && 'code' in cause && cause.code === 'ENOTFOUND') {
+				throw new DidNotFoundError(handle);
+			}
+
+			throw new FailedHandleResolutionError(handle, { cause });
+		}
+
+		const records = results.map((record) => record.join('').replace(/^"|"$/g, '').replace(/\\"/g, '"'));
+		for (let i = 0, il = records.length; i < il; i++) {
+			const data = records[i];
+
+			if (!data.startsWith(PREFIX)) {
+				continue;
+			}
+
+			for (let j = i + 1; j < il; j++) {
+				const data = records[j];
+				if (data.startsWith(PREFIX)) {
+					throw new AmbiguousHandleError(handle);
+				}
+			}
+
+			const did = data.slice(PREFIX.length);
+			if (!isAtprotoDid(did)) {
+				throw new InvalidResolvedHandleError(handle, did);
+			}
+
+			return did;
+		}
+
+		// theoretically this shouldn't happen, it should've returned ENOTFOUND
+		throw new DidNotFoundError(handle);
+	}
+}

package/lib/index.ts

@@ -0,0 +1 @@
+export * from './did/methods/node.js';

package/package.json

@@ -0,0 +1,39 @@
+{
+  "type": "module",
+  "name": "@atcute/identity-resolver-node",
+  "version": "0.1.0",
+  "description": "additional atproto identity resolvers for Node.js",
+  "keywords": [
+    "atproto",
+    "did"
+  ],
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/mary-ext/atcute",
+    "directory": "packages/identity/identity-resolver-node"
+  },
+  "files": [
+    "dist/",
+    "lib/",
+    "!lib/**/*.bench.ts",
+    "!lib/**/*.test.ts"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "sideEffects": false,
+  "peerDependencies": {
+    "@atcute/identity": "^0.1.0",
+    "@atcute/identity-resolver": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.1",
+    "@atcute/identity": "^0.1.0",
+    "@atcute/identity-resolver": "^0.1.0"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "test": "bun test --coverage",
+    "prepublish": "rm -rf dist; pnpm run build"
+  }
+}