@finos/legend-cube-builder 0.0.3 → 0.0.4

package/lib/stores/fixtures/CubeTradesModel.js

@@ -0,0 +1,197 @@
+/**
+ * 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 { addSampleDays, createSampleRandom, pickSample, sampleInsert, toPureSetupSqls, } from './CubeSampleSql.js';
+// The trades sample: made-up trades of the first half of 2026 by six desks in
+// made-up instruments, in an in-memory H2 database the engine fills from the
+// model's setup SQL
+export const CUBE_TRADES_DATABASE = 'cube::samples::trades::TradesDatabase';
+export const CUBE_TRADES_CONNECTION = 'cube::samples::trades::TradesConnection';
+export const CUBE_TRADES_RUNTIME = 'cube::samples::trades::TradesRuntime';
+export const CUBE_TRADES_SCHEMA = 'TRADES_SAMPLE';
+export const CUBE_TRADES_TRADE_COUNT = 400;
+/** Each desk, its region, and the asset classes it trades */
+const DESKS = [
+    ['Equities Cash', 'Americas', ['Equity']],
+    ['Equity Derivatives', 'Europe', ['Equity', 'Commodity']],
+    ['Rates', 'Americas', ['Bond', 'FX']],
+    ['Credit', 'Europe', ['Bond']],
+    ['FX', 'Asia', ['FX']],
+    ['Commodities', 'Americas', ['Commodity', 'FX']],
+];
+/** Each instrument: symbol, name, asset class, currency and a typical price */
+const INSTRUMENTS = [
+    ['ACME', 'Acme Industries', 'Equity', 'USD', 182.5],
+    ['GLBX', 'Globex Corp', 'Equity', 'USD', 64.2],
+    ['INIT', 'Initech', 'Equity', 'USD', 23.75],
+    ['UMBR', 'Umbrella Holdings', 'Equity', 'EUR', 96.4],
+    ['STRK', 'Stark Works', 'Equity', 'EUR', 310.1],
+    ['UST10', 'Treasury 10Y', 'Bond', 'USD', 98.6],
+    ['UST2', 'Treasury 2Y', 'Bond', 'USD', 99.8],
+    ['BUND10', 'Bund 10Y', 'Bond', 'EUR', 101.3],
+    ['ACME28', 'Acme 4.5% 2028', 'Bond', 'USD', 97.2],
+    ['EURUSD', 'Euro / Dollar', 'FX', 'USD', 1.0875],
+    ['USDJPY', 'Dollar / Yen', 'FX', 'JPY', 148.35],
+    ['GBPUSD', 'Pound / Dollar', 'FX', 'USD', 1.265],
+    ['GOLD', 'Gold', 'Commodity', 'USD', 2350.0],
+    ['BRENT', 'Brent Crude', 'Commodity', 'USD', 82.4],
+    ['COPPER', 'Copper', 'Commodity', 'USD', 4.15],
+];
+/** What a unit of each currency is worth in dollars, fixed for the sample */
+export const CUBE_TRADES_USD_RATES = new Map([
+    ['USD', 1],
+    ['EUR', 1.08],
+    ['JPY', 0.0067],
+]);
+/** How many units a trade of an asset class is for, at most */
+const MAX_QUANTITY = new Map([
+    ['Equity', 5_000],
+    ['Bond', 2_000],
+    ['FX', 1_000_000],
+    ['Commodity', 1_000],
+]);
+/** A whole number of ten-thousandths as a decimal text, e.g. 12345 is 1.2345 */
+const fromTenThousandths = (value, scale) => {
+    const text = String(value).padStart(5, '0');
+    const whole = text.slice(0, -4);
+    const fraction = text.slice(-4).slice(0, scale);
+    return scale === 0 ? whole : `${whole}.${fraction}`;
+};
+const createTrades = () => {
+    const random = createSampleRandom(20260102);
+    const trades = [];
+    for (let id = 1; id <= CUBE_TRADES_TRADE_COUNT; id++) {
+        const deskIndex = Math.floor(random() * DESKS.length);
+        const [, , assetClasses] = pickSample(DESKS, deskIndex / DESKS.length);
+        const assetClass = pickSample(assetClasses, random());
+        const choices = INSTRUMENTS.flatMap((instrument, index) => instrument[2] === assetClass ? [index] : []);
+        const instrumentIndex = pickSample(choices, random());
+        const [, , , currency, price] = pickSample(INSTRUMENTS, instrumentIndex / INSTRUMENTS.length);
+        const quantity = Math.max(1, Math.round(random() * (MAX_QUANTITY.get(assetClass) ?? 1_000)));
+        // prices move up to 5% either way, kept to four decimals
+        const priceInTenThousandths = Math.round(price * (0.95 + random() * 0.1) * 10_000);
+        // the notional in dollars, at a fixed rate, kept to cents
+        const notionalInTenThousandths = Math.round((quantity *
+            priceInTenThousandths *
+            (CUBE_TRADES_USD_RATES.get(currency) ?? 1)) /
+            100) * 100;
+        // trading days: Monday to Friday
+        let day = Math.floor(random() * 181);
+        while ([0, 6].includes(new Date(Date.UTC(2026, 0, 1 + day)).getUTCDay())) {
+            day = (day + 1) % 181;
+        }
+        trades.push([
+            id,
+            { date: addSampleDays('2026-01-01', day) },
+            deskIndex + 1,
+            instrumentIndex + 1,
+            random() < 0.5 ? 'BUY' : 'SELL',
+            quantity,
+            { decimal: fromTenThousandths(priceInTenThousandths, 4) },
+            { decimal: fromTenThousandths(notionalInTenThousandths, 2) },
+        ]);
+    }
+    return trades;
+};
+/** The SQL that makes and fills the tables, run on every connection checkout */
+export const CUBE_TRADES_SETUP_SQLS = [
+    `drop schema if exists ${CUBE_TRADES_SCHEMA} cascade`,
+    `create schema ${CUBE_TRADES_SCHEMA}`,
+    `create table ${CUBE_TRADES_SCHEMA}.DESKS (ID INTEGER PRIMARY KEY, DESK VARCHAR(20) NOT NULL, REGION VARCHAR(10) NOT NULL)`,
+    sampleInsert(`${CUBE_TRADES_SCHEMA}.DESKS`, DESKS.map(([desk, region], index) => [index + 1, desk, region])),
+    `create table ${CUBE_TRADES_SCHEMA}.INSTRUMENTS (ID INTEGER PRIMARY KEY, SYMBOL VARCHAR(10) NOT NULL, INSTRUMENT VARCHAR(30) NOT NULL, ASSET_CLASS VARCHAR(10) NOT NULL, CURRENCY VARCHAR(3) NOT NULL)`,
+    sampleInsert(`${CUBE_TRADES_SCHEMA}.INSTRUMENTS`, INSTRUMENTS.map(([symbol, name, assetClass, currency], index) => [
+        index + 1,
+        symbol,
+        name,
+        assetClass,
+        currency,
+    ])),
+    `create table ${CUBE_TRADES_SCHEMA}.TRADES (TRADE_ID INTEGER PRIMARY KEY, TRADE_DATE DATE NOT NULL, DESK_ID INTEGER NOT NULL, INSTRUMENT_ID INTEGER NOT NULL, SIDE VARCHAR(4) NOT NULL, QUANTITY INTEGER NOT NULL, PRICE DECIMAL(14,4) NOT NULL, NOTIONAL_USD DECIMAL(18,2) NOT NULL)`,
+    sampleInsert(`${CUBE_TRADES_SCHEMA}.TRADES`, createTrades()),
+];
+export const CUBE_TRADES_MODEL_CODE = `###Relational
+Database ${CUBE_TRADES_DATABASE}
+(
+  Schema ${CUBE_TRADES_SCHEMA}
+  (
+    Table DESKS
+    (
+      ID INTEGER PRIMARY KEY,
+      DESK VARCHAR(20) NOT NULL,
+      REGION VARCHAR(10) NOT NULL
+    )
+    Table INSTRUMENTS
+    (
+      ID INTEGER PRIMARY KEY,
+      SYMBOL VARCHAR(10) NOT NULL,
+      INSTRUMENT VARCHAR(30) NOT NULL,
+      ASSET_CLASS VARCHAR(10) NOT NULL,
+      CURRENCY VARCHAR(3) NOT NULL
+    )
+    Table TRADES
+    (
+      TRADE_ID INTEGER PRIMARY KEY,
+      TRADE_DATE DATE NOT NULL,
+      DESK_ID INTEGER NOT NULL,
+      INSTRUMENT_ID INTEGER NOT NULL,
+      SIDE VARCHAR(4) NOT NULL,
+      QUANTITY INTEGER NOT NULL,
+      PRICE DECIMAL(14,4) NOT NULL,
+      NOTIONAL_USD DECIMAL(18,2) NOT NULL
+    )
+  )
+
+  Join TRADE_DESK(${CUBE_TRADES_SCHEMA}.TRADES.DESK_ID = ${CUBE_TRADES_SCHEMA}.DESKS.ID)
+  Join TRADE_INSTRUMENT(${CUBE_TRADES_SCHEMA}.TRADES.INSTRUMENT_ID = ${CUBE_TRADES_SCHEMA}.INSTRUMENTS.ID)
+)
+
+
+###Connection
+RelationalDatabaseConnection ${CUBE_TRADES_CONNECTION}
+{
+  store: ${CUBE_TRADES_DATABASE};
+  type: H2;
+  specification: LocalH2
+  {
+    testDataSetupSqls: [
+${toPureSetupSqls(CUBE_TRADES_SETUP_SQLS)}
+    ];
+  };
+  auth: DefaultH2;
+}
+
+
+###Runtime
+Runtime ${CUBE_TRADES_RUNTIME}
+{
+  mappings:
+  [
+  ];
+  connections:
+  [
+    ${CUBE_TRADES_DATABASE}:
+    [
+      connection_1: ${CUBE_TRADES_CONNECTION}
+    ]
+  ];
+}
+`;
+/** The trades sample as a cube saves it (PLAN §6.2.2) */
+export const CUBE_TRADES_MODEL = Object.freeze({
+    _type: 'text',
+    code: CUBE_TRADES_MODEL_CODE,
+});
+//# sourceMappingURL=CubeTradesModel.js.map

