@finos/legend-extension-dsl-data-space 9.1.6 → 9.2.0

package/src/graphManager/protocol/pure/v1/V1_DSL_DataSpace_PureGraphManagerExtension.ts

@@ -135,7 +135,7 @@ export class V1_DSL_DataSpace_PureGraphManagerExtension extends DSL_DataSpace_Pu
       );
     }
     return this.buildDataSpaceAnalytics(
-      V1_DataSpaceAnalysisResult.serialization.fromJson(analysisResult),
+      V1_DataSpaceAnalysisResult.deserialize(analysisResult),
     );
   }
 
@@ -362,23 +362,14 @@ export class V1_DSL_DataSpace_PureGraphManagerExtension extends DSL_DataSpace_Pu
       return entries;
     });
 
-    // featured diagrams
-    result.diagrams = analysisResult.featuredDiagrams
-      .map((path) => {
-        const diagram = new DataSpaceDiagramAnalysisResult();
-        diagram.title = path;
-        diagram.diagram = getDiagram(path, graph);
-        return diagram;
-      })
-      .concat(
-        analysisResult.diagrams.map((diagramProtocol) => {
-          const diagram = new DataSpaceDiagramAnalysisResult();
-          diagram.title = diagramProtocol.title;
-          diagram.description = diagramProtocol.description;
-          diagram.diagram = getDiagram(diagramProtocol.diagram, graph);
-          return diagram;
-        }),
-      );
+    // diagrams
+    result.diagrams = analysisResult.diagrams.map((diagramProtocol) => {
+      const diagram = new DataSpaceDiagramAnalysisResult();
+      diagram.title = diagramProtocol.title;
+      diagram.description = diagramProtocol.description;
+      diagram.diagram = getDiagram(diagramProtocol.diagram, graph);
+      return diagram;
+    });
 
     // executables
     result.executables = analysisResult.executables.map(

package/src/graphManager/protocol/pure/v1/engine/analytics/V1_DataSpaceAnalysis.ts

@@ -22,6 +22,8 @@ import {
   UnsupportedOperationError,
   customListWithSchema,
   usingConstantValueSchema,
+  isString,
+  isNonNullable,
 } from '@finos/legend-shared';
 import {
   createModelSchema,
@@ -317,15 +319,13 @@ export class V1_DataSpaceAnalysisResult {
   executionContexts: V1_DataSpaceExecutionContextAnalysisResult[] = [];
   defaultExecutionContext!: string;
 
-  featuredDiagrams: string[] = [];
-
   elements: string[] = [];
   elementDocs: V1_DataSpaceModelDocumentationEntry[] = [];
 
   executables: V1_DataSpaceExecutableAnalysisResult[] = [];
   diagrams: V1_DataSpaceDiagramAnalysisResult[] = [];
 
-  static readonly serialization = new SerializationFactory(
+  private static readonly serialization = new SerializationFactory(
     createModelSchema(V1_DataSpaceAnalysisResult, {
       name: primitive(),
       package: primitive(),
@@ -363,4 +363,35 @@ export class V1_DataSpaceAnalysisResult {
       ),
     }),
   );
+
+  static deserialize(
+    json: PlainObject<V1_DataSpaceAnalysisResult>,
+  ): V1_DataSpaceAnalysisResult {
+    const result = deserialize(
+      V1_DataSpaceAnalysisResult.serialization.schema,
+      json,
+    );
+    /**
+     * Featured diagrams will be transformed to diagrams, so here we nicely
+     * auto-transform it for backward compatibility
+     *
+     * @backwardCompatibility
+     */
+    if (json.featuredDiagrams && Array.isArray(json.featuredDiagrams)) {
+      const diagramResults = json.featuredDiagrams
+        .map((featuredDiagram) => {
+          if (isString(featuredDiagram)) {
+            const diagramAnalysisResult =
+              new V1_DataSpaceDiagramAnalysisResult();
+            diagramAnalysisResult.title = '';
+            diagramAnalysisResult.diagram = featuredDiagram;
+            return diagramAnalysisResult;
+          }
+          return undefined;
+        })
+        .filter(isNonNullable);
+      result.diagrams = result.diagrams.concat(diagramResults);
+    }
+    return result;
+  }
 }

package/src/graphManager/protocol/pure/v1/model/packageableElements/dataSpace/V1_DSL_DataSpace_DataSpace.ts

@@ -24,48 +24,6 @@ import {
   type V1_TaggedValue,
 } from '@finos/legend-graph';
 
-export abstract class V1_DataSpaceSupportInfo implements Hashable {
-  documentationUrl?: string | undefined;
-
-  abstract get hashCode(): string;
-}
-
-export class V1_DataSpaceSupportEmail
-  extends V1_DataSpaceSupportInfo
-  implements Hashable
-{
-  address!: string;
-
-  get hashCode(): string {
-    return hashArray([
-      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_SUPPORT_EMAIL,
-      this.documentationUrl ?? '',
-      this.address,
-    ]);
-  }
-}
-
-export class V1_DataSpaceSupportCombinedInfo
-  extends V1_DataSpaceSupportInfo
-  implements Hashable
-{
-  emails?: string[] | undefined;
-  website?: string | undefined;
-  faqUrl?: string | undefined;
-  supportUrl?: string | undefined;
-
-  get hashCode(): string {
-    return hashArray([
-      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_SUPPORT_COMBINED_INFO,
-      this.documentationUrl ?? '',
-      hashArray(this.emails ?? []),
-      this.website ?? '',
-      this.faqUrl ?? '',
-      this.supportUrl ?? '',
-    ]);
-  }
-}
-
 export class V1_DataSpaceExecutionContext implements Hashable {
   name!: string;
   title?: string | undefined;
@@ -85,6 +43,19 @@ export class V1_DataSpaceExecutionContext implements Hashable {
   }
 }
 
+export class V1_DataSpaceElementPointer implements Hashable {
+  path!: string;
+  exclude?: boolean | undefined;
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_ELEMENT_POINTER,
+      this.path,
+      this.exclude ?? '',
+    ]);
+  }
+}
+
 export class V1_DataSpaceExecutable implements Hashable {
   title!: string;
   description?: string | undefined;
@@ -115,6 +86,48 @@ export class V1_DataSpaceDiagram implements Hashable {
   }
 }
 
