@atproto/lexicon-resolver 0.1.0

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./record.js"), exports);
+__exportStar(require("./lexicon.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,+CAA4B"}

package/dist/lexicon.d.ts

@@ -0,0 +1,43 @@
+import { CID } from 'multiformats/cid';
+import { LexiconDoc } from '@atproto/lexicon';
+import { Commit } from '@atproto/repo';
+import { AtUri, NSID } from '@atproto/syntax';
+import { BuildRecordResolverOptions, ResolveRecordOptions } from './record.js';
+export declare const LEXICON_SCHEMA_NSID = "com.atproto.lexicon.schema";
+/**
+ * Resolve Lexicon from an NSID
+ */
+export type LexiconResolver = (nsid: NSID | string) => Promise<LexiconResolution>;
+/**
+ * Resolve Lexicon from an NSID using Lexicon DID authority and record resolution
+ */
+export type AtprotoLexiconResolver = (nsid: NSID | string, options?: ResolveLexiconOptions) => Promise<LexiconResolution>;
+export type BuildLexiconResolverOptions = BuildRecordResolverOptions;
+export type ResolveLexiconOptions = ResolveRecordOptions & {
+    didAuthority?: string;
+};
+export type LexiconResolution = {
+    commit: Commit;
+    uri: AtUri;
+    cid: CID;
+    nsid: NSID;
+    lexicon: LexiconDoc & LexiconSchemaRecord;
+};
+/**
+ * Build a Lexicon resolver function.
+ */
+export declare function buildLexiconResolver(options?: BuildLexiconResolverOptions): AtprotoLexiconResolver;
+export declare const resolveLexicon: AtprotoLexiconResolver;
+/**
+ * Resolve the DID authority for a Lexicon from the network using DNS, based on its NSID.
+ * @param nsidStr NSID or string representing one for which to lookup its Lexicon DID authority.
+ */
+export declare function resolveLexiconDidAuthority(nsidStr: NSID | string): Promise<string | undefined>;
+export declare class LexiconResolutionError extends Error {
+    constructor(message?: string, options?: ErrorOptions);
+}
+type LexiconSchemaRecord = {
+    $type: typeof LEXICON_SCHEMA_NSID;
+};
+export {};
+//# sourceMappingURL=lexicon.d.ts.map

package/dist/lexicon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicon.d.ts","sourceRoot":"","sources":["../src/lexicon.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,UAAU,EAAmB,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAkB,MAAM,iBAAiB,CAAA;AAC7D,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EAErB,MAAM,aAAa,CAAA;AAKpB,eAAO,MAAM,mBAAmB,+BAA+B,CAAA;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE,IAAI,GAAG,MAAM,KAChB,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE/B;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,IAAI,EAAE,IAAI,GAAG,MAAM,EACnB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE/B,MAAM,MAAM,2BAA2B,GAAG,0BAA0B,CAAA;AAEpE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG;IACzD,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,KAAK,CAAA;IACV,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,UAAU,GAAG,mBAAmB,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,2BAAgC,GACxC,sBAAsB,CAoCxB;AAED,eAAO,MAAM,cAAc,wBAAyB,CAAA;AAEpD;;;GAGG;AACH,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,IAAI,GAAG,MAAM,GACrB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAK7B;AAED,qBAAa,sBAAuB,SAAQ,KAAK;gBACnC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIrD;AAmCD,KAAK,mBAAmB,GAAG;IAAE,KAAK,EAAE,OAAO,mBAAmB,CAAA;CAAE,CAAA"}

package/dist/lexicon.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LexiconResolutionError = exports.resolveLexicon = exports.LEXICON_SCHEMA_NSID = void 0;
+exports.buildLexiconResolver = buildLexiconResolver;
+exports.resolveLexiconDidAuthority = resolveLexiconDidAuthority;
+const promises_1 = __importDefault(require("node:dns/promises"));
+const lexicon_1 = require("@atproto/lexicon");
+const syntax_1 = require("@atproto/syntax");
+const record_js_1 = require("./record.js");
+const util_js_1 = require("./util.js");
+const DNS_SUBDOMAIN = '_lexicon';
+const DNS_PREFIX = 'did=';
+exports.LEXICON_SCHEMA_NSID = 'com.atproto.lexicon.schema';
+/**
+ * Build a Lexicon resolver function.
+ */
+function buildLexiconResolver(options = {}) {
+    const resolveRecord = (0, record_js_1.buildRecordResolver)(options);
+    return async function (nsidStr, opts = {}) {
+        const nsid = typeof nsidStr === 'string' ? syntax_1.NSID.parse(nsidStr) : nsidStr;
+        const didAuthority = await getDidAuthority(nsid, opts);
+        const verified = await resolveRecord(syntax_1.AtUri.make(didAuthority, exports.LEXICON_SCHEMA_NSID, nsid.toString()), { forceRefresh: opts.forceRefresh }).catch((err) => {
+            throw new LexiconResolutionError('Could not resolve Lexicon schema record', { cause: err });
+        });
+        let lexicon;
+        try {
+            lexicon = (0, lexicon_1.parseLexiconDoc)(verified.record);
+        }
+        catch (err) {
+            throw new LexiconResolutionError('Invalid Lexicon document', {
+                cause: err,
+            });
+        }
+        if (!isLexiconSchemaRecord(lexicon)) {
+            throw new LexiconResolutionError('Invalid Lexicon schema record');
+        }
+        if (lexicon.id !== nsid.toString()) {
+            throw new LexiconResolutionError(`Lexicon schema record id does not match NSID: ${lexicon.id}`);
+        }
+        const { uri, cid, commit } = verified;
+        return { commit, uri, cid, nsid, lexicon };
+    };
+}
+exports.resolveLexicon = buildLexiconResolver();
+/**
+ * Resolve the DID authority for a Lexicon from the network using DNS, based on its NSID.
+ * @param nsidStr NSID or string representing one for which to lookup its Lexicon DID authority.
+ */
+async function resolveLexiconDidAuthority(nsidStr) {
+    const nsid = typeof nsidStr === 'string' ? syntax_1.NSID.parse(nsidStr) : nsidStr;
+    const did = await resolveDns(nsid.authority);
+    if (did == null || !(0, util_js_1.isValidDid)(did))
+        return;
+    return did;
+}
+class LexiconResolutionError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = 'LexiconResolutionError';
+    }
+}
+exports.LexiconResolutionError = LexiconResolutionError;
+async function getDidAuthority(nsid, options) {
+    if (options.didAuthority) {
+        (0, syntax_1.ensureValidDid)(options.didAuthority);
+        return options.didAuthority;
+    }
+    const did = await resolveLexiconDidAuthority(nsid);
+    if (!did) {
+        throw new LexiconResolutionError(`Could not resolve a DID authority for NSID: ${nsid}`);
+    }
+    return did;
+}
+async function resolveDns(authority) {
+    let chunkedResults;
+    try {
+        chunkedResults = await promises_1.default.resolveTxt(`${DNS_SUBDOMAIN}.${authority}`);
+    }
+    catch (err) {
+        return undefined;
+    }
+    return parseDnsResult(chunkedResults);
+}
+function parseDnsResult(chunkedResults) {
+    const results = chunkedResults.map((chunks) => chunks.join(''));
+    const found = results.filter((i) => i.startsWith(DNS_PREFIX));
+    if (found.length !== 1) {
+        return undefined;
+    }
+    return found[0].slice(DNS_PREFIX.length);
+}
+function isLexiconSchemaRecord(v) {
+    return v?.['$type'] === exports.LEXICON_SCHEMA_NSID;
+}
+//# sourceMappingURL=lexicon.js.map

