@finos/legend-cube-builder 0.0.2 → 0.0.4

package/src/stores/editors/CubeSortRows.ts

@@ -0,0 +1,84 @@
+/**
+ * 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, SortDirection } from '@finos/legend-cube';
+
+// The sort rows of the editors that sort (Sort, PLAN §11.4; Partition's
+// window, §11.6): a column and a direction each, most significant first
+
+/** One sort row: 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;
+
+export const blankSortRow = (): CubeSortRow => ({
+  key: nextRowKey++,
+  column: '',
+  direction: SortDirection.ASC,
+});
+
+/** The rows of saved sort keys, in order */
+export const sortRowsOf = (sorts: readonly ColumnDirection[]): CubeSortRow[] =>
+  sorts.map(({ column, direction }) => ({
+    key: nextRowKey++,
+    column,
+    direction,
+  }));
+
+/** Every row's key, a blank one included */
+export const sortKeysOfRows = (
+  rows: readonly CubeSortRow[],
+): ColumnDirection[] =>
+  rows.map(({ column, direction }) => ({ column, direction }));
+
+/** The keys the rows build, in order: a row without a column is left out */
+export const sortsOfRows = (rows: readonly CubeSortRow[]): ColumnDirection[] =>
+  sortKeysOfRows(rows).filter(({ column }) => column);
+
+/** The rows with one moved one place up (`-1`) or down (`1`), if it can go there */
+export const movedSortRows = (
+  rows: readonly CubeSortRow[],
+  key: number,
+  offset: -1 | 1,
+): readonly CubeSortRow[] => {
+  const from = rows.findIndex((row) => row.key === key);
+  const to = from + offset;
+  if (from < 0 || to < 0 || to >= rows.length) {
+    return rows;
+  }
+  const moved = [...rows];
+  [moved[from], moved[to]] = [
+    moved[to] as CubeSortRow,
+    moved[from] as CubeSortRow,
+  ];
+  return moved;
+};
+
+export 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,
+  );

package/src/stores/fixtures/CubeNorthwindModel.ts

@@ -15,6 +15,7 @@
  */
 
 import type { ModelContext } from '@finos/legend-cube';
+import { toPureSetupSqls } from './CubeSampleSql.js';
 
 // The Cube Northwind fixture (PLAN §6.2.4): a corrected copy of the Northwind
 // Database of the query builder's tests, which is left as it is. Corrections:
@@ -77,15 +78,90 @@ const CUBETEST_SETUP_SQLS = [
   'insert into CUBETEST.KEY_NUM values (1.2500), (3.0000)',
 ];
 
-/** A Pure string literal */
-const pureString = (text: string): string =>
-  `'${text.replaceAll('\\', '\\\\').replaceAll("'", "\\'")}'`;
+/** The CUBETEST schema and the decoy table, in the Database's text */
+const CUBETEST_DATABASE_TEXT = `  Schema CUBETEST
+  (
+    Table ALLTYPES
+    (
+      ID INTEGER PRIMARY KEY,
+      TI TINYINT,
+      SI SMALLINT,
+      BI BIGINT,
+      F FLOAT,
+      D DOUBLE,
+      DEC DECIMAL(10, 2),
+      NUM NUMERIC(12, 4),
+      DT DATE,
+      TS TIMESTAMP,
+      B BIT,
+      VC VARCHAR(20)
+    )
+    Table "ORDER.LINES"
+    (
+      LINE_ID INTEGER PRIMARY KEY,
+      RIGHT_COL VARCHAR(10)
+    )
+    Table PROBLEM_BINARY
+    (
+      ID INTEGER PRIMARY KEY,
+      PAYLOAD BINARY(8)
+    )
+    Table PROBLEM_CHAR
+    (
+      CODE CHAR(3) PRIMARY KEY,
+      LABEL VARCHAR(10)
+    )
+    Table PROBLEM_OTHER
+    (
+      ID INTEGER PRIMARY KEY,
+      O OTHER
+    )
+    View PROBLEM_VIEW
+    (
+      ID: CUBETEST.ALLTYPES.ID PRIMARY KEY,
+      VC: CUBETEST.ALLTYPES.VC
+    )
+    Table EMP_REGION
+    (
+      EMPLOYEE_ID SMALLINT PRIMARY KEY,
+      REGION VARCHAR(15)
+    )
+    Table CUST_REGION
+    (
+      CUSTOMER_ID VARCHAR(5) PRIMARY KEY,
+      REGION VARCHAR(15)
+    )
+    Table CATEGORY_REGION
+    (
+      CATEGORY_ID SMALLINT PRIMARY KEY,
+      SHIP_REGION VARCHAR(15) NOT NULL
+    )
+    Table KEY_VC15
+    (
+      K VARCHAR(15)
+    )
+    Table KEY_VC2
+    (
+      K VARCHAR(2)
+    )
+    Table KEY_DEC
+    (
+      K DECIMAL(10, 2)
+    )
+    Table KEY_NUM
+    (
+      K NUMERIC(12, 4)
+    )
+  )
+  Table CUBETEST
+  (
+    WRONG_TABLE VARCHAR(10)
+  )
 
-const SETUP_SQLS = ['call loadNorthwindData()', ...CUBETEST_SETUP_SQLS]
-  .map((sql) => `      ${pureString(sql)}`)
-  .join(',\n');
+`;
 
