jlens-wasm 0.17.0 → 0.18.0

package/jlens.d.ts

@@ -217,6 +217,26 @@ export interface ExplanationLine {
     node: number;
 }
 
+// ---------------------------------------------------------------------------------------------
+// The fields an expression reads
+
+/**
+ * What an expression reads of a value: `true` for the whole value; an object for only the fields
+ * it lists, each with its own `Read` (of an array, its items, each read the same way; of a
+ * scalar, the scalar). An empty object needs the value but none of its fields, as `$count` does.
+ */
+export type Read = true | { [field: string]: Read };
+
+/** What an expression reads of its input and of its bindings, given by `Expression.reads()`. */
+export interface Reads {
+    /** Absent when the expression does not read its input. */
+    input?: Read;
+    /** The bindings the expression reads, by name (without the `$`). */
+    bindings: Record<string, Read>;
+    /** Set when the expression may read any binding whole, as `$eval` can: keep all bindings. */
+    everyBinding?: true;
+}
+
 // ---------------------------------------------------------------------------------------------
 // Parsing
 
@@ -360,7 +380,8 @@ export class Expression {
     evaluate(input?: unknown, bindings?: Bindings | null, options?: EvaluateOptions): unknown;
     /**
      * Like `evaluate`, with the input document and the result as JSON text. This avoids
-     * converting large documents to and from JavaScript objects.
+     * converting large documents to and from JavaScript objects. The fields of the input that the
+     * expression does not read (`reads()`) are skipped while parsing, checked as JSON syntax only.
      */
     evaluateJson(
     input?: string | null,
@@ -385,6 +406,12 @@ export class Expression {
      * `JlensError` when the signature is invalid.
      */
     registerFunction(name: string, implementation: HostFunction, signature?: string): void;
+    /**
+     * The fields of the input and of the bindings the expression reads: an input cut down to them
+     * gives the same result. The functions in `bindings`, and those registered on the expression,
+     * read only their arguments; a call to a function it does not know reads its context whole.
+     */
+    reads(bindings?: Bindings | null): Reads;
     /** The processed syntax tree, as plain objects. */
     ast(): AstNode;
     /** Releases the compiled expression. */
@@ -399,8 +426,12 @@ export class Expression {
 export class Document {
     /** Converts a JSON-compatible value. */
     constructor(input: unknown);
-    /** Parses JSON text. Throws a `TypeError` when it is not valid JSON. */
-    static fromJson(text: string): Document;
+    /**
+     * Parses JSON text. Throws a `TypeError` when it is not valid JSON. With `read` (the `input`
+     * of `reads()` or of `unionReads()`), the fields it leaves out are skipped, checked as JSON
+     * syntax only, and the document serves the expressions it comes from as the whole one would.
+     */
+    static fromJson(text: string, read?: Read | null): Document;
     free(): void;
     [Symbol.dispose](): void;
 }
@@ -433,6 +464,12 @@ export class LanguageService {
     [Symbol.dispose](): void;
 }
 
+/**
+ * What any of several expressions reads: an input cut down to the union gives each of them its
+ * result. Throws a `TypeError` when an item is not in the form `reads()` returns.
+ */
+export function unionReads(reads: Reads[]): Reads;
+
 /**
  * Infers a JSON Schema (2020-12, with `x-jlens-*` annotations) from sample documents.
  * `overrides` adds descriptions, labels, allowed values and hidden fields by path, such as
@@ -469,7 +506,7 @@ export interface InitOutput {
     readonly __wbg_document_free: (a: number, b: number) => void;
     readonly __wbg_expression_free: (a: number, b: number) => void;
     readonly __wbg_languageservice_free: (a: number, b: number) => void;
-    readonly document_fromJson: (a: number, b: number) => [number, number, number];
+    readonly document_fromJson: (a: number, b: number, c: number) => [number, number, number];
     readonly document_new: (a: any) => [number, number, number];
     readonly expression_ast: (a: number) => any;
     readonly expression_evaluate: (a: number, b: number, c: number, d: number) => [number, number, number];
@@ -477,6 +514,7 @@ export interface InitOutput {
     readonly expression_evaluateJson: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly expression_evaluateWithAudit: (a: number, b: number, c: number, d: number) => [number, number, number];
     readonly expression_new: (a: number, b: number) => [number, number, number];
+    readonly expression_reads: (a: number, b: number) => [number, number, number];
     readonly expression_registerFunction: (a: number, b: number, c: number, d: any, e: number, f: number) => [number, number];
     readonly expression_source: (a: number) => [number, number];
     readonly functions: () => any;
@@ -487,6 +525,7 @@ export interface InitOutput {
     readonly languageservice_new: (a: number, b: number, c: number) => [number, number, number];
     readonly languageservice_signatureHelp: (a: number, b: number, c: number, d: number) => any;
     readonly parseRecover: (a: number, b: number) => any;
+    readonly unionReads: (a: any) => [number, number, number];
     readonly version: () => [number, number];
     readonly wasm_bindgen_dfd3dc8039a2d669___convert__closures_____invoke___js_sys_94575574b531b35c___Array__core_37ee0ce0c4cd57d5___result__Result_wasm_bindgen_dfd3dc8039a2d669___JsValue__wasm_bindgen_dfd3dc8039a2d669___JsValue___false_: (a: number, b: number, c: any) => [number, number, number];
     readonly __wbindgen_malloc: (a: number, b: number) => number;

package/jlens.js

@@ -1,6 +1,6 @@
 /* @ts-self-types="./jlens.d.ts" */
-import { jlensCallable } from './snippets/jlens-wasm-669ebf4a414f63a3/inline0.js';
-import { jlensLevel } from './snippets/jlens-wasm-669ebf4a414f63a3/inline1.js';
+import { jlensCallable } from './snippets/jlens-wasm-b5dd6593a6f87d95/inline0.js';
+import { jlensLevel } from './snippets/jlens-wasm-b5dd6593a6f87d95/inline1.js';
 
 
 /**
@@ -25,14 +25,16 @@ export class Document {
         wasm.__wbg_document_free(ptr, 0);
     }
     /**
-     * Parses JSON text.
+     * Parses JSON text. With `read` (the `input` of a `reads()`, or of a `unionReads()`), the
+     * fields it leaves out are skipped: they are checked as JSON syntax only.
      * @param {string} text
+     * @param {any | null} [read]
      * @returns {Document}
      */
-    static fromJson(text) {
+    static fromJson(text, read) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.document_fromJson(ptr0, len0);
+        const ret = wasm.document_fromJson(ptr0, len0, isLikeNone(read) ? 0 : addToExternrefTable0(read));
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
@@ -98,7 +100,8 @@ export class Expression {
     }
     /**
      * Like `evaluate`, with the input document and the result as JSON text. This avoids
-     * converting large documents to and from JavaScript objects.
+     * converting large documents to and from JavaScript objects. The fields of the input that
+     * the expression does not read (`reads()`, without bindings) are skipped while parsing.
      * @param {string | null} [input]
      * @param {any | null} [bindings]
      * @param {any | null} [options]
@@ -169,6 +172,21 @@ export class Expression {
         ExpressionFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
+    /**
+     * The fields of the input and of the bindings the expression reads (ADR 0016). The
+     * functions in `bindings`, and those registered on the expression, read only their
+     * arguments, since a JavaScript function cannot read the context of its call; a call to a
+     * function the analysis does not know reads its context whole.
+     * @param {any | null} [bindings]
+     * @returns {any}
+     */
+    reads(bindings) {
+        const ret = wasm.expression_reads(this.__wbg_ptr, isLikeNone(bindings) ? 0 : addToExternrefTable0(bindings));
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * Makes `implementation` available to the expression as `$name`, in every evaluation. With
      * a `signature` (such as `<n-n?:n>`), arguments are checked before each call, as for
@@ -328,6 +346,20 @@ export function parseRecover(source) {
     return ret;
 }
 
+/**
+ * What any of several expressions reads: the union of their `reads()`. Throws a `TypeError`
+ * when an item is not in the form `reads()` returns.
+ * @param {any} reads
+ * @returns {any}
+ */
+export function unionReads(reads) {
+    const ret = wasm.unionReads(reads);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 /**
  * The jlens version.
  * @returns {string}
@@ -431,11 +463,11 @@ function __wbg_get_imports() {
             const ret = Array.isArray(arg0);
             return ret;
         },
-        __wbg_jlensCallable_bc242b920bd3b7cb: function(arg0, arg1) {
+        __wbg_jlensCallable_7d9ffbb6d82e5c6e: function(arg0, arg1) {
             const ret = jlensCallable(arg0, arg1 >>> 0);
             return ret;
         },
-        __wbg_jlensLevel_4984dcab128c4444: function() { return handleError(function (arg0, arg1, arg2) {
+        __wbg_jlensLevel_7fc665e0f96eeefc: function() { return handleError(function (arg0, arg1, arg2) {
             const ret = jlensLevel(arg0, arg1 >>> 0, arg2 >>> 0);
             return ret;
         }, arguments); },

package/jlens_bg.wasm.d.ts

@@ -4,7 +4,7 @@ export const memory: WebAssembly.Memory;
 export const __wbg_document_free: (a: number, b: number) => void;
 export const __wbg_expression_free: (a: number, b: number) => void;
 export const __wbg_languageservice_free: (a: number, b: number) => void;
-export const document_fromJson: (a: number, b: number) => [number, number, number];
+export const document_fromJson: (a: number, b: number, c: number) => [number, number, number];
 export const document_new: (a: any) => [number, number, number];
 export const expression_ast: (a: number) => any;
 export const expression_evaluate: (a: number, b: number, c: number, d: number) => [number, number, number];
@@ -12,6 +12,7 @@ export const expression_evaluateDocument: (a: number, b: number, c: number, d: n
 export const expression_evaluateJson: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
 export const expression_evaluateWithAudit: (a: number, b: number, c: number, d: number) => [number, number, number];
 export const expression_new: (a: number, b: number) => [number, number, number];
+export const expression_reads: (a: number, b: number) => [number, number, number];
 export const expression_registerFunction: (a: number, b: number, c: number, d: any, e: number, f: number) => [number, number];
 export const expression_source: (a: number) => [number, number];
 export const functions: () => any;
@@ -22,6 +23,7 @@ export const languageservice_hover: (a: number, b: number, c: number, d: number)
 export const languageservice_new: (a: number, b: number, c: number) => [number, number, number];
 export const languageservice_signatureHelp: (a: number, b: number, c: number, d: number) => any;
 export const parseRecover: (a: number, b: number) => any;
+export const unionReads: (a: any) => [number, number, number];
 export const version: () => [number, number];
 export const wasm_bindgen_dfd3dc8039a2d669___convert__closures_____invoke___js_sys_94575574b531b35c___Array__core_37ee0ce0c4cd57d5___result__Result_wasm_bindgen_dfd3dc8039a2d669___JsValue__wasm_bindgen_dfd3dc8039a2d669___JsValue___false_: (a: number, b: number, c: any) => [number, number, number];
 export const __wbindgen_malloc: (a: number, b: number) => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jlens-wasm",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "JSONata in WebAssembly, with evaluation audits and schema-driven autocomplete",
   "license": "MIT",
   "repository": {