package/dist/lexicon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicon.js","sourceRoot":"","sources":["../src/lexicon.ts"],"names":[],"mappings":";;;;;;AAgDA,oDAsCC;AAQD,gEAOC;AArGD,iEAAmC;AAEnC,8CAA8D;AAE9D,4CAA6D;AAC7D,2CAIoB;AACpB,uCAAsC;AAEtC,MAAM,aAAa,GAAG,UAAU,CAAA;AAChC,MAAM,UAAU,GAAG,MAAM,CAAA;AACZ,QAAA,mBAAmB,GAAG,4BAA4B,CAAA;AA+B/D;;GAEG;AACH,SAAgB,oBAAoB,CAClC,UAAuC,EAAE;IAEzC,MAAM,aAAa,GAAG,IAAA,+BAAmB,EAAC,OAAO,CAAC,CAAA;IAClD,OAAO,KAAK,WACV,OAAsB,EACtB,OAA8B,EAAE;QAEhC,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;QACxE,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACtD,MAAM,QAAQ,GAAG,MAAM,aAAa,CAClC,cAAK,CAAC,IAAI,CAAC,YAAY,EAAE,2BAAmB,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,EAC9D,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CACpC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACd,MAAM,IAAI,sBAAsB,CAC9B,yCAAyC,EACzC,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAA;QACH,CAAC,CAAC,CAAA;QACF,IAAI,OAAmB,CAAA;QACvB,IAAI,CAAC;YACH,OAAO,GAAG,IAAA,yBAAe,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC5C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,sBAAsB,CAAC,0BAA0B,EAAE;gBAC3D,KAAK,EAAE,GAAG;aACX,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,sBAAsB,CAAC,+BAA+B,CAAC,CAAA;QACnE,CAAC;QACD,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,sBAAsB,CAC9B,iDAAiD,OAAO,CAAC,EAAE,EAAE,CAC9D,CAAA;QACH,CAAC;QACD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAA;QACrC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;IAC5C,CAA2B,CAAA;AAC7B,CAAC;AAEY,QAAA,cAAc,GAAG,oBAAoB,EAAE,CAAA;AAEpD;;;GAGG;AACI,KAAK,UAAU,0BAA0B,CAC9C,OAAsB;IAEtB,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IACxE,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC5C,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,IAAA,oBAAU,EAAC,GAAG,CAAC;QAAE,OAAM;IAC3C,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAC/C,YAAY,OAAgB,EAAE,OAAsB;QAClD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAA;IACtC,CAAC;CACF;AALD,wDAKC;AAED,KAAK,UAAU,eAAe,CAAC,IAAU,EAAE,OAA8B;IACvE,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,IAAA,uBAAc,EAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACpC,OAAO,OAAO,CAAC,YAAY,CAAA;IAC7B,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,0BAA0B,CAAC,IAAI,CAAC,CAAA;IAClD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,sBAAsB,CAC9B,+CAA+C,IAAI,EAAE,CACtD,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,SAAiB;IACzC,IAAI,cAA0B,CAAA;IAC9B,IAAI,CAAC;QACH,cAAc,GAAG,MAAM,kBAAG,CAAC,UAAU,CAAC,GAAG,aAAa,IAAI,SAAS,EAAE,CAAC,CAAA;IACxE,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,cAAc,CAAC,cAAc,CAAC,CAAA;AACvC,CAAC;AAED,SAAS,cAAc,CAAC,cAA0B;IAChD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IAC/D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IAC7D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAGD,SAAS,qBAAqB,CAAC,CAAU;IACvC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,2BAAmB,CAAA;AAC7C,CAAC"}

