@finos/legend-application-studio 23.0.0 → 23.0.1

package/src/stores/STO_Relational_LegendStudioApplicationPlugin_Extension.ts

@@ -1,167 +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 { DSL_LegendStudioApplicationPlugin_Extension } from './LegendStudioApplicationPlugin.js';
-import type {
-  DatasourceSpecification,
-  AuthenticationStrategy,
-  PostProcessor,
-  ObserverContext,
-} from '@finos/legend-graph';
-import type { RelationalDatabaseConnectionValueState } from './editor-state/element-editor-state/connection/ConnectionEditorState.js';
-import type { PostProcessorEditorState } from './editor-state/element-editor-state/connection/PostProcessorEditorState.js';
-import type { ElementEmbeddedContentSnippetSuggestion } from '@finos/legend-application';
-
-/**
- * NOTE: The tab-stop index of the snippet must start from 6
- */
-export type EmbeddedPostProcessorSnippetSuggestion =
-  ElementEmbeddedContentSnippetSuggestion;
-
-// connection datasource specification
-
-export type DatasourceSpecificationClassifier = (
-  metamodel: DatasourceSpecification,
-) => string | undefined;
-
-export type DatasourceSpecificationCreator = (
-  type: string,
-) => DatasourceSpecification | undefined;
-
-export type DatasourceSpecificationEditorRenderer = (
-  metamodel: DatasourceSpecification,
-  isReadOnly: boolean,
-) => React.ReactNode | undefined;
-
-// connection authentication strategy
-
-export type AuthenticationStrategyClassifier = (
-  metamodel: AuthenticationStrategy,
-) => string | undefined;
-
-export type AuthenticationStrategyCreator = (
-  type: string,
-) => AuthenticationStrategy | undefined;
-
-export type AuthenticationStrategyEditorRenderer = (
-  metamodel: AuthenticationStrategy,
-  isReadOnly: boolean,
-) => React.ReactNode | undefined;
-
-// connection post-processor
-
-export type PostProcessorTypeGetter = (
-  metamodel: PostProcessor,
-) => string | undefined;
-
-export type PostProcessorCreator = (
-  type: string,
-  connectionValueState: RelationalDatabaseConnectionValueState,
-  observerContext: ObserverContext,
-) => PostProcessor | undefined;
-
-export type PostProcessorEditorRenderer = (
-  metamodel: PostProcessor,
-  connectionValueState: RelationalDatabaseConnectionValueState,
-  isReadOnly: boolean,
-) => React.ReactNode | undefined;
-
-export type PostProcessorStateCreator = (
-  metamodel: PostProcessor,
-  connectionValueState: RelationalDatabaseConnectionValueState,
-) => PostProcessorEditorState | undefined;
-
-export interface STO_Relational_LegendStudioApplicationPlugin_Extension
-  extends DSL_LegendStudioApplicationPlugin_Extension {
-  // --------------------- relational database connection datasource specification ------------------
-
-  /**
-   * Get the list of the supported type specifiers for relational database
-   * datasource specifications.
-   */
-  getExtraDatasourceSpecificationTypes?(): string[];
-
-  /**
-   * Get the list of classifiers for a relational database datasource specification.
-   */
-  getExtraDatasourceSpecificationClassifiers?(): DatasourceSpecificationClassifier[];
-
-  /**
-   * Get the list of creators for relational database datasource specification given the type specifier.
-   */
-  getExtraDatasourceSpecificationCreators?(): DatasourceSpecificationCreator[];
-
-  /**
-   * Get the list of renderers for the editor for a relational database datasource specification.
-   */
-  getExtraDatasourceSpecificationEditorRenderers?(): DatasourceSpecificationEditorRenderer[];
-
-  // --------------------- relational database connection authentication strategy ------------------
-
-  /**
-   * Get the list of supported type specifiers for relational database connection
-   * authentication strategies.
-   */
-  getExtraAuthenticationStrategyTypes?(): string[];
-
-  /**
-   * Get the list of classifiers for a relational database authentication strategy.
-   */
-  getExtraAuthenticationStrategyClassifiers?(): AuthenticationStrategyClassifier[];
-
-  /**
-   * Get the list of creators for relational database authentication strategy given the type specifier.
-   */
-  getExtraAuthenticationStrategyCreators?(): AuthenticationStrategyCreator[];
-
-  /**
-   * Get the list of renderers for the editor for a relational database authentication strategy.
-   */
-  getExtraAuthenticationStrategyEditorRenderers?(): AuthenticationStrategyEditorRenderer[];
-
-  // --------------------- relational database connection post-processor ------------------
-
-  /**
-   * Get the list of the supported type for post-processors.
-   *
-   */
-  getExtraPostProcessorClassifiers?(): string[];
-
-  /**
-   * Get the list of classifiers for a post-processor.
-   */
-  getExtraPostProcessorClassifierGetters?(): PostProcessorTypeGetter[];
-
-  /**
-   * Get the list of creators for post-processor given the type specifier.
-   */
-  getExtraPostProcessorCreators?(): PostProcessorCreator[];
-
-  /**
-   * Get the list of state creators for a post-processor.
-   */
-  getExtraPostProcessorStateCreators?(): PostProcessorStateCreator[];
-
-  /**
-   * Get the list of Pure grammar suggestion snippet getters for post-processors.
-   */
-  getExtraPostProcessorSnippetSuggestions?(): EmbeddedPostProcessorSnippetSuggestion[];
-
-  /**
-   * Get the list of renderers for the editor for a post-processor.
-   */
-  getExtraPostProcessorEditorRenderers?(): PostProcessorEditorRenderer[];
-}