package/lib/stores/fixtures/CubeTradesModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeTradesModel.js","sourceRoot":"","sources":["../../../src/stores/fixtures/CubeTradesModel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,YAAY,EAEZ,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAE5B,8EAA8E;AAC9E,6EAA6E;AAC7E,oBAAoB;AAEpB,MAAM,CAAC,MAAM,oBAAoB,GAAG,uCAAuC,CAAC;AAC5E,MAAM,CAAC,MAAM,sBAAsB,GAAG,yCAAyC,CAAC;AAChF,MAAM,CAAC,MAAM,mBAAmB,GAAG,sCAAsC,CAAC;AAC1E,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAClD,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAE3C,6DAA6D;AAC7D,MAAM,KAAK,GAA8D;IACvE,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,oBAAoB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC,aAAa,EAAE,UAAU,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;CACjD,CAAC;AAEF,+EAA+E;AAC/E,MAAM,WAAW,GAMV;IACL,CAAC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC;IACnD,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;IAC9C,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC;IAC3C,CAAC,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;IACpD,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC;IAC/C,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAC9C,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAC5C,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC;IAC5C,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IACjD,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;IAChD,CAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;IAC/C,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC;IAChD,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC;IAC5C,CAAC,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC;IAClD,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC;CAC/C,CAAC;AAEF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAgC,IAAI,GAAG,CAAC;IACxE,CAAC,KAAK,EAAE,CAAC,CAAC;IACV,CAAC,KAAK,EAAE,IAAI,CAAC;IACb,CAAC,KAAK,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH,+DAA+D;AAC/D,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,CAAC,QAAQ,EAAE,KAAK,CAAC;IACjB,CAAC,MAAM,EAAE,KAAK,CAAC;IACf,CAAC,IAAI,EAAE,SAAS,CAAC;IACjB,CAAC,WAAW,EAAE,KAAK,CAAC;CACrB,CAAC,CAAC;AAEH,gFAAgF;AAChF,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,KAAa,EAAU,EAAE;IAClE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAChD,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAAuB,EAAE;IAC5C,MAAM,MAAM,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,uBAAuB,EAAE,EAAE,EAAE,EAAE,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,AAAD,EAAG,YAAY,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CACxD,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAC5C,CAAC;QACF,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,AAAD,EAAG,AAAD,EAAG,QAAQ,EAAE,KAAK,CAAC,GAAG,UAAU,CACxC,WAAW,EACX,eAAe,GAAG,WAAW,CAAC,MAAM,CACrC,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CACvB,CAAC,EACD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC,CAC/D,CAAC;QACF,yDAAyD;QACzD,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CACtC,KAAK,GAAG,CAAC,IAAI,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,MAAM,CACzC,CAAC;QACF,0DAA0D;QAC1D,MAAM,wBAAwB,GAC5B,IAAI,CAAC,KAAK,CACR,CAAC,QAAQ;YACP,qBAAqB;YACrB,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3C,GAAG,CACN,GAAG,GAAG,CAAC;QACV,iCAAiC;QACjC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;QACrC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;YACzE,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QACxB,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,EAAE;YACF,EAAE,IAAI,EAAE,aAAa,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE;YAC1C,SAAS,GAAG,CAAC;YACb,eAAe,GAAG,CAAC;YACnB,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM;YAC/B,QAAQ;YACR,EAAE,OAAO,EAAE,kBAAkB,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE;YACzD,EAAE,OAAO,EAAE,kBAAkB,CAAC,wBAAwB,EAAE,CAAC,CAAC,EAAE;SAC7D,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,gFAAgF;AAChF,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,yBAAyB,kBAAkB,UAAU;IACrD,iBAAiB,kBAAkB,EAAE;IACrC,gBAAgB,kBAAkB,yFAAyF;IAC3H,YAAY,CACV,GAAG,kBAAkB,QAAQ,EAC7B,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAChE;IACD,gBAAgB,kBAAkB,qKAAqK;IACvM,YAAY,CACV,GAAG,kBAAkB,cAAc,EACnC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/D,KAAK,GAAG,CAAC;QACT,MAAM;QACN,IAAI;QACJ,UAAU;QACV,QAAQ;KACT,CAAC,CACH;IACD,gBAAgB,kBAAkB,oPAAoP;IACtR,YAAY,CAAC,GAAG,kBAAkB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC7D,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG;WAC3B,oBAAoB;;WAEpB,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBA6BT,kBAAkB,qBAAqB,kBAAkB;0BACnD,kBAAkB,2BAA2B,kBAAkB;;;;;+BAK1D,sBAAsB;;WAE1C,oBAAoB;;;;;EAK7B,eAAe,CAAC,sBAAsB,CAAC;;;;;;;;UAQ/B,mBAAmB;;;;;;;MAOvB,oBAAoB;;sBAEJ,sBAAsB;;;;CAI3C,CAAC;AAEF,yDAAyD;AACzD,MAAM,CAAC,MAAM,iBAAiB,GAAiB,MAAM,CAAC,MAAM,CAAC;IAC3D,KAAK,EAAE,MAAM;IACb,IAAI,EAAE,sBAAsB;CAC7B,CAAC,CAAC"}

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

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ */
+/** The most rows a CSV may have: the cube saves them, and every connection inserts them again */
+export declare const CUBE_CSV_MAX_ROWS = 10000;
+/** The most characters a CSV may have */
+export declare const CUBE_CSV_MAX_LENGTH = 5000000;
+/** The schema a CSV's table is created in */
+export declare const CUBE_CSV_SCHEMA = "csv";
+/** The DuckDB types a CSV's columns are given, from their values */
+export declare enum CubeCsvColumnType {
+    INTEGER = "INTEGER",
+    BIGINT = "BIGINT",
+    DOUBLE = "DOUBLE",
+    BOOLEAN = "BOOLEAN",
+    DATE = "DATE",
+    TIMESTAMP = "TIMESTAMP",
+    VARCHAR = "VARCHAR"
+}
+export declare class CubeCsvError extends Error {
+}
+/** A CSV loaded as a table: its name, its columns and their types, and the setup SQL that creates it */
+export interface CubeCsvTable {
+    readonly table: string;
+    readonly columns: readonly {
+        readonly name: string;
+        readonly type: CubeCsvColumnType;
+    }[];
+    readonly rowCount: number;
+    /** Statements in the form's setup SQL text: each ends on a line ending in ';' */
+    readonly sql: string;
+}
+/**
+ * The records of a CSV (RFC 4180): fields split on commas, a field in double
+ * quotes may hold commas, line breaks and doubled quotes; blank lines are
+ * skipped
+ */
+export declare const parseCubeCsv: (text: string) => string[][];
+/**
+ * A column's type from its values, empty ones left out: the narrowest type
+ * every value fits. Whole numbers with a leading zero (codes, such as
+ * `007`) and ones past 64 bits stay text, so no digit is lost; numbers
+ * with a fraction are DOUBLE. A column of empty values is text.
+ */
+export declare const inferCubeCsvColumnType: (values: readonly string[]) => CubeCsvColumnType;
+/**
+ * A name the database takes unquoted: letters, digits and underscores, not
+ * starting with a digit, and no reserved word (one gets a trailing
+ * underscore)
+ */
+export declare const toCubeCsvName: (text: string, fallback: string) => string;
+/**
+ * A CSV, with a header row, as a table of the `csv` schema: setup SQL that
+ * creates the schema if needed, drops and creates the table, then inserts
+ * the rows. Refuses an empty CSV, a record whose values don't match the
+ * header, and one past the limits.
+ */
+export declare const buildCubeCsvTable: (text: string, tableName: string) => CubeCsvTable;
+//# sourceMappingURL=CubeCsvSetupSql.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CubeCsvSetupSql.d.ts","sourceRoot":"","sources":["../../../src/stores/source-picker/CubeCsvSetupSql.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AASH,iGAAiG;AACjG,eAAO,MAAM,iBAAiB,QAAS,CAAC;AAExC,yCAAyC;AACzC,eAAO,MAAM,mBAAmB,UAAY,CAAC;AAE7C,6CAA6C;AAC7C,eAAO,MAAM,eAAe,QAAQ,CAAC;AAKrC,oEAAoE;AACpE,oBAAY,iBAAiB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,qBAAa,YAAa,SAAQ,KAAK;CAAG;AAE1C,wGAAwG;AACxG,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,SAAS;QACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;KAClC,EAAE,CAAC;IACJ,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iFAAiF;IACjF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,MAAM,EAAE,EA8DnD,CAAC;AA2CF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,SAAS,MAAM,EAAE,KACxB,iBA8BF,CAAC;AAuHF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,KAAG,MAK9D,CAAC;AA2CF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,YAsDF,CAAC"}