-export const CUBE_NORTHWIND_MODEL_CODE = `###Relational
+/** The Northwind model's text, with Cube's test tables or without */
+const northwindModelCode = (withTestTables: boolean): string => `###Relational
 Database ${CUBE_NORTHWIND_DATABASE}
 (
   Schema NORTHWIND
@@ -222,86 +298,7 @@ Database ${CUBE_NORTHWIND_DATABASE}
       STATE_REGION VARCHAR(50)
     )
   )
-  Schema CUBETEST
-  (
-    Table ALLTYPES
-    (
-      ID INTEGER PRIMARY KEY,
-      TI TINYINT,
-      SI SMALLINT,
-      BI BIGINT,
-      F FLOAT,
-      D DOUBLE,
-      DEC DECIMAL(10, 2),
-      NUM NUMERIC(12, 4),
-      DT DATE,
-      TS TIMESTAMP,
-      B BIT,
-      VC VARCHAR(20)
-    )
-    Table "ORDER.LINES"
-    (
-      LINE_ID INTEGER PRIMARY KEY,
-      RIGHT_COL VARCHAR(10)
-    )
-    Table PROBLEM_BINARY
-    (
-      ID INTEGER PRIMARY KEY,
-      PAYLOAD BINARY(8)
-    )
-    Table PROBLEM_CHAR
-    (
-      CODE CHAR(3) PRIMARY KEY,
-      LABEL VARCHAR(10)
-    )
-    Table PROBLEM_OTHER
-    (
-      ID INTEGER PRIMARY KEY,
-      O OTHER
-    )
-    View PROBLEM_VIEW
-    (
-      ID: CUBETEST.ALLTYPES.ID PRIMARY KEY,
-      VC: CUBETEST.ALLTYPES.VC
-    )
-    Table EMP_REGION
-    (
-      EMPLOYEE_ID SMALLINT PRIMARY KEY,
-      REGION VARCHAR(15)
-    )
-    Table CUST_REGION
-    (
-      CUSTOMER_ID VARCHAR(5) PRIMARY KEY,
-      REGION VARCHAR(15)
-    )
-    Table CATEGORY_REGION
-    (
-      CATEGORY_ID SMALLINT PRIMARY KEY,
-      SHIP_REGION VARCHAR(15) NOT NULL
-    )
-    Table KEY_VC15
-    (
-      K VARCHAR(15)
-    )
-    Table KEY_VC2
-    (
-      K VARCHAR(2)
-    )
-    Table KEY_DEC
-    (
-      K DECIMAL(10, 2)
-    )
-    Table KEY_NUM
-    (
-      K NUMERIC(12, 4)
-    )
-  )
-  Table CUBETEST
-  (
-    WRONG_TABLE VARCHAR(10)
-  )
-
-  Join ORDERS_CUSTMERS(NORTHWIND.ORDERS.CUSTOMER_ID = NORTHWIND.CUSTOMERS.CUSTOMER_ID)
+${withTestTables ? CUBETEST_DATABASE_TEXT : '\n'}  Join ORDERS_CUSTMERS(NORTHWIND.ORDERS.CUSTOMER_ID = NORTHWIND.CUSTOMERS.CUSTOMER_ID)
   Join ORDERS_EMPLOYEES(NORTHWIND.ORDERS.EMPLOYEE_ID = NORTHWIND.EMPLOYEES.EMPLOYEE_ID)
   Join ORDERS_SHIPPERS(NORTHWIND.ORDERS.SHIP_VIA = NORTHWIND.SHIPPERS.SHIPPER_ID)
   Join ORDERS_ORDER_DETAILS(NORTHWIND.ORDERS.ORDER_ID = NORTHWIND.ORDER_DETAILS.ORDER_ID)
