@finos/legend-application-studio 22.6.0 → 23.0.1

package/src/components/workspace-setup/WorkspaceSetup.tsx

@@ -26,34 +26,34 @@ import {
   CustomSelectorInput,
   RepoIcon,
 } from '@finos/legend-art';
-import { LEGEND_STUDIO_TEST_ID } from '../LegendStudioTestID.js';
+import { LEGEND_STUDIO_TEST_ID } from '../../application/LegendStudioTesting.js';
 import {
   type SetupPathParams,
   generateEditorRoute,
-  LEGEND_STUDIO_PATH_PARAM_TOKEN,
-} from '../../stores/LegendStudioRouter.js';
+  LEGEND_STUDIO_ROUTE_PATTERN_TOKEN,
+} from '../../application/LegendStudioNavigation.js';
 import { flowResult } from 'mobx';
 import {
   DocumentationLink,
   useApplicationNavigationContext,
   useParams,
 } from '@finos/legend-application';
-import { LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../stores/LegendStudioDocumentation.js';
+import { LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../application/LegendStudioDocumentation.js';
 import { CreateProjectModal } from './CreateProjectModal.js';
 import { ActivityBarMenu } from '../editor/ActivityBar.js';
-import { LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../../stores/LegendStudioApplicationNavigationContext.js';
+import { LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../../application/LegendStudioApplicationNavigationContext.js';
 import { CreateWorkspaceModal } from './CreateWorkspaceModal.js';
 import { useLegendStudioApplicationStore } from '../LegendStudioBaseStoreProvider.js';
 import {
   type ProjectOption,
   buildProjectOption,
   getProjectOptionLabelFormatter,
-} from '../shared/ProjectSelectorUtils.js';
+} from './ProjectSelectorUtils.js';
 import {
   type WorkspaceOption,
   buildWorkspaceOption,
   formatWorkspaceOptionLabel,
-} from '../shared/WorkspaceSelectorUtils.js';
+} from './WorkspaceSelectorUtils.js';
 import { debounce, guaranteeNonNullable } from '@finos/legend-shared';
 import { WorkspaceSetupStore } from '../../stores/workspace-setup/WorkspaceSetupStore.js';
 import { useSDLCServerClient } from '@finos/legend-server-sdlc';
@@ -95,10 +95,10 @@ const withWorkspaceSetupStore = (WrappedComponent: React.FC): React.FC =>
 export const WorkspaceSetup = withWorkspaceSetupStore(
   observer(() => {
     const params = useParams<SetupPathParams>();
-    const projectId = params[LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID];
-    const workspaceId = params[LEGEND_STUDIO_PATH_PARAM_TOKEN.WORKSPACE_ID];
+    const projectId = params[LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID];
+    const workspaceId = params[LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID];
     const groupWorkspaceId =
-      params[LEGEND_STUDIO_PATH_PARAM_TOKEN.GROUP_WORKSPACE_ID];
+      params[LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID];
     const setupStore = useWorkspaceSetupStore();
     const applicationStore = useLegendStudioApplicationStore();
     const [projectSearchText, setProjectSearchText] = useState('');

package/src/index.ts

@@ -15,24 +15,28 @@
  */
 
 // application
-export * from './components/LegendStudioBaseStoreProvider.js';
-export * from './stores/LegendStudioBaseStore.js';
 export * from './application/LegendStudio.js';
 export * from './application/LegendStudioApplicationConfig.js';
 export * from './application/LegendStudioPluginManager.js';
-export * from './stores/LegendStudioAppEvent.js';
-export { queryClass } from './components/editor/edit-panel/uml-editor/ClassQueryBuilder.js';
+export * from './application/LegendStudioEvent.js';
+export {
+  generateEditorRoute,
+  generateReviewRoute,
+  generateViewProjectRoute,
+} from './application/LegendStudioNavigation.js';
+export { useLegendStudioApplicationStore } from './components/LegendStudioBaseStoreProvider.js';
+export type { LegendStudioApplicationStore } from './stores/LegendStudioBaseStore.js';
 
 // stores
 export * from './stores/LegendStudioApplicationPlugin.js';
-export * from './stores/EditorTabManagerState.js';
-export * from './stores/EditorStore.js';
-export * from './stores/EditorConfig.js';
-export * from './stores/editor-state/ModelImporterState.js';
+export * from './stores/editor/EditorTabManagerState.js';
+export * from './stores/editor/EditorStore.js';
+export * from './stores/editor/EditorConfig.js';
+export * from './stores/editor/editor-state/ModelImporterState.js';
 export * from './stores/workspace-setup/ProjectConfigurationStatus.js';
-export { ClassEditorState } from './stores/editor-state/element-editor-state/ClassEditorState.js';
-export { ElementEditorState } from './stores/editor-state/element-editor-state/ElementEditorState.js';
-export { UnsupportedElementEditorState } from './stores/editor-state/UnsupportedElementEditorState.js';
+export { ClassEditorState } from './stores/editor/editor-state/element-editor-state/ClassEditorState.js';
+export { ElementEditorState } from './stores/editor/editor-state/element-editor-state/ElementEditorState.js';
+export { UnsupportedElementEditorState } from './stores/editor/editor-state/UnsupportedElementEditorState.js';
 export {
   NewElementState,
   NewElementDriver,
@@ -44,25 +48,25 @@ export {
   TypeDragSource,
   type UMLEditorElementDropTarget,
   type TransformDropTarget,
-} from './stores/shared/DnDUtils.js';
-export { ExplorerTreeRootPackageLabel } from './stores/ExplorerTreeState.js';
-export * from './stores/shared/modifier/GraphModifierHelper.js';
-export * from './stores/shared/modifier/DomainGraphModifierHelper.js';
-export * from './stores/DSL_Mapping_LegendStudioApplicationPlugin_Extension.js';
-export * from './stores/DSL_Service_LegendStudioApplicationPlugin_Extension.js';
-export * from './stores/DSL_Data_LegendStudioApplicationPlugin_Extension.js';
-export * from './stores/shared/modifier/DSL_Generation_GraphModifierHelper.js';
-export * from './stores/shared/modifier/DSL_Service_GraphModifierHelper.js';
+} from './stores/editor/shared/DnDUtils.js';
+export { ExplorerTreeRootPackageLabel } from './stores/editor/ExplorerTreeState.js';
+export * from './stores/editor/shared/modifier/GraphModifierHelper.js';
+export * from './stores/editor/shared/modifier/DomainGraphModifierHelper.js';
+export * from './stores/editor/shared/modifier/DSL_Generation_GraphModifierHelper.js';
+export * from './stores/editor/shared/modifier/DSL_Service_GraphModifierHelper.js';
+export * from './stores/extensions/DSL_Mapping_LegendStudioApplicationPlugin_Extension.js';
+export * from './stores/extensions/DSL_Service_LegendStudioApplicationPlugin_Extension.js';
+export * from './stores/extensions/DSL_Data_LegendStudioApplicationPlugin_Extension.js';
 
 // components
+export { queryClass } from './components/editor/edit-panel/uml-editor/ClassQueryBuilder.js';
 export * from './components/editor/EditorStoreProvider.js';
-export * from './stores/LegendStudioRouter.js';
 export { ActivityBarMenu } from './components/editor/ActivityBar.js';
-export * from './components/shared/ProjectSelectorUtils.js';
-export * from './components/shared/WorkspaceSelectorUtils.js';
+export * from './components/workspace-setup/ProjectSelectorUtils.js';
+export * from './components/workspace-setup/WorkspaceSelectorUtils.js';
 export { ClassFormEditor } from './components/editor/edit-panel/uml-editor/ClassEditor.js';
-export { TypeTree } from './components/shared/TypeTree.js';
-export * from './stores/sidebar-state/testable/GlobalTestRunnerState.js';
+export { TypeTree } from './components/editor/edit-panel/mapping-editor/TypeTree.js';
+export * from './stores/editor/sidebar-state/testable/GlobalTestRunnerState.js';
 
 // test
 export {
@@ -71,19 +75,19 @@ export {
   TEST__setUpEditorWithDefaultSDLCData,
   TEST__openElementFromExplorerTree,
 } from './components/EditorComponentTestUtils.js';
-export * from './components/LegendStudioTestID.js';
-export * from './stores/EditorStoreTestUtils.js';
+export * from './application/LegendStudioTesting.js';
+export * from './stores/editor/EditorStoreTestUtils.js';
 
-export { PostProcessorEditorState } from './stores/editor-state/element-editor-state/connection/PostProcessorEditorState.js';
-export { MappingExecutionState } from './stores/editor-state/element-editor-state/mapping/MappingExecutionState.js';
-export { MappingTestState } from './stores/editor-state/element-editor-state/mapping/MappingTestState.js';
+export { PostProcessorEditorState } from './stores/editor/editor-state/element-editor-state/connection/PostProcessorEditorState.js';
+export { MappingExecutionState } from './stores/editor/editor-state/element-editor-state/mapping/MappingExecutionState.js';
+export { MappingTestState } from './stores/editor/editor-state/element-editor-state/mapping/MappingTestState.js';
 export {
   ConnectionValueState,
   RelationalDatabaseConnectionValueState,
-} from './stores/editor-state/element-editor-state/connection/ConnectionEditorState.js';
-export * from './stores/editor-state/element-editor-state/mapping/MappingEditorState.js';
-export { MappingElementState } from './stores/editor-state/element-editor-state/mapping/MappingElementState.js';
-export { UnsupportedInstanceSetImplementationState } from './stores/editor-state/element-editor-state/mapping/UnsupportedInstanceSetImplementationState.js';
+} from './stores/editor/editor-state/element-editor-state/connection/ConnectionEditorState.js';
+export * from './stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
+export { MappingElementState } from './stores/editor/editor-state/element-editor-state/mapping/MappingElementState.js';
+export { UnsupportedInstanceSetImplementationState } from './stores/editor/editor-state/element-editor-state/mapping/UnsupportedInstanceSetImplementationState.js';
 export { getElementIcon } from './components/shared/ElementIconUtils.js';
 
 // --------------------------------------------- DSL --------------------------------------------------
@@ -92,29 +96,30 @@ export { getElementIcon } from './components/shared/ElementIconUtils.js';
  * See https://github.com/finos/legend-studio/issues/65
  */
 
-export * from './stores/DSL_Generation_LegendStudioApplicationPlugin_Extension.js';
-export * from './stores/STO_Relational_LegendStudioApplicationPlugin_Extension.js';
+export * from './stores/extensions/DSL_Generation_LegendStudioApplicationPlugin_Extension.js';
+export * from './stores/extensions/STO_ProjectOverview_LegendStudioApplicationPlugin_Extension.js';
+export * from './stores/extensions/STO_Relational_LegendStudioApplicationPlugin_Extension.js';
 
-export { MINIMUM_SERVICE_OWNERS } from './stores/editor-state/element-editor-state/service/ServiceEditorState.js';
+export { MINIMUM_SERVICE_OWNERS } from './stores/editor/editor-state/element-editor-state/service/ServiceEditorState.js';
 export {
   LATEST_PROJECT_REVISION,
   generateServiceManagementUrl,
-} from './stores/editor-state/element-editor-state/service/ServiceRegistrationState.js';
-export { ServicePureExecutionState } from './stores/editor-state/element-editor-state/service/ServiceExecutionState.js';
+} from './stores/editor/editor-state/element-editor-state/service/ServiceRegistrationState.js';
+export { ServicePureExecutionState } from './stores/editor/editor-state/element-editor-state/service/ServiceExecutionState.js';
 export { NewServiceModal } from './components/editor/edit-panel/service-editor/NewServiceModal.js';
-export { FileSystem_File as GenerationFile } from './stores/shared/FileSystemTreeUtils.js';
+export { FileSystem_File as GenerationFile } from './stores/editor/shared/FileSystemTreeUtils.js';
 export {
   FileGenerationState,
   GeneratedFileStructureState,
-} from './stores/editor-state/FileGenerationState.js';
-export { DSL_ExternalFormat_LegendStudioApplicationPlugin } from './components/DSL_ExternalFormat_LegendStudioApplicationPlugin.js';
+} from './stores/editor/editor-state/FileGenerationState.js';
+export { DSL_ExternalFormat_LegendStudioApplicationPlugin } from './components/extensions/DSL_ExternalFormat_LegendStudioApplicationPlugin.js';
 export {
   externalFormatData_setData,
   externalFormatData_setContentType,
-} from './stores/shared/modifier/DSL_Data_GraphModifierHelper.js';
+} from './stores/editor/shared/modifier/DSL_Data_GraphModifierHelper.js';
 export { ExternalFormatDataEditor } from './components/editor/edit-panel/data-editor/DataElementEditor.js';
 export {
   ExternalFormatDataState,
   EmbeddedDataState,
-} from './stores/editor-state/element-editor-state/data/EmbeddedDataState.js';
-export type { EmbeddedDataTypeOption } from './stores/editor-state/element-editor-state/data/DataEditorState.js';
+} from './stores/editor/editor-state/element-editor-state/data/EmbeddedDataState.js';
+export type { EmbeddedDataTypeOption } from './stores/editor/editor-state/element-editor-state/data/DataEditorState.js';

package/src/stores/LegendStudioApplicationPlugin.ts

@@ -15,8 +15,11 @@
  */
 
 import type { LegendStudioPluginManager } from '../application/LegendStudioPluginManager.js';
-import type { ElementEditorState } from './editor-state/element-editor-state/ElementEditorState.js';
-import type { EditorExtensionState, EditorStore } from './EditorStore.js';
+import type { ElementEditorState } from './editor/editor-state/element-editor-state/ElementEditorState.js';
+import type {
+  EditorExtensionState,
+  EditorStore,
+} from './editor/EditorStore.js';
 import type {
   NewElementDriver,
   NewElementState,
@@ -26,12 +29,13 @@ import {
   type DocumentationEntry,
   type PureGrammarTextSuggestion,
   LegendApplicationPlugin,
+  type ApplicationPageEntry,
 } from '@finos/legend-application';
-import type { TestableMetadata } from './sidebar-state/testable/GlobalTestRunnerState.js';
+import type { TestableMetadata } from './editor/sidebar-state/testable/GlobalTestRunnerState.js';
 import type {
   ExtensionModelImportRendererState,
   ModelImporterState,
-} from './editor-state/ModelImporterState.js';
+} from './editor/editor-state/ModelImporterState.js';
 
 export type ExplorerContextMenuItemRendererConfiguration = {
   key: string;
@@ -69,6 +73,10 @@ export type ModelImporterExtensionConfiguration = {
   ) => Promise<void>;
 };
 
+export type LegendStudioApplicationPageEntry = ApplicationPageEntry & {
+  bypassSDLC?: boolean | undefined;
+};
+
 export type TestableMetadataGetter = (
   testable: Testable,
   editorStore: EditorStore,
@@ -85,6 +93,11 @@ export abstract class LegendStudioApplicationPlugin extends LegendApplicationPlu
     pluginManager.registerApplicationPlugin(this);
   }
 
+  /**
+   * Get the list of application page entries to be rendered
+   */
+  override getExtraApplicationPageEntries?(): LegendStudioApplicationPageEntry[];
+
   /**
    * Get the list of items to be rendered in the explorer context menu.
    */
@@ -98,14 +111,14 @@ export abstract class LegendStudioApplicationPlugin extends LegendApplicationPlu
   getExtraEditorExtensionStateCreators?(): EditorExtensionStateCreator[];
 
   /**
-   * Get the list of renderers for the preview panel of a class.
+   * Get the list of configurations for the renderer of editor extension states.
    */
-  getExtraClassPreviewRenderers?(): ClassPreviewRenderer[];
+  getExtraEditorExtensionComponentRendererConfigurations?(): EditorExtensionComponentRendererConfiguration[];
 
   /**
-   * Get the list of configurations for the renderer of editor extension states.
+   * Get the list of renderers for the preview panel of a class.
    */
-  getExtraEditorExtensionComponentRendererConfigurations?(): EditorExtensionComponentRendererConfiguration[];
+  getExtraClassPreviewRenderers?(): ClassPreviewRenderer[];
 
   /**
    * Get the list of extension configurations for model importer.

package/src/stores/LegendStudioBaseStore.ts

@@ -22,14 +22,16 @@ import {
   ActionState,
   LogEvent,
   assertErrorThrown,
+  NetworkClient,
 } from '@finos/legend-shared';
 import {
   type ApplicationStore,
   ActionAlertActionType,
   ActionAlertType,
-  ApplicationTelemetry,
+  LegendApplicationTelemetryHelper,
   matchPath,
   APPLICATION_EVENT,
+  generateExtensionUrlPattern,
 } from '@finos/legend-application';
 import {
   action,
@@ -40,12 +42,12 @@ import {
   observable,
 } from 'mobx';
 import { User, SDLCServerClient } from '@finos/legend-server-sdlc';
-import { LEGEND_STUDIO_APP_EVENT } from './LegendStudioAppEvent.js';
+import { LEGEND_STUDIO_APP_EVENT } from '../application/LegendStudioEvent.js';
 import type { DepotServerClient } from '@finos/legend-server-depot';
 import type { LegendStudioPluginManager } from '../application/LegendStudioPluginManager.js';
 import type { LegendStudioApplicationConfig } from '../application/LegendStudioApplicationConfig.js';
-import { LegendStudioEventService } from './LegendStudioEventService.js';
-import { LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN } from './LegendStudioRouter.js';
+import { LegendStudioEventHelper } from '../application/LegendStudioEventHelper.js';
+import { LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN } from '../application/LegendStudioNavigation.js';
 
 export type LegendStudioApplicationStore = ApplicationStore<
   LegendStudioApplicationConfig,
@@ -99,14 +101,21 @@ export class LegendStudioBaseStore {
     }
     this.initState.inProgress();
 
+    const SDLCBypassedRoutePatterns = this.applicationStore.pluginManager
+      .getApplicationPlugins()
+      .flatMap((plugin) => plugin.getExtraApplicationPageEntries?.() ?? [])
+      .filter((entry) => entry.bypassSDLC)
+      .flatMap((entry) => entry.urlPatterns.map(generateExtensionUrlPattern));
+
     // authorize SDLC, unless navigation location match SDLC-bypassed patterns
     if (
       !matchPath(
         this.applicationStore.navigationService.navigator.getCurrentLocation(),
         [
-          // TODO: we might want to consider making this extensible
           LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN.VIEW_BY_GAV,
           LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN.VIEW_BY_GAV_ENTITY,
+          LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN.PREVIEW_BY_GAV_ENTITY,
+          ...SDLCBypassedRoutePatterns,
         ],
       )
     ) {
@@ -124,9 +133,7 @@ export class LegendStudioBaseStore {
       } catch (error) {
         assertErrorThrown(error);
         this.applicationStore.logService.error(
-          LogEvent.create(
-            APPLICATION_EVENT.APPLICATION_IDENTITY_AUTO_FETCH__FAILURE,
-          ),
+          LogEvent.create(APPLICATION_EVENT.IDENTITY_AUTO_FETCH__FAILURE),
           error,
         );
         this.applicationStore.notificationService.notifyWarning(error.message);
@@ -138,14 +145,32 @@ export class LegendStudioBaseStore {
       this.isSDLCAuthorized = undefined;
     }
 
-    ApplicationTelemetry.logEvent_ApplicationInitializationSucceeded(
+    // retrieved the user identity is not already configured
+    if (this.applicationStore.identityService.isAnonymous) {
+      try {
+        this.applicationStore.identityService.setCurrentUser(
+          (yield new NetworkClient().get(
+            `${this.applicationStore.config.engineServerUrl}/server/v1/currentUser`,
+          )) as string,
+        );
+      } catch (error) {
+        assertErrorThrown(error);
+        this.applicationStore.logService.error(
+          LogEvent.create(APPLICATION_EVENT.IDENTITY_AUTO_FETCH__FAILURE),
+          error,
+        );
+        this.applicationStore.notificationService.notifyWarning(error.message);
+      }
+    }
+
+    LegendApplicationTelemetryHelper.logEvent_ApplicationInitializationSucceeded(
       this.applicationStore.telemetryService,
       this.applicationStore,
     );
 
-    LegendStudioEventService.create(
+    LegendStudioEventHelper.notify_ApplicationLoadSucceeded(
       this.applicationStore.eventService,
-    ).notify_ApplicationLoaded();
+    );
 
     this.initState.complete();
   }