@finos/legend-application-repl 0.0.30 → 0.0.32

package/src/components/dataCube/grid/menu/DataCubeGridMenu.tsx

@@ -0,0 +1,441 @@
+/**
+ * Copyright (c) 2020-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 {
+  GetContextMenuItemsParams,
+  GetMainMenuItemsParams,
+  MenuItemDef,
+} from '@ag-grid-community/core';
+import type { DataCubeState } from '../../../../stores/dataCube/DataCubeState.js';
+import { buildGridSortsMenu } from './DataCubeGridSortsMenu.js';
+import { WIP_GridMenuItem } from '../DataCubeGridShared.js';
+import {
+  DataCubeColumnPinPlacement,
+  DEFAULT_COLUMN_MIN_WIDTH,
+} from '../../../../stores/dataCube/core/DataCubeQueryEngine.js';
+import { isNonNullable } from '@finos/legend-shared';
+
+export function buildGridMenu(
+  params:
+    | GetContextMenuItemsParams<unknown, { dataCube: DataCubeState }>
+    | GetMainMenuItemsParams<unknown, { dataCube: DataCubeState }>,
+): (string | MenuItemDef)[] {
+  const context = params.context;
+  const dataCube = context.dataCube;
+  const editor = dataCube.editor;
+  const column = params.column ?? undefined;
+  const columnConfiguration = editor.columnProperties.getColumnConfiguration(
+    column?.getColId(),
+  );
+  const value: unknown = 'value' in params ? params.value : undefined;
+
+  const result: (string | MenuItemDef)[] = [
+    {
+      name: 'Export',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      subMenu: [
+        {
+          name: 'HTML',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'PDF',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Excel',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'CSV',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        'separator',
+        {
+          name: 'DataCube Specification',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    {
+      name: 'Email',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      subMenu: [
+        {
+          name: 'HTML',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        'separator',
+        {
+          name: 'HTML Attachment',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'PDF Attachment',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Excel Attachment',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'CSV Attachment',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'DataCube Specification Attachment',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    {
+      name: 'Copy',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      subMenu: [
+        {
+          name: 'Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Selected Row(s) as Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: 'Selected Column as Plain Text',
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    'separator',
+    buildGridSortsMenu(editor, column, value),
+    {
+      name: 'Filter',
+      menuItem: WIP_GridMenuItem,
+      disabled: true,
+      cssClasses: ['!opacity-100'],
+      subMenu: [
+        ...(column && value
+          ? [
+              {
+                name: `Add Filter: ${column.getColId()} = {value}`,
+                menuItem: WIP_GridMenuItem,
+                cssClasses: ['!opacity-100'],
+                disabled: true,
+              },
+              {
+                name: `More Filters on ${column.getColId()}...`,
+                menuItem: WIP_GridMenuItem,
+                cssClasses: ['!opacity-100'],
+                disabled: true,
+                subMenu: [], // TODO
+              },
+              'separator',
+            ]
+          : []),
+        {
+          name: 'Filters...',
+        },
+        {
+          name: 'Clear All Filters',
+        },
+      ],
+    },
+    {
+      name: 'Pivot',
+      menuItem: WIP_GridMenuItem,
+      disabled: true,
+      cssClasses: ['!opacity-100'],
+      subMenu: [
+        ...(column
+          ? [
+              {
+                name: `VPivot on ${column.getColId()}`,
+                menuItem: WIP_GridMenuItem,
+                cssClasses: ['!opacity-100'],
+                disabled: true,
+              },
+              {
+                name: `Add VPivot on ${column.getColId()}`,
+                menuItem: WIP_GridMenuItem,
+                cssClasses: ['!opacity-100'],
+                disabled: true,
+              },
+              {
+                name: `Remove VPivot on ${column.getColId()}`,
+                menuItem: WIP_GridMenuItem,
+                cssClasses: ['!opacity-100'],
+                disabled: true,
+              },
+              'separator',
+            ]
+          : []),
+        {
+          name: `Clear All VPivots`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    {
+      name: 'Heatmap',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: !column,
+      subMenu: column
+        ? [
+            {
+              name: `Add to ${column.getColId()}`,
+              menuItem: WIP_GridMenuItem,
+              cssClasses: ['!opacity-100'],
+              disabled: true,
+            },
+            {
+              name: `Remove from ${column.getColId()}`,
+              menuItem: WIP_GridMenuItem,
+              cssClasses: ['!opacity-100'],
+              disabled: true,
+            },
+          ]
+        : [],
+    },
+    {
+      name: 'Extended Columns',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: true,
+      subMenu: [
+        {
+          name: `Add New Column...`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: `Edit {column}`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: `Remove {column}`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    {
+      name: 'Custom Groupings',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: true,
+      subMenu: [
+        {
+          name: `Add New Grouping...`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: `Edit {column}`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+        {
+          name: `Remove {column}`,
+          menuItem: WIP_GridMenuItem,
+          cssClasses: ['!opacity-100'],
+          disabled: true,
+        },
+      ],
+    },
+    'separator',
+    {
+      name: 'Resize',
+      subMenu: [
+        {
+          name: `Auto-size to Fit Content`,
+          action: () =>
+            params.api.autoSizeColumns(
+              [column?.getColId()].filter(isNonNullable),
+            ),
+          disabled: !column,
+        },
+        {
+          name: `Minimize Column`,
+          action: () => {
+            if (column) {
+              params.api.setColumnWidths([
+                {
+                  key: column.getColId(),
+                  newWidth:
+                    columnConfiguration?.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH,
+                },
+              ]);
+            }
+          },
+          disabled: !column,
+        },
+        'separator',
+        {
+          name: `Auto-size All Columns`,
+          action: () => params.api.autoSizeAllColumns(),
+        },
+        {
+          name: `Minimize All Columns`,
+          action: () => {
+            params.api.setColumnWidths(
+              dataCube.editor.columnProperties.columns.map((col) => ({
+                key: col.name,
+                newWidth:
+                  columnConfiguration?.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH,
+              })),
+            );
+          },
+        },
+        {
+          name: `Size Grid to Fit Screen`,
+          action: () => params.api.sizeColumnsToFit(),
+        },
+      ],
+    },
+    {
+      name: 'Pin',
+      subMenu: [
+        {
+          name: `Pin Left`,
+          disabled: !column || column.isPinnedLeft(),
+          checked: Boolean(column?.isPinnedLeft()),
+          action: () => {
+            columnConfiguration?.setPinned(DataCubeColumnPinPlacement.LEFT);
+            editor.applyChanges();
+          },
+        },
+        {
+          name: `Pin Right`,
+          disabled: !column || column.isPinnedRight(),
+          checked: Boolean(column?.isPinnedRight()),
+          action: () => {
+            columnConfiguration?.setPinned(DataCubeColumnPinPlacement.RIGHT);
+            editor.applyChanges();
+          },
+        },
+        {
+          name: `Unpin`,
+          disabled: !column?.isPinned(),
+          action: () => {
+            columnConfiguration?.setPinned(undefined);
+            editor.applyChanges();
+          },
+        },
+        'separator',
+        {
+          name: `Remove All Pinnings`,
+          disabled: editor.columnProperties.columns.every(
+            (col) => col.pinned === undefined,
+          ),
+          action: () => {
+            editor.columnProperties.columns.forEach((col) =>
+              col.setPinned(undefined),
+            );
+            editor.applyChanges();
+          },
+        },
+      ],
+    },
+    {
+      name: 'Hide',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: true,
+    },
+    'separator',
+    {
+      name: 'Show Plot...',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: true,
+    },
+    {
+      name: 'Show TreeMap...',
+      menuItem: WIP_GridMenuItem,
+      cssClasses: ['!opacity-100'],
+      disabled: true,
+    },
+    'separator',
+    {
+      name: 'Properties...',
+      disabled: editor.isPanelOpen,
+      action: () => {
+        if (!editor.isPanelOpen) {
+          editor.openPanel();
+        }
+      },
+    },
+  ];
+  return result;
+}

package/src/components/dataCube/grid/menu/DataCubeGridSortsMenu.tsx

@@ -0,0 +1,119 @@
+/**
+ * Copyright (c) 2020-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 { Column, MenuItemDef } from '@ag-grid-community/core';
+import type { DataCubeEditorState } from '../../../../stores/dataCube/editor/DataCubeEditorState.js';
+import { DataCubeQuerySnapshotSortOperation } from '../../../../stores/dataCube/core/DataCubeQuerySnapshot.js';
+import { WIP_GridMenuItem } from '../DataCubeGridShared.js';
+
+export function buildGridSortsMenu(
+  editor: DataCubeEditorState,
+  column: Column | undefined,
+  value: unknown,
+): MenuItemDef {
+  if (!column) {
+    return {
+      name: 'Sort',
+      disabled: true,
+      subMenu: [],
+    };
+  }
+
+  return {
+    name: 'Sort',
+    subMenu: [
+      {
+        name: 'Ascending',
+        disabled: !editor.sorts.getActionableSortColumn(
+          column.getColId(),
+          DataCubeQuerySnapshotSortOperation.ASCENDING,
+        ),
+        action: () =>
+          editor.sorts.sortByColumn(
+            column.getColId(),
+            DataCubeQuerySnapshotSortOperation.ASCENDING,
+          ),
+      },
+      {
+        name: 'Ascending Absolute',
+        menuItem: WIP_GridMenuItem,
+        cssClasses: ['!opacity-100'],
+        disabled: true,
+      },
+      {
+        name: 'Descending',
+        disabled: !editor.sorts.getActionableSortColumn(
+          column.getColId(),
+          DataCubeQuerySnapshotSortOperation.DESCENDING,
+        ),
+        action: () =>
+          editor.sorts.sortByColumn(
+            column.getColId(),
+            DataCubeQuerySnapshotSortOperation.DESCENDING,
+          ),
+      },
+      {
+        name: 'Descending Absolute',
+        menuItem: WIP_GridMenuItem,
+        cssClasses: ['!opacity-100'],
+        disabled: true,
+      },
+      'separator',
+      {
+        name: 'Add Ascending',
+        disabled: !editor.sorts.getActionableSortColumn(
+          column.getColId(),
+          DataCubeQuerySnapshotSortOperation.ASCENDING,
+        ),
+        action: () =>
+          editor.sorts.addSortByColumn(
+            column.getColId(),
+            DataCubeQuerySnapshotSortOperation.ASCENDING,
+          ),
+      },
+      {
+        name: 'Add Ascending Absolute',
+        menuItem: WIP_GridMenuItem,
+        cssClasses: ['!opacity-100'],
+        disabled: true,
+      },
+      {
+        name: 'Add Descending',
+        disabled: !editor.sorts.getActionableSortColumn(
+          column.getColId(),
+          DataCubeQuerySnapshotSortOperation.DESCENDING,
+        ),
+        action: () =>
+          editor.sorts.addSortByColumn(
+            column.getColId(),
+            DataCubeQuerySnapshotSortOperation.DESCENDING,
+          ),
+      },
+      {
+        name: 'Add Descending Absolute',
+        menuItem: WIP_GridMenuItem,
+        cssClasses: ['!opacity-100'],
+        disabled: true,
+      },
+      'separator',
+      {
+        name: 'Clear All Sorts',
+        disabled: editor.sorts.columnsSelector.selectedColumns.length === 0,
+        action: () => editor.sorts.clearAllSorts(),
+      },
+    ],
+  };
+}

package/src/server/models/DataCubeQuery.ts

@@ -97,21 +97,17 @@ function serializeQuerySource(
   );
 }
 
-export class DataCubeConfiguration {
-  // TODO
-}
-
 export class DataCubeQuery {
   name!: string;
   query!: string;
   partialQuery!: string;
   source!: DataCubeQuerySource;
-  configuration!: DataCubeConfiguration;
+  configuration?: PlainObject | undefined;
 
   constructor(
     name: string,
     query: string,
-    configuration: DataCubeConfiguration,
+    configuration?: PlainObject | undefined,
   ) {
     this.name = name;
     this.query = query;

package/src/stores/{dataCube/REPLStore.ts → REPLStore.ts}

@@ -14,22 +14,24 @@
  * limitations under the License.
  */
 
