@finos/legend-extension-dsl-data-space 10.4.252 → 10.4.254

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/V1_DSL_DataSpace_ProtocolHelper.ts

@@ -32,12 +32,15 @@ import {
   V1_PackageableElementPointer,
   V1_rawLambdaModelSchema,
   V1_dataElementReferenceModelSchema,
+  V1_DataProductOperationalMetadata,
 } from '@finos/legend-graph';
 import {
   type PlainObject,
   UnsupportedOperationError,
   usingConstantValueSchema,
   usingModelSchema,
+  optionalCustom,
+  optionalCustomList,
   optionalCustomListWithSchema,
   customListWithSchema,
   isString,
@@ -51,6 +54,10 @@ import {
   V1_DataSpaceMappingProvider,
   V1_DataSpaceSupportEmail,
   V1_DataSpaceSupportCombinedInfo,
+  V1_DataSpaceSupportFullInfo,
+  V1_DataSpaceLink,
+  V1_DataSpaceEmail,
+  V1_DataSpaceExpertise,
   V1_DataSpaceDiagram,
   V1_DataSpaceElementPointer,
   V1_DataSpaceTemplateExecutable,
@@ -61,6 +68,7 @@ import { V1_MappingIncludeDataSpace } from '../../model/packageableElements/mapp
 export const V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE = 'dataSpace';
 const V1_DATA_SPACE_SUPPORT_EMAIL_TYPE = 'email';
 const V1_DATA_SPACE_SUPPORT_COMBINED_INFO_TYPE = 'combined';
+const V1_DATA_SPACE_SUPPORT_FULL_INFO_TYPE = 'full';
 const V1_DATA_SPACE_PACKAGEABLE_ELEMENT_EXECUTABLE =
   'dataSpacePackageableElementExecutable';
 const V1_DATA_SPACE_TEMPLATE_EXECUTABLE = 'dataSpaceTemplateExecutable';
@@ -113,6 +121,38 @@ const V1_dataSpaceSupportCombinedInfoModelSchema = createModelSchema(
   },
 );
 
+const V1_dataSpaceLinkModelSchema = createModelSchema(V1_DataSpaceLink, {
+  label: optional(primitive()),
+  url: primitive(),
+});
+
+const V1_dataSpaceEmailModelSchema = createModelSchema(V1_DataSpaceEmail, {
+  address: primitive(),
+  title: primitive(),
+});
+
+const V1_dataSpaceExpertiseModelSchema = createModelSchema(
+  V1_DataSpaceExpertise,
+  {
+    description: optional(primitive()),
+    expertIds: optional(list(primitive())),
+  },
+);
+
+const V1_dataSpaceSupportFullInfoModelSchema = createModelSchema(
+  V1_DataSpaceSupportFullInfo,
+  {
+    _type: usingConstantValueSchema(V1_DATA_SPACE_SUPPORT_FULL_INFO_TYPE),
+    documentation: optional(usingModelSchema(V1_dataSpaceLinkModelSchema)),
+    documentationUrl: optional(primitive()),
+    emails: optionalCustomListWithSchema(V1_dataSpaceEmailModelSchema),
+    expertise: optionalCustomListWithSchema(V1_dataSpaceExpertiseModelSchema),
+    faqUrl: optional(usingModelSchema(V1_dataSpaceLinkModelSchema)),
+    supportUrl: optional(usingModelSchema(V1_dataSpaceLinkModelSchema)),
+    website: optional(usingModelSchema(V1_dataSpaceLinkModelSchema)),
+  },
+);
+
 const V1_serializeSupportInfo = (
   protocol: V1_DataSpaceSupportInfo | undefined,
 ): PlainObject<V1_DataSpaceSupportInfo> | typeof SKIP => {
@@ -123,6 +163,8 @@ const V1_serializeSupportInfo = (
     return serialize(V1_dataSpaceSupportEmailModelSchema, protocol);
   } else if (protocol instanceof V1_DataSpaceSupportCombinedInfo) {
     return serialize(V1_dataSpaceSupportCombinedInfoModelSchema, protocol);
+  } else if (protocol instanceof V1_DataSpaceSupportFullInfo) {
+    return serialize(V1_dataSpaceSupportFullInfoModelSchema, protocol);
   }
   throw new UnsupportedOperationError(`Can't serialize support info`, protocol);
 };
@@ -138,6 +180,8 @@ export const V1_deserializeSupportInfo = (
       return deserialize(V1_dataSpaceSupportEmailModelSchema, json);
     case V1_DATA_SPACE_SUPPORT_COMBINED_INFO_TYPE:
       return deserialize(V1_dataSpaceSupportCombinedInfoModelSchema, json);
+    case V1_DATA_SPACE_SUPPORT_FULL_INFO_TYPE:
+      return deserialize(V1_dataSpaceSupportFullInfoModelSchema, json);
     default: {
       throw new UnsupportedOperationError(
         `Can't deserialize support info of type '${json._type}'`,
@@ -218,6 +262,20 @@ const V1_dataSpaceDiagramModelSchema = createModelSchema(V1_DataSpaceDiagram, {
   title: primitive(),
 });
 
+const V1_dataSpaceOperationalMetadataModelSchema = createModelSchema(
+  V1_DataProductOperationalMetadata,
+  {
+    coverageRegions: optionalCustomList(
+      (val) => (val as string).toLowerCase(),
+      (val) => (val as unknown as string).toUpperCase(),
+    ),
+    updateFrequency: optionalCustom(
+      (val) => (val as string).toLowerCase(),
+      (val) => (val as string).toUpperCase(),
+    ),
+  },
+);
+
 const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
   _type: usingConstantValueSchema(V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE),
   defaultExecutionContext: optional(primitive()),
@@ -237,6 +295,9 @@ const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
     V1_packageableElementPointerModelSchema,
   ),
   name: primitive(),
+  operationalMetadata: optional(
+    usingModelSchema(V1_dataSpaceOperationalMetadataModelSchema),
+  ),
   package: primitive(),
   stereotypes: customListWithSchema(V1_stereotypePtrModelSchema, {
     INTERNAL__forceReturnEmptyInTest: true,

package/src/stores/DataSpaceLayoutState.ts

@@ -41,6 +41,45 @@ type DataSpacePageNavigationCommand = {
   anchor: string;
 };
 
+export class CollapseState {
+  private readonly collapsedKeys = new Set<string>();
+
+  constructor() {
+    makeObservable<CollapseState, 'collapsedKeys'>(this, {
+      collapsedKeys: observable,
+      toggleSectionCollapse: action,
+      toggleAllSectionsCollapse: action,
+    });
+  }
+
+  isSectionCollapsed(key: string): boolean {
+    return this.collapsedKeys.has(key);
+  }
+
+  toggleSectionCollapse(key: string): void {
+    if (this.collapsedKeys.has(key)) {
+      this.collapsedKeys.delete(key);
+    } else {
+      this.collapsedKeys.add(key);
+    }
+  }
+
+  areAllSectionsCollapsed(keys: string[]): boolean {
+    return keys.length > 0 && keys.every((key) => this.collapsedKeys.has(key));
+  }
+
+  toggleAllSectionsCollapse(keys: string[]): void {
+    const shouldCollapse = !this.areAllSectionsCollapsed(keys);
+    keys.forEach((key) => {
+      if (shouldCollapse) {
+        this.collapsedKeys.add(key);
+      } else {
+        this.collapsedKeys.delete(key);
+      }
+    });
+  }
+}
+
 export class DataSpaceLayoutState {
   readonly dataSpaceViewerState: DataSpaceViewerState;
 
@@ -56,6 +95,8 @@ export class DataSpaceLayoutState {
   private wikiPageVisibleAnchors: string[] = [];
   private wikiPageScrollIntersectionObserver?: IntersectionObserver | undefined;
 
+  readonly sectionCollapseState = new CollapseState();
+
   constructor(dataSpaceViewerState: DataSpaceViewerState) {
     makeObservable<
       DataSpaceLayoutState,

package/src/stores/DataSpaceModelsDocumentationState.ts

@@ -27,7 +27,13 @@ export class DataSpaceViewerModelsDocumentationState
   readonly dataSpaceViewerState: DataSpaceViewerState;
 
   constructor(dataSpaceViewerState: DataSpaceViewerState) {
-    super(dataSpaceViewerState.dataSpaceAnalysisResult.elementDocs);
+    super(
+      dataSpaceViewerState.applicationStore,
+      dataSpaceViewerState.dataSpaceAnalysisResult.elementDocs,
+      {
+        collapseState: dataSpaceViewerState.layoutState.sectionCollapseState,
+      },
+    );
 
     this.dataSpaceViewerState = dataSpaceViewerState;
   }

package/src/stores/DataSpaceViewerDiagramViewerState.ts

@@ -28,8 +28,12 @@ export class DataSpaceViewerDiagramViewerState
 
   constructor(dataSpaceViewerState: DataSpaceViewerState) {
     super(
+      dataSpaceViewerState.applicationStore,
       dataSpaceViewerState.dataSpaceAnalysisResult.diagrams,
-      dataSpaceViewerState.queryClass,
+      {
+        queryClass: dataSpaceViewerState.queryClass,
+        collapseState: dataSpaceViewerState.layoutState.sectionCollapseState,
+      },
     );
     this.dataSpaceViewerState = dataSpaceViewerState;
   }

package/src/stores/DataSpaceViewerExecutableState.ts

@@ -32,6 +32,7 @@ import {
 import type { DataSpaceViewerState } from './DataSpaceViewerState.js';
 import { action, flow, makeObservable, observable } from 'mobx';
 import {
+  extractAnnotatedElementDocumentation,
   RelationType,
   TDSExecutionResult,
   type ExecutionResultWithMetadata,
@@ -212,6 +213,7 @@ export class DataSpaceExecutableRelationResultState {
       id: uuid(),
       name: col.name,
       type: col.genericType.value.rawType.name,
+      documentation: extractAnnotatedElementDocumentation(col),
     }));
   }
 }

package/src/stores/query-builder/DataSpaceQueryBuilderState.ts

@@ -23,6 +23,8 @@ import {
   type QueryBuilderExtraFunctionAnalysisInfo,
   QUERY_BUILDER_LAMBDA_WRITER_MODE,
   type ExtraOptionsConfig,
+  QueryBuilderEmbeddedFromExecutionContextState,
+  type QueryBuilderExecutionContextState,
 } from '@finos/legend-query-builder';
 import {
   type Class,
@@ -69,6 +71,7 @@ import type {
 } from '@finos/legend-storage';
 import { buildDataSpaceExecutableAnalysisResultFromExecutable } from '../../graph-manager/action/analytics/DataSpaceAnalysisHelper.js';
 import { compareLabelFn } from '@finos/legend-art';
+import { resolveExecutionContextMapping } from '../../graph-manager/DSL_DataSpace_GraphManagerHelper.js';
 
 const matchesDataElement = (
   _class: Class,
@@ -367,6 +370,23 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
     return this.buildQueryLambdaWithoutExecutionContext();
   }
 
+  override setExecutionContextState(
+    val: QueryBuilderExecutionContextState,
+  ): void {
+    if (
+      val instanceof QueryBuilderEmbeddedFromExecutionContextState &&
+      val.mapping === undefined
+    ) {
+      const resolvedMapping = resolveExecutionContextMapping(
+        this.executionContext,
+      );
+      if (resolvedMapping) {
+        val.setMapping(resolvedMapping);
+      }
+    }
+    super.setExecutionContextState(val);
+  }
+
   override buildExecutionContextExpression(
     lambdaFunction: LambdaFunction,
   ): LambdaFunction {