package/dist/record.d.ts

@@ -0,0 +1,37 @@
+import { CID } from 'multiformats/cid';
+import { IdResolver } from '@atproto/identity';
+import { RepoRecord } from '@atproto/lexicon';
+import { Commit } from '@atproto/repo';
+import { AtUri } from '@atproto/syntax';
+import { BuildFetchHandlerOptions, FetchHandler } from '@atproto/xrpc';
+/**
+ * Resolve a record from the network.
+ */
+export type RecordResolver = (uriStr: AtUri | string) => Promise<RecordResolution>;
+/**
+ * Resolve a record from the network, verifying its authenticity.
+ */
+export type AtprotoRecordResolver = (uriStr: AtUri | string, options?: ResolveRecordOptions) => Promise<RecordResolution>;
+export type BuildRecordResolverOptions = {
+    idResolver?: IdResolver;
+    rpc?: Partial<BuildFetchHandlerOptions> | FetchHandler;
+};
+export type ResolveRecordOptions = {
+    forceRefresh?: boolean;
+};
+export type RecordResolution = {
+    commit: Commit;
+    uri: AtUri;
+    cid: CID;
+    record: RepoRecord;
+};
+/**
+ * Build a record resolver function.
+ */
+export declare function buildRecordResolver(options?: BuildRecordResolverOptions): AtprotoRecordResolver;
+export declare const resolveRecord: AtprotoRecordResolver;
+export declare const safeFetch: (input: string | URL | Request, init?: RequestInit | undefined) => Promise<Response>;
+export declare class RecordResolutionError extends Error {
+    constructor(message?: string, options?: ErrorOptions);
+}
+//# sourceMappingURL=record.d.ts.map

