@finos/legend-application-studio 23.0.0 → 23.0.2

package/src/stores/extensions/DSL_Generation_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { PackageableElement } from '@finos/legend-graph';
+import type { GeneratedFileStructureState } from '../editor/editor-state/FileGenerationState.js';
+import type { DSL_LegendStudioApplicationPlugin_Extension } from '../LegendStudioApplicationPlugin.js';
+
+export type FileGenerationResultViewerActionConfiguration = {
+  key: string;
+  renderer: (
+    fileGenerationState: GeneratedFileStructureState,
+  ) => React.ReactNode | undefined;
+};
+
+export type FileGenerationScopeFilterConfiguration = {
+  type: string;
+  filter: (element: PackageableElement) => boolean;
+};
+
+export interface DSL_Generation_LegendStudioApplicationPlugin_Extension
+  extends DSL_LegendStudioApplicationPlugin_Extension {
+  /**
+   * Get drag-and-drop type specifier for model generation specification elements.
+   */
+  getExtraModelGenerationSpecificationElementDnDTypes?(): string[];
+
+  /**
+   * Get the list of the file generation result viewer actions to be rendered.
+   */
+  getExtraFileGenerationResultViewerActionConfigurations?(): FileGenerationResultViewerActionConfiguration[];
+
+  /**
+   * Get the list of filters that check if an element is in scope for certain file generation.
+   *
+   * TODO?: ideally, we should consider having the backend returns this information instead,
+   * maybe the classifier path
+   */
+  getExtraFileGenerationScopeFilterConfigurations?(): FileGenerationScopeFilterConfiguration[];
+}

package/src/stores/extensions/DSL_Mapping_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,212 @@
+/**
+ * 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 { PureGrammarTextSuggestion } from '@finos/legend-application';
+import type { DSL_LegendStudioApplicationPlugin_Extension } from '../LegendStudioApplicationPlugin.js';
+import type { ConnectionValueState } from '../editor/editor-state/element-editor-state/connection/ConnectionEditorState.js';
+import type { EditorStore } from '../editor/EditorStore.js';
+import type {
+  Store,
+  Connection,
+  SetImplementation,
+  InstanceSetImplementation,
+} from '@finos/legend-graph';
+import type { NewConnectionValueDriver } from '../editor/NewElementState.js';
+import type {
+  MappingElement,
+  MappingElementSource,
+} from '../editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
+import type {
+  InstanceSetImplementationState,
+  MappingElementState,
+  PropertyMappingState,
+} from '../editor/editor-state/element-editor-state/mapping/MappingElementState.js';
+
+type MappingSourceTypeInfo = {
+  sourceType: string;
+  sourceName: string;
+};
+
+export type SetImplementationDecorator = (
+  setImplementation: SetImplementation,
+) => void;
+
+export type SetImplementationDecorationCleaner = (
+  setImplementation: SetImplementation,
+) => void;
+
+export interface MappingElementLabel {
+  value: string;
+  root: boolean;
+  tooltip: string;
+}
+
+export type SetImplementationMappingElementLabelInfoBuilder = (
+  setImplementation: SetImplementation,
+) => MappingElementLabel | undefined;
+
+export type MappingElementSourceExtractor = (
+  mappingElement: MappingElement,
+) => MappingElementSource | undefined;
+
+export type MappingElementStateCreator = (
+  mappingElement: MappingElement | undefined,
+  editorStore: EditorStore,
+) => MappingElementState | undefined;
+
+export type DefaultConnectionValueBuilder = (
+  store: Store,
+) => Connection | undefined;
+
+export type ConnectionValueEditorStateBuilder = (
+  editorStore: EditorStore,
+  connection: Connection,
+) => ConnectionValueState | undefined;
+
+export type ConnectionEditorRenderer = (
+  connectionValueState: ConnectionValueState,
+  isReadOnly: boolean,
+) => React.ReactNode | undefined;
+
+export type RuntimeConnectionTooltipTextBuilder = (
+  connection: Connection,
+) => string | undefined;
+
+export type NewConnectionDriverCreator = (
+  editorStore: EditorStore,
+  typeOrStore: Store | string,
+) => NewConnectionValueDriver<Connection> | undefined;
+
+export type ConnectionTypeOption = {
+  value: string;
+  label: string;
+};
+
+export type NewConnectionSnippetSuggestion = PureGrammarTextSuggestion;
+
+/**
+ * @returns a boolean indicating whether the update has ocurred or not
+ */
+export type InstanceSetImplementationSourceUpdater = (
+  setImplementation: InstanceSetImplementation,
+  newSource: unknown | undefined,
+) => boolean;
+
+export type MappingSourceTypeInfoGetter = (
+  setImplementation: SetImplementation,
+) => MappingSourceTypeInfo | undefined;
+
+export type PropertyMappingEditorRenderer = (
+  instanceSetImplementationState: InstanceSetImplementationState,
+  propertyMappingState: PropertyMappingState,
+) => React.ReactNode | undefined;
+
+export type InstanceSetImplementationBlockingErrorChecker = (
+  setImplementationState: InstanceSetImplementationState,
+) => boolean | undefined;
+
+export type InstanceSetImplementationStoreExtractor = (
+  sourceElement: MappingElementSource,
+) => Store | undefined;
+
+export interface DSL_Mapping_LegendStudioApplicationPlugin_Extension
+  extends DSL_LegendStudioApplicationPlugin_Extension {
+  /**
+   * Get the list of set implementation decorators.
+   */
+  getExtraSetImplementationDecorationCleaners?(): SetImplementationDecorationCleaner[];
+
+  /**
+   * Get the list of set implementation decorators.
+   */
+  getExtraSetImplementationDecorators?(): SetImplementationDecorator[];
+
+  /**
+   * Get the list of mapping element info builders for set implemenetation.
+   */
+  getExtraSetImplementationMappingElementLabelInfoBuilders?(): SetImplementationMappingElementLabelInfoBuilder[];
+
+  /**
+   * Get the list of the mapping element state creators for the given class mapping.
+   */
+  getExtraMappingElementStateCreators?(): MappingElementStateCreator[];
+
+  /**
+   * Get the list of source extractors for the specified mapping element.
+   */
+  getExtraMappingElementSourceExtractors?(): MappingElementSourceExtractor[];
+
+  /**
+   * Get extra connection type options.
+   */
+  getExtraConnectionTypeOptions?(): ConnectionTypeOption[];
+
+  /**
+   * Get the list of the default connection value builder for a specified store.
+   */
+  getExtraDefaultConnectionValueBuilders?(): DefaultConnectionValueBuilder[];
+
+  /**
+   * Get the list of editor state builders for a specified connection value.
+   */
+  getExtraConnectionValueEditorStateBuilders?(): ConnectionValueEditorStateBuilder[];
+
+  /**
+   * Get the list of renderers for a specified connection editor state.
+   */
+  getExtraConnectionEditorRenderers?(): ConnectionEditorRenderer[];
+
+  /**
+   * Get the list of the runtime connection tooltip text builders for a specified connection.
+   */
+  getExtraRuntimeConnectionTooltipTextBuilders?(): RuntimeConnectionTooltipTextBuilder[];
+
+  /**
+   * Get the list of creators for connection creation state driver given the store.
+   */
+  getExtraNewConnectionDriverCreators?(): NewConnectionDriverCreator[];
+
+  /**
+   * Get the list of creators for connection creation state driver given the store.
+   */
+  getExtraNewConnectionSnippetSuggestions?(): NewConnectionSnippetSuggestion[];
+
+  /**
+   * Get the list of instance set implementation source updaters.
+   */
+  getExtraInstanceSetImplementationSourceUpdaters?(): InstanceSetImplementationSourceUpdater[];
+
+  /**
+   * Get the list of source-type info getters for mapping.
+   */
+  getExtraMappingSourceTypeInfoGetters?(): MappingSourceTypeInfoGetter[];
+
+  /**
+   * Get the list of renderers for property mapping editor.
+   */
+  getExtraPropertyMappingEditorRenderers?(): PropertyMappingEditorRenderer[];
+
+  /**
+   * Get the list of checkers for errors in the specified instance set implementation that could
+   * potentially block the user interaction until fixed (e.g. parser error in some property mapping transform lambda editor).
+   */
+  getExtraInstanceSetImplementationBlockingErrorCheckers?(): InstanceSetImplementationBlockingErrorChecker[];
+
+  /**
+   * Get the list of store extractor for the given set implementation source.
+   */
+  getExtraInstanceSetImplementationStoreExtractors?(): InstanceSetImplementationStoreExtractor[];
+}

