@finos/legend-cube-builder 0.0.5 → 0.0.6

package/lib/stores/variant/CubeJson.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** A JSON value, numbers kept as written and keys in their order */
+export type CubeJsonNode = {
+    readonly kind: 'object';
+    readonly entries: readonly (readonly [string, CubeJsonNode])[];
+} | {
+    readonly kind: 'array';
+    readonly items: readonly CubeJsonNode[];
+} | {
+    readonly kind: 'number';
+    readonly text: string;
+} | {
+    readonly kind: 'string';
+    readonly value: string;
+} | {
+    readonly kind: 'boolean';
+    readonly value: boolean;
+} | {
+    readonly kind: 'null';
+};
+/** A JSON document; throws a `SyntaxError` on text that isn't one */
+export declare const parseCubeJson: (text: string) => CubeJsonNode;
+/** The document, or `undefined` for text that isn't JSON */
+export declare const readCubeJson: (text: string) => CubeJsonNode | undefined;
+/**
+ * A Variant cell on one line, for the eye (PLAN §11.20, as legend-lite's
+ * Data Cube shows one): `{name: ann, tier: gold}`, `[a, b]`, numbers as
+ * written. Text that isn't JSON is shown as it is; the value itself stays the
+ * JSON text, for copying and export.
+ */
+export declare const formatCubeJsonLine: (text: string) => string;
+/** The document as JSON, indented two spaces, numbers as written */
+export declare const formatCubeJsonPretty: (node: CubeJsonNode, depth?: number) => string;
+//# sourceMappingURL=CubeJson.d.ts.map

package/lib/stores/variant/CubeJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeJson.d.ts","sourceRoot":"","sources":["../../../src/stores/variant/CubeJson.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAOH,oEAAoE;AACpE,MAAM,MAAM,YAAY,GACpB;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;CAChE,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,GACnE;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GACrD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAK9B,qEAAqE;AACrE,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,YAyG5C,CAAC;AAEF,4DAA4D;AAC5D,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,YAAY,GAAG,SAM1D,CAAC;AAmCF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,KAAG,MAGjD,CAAC;AAEF,oEAAoE;AACpE,eAAO,MAAM,oBAAoB,GAAI,MAAM,YAAY,EAAE,cAAS,KAAG,MA8BpE,CAAC"}

package/lib/stores/variant/CubeJson.js