package/dist/record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EACL,MAAM,EAMP,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,KAAK,EAAkB,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAKtE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAC3B,MAAM,EAAE,KAAK,GAAG,MAAM,KACnB,OAAO,CAAC,gBAAgB,CAAC,CAAA;AAE9B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,MAAM,EAAE,KAAK,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,oBAAoB,KAC3B,OAAO,CAAC,gBAAgB,CAAC,CAAA;AAE9B,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,GAAG,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,YAAY,CAAA;CACvD,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,KAAK,CAAA;IACV,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,0BAA+B,GACvC,qBAAqB,CAyCvB;AAED,eAAO,MAAM,aAAa,uBAAwB,CAAA;AAElD,eAAO,MAAM,SAAS,sFAIpB,CAAA;AAEF,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIrD"}

package/dist/record.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordResolutionError = exports.safeFetch = exports.resolveRecord = void 0;
+exports.buildRecordResolver = buildRecordResolver;
+const identity_1 = require("@atproto/identity");
+const repo_1 = require("@atproto/repo");
+const syntax_1 = require("@atproto/syntax");
+const fetch_node_1 = require("@atproto-labs/fetch-node");
+const index_js_1 = require("./client/index.js");
+const util_js_1 = require("./util.js");
+/**
+ * Build a record resolver function.
+ */
+function buildRecordResolver(options = {}) {
+    const { idResolver = new identity_1.IdResolver(), rpc } = options;
+    return async function resolveRecord(uriStr, opts = {}) {
+        const uri = typeof uriStr === 'string' ? new syntax_1.AtUri(uriStr) : uriStr;
+        const did = await getDidFromUri(uri, { idResolver });
+        const identity = await idResolver.did
+            .resolveAtprotoData(did, opts.forceRefresh)
+            .catch((err) => {
+            throw new RecordResolutionError('Could not resolve DID identity data', {
+                cause: err,
+            });
+        });
+        const client = new index_js_1.AtpBaseClient(typeof rpc === 'function'
+            ? rpc
+            : {
+                ...rpc,
+                service: rpc?.service ?? identity.pds,
+                fetch: rpc?.fetch ?? exports.safeFetch,
+            });
+        const { data: proofBytes } = await client.com.atproto.sync
+            .getRecord({
+            did,
+            collection: uri.collection,
+            rkey: uri.rkey,
+        })
+            .catch((err) => {
+            throw new RecordResolutionError('Could not fetch record proof', {
+                cause: err,
+            });
+        });
+        const verified = await verifyRecordProof(proofBytes, {
+            uri: syntax_1.AtUri.make(did, uri.collection, uri.rkey),
+            signingKey: identity.signingKey,
+        });
+        return verified;
+    };
+}
+exports.resolveRecord = buildRecordResolver();
+exports.safeFetch = (0, fetch_node_1.safeFetchWrap)({
+    allowIpHost: false,
+    allowImplicitRedirect: true,
+    responseMaxSize: (1024 + 10) * 1024, // 1MB + 10kB, just a bit larger than max record size
+});
+class RecordResolutionError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = 'RecordResolutionError';
+    }
+}
+exports.RecordResolutionError = RecordResolutionError;
+async function getDidFromUri(uri, { idResolver }) {
+    if (uri.host.startsWith('did:')) {
+        (0, syntax_1.ensureValidDid)(uri.host);
+        return uri.host;
+    }
+    const resolved = await idResolver.handle.resolve(uri.host);
+    if (!resolved || !(0, util_js_1.isValidDid)(resolved)) {
+        throw new RecordResolutionError('Could not resolve handle found in AT-URI');
+    }
+    return resolved;
+}
+async function verifyRecordProof(proofBytes, { uri, signingKey }) {
+    const { root, blocks } = await (0, repo_1.readCarWithRoot)(proofBytes).catch((err) => {
+        throw new RecordResolutionError('Malformed record proof', { cause: err });
+    });
+    const blockstore = new repo_1.MemoryBlockstore(blocks);
+    const commit = await blockstore.readObj(root, repo_1.def.commit).catch((err) => {
+        throw new RecordResolutionError('Invalid commit in record proof', {
+            cause: err,
+        });
+    });
+    if (commit.did !== uri.host) {
+        throw new RecordResolutionError(`Invalid repo did: ${commit.did}`);
+    }
+    const validSig = await (0, repo_1.verifyCommitSig)(commit, signingKey);
+    if (!validSig) {
+        throw new RecordResolutionError(`Invalid signature on commit: ${root.toString()}`);
+    }
+    const mst = repo_1.MST.load(blockstore, commit.data);
+    const cid = await mst.get(`${uri.collection}/${uri.rkey}`);
+    if (!cid) {
+        throw new RecordResolutionError('Record not found in proof');
+    }
+    const record = await blockstore.readRecord(cid);
+    return { commit, uri, cid, record };
+}
+//# sourceMappingURL=record.js.map

