@finos/legend-cube-builder 0.0.2 → 0.0.3

package/src/stores/editors/CubeSliceDraft.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { Slice } from '@finos/legend-cube';
+import { action, makeObservable, observable } from 'mobx';
+import { parseWholeNumberText } from './CubeIntegerText.js';
+import { CubeNodeDraft } from './CubeNodeDraft.js';
+
+const textOf = (value: number | undefined): string =>
+  value === undefined ? '' : String(value);
+
+/**
+ * The Slice editor's draft (spec §17.6: start and stop integer fields). It
+ * keeps the texts as typed; a text that isn't a whole number builds a
+ * cleared bound, which the node reports, never the default (spec §7.9). A
+ * field that holds the text it opened with keeps its saved bound, so a bound
+ * the field can't read (`1.5` from an imported spec) is kept unless the user
+ * types something else in that field.
+ */
+export class CubeSliceDraft extends CubeNodeDraft<Slice> {
+  startText: string;
+  stopText: string;
+  /** The texts the fields opened with, which keep the saved bounds */
+  private readonly initialStartText: string;
+  private readonly initialStopText: string;
+
+  constructor(original: Slice) {
+    super(original);
+    makeObservable(this, {
+      startText: observable,
+      stopText: observable,
+      setStartText: action,
+      setStopText: action,
+    });
+    this.initialStartText = textOf(original.start);
+    this.initialStopText = textOf(original.stop);
+    this.startText = this.initialStartText;
+    this.stopText = this.initialStopText;
+  }
+
+  /** The start the text gives: `undefined` unless it is a whole number */
+  get start(): number | undefined {
+    return parseWholeNumberText(this.startText);
+  }
+
+  /** The stop the text gives: `undefined` unless it is a whole number */
+  get stop(): number | undefined {
+    return parseWholeNumberText(this.stopText);
+  }
+
+  setStartText(text: string): void {
+    this.startText = text;
+  }
+
+  setStopText(text: string): void {
+    this.stopText = text;
+  }
+
+  /** The original while each field holds its opening text or the same bound */
+  build(): Slice {
+    const { original, start, stop } = this;
+    const keepStart =
+      this.startText.trim() === this.initialStartText ||
+      start === original.start;
+    const keepStop =
+      this.stopText.trim() === this.initialStopText || stop === original.stop;
+    return keepStart && keepStop
+      ? original
+      : original.withRange(
+          keepStart ? original.start : start,
+          keepStop ? original.stop : stop,
+        );
+  }
+}

package/src/stores/editors/CubeSortDraft.ts

@@ -0,0 +1,135 @@
+/**
+ * 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 ColumnDirection,
+  type Sort,
+  SortDirection,
+} from '@finos/legend-cube';
+import { action, makeObservable, observable } from 'mobx';
+import { CubeNodeDraft } from './CubeNodeDraft.js';
+
+/** One row of the Sort editor: a column, `''` until picked, and its direction */
+export interface CubeSortRow {
+  /** Identifies the row in the editor */
+  readonly key: number;
+  readonly column: string;
+  readonly direction: SortDirection;
+}
+
+let nextRowKey = 1;
+
+const blankRow = (): CubeSortRow => ({
+  key: nextRowKey++,
+  column: '',
+  direction: SortDirection.ASC,
+});
+
+const isSameSorts = (
+  a: readonly ColumnDirection[],
+  b: readonly ColumnDirection[],
+): boolean =>
+  a.length === b.length &&
+  a.every(
+    (sort, index) =>
+      sort.column === b[index]?.column &&
+      sort.direction === b[index]?.direction,
+  );
+
+/**
+ * The Sort editor's draft (spec §17.6: a list of column and direction rows,
+ * most significant first). A row without a column is left out when built, as
+ * a Rename's blank rows are. While the rows are the ones it opened with, the
+ * original is given back, so a saved key without a column (from an imported
+ * spec) is kept until the rows change; removing its row removes it.
+ */
+export class CubeSortDraft extends CubeNodeDraft<Sort> {
+  rows: readonly CubeSortRow[];
+  /** The rows' keys when the editor opened, blank ones included */
+  private readonly initialKeys: readonly ColumnDirection[];
+
+  constructor(original: Sort) {
+    super(original);
+    makeObservable(this, {
+      rows: observable.ref,
+      addRow: action,
+      removeRow: action,
+      moveRow: action,
+      setColumn: action,
+      setDirection: action,
+    });
+    this.rows = original.sorts.length
+      ? original.sorts.map(({ column, direction }) => ({
+          key: nextRowKey++,
+          column,
+          direction,
+        }))
+      : [blankRow()];
+    this.initialKeys = this.keys;
+  }
+
+  /** Every row's key, a blank one included */
+  private get keys(): ColumnDirection[] {
+    return this.rows.map(({ column, direction }) => ({ column, direction }));
+  }
+
+  /** The keys the rows build, in order: a row without a column is left out */
+  get sorts(): ColumnDirection[] {
+    return this.keys.filter(({ column }) => column);
+  }
+
+  addRow(): void {
+    this.rows = [...this.rows, blankRow()];
+  }
+
+  removeRow(key: number): void {
+    this.rows = this.rows.filter((row) => row.key !== key);
+  }
+
+  /** Moves a row one place up (`-1`) or down (`1`), if it can go there */
+  moveRow(key: number, offset: -1 | 1): void {
+    const from = this.rows.findIndex((row) => row.key === key);
+    const to = from + offset;
+    if (from < 0 || to < 0 || to >= this.rows.length) {
+      return;
+    }
+    const rows = [...this.rows];
+    [rows[from], rows[to]] = [
+      rows[to] as CubeSortRow,
+      rows[from] as CubeSortRow,
+    ];
+    this.rows = rows;
+  }
+
+  setColumn(key: number, column: string): void {
+    this.rows = this.rows.map((row) =>
+      row.key === key ? { ...row, column } : row,
+    );
+  }
+
+  setDirection(key: number, direction: SortDirection): void {
+    this.rows = this.rows.map((row) =>
+      row.key === key ? { ...row, direction } : row,
+    );
+  }
+
+  build(): Sort {
+    const { original } = this;
+    return isSameSorts(this.keys, this.initialKeys)
+      ? original
+      : original.withSorts(this.sorts);
+  }
+}

