@finos/legend-cube-builder 0.0.3 → 0.0.5

package/lib/stores/source-picker/CubeInlineModelTabState.d.ts

@@ -0,0 +1,203 @@
+/**
+ * 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 CubeContext, type EnteredValue, type FunctionParameter, type ModelContext, Schema } from '@finos/legend-cube';
+import { type GeneratorFn } from '@finos/legend-shared';
+import { type CubeModelOutline, type CubeOutlineDatabase, type CubeOutlineFunction, type CubeOutlineRuntime, type CubeOutlineSchema, type CubeOutlineTable } from '../../graph-manager/CubeEngine.js';
+import type { CubeEditorState } from '../CubeEditorState.js';
+import { type BundledModel } from '../LocalModelCatalog.js';
+import { type CubeSourcePickerTab, CubeSourcePickerTabKey } from './CubeSourcePickerTab.js';
+/** Whether a table can be picked: a table with a column Cube can't read can't */
+export declare const isTableSelectable: (table: CubeOutlineTable) => boolean;
+/** What the tab adds from the model: a table, or a function that returns a relation (PLAN §6.5) */
+export declare enum CubeModelReadKind {
+    TABLE = "table",
+    FUNCTION = "function"
+}
+/**
+ * A parameter's value from its text: none for empty text, whatever the type,
+ * so an optional String left empty passes `[]`, not `''`
+ */
+export declare const readCubeFunctionValue: (text: string, parameter: FunctionParameter) => EnteredValue;
+/** A function's parameters as Cube types: `[0..1]` ones optional */
+export declare const getCubeFunctionParameters: (fn: CubeOutlineFunction) => FunctionParameter[];
+/**
+ * The source picker's Model tab (PLAN §6.2.7, Settled before M1.8): model,
+ * then database, then a runtime keyed by that database, then schema and
+ * table. A step with a single choice is picked automatically. The first
+ * table fixes the cube's model and runtime; later tables come from the same
+ * database and runtime. A table is added only once its schema has resolved.
+ * It serves every cube no other tab claims, e.g. one on Pure text.
+ */
+export declare class CubeInlineModelTabState implements CubeSourcePickerTab {
+    readonly key: CubeSourcePickerTabKey;
+    readonly label: string;
+    readonly editorState: CubeEditorState;
+    model: ModelContext | undefined;
+    /** The model is Pure text the user pastes, not a bundled one */
+    isPastingModel: boolean;
+    pastedModelText: string;
+    /** The model the paste box last loaded: only it keeps the box shown */
+    private pastedModel;
+    outline: CubeModelOutline | undefined;
+    isLoadingModel: boolean;
+    databasePath: string | undefined;
+    runtimePath: string | undefined;
+    schemaName: string | undefined;
+    /** The picked tables, in the order picked; several are added at once */
+    tableNames: readonly string[];
+    tableSearch: string;
+    /** Whether the tab adds a table or a function */
+    readKind: CubeModelReadKind;
+    functionSearch: string;
+    /** The picked function's full name */
+    functionSignature: string | undefined;
+    /** The text entered for each of its parameters */
+    functionValueTexts: string[];
+    /** The runtime picked for a function that leaves it to its caller */
+    functionRuntimePath: string | undefined;
+    isResolving: boolean;
+    /** The table whose columns the tab shows under the list: the one picked last */
+    previewTableName: string | undefined;
+    /**
+     * The columns of each table previewed, or why they couldn't be read, by
+     * database, schema and table; Add takes them, so it asks the engine only
+     * for the others (the review of the demo, 2026-10-13)
+     */
+    previewSchemas: ReadonlyMap<string, Schema | string>;
+    /** Counts the model, database or runtime changes, so a late preview is dropped */
+    private previewGeneration;
+    /** The preview waiting for the clicks to pause */
+    private previewTimer;
+    /** Why the outline or the table couldn't be loaded, shown in the dialog */
+    error: string | undefined;
+    /** Counts Add presses: closing the dialog moves it on, so the pending Add is dropped */
+    private confirmRequest;
+    constructor(editorState: CubeEditorState);
+    get models(): readonly BundledModel[];
+    /** Once the cube has a model, every table comes from it */
+    get fixedContext(): CubeContext | undefined;
+    /** Once the cube has a table, every other one comes from its database */
+    get fixedDatabasePath(): string | undefined;
+    get databases(): readonly CubeOutlineDatabase[];
+    get runtimes(): readonly CubeOutlineRuntime[];
+    get schemas(): readonly CubeOutlineSchema[];
+    /** The schema's tables, views left out */
+    get schemaTables(): readonly CubeOutlineTable[];
+    /** The one picked table; none when several are */
+    get tableName(): string | undefined;
+    /** The schema's tables, views left out, filtered by the search text */
+    get tables(): readonly CubeOutlineTable[];
+    /** The model's functions that return a relation, filtered by the search text */
+    get functions(): readonly CubeOutlineFunction[];
+    get pickedFunction(): CubeOutlineFunction | undefined;
+    get functionParameters(): readonly FunctionParameter[];
+    /** The value entered for each parameter */
+    get functionValues(): readonly EnteredValue[];
+    /**
+     * The runtimes a function that leaves the runtime to its caller can run
+     * on: the cube's, once it has one, else every runtime of the model
+     */
+    get functionRuntimes(): readonly CubeOutlineRuntime[];
+    /**
+     * The runtime the picked function runs on: its own, when its body names
+     * one; else the one picked
+     */
+    get functionRuntime(): string | undefined;
+    /** Why the picked function can't be added, if it can't */
+    get functionProblem(): string | undefined;
+    /** The host serves the tab unless it offers no sample data */
+    get isAvailable(): boolean;
+    get isBusy(): boolean;
+    /** The tab claims no cube: the dialog gives it every cube no other tab claims */
+    ownsContext(context: CubeContext): boolean;
+    get canConfirm(): boolean;
+    /**
+     * When the dialog opens on the tab: on the cube's model, else the pasted
+     * model while the paste box is shown, else the bundled model picked last,
+     * else the first one. A model whose outline failed to load is loaded again.
+     */
+    open(): void;
+    /**
+     * Takes the cube's runtime once it has one, e.g. a function's (PLAN
+     * §6.5): its table and function steps can't pick another
+     */
+    protected followFixedRuntime(): void;
+    /** When the dialog closes: a table still being typed is not added */
+    close(): void;
+    /** Offers a text box for a Pure model in place of the bundled ones */
+    startPastingModel(): void;
+    setPastedModelText(text: string): void;
+    /**
+     * Loads the pasted Pure text as the model: the cube will hold the text
+     * itself, so it counts towards the size a saved cube can have
+     */
+    loadPastedModel(): GeneratorFn<void>;
+    /**
+     * Loads a model's outline. Any model but the one the paste box loaded ends
+     * pasting, e.g. a bundled model, or the model of a cube opened meanwhile.
+     */
+    selectModel(model: ModelContext): GeneratorFn<void>;
+    selectDatabase(path: string | undefined): void;
+    selectRuntime(path: string | undefined): void;
+    selectSchema(name: string | undefined): void;
+    /** Picks the table alone, in place of any picked, and previews its columns */
+    selectTable(name: string | undefined): void;
+    /** Adds the table to the picked ones, previewing it, or takes it out */
+    toggleTable(name: string): void;
+    private previewKey;
+    /** The previewed table's columns, `undefined` while they load, or why they couldn't be read */
+    get previewedColumns(): Schema | string | undefined;
+    /**
+     * Previews the table once the clicks pause, so picking several in a row
+     * asks the engine for the last only; Add, Close and another pick cancel it
+     */
+    private preview;
+    private cancelPreview;
+    /** Reads a table's columns from the engine, once a table and a model's database */
+    loadPreview(name: string): GeneratorFn<void>;
+    /** How many sources Add adds */
+    get pickedCount(): number;
+    setTableSearch(search: string): void;
+    /**
+     * What the tab reads: a model's tables or functions; a project's tables
+     * and functions each have a tab of their own (user, 2026-10-13)
+     */
+    get readKinds(): readonly CubeModelReadKind[];
+    /** Reads tables or functions, when the tab reads that kind */
+    setReadKind(kind: CubeModelReadKind): void;
+    setFunctionSearch(search: string): void;
+    /** Picks a function; its parameters start empty, and its runtime is the only one there is */
+    selectFunction(signature: string | undefined): void;
+    setFunctionValueText(index: number, text: string): void;
+    selectFunctionRuntime(path: string | undefined): void;
+    /**
+     * Types the picked table with the engine, then adds it; the first table
+     * also sets the cube's model and runtime, in the same undo step. The cube
+     * may have changed while the engine answered: the table is added only if
+     * the cube still has the same model and runtime and can take it. Gives
+     * whether the table was added.
+     */
+    confirm(): GeneratorFn<boolean>;
+    /**
+     * Types the picked function's call with the engine, then adds it with its
+     * values; the first source also sets the cube's model and runtime, in the
+     * same undo step: the function's own runtime when its body names one
+     * (PLAN §6.5). Gives whether the function was added.
+     */
+    confirmFunction(): GeneratorFn<boolean>;
+    protected resetFrom(step: 'database' | 'runtime' | 'table'): void;
+}
+//# sourceMappingURL=CubeInlineModelTabState.d.ts.map

