@finos/legend-extension-dsl-data-space 9.1.7 → 9.2.1

package/src/stores/DataSpaceViewerState.ts

@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 
-import type { GenericLegendApplicationStore } from '@finos/legend-application';
+import type {
+  GenericLegendApplicationStore,
+  NavigationZone,
+} from '@finos/legend-application';
 import {
   type ClassView,
   type DiagramRenderer,
@@ -22,6 +25,7 @@ import {
 } from '@finos/legend-extension-dsl-diagram';
 import type {
   BasicGraphManagerState,
+  GraphData,
   PackageableRuntime,
 } from '@finos/legend-graph';
 import {
@@ -38,31 +42,54 @@ import {
   PURE_DATA_SPACE_INFO_PROFILE_PATH,
   PURE_DATA_SPACE_INFO_PROFILE_VERIFIED_STEREOTYPE,
 } from '../graphManager/DSL_DataSpace_PureGraphManagerPlugin.js';
+import { DataSpaceViewerDataAccessState } from './DataSpaceViewerDataAccessState.js';
 
 export enum DATA_SPACE_VIEWER_ACTIVITY_MODE {
-  DESCRIPTION = 'DESCRIPTION',
-  DIAGRAM_VIEWER = 'DIAGRAM_VIEWER',
-  MODELS_DOCUMENTATION = 'MODELS_DOCUMENTATION',
-  QUICK_START = 'QUICK_START',
-  EXECUTION_CONTEXT = 'EXECUTION_CONTEXT',
-  DATA_ACCESS = 'DATA_ACCESS',
-
-  DATA_STORES = 'DATA_STORES', // TODO: with test-data, also let user call TDS query on top of these
-  DATA_AVAILABILITY = 'DATA_AVAILABILITY',
-  DATA_COST = 'DATA_COST',
-  DATA_GOVERNANCE = 'DATA_GOVERNANCE',
-  INFO = 'INFO', // TODO: test coverage? (or maybe this should be done in elements/diagrams/data-quality section)
-  SUPPORT = 'SUPPORT',
+  DESCRIPTION = 'description',
+  DIAGRAM_VIEWER = 'diagram_viewer',
+  MODELS_DOCUMENTATION = 'models_documentation',
+  QUICK_START = 'quick_start',
+  EXECUTION_CONTEXT = 'execution_context',
+  DATA_ACCESS = 'data_access',
+
+  DATA_STORES = 'data_stores', // TODO: with test-data, also let user call TDS query on top of these
+  DATA_AVAILABILITY = 'data_availability',
+  DATA_READINESS = 'data_readiness',
+  DATA_COST = 'data_cost',
+  DATA_GOVERNANCE = 'data_governance',
+  INFO = 'info', // TODO: test coverage? (or maybe this should be done in elements/diagrams/data-quality section)
+  SUPPORT = 'support',
+}
+
+class DataSpaceLayoutState {
+  readonly dataSpaceViewerState: DataSpaceViewerState;
+
+  isExpandedModeEnabled = false;
+
+  constructor(dataSpaceViewerState: DataSpaceViewerState) {
+    makeObservable(this, {
+      isExpandedModeEnabled: observable,
+      enableExpandedMode: action,
+    });
+
+    this.dataSpaceViewerState = dataSpaceViewerState;
+  }
+
+  enableExpandedMode(val: boolean): void {
+    this.isExpandedModeEnabled = val;
+  }
 }
 
 export class DataSpaceViewerState {
   readonly applicationStore: GenericLegendApplicationStore;
   readonly graphManagerState: BasicGraphManagerState;
+  readonly layoutState: DataSpaceLayoutState;
 
+  readonly dataSpaceAnalysisResult: DataSpaceAnalysisResult;
   readonly groupId: string;
   readonly artifactId: string;
   readonly versionId: string;
-  readonly dataSpaceAnalysisResult: DataSpaceAnalysisResult;
+  readonly retriveGraphData: () => GraphData;
   readonly viewProject: (
     groupId: string,
     artifactId: string,
@@ -75,6 +102,11 @@ export class DataSpaceViewerState {
     entityPath: string | undefined,
   ) => Promise<void>;
   readonly onDiagramClassDoubleClick: (classView: ClassView) => void;
+  readonly onZoneChange?:
+    | ((zone: NavigationZone | undefined) => void)
+    | undefined;
+
+  readonly dataAccessState: DataSpaceViewerDataAccessState;
 
   _renderer?: DiagramRenderer | undefined;
   currentDiagram?: DataSpaceDiagramAnalysisResult | undefined;
@@ -82,8 +114,6 @@ export class DataSpaceViewerState {
   currentExecutionContext: DataSpaceExecutionContextAnalysisResult;
   currentRuntime: PackageableRuntime;
 
-  isExpandedModeEnabled = false;
-
   constructor(
     applicationStore: GenericLegendApplicationStore,
     graphManagerState: BasicGraphManagerState,
@@ -92,6 +122,7 @@ export class DataSpaceViewerState {
     versionId: string,
     dataSpaceAnalysisResult: DataSpaceAnalysisResult,
     actions: {
+      retriveGraphData: () => GraphData;
       viewProject: (
         groupId: string,
         artifactId: string,
@@ -104,6 +135,7 @@ export class DataSpaceViewerState {
         entityPath: string | undefined,
       ) => Promise<void>;
       onDiagramClassDoubleClick: (classView: ClassView) => void;
+      onZoneChange?: ((zone: NavigationZone | undefined) => void) | undefined;
     },
   ) {
     makeObservable(this, {
@@ -112,19 +144,19 @@ export class DataSpaceViewerState {
       currentActivity: observable,
       currentExecutionContext: observable,
       currentRuntime: observable,
-      isExpandedModeEnabled: observable,
       isVerified: computed,
-      renderer: computed,
-      setRenderer: action,
+      diagramRenderer: computed,
+      setDiagramRenderer: action,
       setCurrentDiagram: action,
       setCurrentActivity: action,
       setCurrentExecutionContext: action,
       setCurrentRuntime: action,
-      enableExpandedMode: action,
     });
 
     this.applicationStore = applicationStore;
     this.graphManagerState = graphManagerState;
+    this.layoutState = new DataSpaceLayoutState(this);
+
     this.dataSpaceAnalysisResult = dataSpaceAnalysisResult;
     this.groupId = groupId;
     this.artifactId = artifactId;
@@ -135,12 +167,16 @@ export class DataSpaceViewerState {
     this.currentDiagram = getNullableFirstElement(
       this.dataSpaceAnalysisResult.diagrams,
     );
+    this.retriveGraphData = actions.retriveGraphData;
     this.viewProject = actions.viewProject;
     this.viewSDLCProject = actions.viewSDLCProject;
     this.onDiagramClassDoubleClick = actions.onDiagramClassDoubleClick;
+    this.onZoneChange = actions.onZoneChange;
+
+    this.dataAccessState = new DataSpaceViewerDataAccessState(this);
   }
 
-  get renderer(): DiagramRenderer {
+  get diagramRenderer(): DiagramRenderer {
     return guaranteeNonNullable(
       this._renderer,
       `Diagram renderer must be initialized (this is likely caused by calling this method at the wrong place)`,
@@ -159,12 +195,12 @@ export class DataSpaceViewerState {
     if (!this.isDiagramRendererInitialized) {
       return '';
     }
-    if (this.renderer.middleClick || this.renderer.rightClick) {
+    if (this.diagramRenderer.middleClick || this.diagramRenderer.rightClick) {
       return 'diagram-editor__cursor--grabbing';
     }
-    switch (this.renderer.interactionMode) {
+    switch (this.diagramRenderer.interactionMode) {
       case DIAGRAM_INTERACTION_MODE.LAYOUT: {
-        if (this.renderer.mouseOverClassView) {
+        if (this.diagramRenderer.mouseOverClassView) {
           return 'diagram-editor__cursor--pointer';
         }
         return '';
@@ -184,7 +220,7 @@ export class DataSpaceViewerState {
     );
   }
 
-  setRenderer(val: DiagramRenderer): void {
+  setDiagramRenderer(val: DiagramRenderer): void {
     this._renderer = val;
   }
 
@@ -207,14 +243,71 @@ export class DataSpaceViewerState {
     this.currentRuntime = val;
   }
 
-  setupRenderer(): void {
-    this.renderer.setIsReadOnly(true);
-    this.renderer.setEnableLayoutAutoAdjustment(true);
-    this.renderer.onClassViewDoubleClick = (classView: ClassView): void =>
-      this.onDiagramClassDoubleClick(classView);
+  setupDiagramRenderer(): void {
+    this.diagramRenderer.setIsReadOnly(true);
+    this.diagramRenderer.setEnableLayoutAutoAdjustment(true);
+    this.diagramRenderer.onClassViewDoubleClick = (
+      classView: ClassView,
+    ): void => this.onDiagramClassDoubleClick(classView);
   }
 
-  enableExpandedMode(val: boolean): void {
-    this.isExpandedModeEnabled = val;
+  changeZone(zone: NavigationZone): void {
+    switch (zone) {
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DESCRIPTION:
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DIAGRAM_VIEWER:
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.MODELS_DOCUMENTATION:
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.QUICK_START: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DESCRIPTION);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.EXECUTION_CONTEXT: {
+        this.setCurrentActivity(
+          DATA_SPACE_VIEWER_ACTIVITY_MODE.EXECUTION_CONTEXT,
+        );
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_ACCESS: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_ACCESS);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_STORES: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_STORES);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_AVAILABILITY: {
+        this.setCurrentActivity(
+          DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_AVAILABILITY,
+        );
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_READINESS: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_READINESS);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_COST: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_COST);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_GOVERNANCE: {
+        this.setCurrentActivity(
+          DATA_SPACE_VIEWER_ACTIVITY_MODE.DATA_GOVERNANCE,
+        );
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.INFO: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.INFO);
+        break;
+      }
+      case DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT: {
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT);
+        break;
+      }
+      default: {
+        // unknown
+        this.setCurrentActivity(DATA_SPACE_VIEWER_ACTIVITY_MODE.DESCRIPTION);
+        this.onZoneChange?.(undefined);
+        break;
+      }
+    }
   }
 }

package/src/stores/query/DataSpaceAdvancedSearchState.ts

@@ -15,7 +15,12 @@
  */
 
 import type { ClassView } from '@finos/legend-extension-dsl-diagram';
-import type { Class, GraphManagerState } from '@finos/legend-graph';
+import {
+  GraphDataWithOrigin,
+  type Class,
+  type GraphManagerState,
+  LegendSDLC,
+} from '@finos/legend-graph';
 import {
   type StoredEntity,
   type DepotServerClient,
@@ -192,6 +197,14 @@ export class DataSpaceAdvancedSearchState {
         dataSpace.versionId,
         analysisResult,
         {
+          retriveGraphData: () =>
+            new GraphDataWithOrigin(
+              new LegendSDLC(
+                dataSpace.groupId,
+                dataSpace.artifactId,
+                dataSpace.versionId,
+              ),
+            ),
           viewProject: this.viewProject,
           viewSDLCProject: this.viewSDLCProject,
           onDiagramClassDoubleClick: (classView: ClassView): void => {

package/src/stores/studio/DataSpacePreviewState.ts

@@ -31,6 +31,7 @@ import type { DataSpace } from '../../graph/metamodel/pure/model/packageableElem
 import type { DataSpaceAnalysisResult } from '../../graphManager/action/analytics/DataSpaceAnalysis.js';
 import { DSL_DataSpace_getGraphManagerExtension } from '../../graphManager/protocol/pure/DSL_DataSpace_PureGraphManagerExtension.js';
 import { DataSpaceViewerState } from '../DataSpaceViewerState.js';
+import { LiveGraphData } from '@finos/legend-graph';
 
 export class DataSpacePreviewState extends EditorExtensionState {
   readonly editorStore: EditorStore;
@@ -116,6 +117,8 @@ export class DataSpacePreviewState extends EditorExtensionState {
         versionId,
         analysisResult,
         {
+          retriveGraphData: () =>
+            new LiveGraphData(this.editorStore.graphManagerState.graph),
           viewProject: () => {
             this.editorStore.applicationStore.notificationService.notifyWarning(
               'This feature is not supported in preview mode',

package/tsconfig.json

@@ -57,6 +57,7 @@
     "./src/graphManager/protocol/pure/v1/transformation/pureGraph/V1_DSL_DataSpace_GraphBuilderHelper.ts",
     "./src/graphManager/protocol/pure/v1/transformation/pureProtocol/V1_DSL_DataSpace_ProtocolHelper.ts",
     "./src/stores/DSL_DataSpace_LegendApplicationPlugin_Extension.ts",
+    "./src/stores/DataSpaceViewerDataAccessState.ts",
     "./src/stores/DataSpaceViewerState.ts",
     "./src/stores/query/DataSpaceAdvancedSearchState.ts",
     "./src/stores/query/DataSpaceInfo.ts",