@@ -325,7 +322,11 @@ RelationalDatabaseConnection ${CUBE_NORTHWIND_CONNECTION}
   specification: LocalH2
   {
     testDataSetupSqls: [
-${SETUP_SQLS}
+${toPureSetupSqls(
+  withTestTables
+    ? ['call loadNorthwindData()', ...CUBETEST_SETUP_SQLS]
+    : ['call loadNorthwindData()'],
+)}
     ];
   };
   auth: DefaultH2;
@@ -348,8 +349,22 @@ Runtime ${CUBE_NORTHWIND_RUNTIME}
 }
 `;
 
+export const CUBE_NORTHWIND_MODEL_CODE = northwindModelCode(true);
+
+/**
+ * Northwind as the Sample Data tab offers it: Northwind's own tables, without
+ * Cube's test tables
+ */
+export const CUBE_NORTHWIND_SAMPLE_MODEL_CODE = northwindModelCode(false);
+
 /** The Cube Northwind fixture as a cube saves it (PLAN §6.2.2) */
 export const CUBE_NORTHWIND_MODEL: ModelContext = Object.freeze({
   _type: 'text',
   code: CUBE_NORTHWIND_MODEL_CODE,
 });
+
+/** The Northwind sample, without Cube's test tables, as a cube saves it */
+export const CUBE_NORTHWIND_SAMPLE_MODEL: ModelContext = Object.freeze({
+  _type: 'text',
+  code: CUBE_NORTHWIND_SAMPLE_MODEL_CODE,
+});

package/src/stores/fixtures/CubeSampleSql.ts

@@ -0,0 +1,85 @@
+/**
+ * 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.
+ */
+
+// What the sample models are made of: seeded random numbers, so a sample's
+// rows are the same on every load (a saved cube holds the model text, which
+// must not change), and setup SQL that H2 and DuckDB both run.
+
+/** A seeded random number generator (mulberry32): numbers in [0, 1) */
+export const createSampleRandom = (seed: number): (() => number) => {
+  let state = seed >>> 0;
+  return () => {
+    state = (state + 0x6d2b79f5) >>> 0;
+    let t = state;
+    t = Math.imul(t ^ (t >>> 15), t | 1);
+    t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
+    return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
+  };
+};
+
+/** An item of the list, picked with the random number given */
+export const pickSample = <T>(items: readonly T[], random: number): T => {
+  const item = items[Math.floor(random * items.length)];
+  if (item === undefined) {
+    throw new Error(`Can't pick from an empty list`);
+  }
+  return item;
+};
+
+/** A value of a setup SQL row: a number, a text, a date, or NULL */
+export type SampleSqlValue =
+  | number
+  | string
+  | { readonly date: string }
+  | { readonly decimal: string }
+  | null;
+
+const sqlValue = (value: SampleSqlValue): string => {
+  if (value === null) {
+    return 'NULL';
+  }
+  if (typeof value === 'number') {
+    return String(value);
+  }
+  if (typeof value === 'string') {
+    return `'${value.replaceAll("'", "''")}'`;
+  }
+  return 'date' in value ? `DATE '${value.date}'` : value.decimal;
+};
+
+/** One insert of every row of a table */
+export const sampleInsert = (
+  table: string,
+  rows: readonly (readonly SampleSqlValue[])[],
+): string =>
+  `insert into ${table} values ${rows
+    .map((row) => `(${row.map(sqlValue).join(', ')})`)
+    .join(', ')}`;
+
+/** A Pure string literal */
+export const pureString = (text: string): string =>
+  `'${text.replaceAll('\\', '\\\\').replaceAll("'", "\\'")}'`;
+
+/** The setup SQL as the `testDataSetupSqls` of a LocalH2 connection */
+export const toPureSetupSqls = (sqls: readonly string[]): string =>
+  sqls.map((sql) => `      ${pureString(sql)}`).join(',\n');
+
+/** A day as `YYYY-MM-DD`, some days after the first one given */
+export const addSampleDays = (first: string, days: number): string => {
+  const date = new Date(`${first}T00:00:00Z`);
+  date.setUTCDate(date.getUTCDate() + days);
+  return date.toISOString().slice(0, 10);
+};