package/dist/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":";;;AAmDA,kDA2CC;AA7FD,gDAA8C;AAE9C,wCAOsB;AACtB,4CAAuD;AAEvD,yDAAwD;AACxD,gDAA2D;AAC3D,uCAAsC;AAiCtC;;GAEG;AACH,SAAgB,mBAAmB,CACjC,UAAsC,EAAE;IAExC,MAAM,EAAE,UAAU,GAAG,IAAI,qBAAU,EAAE,EAAE,GAAG,EAAE,GAAG,OAAO,CAAA;IACtD,OAAO,KAAK,UAAU,aAAa,CACjC,MAAsB,EACtB,OAA6B,EAAE;QAE/B,MAAM,GAAG,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,cAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QACnE,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,GAAG;aAClC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC;aAC1C,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,EAAE;gBACrE,KAAK,EAAE,GAAG;aACX,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACJ,MAAM,MAAM,GAAG,IAAI,wBAAM,CACvB,OAAO,GAAG,KAAK,UAAU;YACvB,CAAC,CAAC,GAAG;YACL,CAAC,CAAC;gBACE,GAAG,GAAG;gBACN,OAAO,EAAE,GAAG,EAAE,OAAO,IAAI,QAAQ,CAAC,GAAG;gBACrC,KAAK,EAAE,GAAG,EAAE,KAAK,IAAI,iBAAS;aAC/B,CACN,CAAA;QACD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI;aACvD,SAAS,CAAC;YACT,GAAG;YACH,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,IAAI,qBAAqB,CAAC,8BAA8B,EAAE;gBAC9D,KAAK,EAAE,GAAG;aACX,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACJ,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE;YACnD,GAAG,EAAE,cAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC;YAC9C,UAAU,EAAE,QAAQ,CAAC,UAAU;SAChC,CAAC,CAAA;QACF,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;AACH,CAAC;AAEY,QAAA,aAAa,GAAG,mBAAmB,EAAE,CAAA;AAErC,QAAA,SAAS,GAAG,IAAA,0BAAa,EAAC;IACrC,WAAW,EAAE,KAAK;IAClB,qBAAqB,EAAE,IAAI;IAC3B,eAAe,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,qDAAqD;CAC3F,CAAC,CAAA;AAEF,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAgB,EAAE,OAAsB;QAClD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAA;IACrC,CAAC;CACF;AALD,sDAKC;AAED,KAAK,UAAU,aAAa,CAC1B,GAAU,EACV,EAAE,UAAU,EAA8B;IAE1C,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,IAAA,uBAAc,EAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACxB,OAAO,GAAG,CAAC,IAAI,CAAA;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,oBAAU,EAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,qBAAqB,CAAC,0CAA0C,CAAC,CAAA;IAC7E,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,UAAsB,EACtB,EAAE,GAAG,EAAE,UAAU,EAAsC;IAEvD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,sBAAe,EAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACvE,MAAM,IAAI,qBAAqB,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;IAC3E,CAAC,CAAC,CAAA;IACF,MAAM,UAAU,GAAG,IAAI,uBAAgB,CAAC,MAAM,CAAC,CAAA;IAC/C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,UAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QAC1E,MAAM,IAAI,qBAAqB,CAAC,gCAAgC,EAAE;YAChE,KAAK,EAAE,GAAG;SACX,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,IAAI,qBAAqB,CAAC,qBAAqB,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;IACpE,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAe,EAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAC1D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,qBAAqB,CAC7B,gCAAgC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAClD,CAAA;IACH,CAAC;IACD,MAAM,GAAG,GAAG,UAAG,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IAC7C,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;IAC1D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,qBAAqB,CAAC,2BAA2B,CAAC,CAAA;IAC9D,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IAC/C,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAA;AACrC,CAAC"}

