@jbrowse/jexl 4.0.1 → 5.0.1

package/esm/analyze.js

@@ -0,0 +1,256 @@
+/*
+ * Jexl
+ * Copyright 2020 Tom Shawver
+ */
+function literalKey(node) {
+    const value = literalValue(node);
+    return typeof value === 'boolean' ? String(value) : (value ?? undefined);
+}
+function literalValue(ast) {
+    const node = ast;
+    if (node.type === 'Literal') {
+        return node.value;
+    }
+    if (node.type === 'TemplateLiteral' &&
+        node.parts.every((part) => part.type === 'static')) {
+        return node.parts.map((part) => part.value).join('');
+    }
+    return undefined;
+}
+function extend(read, keys, dynamic = false) {
+    if (read.dynamic) {
+        return read;
+    }
+    const path = [...read.path, ...keys];
+    return dynamic
+        ? { root: read.root, path, dynamic }
+        : { root: read.root, path };
+}
+function isBarePath(ast) {
+    const node = ast;
+    if (node.type === 'Identifier') {
+        return !node.from || isBarePath(node.from);
+    }
+    return (node.type === 'FilterExpression' &&
+        literalKey(node.expr) !== undefined &&
+        isBarePath(node.subject));
+}
+function fieldOf({ root, path, dynamic }, row, env) {
+    const fieldPath = root === row
+        ? path
+        : env && !env.includes(root)
+            ? [root, ...path]
+            : undefined;
+    return (fieldPath && (dynamic ? { path: fieldPath, dynamic } : { path: fieldPath }));
+}
+function classify(node, value) {
+    const literal = literalValue(node);
+    if (literal !== undefined) {
+        return { type: 'literal', value: literal };
+    }
+    return value.length === 1
+        ? { type: 'path', read: value[0] }
+        : { type: 'dynamic' };
+}
+/**
+ * Lists what an expression reads from its context, without evaluating it or
+ * consulting any registered function.
+ *
+ * A name assigned earlier in the expression is a local: `x = feature.score;
+ * x > 1` reads `feature.score` and no `x`. An assignment that may not run — in
+ * a conditional's branch, or right of a binary operator, which may short-circuit
+ * — counts its value as read and binds nothing past that operand, so a later
+ * read of the name is a context read.
+ *
+ * Every path evaluation reads is reported, or a prefix of it is.
+ */
+export function analyze(ast, { accessors = {}, row, env } = {}) {
+    const reads = new Map();
+    const calls = [];
+    const assigned = new Set();
+    function consume(value) {
+        for (const read of value) {
+            const key = JSON.stringify([read.root, read.path, read.dynamic]);
+            if (!reads.has(key)) {
+                reads.set(key, read);
+            }
+        }
+    }
+    function use(node, scope) {
+        consume(walk(node, scope));
+    }
+    function release(scope, outer) {
+        for (const [name, binding] of scope) {
+            if (!binding.used && outer?.get(name) !== binding) {
+                consume(binding.value);
+            }
+        }
+    }
+    function branch(node, scope) {
+        if (!node) {
+            return [];
+        }
+        const inner = new Map(scope);
+        const value = walk(node, inner);
+        release(inner, scope);
+        return value;
+    }
+    function call(node, scope) {
+        const record = { name: node.name, args: [] };
+        calls.push(record);
+        const [subjectNode, ...keyNodes] = node.args;
+        const prefix = Object.hasOwn(accessors, node.name)
+            ? accessors[node.name]
+            : undefined;
+        if (!prefix || !subjectNode) {
+            for (const arg of node.args) {
+                const value = walk(arg, scope);
+                record.args.push(classify(arg, value));
+                consume(value);
+            }
+            return [];
+        }
+        const subject = walk(subjectNode, scope);
+        record.args.push(classify(subjectNode, subject));
+        const keys = [...prefix];
+        let dynamic = false;
+        for (const arg of keyNodes) {
+            const key = literalKey(arg);
+            if (key === undefined) {
+                const value = walk(arg, scope);
+                record.args.push(classify(arg, value));
+                consume(value);
+                dynamic = true;
+            }
+            else {
+                record.args.push({ type: 'literal', value: literalValue(arg) });
+                if (!dynamic) {
+                    keys.push(key);
+                }
+            }
+        }
+        return subject.map((read) => extend(read, keys, dynamic));
+    }
+    function walk(ast, scope) {
+        const node = ast;
+        switch (node.type) {
+            case 'Literal': {
+                return [];
+            }
+            case 'Identifier': {
+                if (node.from) {
+                    return walk(node.from, scope).map((read) => extend(read, [node.value]));
+                }
+                const binding = scope.get(node.value);
+                if (binding) {
+                    binding.used = true;
+                    return binding.value;
+                }
+                return [{ root: node.value, path: [] }];
+            }
+            case 'FilterExpression': {
+                const subject = walk(node.subject, scope);
+                const key = literalKey(node.expr);
+                if (key !== undefined) {
+                    return subject.map((read) => extend(read, [key]));
+                }
+                use(node.expr, scope);
+                return subject.map((read) => extend(read, [], true));
+            }
+            case 'FunctionCall': {
+                return call(node, scope);
+            }
+            case 'ConditionalExpression': {
+                const test = walk(node.test, scope);
+                consume(test);
+                const consequent = node.consequent
+                    ? branch(node.consequent, scope)
+                    : test;
+                return [...consequent, ...branch(node.alternate, scope)];
+            }
+            case 'BinaryExpression': {
+                use(node.left, scope);
+                consume(branch(node.right, scope));
+                return [];
+            }
+            case 'UnaryExpression': {
+                use(node.right, scope);
+                return [];
+            }
+            case 'ArrayLiteral': {
+                for (const item of node.value) {
+                    use(item, scope);
+                }
+                return [];
+            }
+            case 'ObjectLiteral': {
+                for (const value of Object.values(node.value)) {
+                    use(value, scope);
+                }
+                return [];
+            }
+            case 'TemplateLiteral': {
+                for (const part of node.parts) {
+                    if (part.type === 'expression') {
+                        use(part.value, scope);
+                    }
+                }
+                return [];
+            }
+            case 'SequenceExpression': {
+                const exprs = node.expressions;
+                for (const expr of exprs.slice(0, -1)) {
+                    const value = walk(expr, scope);
+                    if (expr.type !== 'AssignmentExpression') {
+                        consume(value);
+                    }
+                }
+                return walk(exprs.at(-1), scope);
+            }
+            case 'AssignmentExpression': {
+                const value = walk(node.right, scope);
+                const name = node.left.value;
+                const previous = scope.get(name);
+                if (previous && !previous.used) {
+                    consume(previous.value);
+                }
+                scope.set(name, { value, used: false });
+                assigned.add(name);
+                return value;
+            }
+            case 'Lambda': {
+                const inner = new Map(scope);
+                for (const param of node.params) {
+                    inner.set(param, { value: [], used: true });
+                }
+                use(node.body, inner);
+                return [];
+            }
+            default: {
+                throw new Error(`Corrupt AST: unknown node type '${ast.type}'`);
+            }
+        }
+    }
+    const scope = new Map();
+    const returns = ast ? walk(ast, scope) : [];
+    consume(returns);
+    release(scope);
+    const readList = [...reads.values()];
+    const fields = new Map();
+    for (const read of readList) {
+        const field = fieldOf(read, row, env);
+        if (field) {
+            fields.set(JSON.stringify(field), field);
+        }
+    }
+    return {
+        variables: [...new Set(readList.map((read) => read.root))],
+        reads: readList,
+        fields: [...fields.values()],
+        returns,
+        bare: ast !== null && isBarePath(ast),
+        calls,
+        assigned: [...assigned]
+    };
+}
+//# sourceMappingURL=analyze.js.map

