@finos/legend-extension-dsl-data-space 9.2.3 → 9.2.5

package/src/components/DataSpaceQuickStart.tsx

@@ -19,27 +19,30 @@ import {
   AnchorLinkIcon,
   CodeIcon,
   CopyIcon,
+  LegendLogo,
   MoreVerticalIcon,
-  QueryIcon,
   QuestionCircleIcon,
   clsx,
 } from '@finos/legend-art';
 import { type DataSpaceViewerState } from '../stores/DataSpaceViewerState.js';
-import { AgGridReact } from '@ag-grid-community/react';
-import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
 import {
-  EDITOR_LANGUAGE,
-  TextInputEditor,
+  CODE_EDITOR_LANGUAGE,
   useApplicationStore,
 } from '@finos/legend-application';
 import {
   DataSpaceExecutableTDSResult,
   type DataSpaceExecutableAnalysisResult,
+  type DataSpaceExecutableTDSResultColumn,
 } from '../graphManager/action/analytics/DataSpaceAnalysis.js';
 import { DataSpaceMarkdownTextViewer } from './DataSpaceMarkdownTextViewer.js';
 import type { DSL_DataSpace_LegendApplicationPlugin_Extension } from '../stores/DSL_DataSpace_LegendApplicationPlugin_Extension.js';
 import { useState } from 'react';
 import { DataSpaceWikiPlaceholder } from './DataSpacePlaceholder.js';
