@finos/legend-application-repl 0.0.60 → 1.0.0

package/src/server/REPLEngine.ts

@@ -1,110 +0,0 @@
-/**
- * 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 { createModelSchema, custom, primitive } from 'serializr';
-import {
-  SerializationFactory,
-  usingModelSchema,
-  type PlainObject,
-} from '@finos/legend-shared';
-import {
-  type V1_ValueSpecification,
-  type V1_Lambda,
-  V1_deserializeValueSpecification,
-  V1_serializeValueSpecification,
-} from '@finos/legend-graph';
-import { DataCubeQuery, type DataCubeQueryColumn } from './DataCubeQuery.js';
-
-export type DataCubeQueryBuilderError = {
-  type: string;
-  message: string;
-  sourceInformation?: {
-    startLine: number;
-    startColumn: number;
-    endLine: number;
-    endColumn: number;
-  };
-};
-
-export type DataCubeInfrastructureInfo = {
-  gridClientLicense?: string | undefined;
-};
-
-export type DataCubeGetQueryCodeInput = {
-  query: PlainObject<V1_ValueSpecification>;
-  pretty?: boolean;
-};
-
-export type DataCubeParseQueryInput = {
-  code: string;
-  returnSourceInformation?: boolean | undefined;
-};
-
-export type CompletionItem = {
-  completion: string;
-  display: string;
-};
-
-export type DataCubeQueryTypeaheadInput = {
-  code: string;
-  baseQuery?: PlainObject<V1_ValueSpecification>;
-};
-
-export type DataCubeGetQueryRelationReturnTypeInput = {
-  query: PlainObject<V1_Lambda>;
-};
-
-export type DataCubeGetQueryCodeRelationReturnTypeInput = {
-  code: string;
-  baseQuery?: PlainObject<V1_ValueSpecification>;
-};
-
-export type DataCubeExecutionInput = {
-  query: PlainObject<V1_Lambda>;
-  debug?: boolean | undefined;
-};
-
-export type DataCubeExecutionResult = {
-  result: string;
-  executedQuery: string;
-  executedSQL: string;
-};
-
-export type RelationType = {
-  columns: DataCubeQueryColumn[];
-};
-
-export class DataCubeGetBaseQueryResult {
-  query!: DataCubeQuery;
-  timestamp!: number;
-  partialQuery!: V1_ValueSpecification;
-  sourceQuery!: V1_ValueSpecification;
-
-  static readonly serialization = new SerializationFactory(
-    createModelSchema(DataCubeGetBaseQueryResult, {
-      partialQuery: custom(
-        (val) => V1_serializeValueSpecification(val, []),
-        (val) => V1_deserializeValueSpecification(val, []),
-      ),
-      query: usingModelSchema(DataCubeQuery.serialization.schema),
-      sourceQuery: custom(
-        (val) => V1_serializeValueSpecification(val, []),
-        (val) => V1_deserializeValueSpecification(val, []),
-      ),
-      timestamp: primitive(),
-    }),
-  );
-}

package/src/stores/LayoutManagerState.ts

@@ -1,176 +0,0 @@
-/**
- * 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 { GenericLegendApplicationStore } from '@finos/legend-application';
-import { uuid } from '@finos/legend-shared';
-import {
-  action,
-  computed,
-  makeObservable,
-  observable,
-  runInAction,
-} from 'mobx';
-
-export type WindowConfiguration = {
-  x?: number | undefined;
-  y?: number | undefined;
-  width?: number | undefined;
-  height?: number | undefined;
-  minWidth?: number | undefined;
-  minHeight?: number | undefined;
-  center?: boolean | undefined;
-};
-
-export class LayoutConfiguration {
-  title: string;
-  readonly contentRenderer: (config: LayoutConfiguration) => React.ReactNode;
-  window: WindowConfiguration = {};
-
-  constructor(
-    title: string,
-    contentRenderer: (config: LayoutConfiguration) => React.ReactNode,
-  ) {
-    this.contentRenderer = contentRenderer;
-    this.title = title;
-  }
-}
-
-export class WindowState {
-  readonly uuid = uuid();
-  readonly configuration: LayoutConfiguration;
-  readonly onClose?: (() => void) | undefined;
-
-  constructor(
-    configuration: LayoutConfiguration,
-    onClose?: (() => void) | undefined,
-  ) {
-    this.configuration = configuration;
-    this.onClose = onClose;
-  }
-}
-
-export class LayoutManagerState {
-  readonly application: GenericLegendApplicationStore;
-  windows: WindowState[] = [];
-
-  constructor(application: GenericLegendApplicationStore) {
-    makeObservable(this, {
-      windows: observable,
-      newWindow: action,
-      bringWindowFront: action,
-      closeWindow: action,
-    });
-
-    this.application = application;
-  }
-
-  newWindow(window: WindowState) {
-    this.windows.push(window);
-  }
-
-  bringWindowFront(window: WindowState) {
-    const matchingWindow = this.windows.find((w) => w.uuid === window.uuid);
-    if (matchingWindow) {
-      this.windows = this.windows.filter((w) => w.uuid !== window.uuid);
-      this.windows.push(window);
-    }
-  }
-
-  closeWindow(window: WindowState) {
-    const matchingWindow = this.windows.find((w) => w.uuid === window.uuid);
-    if (matchingWindow) {
-      this.windows = this.windows.filter((w) => w.uuid !== window.uuid);
-      window.onClose?.();
-    }
-  }
-}
-
-export const WINDOW_DEFAULT_OFFSET = 50;
-export const WINDOW_DEFAULT_WIDTH = 800;
-export const WINDOW_DEFAULT_HEIGHT = 600;
-export const WINDOW_DEFAULT_MIN_WIDTH = 300;
-export const WINDOW_DEFAULT_MIN_HEIGHT = 300;
-
-export const DEFAULT_TOOL_PANEL_WINDOW_CONFIG: WindowConfiguration = {
-  width: WINDOW_DEFAULT_WIDTH,
-  height: WINDOW_DEFAULT_HEIGHT,
-  minWidth: WINDOW_DEFAULT_MIN_WIDTH,
-  minHeight: WINDOW_DEFAULT_MIN_HEIGHT,
-  center: true,
-};
-
-export const DEFAULT_SMALL_ALERT_WINDOW_CONFIG: WindowConfiguration = {
-  width: 500,
-  height: 200,
-  minWidth: 200,
-  minHeight: 80,
-  center: true,
-};
-
-export const DEFAULT_LARGE_ALERT_WINDOW_CONFIG: WindowConfiguration = {
-  width: 600,
-  height: 200,
-  minWidth: 300,
-  minHeight: 150,
-  center: true,
-};
-
-export class DisplayState {
-  readonly layoutManagerState: LayoutManagerState;
-  readonly configuration: LayoutConfiguration;
-  window?: WindowState | undefined;
-
-  constructor(
-    layoutManagerState: LayoutManagerState,
-    title: string,
-    contentRenderer: (config: LayoutConfiguration) => React.ReactNode,
-  ) {
-    makeObservable(this, {
-      window: observable,
-      isOpen: computed,
-      open: action,
-      close: action,
-    });
-
-    this.layoutManagerState = layoutManagerState;
-    this.configuration = new LayoutConfiguration(title, contentRenderer);
-    this.configuration.window = DEFAULT_TOOL_PANEL_WINDOW_CONFIG;
-  }
-
-  get isOpen() {
-    return Boolean(this.window);
-  }
-
-  open() {
-    if (this.window) {
-      this.layoutManagerState.bringWindowFront(this.window);
-    } else {
-      this.window = new WindowState(this.configuration, () =>
-        runInAction(() => {
-          this.window = undefined;
-        }),
-      );
-      this.layoutManagerState.newWindow(this.window);
-    }
-  }
-
-  close() {
-    if (this.window) {
-      this.layoutManagerState.closeWindow(this.window);
-      this.window = undefined;
-    }
-  }
-}

package/src/stores/LegendREPLApplicationPlugin.ts

@@ -1,39 +0,0 @@
-/**
- * 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 { LegendApplicationPlugin } from '@finos/legend-application';
-import type { LegendREPLPluginManager } from '../application/LegendREPLPluginManager.js';
-import { DocumentationKey } from '../application/LegendREPLDocumentation.js';
-
-export abstract class LegendREPLApplicationPlugin extends LegendApplicationPlugin {
-  /**
-   * This helps to better type-check for this empty abtract type
-   * See https://github.com/finos/legend-studio/blob/master/docs/technical/typescript-usage.md#understand-typescript-structual-type-system
-   */
-  private readonly _$nominalTypeBrand!: 'LegendREPLApplicationPlugin';
-
-  install(pluginManager: LegendREPLPluginManager) {
-    pluginManager.registerApplicationPlugin(this);
-  }
-
-  override getExtraRequiredDocumentationKeys() {
-    return [
-      DocumentationKey.DATA_CUBE_EXTENDED_COLUMN_LEVELS,
-      DocumentationKey.DATA_CUBE_COLUMN_KINDS,
-      DocumentationKey.DATA_CUBE_COLUMN_DISPLAY_AS_LINK,
-    ];
-  }
-}