package/esm/analyze.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyze.js","sourceRoot":"","sources":["../src/analyze.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmFH,SAAS,UAAU,CAAC,IAAa;IAC/B,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAChC,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC,CAAA;AAC1E,CAAC;AAED,SAAS,YAAY,CAAC,GAAY;IAChC,MAAM,IAAI,GAAG,GAAmB,CAAA;IAChC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IACD,IACE,IAAI,CAAC,IAAI,KAAK,iBAAiB;QAC/B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,EAClD,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtD,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,MAAM,CAAC,IAAU,EAAE,IAAwB,EAAE,OAAO,GAAG,KAAK;IACnE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAA;IACpC,OAAO,OAAO;QACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE;QACpC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAA;AAC/B,CAAC;AAED,SAAS,UAAU,CAAC,GAAY;IAC9B,MAAM,IAAI,GAAG,GAAmB,CAAA;IAChC,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5C,CAAC;IACD,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,kBAAkB;QAChC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS;QACnC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CACzB,CAAA;AACH,CAAC;AAED,SAAS,OAAO,CACd,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAQ,EAC7B,GAAuB,EACvB,GAAkC;IAElC,MAAM,SAAS,GACb,IAAI,KAAK,GAAG;QACV,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC1B,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;YACjB,CAAC,CAAC,SAAS,CAAA;IACjB,OAAO,CACL,SAAS,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC5E,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAa,EAAE,KAAa;IAC5C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAClC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;IAC5C,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE,EAAE;QACnC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CACrB,GAAmB,EACnB,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,EAAE,GAAG,KAAqB,EAAE;IAEjD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgB,CAAA;IACrC,MAAM,KAAK,GAAW,EAAE,CAAA;IACxB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAElC,SAAS,OAAO,CAAC,KAAa;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,GAAG,CAAC,IAAa,EAAE,KAAY;QACtC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;IAC5B,CAAC;IAED,SAAS,OAAO,CAAC,KAAY,EAAE,KAAa;QAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;gBAClD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,MAAM,CAAC,IAAyB,EAAE,KAAY;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAC/B,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,SAAS,IAAI,CAAC,IAAkB,EAAE,KAAY;QAC5C,MAAM,MAAM,GAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClB,MAAM,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,IAAI,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACtB,CAAC,CAAC,SAAS,CAAA;QACb,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;gBACtC,OAAO,CAAC,KAAK,CAAC,CAAA;YAChB,CAAC;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;QAChD,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,CAAA;QACxB,IAAI,OAAO,GAAG,KAAK,CAAA;QACnB,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,CAAA;YAC3B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;gBACtC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACd,OAAO,GAAG,IAAI,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,GAAG,CAAE,EAAE,CAAC,CAAA;gBAChE,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAChB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED,SAAS,IAAI,CAAC,GAAY,EAAE,KAAY;QACtC,MAAM,IAAI,GAAG,GAAmB,CAAA;QAChC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACzC,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAC3B,CAAA;gBACH,CAAC;gBACD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBACrC,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;oBACnB,OAAO,OAAO,CAAC,KAAK,CAAA;gBACtB,CAAC;gBACD,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;YACzC,CAAC;YAED,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACxB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;gBACzC,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACnD,CAAC;gBACD,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBACrB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;YACtD,CAAC;YAED,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC1B,CAAC;YAED,KAAK,uBAAuB,CAAC,CAAC,CAAC;gBAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBACnC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACb,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU;oBAChC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC;oBAChC,CAAC,CAAC,IAAI,CAAA;gBACR,OAAO,CAAC,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAA;YAC1D,CAAC;YAED,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACxB,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBACrB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAA;gBAClC,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,GAAG,CAAC,IAAI,CAAC,KAAM,EAAE,KAAK,CAAC,CAAA;gBACvB,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBAC9B,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBAClB,CAAC;gBACD,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC9C,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;gBACnB,CAAC;gBACD,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBAC9B,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;wBAC/B,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;oBACxB,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,CAAA;YACX,CAAC;YAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;gBAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAA;gBAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;oBAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;wBACzC,OAAO,CAAC,KAAK,CAAC,CAAA;oBAChB,CAAC;gBACH,CAAC;gBACD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,EAAE,KAAK,CAAC,CAAA;YACnC,CAAC;YAED,KAAK,sBAAsB,CAAC,CAAC,CAAC;gBAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAM,EAAE,KAAK,CAAC,CAAA;gBACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAA;gBAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBAChC,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;gBACzB,CAAC;gBACD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;gBACvC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBAClB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,KAAK,GAAU,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;gBACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;gBAC7C,CAAC;gBACD,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBACrB,OAAO,EAAE,CAAA;YACX,CAAC;YAED,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAA;YACjE,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAU,IAAI,GAAG,EAAE,CAAA;IAC9B,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC3C,OAAO,CAAC,OAAO,CAAC,CAAA;IAChB,OAAO,CAAC,KAAK,CAAC,CAAA;IACd,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IACpC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiB,CAAA;IACvC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;QAC1C,CAAC;IACH,CAAC;IACD,OAAO;QACL,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QAC5B,OAAO;QACP,IAAI,EAAE,GAAG,KAAK,IAAI,IAAI,UAAU,CAAC,GAAG,CAAC;QACrC,KAAK;QACL,QAAQ,EAAE,CAAC,GAAG,QAAQ,CAAC;KACxB,CAAA;AACH,CAAC"}