@@ -0,0 +1,207 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const WHITESPACE = new Set([' ', '\t', '\n', '\r']);
+const NUMBER = /-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?/uy;
+/** A JSON document; throws a `SyntaxError` on text that isn't one */
+export const parseCubeJson = (text) => {
+    let at = 0;
+    const fail = (what) => {
+        throw new SyntaxError(`${what} at ${at} in JSON`);
+    };
+    const skipWhitespace = () => {
+        while (at < text.length && WHITESPACE.has(text.charAt(at))) {
+            at += 1;
+        }
+    };
+    const readString = () => {
+        const start = at;
+        at += 1;
+        while (at < text.length && text.charAt(at) !== '"') {
+            at += text.charAt(at) === '\\' ? 2 : 1;
+        }
+        if (at >= text.length) {
+            fail('An unterminated string');
+        }
+        at += 1;
+        // a string loses nothing through JSON.parse: only numbers do
+        return JSON.parse(text.slice(start, at));
+    };
+    const readValue = () => {
+        skipWhitespace();
+        const char = text.charAt(at);
+        if (char === '{') {
+            at += 1;
+            const entries = [];
+            skipWhitespace();
+            if (text.charAt(at) === '}') {
+                at += 1;
+                return { kind: 'object', entries };
+            }
+            for (;;) {
+                skipWhitespace();
+                if (text.charAt(at) !== '"') {
+                    fail('A key expected');
+                }
+                const key = readString();
+                skipWhitespace();
+                if (text.charAt(at) !== ':') {
+                    fail('":" expected');
+                }
+                at += 1;
+                entries.push([key, readValue()]);
+                skipWhitespace();
+                if (text.charAt(at) === ',') {
+                    at += 1;
+                }
+                else if (text.charAt(at) === '}') {
+                    at += 1;
+                    return { kind: 'object', entries };
+                }
+                else {
+                    fail('"," or "}" expected');
+                }
+            }
+        }
+        if (char === '[') {
+            at += 1;
+            const items = [];
+            skipWhitespace();
+            if (text.charAt(at) === ']') {
+                at += 1;
+                return { kind: 'array', items };
+            }
+            for (;;) {
+                items.push(readValue());
+                skipWhitespace();
+                if (text.charAt(at) === ',') {
+                    at += 1;
+                }
+                else if (text.charAt(at) === ']') {
+                    at += 1;
+                    return { kind: 'array', items };
+                }
+                else {
+                    fail('"," or "]" expected');
+                }
+            }
+        }
+        if (char === '"') {
+            return { kind: 'string', value: readString() };
+        }
+        for (const [word, node] of [
+            ['true', { kind: 'boolean', value: true }],
+            ['false', { kind: 'boolean', value: false }],
+            ['null', { kind: 'null' }],
+        ]) {
+            if (text.startsWith(word, at)) {
+                at += word.length;
+                return node;
+            }
+        }
+        NUMBER.lastIndex = at;
+        const number = NUMBER.exec(text);
+        if (!number) {
+            return fail('A value expected');
+        }
+        at += number[0].length;
+        return { kind: 'number', text: number[0] };
+    };
+    const value = readValue();
+    skipWhitespace();
+    if (at < text.length) {
+        fail('Text after the value');
+    }
+    return value;
+};
+/** The document, or `undefined` for text that isn't JSON */
+export const readCubeJson = (text) => {
+    try {
+        return parseCubeJson(text);
+    }
+    catch {
+        return undefined;
+    }
+};
+/**
+ * A key or a string shown bare when it can't be mistaken for anything else:
+ * not empty, none of the notation's punctuation or a line break, no space at
+ * either end, and not a number, `true`, `false` or `null`; JSON-quoted
+ * otherwise
+ */
+const showText = (text) => text !== '' &&
+    !/[,:{}[\]"\n\r\t]/u.test(text) &&
+    text === text.trim() &&
+    !/^(?:true|false|null|-?\d.*)$/u.test(text)
+    ? text
+    : JSON.stringify(text);
+const showNode = (node) => {
+    switch (node.kind) {
+        case 'object':
+            return `{${node.entries.map(([key, value]) => `${showText(key)}: ${showNode(value)}`).join(', ')}}`;
+        case 'array':
+            return `[${node.items.map(showNode).join(', ')}]`;
+        case 'string':
+            return showText(node.value);
+        case 'number':
+            return node.text;
+        case 'boolean':
+            return String(node.value);
+        case 'null':
+            return 'null';
+        default:
+            return '';
+    }
+};
+/**
+ * A Variant cell on one line, for the eye (PLAN §11.20, as legend-lite's
+ * Data Cube shows one): `{name: ann, tier: gold}`, `[a, b]`, numbers as
+ * written. Text that isn't JSON is shown as it is; the value itself stays the
+ * JSON text, for copying and export.
+ */
+export const formatCubeJsonLine = (text) => {
+    const node = readCubeJson(text);
+    return node ? showNode(node) : text;
+};
+/** The document as JSON, indented two spaces, numbers as written */
+export const formatCubeJsonPretty = (node, depth = 0) => {
+    const indent = '  '.repeat(depth + 1);
+    const closing = '  '.repeat(depth);
+    switch (node.kind) {
+        case 'object':
+            return node.entries.length === 0
+                ? '{}'
+                : `{\n${node.entries
+                    .map(([key, value]) => `${indent}${JSON.stringify(key)}: ${formatCubeJsonPretty(value, depth + 1)}`)
+                    .join(',\n')}\n${closing}}`;
+        case 'array':
+            return node.items.length === 0
+                ? '[]'
+                : `[\n${node.items
+                    .map((item) => `${indent}${formatCubeJsonPretty(item, depth + 1)}`)
+                    .join(',\n')}\n${closing}]`;
+        case 'string':
+            return JSON.stringify(node.value);
+        case 'number':
+            return node.text;
+        case 'boolean':
+            return String(node.value);
+        case 'null':
+            return 'null';
+        default:
+            return '';
+    }
+};
+//# sourceMappingURL=CubeJson.js.map

package/lib/stores/variant/CubeJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeJson.js","sourceRoot":"","sources":["../../../src/stores/variant/CubeJson.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAmBH,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACpD,MAAM,MAAM,GAAG,+CAA+C,CAAC;AAE/D,qEAAqE;AACrE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAgB,EAAE;IAC1D,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,MAAM,IAAI,GAAG,CAAC,IAAY,EAAS,EAAE;QACnC,MAAM,IAAI,WAAW,CAAC,GAAG,IAAI,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC,CAAC;IACF,MAAM,cAAc,GAAG,GAAS,EAAE;QAChC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3D,EAAE,IAAI,CAAC,CAAC;QACV,CAAC;IACH,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,GAAW,EAAE;QAC9B,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,EAAE,IAAI,CAAC,CAAC;QACR,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;YACnD,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACjC,CAAC;QACD,EAAE,IAAI,CAAC,CAAC;QACR,6DAA6D;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAW,CAAC;IACrD,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,GAAiB,EAAE;QACnC,cAAc,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,EAAE,IAAI,CAAC,CAAC;YACR,MAAM,OAAO,GAAwC,EAAE,CAAC;YACxD,cAAc,EAAE,CAAC;YACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;gBAC5B,EAAE,IAAI,CAAC,CAAC;gBACR,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACrC,CAAC;YACD,SAAS,CAAC;gBACR,cAAc,EAAE,CAAC;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBAC5B,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACzB,CAAC;gBACD,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;gBACzB,cAAc,EAAE,CAAC;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBAC5B,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvB,CAAC;gBACD,EAAE,IAAI,CAAC,CAAC;gBACR,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;gBACjC,cAAc,EAAE,CAAC;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBAC5B,EAAE,IAAI,CAAC,CAAC;gBACV,CAAC;qBAAM,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBACnC,EAAE,IAAI,CAAC,CAAC;oBACR,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,EAAE,IAAI,CAAC,CAAC;YACR,MAAM,KAAK,GAAmB,EAAE,CAAC;YACjC,cAAc,EAAE,CAAC;YACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;gBAC5B,EAAE,IAAI,CAAC,CAAC;gBACR,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAClC,CAAC;YACD,SAAS,CAAC;gBACR,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;gBACxB,cAAc,EAAE,CAAC;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBAC5B,EAAE,IAAI,CAAC,CAAC;gBACV,CAAC;qBAAM,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC;oBACnC,EAAE,IAAI,CAAC,CAAC;oBACR,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC;QACjD,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI;YACzB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YAC1C,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC5C,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;SAClB,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC9B,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC;gBAClB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClC,CAAC;QACD,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,cAAc,EAAE,CAAC;IACjB,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAA4B,EAAE;IACrE,IAAI,CAAC;QACH,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CACxC,IAAI,KAAK,EAAE;IACX,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;IAC/B,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;IACpB,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC;IACzC,CAAC,CAAC,IAAI;IACN,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAE3B,MAAM,QAAQ,GAAG,CAAC,IAAkB,EAAU,EAAE;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACtG,KAAK,OAAO;YACV,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACpD,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9B,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAU,EAAE;IACzD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACtC,CAAC,CAAC;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAkB,EAAE,KAAK,GAAG,CAAC,EAAU,EAAE;IAC5E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;gBAC9B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO;qBACf,GAAG,CACF,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,GAAG,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAC/E;qBACA,IAAI,CAAC,KAAK,CAAC,KAAK,OAAO,GAAG,CAAC;QACpC,KAAK,OAAO;YACV,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBAC5B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK;qBACb,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,oBAAoB,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;qBAClE,IAAI,CAAC,KAAK,CAAC,KAAK,OAAO,GAAG,CAAC;QACpC,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}