package/src/stores/editor-state/ExternalFormatState.ts

@@ -1,119 +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 { ExternalFormatDescription } from '@finos/legend-graph';
-import {
-  type GeneratorFn,
-  assertErrorThrown,
-  LogEvent,
-  ActionState,
-} from '@finos/legend-shared';
-import { flow, action, makeObservable, observable } from 'mobx';
-import type { EditorStore } from '../EditorStore.js';
-import { LEGEND_STUDIO_APP_EVENT } from '../../application/LegendStudioEvent.js';
-import { ElementXTSchemaGenerationState } from './element-editor-state/ElementExternalFormatGenerationState.js';
-
-export type ExternalFormatTypeOption = {
-  value: string;
-  label: string;
-};
-
-export enum EmbeddedDataType {
-  EXTERNAL_FORMAT_DATA = 'EXTERNAL_FORMAT',
-  MODEL_STORE_DATA = 'MODEL_STORE',
-  RELATIONAL_CSV = 'RELATIONAL',
-  DATA_ELEMENT = 'DATA_ELEMENT',
-}
-
-export class ExternalFormatState {
-  fetchingDescriptionsState = ActionState.create();
-  editorStore: EditorStore;
-  externalFormatsDescriptions: ExternalFormatDescription[] = [];
-  schemaGenerationStates: ElementXTSchemaGenerationState[] = [];
-
-  constructor(editorStore: EditorStore) {
-    makeObservable<ExternalFormatState>(this, {
-      externalFormatsDescriptions: observable,
-      schemaGenerationStates: observable,
-      setExternalFormatsDescriptions: action,
-      fetchExternalFormatsDescriptions: flow,
-    });
-
-    this.editorStore = editorStore;
-  }
-
-  get formatTypes(): string[] {
-    return this.externalFormatsDescriptions.map((e) => e.name);
-  }
-
-  get formatTypeOptions(): ExternalFormatTypeOption[] {
-    return this.externalFormatsDescriptions.map((types) => ({
-      value: types.name,
-      label: types.name,
-    }));
-  }
-
-  get formatContentTypes(): string[] {
-    return this.externalFormatsDescriptions.map((e) => e.contentTypes).flat();
-  }
-
-  get externalFormatDescriptionsWithModelGenerationSupport(): ExternalFormatDescription[] {
-    return this.externalFormatsDescriptions.filter(
-      (d) => d.supportsModelGeneration,
-    );
-  }
-
-  getFormatTypeForContentType(contentType: string): string | undefined {
-    return this.externalFormatsDescriptions.find(
-      (externalFormatDescription) =>
-        externalFormatDescription.contentTypes[0] === contentType,
-    )?.name;
-  }
-
-  setExternalFormatsDescriptions(
-    externalFormatsDescriptions: ExternalFormatDescription[],
-  ): void {
-    this.externalFormatsDescriptions = externalFormatsDescriptions;
-  }
-
-  *fetchExternalFormatsDescriptions(): GeneratorFn<void> {
-    try {
-      this.fetchingDescriptionsState.inProgress();
-      const externalFormatDescriptions =
-        (yield this.editorStore.graphManagerState.graphManager.getAvailableExternalFormatsDescriptions()) as ExternalFormatDescription[];
-      this.setExternalFormatsDescriptions(externalFormatDescriptions);
-      this.schemaGenerationStates = externalFormatDescriptions
-        .filter((s) => s.supportsSchemaGeneration)
-        .map(
-          (descr) =>
-            new ElementXTSchemaGenerationState(this.editorStore, descr),
-        );
-      this.fetchingDescriptionsState.complete();
-    } catch (error) {
-      assertErrorThrown(error);
-      this.editorStore.applicationStore.logService.error(
-        LogEvent.create(LEGEND_STUDIO_APP_EVENT.EXTERNAL_FORMAT_FAILURE),
-        error,
-      );
-      this.editorStore.applicationStore.notificationService.notifyError(error);
-      this.fetchingDescriptionsState.fail();
-    }
-  }
-
-  getTypeDescription(type: string): ExternalFormatDescription | undefined {
-    return this.externalFormatsDescriptions.find((e) => e.name === type);
-  }
-}

