@finos/legend-extension-dsl-data-space 0.0.6 → 1.0.1

package/lib/stores/studio/DataSpaceEditorState.js

@@ -1,76 +0,0 @@
-/**
- * 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 { computed, action, makeObservable, observable } from 'mobx';
-import { guaranteeNonNullable, guaranteeType } from '@finos/legend-shared';
-import { ElementEditorState } from '@finos/legend-studio';
-import { DataSpace } from '../../models/metamodels/pure/model/packageableElements/dataSpace/DataSpace';
-import { Diagram } from '@finos/legend-extension-dsl-diagram';
-export var DATA_SPACE_VIEWER_ACTIVITY_MODE;
-(function (DATA_SPACE_VIEWER_ACTIVITY_MODE) {
-    DATA_SPACE_VIEWER_ACTIVITY_MODE["MODELS"] = "MODELS";
-    DATA_SPACE_VIEWER_ACTIVITY_MODE["EXECUTION"] = "EXECUTION";
-    DATA_SPACE_VIEWER_ACTIVITY_MODE["ENTITLEMENT"] = "ENTITLEMENT";
-    DATA_SPACE_VIEWER_ACTIVITY_MODE["SUPPORT"] = "SUPPORT";
-})(DATA_SPACE_VIEWER_ACTIVITY_MODE || (DATA_SPACE_VIEWER_ACTIVITY_MODE = {}));
-export class DataSpaceEditorState extends ElementEditorState {
-    _renderer;
-    currentDiagram;
-    currentActivity = DATA_SPACE_VIEWER_ACTIVITY_MODE.MODELS;
-    diagrams = [];
-    constructor(editorStore, element) {
-        super(editorStore, element);
-        makeObservable(this, {
-            _renderer: observable,
-            currentDiagram: observable,
-            currentActivity: observable,
-            renderer: computed,
-            dataSpace: computed,
-            setRenderer: action,
-            setCurrentDiagram: action,
-            setCurrentActivity: action,
-            reprocess: action,
-        });
-        this.dataSpace.featuredDiagrams.forEach((diagram) => {
-            this.diagrams.push(this.editorStore.graphManagerState.graph.getExtensionElement(diagram, Diagram));
-        });
-        if (this.diagrams.length !== 0) {
-            this.setCurrentDiagram(this.diagrams[0]);
-        }
-    }
-    get dataSpace() {
-        return guaranteeType(this.element, DataSpace, 'Element inside data space editor state must be a data space element');
-    }
-    get renderer() {
-        return guaranteeNonNullable(this._renderer, `Diagram renderer must be initialized (this is likely caused by calling this method at the wrong place)`);
-    }
-    get isDiagramRendererInitialized() {
-        return Boolean(this._renderer);
-    }
-    setRenderer(val) {
-        this._renderer = val;
-    }
-    setCurrentDiagram(val) {
-        this.currentDiagram = val;
-    }
-    setCurrentActivity(val) {
-        this.currentActivity = val;
-    }
-    reprocess(newElement, editorStore) {
-        const newElementEditorState = new DataSpaceEditorState(editorStore, newElement);
-        return newElementEditorState;
-    }
-}
-//# sourceMappingURL=DataSpaceEditorState.js.map

package/lib/stores/studio/DataSpaceEditorState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataSpaceEditorState.js","sourceRoot":"","sources":["../../../src/stores/studio/DataSpaceEditorState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEpE,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,4EAA4E,CAAC;AAEvG,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAE9D,MAAM,CAAN,IAAY,+BAKX;AALD,WAAY,+BAA+B;IACzC,oDAAiB,CAAA;IACjB,0DAAuB,CAAA;IACvB,8DAA2B,CAAA;IAC3B,sDAAmB,CAAA;AACrB,CAAC,EALW,+BAA+B,KAA/B,+BAA+B,QAK1C;AAED,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IAC1D,SAAS,CAA+B;IACxC,cAAc,CAAuB;IACrC,eAAe,GAAG,+BAA+B,CAAC,MAAM,CAAC;IACzD,QAAQ,GAAc,EAAE,CAAC;IAEzB,YAAY,WAAwB,EAAE,OAA2B;QAC/D,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,cAAc,CAAC,IAAI,EAAE;YACnB,SAAS,EAAE,UAAU;YACrB,cAAc,EAAE,UAAU;YAC1B,eAAe,EAAE,UAAU;YAC3B,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,MAAM;YACnB,iBAAiB,EAAE,MAAM;YACzB,kBAAkB,EAAE,MAAM;YAC1B,SAAS,EAAE,MAAM;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,mBAAmB,CAC1D,OAAO,EACP,OAAO,CACR,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,aAAa,CAClB,IAAI,CAAC,OAAO,EACZ,SAAS,EACT,qEAAqE,CACtE,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,oBAAoB,CACzB,IAAI,CAAC,SAAS,EACd,wGAAwG,CACzG,CAAC;IACJ,CAAC;IAED,IAAI,4BAA4B;QAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,WAAW,CAAC,GAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;IACvB,CAAC;IAED,iBAAiB,CAAC,GAAY;QAC5B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,kBAAkB,CAAC,GAAoC;QACrD,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;IAC7B,CAAC;IAED,SAAS,CACP,UAA8B,EAC9B,WAAwB;QAExB,MAAM,qBAAqB,GAAG,IAAI,oBAAoB,CACpD,WAAW,EACX,UAAU,CACX,CAAC;QACF,OAAO,qBAAqB,CAAC;IAC/B,CAAC;CACF"}

package/src/components/studio/DataSpaceEditor.tsx

@@ -1,272 +0,0 @@
-/**
- * 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 { useRef, useEffect } from 'react';
-import { observer } from 'mobx-react-lite';
-import { useEditorStore } from '@finos/legend-studio';
-import { useResizeDetector } from 'react-resize-detector';
-import {
-  BlankPanelContent,
-  ShapesIcon,
-  PlayIcon,
-  UserIcon,
-  QuestionCircleIcon,
-  clsx,
-  CustomSelectorInput,
-} from '@finos/legend-art';
-import {
-  DataSpaceEditorState,
-  DATA_SPACE_VIEWER_ACTIVITY_MODE,
-} from '../../stores/studio/DataSpaceEditorState';
-import type { Diagram } from '@finos/legend-extension-dsl-diagram';
-import { DiagramRenderer } from '@finos/legend-extension-dsl-diagram';
-
-interface DataSpaceViewerActivityConfig {
-  mode: DATA_SPACE_VIEWER_ACTIVITY_MODE;
-  title: string;
-  icon: React.ReactElement;
-}
-
-const DataSpaceDiagramCanvas = observer(
-  (
-    props: {
-      dataSpaceEditorState: DataSpaceEditorState;
-      diagram: Diagram;
-    },
-    ref: React.Ref<HTMLDivElement>,
-  ) => {
-    const { dataSpaceEditorState, diagram } = props;
-    const diagramCanvasRef =
-      ref as React.MutableRefObject<HTMLDivElement | null>;
-
-    const { width, height } = useResizeDetector<HTMLDivElement>({
-      refreshMode: 'debounce',
-      refreshRate: 50,
-      targetRef: diagramCanvasRef,
-    });
-
-    useEffect(() => {
-      if (diagramCanvasRef.current) {
-        const renderer = new DiagramRenderer(diagramCanvasRef.current, diagram);
-        dataSpaceEditorState.setRenderer(renderer);
-        renderer.render();
-        renderer.autoRecenter();
-      }
-    }, [diagramCanvasRef, dataSpaceEditorState, diagram]);
-
-    useEffect(() => {
-      if (dataSpaceEditorState.isDiagramRendererInitialized) {
-        dataSpaceEditorState.renderer.refresh();
-      }
-    }, [dataSpaceEditorState, width, height]);
-
-    return (
-      <div
-        ref={diagramCanvasRef}
-        className="diagram-canvas"
-        tabIndex={0}
-        onContextMenu={(event): void => event.preventDefault()}
-      />
-    );
-  },
-  { forwardRef: true },
-);
-
-type DiagramOption = { label: string; value: Diagram };
-const buildDiagramOption = (diagram: Diagram): DiagramOption => ({
-  label: diagram.name,
-  value: diagram,
-});
-
-const DataSpaceModelsOverview = observer(
-  (props: { dataSpaceEditorState: DataSpaceEditorState }) => {
-    const { dataSpaceEditorState } = props;
-    const diagramCanvasRef = useRef<HTMLDivElement>(null);
-    const diagramOptions =
-      dataSpaceEditorState.diagrams.map(buildDiagramOption);
-    const selectedDiagramOption = dataSpaceEditorState.currentDiagram
-      ? buildDiagramOption(dataSpaceEditorState.currentDiagram)
-      : null;
-    const onDiagramOptionChange = (option: DiagramOption): void => {
-      if (option.value !== dataSpaceEditorState.currentDiagram) {
-        dataSpaceEditorState.setCurrentDiagram(option.value);
-      }
-    };
-
-    return (
-      <>
-        {dataSpaceEditorState.diagrams.length !== 0 && (
-          <div className="data-space-viewer__main-panel__content data-space-viewer__overview-panel">
-            <div className="data-space-viewer__overview-panel__header">
-              <CustomSelectorInput
-                className="data-space-viewer__overview-panel__diagram-selector"
-                options={diagramOptions}
-                onChange={onDiagramOptionChange}
-                value={selectedDiagramOption}
-                placeholder="Search for a diagram"
-                darkMode={true}
-              />
-            </div>
-            <div className="data-space-viewer__overview-panel__content">
-              {dataSpaceEditorState.currentDiagram && (
-                <DataSpaceDiagramCanvas
-                  dataSpaceEditorState={dataSpaceEditorState}
-                  diagram={dataSpaceEditorState.currentDiagram}
-                  ref={diagramCanvasRef}
-                />
-              )}
-            </div>
-          </div>
-        )}
-        {dataSpaceEditorState.diagrams.length === 0 && (
-          <BlankPanelContent>No diagrams available</BlankPanelContent>
-        )}
-      </>
-    );
-  },
-);
-
-export const DataSpaceViewer = observer(() => {
-  const editorStore = useEditorStore();
-  const dataSpaceEditorState =
-    editorStore.getCurrentEditorState(DataSpaceEditorState);
-  const dataSpace = dataSpaceEditorState.dataSpace;
-  const changeActivity =
-    (activity: DATA_SPACE_VIEWER_ACTIVITY_MODE): (() => void) =>
-    (): void =>
-      dataSpaceEditorState.setCurrentActivity(activity);
-
-  const activities: DataSpaceViewerActivityConfig[] = [
-    {
-      mode: DATA_SPACE_VIEWER_ACTIVITY_MODE.MODELS,
-      title: 'Models Overview',
-      icon: <ShapesIcon />,
-    },
-    {
-      mode: DATA_SPACE_VIEWER_ACTIVITY_MODE.EXECUTION,
-      title: 'Execution Context',
-      icon: <PlayIcon />,
-    },
-    {
-      mode: DATA_SPACE_VIEWER_ACTIVITY_MODE.ENTITLEMENT,
-      title: 'Entitlement',
-      icon: <UserIcon />,
-    },
-    {
-      mode: DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT,
-      title: 'Support',
-      icon: <QuestionCircleIcon />,
-    },
-  ];
-
-  return (
-    <div className="data-space-viewer">
-      <div className="data-space-viewer__header">
-        <div className="data-space-viewer__path">{dataSpace.path}</div>
-        <div className="data-space-viewer__gav">
-          <div className="data-space-viewer__gav__group-id">
-            {dataSpace.groupId}
-          </div>
-          <div className="data-space-viewer__gav__separator">:</div>
-          <div className="data-space-viewer__gav__artifact-id">
-            {dataSpace.artifactId}
-          </div>
-          <div className="data-space-viewer__gav__separator">:</div>
-          <div className="data-space-viewer__gav__version-id">
-            {dataSpace.versionId}
-          </div>
-        </div>
-        <div className="data-space-viewer__description">
-          {dataSpace.description ? (
-            dataSpace.description
-          ) : (
-            <div className="data-space-viewer__description--empty">
-              No description
-            </div>
-          )}
-        </div>
-      </div>
-      <div className="data-space-viewer__content">
-        <div className="data-space-viewer__body">
-          <div className="data-space-viewer__activity-bar">
-            <div className="data-space-viewer__activity-bar__items">
-              {activities.map((activity) => (
-                <button
-                  key={activity.mode}
-                  className={clsx('data-space-viewer__activity-bar__item', {
-                    'data-space-viewer__activity-bar__item--active':
-                      dataSpaceEditorState.currentActivity === activity.mode,
-                  })}
-                  onClick={changeActivity(activity.mode)}
-                  tabIndex={-1}
-                  title={activity.title}
-                >
-                  {activity.icon}
-                </button>
-              ))}
-            </div>
-          </div>
-          <div className="data-space-viewer__main-panel">
-            {dataSpaceEditorState.currentActivity ===
-              DATA_SPACE_VIEWER_ACTIVITY_MODE.MODELS && (
-              <DataSpaceModelsOverview
-                dataSpaceEditorState={dataSpaceEditorState}
-              />
-            )}
-            {/* {dataSpaceEditorState.currentActivity ===
-              DATA_SPACE_VIEWER_ACTIVITY_MODE.EXECUTION && (
-              <div className="data-space-viewer__main-panel__content data-space-viewer__execution-panel">
-                <div className="data-space-viewer__panel__info-entry">
-                  <div className="data-space-viewer__panel__info-entry__icon">
-                    <MappingIcon />
-                  </div>
-                  <div className="data-space-viewer__panel__info-entry__content">
-                    {dataSpace.mapping}
-                  </div>
-                </div>
-                <div className="data-space-viewer__panel__info-entry">
-                  <div className="data-space-viewer__panel__info-entry__icon">
-                    <RuntimeIcon />
-                  </div>
-                  <div className="data-space-viewer__panel__info-entry__content">
-                    {dataSpace.runtime}
-                  </div>
-                </div>
-              </div>
-            )} */}
-            {dataSpaceEditorState.currentActivity ===
-              DATA_SPACE_VIEWER_ACTIVITY_MODE.ENTITLEMENT && (
-              <BlankPanelContent>(WIP)</BlankPanelContent>
-            )}
-            {/* {dataSpaceEditorState.currentActivity ===
-              DATA_SPACE_VIEWER_ACTIVITY_MODE.SUPPORT && (
-              <div className="data-space-viewer__main-panel__content data-space-viewer__support-panel">
-                <div className="data-space-viewer__panel__info-entry">
-                  <div className="data-space-viewer__panel__info-entry__icon">
-                    <EnvelopIcon />
-                  </div>
-                  <div className="data-space-viewer__panel__info-entry__content">
-                    {dataSpace.supportInfo ?? '(no support contact available)'}
-                  </div>
-                </div>
-              </div>
-            )} */}
-          </div>
-        </div>
-      </div>
-    </div>
-  );
-});