package/lib/stores/variant/CubeJsonExplorerState.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type SchemaColumn } from '@finos/legend-cube';
+import { type GeneratorFn } from '@finos/legend-shared';
+import type { CubeEditorState } from '../CubeEditorState.js';
+import { type CubeJsonField, type CubeJsonOffer } from './CubeJsonOffers.js';
+import type { CubeJsonSample } from './CubeJsonShape.js';
+/**
+ * Explore JSON (PLAN §11.20): a Variant column's documents, sampled through
+ * the cube's own query path (the query up to the node that ran, the column
+ * alone, its non-empty values), so the sample is listed in Runs and can be
+ * stopped; their fields as a tree; and the offers ticked, added after the
+ * node that ran as one undo step: an Extend of the columns, then an Explode
+ * Array for one row per element of an array. The engine parses each column's
+ * text first; the background check types the Extend, as any typed in the
+ * editor.
+ */
+export declare class CubeJsonExplorerState {
+    readonly editorState: CubeEditorState;
+    /** The column explored; `undefined` while closed */
+    column: SchemaColumn | undefined;
+    /** What was read: the first values, or every row */
+    sample: CubeJsonSample | undefined;
+    isReading: boolean;
+    isAdding: boolean;
+    /** Why the column couldn't be read, or the columns added */
+    error: string | undefined;
+    search: string;
+    /** The field whose offers show */
+    selectedPath: readonly string[];
+    /** The ticked offers, by field and key */
+    ticked: Map<string, CubeJsonOffer>;
+    /** The cube as it was when the dialog opened, and the node that ran */
+    private document;
+    private afterId;
+    private controller;
+    constructor(editorState: CubeEditorState);
+    get isOpen(): boolean;
+    /** The column's fields, from what was read */
+    get fields(): CubeJsonField | undefined;
+    get selectedField(): CubeJsonField | undefined;
+    /** The offers ticked, in the order ticked */
+    get tickedOffers(): CubeJsonOffer[];
+    isTicked(path: readonly string[], offer: CubeJsonOffer): boolean;
+    /**
+     * Why Explore JSON can't be used on the column now: the grid's blockers
+     * (stale rows, edits, a run, a read-only cube), or a database without
+     * JSON; `undefined` when it can
+     */
+    getDisabledReason(): string | undefined;
+    /** Opens the dialog on a column of the rows shown, and reads its first values */
+    open(column: SchemaColumn): GeneratorFn<void>;
+    /** Reads the column's first values, or every row: either replaces what was read */
+    read(everyRow: boolean): GeneratorFn<void>;
+    /** Stops a read in flight, keeping what was read before it */
+    stop(): void;
+    setSearch(search: string): void;
+    select(path: readonly string[]): void;
+    /**
+     * Ticks or unticks an offer. One row per element can be ticked for one
+     * array at a time: two would give a row for each pair of their elements.
+     */
+    toggle(path: readonly string[], offer: CubeJsonOffer): void;
+    /**
+     * Adds the ticked offers after the node that ran, one undo step: an Extend
+     * of the columns, each under its default name or the next free one, then
+     * an Explode Array for the array ticked for one row per element, its
+     * element named the same way. The engine parses each column's text first,
+     * and the dialog stays open with the error if it can't. Nothing is added if
+     * the cube changed meanwhile.
+     */
+    add(): GeneratorFn<void>;
+    close(): void;
+}
+//# sourceMappingURL=CubeJsonExplorerState.d.ts.map