+import {
+  DataGrid,
+  type DataGridCellRendererParams,
+} from '@finos/legend-lego/data-grid';
+import { CodeEditor } from '@finos/legend-lego/code-editor';
 
 enum TDS_EXECUTABLE_ACTION_TAB {
   COLUMN_SPECS = 'COLUMN_SPECS',
@@ -47,6 +50,40 @@ enum TDS_EXECUTABLE_ACTION_TAB {
   QUERY_TEXT = 'QUERY_TEXT',
 }
 
+const MIN_NUMBER_OF_ROWS_FOR_AUTO_HEIGHT = 15;
+
+const TDSColumnDocumentationCellRenderer = (
+  params: DataGridCellRendererParams<DataSpaceExecutableTDSResultColumn>,
+): React.ReactNode => {
+  const data = params.data;
+  if (!data) {
+    return null;
+  }
+  return data.documentation?.trim() ? (
+    data.documentation
+  ) : (
+    <div className="data-space__viewer__grid__empty-cell">
+      No documentation provided
+    </div>
+  );
+};
+
+const TDSColumnSampleValuesCellRenderer = (
+  params: DataGridCellRendererParams<DataSpaceExecutableTDSResultColumn>,
+): React.ReactNode => {
+  const data = params.data;
+  if (!data) {
+    return null;
+  }
+  return data.sampleValues?.trim() ? (
+    data.sampleValues
+  ) : (
+    <div className="data-space__viewer__grid__empty-cell">
+      No sample values provided
+    </div>
+  );
+};
+
 const DataSpaceExecutableTDSResultView = observer(
   (props: {
     dataSpaceViewerState: DataSpaceViewerState;
@@ -61,6 +98,8 @@ const DataSpaceExecutableTDSResultView = observer(
     const queryText = executableAnalysisResult.info?.query;
 
     const columnSpecifications = tdsResult.columns;
+    const autoHeight =
+      tdsResult.columns.length <= MIN_NUMBER_OF_ROWS_FOR_AUTO_HEIGHT;
     const extractTDSExecutableActionConfigurations =
       applicationStore.pluginManager
         .getApplicationPlugins()
@@ -127,7 +166,7 @@ const DataSpaceExecutableTDSResultView = observer(
                 onClick={() => setSelectedTab(TDS_EXECUTABLE_ACTION_TAB.QUERY)}
               >
                 <div className="data-space__viewer__quickstart__item__content__tab__icon">
-                  <QueryIcon className="data-space__viewer__quickstart__item__content__tab__icon--query" />
+                  <LegendLogo className="data-space__viewer__quickstart__item__content__tab__icon--query" />
                 </div>
                 <div className="data-space__viewer__quickstart__item__content__tab__label">
                   Query
@@ -177,16 +216,24 @@ const DataSpaceExecutableTDSResultView = observer(
               </button>
             )}
           </div>
-          <div className="data-space__viewer__quickstart__item__content__tab__content">
+          <div
+            className={clsx(
+              'data-space__viewer__quickstart__item__content__tab__content',
+              {
+                'data-space__viewer__quickstart__item__content__tab__content':
+                  autoHeight,
+              },
+            )}
+          >
             {selectedTab === TDS_EXECUTABLE_ACTION_TAB.COLUMN_SPECS && (
               <div className="data-space__viewer__quickstart__tds__column-specs data-space__viewer__grid ag-theme-balham-dark">
-                <AgGridReact
+                <DataGrid
+                  domLayout={autoHeight ? 'autoHeight' : 'normal'}
                   rowData={columnSpecifications}
                   gridOptions={{
                     suppressScrollOnNewData: true,
                     getRowId: (rowData) => rowData.data.uuid,
                   }}
-                  modules={[ClientSideRowModelModule]}
                   suppressFieldDotNotation={true}
                   columnDefs={[
                     {
@@ -194,14 +241,19 @@ const DataSpaceExecutableTDSResultView = observer(
                       sortable: true,
                       resizable: true,
                       field: 'name',
-                      headerName: `Column (${columnSpecifications.length})`,
+                      headerValueGetter: () =>
+                        `Column ${
+                          columnSpecifications.length
+                            ? ` (${columnSpecifications.length})`
+                            : ''
+                        }`,
                       flex: 1,
                     },
                     {
                       minWidth: 50,
                       sortable: false,
                       resizable: true,
-                      field: 'documentation',
+                      cellRenderer: TDSColumnDocumentationCellRenderer,
                       headerName: 'Documentation',
                       flex: 1,
                       wrapText: true,
@@ -210,8 +262,10 @@ const DataSpaceExecutableTDSResultView = observer(
                     {
                       minWidth: 50,
                       sortable: false,
-                      resizable: true,
-                      field: 'sample_values',
+                      resizable: false,
+                      headerClass:
+                        'data-space__viewer__grid__last-column-header',
+                      cellRenderer: TDSColumnSampleValuesCellRenderer,
                       headerName: 'Sample Values',
                       flex: 1,
                     },
@@ -245,10 +299,10 @@ const DataSpaceExecutableTDSResultView = observer(
               queryText !== undefined && (
                 <div className="data-space__viewer__quickstart__tds__query-text">
                   <div className="data-space__viewer__quickstart__tds__query-text__content">
-                    <TextInputEditor
+                    <CodeEditor
                       inputValue={queryText}
                       isReadOnly={true}
-                      language={EDITOR_LANGUAGE.PURE}
+                      language={CODE_EDITOR_LANGUAGE.PURE}
                       showMiniMap={false}
                       hideGutter={true}
                     />

package/src/components/DataSpaceViewer.tsx

@@ -49,12 +49,10 @@ const DataSpaceHeader = observer(
         >
           <div
             className="data-space__viewer__header__title"
-            title={`${analysisResult.title ?? analysisResult.name} - ${
-              analysisResult.path
-            }`}
+            title={`${analysisResult.displayName} - ${analysisResult.path}`}
           >
             <div className="data-space__viewer__header__title__label">
-              {analysisResult.title ?? analysisResult.name}
+              {analysisResult.displayName}
             </div>
             {dataSpaceViewerState.isVerified && (
               <VerifiedIcon

package/src/components/DataSpaceWiki.tsx

@@ -26,8 +26,6 @@ export const DataSpaceWiki = observer(
   (props: { dataSpaceViewerState: DataSpaceViewerState }) => {
     const { dataSpaceViewerState } = props;
 
-    // const a = new IntersectionObserver(() => {});
-
     return (
       <div className="data-space__viewer__wiki">
         <DataSpaceDescription dataSpaceViewerState={dataSpaceViewerState} />

package/src/graphManager/action/analytics/DataSpaceAnalysis.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import type {
-  Mapping,
-  PackageableRuntime,
-  PureModel,
+import {
+  type Multiplicity,
+  type Mapping,
+  type PackageableRuntime,
+  type PureModel,
 } from '@finos/legend-graph';
-import { uuid } from '@finos/legend-shared';
+import { prettyCONSTName, uuid } from '@finos/legend-shared';
 import type { DataSpaceSupportInfo } from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
 import type { Diagram } from '@finos/legend-extension-dsl-diagram';
 
@@ -47,27 +48,74 @@ export class DataSpaceStereotypeInfo {
   value!: string;
 }
 
-export class DataSpaceDocumentationEntry {
+export class NormalizedDataSpaceDocumentationEntry {
   readonly uuid = uuid();
-  readonly elementPath: string;
-  readonly subElementText?: string | undefined;
-  readonly doc: string;
-  readonly milestoning?: string | undefined;
+  readonly text: string;
+  readonly documentation: string;
+  readonly elementEntry: DataSpaceModelDocumentationEntry;
+  readonly entry: DataSpaceBasicDocumentationEntry;
 
   constructor(
-    elementPath: string,
-    subElementText: string | undefined,
+    text: string,
     documentation: string,
-    milestoning: string | undefined,
+    elementEntry: DataSpaceModelDocumentationEntry,
+    entry: DataSpaceBasicDocumentationEntry,
   ) {
-    this.elementPath = elementPath;
-    this.subElementText = subElementText;
-    this.doc = documentation;
-    this.milestoning = milestoning;
+    this.text = text;
+    this.documentation = documentation;
+    this.elementEntry = elementEntry;
+    this.entry = entry;
   }
+
+  get humanizedText(): string {
+    return prettyCONSTName(this.text);
+  }
+}
+
+export class DataSpaceBasicDocumentationEntry {
+  name!: string;
+  docs: string[] = [];
+
+  get humanizedName(): string {
+    return prettyCONSTName(this.name);
+  }
+}
+
+export class DataSpacePropertyDocumentationEntry extends DataSpaceBasicDocumentationEntry {
+  milestoning?: string | undefined;
+  /**
+   * Make this optional for backward compatibility
+   *
+   * @backwardCompatibility
+   */
+  type?: string | undefined;
+  /**
+   * Make this optional for backward compatibility
+   *
+   * @backwardCompatibility
+   */
+  multiplicity?: Multiplicity | undefined;
+}
+
+export class DataSpaceModelDocumentationEntry extends DataSpaceBasicDocumentationEntry {
+  path!: string;
+}
+
+export class DataSpaceClassDocumentationEntry extends DataSpaceModelDocumentationEntry {
+  properties: DataSpacePropertyDocumentationEntry[] = [];
+  milestoning?: string | undefined;
+}
+
+export class DataSpaceEnumerationDocumentationEntry extends DataSpaceModelDocumentationEntry {
+  enumValues: DataSpaceBasicDocumentationEntry[] = [];
+}
+
+export class DataSpaceAssociationDocumentationEntry extends DataSpaceModelDocumentationEntry {
+  properties: DataSpacePropertyDocumentationEntry[] = [];
 }
 
 export class DataSpaceDiagramAnalysisResult {
+  readonly uuid = uuid();
   title!: string;
   description?: string | undefined;
   diagram!: Diagram;
@@ -95,7 +143,7 @@ export class DataSpaceExecutableTDSResultColumn {
 
   // TODO: we need to think of how we want to support sample values, should we rely on the type here
   // or should we rely on actual execution result on test data?
-  sampleValues = '';
+  sampleValues?: string | undefined;
 }
 
 export class DataSpaceExecutableTDSResult extends DataSpaceExecutableResult {
@@ -128,11 +176,15 @@ export class DataSpaceAnalysisResult {
   executionContextsIndex!: Map<string, DataSpaceExecutionContextAnalysisResult>;
   defaultExecutionContext!: DataSpaceExecutionContextAnalysisResult;
 
-  elementDocs: DataSpaceDocumentationEntry[] = [];
+  elementDocs: NormalizedDataSpaceDocumentationEntry[] = [];
 
   diagrams: DataSpaceDiagramAnalysisResult[] = [];
 
   executables: DataSpaceExecutableAnalysisResult[] = [];
 
   supportInfo?: DataSpaceSupportInfo | undefined;
+
+  get displayName(): string {
+    return this.title ?? prettyCONSTName(this.name);
+  }
 }

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

@@ -52,7 +52,7 @@ import {
 import {
   DataSpaceAnalysisResult,
   DataSpaceDiagramAnalysisResult,
-  DataSpaceDocumentationEntry,
+  NormalizedDataSpaceDocumentationEntry,
   DataSpaceExecutableAnalysisResult,
   DataSpaceExecutableTDSResultColumn,
   DataSpaceExecutableTDSResult,
@@ -60,6 +60,11 @@ import {
   DataSpaceServiceExecutableInfo,
   DataSpaceStereotypeInfo,
   DataSpaceTaggedValueInfo,
+  DataSpaceClassDocumentationEntry,
+  DataSpacePropertyDocumentationEntry,
+  DataSpaceEnumerationDocumentationEntry,
+  DataSpaceBasicDocumentationEntry,
+  DataSpaceAssociationDocumentationEntry,
 } from '../../../action/analytics/DataSpaceAnalysis.js';
 import { DSL_DataSpace_PureGraphManagerExtension } from '../DSL_DataSpace_PureGraphManagerExtension.js';
 import {
@@ -73,6 +78,7 @@ import {
 import { getDiagram } from '@finos/legend-extension-dsl-diagram';
 
 const ANALYZE_DATA_SPACE_TRACE = 'analyze data space';
+const TEMPORARY__TDS_SAMPLE_VALUES__DELIMETER = '-- e.g.';
 
 export class V1_DSL_DataSpace_PureGraphManagerExtension extends DSL_DataSpace_PureGraphManagerExtension {
   declare graphManager: V1_PureGraphManager;
@@ -315,66 +321,107 @@ export class V1_DSL_DataSpace_PureGraphManagerExtension extends DSL_DataSpace_Pu
 
     // elements documentation
     result.elementDocs = analysisResult.elementDocs.flatMap((docEntry) => {
-      const entries: DataSpaceDocumentationEntry[] = [];
+      const entries: NormalizedDataSpaceDocumentationEntry[] = [];
       if (docEntry instanceof V1_DataSpaceClassDocumentationEntry) {
+        const classData = new DataSpaceClassDocumentationEntry();
+        classData.name = docEntry.name;
+        classData.docs = docEntry.docs;
+        classData.path = docEntry.path;
+        classData.milestoning = docEntry.milestoning;
         entries.push(
-          new DataSpaceDocumentationEntry(
-            docEntry.path,
-            undefined,
-            docEntry.docs.join('\n'),
-            docEntry.milestoning,
+          new NormalizedDataSpaceDocumentationEntry(
+            docEntry.name,
+            docEntry.docs.join('\n').trim(),
+            classData,
+            classData,
           ),
         );
+
         docEntry.properties.forEach((property) => {
+          const propertyData = new DataSpacePropertyDocumentationEntry();
+          propertyData.name = property.name;
+          propertyData.docs = property.docs;
+          propertyData.type = property.type;
+          propertyData.milestoning = property.milestoning;
+          propertyData.multiplicity = property.multiplicity
+            ? graph.getMultiplicity(
+                property.multiplicity.lowerBound,
+                property.multiplicity.upperBound,
+              )
+            : undefined;
+          classData.properties.push(propertyData);
           entries.push(
-            new DataSpaceDocumentationEntry(
-              docEntry.path,
+            new NormalizedDataSpaceDocumentationEntry(
               property.name,
-              property.docs.join('\n'),
-              property.milestoning,
+              property.docs.join('\n').trim(),
+              classData,
+              propertyData,
             ),
           );
         });
-        // NOTE: we don't want to list inherited properties
       } else if (
         docEntry instanceof V1_DataSpaceEnumerationDocumentationEntry
       ) {
+        const enumerationData = new DataSpaceEnumerationDocumentationEntry();
+        enumerationData.name = docEntry.name;
+        enumerationData.docs = docEntry.docs;
+        enumerationData.path = docEntry.path;
         entries.push(
-          new DataSpaceDocumentationEntry(
-            docEntry.path,
-            undefined,
-            docEntry.docs.join('\n'),
-            undefined,
+          new NormalizedDataSpaceDocumentationEntry(
+            docEntry.name,
+            docEntry.docs.join('\n').trim(),
+            enumerationData,
+            enumerationData,
           ),
         );
         docEntry.enumValues.forEach((enumValue) => {
+          const enumData = new DataSpaceBasicDocumentationEntry();
+          enumData.name = enumValue.name;
+          enumData.docs = enumValue.docs;
+          enumerationData.enumValues.push(enumData);
           entries.push(
-            new DataSpaceDocumentationEntry(
-              docEntry.path,
+            new NormalizedDataSpaceDocumentationEntry(
               enumValue.name,
-              enumValue.docs.join('\n'),
-              undefined,
+              enumValue.docs.join('\n').trim(),
+              enumerationData,
+              enumData,
             ),
           );
         });
       } else if (
         docEntry instanceof V1_DataSpaceAssociationDocumentationEntry
       ) {
+        const associationData = new DataSpaceAssociationDocumentationEntry();
+        associationData.name = docEntry.name;
+        associationData.docs = docEntry.docs;
+        associationData.path = docEntry.path;
         entries.push(
-          new DataSpaceDocumentationEntry(
-            docEntry.path,
-            undefined,
-            docEntry.docs.join('\n'),
-            undefined,
+          new NormalizedDataSpaceDocumentationEntry(
+            docEntry.name,
+            docEntry.docs.join('\n').trim(),
+            associationData,
+            associationData,
           ),
         );
         docEntry.properties.forEach((property) => {
+          const propertyData = new DataSpacePropertyDocumentationEntry();
+          propertyData.name = property.name;
+          propertyData.docs = property.docs;
+          propertyData.type = property.type;
+          propertyData.milestoning = property.milestoning;
+          propertyData.multiplicity = property.multiplicity
+            ? graph.getMultiplicity(
+                property.multiplicity.lowerBound,
+                property.multiplicity.upperBound,
+              )
+            : undefined;
+          associationData.properties.push(propertyData);
           entries.push(
-            new DataSpaceDocumentationEntry(
-              docEntry.path,
+            new NormalizedDataSpaceDocumentationEntry(
               property.name,
               property.docs.join('\n'),
-              property.milestoning,
+              associationData,
+              propertyData,
             ),
           );
         });
@@ -419,6 +466,27 @@ export class V1_DSL_DataSpace_PureGraphManagerExtension extends DSL_DataSpace_Pu
               column.type = tdsColumn.type;
               column.relationalType = tdsColumn.relationalType;
               column.documentation = tdsColumn.documentation;
+              if (
+                tdsColumn.documentation?.includes(
+                  TEMPORARY__TDS_SAMPLE_VALUES__DELIMETER,
+                )
+              ) {
+                column.documentation = tdsColumn.documentation
+                  .substring(
+                    0,
+                    tdsColumn.documentation.indexOf(
+                      TEMPORARY__TDS_SAMPLE_VALUES__DELIMETER,
+                    ),
+                  )
+                  .trim();
+                column.sampleValues = tdsColumn.documentation
+                  .substring(
+                    tdsColumn.documentation.indexOf(
+                      TEMPORARY__TDS_SAMPLE_VALUES__DELIMETER,
+                    ) + TEMPORARY__TDS_SAMPLE_VALUES__DELIMETER.length,
+                  )
+                  .trim();
+              }
               return column;
             },
           );

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

@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-import { V1_PureModelContextData } from '@finos/legend-graph';
+import {
+  type V1_Multiplicity,
+  V1_PureModelContextData,
+  V1_multiplicityModelSchema,
+} from '@finos/legend-graph';
 import {
   SerializationFactory,
   optionalCustom,
@@ -24,6 +28,7 @@ import {
   usingConstantValueSchema,
   isString,
   isNonNullable,
+  optionalCustomUsingModelSchema,
 } from '@finos/legend-shared';
 import {
   createModelSchema,
@@ -97,13 +102,27 @@ export class V1_DataSpaceBasicDocumentationEntry {
 }
 
 export class V1_DataSpacePropertyDocumentationEntry extends V1_DataSpaceBasicDocumentationEntry {
-  milestoning?: string;
+  milestoning?: string | undefined;
+  /**
+   * Make this optional for backward compatibility
+   *
+   * @backwardCompatibility
+   */
+  type?: string | undefined;
+  /**
+   * Make this optional for backward compatibility
+   *
+   * @backwardCompatibility
+   */
+  multiplicity?: V1_Multiplicity | undefined;
 
   static override readonly serialization = new SerializationFactory(
     createModelSchema(V1_DataSpacePropertyDocumentationEntry, {
       docs: list(primitive()),
       milestoning: optional(primitive()),
+      multiplicity: optionalCustomUsingModelSchema(V1_multiplicityModelSchema),
       name: primitive(),
+      type: optional(primitive()),
     }),
   );
 }
@@ -122,7 +141,7 @@ export class V1_DataSpaceModelDocumentationEntry extends V1_DataSpaceBasicDocume
 
 export class V1_DataSpaceClassDocumentationEntry extends V1_DataSpaceModelDocumentationEntry {
   properties: V1_DataSpacePropertyDocumentationEntry[] = [];
-  milestoning?: string;
+  milestoning?: string | undefined;
 
   static override readonly serialization = new SerializationFactory(
     createModelSchema(V1_DataSpaceClassDocumentationEntry, {