@finos/legend-application-studio 23.0.0 → 23.0.2

package/src/components/editor/side-bar/ProjectDependantsEditor.tsx

@@ -15,10 +15,7 @@
  */
 
 import { useEffect } from 'react';
-import {
-  useApplicationStore,
-  generateExtensionUrlPattern,
-} from '@finos/legend-application';
+import { useApplicationStore } from '@finos/legend-application';
 import {
   PanelListItem,
   Badge,
@@ -40,10 +37,9 @@ import {
 import { generateGAVCoordinates } from '@finos/legend-storage';
 import { flowResult } from 'mobx';
 import { observer } from 'mobx-react-lite';
-import { PROJECT_OVERVIEW_ACTIVITY_MODE } from '../../../stores/sidebar-state/ProjectOverviewState.js';
+import { PROJECT_OVERVIEW_ACTIVITY_MODE } from '../../../stores/editor/sidebar-state/ProjectOverviewState.js';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import {
-  generateDependencyDashboardRoute,
   generateViewProjectByGAVRoute,
   generateViewVersionRoute,
 } from '../../../application/LegendStudioNavigation.js';
@@ -146,7 +142,6 @@ export const ProjectDependantsEditor = observer(() => {
   const editorStore = useEditorStore();
   const applicationStore = useApplicationStore();
   const projectOverviewState = editorStore.projectOverviewState;
-  const configState = editorStore.projectConfigurationEditorState;
   const dependantEditorState = projectOverviewState.projectDependantEditorState;
   const dependants = dependantEditorState.dependants;
   const isLoading =
@@ -196,19 +191,20 @@ export const ProjectDependantsEditor = observer(() => {
           <button
             className="btn btn--dark"
             tabIndex={-1}
-            onClick={() => {
-              applicationStore.navigationService.navigator.visitAddress(
-                generateExtensionUrlPattern(
-                  generateDependencyDashboardRoute(
-                    configState.currentProjectConfiguration.projectId,
-                    configState.currentProjectConfiguration.groupId,
-                    configState.currentProjectConfiguration.artifactId,
-                    undefined,
-                    undefined,
-                  ),
-                ),
-              );
-            }}
+            // FIXME: @xannem we must modularize this instead of depending on an extension-specific logic like this
+            // onClick={() => {
+            //   applicationStore.navigationService.navigator.visitAddress(
+            //     generateExtensionUrlPattern(
+            //       generateDependencyDashboardRoute(
+            //         configState.currentProjectConfiguration.projectId,
+            //         configState.currentProjectConfiguration.groupId,
+            //         configState.currentProjectConfiguration.artifactId,
+            //         undefined,
+            //         undefined,
+            //       ),
+            //     ),
+            //   );
+            // }}
             title="Open dependants dashboard"
           >
             Open Dependants Dashboard

package/src/components/editor/side-bar/ProjectOverview.tsx

@@ -16,7 +16,7 @@
 
 import { forwardRef, useEffect, useState } from 'react';
 import { observer } from 'mobx-react-lite';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import {
   clsx,
   CustomSelectorInput,
@@ -38,7 +38,7 @@ import {
   MenuContentItem,
   MenuContent,
 } from '@finos/legend-art';
-import { PROJECT_OVERVIEW_ACTIVITY_MODE } from '../../../stores/sidebar-state/ProjectOverviewState.js';
+import { PROJECT_OVERVIEW_ACTIVITY_MODE } from '../../../stores/editor/sidebar-state/ProjectOverviewState.js';
 import {
   generateEditorRoute,
   generateViewProjectRoute,
@@ -863,6 +863,7 @@ export const ProjectOverview = observer(() => {
         return <OverviewViewer />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.RELEASE:
         return <ReleaseEditor />;
+      // TODO: @xannem move this into dependency dashboard extension
       case PROJECT_OVERVIEW_ACTIVITY_MODE.DEPENDANTS:
         return <ProjectDependantsEditor />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.VERSIONS:

package/src/components/editor/side-bar/RegisterService.tsx

@@ -15,7 +15,7 @@
  */
 import { useState } from 'react';
 import { observer } from 'mobx-react-lite';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import {
   ContextMenu,
@@ -29,7 +29,7 @@ import {
   EmptyWindowRestoreIcon,
   WindowMaximizeIcon,
 } from '@finos/legend-art';
-import type { BulkServiceRegistrationState } from '../../../stores/sidebar-state/BulkServiceRegistrationState.js';
+import type { BulkServiceRegistrationState } from '../../../stores/editor/sidebar-state/BulkServiceRegistrationState.js';
 import { BulkServiceRegistrationEditor } from '../edit-panel/service-editor/BulkServiceRegistrationEditor.js';
 import { noop } from '@finos/legend-shared';
 

package/src/components/editor/side-bar/SideBar.tsx

@@ -15,7 +15,7 @@
  */
 
 import { observer } from 'mobx-react-lite';
-import { ACTIVITY_MODE } from '../../../stores/EditorConfig.js';
+import { ACTIVITY_MODE } from '../../../stores/editor/EditorConfig.js';
 import { Explorer } from './Explorer.js';
 import { LocalChanges } from './LocalChanges.js';
 import { WorkspaceReview } from './WorkspaceReview.js';

package/src/components/editor/side-bar/WorkflowManager.tsx

@@ -44,7 +44,7 @@ import {
   Modal,
   ModalFooterButton,
 } from '@finos/legend-art';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import { flowResult } from 'mobx';
 import { WorkflowJobStatus, WorkflowStatus } from '@finos/legend-server-sdlc';
 import {
@@ -59,7 +59,7 @@ import {
   type WorkflowState,
   WorkflowJobTreeNodeData,
   WorkflowTreeNodeData,
-} from '../../../stores/sidebar-state/WorkflowManagerState.js';
+} from '../../../stores/editor/sidebar-state/WorkflowManagerState.js';
 import {
   formatDistanceToNow,
   guaranteeNonNullable,

package/src/components/editor/side-bar/WorkspaceReview.tsx

@@ -16,7 +16,7 @@
 
 import { useRef, useEffect } from 'react';
 import { observer } from 'mobx-react-lite';
-import { EntityDiffViewState } from '../../../stores/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
+import { EntityDiffViewState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
 import { EntityDiffSideBarItem } from '../../editor/edit-panel/diff-editor/EntityDiffView.js';
 import {
   clsx,
@@ -29,12 +29,12 @@ import {
   ExternalLinkSquareIcon,
   PanelContent,
 } from '@finos/legend-art';
-import { ACTIVITY_MODE } from '../../../stores/EditorConfig.js';
+import { ACTIVITY_MODE } from '../../../stores/editor/EditorConfig.js';
 import { generateReviewRoute } from '../../../application/LegendStudioNavigation.js';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import { flowResult } from 'mobx';
 import type { EntityDiff } from '@finos/legend-server-sdlc';
-import { entityDiffSorter } from '../../../stores/EditorSDLCState.js';
+import { entityDiffSorter } from '../../../stores/editor/EditorSDLCState.js';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import { useLegendStudioApplicationStore } from '../../LegendStudioBaseStoreProvider.js';
 import { formatDistanceToNow } from '@finos/legend-shared';

package/src/components/editor/side-bar/WorkspaceSyncConflictResolver.tsx

@@ -40,14 +40,14 @@ import {
   EntityChangeConflictEditor,
   EntityChangeConflictSideBarItem,
 } from '../edit-panel/diff-editor/EntityChangeConflictEditor.js';
-import { EntityChangeConflictEditorState } from '../../../stores/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
-import type { EntityDiffViewerState } from '../../../stores/editor-state/entity-diff-editor-state/EntityDiffEditorState.js';
+import { EntityChangeConflictEditorState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
+import type { EntityDiffViewerState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityDiffEditorState.js';
 import {
   EntityDiffSideBarItem,
   EntityDiffView,
 } from '../edit-panel/diff-editor/EntityDiffView.js';
-import { EntityDiffViewState } from '../../../stores/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
-import { entityDiffSorter } from '../../../stores/EditorSDLCState.js';
+import { EntityDiffViewState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
+import { entityDiffSorter } from '../../../stores/editor/EditorSDLCState.js';
 import { flowResult } from 'mobx';
 import { useApplicationStore } from '@finos/legend-application';
 

package/src/components/editor/side-bar/WorkspaceUpdateConflictResolver.tsx

@@ -15,7 +15,7 @@
  */
 
 import { observer } from 'mobx-react-lite';
-import { EntityDiffViewState } from '../../../stores/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
+import { EntityDiffViewState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
 import { EntityDiffSideBarItem } from '../edit-panel/diff-editor/EntityDiffView.js';
 import {
   PanelLoadingIndicator,
@@ -27,14 +27,14 @@ import {
   PanelContent,
 } from '@finos/legend-art';
 import { EntityChangeConflictSideBarItem } from '../edit-panel/diff-editor/EntityChangeConflictEditor.js';
-import { EntityChangeConflictEditorState } from '../../../stores/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { EntityChangeConflictEditorState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import { flowResult } from 'mobx';
 import type {
   EntityChangeConflict,
   EntityDiff,
 } from '@finos/legend-server-sdlc';
-import { entityDiffSorter } from '../../../stores/EditorSDLCState.js';
+import { entityDiffSorter } from '../../../stores/editor/EditorSDLCState.js';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import { useApplicationStore } from '@finos/legend-application';
 

package/src/components/editor/side-bar/WorkspaceUpdater.tsx

@@ -16,7 +16,7 @@
 
 import { useEffect } from 'react';
 import { observer } from 'mobx-react-lite';
-import { EntityDiffViewState } from '../../../stores/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
+import { EntityDiffViewState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
 import { EntityDiffSideBarItem } from '../../editor/edit-panel/diff-editor/EntityDiffView.js';
 import {
   clsx,
@@ -31,15 +31,15 @@ import {
   PanelContent,
 } from '@finos/legend-art';
 import { EntityChangeConflictSideBarItem } from '../../editor/edit-panel/diff-editor/EntityChangeConflictEditor.js';
-import { EntityChangeConflictEditorState } from '../../../stores/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
+import { EntityChangeConflictEditorState } from '../../../stores/editor/editor-state/entity-diff-editor-state/EntityChangeConflictEditorState.js';
 import { generateReviewRoute } from '../../../application/LegendStudioNavigation.js';
-import { LEGEND_STUDIO_TEST_ID } from '../../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../application/LegendStudioTesting.js';
 import { flowResult } from 'mobx';
 import type {
   EntityChangeConflict,
   EntityDiff,
 } from '@finos/legend-server-sdlc';
-import { entityDiffSorter } from '../../../stores/EditorSDLCState.js';
+import { entityDiffSorter } from '../../../stores/editor/EditorSDLCState.js';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import { useLegendStudioApplicationStore } from '../../LegendStudioBaseStoreProvider.js';
 

package/src/components/editor/side-bar/testable/GlobalTestRunner.tsx

@@ -58,7 +58,7 @@ import {
 } from '@finos/legend-shared';
 import { observer } from 'mobx-react-lite';
 import { forwardRef, useEffect, useState } from 'react';
-import { GLOBAL_TEST_RUNNER_TABS } from '../../../../stores/EditorConfig.js';
+import { GLOBAL_TEST_RUNNER_TABS } from '../../../../stores/editor/EditorConfig.js';
 import {
   type TestableExplorerTreeNodeData,
   type GlobalTestRunnerState,
@@ -71,9 +71,9 @@ import {
   getNodeTestableResult,
   getAtomicTest_TestResult,
   getAssertionStatus,
-} from '../../../../stores/sidebar-state/testable/GlobalTestRunnerState.js';
-import type { STO_ProjectOverview_LegendStudioApplicationPlugin_Extension } from '../../../../stores/STO_ProjectOverview_LegendStudioApplicationPlugin_Extension.js';
-import { LEGEND_STUDIO_TEST_ID } from '../../../LegendStudioTestID.js';
+} from '../../../../stores/editor/sidebar-state/testable/GlobalTestRunnerState.js';
+import type { STO_ProjectOverview_LegendStudioApplicationPlugin_Extension } from '../../../../stores/extensions/STO_ProjectOverview_LegendStudioApplicationPlugin_Extension.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../../../application/LegendStudioTesting.js';
 import { TextDiffView } from '../../../shared/DiffView.js';
 import { getElementTypeIcon } from '../../../shared/ElementIconUtils.js';
 import { UnsupportedEditorPanel } from '../../edit-panel/UnsupportedElementEditor.js';

package/src/components/extensions/Core_LegendStudioApplicationPlugin.tsx

@@ -0,0 +1,112 @@
+/**
+ * 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 {
+  collectContextualDocumentationEntries,
+  collectKeyedCommandConfigEntriesFromConfig,
+  type KeyedCommandConfigEntry,
+  type ContextualDocumentationEntry,
+  type SettingConfigurationEntry,
+  collectSettingConfigurationEntriesFromConfig,
+} from '@finos/legend-application';
+import packageJson from '../../../package.json';
+import { LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../../application/LegendStudioApplicationNavigationContext.js';
+import {
+  CORE_CONTEXTUAL_DOCUMENTATION_CONFIG,
+  LEGEND_STUDIO_DOCUMENTATION_KEY,
+} from '../../application/LegendStudioDocumentation.js';
+import { LegendStudioApplicationPlugin } from '../../stores/LegendStudioApplicationPlugin.js';
+import { LEGEND_STUDIO_COMMAND_CONFIG } from '../../application/LegendStudioCommand.js';
+import { LEGEND_STUDIO_SETTING_CONFIG } from '../../application/LegendStudioSetting.js';
+
+export class Core_LegendStudioApplicationPlugin extends LegendStudioApplicationPlugin {
+  static NAME = packageJson.extensions.applicationStudioPlugin;
+
+  constructor() {
+    super(Core_LegendStudioApplicationPlugin.NAME, packageJson.version);
+  }
+
+  override getExtraKeyedCommandConfigEntries(): KeyedCommandConfigEntry[] {
+    return collectKeyedCommandConfigEntriesFromConfig(
+      LEGEND_STUDIO_COMMAND_CONFIG,
+    );
+  }
+
+  override getExtraRequiredDocumentationKeys(): string[] {
+    return [
+      // grammar parsers
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_PURE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_MAPPING,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_RUNTIME,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_RELATIONAL,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_SERVICE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_FILE_GENERATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER_DATA,
+      // grammar elements
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_CLASS,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_PROFILE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_ENUMERATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_MEASURE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_ASSOCIATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_FUNCTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_MAPPING,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_DATABASE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_SERVICE,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_RUNTIME,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_FILE_GENERATION_SPECIFICATION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_DATA_ELEMENT,
+      // grammar elements
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_JSON_MODEL_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_XML_MODEL_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_MODEL_CHAIN_CONNECTION,
+      LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_CONNECTION_RELATIONAL_DATABASE_CONNECTION,
+    ];
+  }
+
+  override getExtraContextualDocumentationEntries(): ContextualDocumentationEntry[] {
+    return collectContextualDocumentationEntries(
+      CORE_CONTEXTUAL_DOCUMENTATION_CONFIG,
+    );
+  }
+
+  override getExtraAccessEventLoggingApplicationContextKeys(): string[] {
+    return [
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.EMBEDDED_QUERY_BUILDER,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.TEXT_MODE_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.MODEL_LOADER,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.CLASS_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.PROFILE_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.ENUMERATION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.ASSOCIATION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.FUNCTION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.MAPPING_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.RUNTIME_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.CONNECTION_EDITOR,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.DATABASE_BUILDER,
+      LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.SERVICE_EDITOR,
+    ];
+  }
+
+  override getExtraSettingConfigurationEntries(): SettingConfigurationEntry[] {
+    return collectSettingConfigurationEntriesFromConfig(
+      LEGEND_STUDIO_SETTING_CONFIG,
+    );
+  }
+}