package/lib/stores/variant/CubeJsonExplorerState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeJsonExplorerState.d.ts","sourceRoot":"","sources":["../../../src/stores/variant/CubeJsonExplorerState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAOL,KAAK,YAAY,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAa3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAG7D,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,aAAa,EAGnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AASzD;;;;;;;;;GASG;AACH,qBAAa,qBAAqB;IAChC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IAEtC,oDAAoD;IACpD,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,oDAAoD;IACpD,MAAM,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC,SAAS,UAAS;IAClB,QAAQ,UAAS;IACjB,4DAA4D;IAC5D,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,SAAM;IACZ,kCAAkC;IAClC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAM;IACrC,0CAA0C;IAC1C,MAAM,6BAAoC;IAE1C,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,UAAU,CAA8B;gBAEpC,WAAW,EAAE,eAAe;IA4BxC,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,8CAA8C;IAC9C,IAAI,MAAM,IAAI,aAAa,GAAG,SAAS,CAItC;IAED,IAAI,aAAa,IAAI,aAAa,GAAG,SAAS,CAU7C;IAED,6CAA6C;IAC7C,IAAI,YAAY,IAAI,aAAa,EAAE,CAElC;IAED,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,GAAG,OAAO;IAIhE;;;;OAIG;IACH,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAoBvC,iFAAiF;IAChF,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC;IAkC9C,mFAAmF;IAClF,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC;IA6C3C,8DAA8D;IAC9D,IAAI,IAAI,IAAI;IAMZ,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/B,MAAM,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAIrC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAgB3D;;;;;;;OAOG;IACF,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC;IAoEzB,KAAK,IAAI,IAAI;CAWd"}

package/lib/stores/variant/CubeJsonExplorerState.js