package/esm/check.d.ts

@@ -0,0 +1,109 @@
+import type { AnalyzeOptions } from './analyze.ts';
+import type { AstNode } from './types.ts';
+/**
+ * How many values a field holds: one, a list of exactly that many when a
+ * number, or a list whose length follows the record, as VCF's `Number=A`, `R`,
+ * `G` and `.` do.
+ */
+export type Cardinality = 'one' | 'perAlt' | 'perAllele' | 'perGenotype' | 'many' | number;
+/**
+ * One field of a row, as a file header declares it. A `record` field's own
+ * fields are further entries whose path extends its path, including when the
+ * record is a list of them. A path key of `*` stands for every key of a map,
+ * such as a VCF record's sample names. An entry with an empty path describes
+ * the row itself.
+ */
+export interface FieldSchema {
+    path: readonly string[];
+    type: 'number' | 'string' | 'boolean' | 'flag' | 'record';
+    cardinality?: Cardinality;
+    integer?: boolean;
+    description?: string;
+    /** Every value the field takes, where the header enumerates them. */
+    categories?: readonly string[];
+    domain?: readonly [number, number];
+    /** For a record: its fields were observed in data rather than declared. */
+    open?: boolean;
+}
+interface FromField {
+    field?: FieldSchema;
+}
+export type Type = {
+    kind: 'unknown';
+} | {
+    kind: 'undefined';
+} | (FromField & {
+    kind: 'number';
+    values?: readonly number[];
+    domain?: readonly [number, number];
+}) | (FromField & {
+    kind: 'string';
+    values?: readonly string[];
+}) | (FromField & {
+    kind: 'boolean';
+}) | (FromField & {
+    kind: 'list';
+    of: Type;
+    cardinality: Exclude<Cardinality, 'one'>;
+}) | (FromField & {
+    kind: 'record';
+    fields: ReadonlyMap<string, Type>;
+    each?: Type;
+    open: boolean;
+}) | {
+    kind: 'union';
+    of: readonly Type[];
+} | {
+    kind: 'lambda';
+    returns: Type;
+};
+export type ParamType = 'number' | 'string' | 'boolean' | 'list' | 'record' | 'any' | 'member' | 'lambda';
+export interface Signature {
+    params: readonly (ParamType | readonly ParamType[])[];
+    /** How many trailing params a call may leave out. */
+    optional?: number;
+    /** Whether the last param repeats. */
+    variadic?: boolean;
+    returns?: 'number' | 'string' | 'boolean' | Type | ((args: readonly Type[]) => Type);
+}
+export type Severity = 'error' | 'warning' | 'info';
+export type DiagnosticCode = 'unknown-variable' | 'unknown-field' | 'unknown-function' | 'arity' | 'argument-type' | 'list-operand' | 'list-lengths' | 'invalid-pattern' | 'string-numeric' | 'never-equal' | 'unknown-category' | 'index-scalar' | 'index-range' | 'dot-through-list' | 'dotted-key';
+export interface Diagnostic {
+    code: DiagnosticCode;
+    severity: Severity;
+    message: string;
+    node: AstNode;
+    /** Replacements for `node`'s text, best first. */
+    suggestions?: string[];
+}
+export interface CheckOptions {
+    schema?: readonly FieldSchema[];
+    functions?: Readonly<Record<string, Signature>>;
+    accessors?: AnalyzeOptions['accessors'];
+    /** The variable holding the row. Without one, every free name is a field. */
+    row?: string;
+    /**
+     * The other variables the host binds, and their types. When given, any name
+     * that is neither these, the row nor a field is reported.
+     */
+    env?: Readonly<Record<string, Type>>;
+}
+export interface CheckResult {
+    diagnostics: Diagnostic[];
+    type: Type;
+}
+export declare const UNKNOWN: Type;
+/**
+ * Renders a tree back to expression text, for messages and suggestions. The
+ * text parses back to the same tree.
+ */
+export declare function print(ast: AstNode): string;
+/** The type of a row whose fields `schema` declares. */
+export declare function recordOf(schema: readonly FieldSchema[]): Type;
+export declare function union(a: Type, b: Type): Type;
+/**
+ * Checks an expression against the fields a host's data declares and the
+ * functions it registers, without evaluating it, and infers what it answers.
+ */
+export declare function check(ast: AstNode | null, { schema, functions, accessors, row, env }?: CheckOptions): CheckResult;
+export {};