package/tsconfig.json

@@ -54,6 +54,7 @@
     "./src/__test-utils__/CubeCanvasTestUtils.ts",
     "./src/__test-utils__/CubeEngineTestSupport.ts",
     "./src/__test-utils__/CubeNorthwindTestQueries.ts",
+    "./src/__test-utils__/CubeOperationsTestUtils.ts",
     "./src/__test-utils__/CubeTestApplication.ts",
     "./src/__test-utils__/FakeCubeEngine.ts",
     "./src/components/canvas/CubeCanvasContext.ts",
@@ -74,6 +75,7 @@
     "./src/graph-manager/protocol/pure/v1/__test-utils__/V1_CubeEngineTestUtils.ts",
     "./src/stores/CubeEditorState.ts",
     "./src/stores/CubeExecutionState.ts",
+    "./src/stores/CubeGridQuickActions.ts",
     "./src/stores/CubeHost.ts",
     "./src/stores/CubeNodeEditorState.ts",
     "./src/stores/CubeShowPureState.ts",
@@ -81,9 +83,15 @@
     "./src/stores/CubeSpecTransferState.ts",
     "./src/stores/LocalModelCatalog.ts",
     "./src/stores/editors/CubeFilterDraft.ts",
+    "./src/stores/editors/CubeIntegerText.ts",
     "./src/stores/editors/CubeJoinDraft.ts",
     "./src/stores/editors/CubeNodeDraft.ts",
     "./src/stores/editors/CubeNodeDraftRegistry.ts",
+    "./src/stores/editors/CubeRenameDraft.ts",
+    "./src/stores/editors/CubeRestrictDraft.ts",
+    "./src/stores/editors/CubeRowCountDraft.ts",
+    "./src/stores/editors/CubeSliceDraft.ts",
+    "./src/stores/editors/CubeSortDraft.ts",
     "./src/stores/fixtures/CubeNorthwindModel.ts",
     "./src/__test-utils__/CubePageTestUtils.tsx",
     "./src/components/CubeButton.tsx",
@@ -94,9 +102,16 @@
     "./src/components/canvas/CubeCanvasEdge.tsx",
     "./src/components/canvas/CubeCanvasNode.tsx",
     "./src/components/editors/CubeColumnPicker.tsx",
+    "./src/components/editors/CubeDistinctEditor.tsx",
     "./src/components/editors/CubeFilterEditor.tsx",
+    "./src/components/editors/CubeIntegerField.tsx",
     "./src/components/editors/CubeJoinEditor.tsx",
     "./src/components/editors/CubeNodeEditorPanel.tsx",
+    "./src/components/editors/CubeRenameEditor.tsx",
+    "./src/components/editors/CubeRestrictEditor.tsx",
+    "./src/components/editors/CubeRowCountEditor.tsx",
+    "./src/components/editors/CubeSliceEditor.tsx",
+    "./src/components/editors/CubeSortEditor.tsx",
     "./src/components/editors/CubeSourceEditor.tsx",
     "./src/components/editors/CubeValueEditor.tsx",
     "./src/components/grid/CubeGridRegion.tsx",