@finos/legend-data-cube 0.0.7 → 0.0.9

package/src/components/{filter → view/filter}/DataCubeFilterEditor.tsx

@@ -30,18 +30,18 @@ import {
   DataCubeQueryFilterGroupOperator,
   getDataType,
   type DataCubeOperationValue,
-} from '../../stores/core/DataCubeQueryEngine.js';
+} from '../../../stores/core/DataCubeQueryEngine.js';
 import {
   DataCubeFilterEditorConditionGroupTreeNode,
   DataCubeFilterEditorConditionTreeNode,
   type DataCubeFilterEditorTreeNode,
-} from '../../stores/core/filter/DataCubeQueryFilterEditorState.js';
+} from '../../../stores/core/filter/DataCubeQueryFilterEditorState.js';
 import {
   FormDropdownMenu,
   FormDropdownMenuItem,
   FormDropdownMenuTrigger,
-} from '../shared/DataCubeFormUtils.js';
-import type { DataCubeViewState } from '../../stores/DataCubeViewState.js';
+} from '../../core/DataCubeFormUtils.js';
+import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.js';
 import { forwardRef, useCallback, useEffect, useRef, useState } from 'react';
 import { DATE_FORMAT, PRIMITIVE_TYPE } from '@finos/legend-graph';
 import {
@@ -293,10 +293,10 @@ const DataCubeEditorFilterConditionNodeColumnSelector = observer(
       (column) => column.name === value,
     );
     const [
-      openColumnsDropdown,
-      closeColumnsDropdown,
-      columnsDropdownProps,
-      columnsDropdownPropsOpen,
+      openColumnDropdown,
+      closeColumnDropdown,
+      columnDropdownProps,
+      columnDropdownPropsOpen,
     ] = useDropdownMenu();
 
     return (
@@ -304,12 +304,12 @@ const DataCubeEditorFilterConditionNodeColumnSelector = observer(
         <FormDropdownMenuTrigger
           ref={ref}
           className="relative mr-1 w-32"
-          onClick={openColumnsDropdown}
-          open={columnsDropdownPropsOpen}
+          onClick={openColumnDropdown}
+          open={columnDropdownPropsOpen}
         >
           {value}
         </FormDropdownMenuTrigger>
-        <FormDropdownMenu className="w-32" {...columnsDropdownProps}>
+        <FormDropdownMenu className="w-32" {...columnDropdownProps}>
           {editor.columns
             .filter(
               (column) =>
@@ -321,7 +321,7 @@ const DataCubeEditorFilterConditionNodeColumnSelector = observer(
                 key={column.name}
                 onClick={() => {
                   updateValue(column.name);
-                  closeColumnsDropdown();
+                  closeColumnDropdown();
                 }}
                 autoFocus={value === column.name}
               >
@@ -477,16 +477,16 @@ const DataCubeEditorFilterConditionNodeDisplay = observer(
     const nodeIdx = parentNode ? parentNode.children.indexOf(node) : undefined;
     const valueEditorRef = useRef<HTMLElement>(null);
     const [
-      openColumnsDropdown,
-      closeColumnsDropdown,
-      columnsDropdownProps,
-      columnsDropdownPropsOpen,
+      openColumnDropdown,
+      closeColumnDropdown,
+      columnDropdownProps,
+      columnDropdownPropsOpen,
     ] = useDropdownMenu();
     const [
-      openOperatorsDropdown,
-      closeOperatorsDropdown,
-      operatorsDropdownProps,
-      operatorsDropdownPropsOpen,
+      openOperationDropdown,
+      closeOperationDropdown,
+      operationDropdownProps,
+      operationDropdownPropsOpen,
     ] = useDropdownMenu();
     const focusOnValueEditor = useCallback(
       () => valueEditorRef.current?.focus(),
@@ -551,14 +551,14 @@ const DataCubeEditorFilterConditionNodeDisplay = observer(
         {node.not && <DataCubeEditorFilterNotLabel />}
         <FormDropdownMenuTrigger
           className="relative mr-1 w-32"
-          onClick={openColumnsDropdown}
-          open={columnsDropdownPropsOpen}
+          onClick={openColumnDropdown}
+          open={columnDropdownPropsOpen}
         >
           {node.column.name}
         </FormDropdownMenuTrigger>
         <FormDropdownMenu
           className="w-32"
-          {...columnsDropdownProps}
+          {...columnDropdownProps}
           onClosed={focusOnValueEditor}
         >
           {editor.columns.map((column) => (
@@ -579,7 +579,7 @@ const DataCubeEditorFilterConditionNodeDisplay = observer(
                     node.setValue(newOp.generateDefaultValue(column));
                   }
                 }
-                closeColumnsDropdown();
+                closeColumnDropdown();
               }}
               autoFocus={node.column.name === column.name}
             >
@@ -589,14 +589,14 @@ const DataCubeEditorFilterConditionNodeDisplay = observer(
         </FormDropdownMenu>
         <FormDropdownMenuTrigger
           className="relative mr-1 w-24"
-          onClick={openOperatorsDropdown}
-          open={operatorsDropdownPropsOpen}
+          onClick={openOperationDropdown}
+          open={operationDropdownPropsOpen}
         >
           {node.operation.label}
         </FormDropdownMenuTrigger>
         <FormDropdownMenu
           className="w-24"
-          {...operatorsDropdownProps}
+          {...operationDropdownProps}
           onClosed={focusOnValueEditor}
         >
           {editor.view.engine.filterOperations
@@ -611,7 +611,7 @@ const DataCubeEditorFilterConditionNodeDisplay = observer(
                       node.setValue(op.generateDefaultValue(node.column));
                     }
                   }
-                  closeOperatorsDropdown();
+                  closeOperationDropdown();
                 }}
                 autoFocus={node.operation.operator === op.operator}
               >
@@ -645,10 +645,10 @@ const DataCubeEditorFilterGroupNodeDisplay = observer(
     const parentNode = node.parent;
     const nodeIdx = parentNode ? parentNode.children.indexOf(node) : undefined;
     const [
-      openOperatorsDropdown,
-      closeOperatorsDropdown,
-      operatorsDropdownProps,
-      operatorsDropdownPropsOpen,
+      openOperationDropdown,
+      closeOperationDropdown,
+      operationDropdownProps,
+      operationDropdownPropsOpen,
     ] = useDropdownMenu();
 
     return (
@@ -713,18 +713,18 @@ const DataCubeEditorFilterGroupNodeDisplay = observer(
         )}
         <FormDropdownMenuTrigger
           className="relative w-14"
-          onClick={openOperatorsDropdown}
-          open={operatorsDropdownPropsOpen}
+          onClick={openOperationDropdown}
+          open={operationDropdownPropsOpen}
         >
           {node.operation === DataCubeQueryFilterGroupOperator.AND
             ? 'All of'
             : 'Any of'}
         </FormDropdownMenuTrigger>
-        <FormDropdownMenu className="w-14" {...operatorsDropdownProps}>
+        <FormDropdownMenu className="w-14" {...operationDropdownProps}>
           <FormDropdownMenuItem
             onClick={() => {
               node.setOperation(DataCubeQueryFilterGroupOperator.AND);
-              closeOperatorsDropdown();
+              closeOperationDropdown();
             }}
             autoFocus={node.operation === DataCubeQueryFilterGroupOperator.AND}
           >
@@ -733,7 +733,7 @@ const DataCubeEditorFilterGroupNodeDisplay = observer(
           <FormDropdownMenuItem
             onClick={() => {
               node.setOperation(DataCubeQueryFilterGroupOperator.OR);
-              closeOperatorsDropdown();
+              closeOperationDropdown();
             }}
             autoFocus={node.operation === DataCubeQueryFilterGroupOperator.OR}
           >

package/src/components/{grid → view/grid}/DataCubeGrid.tsx

@@ -35,7 +35,7 @@ import {
   generateTextAlignUtilityClassName,
   generateTextColorUtilityClassName,
   INTERNAL__GridClientUtilityCssClassName,
-} from '../../stores/grid/DataCubeGridClientEngine.js';
+} from '../../../stores/view/grid/DataCubeGridClientEngine.js';
 import { RangeSelectionModule } from '@ag-grid-enterprise/range-selection';
 import {
   DataCubeFont,
@@ -44,14 +44,14 @@ import {
   DataCubeFontTextAlignment,
   DEFAULT_ROW_BACKGROUND_COLOR,
   DEFAULT_ROW_HIGHLIGHT_BACKGROUND_COLOR,
-} from '../../stores/core/DataCubeQueryEngine.js';
+} from '../../../stores/core/DataCubeQueryEngine.js';
 import { isNonNullable } from '@finos/legend-shared';
 import type {
   DataCubeConfiguration,
   DataCubeConfigurationColorKey,
-} from '../../stores/core/DataCubeConfiguration.js';
-import { generateBaseGridOptions } from '../../stores/grid/DataCubeGridConfigurationBuilder.js';
-import type { DataCubeViewState } from '../../stores/DataCubeViewState.js';
+} from '../../../stores/core/DataCubeConfiguration.js';
+import { generateBaseGridOptions } from '../../../stores/view/grid/DataCubeGridConfigurationBuilder.js';
+import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.js';
 
 // NOTE: This is a workaround to prevent ag-grid license key check from flooding the console screen
 // with its stack trace in Chrome.

package/src/components/{grid → view/grid}/DataCubeGridShared.tsx

@@ -18,7 +18,7 @@ import {
   useGridMenuItem,
   type CustomMenuItemProps,
 } from '@ag-grid-community/react';
-import { FormBadge_WIP } from '../shared/DataCubeFormUtils.js';
+import { FormBadge_WIP } from '../../core/DataCubeFormUtils.js';
 
 export function WIP_GridMenuItem({
   name,

package/src/index.tsx

@@ -14,12 +14,11 @@
  * limitations under the License.
  */
 
-export * from './stores/engine/DataCubeEngine.js';
-export * from './stores/engine/DataCubeApplicationEngine.js';
+export * from './stores/core/DataCubeEngine.js';
+export * from './stores/core/DataCubeApplicationEngine.js';
+export * from './stores/core/DataCubeQuery.js';
+export * from './stores/core/DataCubeQueryBuilderUtils.js';
 
-export * from './components/application/DataCubeAlert.js';
+export * from './components/core/DataCubeAlert.js';
 export * from './components/DataCube.js';
 export * from './components/DataCubeProvider.js';
-
-export * from './stores/engine/DataCubeQuery.js';
-export * from './stores/core/DataCubeQueryBuilderUtils.js';

package/src/stores/DataCubeState.tsx

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-import { type DataCubeEngine } from './engine/DataCubeEngine.js';
-import { DataCubeViewState } from './DataCubeViewState.js';
-import type { DisplayState } from './engine/DataCubeLayoutManagerState.js';
-import { DocumentationPanel } from '../components/application/DataCubeDocumentationPanel.js';
-import { DataCubeSettingsPanel } from '../components/application/DataCubeSettingsPanel.js';
+import { type DataCubeEngine } from './core/DataCubeEngine.js';
+import { DataCubeViewState } from './view/DataCubeViewState.js';
+import type { DisplayState } from './core/DataCubeLayoutManagerState.js';
+import { DocumentationPanel } from '../components/core/DataCubeDocumentationPanel.js';
+import { DataCubeSettingsPanel } from '../components/core/DataCubeSettingsPanel.js';
 import { ActionState, assertErrorThrown } from '@finos/legend-shared';
-import { AlertType } from '../components/application/DataCubeAlert.js';
-import { type DataCubeApplicationEngine } from './engine/DataCubeApplicationEngine.js';
+import { AlertType } from '../components/core/DataCubeAlert.js';
+import { type DataCubeApplicationEngine } from './core/DataCubeApplicationEngine.js';
 
 export class DataCubeState {
   readonly application: DataCubeApplicationEngine;
@@ -39,7 +39,11 @@ export class DataCubeState {
   constructor(application: DataCubeApplicationEngine, engine: DataCubeEngine) {
     this.application = application;
     this.engine = engine;
-    this.engine.viewTaskRunner = (task) => this.runTaskForAllViews(task);
+    this.engine.gridClientTaskRunner = (task) => {
+      // TODO: When we support multi-view (i.e. multiple instances of DataCubes) we would need
+      // to traverse through and update the configurations of all of their grid clients
+      task(this.view.grid.client);
+    };
     this.view = new DataCubeViewState(this);
 
     this.settingsDisplay = this.application.layout.newDisplay(
@@ -70,12 +74,6 @@ export class DataCubeState {
     );
   }
 
-  private runTaskForAllViews(task: (view: DataCubeViewState) => void): void {
-    // TODO: When we support multi-view (i.e. multiple instances of DataCubes) we would need
-    // to traverse through and update the configurations of all of their grid clients
-    task(this.view);
-  }
-
   async initialize() {
     if (!this.initState.isInInitialState) {
       this.application.logDebug('REPL store is re-initialized');

package/src/stores/{engine → core}/DataCubeApplicationEngine.tsx

@@ -14,14 +14,18 @@
  * limitations under the License.
  */
 
-import type { LogEvent, DocumentationEntry } from '@finos/legend-shared';
+import {
+  type LogEvent,
+  type DocumentationEntry,
+  uuid,
+} from '@finos/legend-shared';
 import { action, makeObservable, observable } from 'mobx';
 import {
   Alert,
   AlertType,
   type ActionAlert,
   type ActionAlertAction,
-} from '../../components/application/DataCubeAlert.js';
+} from '../../components/core/DataCubeAlert.js';
 import {
   DEFAULT_SMALL_ALERT_WINDOW_CONFIG,
   LayoutConfiguration,
@@ -29,6 +33,10 @@ import {
   WindowState,
   type WindowConfiguration,
 } from './DataCubeLayoutManagerState.js';
+import type { DataCubeQueryBuilderError } from './DataCubeEngine.js';
+import { CODE_EDITOR_LANGUAGE } from '@finos/legend-code-editor';
+import { editor as monacoEditorAPI, Uri } from 'monaco-editor';
+import { DataCubeCodeCheckErrorAlert } from '../../components/core/DataCubeCodeCheckErrorAlert.js';
 
 export abstract class DataCubeApplicationEngine {
   readonly layout: LayoutManagerState;
@@ -57,15 +65,44 @@ export abstract class DataCubeApplicationEngine {
   abstract setWindowTitle(title: string): void;
 
   abstract logDebug(message: string, ...data: unknown[]): void;
-  abstract debugProcess(processName: string, ...data: unknown[]): void;
+  abstract debugProcess(
+    processName: string,
+    ...data: [string, unknown][]
+  ): void;
   abstract logInfo(event: LogEvent, ...data: unknown[]): void;
   abstract logWarning(event: LogEvent, ...data: unknown[]): void;
   abstract logError(event: LogEvent, ...data: unknown[]): void;
   abstract logUnhandledError(error: Error): void;
   abstract logIllegalStateError(message: string, error?: Error): void;
 
-  abstract alertAction(alertInfo: ActionAlert | undefined): void;
-  abstract alertUnhandledError(error: Error): void;
+  alert(options: {
+    message: string;
+    type: AlertType;
+    text?: string | undefined;
+    actions?: ActionAlertAction[] | undefined;
+    windowTitle?: string | undefined;
+    windowConfig?: WindowConfiguration | undefined;
+  }) {
+    const { message, type, text, actions, windowTitle, windowConfig } = options;
+    const window = new WindowState(
+      new LayoutConfiguration(windowTitle ?? '', () => (
+        <Alert
+          type={type}
+          message={message}
+          text={text}
+          actions={actions}
+          onClose={() => this.layout.closeWindow(window)}
+        />
+      )),
+    );
+    window.configuration.window =
+      windowConfig ?? DEFAULT_SMALL_ALERT_WINDOW_CONFIG;
+    this.layout.newWindow(window);
+  }
+
+  alertAction(alertInfo: ActionAlert | undefined) {
+    this.currentActionAlert = alertInfo;
+  }
 
   alertError(
     error: Error,
@@ -93,28 +130,71 @@ export abstract class DataCubeApplicationEngine {
     this.layout.newWindow(window);
   }
 
-  alert(options: {
-    message: string;
-    type: AlertType;
-    text?: string | undefined;
-    actions?: ActionAlertAction[] | undefined;
-    windowTitle?: string | undefined;
-    windowConfig?: WindowConfiguration | undefined;
-  }) {
-    const { message, type, text, actions, windowTitle, windowConfig } = options;
-    const window = new WindowState(
-      new LayoutConfiguration(windowTitle ?? '', () => (
-        <Alert
-          type={type}
-          message={message}
-          text={text}
-          actions={actions}
-          onClose={() => this.layout.closeWindow(window)}
-        />
-      )),
-    );
-    window.configuration.window =
-      windowConfig ?? DEFAULT_SMALL_ALERT_WINDOW_CONFIG;
-    this.layout.newWindow(window);
+  alertUnhandledError(error: Error) {
+    this.logUnhandledError(error);
+    this.alertError(error, {
+      message: error.message,
+    });
+  }
+
+  alertCodeCheckError(
+    error: DataCubeQueryBuilderError,
+    code: string,
+    codePrefix: string,
+    options: {
+      message: string;
+      text?: string | undefined;
+      actions?: ActionAlertAction[] | undefined;
+      windowTitle?: string | undefined;
+      windowConfig?: WindowConfiguration | undefined;
+    },
+  ) {
+    const { message, text, windowTitle, windowConfig } = options;
+    // correct the source information since we added prefix to the code
+    // and reveal error in the editor
+    if (error.sourceInformation) {
+      error.sourceInformation.startColumn -=
+        error.sourceInformation.startLine === 1 ? codePrefix.length : 0;
+      error.sourceInformation.endColumn -=
+        error.sourceInformation.endLine === 1 ? codePrefix.length : 0;
+      const editorModel = monacoEditorAPI.createModel(
+        code,
+        CODE_EDITOR_LANGUAGE.PURE,
+        Uri.file(`/${uuid()}.pure`),
+      );
+
+      const fullRange = editorModel.getFullModelRange();
+      if (
+        error.sourceInformation.startLine < 1 ||
+        (error.sourceInformation.startLine === 1 &&
+          error.sourceInformation.startColumn < 1) ||
+        error.sourceInformation.endLine > fullRange.endLineNumber ||
+        (error.sourceInformation.endLine === fullRange.endLineNumber &&
+          error.sourceInformation.endColumn > fullRange.endColumn)
+      ) {
+        error.sourceInformation.startColumn = fullRange.startColumn;
+        error.sourceInformation.startLine = fullRange.startLineNumber;
+        error.sourceInformation.endColumn = fullRange.endColumn;
+        error.sourceInformation.endLine = fullRange.endLineNumber;
+      }
+      const window = new WindowState(
+        new LayoutConfiguration(windowTitle ?? 'Error', () => (
+          <DataCubeCodeCheckErrorAlert
+            editorModel={editorModel}
+            error={error}
+            message={message}
+            text={text}
+          />
+        )),
+      );
+      window.configuration.window = windowConfig ?? {
+        width: 500,
+        height: 400,
+        minWidth: 300,
+        minHeight: 300,
+        center: true,
+      };
+      this.layout.newWindow(window);
+    }
   }
 }

package/src/stores/core/DataCubeConfiguration.ts

@@ -157,6 +157,10 @@ export class DataCubeColumnConfiguration {
       zeroForegroundColor: optional(primitive()),
     }),
   );
+
+  serialize() {
+    return DataCubeColumnConfiguration.serialization.toJson(this);
+  }
 }
 
 export class DataCubePivotLayoutConfiguration {
@@ -167,6 +171,10 @@ export class DataCubePivotLayoutConfiguration {
       expandedPaths: list(primitive()),
     }),
   );
+
+  serialize() {
+    return DataCubePivotLayoutConfiguration.serialization.toJson(this);
+  }
 }
 
 export class DataCubeConfiguration {
@@ -255,4 +263,8 @@ export class DataCubeConfiguration {
       zeroForegroundColor: primitive(),
     }),
   );
+
+  serialize() {
+    return DataCubeConfiguration.serialization.toJson(this);
+  }
 }

package/src/stores/core/DataCubeConfigurationBuilder.ts

@@ -20,7 +20,7 @@ import {
   DataCubeConfiguration,
 } from './DataCubeConfiguration.js';
 import {
-  DataCubeAggregateOperator,
+  DataCubeQueryAggregateOperator,
   DataCubeColumnKind,
   DataCubeFontTextAlignment,
 } from './DataCubeQueryEngine.js';
@@ -42,14 +42,14 @@ export function buildDefaultColumnConfiguration(column: {
       config.negativeNumberInParens = true;
       config.textAlign = DataCubeFontTextAlignment.RIGHT; // always align number to the right
       config.excludedFromPivot = false;
-      config.aggregateOperator = DataCubeAggregateOperator.SUM;
-      config.pivotStatisticColumnFunction = DataCubeAggregateOperator.SUM;
+      config.aggregateOperator = DataCubeQueryAggregateOperator.SUM;
+      config.pivotStatisticColumnFunction = DataCubeQueryAggregateOperator.SUM;
       break;
     }
     default: {
       config.kind = DataCubeColumnKind.DIMENSION;
       config.excludedFromPivot = true;
-      config.aggregateOperator = DataCubeAggregateOperator.UNIQUE;
+      config.aggregateOperator = DataCubeQueryAggregateOperator.UNIQUE;
       break;
     }
   }