package/lib/stores/source-picker/CubeCsvSetupSql.js

@@ -0,0 +1,392 @@
+/**
+ * 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 { CUBE_CSV_MESSAGE } from '../../__lib__/LegendCubeDirectConnectionLabels.js';
+// A CSV loaded into an in-memory DuckDB connection: the CSV becomes setup SQL
+// (a table, then its rows as inserts), which the engine runs on every
+// connection and the cube saves with its connection. No file reaches the
+// engine's host
+/** The most rows a CSV may have: the cube saves them, and every connection inserts them again */
+export const CUBE_CSV_MAX_ROWS = 10_000;
+/** The most characters a CSV may have */
+export const CUBE_CSV_MAX_LENGTH = 5_000_000;
+/** The schema a CSV's table is created in */
+export const CUBE_CSV_SCHEMA = 'csv';
+/** How many rows one insert statement holds */
+const ROWS_PER_INSERT = 1000;
+/** The DuckDB types a CSV's columns are given, from their values */
+export var CubeCsvColumnType;
+(function (CubeCsvColumnType) {
+    CubeCsvColumnType["INTEGER"] = "INTEGER";
+    CubeCsvColumnType["BIGINT"] = "BIGINT";
+    CubeCsvColumnType["DOUBLE"] = "DOUBLE";
+    CubeCsvColumnType["BOOLEAN"] = "BOOLEAN";
+    CubeCsvColumnType["DATE"] = "DATE";
+    CubeCsvColumnType["TIMESTAMP"] = "TIMESTAMP";
+    CubeCsvColumnType["VARCHAR"] = "VARCHAR";
+})(CubeCsvColumnType || (CubeCsvColumnType = {}));
+export class CubeCsvError extends Error {
+}
+/**
+ * The records of a CSV (RFC 4180): fields split on commas, a field in double
+ * quotes may hold commas, line breaks and doubled quotes; blank lines are
+ * skipped
+ */
+export const parseCubeCsv = (text) => {
+    const source = text.startsWith('') ? text.slice(1) : text;
+    const records = [];
+    let record = [];
+    let field = '';
+    let quoted = false;
+    let wasQuoted = false;
+    let line = 1;
+    let quoteLine = 1;
+    const endField = () => {
+        record.push(field);
+        field = '';
+        wasQuoted = false;
+    };
+    const endRecord = () => {
+        const lastWasQuoted = wasQuoted;
+        endField();
+        // a blank line is one empty field, never quoted
+        if (record.length > 1 || record[0] !== '' || lastWasQuoted) {
+            records.push(record);
+        }
+        record = [];
+    };
+    for (let index = 0; index < source.length; index++) {
+        const char = source.charAt(index);
+        if (quoted) {
+            if (char === '"') {
+                if (source.charAt(index + 1) === '"') {
+                    field += '"';
+                    index++;
+                }
+                else {
+                    quoted = false;
+                }
+            }
+            else {
+                if (char === '\n') {
+                    line++;
+                }
+                field += char;
+            }
+        }
+        else if (char === '"' && field === '') {
+            quoted = true;
+            wasQuoted = true;
+            quoteLine = line;
+        }
+        else if (char === ',') {
+            endField();
+        }
+        else if (char === '\r' || char === '\n') {
+            if (char === '\r' && source.charAt(index + 1) === '\n') {
+                index++;
+            }
+            line++;
+            endRecord();
+        }
+        else {
+            field += char;
+        }
+    }
+    if (quoted) {
+        throw new CubeCsvError(CUBE_CSV_MESSAGE.UNCLOSED_QUOTE(quoteLine));
+    }
+    if (field !== '' || record.length || wasQuoted) {
+        endRecord();
+    }
+    return records;
+};
+const INTEGER_TEXT = /^[+-]?(?:0|[1-9]\d*)$/u;
+const NUMBER_TEXT = /^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?$/u;
+const BOOLEAN_TEXT = /^(?:true|false)$/iu;
+const DATE_TEXT = /^(?<year>\d{4})-(?<month>\d{2})-(?<day>\d{2})$/u;
+const TIMESTAMP_TEXT = /^(?<year>\d{4})-(?<month>\d{2})-(?<day>\d{2})[ T](?<hour>\d{2}):(?<minute>\d{2})(?::(?<second>\d{2})(?:\.\d{1,9})?)?$/u;
+const INT32 = { min: -(2n ** 31n), max: 2n ** 31n - 1n };
+const INT64 = { min: -(2n ** 63n), max: 2n ** 63n - 1n };
+const fits = (text, range) => {
+    const value = BigInt(text);
+    return value >= range.min && value <= range.max;
+};
+/** Whether year, month and day name a real day */
+const isDay = (year, month, day) => {
+    const date = new Date(Date.UTC(Number(year), Number(month) - 1, Number(day)));
+    return (date.getUTCFullYear() === Number(year) &&
+        date.getUTCMonth() === Number(month) - 1 &&
+        date.getUTCDate() === Number(day));
+};
+const isDate = (text) => {
+    const day = DATE_TEXT.exec(text)?.groups;
+    return Boolean(day && isDay(day.year ?? '', day.month ?? '', day.day ?? ''));
+};
+const isTimestamp = (text) => {
+    const at = TIMESTAMP_TEXT.exec(text)?.groups;
+    return Boolean(at &&
+        isDay(at.year ?? '', at.month ?? '', at.day ?? '') &&
+        Number(at.hour) < 24 &&
+        Number(at.minute) < 60 &&
+        Number(at.second ?? '0') < 60);
+};
+/**
+ * A column's type from its values, empty ones left out: the narrowest type
+ * every value fits. Whole numbers with a leading zero (codes, such as
+ * `007`) and ones past 64 bits stay text, so no digit is lost; numbers
+ * with a fraction are DOUBLE. A column of empty values is text.
+ */
+export const inferCubeCsvColumnType = (values) => {
+    const present = values.filter((value) => value !== '');
+    if (!present.length) {
+        return CubeCsvColumnType.VARCHAR;
+    }
+    if (present.every((value) => INTEGER_TEXT.test(value))) {
+        if (present.every((value) => fits(value, INT32))) {
+            return CubeCsvColumnType.INTEGER;
+        }
+        return present.every((value) => fits(value, INT64))
+            ? CubeCsvColumnType.BIGINT
+            : CubeCsvColumnType.VARCHAR;
+    }
+    if (present.every((value) => NUMBER_TEXT.test(value)) &&
+        // a whole number with a leading zero is a code, not a number
+        !present.some((value) => /^[+-]?0\d/u.test(value))) {
+        return CubeCsvColumnType.DOUBLE;
+    }
+    if (present.every((value) => BOOLEAN_TEXT.test(value))) {
+        return CubeCsvColumnType.BOOLEAN;
+    }
+    if (present.every(isDate)) {
+        return CubeCsvColumnType.DATE;
+    }
+    if (present.every((value) => isDate(value) || isTimestamp(value))) {
+        return CubeCsvColumnType.TIMESTAMP;
+    }
+    return CubeCsvColumnType.VARCHAR;
+};
+/**
+ * The keywords that can't name a column or table unquoted: DuckDB's
+ * `reserved` and `type_function` ones, as `duckdb_keywords()` lists them on
+ * the engine's DuckDB (1.3)
+ */
+const RESERVED_WORDS = new Set([
+    'all',
+    'analyse',
+    'analyze',
+    'and',
+    'anti',
+    'any',
+    'array',
+    'as',
+    'asc',
+    'asof',
+    'asymmetric',
+    'at',
+    'authorization',
+    'binary',
+    'both',
+    'case',
+    'cast',
+    'check',
+    'collate',
+    'collation',
+    'column',
+    'columns',
+    'concurrently',
+    'constraint',
+    'create',
+    'cross',
+    'default',
+    'deferrable',
+    'desc',
+    'describe',
+    'distinct',
+    'do',
+    'else',
+    'end',
+    'except',
+    'false',
+    'fetch',
+    'for',
+    'foreign',
+    'freeze',
+    'from',
+    'full',
+    'generated',
+    'glob',
+    'group',
+    'having',
+    'ilike',
+    'in',
+    'initially',
+    'inner',
+    'intersect',
+    'into',
+    'is',
+    'isnull',
+    'join',
+    'lambda',
+    'lateral',
+    'leading',
+    'left',
+    'like',
+    'limit',
+    'map',
+    'natural',
+    'not',
+    'notnull',
+    'null',
+    'offset',
+    'on',
+    'only',
+    'or',
+    'order',
+    'outer',
+    'overlaps',
+    'pivot',
+    'pivot_longer',
+    'pivot_wider',
+    'placing',
+    'positional',
+    'primary',
+    'qualify',
+    'references',
+    'returning',
+    'right',
+    'select',
+    'semi',
+    'show',
+    'similar',
+    'some',
+    'struct',
+    'summarize',
+    'symmetric',
+    'table',
+    'tablesample',
+    'then',
+    'to',
+    'trailing',
+    'true',
+    'try_cast',
+    'union',
+    'unique',
+    'unpack',
+    'unpivot',
+    'using',
+    'variadic',
+    'verbose',
+    'when',
+    'where',
+    'window',
+    'with',
+]);
+/**
+ * A name the database takes unquoted: letters, digits and underscores, not
+ * starting with a digit, and no reserved word (one gets a trailing
+ * underscore)
+ */
+export const toCubeCsvName = (text, fallback) => {
+    const name = text.trim().replace(/[^A-Za-z0-9_]+/gu, '_');
+    const safe = !name || /^_*$/u.test(name) ? fallback : name;
+    const start = /^[0-9]/u.test(safe) ? `_${safe}` : safe;
+    return RESERVED_WORDS.has(start.toLowerCase()) ? `${start}_` : start;
+};
+/** The header's names made safe, and distinct whatever their case */
+const toColumnNames = (header) => {
+    const used = new Set();
+    return header.map((text, index) => {
+        const base = toCubeCsvName(text, `column_${index + 1}`);
+        let name = base;
+        for (let suffix = 2; used.has(name.toLowerCase()); suffix++) {
+            name = `${base}_${suffix}`;
+        }
+        used.add(name.toLowerCase());
+        return name;
+    });
+};
+/** A string literal: quotes doubled, line breaks as chr(10), so no line of the setup SQL ends inside it */
+const quote = (value) => `'${value
+    .replace(/'/gu, "''")
+    .split(/\r\n|\r|\n/u)
+    .join("' || chr(10) || '")}'`;
+const toLiteral = (value, type) => {
+    if (value === '') {
+        return 'NULL';
+    }
+    switch (type) {
+        case CubeCsvColumnType.INTEGER:
+        case CubeCsvColumnType.BIGINT:
+        case CubeCsvColumnType.DOUBLE:
+            return value;
+        case CubeCsvColumnType.BOOLEAN:
+            return value.toLowerCase();
+        case CubeCsvColumnType.DATE:
+            return `DATE '${value}'`;
+        case CubeCsvColumnType.TIMESTAMP:
+            return `TIMESTAMP '${value.replace('T', ' ')}'`;
+        default:
+            return quote(value);
+    }
+};
+/**
+ * A CSV, with a header row, as a table of the `csv` schema: setup SQL that
+ * creates the schema if needed, drops and creates the table, then inserts
+ * the rows. Refuses an empty CSV, a record whose values don't match the
+ * header, and one past the limits.
+ */
+export const buildCubeCsvTable = (text, tableName) => {
+    if (text.length > CUBE_CSV_MAX_LENGTH) {
+        throw new CubeCsvError(CUBE_CSV_MESSAGE.TOO_LONG(CUBE_CSV_MAX_LENGTH));
+    }
+    const [header, ...rows] = parseCubeCsv(text);
+    if (!header) {
+        throw new CubeCsvError(CUBE_CSV_MESSAGE.EMPTY);
+    }
+    if (rows.length > CUBE_CSV_MAX_ROWS) {
+        throw new CubeCsvError(CUBE_CSV_MESSAGE.TOO_MANY_ROWS(rows.length, CUBE_CSV_MAX_ROWS));
+    }
+    rows.forEach((row, index) => {
+        if (row.length !== header.length) {
+            throw new CubeCsvError(CUBE_CSV_MESSAGE.RAGGED_ROW(index + 1, row.length, header.length));
+        }
+    });
+    const table = toCubeCsvName(tableName, 'csv_data');
+    const names = toColumnNames(header);
+    const columns = names.map((name, index) => ({
+        name,
+        type: inferCubeCsvColumnType(rows.map((row) => row[index] ?? '')),
+    }));
+    const qualified = `${CUBE_CSV_SCHEMA}.${table}`;
+    const statements = [
+        `create schema if not exists ${CUBE_CSV_SCHEMA};`,
+        `drop table if exists ${qualified};`,
+        `create table ${qualified} (${columns
+            .map((column) => `${column.name} ${column.type}`)
+            .join(', ')});`,
+    ];
+    for (let start = 0; start < rows.length; start += ROWS_PER_INSERT) {
+        const chunk = rows.slice(start, start + ROWS_PER_INSERT);
+        statements.push([
+            `insert into ${qualified} values`,
+            ...chunk.map((row, index) => `(${row
+                .map((value, column) => toLiteral(value, columns[column]?.type ?? CubeCsvColumnType.VARCHAR))
+                .join(', ')})${index === chunk.length - 1 ? ';' : ','}`),
+        ].join('\n'));
+    }
+    return { table, columns, rowCount: rows.length, sql: statements.join('\n') };
+};
+//# sourceMappingURL=CubeCsvSetupSql.js.map