-import type { LegendREPLApplicationStore } from '../LegendREPLBaseStore.js';
-import { REPLServerClient } from '../../server/REPLServerClient.js';
+import type { LegendREPLApplicationStore } from './LegendREPLBaseStore.js';
+import { REPLServerClient } from '../server/REPLServerClient.js';
 import { NetworkClient } from '@finos/legend-shared';
 import { makeObservable, observable } from 'mobx';
-import { DataCubeState } from './DataCubeState.js';
+import { DataCubeState } from './dataCube/DataCubeState.js';
+import { DataCubeInfrastructure } from './dataCube/DataCubeInfrastructure.js';
 
 export class REPLStore {
   readonly applicationStore: LegendREPLApplicationStore;
   readonly client: REPLServerClient;
 
+  dataCubeInfrastructure!: DataCubeInfrastructure;
   // TODO: when we support multi-view, we would need to support multiple states
-  dataCubeState!: DataCubeState;
+  dataCube!: DataCubeState;
 
   constructor(applicationStore: LegendREPLApplicationStore) {
     makeObservable(this, {
-      dataCubeState: observable,
+      dataCube: observable,
     });
     this.applicationStore = applicationStore;
     this.client = new REPLServerClient(
@@ -40,6 +42,7 @@ export class REPLStore {
           : this.applicationStore.config.replUrl,
       }),
     );
-    this.dataCubeState = new DataCubeState(this);
+    this.dataCubeInfrastructure = new DataCubeInfrastructure(this);
+    this.dataCube = new DataCubeState(this);
   }
 }

