jlens-wasm 0.28.0 → 0.30.0

package/README.md

@@ -35,6 +35,7 @@ expr.evaluate({ items: [{ type: "a", price: 2.5, qty: 4 }] }, { kind: "a" }); //
 | `expr.ast()` | The processed syntax tree |
 | `parseRecover(source)` | Partial syntax tree and every diagnostic, without throwing |
 | `inferSchema(samples, overrides?)` | A JSON Schema (2020-12) inferred from sample documents |
+| `missingOverridePaths(samples, overrides)` | The override paths the samples lack, with the path each most likely meant |
 | `new LanguageService(schema?, variables?)` | `complete`, `diagnostics`, `hover` and `signatureHelp` for an editor |
 | `functions()` | The built-in function catalog |
 | `version()` | The jlens version |

package/jlens.d.ts

@@ -300,12 +300,19 @@ export interface SchemaOverride {
     /** Hide from completion. */
     hidden?: boolean;
     enum?: unknown[];
+    /**
+     * An open domain: an identifier the application fetches the values of (in JSON Schema,
+     * `x-jlens-domain`). Completion returns a `valueRequest` for it.
+     */
+    domain?: string;
     format?: string;
-    type?: JsonType[];
+    /** Replaces the inferred types: one name, or a list for a union, as in JSON Schema. */
+    type?: JsonType | JsonType[];
     examples?: unknown[];
 }
 
-export type CompletionKind = "field" | "variable" | "function" | "keyword" | "operator";
+/** `value`: a value of the `enum` or `const` of the left-hand side of `=`, `!=` or `in`. */
+export type CompletionKind = "field" | "variable" | "function" | "keyword" | "operator" | "value";
 
 export interface CompletionItem {
     label: string;
@@ -319,10 +326,48 @@ export interface CompletionItem {
 }
 
 export interface Completions {
-    /** The range the chosen item replaces (the word under the cursor). */
+    /** The range the chosen item replaces (the word under the cursor, or the whole string literal). */
     range: Span;
     /** Best first. */
     items: CompletionItem[];
+    /**
+     * Present where a value of an open domain (`x-jlens-domain`) completes the expression: the
+     * application fetches the domain's values and offers them beside `items`.
+     */
+    valueRequest?: ValueRequest;
+}
+
+/** A request for the values of an open domain, at the right of `=`, `!=` or `in`. */
+export interface ValueRequest {
+    /** The domain's identifier, as the schema declares it. */
+    domain: string;
+    /** The left-hand side's path in the schema, such as `items[].type`; absent for a variable. */
+    path?: string;
+    /** What is typed so far: the word, or a string literal's text up to the cursor (as written). */
+    prefix: string;
+    /** The range a value replaces: the same as `Completions.range`. */
+    range: Span;
+    /** The quote to write a string value with (pass it to `valueLiteral`). */
+    quote: '"' | "'";
+    /**
+     * The fields fixed to literals beside the value, in the order written: the comparisons joined
+     * to this one by `and` within the same predicate (or, outside any, the whole expression). A
+     * domain whose values depend on another value reads it here, such as the group of
+     * `categories[group = 'X' and subgroup = '|']`.
+     */
+    conditions: ValueCondition[];
+    /** Whether the value is an element of the array on the right of `in`: several may be inserted. */
+    inArray: boolean;
+    /** The literals already in that array, not to offer again; empty outside an array. */
+    listed: unknown[];
+}
+
+/** A field compared with literals beside a requested value, by `=` or `in`. */
+export interface ValueCondition {
+    /** The field's path in the schema, as `ValueRequest.path` writes it. */
+    path: string;
+    /** The literal it is compared with, or those of the array it is in. */
+    values: unknown[];
 }
 
 export interface Hover {
@@ -494,6 +539,32 @@ samples: unknown[],
 overrides?: Record<string, SchemaOverride>,
 ): JsonSchema;
 
+/** An override path the samples lack (see `missingOverridePaths`). */
+export interface MissingOverridePath {
+    /** The path, as the overrides wrote it. */
+    path: string;
+    /** An existing path it most likely meant, such as `items[].type` for `items.type`. */
+    suggestion?: string;
+}
+
+/**
+ * The paths of `overrides` that the samples lack, in path order: the fields `inferSchema`
+ * declares for them. A field may be declared on purpose, but a misspelt path does the same, so
+ * show them as warnings. Throws as `inferSchema` does for invalid samples or overrides; malformed
+ * paths are left out.
+ */
+export function missingOverridePaths(
+samples: unknown[],
+overrides: Record<string, SchemaOverride>,
+): MissingOverridePath[];
+
+/**
+ * `value` as a JSONata literal, to insert in place of a `ValueRequest`'s range: a string in
+ * `quote` when it can be, other values as JSON. Throws a `TypeError` for another quote, or a value
+ * without a JSON form (`undefined`, a function).
+ */
+export function valueLiteral(value: unknown, quote?: '"' | "'"): string;
+
 
 
 /**
@@ -537,8 +608,10 @@ export interface InitOutput {
     readonly languageservice_hover: (a: number, b: number, c: number, d: number) => any;
     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 missingOverridePaths: (a: any, b: any) => [number, number, number];
     readonly parseRecover: (a: number, b: number) => any;
     readonly unionReads: (a: any) => [number, number, number];
+    readonly valueLiteral: (a: any, b: number, c: number) => [number, number, number, number];
     readonly version: () => [number, number];
     readonly wasm_bindgen_b2e20306cf4cf84c___convert__closures_____invoke___js_sys_a01820d46f63e2f4___Array__core_37ee0ce0c4cd57d5___result__Result_wasm_bindgen_b2e20306cf4cf84c___JsValue__wasm_bindgen_b2e20306cf4cf84c___JsValue___false_: (a: number, b: number, c: any) => [number, number, number];
     readonly __wbindgen_malloc: (a: number, b: number) => number;