@finos/legend-application-studio 28.4.4 → 28.5.0

package/src/__lib__/LegendStudioNavigation.ts

@@ -21,6 +21,7 @@ import { generatePath } from '@finos/legend-application/browser';
 
 export enum LEGEND_STUDIO_ROUTE_PATTERN_TOKEN {
   PROJECT_ID = 'projectId',
+  PATCH_RELEASE_VERSION_ID = 'patchReleaseVersionId',
   WORKSPACE_ID = 'workspaceId',
   GROUP_WORKSPACE_ID = 'groupWorkspaceId',
   REVISION_ID = 'revisionId',
@@ -38,12 +39,19 @@ export const LEGEND_STUDIO_ROUTE_PATTERN = Object.freeze({
   VIEW_BY_REVISION_ENTITY: `/view/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/revision/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.REVISION_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
   VIEW_BY_VERSION_ENTITY: `/view/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/version/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.VERSION_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
   REVIEW: `/review/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.REVIEW_ID}`,
+  PATCH_REVIEW: `/review/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.REVIEW_ID}`,
   EDIT_WORKSPACE: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}/`,
+  EDIT_PATCH_WORKSPACE: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}/`,
   EDIT_WORKSPACE_ENTITY: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
+  EDIT_PATCH_WORKSPACE_ENTITY: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
   EDIT_GROUP_WORKSPACE: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/`,
+  EDIT_PATCH_GROUP_WORKSPACE: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/`,
   EDIT_GROUP_WORKSPACE_ENTITY: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
+  EDIT_PATCH_GROUP_WORKSPACE_ENTITY: `/edit/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/entity/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH}`,
   SETUP_WORKSPACE: `/setup/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}?/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}?`,
+  SETUP_PATCH_WORKSPACE: `/setup/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}?/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID}?`,
   SETUP_GROUP_WORKSPACE: `/setup/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/`,
+  SETUP_PATCH_GROUP_WORKSPACE: `/setup/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID}/patches/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID}?/groupWorkspace/:${LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID}/`,
 });
 
 export const LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN = Object.freeze({
@@ -67,6 +75,7 @@ export type ProjectViewerPathParams = {
 
 export type WorkspaceEditorPathParams = {
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID]: string;
+  [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID]?: string;
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID]?: string;
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID]?: string;
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.ENTITY_PATH]?: string;
@@ -74,6 +83,7 @@ export type WorkspaceEditorPathParams = {
 
 export type WorkspaceSetupPathParams = {
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PROJECT_ID]?: string;
+  [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.PATCH_RELEASE_VERSION_ID]?: string;
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.WORKSPACE_ID]?: string;
   [LEGEND_STUDIO_ROUTE_PATTERN_TOKEN.GROUP_WORKSPACE_ID]?: string;
 };
@@ -85,53 +95,99 @@ export type ElementPreviewPathParams = {
 
 const generateGroupWorkspaceSetupRoute = (
   projectId: string | undefined,
+  patchReleaseVersionId: string | undefined,
   groupWorkspaceId: string,
 ): string =>
-  generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_GROUP_WORKSPACE, {
-    // FIXME: due to some problem with typings, we will need to cast like this
-    // we will fix this when upgrading react-router
-    // See https://github.com/finos/legend-studio/issues/688
-    projectId: projectId as string,
-    groupWorkspaceId,
-  });
+  patchReleaseVersionId
+    ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_PATCH_GROUP_WORKSPACE, {
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        projectId: projectId as string,
+        patchReleaseVersionId: patchReleaseVersionId,
+        groupWorkspaceId,
+      })
+    : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_GROUP_WORKSPACE, {
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        projectId: projectId as string,
+        groupWorkspaceId,
+      });
 
 const generateWorkspaceSetupRoute = (
   projectId: string | undefined,
+  patchReleaseVersionId: string | undefined,
   workspaceId?: string,
 ): string =>
-  generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_WORKSPACE, {
-    // FIXME: due to some problem with typings, we will need to cast like this
-    // we will fix this when upgrading react-router
-    // See https://github.com/finos/legend-studio/issues/688
-    projectId: projectId as string,
-    // FIXME: due to some problem with typings, we will need to cast like this
-    // we will fix this when upgrading react-router
-    // See https://github.com/finos/legend-studio/issues/688
-    workspaceId: workspaceId as string,
-  });
+  patchReleaseVersionId
+    ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_PATCH_WORKSPACE, {
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        projectId: projectId as string,
+        patchReleaseVersionId: patchReleaseVersionId,
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        workspaceId: workspaceId as string,
+      })
+    : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.SETUP_WORKSPACE, {
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        projectId: projectId as string,
+        // FIXME: due to some problem with typings, we will need to cast like this
+        // we will fix this when upgrading react-router
+        // See https://github.com/finos/legend-studio/issues/688
+        workspaceId: workspaceId as string,
+      });
 
 export const generateSetupRoute = (
   projectId: string | undefined,
+  patchReleaseVersionId: string | undefined,
   workspaceId?: string | undefined,
   workspaceType?: WorkspaceType | undefined,
 ): string =>
   workspaceType === WorkspaceType.GROUP
     ? generateGroupWorkspaceSetupRoute(
         projectId,
+        patchReleaseVersionId,
         guaranteeNonNullable(workspaceId),
       )
