@atproto/lex-document 0.0.0

package/dist/lexicon-schema-builder.js

@@ -0,0 +1,249 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LexiconSchemaBuilder = void 0;
+exports.memoize = memoize;
+const lex_schema_1 = require("@atproto/lex-schema");
+/**
+ * Builds a validator for a given lexicon "ref" from a lexicon indexer.
+ *
+ * @example
+ *
+ * ```ts
+ * import { LexiconSchemaBuilder } from '@atproto/lex/doc'
+ * import { LexiconStreamIndexer } from '@atproto/lex/doc'
+ *
+ * const indexer = new LexiconStreamIndexer(lexiconDocs)
+ * const validator = await LexiconSchemaBuilder.build(indexer, 'com.example.foo#bar')
+ * ```
+ */
+class LexiconSchemaBuilder {
+    indexer;
+    static async build(indexer, fullRef) {
+        const ctx = new LexiconSchemaBuilder(indexer);
+        try {
+            const result = await ctx.buildFullRef(fullRef);
+            if (!(result instanceof lex_schema_1.l.Validator)) {
+                throw new Error(`Ref ${fullRef} is not a validator schema type`);
+            }
+            return result;
+        }
+        finally {
+            await ctx.done();
+        }
+    }
+    static async buildAll(indexer) {
+        const builder = new LexiconSchemaBuilder(indexer);
+        const schemas = new Map();
+        if (!isAsyncIterableObject(indexer)) {
+            throw new Error('An iterable indexer is required to build all schemas');
+        }
+        try {
+            for await (const doc of indexer) {
+                for (const hash of Object.keys(doc.defs)) {
+                    const fullRef = `${doc.id}#${hash}`;
+                    const schema = await builder.buildFullRef(fullRef);
+                    schemas.set(fullRef, schema);
+                }
+            }
+            return schemas;
+        }
+        finally {
+            await builder.done();
+        }
+    }
+    #asyncTasks = new AsyncTasks();
+    constructor(indexer) {
+        this.indexer = indexer;
+    }
+    async done() {
+        await this.#asyncTasks.done();
+    }
+    buildFullRef = memoize(async (fullRef) => {
+        const { nsid, hash } = parseRef(fullRef);
+        const doc = await this.indexer.get(nsid);
+        if (!doc)
+            throw new Error(`No lexicon found for NSID: ${nsid}`);
+        return this.compileDef(doc, hash);
+    });
+    buildRefGetter(fullRef) {
+        let validator;
+        this.#asyncTasks.add(this.buildFullRef(fullRef).then((v) => {
+            if (!(v instanceof lex_schema_1.l.Validator)) {
+                throw new Error(`Only refs to validator schema types are allowed`);
+            }
+            validator = v;
+        }));
+        return () => {
+            if (validator)
+                return validator;
+            throw new Error('Validator not yet built. Did you await done()?');
+        };
+    }
+    buildTypedRefGetter(fullRef) {
+        let validator;
+        this.#asyncTasks.add(this.buildFullRef(fullRef).then((v) => {
+            if (v instanceof lex_schema_1.l.TypedObjectSchema || v instanceof lex_schema_1.l.RecordSchema) {
+                validator = v;
+            }
+            else {
+                throw new Error('Only refs to records and object definitions are allowed');
+            }
+        }));
+        return () => {
+            if (validator)
+                return validator;
+            throw new Error('Validator not yet built. Did you await done()?');
+        };
+    }
+    compileDef(doc, hash) {
+        const def = Object.hasOwn(doc.defs, hash) ? doc.defs[hash] : null;
+        if (!def) {
+            throw new Error(`No definition found for hash "${JSON.stringify(hash)}" in ${doc.id}`);
+        }
+        switch (def.type) {
+            case 'permission-set':
+                return lex_schema_1.l.permissionSet(doc.id, def.permissions.map(({ resource, type, ...p }) => lex_schema_1.l.permission(resource, p)), def);
+            case 'procedure':
+                return lex_schema_1.l.procedure(doc.id, this.compileParams(doc, def.parameters), this.compilePayload(doc, def.input), this.compilePayload(doc, def.output), this.compileErrors(doc, def.errors));
+            case 'query':
+                return lex_schema_1.l.query(doc.id, this.compileParams(doc, def.parameters), this.compilePayload(doc, def.output), this.compileErrors(doc, def.errors));
+            case 'subscription':
+                return lex_schema_1.l.subscription(doc.id, this.compileParams(doc, def.parameters), this.compilePayloadSchema(doc, def.message?.schema), this.compileErrors(doc, def.errors));
+            case 'token':
+                return lex_schema_1.l.token(doc.id, hash);
+            case 'record':
+                return lex_schema_1.l.record(def.key ? lex_schema_1.l.asRecordKey(def.key) : 'any', doc.id, this.compileObject(doc, def.record));
+            case 'object':
+                return lex_schema_1.l.typedObject(doc.id, hash, this.compileObject(doc, def));
+            default:
+                return this.compileLeaf(doc, def);
+        }
+    }
+    compileLeaf(doc, def) {
+        switch (def.type) {
+            case 'string':
+                return lex_schema_1.l.string(def);
+            case 'integer':
+                return lex_schema_1.l.integer(def);
+            case 'boolean':
+                return lex_schema_1.l.boolean(def);
+            case 'blob':
+                return lex_schema_1.l.blob(def);
+            case 'cid-link':
+                return lex_schema_1.l.cidLink();
+            case 'bytes':
+                return lex_schema_1.l.bytes(def);
+            case 'unknown':
+                return lex_schema_1.l.unknown();
+            case 'array':
+                return lex_schema_1.l.array(this.compileLeaf(doc, def.items), def);
+            default:
+                return this.compileRef(doc, def);
+        }
+    }
+    compileRef(doc, def) {
+        switch (def.type) {
+            case 'ref':
+                return lex_schema_1.l.ref(this.buildRefGetter(buildFullRef(doc, def.ref)));
+            case 'union':
+                return lex_schema_1.l.typedUnion(def.refs.map((r) => lex_schema_1.l.typedRef(this.buildTypedRefGetter(buildFullRef(doc, r)))), def.closed ?? false);
+            default:
+                // @ts-expect-error
+                throw new Error(`Unknown lexicon type: ${def.type}`);
+        }
+    }
+    compileObject(doc, def) {
+        const props = {};
+        for (const [key, propDef] of Object.entries(def.properties)) {
+            if (propDef === undefined)
+                continue;
+            props[key] = this.compileLeaf(doc, propDef);
+        }
+        return lex_schema_1.l.object(props, def);
+    }
+    compilePayload(doc, def) {
+        return lex_schema_1.l.payload(def?.encoding, def?.schema ? this.compilePayloadSchema(doc, def.schema) : undefined);
+    }
+    compileErrors(_doc, errors) {
+        return errors?.map((e) => e.name);
+    }
+    compilePayloadSchema(doc, def) {
+        if (!def)
+            return undefined;
+        switch (def.type) {
+            case 'object':
+                return this.compileObject(doc, def);
+            default:
+                return this.compileRef(doc, def);
+        }
+    }
+    compileParams(doc, def) {
+        if (!def)
+            return lex_schema_1.l.params();
+        const props = {};
+        for (const [key, propDef] of Object.entries(def.properties)) {
+            if (propDef === undefined)
+                continue;
+            props[key] = this.compileLeaf(doc, propDef);
+        }
+        return lex_schema_1.l.params(props, def);
+    }
+}
+exports.LexiconSchemaBuilder = LexiconSchemaBuilder;
+class AsyncTasks {
+    /**
+     * A set that, eventually, contains only rejected promises.
+     */
+    #promises = new Set();
+    async done() {
+        do {
+            // @NOTE this is going to throw on the first rejected promise (which is
+            // what we want)
+            for (const p of this.#promises)
+                await p;
+            // At this point, all settled promises should have been removed. If
+            // this.#promises is not empty, it means new promises were added during
+            // the awaiting process, so we loop again.
+        } while (this.#promises.size > 0);
+    }
+    add(p) {
+        const promise = Promise.resolve(p).then(() => {
+            // No need to keep the promise any longer
+            this.#promises.delete(promise);
+        });
+        void promise.catch((_err) => {
+            // ignore errors here, they should be caught though done()
+        });
+        this.#promises.add(promise);
+    }
+}
+function parseRef(fullRef) {
+    const { length, 0: nsid, 1: hash } = fullRef.split('#');
+    if (length !== 2)
+        throw new Error('Uri can only have one hash segment');
+    if (!nsid || !hash)
+        throw new Error('Invalid ref, missing hash');
+    return { nsid, hash };
+}
+function buildFullRef(from, ref) {
+    if (ref.startsWith('#'))
+        return `${from.id}${ref}`;
+    return ref;
+}
+function memoize(fn) {
+    const cache = new Map();
+    return ((arg) => {
+        if (cache.has(arg))
+            return cache.get(arg);
+        const result = fn(arg);
+        cache.set(arg, result);
+        return result;
+    });
+}
+function isAsyncIterableObject(obj) {
+    return (obj != null &&
+        typeof obj === 'object' &&
+        Symbol.asyncIterator in obj &&
+        typeof obj[Symbol.asyncIterator] === 'function');
+}
+//# sourceMappingURL=lexicon-schema-builder.js.map

package/dist/lexicon-schema-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicon-schema-builder.js","sourceRoot":"","sources":["../src/lexicon-schema-builder.ts"],"names":[],"mappings":";;;AAqUA,0BAQC;AA7UD,oDAAuC;AAcvC;;;;;;;;;;;;GAYG;AACH,MAAa,oBAAoB;IA8CT;IA7CtB,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,OAAuB,EACvB,OAAe;QAEf,MAAM,GAAG,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAA;QAC7C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;YAC9C,IAAI,CAAC,CAAC,MAAM,YAAY,cAAC,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,OAAO,OAAO,iCAAiC,CAAC,CAAA;YAClE,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;gBAAS,CAAC;YACT,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;QAClB,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAuB;QAC3C,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,IAAI,GAAG,EAOpB,CAAA;QACH,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACzE,CAAC;QACD,IAAI,CAAC;YACH,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,MAAM,OAAO,GAAG,GAAG,GAAG,CAAC,EAAE,IAAI,IAAI,EAAE,CAAA;oBACnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;oBAClD,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;QACtB,CAAC;IACH,CAAC;IAED,WAAW,GAAG,IAAI,UAAU,EAAE,CAAA;IAE9B,YAAsB,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;IAAG,CAAC;IAEjD,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;IAC/B,CAAC;IAED,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,OAAe,EAAE,EAAE;QAC/C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAA;QAExC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAA;QAE/D,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEQ,cAAc,CAAC,OAAe;QACtC,IAAI,SAA+B,CAAA;QAEnC,IAAI,CAAC,WAAW,CAAC,GAAG,CAClB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACpC,IAAI,CAAC,CAAC,CAAC,YAAY,cAAC,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;YACpE,CAAC;YACD,SAAS,GAAG,CAAC,CAAA;QACf,CAAC,CAAC,CACH,CAAA;QAED,OAAO,GAAG,EAAE;YACV,IAAI,SAAS;gBAAE,OAAO,SAAS,CAAA;YAC/B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACnE,CAAC,CAAA;IACH,CAAC;IAES,mBAAmB,CAC3B,OAAe;QAEf,IAAI,SAA+C,CAAA;QAEnD,IAAI,CAAC,WAAW,CAAC,GAAG,CAClB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACpC,IAAI,CAAC,YAAY,cAAC,CAAC,iBAAiB,IAAI,CAAC,YAAY,cAAC,CAAC,YAAY,EAAE,CAAC;gBACpE,SAAS,GAAG,CAAC,CAAA;YACf,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAA;YACH,CAAC;QACH,CAAC,CAAC,CACH,CAAA;QAED,OAAO,GAAG,EAAE;YACV,IAAI,SAAS;gBAAE,OAAO,SAAS,CAAA;YAC/B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACnE,CAAC,CAAA;IACH,CAAC;IAES,UAAU,CAAC,GAAoB,EAAE,IAAY;QACrD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACjE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CACb,iCAAiC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,EAAE,CACtE,CAAA;QACH,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,gBAAgB;gBACnB,OAAO,cAAC,CAAC,aAAa,CACpB,GAAG,CAAC,EAAE,EACN,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,CAC/C,cAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAC1B,EACD,GAAG,CACJ,CAAA;YACH,KAAK,WAAW;gBACd,OAAO,cAAC,CAAC,SAAS,CAChB,GAAG,CAAC,EAAE,EACN,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,EACvC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EACnC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,EACpC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CACpC,CAAA;YACH,KAAK,OAAO;gBACV,OAAO,cAAC,CAAC,KAAK,CACZ,GAAG,CAAC,EAAE,EACN,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,EACvC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,EACpC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CACpC,CAAA;YACH,KAAK,cAAc;gBACjB,OAAO,cAAC,CAAC,YAAY,CACnB,GAAG,CAAC,EAAE,EACN,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,EACvC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACnD,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CACpC,CAAA;YACH,KAAK,OAAO;gBACV,OAAO,cAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;YAC9B,KAAK,QAAQ;gBACX,OAAO,cAAC,CAAC,MAAM,CACb,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,cAAC,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EACxC,GAAG,CAAC,EAAE,EACN,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CACpC,CAAA;YACH,KAAK,QAAQ;gBACX,OAAO,cAAC,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;YAClE;gBACE,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAES,WAAW,CACnB,GAAoB,EACpB,GAAqC;QAErC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO,cAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACtB,KAAK,SAAS;gBACZ,OAAO,cAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACvB,KAAK,SAAS;gBACZ,OAAO,cAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACvB,KAAK,MAAM;gBACT,OAAO,cAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACpB,KAAK,UAAU;gBACb,OAAO,cAAC,CAAC,OAAO,EAAE,CAAA;YACpB,KAAK,OAAO;gBACV,OAAO,cAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACrB,KAAK,SAAS;gBACZ,OAAO,cAAC,CAAC,OAAO,EAAE,CAAA;YACpB,KAAK,OAAO;gBACV,OAAO,cAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAA;YACvD;gBACE,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAES,UAAU,CAClB,GAAoB,EACpB,GAAiC;QAEjC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,KAAK;gBACR,OAAO,cAAC,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YAC/D,KAAK,OAAO;gBACV,OAAO,cAAC,CAAC,UAAU,CACjB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACjB,cAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAC3D,EACD,GAAG,CAAC,MAAM,IAAI,KAAK,CACpB,CAAA;YACH;gBACE,mBAAmB;gBACnB,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IAES,aAAa,CACrB,GAAoB,EACpB,GAAkB;QAElB,MAAM,KAAK,GAAgC,EAAE,CAAA;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,IAAI,OAAO,KAAK,SAAS;gBAAE,SAAQ;YACnC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,cAAC,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAC7B,CAAC;IAES,cAAc,CACtB,GAAoB,EACpB,GAA+B;QAE/B,OAAO,cAAC,CAAC,OAAO,CACd,GAAG,EAAE,QAAQ,EACb,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CACrE,CAAA;IACH,CAAC;IAES,aAAa,CACrB,IAAqB,EACrB,MAAgC;QAEhC,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAES,oBAAoB,CAC5B,GAAoB,EACpB,GAAkD;QAElD,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAA;QAC1B,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;YACrC;gBACE,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAES,aAAa,CAAC,GAAoB,EAAE,GAAuB;QACnE,IAAI,CAAC,GAAG;YAAE,OAAO,cAAC,CAAC,MAAM,EAAE,CAAA;QAE3B,MAAM,KAAK,GAAgC,EAAE,CAAA;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,IAAI,OAAO,KAAK,SAAS;gBAAE,SAAQ;YACnC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,cAAC,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAC7B,CAAC;CACF;AA7PD,oDA6PC;AAED,MAAM,UAAU;IACd;;OAEG;IACH,SAAS,GAAG,IAAI,GAAG,EAAiB,CAAA;IAEpC,KAAK,CAAC,IAAI;QACR,GAAG,CAAC;YACF,uEAAuE;YACvE,gBAAgB;YAChB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS;gBAAE,MAAM,CAAC,CAAA;YACvC,mEAAmE;YACnE,uEAAuE;YACvE,0CAA0C;QAC5C,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,EAAC;IACnC,CAAC;IAED,GAAG,CAAC,CAAgB;QAClB,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YAC3C,yCAAyC;YACzC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC,CAAC,CAAA;QAEF,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,0DAA0D;QAC5D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACvD,IAAI,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;IACvE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;IAChE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AACvB,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB,EAAE,GAAW;IACtD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,CAAA;IAClD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAgB,OAAO,CAAsC,EAAM;IACjE,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAA;IAC/C,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACtB,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAA;QAC1C,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAmB,CAAA;QACxC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QACtB,OAAO,MAAM,CAAA;IACf,CAAC,CAAO,CAAA;AACV,CAAC;AAED,SAAS,qBAAqB,CAC5B,GAAM;IAEN,OAAO,CACL,GAAG,IAAI,IAAI;QACX,OAAO,GAAG,KAAK,QAAQ;QACvB,MAAM,CAAC,aAAa,IAAI,GAAG;QAC3B,OAAO,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,UAAU,CAChD,CAAA;AACH,CAAC","sourcesContent":["import { l } from '@atproto/lex-schema'\nimport {\n  LexiconArray,\n  LexiconArrayItems,\n  LexiconDocument,\n  LexiconError,\n  LexiconObject,\n  LexiconParameters,\n  LexiconPayload,\n  LexiconRef,\n  LexiconRefUnion,\n} from './lexicon-document.js'\nimport { LexiconIndexer } from './lexicon-indexer.js'\n\n/**\n * Builds a validator for a given lexicon \"ref\" from a lexicon indexer.\n *\n * @example\n *\n * ```ts\n * import { LexiconSchemaBuilder } from '@atproto/lex/doc'\n * import { LexiconStreamIndexer } from '@atproto/lex/doc'\n *\n * const indexer = new LexiconStreamIndexer(lexiconDocs)\n * const validator = await LexiconSchemaBuilder.build(indexer, 'com.example.foo#bar')\n * ```\n */\nexport class LexiconSchemaBuilder {\n  static async build(\n    indexer: LexiconIndexer,\n    fullRef: string,\n  ): Promise<l.Validator<unknown>> {\n    const ctx = new LexiconSchemaBuilder(indexer)\n    try {\n      const result = await ctx.buildFullRef(fullRef)\n      if (!(result instanceof l.Validator)) {\n        throw new Error(`Ref ${fullRef} is not a validator schema type`)\n      }\n      return result\n    } finally {\n      await ctx.done()\n    }\n  }\n\n  static async buildAll(indexer: LexiconIndexer) {\n    const builder = new LexiconSchemaBuilder(indexer)\n    const schemas = new Map<\n      string,\n      | l.Validator<unknown>\n      | l.Query\n      | l.Subscription\n      | l.Procedure\n      | l.PermissionSet\n    >()\n    if (!isAsyncIterableObject(indexer)) {\n      throw new Error('An iterable indexer is required to build all schemas')\n    }\n    try {\n      for await (const doc of indexer) {\n        for (const hash of Object.keys(doc.defs)) {\n          const fullRef = `${doc.id}#${hash}`\n          const schema = await builder.buildFullRef(fullRef)\n          schemas.set(fullRef, schema)\n        }\n      }\n      return schemas\n    } finally {\n      await builder.done()\n    }\n  }\n\n  #asyncTasks = new AsyncTasks()\n\n  constructor(protected indexer: LexiconIndexer) {}\n\n  async done(): Promise<void> {\n    await this.#asyncTasks.done()\n  }\n\n  buildFullRef = memoize(async (fullRef: string) => {\n    const { nsid, hash } = parseRef(fullRef)\n\n    const doc = await this.indexer.get(nsid)\n    if (!doc) throw new Error(`No lexicon found for NSID: ${nsid}`)\n\n    return this.compileDef(doc, hash)\n  })\n\n  protected buildRefGetter(fullRef: string): () => l.Validator<unknown> {\n    let validator: l.Validator<unknown>\n\n    this.#asyncTasks.add(\n      this.buildFullRef(fullRef).then((v) => {\n        if (!(v instanceof l.Validator)) {\n          throw new Error(`Only refs to validator schema types are allowed`)\n        }\n        validator = v\n      }),\n    )\n\n    return () => {\n      if (validator) return validator\n      throw new Error('Validator not yet built. Did you await done()?')\n    }\n  }\n\n  protected buildTypedRefGetter(\n    fullRef: string,\n  ): () => l.TypedObjectSchema | l.RecordSchema {\n    let validator: l.TypedObjectSchema | l.RecordSchema\n\n    this.#asyncTasks.add(\n      this.buildFullRef(fullRef).then((v) => {\n        if (v instanceof l.TypedObjectSchema || v instanceof l.RecordSchema) {\n          validator = v\n        } else {\n          throw new Error(\n            'Only refs to records and object definitions are allowed',\n          )\n        }\n      }),\n    )\n\n    return () => {\n      if (validator) return validator\n      throw new Error('Validator not yet built. Did you await done()?')\n    }\n  }\n\n  protected compileDef(doc: LexiconDocument, hash: string) {\n    const def = Object.hasOwn(doc.defs, hash) ? doc.defs[hash] : null\n    if (!def) {\n      throw new Error(\n        `No definition found for hash \"${JSON.stringify(hash)}\" in ${doc.id}`,\n      )\n    }\n    switch (def.type) {\n      case 'permission-set':\n        return l.permissionSet(\n          doc.id,\n          def.permissions.map(({ resource, type, ...p }) =>\n            l.permission(resource, p),\n          ),\n          def,\n        )\n      case 'procedure':\n        return l.procedure(\n          doc.id,\n          this.compileParams(doc, def.parameters),\n          this.compilePayload(doc, def.input),\n          this.compilePayload(doc, def.output),\n          this.compileErrors(doc, def.errors),\n        )\n      case 'query':\n        return l.query(\n          doc.id,\n          this.compileParams(doc, def.parameters),\n          this.compilePayload(doc, def.output),\n          this.compileErrors(doc, def.errors),\n        )\n      case 'subscription':\n        return l.subscription(\n          doc.id,\n          this.compileParams(doc, def.parameters),\n          this.compilePayloadSchema(doc, def.message?.schema),\n          this.compileErrors(doc, def.errors),\n        )\n      case 'token':\n        return l.token(doc.id, hash)\n      case 'record':\n        return l.record(\n          def.key ? l.asRecordKey(def.key) : 'any',\n          doc.id,\n          this.compileObject(doc, def.record),\n        )\n      case 'object':\n        return l.typedObject(doc.id, hash, this.compileObject(doc, def))\n      default:\n        return this.compileLeaf(doc, def)\n    }\n  }\n\n  protected compileLeaf(\n    doc: LexiconDocument,\n    def: LexiconArray | LexiconArrayItems,\n  ): l.Validator<unknown> {\n    switch (def.type) {\n      case 'string':\n        return l.string(def)\n      case 'integer':\n        return l.integer(def)\n      case 'boolean':\n        return l.boolean(def)\n      case 'blob':\n        return l.blob(def)\n      case 'cid-link':\n        return l.cidLink()\n      case 'bytes':\n        return l.bytes(def)\n      case 'unknown':\n        return l.unknown()\n      case 'array':\n        return l.array(this.compileLeaf(doc, def.items), def)\n      default:\n        return this.compileRef(doc, def)\n    }\n  }\n\n  protected compileRef(\n    doc: LexiconDocument,\n    def: LexiconRef | LexiconRefUnion,\n  ) {\n    switch (def.type) {\n      case 'ref':\n        return l.ref(this.buildRefGetter(buildFullRef(doc, def.ref)))\n      case 'union':\n        return l.typedUnion(\n          def.refs.map((r) =>\n            l.typedRef(this.buildTypedRefGetter(buildFullRef(doc, r))),\n          ),\n          def.closed ?? false,\n        )\n      default:\n        // @ts-expect-error\n        throw new Error(`Unknown lexicon type: ${def.type}`)\n    }\n  }\n\n  protected compileObject(\n    doc: LexiconDocument,\n    def: LexiconObject,\n  ): l.ObjectSchema {\n    const props: Record<string, l.Validator> = {}\n    for (const [key, propDef] of Object.entries(def.properties)) {\n      if (propDef === undefined) continue\n      props[key] = this.compileLeaf(doc, propDef)\n    }\n    return l.object(props, def)\n  }\n\n  protected compilePayload(\n    doc: LexiconDocument,\n    def: LexiconPayload | undefined,\n  ): l.Payload {\n    return l.payload(\n      def?.encoding,\n      def?.schema ? this.compilePayloadSchema(doc, def.schema) : undefined,\n    )\n  }\n\n  protected compileErrors(\n    _doc: LexiconDocument,\n    errors?: readonly LexiconError[],\n  ): undefined | string[] {\n    return errors?.map((e) => e.name)\n  }\n\n  protected compilePayloadSchema(\n    doc: LexiconDocument,\n    def?: LexiconObject | LexiconRef | LexiconRefUnion,\n  ) {\n    if (!def) return undefined\n    switch (def.type) {\n      case 'object':\n        return this.compileObject(doc, def)\n      default:\n        return this.compileRef(doc, def)\n    }\n  }\n\n  protected compileParams(doc: LexiconDocument, def?: LexiconParameters) {\n    if (!def) return l.params()\n\n    const props: Record<string, l.Validator> = {}\n    for (const [key, propDef] of Object.entries(def.properties)) {\n      if (propDef === undefined) continue\n      props[key] = this.compileLeaf(doc, propDef)\n    }\n    return l.params(props, def)\n  }\n}\n\nclass AsyncTasks {\n  /**\n   * A set that, eventually, contains only rejected promises.\n   */\n  #promises = new Set<Promise<void>>()\n\n  async done(): Promise<void> {\n    do {\n      // @NOTE this is going to throw on the first rejected promise (which is\n      // what we want)\n      for (const p of this.#promises) await p\n      // At this point, all settled promises should have been removed. If\n      // this.#promises is not empty, it means new promises were added during\n      // the awaiting process, so we loop again.\n    } while (this.#promises.size > 0)\n  }\n\n  add(p: Promise<void>) {\n    const promise = Promise.resolve(p).then(() => {\n      // No need to keep the promise any longer\n      this.#promises.delete(promise)\n    })\n\n    void promise.catch((_err) => {\n      // ignore errors here, they should be caught though done()\n    })\n\n    this.#promises.add(promise)\n  }\n}\n\nfunction parseRef(fullRef: string) {\n  const { length, 0: nsid, 1: hash } = fullRef.split('#')\n  if (length !== 2) throw new Error('Uri can only have one hash segment')\n  if (!nsid || !hash) throw new Error('Invalid ref, missing hash')\n  return { nsid, hash }\n}\n\nfunction buildFullRef(from: LexiconDocument, ref: string) {\n  if (ref.startsWith('#')) return `${from.id}${ref}`\n  return ref\n}\n\nexport function memoize<Fn extends (arg: string) => unknown>(fn: Fn): Fn {\n  const cache = new Map<string, ReturnType<Fn>>()\n  return ((arg: string) => {\n    if (cache.has(arg)) return cache.get(arg)!\n    const result = fn(arg) as ReturnType<Fn>\n    cache.set(arg, result)\n    return result\n  }) as Fn\n}\n\nfunction isAsyncIterableObject<T>(\n  obj: T,\n): obj is T & object & AsyncIterable<unknown> {\n  return (\n    obj != null &&\n    typeof obj === 'object' &&\n    Symbol.asyncIterator in obj &&\n    typeof obj[Symbol.asyncIterator] === 'function'\n  )\n}\n"]}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@atproto/lex-document",
+  "version": "0.0.0",
+  "license": "MIT",
+  "description": "Lexicon document validation tools for AT",
+  "keywords": [
+    "atproto",
+    "lexicon",
+    "document",
+    "lex"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/lex/lex-document"
+  },
+  "files": [
+    "./src",
+    "./dist"
+  ],
+  "sideEffects": false,
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": "./dist/index.js",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@atproto/lex-schema": "workspace:*",
+    "core-js": "^3",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "jest": "^28.1.2"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "test": "jest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+import 'core-js/modules/esnext.symbol.async-dispose'
+import 'core-js/modules/esnext.symbol.dispose'
+
+export * from './lexicon-document.js'
+export * from './lexicon-indexer.js'
+export * from './lexicon-schema-builder.js'
+export * from './lexicon-iterable-indexer.js'

package/src/lexicon-document.test.ts

@@ -0,0 +1,22 @@
+import { lexiconDocumentSchema } from './lexicon-document.js'
+
+describe('General validation', () => {
+  it('allows unknown fields to be present', () => {
+    const value = {
+      lexicon: 1,
+      id: 'com.example.unknownFields',
+      defs: {
+        test: {
+          type: 'object',
+          properties: {},
+          foo: 3,
+        },
+      },
+    }
+
+    expect(lexiconDocumentSchema.validate(value)).toStrictEqual({
+      success: true,
+      value,
+    })
+  })
+})