package/src/stores/fixtures/CubeSportsModel.ts

@@ -0,0 +1,182 @@
+/**
+ * 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 { ModelContext } from '@finos/legend-cube';
+import {
+  addSampleDays,
+  createSampleRandom,
+  pickSample,
+  sampleInsert,
+  type SampleSqlValue,
+  toPureSetupSqls,
+} from './CubeSampleSql.js';
+
+// The sports sample: made-up events of 2025 and how many watched them, in an
+// in-memory H2 database the engine fills from the model's setup SQL
+
+export const CUBE_SPORTS_DATABASE = 'cube::samples::sports::SportsDatabase';
+export const CUBE_SPORTS_CONNECTION = 'cube::samples::sports::SportsConnection';
+export const CUBE_SPORTS_RUNTIME = 'cube::samples::sports::SportsRuntime';
+export const CUBE_SPORTS_SCHEMA = 'SPORTS_SAMPLE';
+export const CUBE_SPORTS_EVENT_COUNT = 360;
+
+/** Each sport, and the millions who watch a typical event of it */
+const SPORTS: readonly (readonly [string, string, number])[] = [
+  ['Football', 'Team', 40],
+  ['Basketball', 'Team', 18],
+  ['Cricket', 'Team', 30],
+  ['Tennis', 'Individual', 9],
+  ['American Football', 'Team', 22],
+  ['Baseball', 'Team', 8],
+  ['Ice Hockey', 'Team', 5],
+  ['Motor Racing', 'Individual', 12],
+  ['Golf', 'Individual', 4],
+  ['Rugby', 'Team', 7],
+];
+
+/** Each region, and how much it watches each sport, in SPORTS' order */
+const REGIONS: readonly (readonly [string, readonly number[]])[] = [
+  ['Europe', [1.6, 0.5, 0.3, 1.2, 0.2, 0.1, 0.6, 1.4, 0.8, 1.3]],
+  ['Americas', [0.8, 1.6, 0.1, 0.9, 2.2, 1.8, 1.2, 0.9, 1.3, 0.3]],
+  ['Asia', [1.0, 1.1, 2.4, 0.7, 0.1, 0.6, 0.1, 0.8, 0.5, 0.2]],
+  ['Africa', [1.2, 0.3, 0.6, 0.3, 0.1, 0.1, 0.1, 0.3, 0.3, 0.9]],
+  ['Oceania', [0.4, 0.3, 0.9, 0.6, 0.1, 0.1, 0.1, 0.5, 0.6, 1.4]],
+];
+
+/** Each stage, and how much more a stage's event is watched */
+const STAGES: readonly (readonly [string, number])[] = [
+  ['Group', 0.6],
+  ['Group', 0.6],
+  ['Group', 0.6],
+  ['Group', 0.6],
+  ['Quarterfinal', 1.1],
+  ['Quarterfinal', 1.1],
+  ['Semifinal', 1.6],
+  ['Final', 2.8],
+];
+
+const COMPETITIONS = ['Cup', 'League', 'Open', 'Championship'];
+
+const createEvents = (): SampleSqlValue[][] => {
+  const random = createSampleRandom(20250101);
+  const events: SampleSqlValue[][] = [];
+  for (let id = 1; id <= CUBE_SPORTS_EVENT_COUNT; id++) {
+    const sportIndex = Math.floor(random() * SPORTS.length);
+    const [sport, , millions] = pickSample(SPORTS, sportIndex / SPORTS.length);
+    const [region, interest] = pickSample(REGIONS, random());
+    const [stage, stageFactor] = pickSample(STAGES, random());
+    const competition = `${region} ${sport} ${pickSample(COMPETITIONS, random())}`;
+    const viewers = Math.round(
+      millions *
+        1_000_000 *
+        (interest[sportIndex] ?? 1) *
+        stageFactor *
+        (0.6 + random() * 0.8),
+    );
+    // about one event in ten has no attendance recorded
+    const attendance =
+      random() < 0.1 ? null : Math.round(5_000 + random() * 85_000);
+    events.push([
+      id,
+      sportIndex + 1,
+      competition,
+      stage,
+      { date: addSampleDays('2025-01-01', Math.floor(random() * 365)) },
+      region,
+      viewers,
+      attendance,
+    ]);
+  }
+  return events;
+};
+
+/** The SQL that makes and fills the tables, run on every connection checkout */
+export const CUBE_SPORTS_SETUP_SQLS = [
+  `drop schema if exists ${CUBE_SPORTS_SCHEMA} cascade`,
+  `create schema ${CUBE_SPORTS_SCHEMA}`,
+  `create table ${CUBE_SPORTS_SCHEMA}.SPORTS (ID INTEGER PRIMARY KEY, SPORT VARCHAR(20) NOT NULL, KIND VARCHAR(10) NOT NULL)`,
+  sampleInsert(
+    `${CUBE_SPORTS_SCHEMA}.SPORTS`,
+    SPORTS.map(([sport, kind], index) => [index + 1, sport, kind]),
+  ),
+  `create table ${CUBE_SPORTS_SCHEMA}.EVENTS (EVENT_ID INTEGER PRIMARY KEY, SPORT_ID INTEGER NOT NULL, COMPETITION VARCHAR(40) NOT NULL, STAGE VARCHAR(12) NOT NULL, EVENT_DATE DATE NOT NULL, REGION VARCHAR(10) NOT NULL, VIEWERS BIGINT NOT NULL, ATTENDANCE INTEGER)`,
+  sampleInsert(`${CUBE_SPORTS_SCHEMA}.EVENTS`, createEvents()),
+];
+
+export const CUBE_SPORTS_MODEL_CODE = `###Relational
+Database ${CUBE_SPORTS_DATABASE}
+(
+  Schema ${CUBE_SPORTS_SCHEMA}
+  (
+    Table SPORTS
+    (
+      ID INTEGER PRIMARY KEY,
+      SPORT VARCHAR(20) NOT NULL,
+      KIND VARCHAR(10) NOT NULL
+    )
+    Table EVENTS
+    (
+      EVENT_ID INTEGER PRIMARY KEY,
+      SPORT_ID INTEGER NOT NULL,
+      COMPETITION VARCHAR(40) NOT NULL,
+      STAGE VARCHAR(12) NOT NULL,
+      EVENT_DATE DATE NOT NULL,
+      REGION VARCHAR(10) NOT NULL,
+      VIEWERS BIGINT NOT NULL,
+      ATTENDANCE INTEGER
+    )
+  )
+
+  Join EVENT_SPORT(${CUBE_SPORTS_SCHEMA}.EVENTS.SPORT_ID = ${CUBE_SPORTS_SCHEMA}.SPORTS.ID)
+)
+
+
+###Connection
+RelationalDatabaseConnection ${CUBE_SPORTS_CONNECTION}
+{
+  store: ${CUBE_SPORTS_DATABASE};
+  type: H2;
+  specification: LocalH2
+  {
+    testDataSetupSqls: [
+${toPureSetupSqls(CUBE_SPORTS_SETUP_SQLS)}
+    ];
+  };
+  auth: DefaultH2;
+}
+
+
+###Runtime
+Runtime ${CUBE_SPORTS_RUNTIME}
+{
+  mappings:
+  [
+  ];
+  connections:
+  [
+    ${CUBE_SPORTS_DATABASE}:
+    [
+      connection_1: ${CUBE_SPORTS_CONNECTION}
+    ]
+  ];
+}
+`;
+
+/** The sports sample as a cube saves it (PLAN §6.2.2) */
+export const CUBE_SPORTS_MODEL: ModelContext = Object.freeze({
+  _type: 'text',
+  code: CUBE_SPORTS_MODEL_CODE,
+});