package/src/stores/studio/DataSpaceEditorState.ts

@@ -1,108 +0,0 @@
-/**
- * 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 { computed, action, makeObservable, observable } from 'mobx';
-import type { EditorStore } from '@finos/legend-studio';
-import { guaranteeNonNullable, guaranteeType } from '@finos/legend-shared';
-import { ElementEditorState } from '@finos/legend-studio';
-import type { PackageableElement } from '@finos/legend-graph';
-import { DataSpace } from '../../models/metamodels/pure/model/packageableElements/dataSpace/DataSpace';
-import type { DiagramRenderer } from '@finos/legend-extension-dsl-diagram';
-import { Diagram } from '@finos/legend-extension-dsl-diagram';
-
-export enum DATA_SPACE_VIEWER_ACTIVITY_MODE {
-  MODELS = 'MODELS',
-  EXECUTION = 'EXECUTION',
-  ENTITLEMENT = 'ENTITLEMENT',
-  SUPPORT = 'SUPPORT',
-}
-
-export class DataSpaceEditorState extends ElementEditorState {
-  _renderer?: DiagramRenderer | undefined;
-  currentDiagram?: Diagram | undefined;
-  currentActivity = DATA_SPACE_VIEWER_ACTIVITY_MODE.MODELS;
-  diagrams: Diagram[] = [];
-
-  constructor(editorStore: EditorStore, element: PackageableElement) {
-    super(editorStore, element);
-
-    makeObservable(this, {
-      _renderer: observable,
-      currentDiagram: observable,
-      currentActivity: observable,
-      renderer: computed,
-      dataSpace: computed,
-      setRenderer: action,
-      setCurrentDiagram: action,
-      setCurrentActivity: action,
-      reprocess: action,
-    });
-
-    this.dataSpace.featuredDiagrams.forEach((diagram) => {
-      this.diagrams.push(
-        this.editorStore.graphManagerState.graph.getExtensionElement(
-          diagram,
-          Diagram,
-        ),
-      );
-    });
-    if (this.diagrams.length !== 0) {
-      this.setCurrentDiagram(this.diagrams[0]);
-    }
-  }
-
-  get dataSpace(): DataSpace {
-    return guaranteeType(
-      this.element,
-      DataSpace,
-      'Element inside data space editor state must be a data space element',
-    );
-  }
-
-  get renderer(): DiagramRenderer {
-    return guaranteeNonNullable(
-      this._renderer,
-      `Diagram renderer must be initialized (this is likely caused by calling this method at the wrong place)`,
-    );
-  }
-
-  get isDiagramRendererInitialized(): boolean {
-    return Boolean(this._renderer);
-  }
-
-  setRenderer(val: DiagramRenderer): void {
-    this._renderer = val;
-  }
-
-  setCurrentDiagram(val: Diagram): void {
-    this.currentDiagram = val;
-  }
-
-  setCurrentActivity(val: DATA_SPACE_VIEWER_ACTIVITY_MODE): void {
-    this.currentActivity = val;
-  }
-
-  reprocess(
-    newElement: PackageableElement,
-    editorStore: EditorStore,
-  ): ElementEditorState {
-    const newElementEditorState = new DataSpaceEditorState(
-      editorStore,
-      newElement,
-    );
-    return newElementEditorState;
-  }
-}