package/src/stores/LegendREPLBaseStore.ts

@@ -1,34 +0,0 @@
-/**
- * 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 { ApplicationStore } from '@finos/legend-application';
-import type { LegendREPLApplicationConfig } from '../application/LegendREPLApplicationConfig.js';
-import type { LegendREPLPluginManager } from '../application/LegendREPLPluginManager.js';
-
-export type LegendREPLApplicationStore = ApplicationStore<
-  LegendREPLApplicationConfig,
-  LegendREPLPluginManager
->;
-
-export class LegendREPLBaseStore {
-  readonly application: LegendREPLApplicationStore;
-  readonly pluginManager: LegendREPLPluginManager;
-
-  constructor(application: LegendREPLApplicationStore) {
-    this.application = application;
-    this.pluginManager = application.pluginManager;
-  }
-}

package/src/stores/REPLStore.tsx

@@ -1,193 +0,0 @@
-/**
- * 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 { LegendREPLApplicationStore } from './LegendREPLBaseStore.js';
-import { REPLServerClient } from '../server/REPLServerClient.js';
-import {
-  ActionState,
-  assertErrorThrown,
-  guaranteeNonNullable,
-  LogEvent,
-  NetworkClient,
-} from '@finos/legend-shared';
-import { makeObservable, observable } from 'mobx';
-import { DataCubeState } from './dataCube/DataCubeState.js';
-import { DataCubeEngine } from './dataCube/DataCubeEngine.js';
-import { LicenseManager } from '@ag-grid-enterprise/core';
-import { ActionAlertType, APPLICATION_EVENT } from '@finos/legend-application';
-import {
-  DEFAULT_SMALL_ALERT_WINDOW_CONFIG,
-  LayoutConfiguration,
-  LayoutManagerState,
-  DisplayState,
-  WindowState,
-  type WindowConfiguration,
-} from './LayoutManagerState.js';
-import {
-  Alert,
-  AlertType,
-  type AlertAction,
-} from '../components/repl/Alert.js';
-import { DocumentationPanel } from '../components/repl/DocumentationPanel.js';
-import { SettingsPanel } from '../components/repl/SettingsPanel.js';
-
-export class REPLStore {
-  readonly application: LegendREPLApplicationStore;
-  readonly client: REPLServerClient;
-  readonly layout: LayoutManagerState;
-  readonly initState = ActionState.create();
-  readonly settingsDisplay: DisplayState;
-  readonly documentationDisplay: DisplayState;
-
-  dataCubeEngine!: DataCubeEngine;
-
-  // TODO: when we support multi-view, we would need to support multiple states
-  dataCube!: DataCubeState;
-
-  constructor(application: LegendREPLApplicationStore) {
-    makeObservable(this, {
-      dataCube: observable,
-    });
-
-    this.application = application;
-    const baseAddress = guaranteeNonNullable(
-      this.application.config.baseAddress,
-    );
-    this.client = new REPLServerClient(
-      new NetworkClient({
-        baseUrl: this.application.config.useDynamicREPLServer
-          ? window.location.origin + baseAddress.replace('/repl/', '')
-          : this.application.config.replUrl,
-      }),
-    );
-    this.layout = new LayoutManagerState(this.application);
-    this.dataCubeEngine = new DataCubeEngine(this);
-    this.dataCube = new DataCubeState(this);
-    this.settingsDisplay = new DisplayState(this.layout, 'Settings', () => (
-      <SettingsPanel />
-    ));
-    this.settingsDisplay.configuration.window = {
-      x: -50,
-      y: 50,
-      width: 600,
-      height: 400,
-      minWidth: 300,
-      minHeight: 200,
-      center: false,
-    };
-    this.documentationDisplay = new DisplayState(
-      this.layout,
-      'Documentation',
-      () => <DocumentationPanel />,
-    );
-    this.documentationDisplay.configuration.window = {
-      x: -50,
-      y: -50,
-      width: 400,
-      height: 400,
-      minWidth: 300,
-      minHeight: 200,
-      center: false,
-    };
-  }
-
-  alertError(
-    error: Error,
-    options: {
-      message: string;
-      text?: string | undefined;
-      actions?: AlertAction[] | undefined;
-      windowTitle?: string | undefined;
-      windowConfig?: WindowConfiguration | undefined;
-    },
-  ) {
-    const { message, text, actions, windowTitle, windowConfig } = options;
-    this.application.notificationService.notifyError(error);
-    const window = new WindowState(
-      new LayoutConfiguration(windowTitle ?? 'Error', () => (
-        <Alert
-          type={AlertType.ERROR}
-          message={message}
-          text={text}
-          actions={actions}
-        />
-      )),
-    );
-    window.configuration.window =
-      windowConfig ?? DEFAULT_SMALL_ALERT_WINDOW_CONFIG;
-    this.layout.newWindow(window);
-  }
-
-  alert(options: {
-    message: string;
-    type: AlertType;
-    text?: string | undefined;
-    actions?: AlertAction[] | 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);
-  }
-
-  async initialize() {
-    if (!this.initState.isInInitialState) {
-      // eslint-disable-next-line no-process-env
-      if (process.env.NODE_ENV === 'production') {
-        this.application.notificationService.notifyIllegalState(
-          'REPL store is re-initialized',
-        );
-      } else {
-        this.application.logService.debug(
-          LogEvent.create(APPLICATION_EVENT.DEBUG),
-          'REPL store is re-initialized',
-        );
-      }
-      return;
-    }
-    this.initState.inProgress();
-
-    try {
-      const info = await this.dataCubeEngine.getInfrastructureInfo();
-      if (info.gridClientLicense) {
-        LicenseManager.setLicenseKey(info.gridClientLicense);
-      }
-      this.initState.pass();
-    } catch (error: unknown) {
-      assertErrorThrown(error);
-      this.application.alertService.setActionAlertInfo({
-        message: `Initialization Failure: ${error.message}`,
-        prompt: `Resolve the issue and reload the application.`,
-        type: ActionAlertType.ERROR,
-        actions: [],
-      });
-      this.initState.fail();
-    }
-  }
-}