-    : generateWorkspaceSetupRoute(projectId, workspaceId);
+    : generateWorkspaceSetupRoute(
+        projectId,
+        patchReleaseVersionId,
+        workspaceId,
+      );
 
 const generateGroupWorkspaceEditorRoute = (
   projectId: string,
+  patchReleaseVersionId: string | undefined,
   groupWorkspaceId: string,
   entityPath?: string | undefined,
 ): string =>
   !entityPath
-    ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_GROUP_WORKSPACE, {
-        projectId,
-        groupWorkspaceId,
-      })
+    ? patchReleaseVersionId
+      ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_GROUP_WORKSPACE, {
+          projectId,
+          patchReleaseVersionId,
+          groupWorkspaceId,
+        })
+      : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_GROUP_WORKSPACE, {
+          projectId,
+          groupWorkspaceId,
+        })
+    : patchReleaseVersionId
+    ? generatePath(
+        LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_GROUP_WORKSPACE_ENTITY,
+        {
+          projectId,
+          patchReleaseVersionId,
+          groupWorkspaceId,
+          entityPath,
+        },
+      )
     : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_GROUP_WORKSPACE_ENTITY, {
         projectId,
         groupWorkspaceId,
@@ -140,13 +196,27 @@ const generateGroupWorkspaceEditorRoute = (
 
 const generateWorkspaceEditorRoute = (
   projectId: string,
+  patchReleaseVersionId: string | undefined,
   workspaceId: string,
   entityPath?: string | undefined,
 ): string =>
   !entityPath
-    ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_WORKSPACE, {
+    ? patchReleaseVersionId
+      ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_WORKSPACE, {
+          projectId,
+          patchReleaseVersionId,
+          workspaceId,
+        })
+      : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_WORKSPACE, {
+          projectId,
+          workspaceId,
+        })
+    : patchReleaseVersionId
+    ? generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_WORKSPACE_ENTITY, {
         projectId,
+        patchReleaseVersionId,
         workspaceId,
+        entityPath,
       })
     : generatePath(LEGEND_STUDIO_ROUTE_PATTERN.EDIT_WORKSPACE_ENTITY, {
         projectId,
@@ -156,13 +226,24 @@ const generateWorkspaceEditorRoute = (
 
 export const generateEditorRoute = (
   projectId: string,
+  patchReleaseVersionId: string | undefined,
   workspaceId: string,
   workspaceType: WorkspaceType,
   entityPath?: string | undefined,
 ): string =>
   workspaceType === WorkspaceType.GROUP
-    ? generateGroupWorkspaceEditorRoute(projectId, workspaceId, entityPath)
-    : generateWorkspaceEditorRoute(projectId, workspaceId, entityPath);
+    ? generateGroupWorkspaceEditorRoute(
+        projectId,
+        patchReleaseVersionId,
+        workspaceId,
+        entityPath,
+      )
+    : generateWorkspaceEditorRoute(
+        projectId,
+        patchReleaseVersionId,
+        workspaceId,
+        entityPath,
+      );
 
 export const generateReviewRoute = (
   projectId: string,

package/src/components/LegendStudioWebApplication.tsx

@@ -170,9 +170,13 @@ export const LegendStudioWebApplicationRouter = observer(() => {
                   strict={true}
                   path={[
                     LEGEND_STUDIO_ROUTE_PATTERN.EDIT_GROUP_WORKSPACE,
+                    LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_GROUP_WORKSPACE,
                     LEGEND_STUDIO_ROUTE_PATTERN.EDIT_GROUP_WORKSPACE_ENTITY,
+                    LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_GROUP_WORKSPACE_ENTITY,
                     LEGEND_STUDIO_ROUTE_PATTERN.EDIT_WORKSPACE,
+                    LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_WORKSPACE,
                     LEGEND_STUDIO_ROUTE_PATTERN.EDIT_WORKSPACE_ENTITY,
+                    LEGEND_STUDIO_ROUTE_PATTERN.EDIT_PATCH_WORKSPACE_ENTITY,
                   ]}
                   component={
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -185,7 +189,9 @@ export const LegendStudioWebApplicationRouter = observer(() => {
                     // root path will lead to setup page (home page)
                     '/',
                     LEGEND_STUDIO_ROUTE_PATTERN.SETUP_WORKSPACE,
+                    LEGEND_STUDIO_ROUTE_PATTERN.SETUP_PATCH_WORKSPACE,
                     LEGEND_STUDIO_ROUTE_PATTERN.SETUP_GROUP_WORKSPACE,
+                    LEGEND_STUDIO_ROUTE_PATTERN.SETUP_PATCH_GROUP_WORKSPACE,
                   ]}
                   component={
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

package/src/components/editor/ActivityBar.tsx

@@ -89,7 +89,7 @@ export const ActivityBarMenu: React.FC = () => {
   const goToWorkspaceSetup = (): void =>
     applicationStore.navigationService.navigator.visitAddress(
       applicationStore.navigationService.navigator.generateAddress(
-        generateSetupRoute(undefined),
+        generateSetupRoute(undefined, undefined),
       ),
     );
   // help

package/src/components/editor/Editor.tsx

@@ -58,6 +58,7 @@ export const Editor = withEditorStore(
   observer(() => {
     const params = useParams<WorkspaceEditorPathParams>();
     const projectId = params.projectId;
+    const patchReleaseVersionId = params.patchReleaseVersionId;
     const workspaceType = params.groupWorkspaceId
       ? WorkspaceType.GROUP
       : WorkspaceType.USER;
@@ -130,9 +131,21 @@ export const Editor = withEditorStore(
     }, [editorStore, params]);
     useEffect(() => {
       flowResult(
-        editorStore.initialize(projectId, workspaceId, workspaceType),
+        editorStore.initialize(
+          projectId,
+          patchReleaseVersionId,
+          workspaceId,
+          workspaceType,
+        ),
       ).catch(applicationStore.alertUnhandledError);
-    }, [editorStore, applicationStore, projectId, workspaceId, workspaceType]);
+    }, [
+      editorStore,
+      patchReleaseVersionId,
+      applicationStore,
+      projectId,
+      workspaceId,
+      workspaceType,
+    ]);
 
     useEffect(() => {
       applicationStore.navigationService.navigator.blockNavigation(

package/src/components/editor/StatusBar.tsx

@@ -57,6 +57,9 @@ export const StatusBar = observer((props: { actionsDisabled: boolean }) => {
   const workspaceType = params.groupWorkspaceId
     ? WorkspaceType.GROUP
     : WorkspaceType.USER;
+  const patchReleaseVersionId = params.patchReleaseVersionId
+    ? `patch / ${params.patchReleaseVersionId} / `
+    : '';
   const workspaceId = guaranteeNonNullable(
     params.groupWorkspaceId ?? params.workspaceId,
     `Workspace/group workspace ID is not provided`,
@@ -171,7 +174,7 @@ export const StatusBar = observer((props: { actionsDisabled: boolean }) => {
             onClick={(): void =>
               applicationStore.navigationService.navigator.visitAddress(
                 applicationStore.navigationService.navigator.generateAddress(
-                  generateSetupRoute(projectId),
+                  generateSetupRoute(projectId, undefined),
                 ),
               )
             }
@@ -191,6 +194,7 @@ export const StatusBar = observer((props: { actionsDisabled: boolean }) => {
               )
             }
           >
+            {patchReleaseVersionId}
             {workspaceId}
             {editorStore.localChangesState.hasUnpushedChanges ? '*' : ''}
           </button>

package/src/components/editor/__test-utils__/EditorComponentTestUtils.tsx

@@ -332,6 +332,7 @@ export const TEST__setUpEditor = async (
     initialEntries: [
       generateEditorRoute(
         (workspace as unknown as Workspace).projectId,
+        undefined,
         (workspace as unknown as Workspace).workspaceId,
         WorkspaceType.USER,
       ),

package/src/components/editor/editor-group/GrammarTextEditor.tsx

@@ -984,7 +984,8 @@ export const GrammarTextEditor = observer(() => {
         (plugin) =>
           (
             plugin as DSL_LegendStudioApplicationPlugin_Extension
-          ).getAutoFoldingCandidateToken?.() ?? [],
+          ).getExtraGrammarTextEditorAutoFoldingElementCreatorKeywords?.() ??
+          [],
       );
     const foldingClass = editor?.getContribution('editor.contrib.folding');
 
@@ -1056,7 +1057,8 @@ export const GrammarTextEditor = observer(() => {
           (plugin) =>
             (
               plugin as DSL_LegendStudioApplicationPlugin_Extension
-            ).getAutoFoldingCandidateToken?.() ?? [],
+            ).getExtraGrammarTextEditorAutoFoldingElementCreatorKeywords?.() ??
+            [],
         );
       const foldingClass = editor.getContribution('editor.contrib.folding');
 
@@ -1110,7 +1112,8 @@ export const GrammarTextEditor = observer(() => {
           (plugin) =>
             (
               plugin as DSL_LegendStudioApplicationPlugin_Extension
-            ).getAutoFoldingCandidateToken?.() ?? [],
+            ).getExtraGrammarTextEditorAutoFoldingElementCreatorKeywords?.() ??
+            [],
         );
       const foldingClass = editor.getContribution('editor.contrib.folding');
 

package/src/components/editor/editor-group/project-configuration-editor/ProjectDependencyEditor.tsx

@@ -97,7 +97,7 @@ import {
 import { LEGEND_STUDIO_TEST_ID } from '../../../../__lib__/LegendStudioTesting.js';
 import { useEditorStore } from '../../EditorStoreProvider.js';
 
-interface VersionOption {
+export interface VersionOption {
   label: string;
   value: string;
 }