@finos/legend-extension-dsl-data-space 9.0.47 → 9.1.0

package/src/components/query/DSL_DataSpace_LegendQueryApplicationPlugin.tsx

@@ -21,8 +21,8 @@ import {
   type ExistingQueryEditorStore,
   LegendQueryApplicationPlugin,
   generateExistingQueryEditorRoute,
-  LegendQueryEventService,
   LEGEND_QUERY_APP_EVENT,
+  LegendQueryEventHelper,
   createViewProjectHandler,
   createViewSDLCProjectHandler,
 } from '@finos/legend-application-query';
@@ -35,7 +35,7 @@ import {
 import {
   DATA_SPACE_QUERY_ROUTE_PATTERN,
   generateDataSpaceQuerySetupRoute,
-} from '../../stores/query/DSL_DataSpace_LegendQueryRouter.js';
+} from '../../application/query/DSL_DataSpace_LegendQueryNavigation.js';
 import { DataSpaceQueryCreator } from './DataSpaceQueryCreator.js';
 import { createQueryDataSpaceTaggedValue } from '../../stores/query/DataSpaceQueryCreatorStore.js';
 import { Query, isValidFullPath } from '@finos/legend-graph';
@@ -168,9 +168,10 @@ export class DSL_DataSpace_LegendQueryApplicationPlugin extends LegendQueryAppli
                       editorStore.applicationStore.notificationService.notifySuccess(
                         `Successfully created query!`,
                       );
-                      LegendQueryEventService.create(
+                      LegendQueryEventHelper.notify_QueryCreateSucceeded(
                         editorStore.applicationStore.eventService,
-                      ).notify_QueryCreated({ queryId: newQuery.id });
+                        { queryId: newQuery.id },
+                      );
                       editorStore.applicationStore.navigationService.navigator.goToLocation(
                         generateExistingQueryEditorRoute(newQuery.id),
                       );

package/src/components/query/DataSpaceQueryBuilder.tsx