package/dist/util.d.ts

@@ -0,0 +1,2 @@
+export declare function isValidDid(did: string): boolean;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAEA,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,WAOrC"}

package/dist/util.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDid = isValidDid;
+const syntax_1 = require("@atproto/syntax");
+function isValidDid(did) {
+    try {
+        (0, syntax_1.ensureValidDid)(did);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;AAEA,gCAOC;AATD,4CAAgD;AAEhD,SAAgB,UAAU,CAAC,GAAW;IACpC,IAAI,CAAC;QACH,IAAA,uBAAc,EAAC,GAAG,CAAC,CAAA;QACnB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC"}

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  displayName: 'Lexicon Resolver',
+  transform: { '^.+\\.(t|j)s$': '@swc/jest' },
+  setupFiles: ['<rootDir>/../../jest.setup.ts'],
+  moduleNameMapper: { '^(\\.\\.?\\/.+)\\.js$': ['$1.ts', '$1.js'] },
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@atproto/lexicon-resolver",
+  "version": "0.1.0",
+  "type": "commonjs",
+  "license": "MIT",
+  "description": "ATProto Lexicon resolution",
+  "keywords": [
+    "atproto",
+    "lexicon"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/lexicon-resolver"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "multiformats": "^9.9.0",
+    "@atproto-labs/fetch-node": "^0.1.9",
+    "@atproto/identity": "^0.4.8",
+    "@atproto/lexicon": "^0.4.13",
+    "@atproto/repo": "^0.8.6",
+    "@atproto/syntax": "^0.4.0",
+    "@atproto/xrpc": "^0.7.2"
+  },
+  "devDependencies": {
+    "jest": "^28.1.2",
+    "typescript": "^5.6.3",
+    "@atproto/common": "^0.4.11",
+    "@atproto/lex-cli": "^0.9.2",
+    "@atproto/dev-env": "^0.3.165"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "tsc --build tsconfig.json",
+    "codegen": "lex gen-api --yes ./src/client ../../lexicons/com/atproto/sync/getRecord.json"
+  }
+}

package/src/client/index.ts

@@ -0,0 +1,67 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import {
+  XrpcClient,
+  type FetchHandler,
+  type FetchHandlerOptions,
+} from '@atproto/xrpc'
+import { schemas } from './lexicons.js'
+import { CID } from 'multiformats/cid'
+import { type OmitKey, type Un$Typed } from './util.js'
+import * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord.js'
+
+export * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord.js'
+
+export class AtpBaseClient extends XrpcClient {
+  com: ComNS
+
+  constructor(options: FetchHandler | FetchHandlerOptions) {
+    super(options, schemas)
+    this.com = new ComNS(this)
+  }
+
+  /** @deprecated use `this` instead */
+  get xrpc(): XrpcClient {
+    return this
+  }
+}
+
+export class ComNS {
+  _client: XrpcClient
+  atproto: ComAtprotoNS
+
+  constructor(client: XrpcClient) {
+    this._client = client
+    this.atproto = new ComAtprotoNS(client)
+  }
+}
+
+export class ComAtprotoNS {
+  _client: XrpcClient
+  sync: ComAtprotoSyncNS
+
+  constructor(client: XrpcClient) {
+    this._client = client
+    this.sync = new ComAtprotoSyncNS(client)
+  }
+}
+
+export class ComAtprotoSyncNS {
+  _client: XrpcClient
+
+  constructor(client: XrpcClient) {
+    this._client = client
+  }
+
+  getRecord(
+    params?: ComAtprotoSyncGetRecord.QueryParams,
+    opts?: ComAtprotoSyncGetRecord.CallOptions,
+  ): Promise<ComAtprotoSyncGetRecord.Response> {
+    return this._client
+      .call('com.atproto.sync.getRecord', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoSyncGetRecord.toKnownErr(e)
+      })
+  }
+}