package/lib/stores/source-picker/CubeInlineModelTabState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeInlineModelTabState.d.ts","sourceRoot":"","sources":["../../../src/stores/source-picker/CubeInlineModelTabState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EAGtB,KAAK,YAAY,EAMjB,MAAM,EACP,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAS3E,OAAO,EAIL,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACtB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAI7D,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EACL,KAAK,mBAAmB,EACxB,sBAAsB,EAGvB,MAAM,0BAA0B,CAAC;AAOlC,iFAAiF;AACjF,eAAO,MAAM,iBAAiB,GAAI,OAAO,gBAAgB,KAAG,OACV,CAAC;AAEnD,mGAAmG;AACnG,oBAAY,iBAAiB;IAC3B,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EACZ,WAAW,iBAAiB,KAC3B,YAA4E,CAAC;AAEhF,oEAAoE;AACpE,eAAO,MAAM,yBAAyB,GACpC,IAAI,mBAAmB,KACtB,iBAAiB,EAKf,CAAC;AAEN;;;;;;;GAOG;AACH,qBAAa,uBAAwB,YAAW,mBAAmB;IACjE,QAAQ,CAAC,GAAG,EAAE,sBAAsB,CAAgC;IACpE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAiB;IACvC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IAEtC,KAAK,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC,gEAAgE;IAChE,cAAc,UAAS;IACvB,eAAe,SAAM;IACrB,uEAAuE;IACvE,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACtC,cAAc,UAAS;IACvB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,wEAAwE;IACxE,UAAU,EAAE,SAAS,MAAM,EAAE,CAAM;IACnC,WAAW,SAAM;IACjB,iDAAiD;IACjD,QAAQ,oBAA2B;IACnC,cAAc,SAAM;IACpB,sCAAsC;IACtC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,kDAAkD;IAClD,kBAAkB,EAAE,MAAM,EAAE,CAAM;IAClC,qEAAqE;IACrE,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,WAAW,UAAS;IACpB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;;;OAIG;IACH,cAAc,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAa;IACjE,kFAAkF;IAClF,OAAO,CAAC,iBAAiB,CAAK;IAC9B,kDAAkD;IAClD,OAAO,CAAC,YAAY,CAA4C;IAChE,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,wFAAwF;IACxF,OAAO,CAAC,cAAc,CAAK;gBAEf,WAAW,EAAE,eAAe;IA+DxC,IAAI,MAAM,IAAI,SAAS,YAAY,EAAE,CAEpC;IAED,2DAA2D;IAC3D,IAAI,YAAY,IAAI,WAAW,GAAG,SAAS,CAE1C;IAED,yEAAyE;IACzE,IAAI,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAK1C;IAED,IAAI,SAAS,IAAI,SAAS,mBAAmB,EAAE,CAa9C;IAED,IAAI,QAAQ,IAAI,SAAS,kBAAkB,EAAE,CAQ5C;IAED,IAAI,OAAO,IAAI,SAAS,iBAAiB,EAAE,CAK1C;IAED,0CAA0C;IAC1C,IAAI,YAAY,IAAI,SAAS,gBAAgB,EAAE,CAM9C;IAED,kDAAkD;IAClD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,uEAAuE;IACvE,IAAI,MAAM,IAAI,SAAS,gBAAgB,EAAE,CAUxC;IAED,gFAAgF;IAChF,IAAI,SAAS,IAAI,SAAS,mBAAmB,EAAE,CAK9C;IAED,IAAI,cAAc,IAAI,mBAAmB,GAAG,SAAS,CAIpD;IAED,IAAI,kBAAkB,IAAI,SAAS,iBAAiB,EAAE,CAGrD;IAED,2CAA2C;IAC3C,IAAI,cAAc,IAAI,SAAS,YAAY,EAAE,CAI5C;IAED;;;OAGG;IACH,IAAI,gBAAgB,IAAI,SAAS,kBAAkB,EAAE,CAKpD;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,0DAA0D;IAC1D,IAAI,eAAe,IAAI,MAAM,GAAG,SAAS,CAcxC;IAED,8DAA8D;IAC9D,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,iFAAiF;IACjF,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;IAI1C,IAAI,UAAU,IAAI,OAAO,CA8BxB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI;IA+BZ;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAepC,qEAAqE;IACrE,KAAK,IAAI,IAAI;IAMb,sEAAsE;IACtE,iBAAiB,IAAI,IAAI;IASzB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAItC;;;OAGG;IACF,eAAe,IAAI,WAAW,CAAC,IAAI,CAAC;IAOrC;;;OAGG;IACF,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC;IA+BpD,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAa9C,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI7C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAK5C,8EAA8E;IAC9E,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAM3C,wEAAwE;IACxE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS/B,OAAO,CAAC,UAAU;IAIlB,+FAA+F;IAC/F,IAAI,gBAAgB,IAAI,MAAM,GAAG,MAAM,GAAG,SAAS,CAKlD;IAED;;;OAGG;IACH,OAAO,CAAC,OAAO;IAaf,OAAO,CAAC,aAAa;IAOrB,mFAAmF;IAClF,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC;IAuC7C,gCAAgC;IAChC,IAAI,WAAW,IAAI,MAAM,CAIxB;IAED,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,iBAAiB,EAAE,CAE5C;IAED,8DAA8D;IAC9D,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAO1C,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIvC,6FAA6F;IAC7F,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAYnD,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAMvD,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAIrD;;;;;;OAMG;IACF,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC;IAsIhC;;;;;OAKG;IACF,eAAe,IAAI,WAAW,CAAC,OAAO,CAAC;IAsExC,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI;CAoBlE"}