@@ -272,7 +272,8 @@ const DataSpaceQueryBuilderSetupPanelContent = observer(
                 placeholder="Search for data space..."
                 escapeClearsValue={true}
                 darkMode={
-                  !applicationStore.layoutService.TEMPORARY__isLightThemeEnabled
+                  !applicationStore.layoutService
+                    .TEMPORARY__isLightColorThemeEnabled
                 }
                 formatOptionLabel={formatDataSpaceOptionLabel}
               />
@@ -316,7 +317,8 @@ const DataSpaceQueryBuilderSetupPanelContent = observer(
                 onChange={onExecutionContextOptionChange}
                 value={selectedExecutionContextOption}
                 darkMode={
-                  !applicationStore.layoutService.TEMPORARY__isLightThemeEnabled
+                  !applicationStore.layoutService
+                    .TEMPORARY__isLightColorThemeEnabled
                 }
               />
             </div>
@@ -337,13 +339,13 @@ const DataSpaceQueryBuilderSetupPanelContent = observer(
                   value={selectedRuntimeOption}
                   darkMode={
                     !applicationStore.layoutService
-                      .TEMPORARY__isLightThemeEnabled
+                      .TEMPORARY__isLightColorThemeEnabled
                   }
                   filterOption={runtimeFilterOption}
                   formatOptionLabel={getRuntimeOptionFormatter({
                     darkMode:
                       !applicationStore.layoutService
-                        .TEMPORARY__isLightThemeEnabled,
+                        .TEMPORARY__isLightColorThemeEnabled,
                     pureModel: queryBuilderState.graphManagerState.graph,
                   })}
                 />

package/src/components/query/DataSpaceQueryCreator.tsx

@@ -15,15 +15,9 @@
  */
 
 import { observer, useLocalObservable } from 'mobx-react-lite';
-import {
-  getQueryParameters,
-  getQueryParameterValue,
-  sanitizeURL,
-} from '@finos/legend-shared';
 import { useApplicationStore, useParams } from '@finos/legend-application';
 import { useDepotServerClient } from '@finos/legend-server-depot';
 import {
-  LEGEND_QUERY_PATH_PARAM_TOKEN,
   QueryEditor,
   QueryEditorStoreContext,
   useLegendQueryApplicationStore,
@@ -31,10 +25,9 @@ import {
 import { DataSpaceQueryCreatorStore } from '../../stores/query/DataSpaceQueryCreatorStore.js';
 import {
   type DataSpaceQueryCreatorPathParams,
-  type DataSpaceQueryEditorQueryParams,
-  DATA_SPACE_QUERY_CREATOR_PATH_PARAM_TOKEN,
+  DATA_SPACE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN,
   DATA_SPACE_QUERY_CREATOR_QUERY_PARAM_TOKEN,
-} from '../../stores/query/DSL_DataSpace_LegendQueryRouter.js';
+} from '../../application/query/DSL_DataSpace_LegendQueryNavigation.js';
 import { parseGAVCoordinates } from '@finos/legend-storage';
 
 const DataSpaceQueryCreatorStoreProvider: React.FC<{
@@ -78,22 +71,18 @@ const DataSpaceQueryCreatorStoreProvider: React.FC<{
 
 export const DataSpaceQueryCreator = observer(() => {
   const applicationStore = useApplicationStore();
-  const params = useParams<DataSpaceQueryCreatorPathParams>();
-  const gav = params[LEGEND_QUERY_PATH_PARAM_TOKEN.GAV];
+  const parameters = useParams<DataSpaceQueryCreatorPathParams>();
+  const gav = parameters[DATA_SPACE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV];
   const dataSpacePath =
-    params[DATA_SPACE_QUERY_CREATOR_PATH_PARAM_TOKEN.DATA_SPACE_PATH];
+    parameters[DATA_SPACE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH];
   const executionContext =
-    params[DATA_SPACE_QUERY_CREATOR_PATH_PARAM_TOKEN.EXECUTION_CONTEXT];
-  const runtimePath = params[LEGEND_QUERY_PATH_PARAM_TOKEN.RUNTIME_PATH];
-  const classPath = getQueryParameterValue(
-    getQueryParameters<DataSpaceQueryEditorQueryParams>(
-      sanitizeURL(
-        applicationStore.navigationService.navigator.getCurrentAddress(),
-      ),
-      true,
-    ),
-    DATA_SPACE_QUERY_CREATOR_QUERY_PARAM_TOKEN.CLASS_PATH,
-  );
+    parameters[DATA_SPACE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.EXECUTION_CONTEXT];
+  const runtimePath =
+    parameters[DATA_SPACE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.RUNTIME_PATH];
+  const classPath =
+    applicationStore.navigationService.navigator.getAddressParameterValue(
+      DATA_SPACE_QUERY_CREATOR_QUERY_PARAM_TOKEN.CLASS_PATH,
+    );
 
   return (
     <DataSpaceQueryCreatorStoreProvider

package/src/components/query/DataSpaceQuerySetup.tsx

@@ -144,7 +144,8 @@ const DataSpaceQuerySetupSetupPanelContent = observer(
                 placeholder="Search for data space..."
                 escapeClearsValue={true}
                 darkMode={
-                  !applicationStore.layoutService.TEMPORARY__isLightThemeEnabled
+                  !applicationStore.layoutService
+                    .TEMPORARY__isLightColorThemeEnabled
                 }
                 formatOptionLabel={formatDataSpaceOptionLabel}
               />

package/src/components/studio/DSL_DataSpace_LegendStudioApplicationPlugin.tsx

@@ -31,6 +31,10 @@ import {
   type PureGrammarParserElementSnippetSuggestionsGetter,
   UnsupportedElementEditorState,
   LegendStudioApplicationPlugin,
+  type ExplorerContextMenuItemRendererConfiguration,
+  type EditorExtensionStateCreator,
+  type EditorExtensionComponentRendererConfiguration,
+  type LegendStudioApplicationPageEntry,
 } from '@finos/legend-application-studio';
 import {
   PackageableElementExplicitReference,
@@ -42,17 +46,24 @@ import {
   DataSpace,
   DataSpaceExecutionContext,
 } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
-import { DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY } from './DSL_DataSpace_LegendStudioDocumentation.js';
+import { DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../application/studio/DSL_DataSpace_LegendStudioDocumentation.js';
 import {
   PURE_GRAMMAR_DATA_SPACE_ELEMENT_TYPE_LABEL,
   PURE_GRAMMAR_DATA_SPACE_PARSER_NAME,
 } from '../../graphManager/DSL_DataSpace_PureGraphManagerPlugin.js';
-import { SIMPLE_DATA_SPACE_SNIPPET } from './DSL_DataSpace_CodeSnippets.js';
+import { SIMPLE_DATA_SPACE_SNIPPET } from '../../application/studio/DSL_DataSpace_CodeSnippets.js';
 import type {
   DocumentationEntry,
   PureGrammarTextSuggestion,
 } from '@finos/legend-application';
 import { DataSpaceIcon } from '../DSL_DataSpace_Icon.js';
+import { DataSpacePreviewState } from '../../stores/studio/DataSpacePreviewState.js';
+import {
+  DataSpacePreviewDialog,
+  DataSpacePreviewAction,
+} from './DataSpacePreviewAction.js';
+import { DATA_SPACE_STUDIO_ROUTE_PATTERN } from '../../application/studio/DSL_DataSpace_LegendStudioNavigation.js';
+import { DataSpacePreview } from './DataSpacePreview.js';
 
 const DATA_SPACE_ELEMENT_TYPE = 'DATA SPACE';
 const DATA_SPACE_ELEMENT_PROJECT_EXPLORER_DND_TYPE =
@@ -66,6 +77,18 @@ export class DSL_DataSpace_LegendStudioApplicationPlugin
     super(packageJson.extensions.applicationStudioPlugin, packageJson.version);
   }
 
+  override getExtraApplicationPageEntries(): LegendStudioApplicationPageEntry[] {
+    return [
+      // data space preview
+      {
+        key: 'data-space-preview',
+        urlPatterns: [DATA_SPACE_STUDIO_ROUTE_PATTERN.PREVIEW],
+        renderer: DataSpacePreview,
+        bypassSDLC: true,
+      },
+    ];
+  }
+
   override getExtraRequiredDocumentationKeys(): string[] {
     return [
       DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY.CONCEPT_ELEMENT_DATA_SPACE,
@@ -73,6 +96,33 @@ export class DSL_DataSpace_LegendStudioApplicationPlugin
     ];
   }
 
+  override getExtraExplorerContextMenuItemRendererConfigurations(): ExplorerContextMenuItemRendererConfiguration[] {
+    return [
+      {
+        key: 'data-space-preview',
+        renderer: (editorStore, element) => {
+          if (element instanceof DataSpace) {
+            return <DataSpacePreviewAction dataSpace={element} />;
+          }
+          return undefined;
+        },
+      },
+    ];
+  }
+
+  override getExtraEditorExtensionStateCreators(): EditorExtensionStateCreator[] {
+    return [(editorStore) => new DataSpacePreviewState(editorStore)];
+  }
+
+  override getExtraEditorExtensionComponentRendererConfigurations(): EditorExtensionComponentRendererConfiguration[] {
+    return [
+      {
+        key: 'data-space-preview',
+        renderer: (editorStore) => <DataSpacePreviewDialog />,
+      },
+    ];
+  }
+
   getExtraSupportedElementTypes(): string[] {
     return [DATA_SPACE_ELEMENT_TYPE];
   }

package/src/components/studio/DataSpacePreview.tsx

@@ -0,0 +1,129 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { observer, useLocalObservable } from 'mobx-react-lite';
+import { useApplicationStore, useParams } from '@finos/legend-application';
+import { useDepotServerClient } from '@finos/legend-server-depot';
+import { parseGAVCoordinates } from '@finos/legend-storage';
+import { DataSpacePreviewStore } from '../../stores/studio/DataSpacePreviewStore.js';
+import { createContext, useContext, useEffect } from 'react';
+import { useLegendStudioApplicationStore } from '@finos/legend-application-studio';
+import {
+  DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN,
+  type DataSpacePreviewPathParams,
+} from '../../application/studio/DSL_DataSpace_LegendStudioNavigation.js';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import { flowResult } from 'mobx';
+import { DataSpaceViewer } from '../DataSpaceViewer.js';
+import {
+  BlankPanelContent,
+  PanelLoadingIndicator,
+  TimesCircleIcon,
+} from '@finos/legend-art';
+
+const DataSpacePreviewStoreContext = createContext<
+  DataSpacePreviewStore | undefined
+>(undefined);
+
+const DataSpacePreviewStoreProvider: React.FC<{
+  children: React.ReactNode;
+  gav: string;
+  dataSpacePath: string;
+}> = ({ children, gav, dataSpacePath }) => {
+  const { groupId, artifactId, versionId } = parseGAVCoordinates(gav);
+  const applicationStore = useLegendStudioApplicationStore();
+  const depotServerClient = useDepotServerClient();
+  const store = useLocalObservable(
+    () =>
+      new DataSpacePreviewStore(
+        applicationStore,
+        depotServerClient,
+        groupId,
+        artifactId,
+        versionId,
+        dataSpacePath,
+      ),
+  );
+  return (
+    <DataSpacePreviewStoreContext.Provider value={store}>
+      {children}
+    </DataSpacePreviewStoreContext.Provider>
+  );
+};
+
+const useDataSpacePreviewStore = (): DataSpacePreviewStore =>
+  guaranteeNonNullable(
+    useContext(DataSpacePreviewStoreContext),
+    `Can't find data space preview store in context`,
+  );
+
+const DataSpacePreviewInner = observer(() => {
+  const previewStore = useDataSpacePreviewStore();
+  const applicationStore = useApplicationStore();
+
+  useEffect(() => {
+    flowResult(previewStore.initialize()).catch(
+      applicationStore.alertUnhandledError,
+    );
+  }, [applicationStore, previewStore]);
+
+  return (
+    <div className="data-space-preview">
+      <PanelLoadingIndicator
+        isLoading={previewStore.loadDataSpaceState.isInProgress}
+      />
+      {previewStore.dataSpaceViewerState && (
+        <DataSpaceViewer
+          dataSpaceViewerState={previewStore.dataSpaceViewerState}
+        />
+      )}
+      {!previewStore.dataSpaceViewerState && (
+        <>
+          {previewStore.loadDataSpaceState.isInProgress && (
+            <BlankPanelContent>
+              {previewStore.loadDataSpaceState.message}
+            </BlankPanelContent>
+          )}
+          {previewStore.loadDataSpaceState.hasFailed && (
+            <BlankPanelContent>
+              <div className="data-space-preview__failure">
+                <div className="data-space-preview__failure__icon">
+                  <TimesCircleIcon />
+                </div>
+                <div className="data-space-preview__failure__text">
+                  Can&apos;t load data space
+                </div>
+              </div>
+            </BlankPanelContent>
+          )}
+        </>
+      )}
+    </div>
+  );
+});
+
+export const DataSpacePreview = observer(() => {
+  const parameters = useParams<DataSpacePreviewPathParams>();
+  const gav = parameters[DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.GAV];
+  const dataSpacePath =
+    parameters[DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH];
+
+  return (
+    <DataSpacePreviewStoreProvider gav={gav} dataSpacePath={dataSpacePath}>
+      <DataSpacePreviewInner />
+    </DataSpacePreviewStoreProvider>
+  );
+});

package/src/components/studio/DataSpacePreviewAction.tsx

@@ -0,0 +1,127 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { useApplicationStore } from '@finos/legend-application';
+import {
+  MenuContentItem,
+  BlankPanelContent,
+  TimesCircleIcon,
+  PanelLoadingIndicator,
+  Dialog,
+  TimesIcon,
+  Modal,
+  ModalHeader,
+  ModalTitle,
+  ModalHeaderActions,
+} from '@finos/legend-art';
+import { flowResult } from 'mobx';
+import { observer } from 'mobx-react-lite';
+import { DataSpaceViewer } from '../DataSpaceViewer.js';
+import type { DataSpace } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
+import { useEditorStore } from '@finos/legend-application-studio';
+import { DataSpacePreviewState } from '../../stores/studio/DataSpacePreviewState.js';
+
+export const DataSpacePreviewAction = observer(
+  (props: { dataSpace: DataSpace }) => {
+    const { dataSpace } = props;
+    const editorStore = useEditorStore();
+    const applicationStore = useApplicationStore();
+    const dataSpacePreviewState =
+      DataSpacePreviewState.retrieveState(editorStore);
+
+    const previewDataSpace = (): void => {
+      flowResult(dataSpacePreviewState.previewDataSpace(dataSpace)).catch(
+        applicationStore.alertUnhandledError,
+      );
+    };
+
+    return (
+      <MenuContentItem onClick={previewDataSpace}>Preview</MenuContentItem>
+    );
+  },
+);
+
+export const DataSpacePreviewDialog = observer(() => {
+  const editorStore = useEditorStore();
+  const dataSpacePreviewState =
+    DataSpacePreviewState.retrieveState(editorStore);
+
+  const onClose = (): void => {
+    dataSpacePreviewState.setDataSpace(undefined);
+  };
+
+  return (
+    <Dialog
+      open={Boolean(dataSpacePreviewState.dataSpace)}
+      onClose={onClose}
+      classes={{
+        root: 'editor-modal__root-container',
+        container: 'editor-modal__container',
+        paper:
+          'editor-modal__content data-space-preview__dialog__container__content',
+      }}
+    >
+      <Modal
+        darkMode={true}
+        className="editor-modal data-space-preview__dialog"
+      >
+        <ModalHeader className="data-space-preview__dialog__header">
+          <ModalTitle title="Preview Data Space" />
+          <ModalHeaderActions>
+            <button
+              className="modal__header__action"
+              title="Close"
+              onClick={onClose}
+            >
+              <TimesIcon />
+            </button>
+          </ModalHeaderActions>
+        </ModalHeader>
+        <div className="data-space-preview__dialog__content">
+          <PanelLoadingIndicator
+            isLoading={dataSpacePreviewState.loadDataSpaceState.isInProgress}
+          />
+          {dataSpacePreviewState.dataSpaceViewerState && (
+            <DataSpaceViewer
+              dataSpaceViewerState={dataSpacePreviewState.dataSpaceViewerState}
+            />
+          )}
+          {!dataSpacePreviewState.dataSpaceViewerState && (
+            <>
+              {dataSpacePreviewState.loadDataSpaceState.isInProgress && (
+                <BlankPanelContent>
+                  {dataSpacePreviewState.loadDataSpaceState.message}
+                </BlankPanelContent>
+              )}
+              {dataSpacePreviewState.loadDataSpaceState.hasFailed && (
+                <BlankPanelContent>
+                  <div className="data-space-preview__dialog__content--failed">
+                    <div className="data-space-preview__dialog__content--failed__icon">
+                      <TimesCircleIcon />
+                    </div>
+                    <div className="data-space-preview__dialog__content--failed__text">
+                      Can&apos;t load data space
+                    </div>
+                  </div>
+                </BlankPanelContent>
+              )}
+            </>
+          )}
+        </div>
+      </Modal>
+    </Dialog>
+  );
+});

package/src/graph/DSL_DataSpace_HashUtils.ts

@@ -17,5 +17,7 @@
 export enum DATA_SPACE_HASH_STRUCTURE {
   DATA_SPACE = 'DATA_SPACE',
   DATA_SPACE_EXECUTION_CONTEXT = 'DATA_SPACE_EXECUTION_CONTEXT',
+  DATA_SPACE_SAMPLE_TDS_QUERY = 'DATA_SPACE_SAMPLE_TDS_QUERY',
+  DATA_SPACE_SAMPLE_TDS_QUERY_COLUMN = 'DATA_SPACE_SAMPLE_TDS_QUERY_COLUMN',
   DATA_SPACE_SUPPORT_EMAIL = 'DATA_SPACE_SUPPORT_EMAIL',
 }

package/src/graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.ts

@@ -21,6 +21,9 @@ import {
   type Mapping,
   type PackageableRuntime,
   type PackageableElementVisitor,
+  type Class,
+  type Enumeration,
+  type Association,
 } from '@finos/legend-graph';
 import { DATA_SPACE_HASH_STRUCTURE } from '../../../../../DSL_DataSpace_HashUtils.js';
 import type { Diagram } from '@finos/legend-extension-dsl-diagram';
@@ -60,12 +63,15 @@ export class DataSpaceExecutionContext implements Hashable {
   }
 }
 
+export type DataSpaceElement = Class | Enumeration | Association;
+
 export class DataSpace extends PackageableElement implements Hashable {
+  title?: string | undefined;
+  description?: string | undefined;
   executionContexts: DataSpaceExecutionContext[] = [];
   defaultExecutionContext!: DataSpaceExecutionContext;
   featuredDiagrams?: PackageableElementReference<Diagram>[] | undefined;
-  title?: string | undefined;
-  description?: string | undefined;
+  elements?: PackageableElementReference<DataSpaceElement>[] | undefined;
   supportInfo?: DataSpaceSupportInfo | undefined;
 
   protected override get _elementHashCode(): string {
@@ -75,6 +81,8 @@ export class DataSpace extends PackageableElement implements Hashable {
         this.stereotypes.map((stereotype) => stereotype.pointerHashCode),
       ),
       hashArray(this.taggedValues),
+      this.title ?? '',
+      this.description ?? '',
       hashArray(this.executionContexts),
       this.defaultExecutionContext.name,
       hashArray(
@@ -82,8 +90,11 @@ export class DataSpace extends PackageableElement implements Hashable {
           (diagram) => diagram.valueForSerialization ?? '',
         ),
       ),
-      this.title ?? '',
-      this.description ?? '',
+      hashArray(
+        (this.elements ?? []).map(
+          (element) => element.valueForSerialization ?? '',
+        ),
+      ),
       this.supportInfo ?? '',
     ]);
   }

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

@@ -22,6 +22,12 @@ import type {
 } from '@finos/legend-graph';
 import { uuid } from '@finos/legend-shared';
 import type { DataSpaceSupportInfo } from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
+import {
+  HACKY__SHOWCASE1,
+  type HACKY__DataSpaceUsageShowcase,
+  HACKY__SHOWCASE2,
+  HACKY__SHOWCASE3,
+} from './HACKY__DataSpaceUsageShowcase.js';
 
 export class DataSpaceExecutionContextAnalysisResult {
   name!: string;
@@ -46,6 +52,23 @@ export class DataSpaceStereotypeInfo {
   value!: string;
 }
 
+export class DataSpaceDocumentationEntry {
+  readonly uuid = uuid();
+  readonly elementPath: string;
+  readonly subElementText?: string | undefined;
+  readonly doc: string;
+
+  constructor(
+    elementPath: string,
+    subElementText: string | undefined,
+    documentation: string,
+  ) {
+    this.elementPath = elementPath;
+    this.subElementText = subElementText;
+    this.doc = documentation;
+  }
+}
+
 export class DataSpaceAnalysisResult {
   name!: string;
   package!: string;
@@ -62,4 +85,12 @@ export class DataSpaceAnalysisResult {
   defaultExecutionContext!: DataSpaceExecutionContextAnalysisResult;
 
   featuredDiagrams: Diagram[] = [];
+
+  elementDocs: DataSpaceDocumentationEntry[] = [];
+
+  HACKY__usageShowcases: HACKY__DataSpaceUsageShowcase[] = [
+    HACKY__SHOWCASE1,
+    HACKY__SHOWCASE2,
+    HACKY__SHOWCASE3,
+  ];
 }