@@ -0,0 +1,297 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Explode, Extend, getVariantDatabaseProblem, } from '@finos/legend-cube';
+import { assertErrorThrown } from '@finos/legend-shared';
+import { action, computed, flow, flowResult, makeObservable, observable, } from 'mobx';
+import { CubeEngineError, } from '../../graph-manager/CubeEngine.js';
+import { getCubeGridActionBlocker } from '../CubeGridQuickActions.js';
+import { CubeQueryRunAborted } from '../CubeQueryRun.js';
+import { getCubeJsonFields, getFreeCubeColumnName, } from './CubeJsonOffers.js';
+import { readCubeJsonSample } from './CubeJsonSampling.js';
+/** A field's path as one key, for ticking */
+const pathKey = (path) => JSON.stringify(path);
+/** A ticked offer, by its field and its key */
+const offerKey = (path, offer) => `${pathKey(path)} ${offer.key}`;
+/**
+ * Explore JSON (PLAN §11.20): a Variant column's documents, sampled through
+ * the cube's own query path (the query up to the node that ran, the column
+ * alone, its non-empty values), so the sample is listed in Runs and can be
+ * stopped; their fields as a tree; and the offers ticked, added after the
+ * node that ran as one undo step: an Extend of the columns, then an Explode
+ * Array for one row per element of an array. The engine parses each column's
+ * text first; the background check types the Extend, as any typed in the
+ * editor.
+ */
+export class CubeJsonExplorerState {
+    editorState;
+    /** The column explored; `undefined` while closed */
+    column;
+    /** What was read: the first values, or every row */
+    sample;
+    isReading = false;
+    isAdding = false;
+    /** Why the column couldn't be read, or the columns added */
+    error;
+    search = '';
+    /** The field whose offers show */
+    selectedPath = [];
+    /** The ticked offers, by field and key */
+    ticked = new Map();
+    /** The cube as it was when the dialog opened, and the node that ran */
+    document;
+    afterId;
+    controller;
+    constructor(editorState) {
+        makeObservable(this, {
+            column: observable.ref,
+            sample: observable.ref,
+            isReading: observable,
+            isAdding: observable,
+            error: observable,
+            search: observable,
+            selectedPath: observable.ref,
+            ticked: observable.shallow,
+            document: observable.ref,
+            afterId: observable,
+            isOpen: computed,
+            fields: computed,
+            selectedField: computed,
+            tickedOffers: computed,
+            open: flow,
+            read: flow,
+            add: flow,
+            stop: action,
+            close: action,
+            setSearch: action,
+            select: action,
+            toggle: action,
+        });
+        this.editorState = editorState;
+    }
+    get isOpen() {
+        return this.column !== undefined;
+    }
+    /** The column's fields, from what was read */
+    get fields() {
+        return this.column && this.sample
+            ? getCubeJsonFields(this.column.name, this.sample)
+            : undefined;
+    }
+    get selectedField() {
+        const key = pathKey(this.selectedPath);
+        const find = (field) => pathKey(field.path) === key
+            ? field
+            : field.children.reduce((found, child) => found ?? find(child), undefined);
+        return this.fields ? find(this.fields) : undefined;
+    }
+    /** The offers ticked, in the order ticked */
+    get tickedOffers() {
+        return [...this.ticked.values()];
+    }
+    isTicked(path, offer) {
+        return this.ticked.has(offerKey(path, offer));
+    }
+    /**
+     * Why Explore JSON can't be used on the column now: the grid's blockers
+     * (stale rows, edits, a run, a read-only cube), or a database without
+     * JSON; `undefined` when it can
+     */
+    getDisabledReason() {
+        const { editorState } = this;
+        const blocker = getCubeGridActionBlocker(editorState);
+        if (blocker) {
+            return blocker;
+        }
+        const { context, query } = editorState.document;
+        const nodeId = query.selected;
+        return context?.runtime === undefined || nodeId === undefined
+            ? undefined
+            : getVariantDatabaseProblem(editorState.getRunDatabaseType(query, nodeId, context.model, context.runtime));
+    }
+    /** Opens the dialog on a column of the rows shown, and reads its first values */
+    *open(column) {
+        const { editorState } = this;
+        const { document } = editorState;
+        this.stop();
+        this.column = column;
+        this.document = document;
+        this.afterId = document.query.selected;
+        this.sample = undefined;
+        this.error = undefined;
+        this.search = '';
+        this.selectedPath = [];
+        this.ticked.clear();
+        // the database the column's rows run on, which must read JSON: its
+        // model's outline may not have been needed by the run that showed them
+        const context = document.context;
+        const nodeId = this.afterId;
+        if (context?.runtime !== undefined && nodeId !== undefined) {
+            yield flowResult(editorState.loadModelOutline(context.model));
+            const problem = getVariantDatabaseProblem(editorState.getRunDatabaseType(document.query, nodeId, context.model, context.runtime));
+            if (problem) {
+                this.error = problem;
+                return;
+            }
+        }
+        yield flowResult(this.read(false));
+    }
+    /** Reads the column's first values, or every row: either replaces what was read */
+    *read(everyRow) {
+        const { editorState, column, document, afterId } = this;
+        if (!column ||
+            !document ||
+            afterId === undefined ||
+            document.context?.runtime === undefined ||
+            this.isReading) {
+            return;
+        }
+        const controller = new AbortController();
+        this.controller = controller;
+        this.isReading = true;
+        this.error = undefined;
+        try {
+            const sample = (yield readCubeJsonSample(editorState, {
+                document,
+                afterId,
+                column,
+                everyRow,
+                abortController: controller,
+            }));
+            if (this.controller !== controller) {
+                return;
+            }
+            this.sample = sample;
+        }
+        catch (error) {
+            if (this.controller !== controller ||
+                error instanceof CubeQueryRunAborted) {
+                return;
+            }
+            assertErrorThrown(error);
+            this.error =
+                error instanceof CubeEngineError ? error.firstLine : error.message;
+        }
+        finally {
+            if (this.controller === controller) {
+                this.controller = undefined;
+                this.isReading = false;
+            }
+        }
+    }
+    /** Stops a read in flight, keeping what was read before it */
+    stop() {
+        this.controller?.abort();
+        this.controller = undefined;
+        this.isReading = false;
+    }
+    setSearch(search) {
+        this.search = search;
+    }
+    select(path) {
+        this.selectedPath = path;
+    }
+    /**
+     * Ticks or unticks an offer. One row per element can be ticked for one
+     * array at a time: two would give a row for each pair of their elements.
+     */
+    toggle(path, offer) {
+        const key = offerKey(path, offer);
+        if (this.ticked.has(key)) {
+            this.ticked.delete(key);
+            return;
+        }
+        if (offer.explode) {
+            [...this.ticked].forEach(([other, ticked]) => {
+                if (ticked.explode) {
+                    this.ticked.delete(other);
+                }
+            });
+        }
+        this.ticked.set(key, offer);
+    }
+    /**
+     * Adds the ticked offers after the node that ran, one undo step: an Extend
+     * of the columns, each under its default name or the next free one, then
+     * an Explode Array for the array ticked for one row per element, its
+     * element named the same way. The engine parses each column's text first,
+     * and the dialog stays open with the error if it can't. Nothing is added if
+     * the cube changed meanwhile.
+     */
+    *add() {
+        const { editorState, document, afterId } = this;
+        const ticked = this.tickedOffers;
+        const offers = ticked.filter((offer) => offer.code !== undefined);
+        const exploded = ticked.find((offer) => offer.explode !== undefined);
+        if (!document ||
+            afterId === undefined ||
+            (!offers.length && !exploded) ||
+            this.isAdding ||
+            editorState.document !== document) {
+            return;
+        }
+        this.isAdding = true;
+        this.error = undefined;
+        try {
+            const { query } = document;
+            const extendId = query.generateId(Extend.TYPE);
+            const taken = (editorState.analysis.schemas.get(afterId)?.columns ?? []).map((column) => column.name);
+            const columns = [];
+            for (const [index, offer] of offers.entries()) {
+                const name = getFreeCubeColumnName(offer.name, [
+                    ...taken,
+                    ...columns.map((column) => column.name),
+                ]);
+                const parsed = (yield editorState.host.engine.parseExpression(offer.code, `${extendId}:${index}`));
+                columns.push({ name, code: offer.code, lambda: parsed.lambda });
+            }
+            // as the dialog found it: nothing changed while the engine parsed
+            if (editorState.document !== document) {
+                return;
+            }
+            const nodes = columns.length
+                ? [new Extend(extendId, columns)]
+                : [];
+            if (exploded?.explode) {
+                nodes.push(new Explode(query.generateId(Explode.TYPE), exploded.explode.column, exploded.explode.path, getFreeCubeColumnName(exploded.name, [
+                    ...taken,
+                    ...columns.map((column) => column.name),
+                ])));
+            }
+            editorState.addConfiguredNodes(nodes, afterId);
+            this.close();
+        }
+        catch (error) {
+            assertErrorThrown(error);
+            this.error =
+                error instanceof CubeEngineError ? error.firstLine : error.message;
+        }
+        finally {
+            this.isAdding = false;
+        }
+    }
+    close() {
+        this.stop();
+        this.column = undefined;
+        this.sample = undefined;
+        this.document = undefined;
+        this.afterId = undefined;
+        this.error = undefined;
+        this.search = '';
+        this.selectedPath = [];
+        this.ticked.clear();
+    }
+}
+//# sourceMappingURL=CubeJsonExplorerState.js.map