@finos/legend-data-cube 0.0.36 → 0.0.38

package/src/stores/core/filter/DataCubeQueryFilterEditorState.ts

@@ -28,7 +28,7 @@ import type {
   DataCubeQuerySnapshotFilter,
   DataCubeQuerySnapshotFilterCondition,
 } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import type { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 
 export abstract class DataCubeFilterEditorTreeNode {

package/src/stores/core/filter/DataCubeQueryFilterOperation.ts

@@ -21,7 +21,7 @@ import {
 } from '@finos/legend-shared';
 import type { DataCubeOperationValue } from '../DataCubeQueryEngine.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DATE_FORMAT,
   DATE_TIME_FORMAT,

package/src/stores/core/filter/DataCubeQueryFilterOperation__Contain.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__ContainCaseInsensitive.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__EndWith.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__EndWithCaseInsensitive.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__Equal.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__EqualCaseInsensitive.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__EqualCaseInsensitiveColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__EqualColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__GreaterThan.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__GreaterThanColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__GreaterThanOrEqual.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__GreaterThanOrEqualColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__IsNotNull.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__IsNull.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__LessThan.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__LessThanColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__LessThanOrEqual.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__LessThanOrEqualColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotContain.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEndWith.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEqual.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEqualCaseInsensitive.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEqualCaseInsensitiveColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEqualColumn.tsx

@@ -17,7 +17,7 @@
 import { type V1_AppliedFunction } from '@finos/legend-graph';
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotStartWith.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__StartWith.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/filter/DataCubeQueryFilterOperation__StartWithCaseInsensitive.tsx

@@ -20,7 +20,7 @@ import {
   generateDefaultFilterConditionPrimitiveTypeValue,
 } from './DataCubeQueryFilterOperation.js';
 import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
-import type { DataCubeColumn } from '../models/DataCubeColumn.js';
+import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
   DataCubeFunction,

package/src/stores/core/model/AdhocQueryDataCubeSource.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 {
+  SerializationFactory,
+  usingConstantValueSchema,
+  type PlainObject,
+} from '@finos/legend-shared';
+import { DataCubeSource } from './DataCubeSource.js';
+import { createModelSchema, primitive, raw } from 'serializr';
+
+export class AdhocQueryDataCubeSource extends DataCubeSource {
+  runtime!: string;
+  model!: PlainObject;
+}
+
+export const ADHOC_QUERY_DATA_CUBE_SOURCE_TYPE = 'adhocQuery';
+
+export class RawAdhocQueryDataCubeSource {
+  query!: string;
+  runtime!: string;
+  model!: PlainObject;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(RawAdhocQueryDataCubeSource, {
+      _type: usingConstantValueSchema(ADHOC_QUERY_DATA_CUBE_SOURCE_TYPE),
+      model: raw(),
+      query: primitive(),
+      runtime: primitive(),
+    }),
+  );
+}

package/src/stores/core/{models → model}/DataCubeSource.ts

@@ -18,7 +18,7 @@ import type { V1_ValueSpecification } from '@finos/legend-graph';
 import type { DataCubeColumn } from './DataCubeColumn.js';
 
 export abstract class DataCubeSource {
-  sourceColumns: DataCubeColumn[] = [];
+  columns: DataCubeColumn[] = [];
   query!: V1_ValueSpecification;
 }
 

package/src/stores/services/DataCubeAlertService.tsx

@@ -0,0 +1,169 @@
+/**
+ * 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 { CODE_EDITOR_LANGUAGE } from '@finos/legend-code-editor';
+import {
+  type DataCubeLayoutService,
+  DEFAULT_ALERT_WINDOW_CONFIG,
+  LayoutConfiguration,
+  WindowState,
+  type WindowConfiguration,
+} from './DataCubeLayoutService.js';
+import { Alert } from '../../components/core/DataCubeAlert.js';
+import type { EngineError } from '@finos/legend-graph';
+import { editor as monacoEditorAPI, Uri } from 'monaco-editor';
+import { DataCubeCodeCheckErrorAlert } from '../../components/core/DataCubeCodeCheckErrorAlert.js';
+import { uuid } from '@finos/legend-shared';
+import type { DataCubeLogService } from './DataCubeLogService.js';
+
+export enum AlertType {
+  ERROR = 'ERROR',
+  INFO = 'INFO',
+  SUCCESS = 'SUCCESS',
+  WARNING = 'WARNING',
+}
+
+export type ActionAlertAction = { label: string; handler: () => void };
+
+export type ActionAlert = {
+  title?: string | undefined;
+  message: string;
+  prompt?: string | undefined;
+  type: AlertType;
+  text?: string | undefined;
+  actions?: ActionAlertAction[] | undefined;
+  onClose?: () => void;
+};
+
+export type ActionAlertOptions = {
+  message: string;
+  text?: string | undefined;
+  actions?: ActionAlertAction[] | undefined;
+  windowTitle?: string | undefined;
+  windowConfig?: WindowConfiguration | undefined;
+};
+
+export class DataCubeAlertService {
+  private readonly _logService: DataCubeLogService;
+  private readonly _layoutService: DataCubeLayoutService;
+
+  constructor(
+    logService: DataCubeLogService,
+    layoutService: DataCubeLayoutService,
+  ) {
+    this._logService = logService;
+    this._layoutService = layoutService;
+  }
+
+  alert(
+    options: ActionAlertOptions & {
+      type: AlertType;
+    },
+  ) {
+    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._layoutService.closeWindow(window)}
+        />
+      )),
+    );
+    window.configuration.window = windowConfig ?? DEFAULT_ALERT_WINDOW_CONFIG;
+    this._layoutService.newWindow(window);
+  }
+
+  alertError(error: Error, options: ActionAlertOptions) {
+    const { message, text, actions, windowTitle, windowConfig } = options;
+    const window = new WindowState(
+      new LayoutConfiguration(windowTitle ?? 'Error', () => (
+        <Alert
+          type={AlertType.ERROR}
+          message={message}
+          text={text}
+          actions={actions}
+        />
+      )),
+    );
+    window.configuration.window = windowConfig ?? DEFAULT_ALERT_WINDOW_CONFIG;
+    this._layoutService.newWindow(window);
+  }
+
+  alertUnhandledError(error: Error) {
+    this._logService.logUnhandledError(error);
+    this.alertError(error, {
+      message: error.message,
+    });
+  }
+
+  alertCodeCheckError(
+    error: EngineError,
+    code: string,
+    codePrefix: string,
+    options: ActionAlertOptions,
+  ) {
+    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._layoutService.newWindow(window);
+    }
+  }
+}

package/src/stores/services/DataCubeDocumentationService.tsx

@@ -0,0 +1,74 @@
+/**
+ * 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 { DocumentationEntry } from '@finos/legend-shared';
+import { makeObservable, observable, action } from 'mobx';
+import { DocumentationPanel } from '../../components/core/DataCubeDocumentationPanel.js';
+import type {
+  DataCubeLayoutService,
+  DisplayState,
+} from './DataCubeLayoutService.js';
+import type { DataCubeEngine } from '../core/DataCubeEngine.js';
+
+export class DataCubeDocumentationService {
+  private readonly _engine: DataCubeEngine;
+  private readonly _layoutService: DataCubeLayoutService;
+
+  readonly display: DisplayState;
+
+  currentEntry?: DocumentationEntry | undefined;
+
+  constructor(engine: DataCubeEngine, layoutService: DataCubeLayoutService) {
+    makeObservable(this, {
+      currentEntry: observable,
+      setCurrentEntry: action,
+    });
+
+    this._engine = engine;
+    this._layoutService = layoutService;
+    this.display = this._layoutService.newDisplay(
+      'Documentation',
+      () => <DocumentationPanel />,
+      {
+        x: -50,
+        y: -50,
+        width: 400,
+        height: 400,
+        minWidth: 300,
+        minHeight: 200,
+        center: false,
+      },
+    );
+  }
+
+  getEntry(key: string) {
+    return this._engine.getDocumentationEntry(key);
+  }
+
+  setCurrentEntry(entry: DocumentationEntry | undefined) {
+    this.currentEntry = entry;
+  }
+
+  shouldDisplayDocumentationEntry(entry: DocumentationEntry) {
+    return (
+      /**
+       * Since we're displaying the documentation entry, we want only user-friendly docs
+       * and discard anything that doesn't come with a title, or does not have any content
+       */
+      Boolean(entry.title && (entry.text ?? entry.markdownText))
+    );
+  }
+}