package/src/stores/extensions/DSL_Service_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { Connection, Runtime } from '@finos/legend-graph';
+
+export type ServiceTestRuntimeConnectionBuilder = (
+  sourceConnection: Connection,
+  runtime: Runtime,
+  testData: string,
+) => Connection | undefined;
+
+export interface DSL_Service_LegendStudioApplicationPlugin_Extension
+  extends DSL_LegendStudioApplicationPlugin_Extension {
+  /**
+   * Get the list of service test runtime connection builder for a provided connection and test data.
+   */
+  getExtraServiceTestRuntimeConnectionBuilders?(): ServiceTestRuntimeConnectionBuilder[];
+}

package/src/stores/extensions/STO_ProjectOverview_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 { Workspace } from '@finos/legend-server-sdlc';
+import type { EditorStore } from '../editor/EditorStore.js';
+import type { DSL_LegendStudioApplicationPlugin_Extension } from '../LegendStudioApplicationPlugin.js';
+
+export type TestRunnerTabRenderer = (
+  selectedTab: string,
+  editorStore: EditorStore,
+  currentWorkspace: Workspace | undefined,
+) => React.ReactNode | undefined;
+
+export interface STO_ProjectOverview_LegendStudioApplicationPlugin_Extension
+  extends DSL_LegendStudioApplicationPlugin_Extension {
+  // --------------------- project overview test runner tabs ------------------
+
+  /**
+   * Get the list of the supported classifers for test runner tabs.
+   */
+  getExtraTestRunnerTabsClassifiers?(): string[];
+
+  /**
+   * Get the list of renderers for the editor for a test runner tab.
+   */
+  getExtraTestRunnerTabsEditorRenderers?(): TestRunnerTabRenderer[];
+}

package/src/stores/extensions/STO_Relational_LegendStudioApplicationPlugin_Extension.ts

@@ -0,0 +1,167 @@
+/**
+ * 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/editor-state/element-editor-state/connection/ConnectionEditorState.js';
+import type { PostProcessorEditorState } from '../editor/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[];
+}