+export abstract class V1_DataSpaceSupportInfo implements Hashable {
+  documentationUrl?: string | undefined;
+
+  abstract get hashCode(): string;
+}
+
+export class V1_DataSpaceSupportEmail
+  extends V1_DataSpaceSupportInfo
+  implements Hashable
+{
+  address!: string;
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_SUPPORT_EMAIL,
+      this.documentationUrl ?? '',
+      this.address,
+    ]);
+  }
+}
+
+export class V1_DataSpaceSupportCombinedInfo
+  extends V1_DataSpaceSupportInfo
+  implements Hashable
+{
+  emails?: string[] | undefined;
+  website?: string | undefined;
+  faqUrl?: string | undefined;
+  supportUrl?: string | undefined;
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_SUPPORT_COMBINED_INFO,
+      this.documentationUrl ?? '',
+      hashArray(this.emails ?? []),
+      this.website ?? '',
+      this.faqUrl ?? '',
+      this.supportUrl ?? '',
+    ]);
+  }
+}
+
 export class V1_DataSpace extends V1_PackageableElement implements Hashable {
   stereotypes: V1_StereotypePtr[] = [];
   taggedValues: V1_TaggedValue[] = [];
@@ -122,8 +135,7 @@ export class V1_DataSpace extends V1_PackageableElement implements Hashable {
   description?: string | undefined;
   executionContexts!: V1_DataSpaceExecutionContext[];
   defaultExecutionContext!: string;
-  featuredDiagrams?: V1_PackageableElementPointer[] | undefined;
-  elements?: V1_PackageableElementPointer[] | undefined;
+  elements?: V1_DataSpaceElementPointer[] | undefined;
   executables?: V1_DataSpaceExecutable[] | undefined;
   diagrams?: V1_DataSpaceDiagram[] | undefined;
   supportInfo?: V1_DataSpaceSupportInfo | undefined;
@@ -137,8 +149,7 @@ export class V1_DataSpace extends V1_PackageableElement implements Hashable {
       this.description ?? '',
       hashArray(this.executionContexts),
       this.defaultExecutionContext,
-      hashArray((this.featuredDiagrams ?? []).map((pointer) => pointer.path)),
-      hashArray((this.elements ?? []).map((pointer) => pointer.path)),
+      hashArray(this.elements ?? []),
       hashArray(this.executables ?? []),
       hashArray(this.diagrams ?? []),
       this.supportInfo ?? '',

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/V1_DSL_DataSpace_ProtocolHelper.ts

@@ -28,7 +28,8 @@ import {
 import {
   V1_stereotypePtrSchema,
   V1_taggedValueSchema,
-  V1_packageableElementPointerDeserializerSchema,
+  V1_packageableElementPointerModelSchema,
+  V1_PackageableElementPointer,
 } from '@finos/legend-graph';
 import {
   type PlainObject,
@@ -37,6 +38,8 @@ import {
   usingModelSchema,
   optionalCustomListWithSchema,
   customListWithSchema,
+  isString,
+  isNonNullable,
 } from '@finos/legend-shared';
 import {
   type V1_DataSpaceSupportInfo,
@@ -46,6 +49,7 @@ import {
   V1_DataSpaceSupportCombinedInfo,
   V1_DataSpaceExecutable,
   V1_DataSpaceDiagram,
+  V1_DataSpaceElementPointer,
 } from '../../model/packageableElements/dataSpace/V1_DSL_DataSpace_DataSpace.js';
 
 export const V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE = 'dataSpace';
@@ -55,11 +59,9 @@ const V1_DATA_SPACE_SUPPORT_COMBINED_INFO_TYPE = 'combined';
 const V1_dataSpaceExecutionContextModelSchema = createModelSchema(
   V1_DataSpaceExecutionContext,
   {
-    defaultRuntime: usingModelSchema(
-      V1_packageableElementPointerDeserializerSchema,
-    ),
+    defaultRuntime: usingModelSchema(V1_packageableElementPointerModelSchema),
     description: optional(primitive()),
-    mapping: usingModelSchema(V1_packageableElementPointerDeserializerSchema),
+    mapping: usingModelSchema(V1_packageableElementPointerModelSchema),
     name: primitive(),
     title: optional(primitive()),
   },
@@ -119,35 +121,39 @@ export const V1_deserializeSupportInfo = (
   }
 };
 
+const V1_dataSpaceElementPointerModelSchema = createModelSchema(
+  V1_DataSpaceElementPointer,
+  {
+    exclude: optional(primitive()),
+    path: primitive(),
+  },
+);
+
 const V1_dataSpaceExecutableModelSchema = createModelSchema(
   V1_DataSpaceExecutable,
   {
     description: optional(primitive()),
-    executable: usingModelSchema(
-      V1_packageableElementPointerDeserializerSchema,
-    ),
+    executable: usingModelSchema(V1_packageableElementPointerModelSchema),
     title: primitive(),
   },
 );
 
 const V1_dataSpaceDiagramModelSchema = createModelSchema(V1_DataSpaceDiagram, {
   description: optional(primitive()),
-  diagram: usingModelSchema(V1_packageableElementPointerDeserializerSchema),
+  diagram: usingModelSchema(V1_packageableElementPointerModelSchema),
   title: primitive(),
 });
 
-export const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
+const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
   _type: usingConstantValueSchema(V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE),
   defaultExecutionContext: primitive(),
   description: optional(primitive()),
   diagrams: list(object(V1_dataSpaceDiagramModelSchema)),
-  elements: optionalCustomListWithSchema(
-    V1_packageableElementPointerDeserializerSchema,
-  ),
+  elements: optionalCustomListWithSchema(V1_dataSpaceElementPointerModelSchema),
   executables: list(object(V1_dataSpaceExecutableModelSchema)),
   executionContexts: list(object(V1_dataSpaceExecutionContextModelSchema)),
   featuredDiagrams: optionalCustomListWithSchema(
-    V1_packageableElementPointerDeserializerSchema,
+    V1_packageableElementPointerModelSchema,
   ),
   name: primitive(),
   package: primitive(),
@@ -163,3 +169,42 @@ export const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
   }),
   title: optional(primitive()),
 });
+
+export const V1_serializeDataSpace = (
+  protocol: V1_DataSpace,
+): PlainObject<V1_DataSpace> => serialize(V1_dataSpaceModelSchema, protocol);
+
+export const V1_deserializeDataSpace = (
+  json: PlainObject<V1_DataSpace>,
+): V1_DataSpace => {
+  const dataSpace = deserialize(V1_dataSpaceModelSchema, json);
+  /**
+   * Featured diagrams will be transformed to diagrams, so here we nicely
+   * auto-transform it for backward compatibility
+   *
+   * @backwardCompatibility
+   */
+  if (json.featuredDiagrams && Array.isArray(json.featuredDiagrams)) {
+    const diagrams = json.featuredDiagrams
+      .map((featuredDiagram) => {
+        if (isString(featuredDiagram.path)) {
+          const diagram = new V1_DataSpaceDiagram();
+          diagram.title = '';
+          diagram.diagram = new V1_PackageableElementPointer(
+            undefined,
+            featuredDiagram.path,
+          );
+          return diagram;
+        }
+        return undefined;
+      })
+      .filter(isNonNullable);
+    if (diagrams.length) {
+      dataSpace.diagrams =
+        dataSpace.diagrams !== undefined
+          ? dataSpace.diagrams.concat(diagrams)
+          : diagrams;
+    }
+  }
+  return dataSpace;
+};

package/src/stores/DataSpaceViewerState.ts

@@ -49,6 +49,7 @@ export enum DATA_SPACE_VIEWER_ACTIVITY_MODE {
 
   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)