package/src/client/lexicons.ts

@@ -0,0 +1,98 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import {
+  type LexiconDoc,
+  Lexicons,
+  ValidationError,
+  type ValidationResult,
+} from '@atproto/lexicon'
+import { type $Typed, is$typed, maybe$typed } from './util.js'
+
+export const schemaDict = {
+  ComAtprotoSyncGetRecord: {
+    lexicon: 1,
+    id: 'com.atproto.sync.getRecord',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.',
+        parameters: {
+          type: 'params',
+          required: ['did', 'collection', 'rkey'],
+          properties: {
+            did: {
+              type: 'string',
+              format: 'did',
+              description: 'The DID of the repo.',
+            },
+            collection: {
+              type: 'string',
+              format: 'nsid',
+            },
+            rkey: {
+              type: 'string',
+              description: 'Record Key',
+              format: 'record-key',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/vnd.ipld.car',
+        },
+        errors: [
+          {
+            name: 'RecordNotFound',
+          },
+          {
+            name: 'RepoNotFound',
+          },
+          {
+            name: 'RepoTakendown',
+          },
+          {
+            name: 'RepoSuspended',
+          },
+          {
+            name: 'RepoDeactivated',
+          },
+        ],
+      },
+    },
+  },
+} as const satisfies Record<string, LexiconDoc>
+export const schemas = Object.values(schemaDict) satisfies LexiconDoc[]
+export const lexicons: Lexicons = new Lexicons(schemas)
+
+export function validate<T extends { $type: string }>(
+  v: unknown,
+  id: string,
+  hash: string,
+  requiredType: true,
+): ValidationResult<T>
+export function validate<T extends { $type?: string }>(
+  v: unknown,
+  id: string,
+  hash: string,
+  requiredType?: false,
+): ValidationResult<T>
+export function validate(
+  v: unknown,
+  id: string,
+  hash: string,
+  requiredType?: boolean,
+): ValidationResult {
+  return (requiredType ? is$typed : maybe$typed)(v, id, hash)
+    ? lexicons.validate(`${id}#${hash}`, v)
+    : {
+        success: false,
+        error: new ValidationError(
+          `Must be an object with "${hash === 'main' ? id : `${id}#${hash}`}" $type property`,
+        ),
+      }
+}
+
+export const ids = {
+  ComAtprotoSyncGetRecord: 'com.atproto.sync.getRecord',
+} as const

package/src/client/types/com/atproto/sync/getRecord.ts

@@ -0,0 +1,78 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { HeadersMap, XRPCError } from '@atproto/xrpc'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'com.atproto.sync.getRecord'
+
+export type QueryParams = {
+  /** The DID of the repo. */
+  did: string
+  collection: string
+  /** Record Key */
+  rkey: string
+}
+export type InputSchema = undefined
+
+export interface CallOptions {
+  signal?: AbortSignal
+  headers?: HeadersMap
+}
+
+export interface Response {
+  success: boolean
+  headers: HeadersMap
+  data: Uint8Array
+}
+
+export class RecordNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export class RepoNotFoundError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export class RepoTakendownError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export class RepoSuspendedError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export class RepoDeactivatedError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'RecordNotFound') return new RecordNotFoundError(e)
+    if (e.error === 'RepoNotFound') return new RepoNotFoundError(e)
+    if (e.error === 'RepoTakendown') return new RepoTakendownError(e)
+    if (e.error === 'RepoSuspended') return new RepoSuspendedError(e)
+    if (e.error === 'RepoDeactivated') return new RepoDeactivatedError(e)
+  }
+
+  return e
+}