package/src/stores/editor-state/FileGenerationState.ts

@@ -1,285 +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 { EditorStore } from '../EditorStore.js';
-import { observable, action, makeObservable, flow } from 'mobx';
-import { LEGEND_STUDIO_APP_EVENT } from '../../application/LegendStudioEvent.js';
-import {
-  type FileSystem_File,
-  type FileResult,
-  FileSystem_Directory,
-  GENERATION_FILE_ROOT_NAME,
-  getFileSystemTreeData,
-  buildFileSystemDirectory,
-} from '../shared/FileSystemTreeUtils.js';
-import {
-  type GeneratorFn,
-  assertErrorThrown,
-  deepEqual,
-  isEmpty,
-  LogEvent,
-  ActionState,
-} from '@finos/legend-shared';
-import {
-  type FileGenerationSpecification,
-  type GenerationOutput,
-  type GenerationProperty,
-  ConfigurationProperty,
-  GenerationPropertyItemType,
-  PackageableElement,
-  PackageableElementReference,
-  PackageableElementExplicitReference,
-  ELEMENT_PATH_DELIMITER,
-  getNullableFileGenerationConfig,
-} from '@finos/legend-graph';
-import {
-  configurationProperty_setValue,
-  configurationProperty_addConfigurationProperty,
-  fileGeneration_addScopeElement,
-  fileGeneration_deleteScopeElement,
-} from '../shared/modifier/DSL_Generation_GraphModifierHelper.js';
-import { FileSystemState } from './FileSystemState.js';
-
-export abstract class GeneratedFileStructureState {
-  readonly editorStore: EditorStore;
-  fileSystemState: FileSystemState;
-  generatingAction = ActionState.create();
-  rootDirectoryName: string;
-
-  constructor(rootDirectory: string, editorStore: EditorStore) {
-    this.rootDirectoryName = rootDirectory;
-    this.fileSystemState = new FileSystemState(rootDirectory);
-    this.editorStore = editorStore;
-  }
-
-  abstract resetGenerator(): void;
-
-  abstract generate(): GeneratorFn<void>;
-
-  abstract get rootFolder(): string;
-
-  abstract get generationParentId(): string | undefined;
-
-  processGenerationResult(output: GenerationOutput[]): void {
-    this.fileSystemState.root = new FileSystem_Directory(
-      this.rootDirectoryName,
-    );
-    this.fileSystemState.filesIndex = new Map<string, FileSystem_File>();
-    const openedNodeIds = this.fileSystemState.directoryTreeData
-      ? Array.from(this.fileSystemState.directoryTreeData.nodes.values())
-          .filter((node) => node.isOpen)
-          .map((node) => node.id)
-      : [];
-    const generationResultIndex = new Map<string, FileResult>();
-    const rootFolder = this.rootFolder;
-    output.forEach((entry) => {
-      entry.cleanFileName(rootFolder);
-      if (generationResultIndex.has(entry.fileName)) {
-        this.editorStore.applicationStore.logService.warn(
-          LogEvent.create(LEGEND_STUDIO_APP_EVENT.GENERATION_FAILURE),
-          'Found 2 generation outputs with same path',
-        );
-      }
-      generationResultIndex.set(entry.fileName, {
-        value: entry,
-        parentId: this.generationParentId,
-      });
-    });
-    // take generation outputs and put them into the root directory
-    buildFileSystemDirectory(
-      this.fileSystemState.root,
-      generationResultIndex,
-      this.fileSystemState.filesIndex,
-    );
-    this.fileSystemState.directoryTreeData = getFileSystemTreeData(
-      this.fileSystemState.root,
-    );
-    this.fileSystemState.reprocessNodeTree(
-      Array.from(generationResultIndex.values()),
-      this.fileSystemState.directoryTreeData,
-      openedNodeIds,
-    );
-  }
-}
-
-export class FileGenerationState extends GeneratedFileStructureState {
-  readonly fileGeneration: FileGenerationSpecification;
-
-  constructor(
-    editorStore: EditorStore,
-    fileGeneration: FileGenerationSpecification,
-  ) {
-    super(GENERATION_FILE_ROOT_NAME, editorStore);
-    makeObservable(this, {
-      generatingAction: observable,
-      fileSystemState: observable,
-      resetGenerator: action,
-      processGenerationResult: action,
-      addScopeElement: action,
-      deleteScopeElement: action,
-      updateFileGenerationParameters: action,
-      generate: flow,
-    });
-    this.fileGeneration = fileGeneration;
-  }
-
-  get rootFolder(): string {
-    return (
-      this.fileGeneration.generationOutputPath ??
-      this.fileGeneration.path.split(ELEMENT_PATH_DELIMITER).join('_')
-    );
-  }
-
-  get generationParentId(): string | undefined {
-    return this.fileGeneration.path;
-  }
-
-  resetGenerator(): void {
-    this.fileGeneration.configurationProperties = [];
-  }
-
-  updateFileGenerationParameters(
-    fileGeneration: FileGenerationSpecification,
-    generationProperty: GenerationProperty,
-    newValue: unknown,
-  ): void {
-    if (generationProperty.type === GenerationPropertyItemType.MAP) {
-      if (
-        !newValue ||
-        isEmpty(newValue) ||
-        deepEqual(newValue, generationProperty.defaultValue)
-      ) {
-        fileGeneration.configurationProperties =
-          fileGeneration.configurationProperties.filter(
-            (e) => e.name !== generationProperty.name,
-          );
-      } else {
-        const configProperty = getNullableFileGenerationConfig(
-          fileGeneration,
-          generationProperty.name,
-        );
-        if (configProperty) {
-          configurationProperty_setValue(configProperty, {
-            ...(newValue as object),
-          });
-        } else {
-          const newItem = new ConfigurationProperty(
-            generationProperty.name,
-            newValue,
-          );
-          configurationProperty_addConfigurationProperty(
-            fileGeneration.configurationProperties,
-            newItem,
-          );
-        }
-      }
-    } else {
-      const configProperty = getNullableFileGenerationConfig(
-        fileGeneration,
-        generationProperty.name,
-      );
-      let useDefaultValue = generationProperty.defaultValue === newValue;
-      if (generationProperty.type === GenerationPropertyItemType.BOOLEAN) {
-        useDefaultValue =
-          (generationProperty.defaultValue === 'true') ===
-          (newValue as boolean);
-      }
-      const newConfigValue = useDefaultValue ? undefined : newValue;
-      if (newConfigValue !== undefined) {
-        if (configProperty) {
-          configurationProperty_setValue(configProperty, newConfigValue);
-        } else {
-          const newItem = new ConfigurationProperty(
-            generationProperty.name,
-            newConfigValue,
-          );
-          configurationProperty_addConfigurationProperty(
-            fileGeneration.configurationProperties,
-            newItem,
-          );
-        }
-      } else {
-        fileGeneration.configurationProperties =
-          fileGeneration.configurationProperties.filter(
-            (e) => e.name !== generationProperty.name,
-          );
-      }
-    }
-  }
-
-  *generate(): GeneratorFn<void> {
-    this.generatingAction.inProgress();
-    try {
-      // avoid wasting a network call when the scope is empty, we can short-circuit this
-      if (!this.fileGeneration.scopeElements.length) {
-        this.fileSystemState.selectedNode = undefined;
-        this.processGenerationResult([]);
-        return;
-      }
-      const mode =
-        this.editorStore.graphState.graphGenerationState.getFileGenerationConfiguration(
-          this.fileGeneration.type,
-        ).generationMode;
-      const result =
-        (yield this.editorStore.graphManagerState.graphManager.generateFile(
-          this.fileGeneration,
-          mode,
-          this.editorStore.graphManagerState.graph,
-        )) as GenerationOutput[];
-      this.processGenerationResult(result);
-    } catch (error) {
-      assertErrorThrown(error);
-      this.fileSystemState.selectedNode = undefined;
-      this.processGenerationResult([]);
-      this.editorStore.applicationStore.logService.error(
-        LogEvent.create(LEGEND_STUDIO_APP_EVENT.GENERATION_FAILURE),
-        error,
-      );
-      this.editorStore.applicationStore.notificationService.notifyError(error);
-    } finally {
-      this.generatingAction.complete();
-    }
-  }
-
-  getScopeElement(
-    element: PackageableElement | string,
-  ): PackageableElementReference<PackageableElement> | string | undefined {
-    return this.fileGeneration.scopeElements.find((el) =>
-      el instanceof PackageableElementReference
-        ? el.value === element
-        : element === el,
-    );
-  }
-
-  addScopeElement(element: PackageableElement | string): void {
-    const el = this.getScopeElement(element);
-    if (!el) {
-      fileGeneration_addScopeElement(
-        this.fileGeneration,
-        element instanceof PackageableElement
-          ? PackageableElementExplicitReference.create(element)
-          : element,
-      );
-    }
-  }
-
-  deleteScopeElement(element: PackageableElement | string): void {
-    const el = this.getScopeElement(element);
-    if (el) {
-      fileGeneration_deleteScopeElement(this.fileGeneration, el);
-    }
-  }
-}