package/src/stores/dataCube/{core/DataCubeEngine.ts → DataCubeInfrastructure.ts}

@@ -23,14 +23,17 @@ import {
   V1_serializeExecutionResult,
   V1_buildExecutionResult,
 } from '@finos/legend-graph';
-import type { REPLServerClient } from '../../../server/REPLServerClient.js';
+import type { REPLServerClient } from '../../server/REPLServerClient.js';
 import {
   DataCubeGetBaseQueryResult,
   type CompletionItem,
-} from '../../../server/models/DataCubeEngineModels.js';
+} from '../../server/models/DataCubeEngineModels.js';
 import { guaranteeType } from '@finos/legend-shared';
+import type { LegendREPLApplicationStore } from '../LegendREPLBaseStore.js';
+import type { REPLStore } from '../REPLStore.js';
+import { action, makeObservable, observable } from 'mobx';
 
-export class DataCubeEngine {
+class DataCubeEngine {
   private readonly client: REPLServerClient;
 
   constructor(client: REPLServerClient) {
@@ -79,3 +82,37 @@ export class DataCubeEngine {
     );
   }
 }
+
+/**
+ * Infrastructure for data cube, can be shared across multiple data cube states
+ */
+export class DataCubeInfrastructure {
+  readonly replStore: REPLStore;
+  readonly application: LegendREPLApplicationStore;
+  readonly engine: DataCubeEngine;
+
+  gridClientRowBuffer = 50;
+  enableDebugMode = false;
+
+  constructor(replStore: REPLStore) {
+    makeObservable(this, {
+      gridClientRowBuffer: observable,
+      setGridClientRowBuffer: action,
+
+      enableDebugMode: observable,
+      setEnableDebugMode: action,
+    });
+
+    this.replStore = replStore;
+    this.application = replStore.applicationStore;
+    this.engine = new DataCubeEngine(replStore.client);
+  }
+
+  setGridClientRowBuffer(rowBuffer: number): void {
+    this.gridClientRowBuffer = rowBuffer;
+  }
+
+  setEnableDebugMode(enableDebugMode: boolean): void {
+    this.enableDebugMode = enableDebugMode;
+  }
+}