@finos/legend-extension-dsl-data-space 9.1.3 → 9.1.5

package/src/components/DataSpaceModelsDocumentation.tsx

@@ -0,0 +1,92 @@
+/**
+ * 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 } from 'mobx-react-lite';
+import { BlankPanelContent, SearchIcon } 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';
+
+export const DataSpaceModelsDocumentation = observer(
+  (props: { dataSpaceViewerState: DataSpaceViewerState }) => {
+    const { dataSpaceViewerState } = props;
+    const documentationEntries =
+      dataSpaceViewerState.dataSpaceAnalysisResult.elementDocs;
+
+    if (documentationEntries.length === 0) {
+      return <BlankPanelContent>No documentation available</BlankPanelContent>;
+    }
+
+    return (
+      <div className="data-space__viewer__wiki__section">
+        <div className="data-space__viewer__wiki__section__header">
+          Models Documentation
+        </div>
+        <div className="data-space__viewer__wiki__section__content">
+          <div className="data-space__viewer__models-documentation">
+            <div className="data-space__viewer__models-documentation__search">
+              <div className="data-space__viewer__models-documentation__search__input-group">
+                <input className="data-space__viewer__models-documentation__search__input-group__input" />
+                <div className="data-space__viewer__models-documentation__search-box__input-group__icon">
+                  <SearchIcon />
+                </div>
+              </div>
+            </div>
+            <div className="data-space__viewer__models-documentation__grid ag-theme-balham-dark">
+              <AgGridReact
+                rowData={documentationEntries}
+                gridOptions={{
+                  suppressScrollOnNewData: true,
+                  getRowId: (rowData) => rowData.data.uuid,
+                }}
+                modules={[ClientSideRowModelModule]}
+                suppressFieldDotNotation={true}
+                columnDefs={[
+                  {
+                    minWidth: 50,
+                    sortable: true,
+                    resizable: true,
+                    field: 'elementPath',
+                    headerName: 'Model',
+                    flex: 1,
+                  },
+                  {
+                    minWidth: 50,
+                    sortable: false,
+                    resizable: true,
+                    field: 'subElementText',
+                    headerName: '',
+                    flex: 1,
+                  },
+                  {
+                    minWidth: 50,
+                    sortable: false,
+                    resizable: true,
+                    field: 'doc',
+                    headerName: 'Documentation',
+                    flex: 1,
+                    wrapText: true,
+                    autoHeight: true,
+                  },
+                ]}
+              />
+            </div>
+          </div>
+        </div>
+      </div>
+    );
+  },
+);

package/src/components/DataSpaceQuickStart.tsx

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */

package/src/components/DataSpaceSupportPanel.tsx

@@ -0,0 +1,80 @@
+/**
+ * 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 } from 'mobx-react-lite';
+import { BlankPanelContent, EnvelopIcon } from '@finos/legend-art';
+import { DataSpaceSupportEmail } from '../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
+import { type DataSpaceViewerState } from '../stores/DataSpaceViewerState.js';
+
+const DataSpaceSupportEmailViewer = observer(
+  (props: {
+    dataSpaceViewerState: DataSpaceViewerState;
+    dataSpaceSupportEmail: DataSpaceSupportEmail;
+  }) => {
+    const { dataSpaceSupportEmail } = props;
+
+    return (
+      <div className="data-space__viewer__support-email">
+        <div className="data-space__viewer__support-email__entry">
+          <div className="data-space__viewer__support-email__entry__icon">
+            <EnvelopIcon />
+          </div>
+          <a
+            href={`mailto:${dataSpaceSupportEmail.address}`}
+            className="data-space__viewer__support-email__entry__content"
+          >
+            {dataSpaceSupportEmail.address}
+          </a>
+        </div>
+      </div>
+    );
+  },
+);
+
+const DataSpaceSupport = observer(
+  (props: { dataSpaceViewerState: DataSpaceViewerState }) => {
+    const { dataSpaceViewerState } = props;
+    const supportInfo =
+      dataSpaceViewerState.dataSpaceAnalysisResult.supportInfo;
+
+    if (supportInfo === undefined) {
+      return <BlankPanelContent>No support info available</BlankPanelContent>;
+    } else if (supportInfo instanceof DataSpaceSupportEmail) {
+      return (
+        <DataSpaceSupportEmailViewer
+          dataSpaceViewerState={dataSpaceViewerState}
+          dataSpaceSupportEmail={supportInfo}
+        />
+      );
+    }
+    return (
+      <BlankPanelContent>{`Can't display support info`}</BlankPanelContent>
+    );
+  },
+);
+
+export const DataSpaceSupportPanel = observer(
+  (props: { dataSpaceViewerState: DataSpaceViewerState }) => {
+    const { dataSpaceViewerState } = props;
+    return (
+      <div className="data-space__viewer__panel">
+        <div className="data-space__viewer__support-info">
+          <DataSpaceSupport dataSpaceViewerState={dataSpaceViewerState} />
+        </div>
+      </div>
+    );
+  },
+);