@finos/legend-extension-dsl-data-space 0.0.1

package/src/models/protocols/pure/v1/model/packageableElements/dataSpace/V1_DataSpace.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { hashArray } from '@finos/legend-shared';
+import type { Hashable } from '@finos/legend-shared';
+import { DATA_SPACE_HASH_STRUCTURE } from '../../../../../../DSLDataSpace_ModelUtils';
+import type {
+  V1_PackageableElementVisitor,
+  V1_StereotypePtr,
+  V1_TaggedValue,
+} from '@finos/legend-graph';
+import { V1_PackageableElement } from '@finos/legend-graph';
+
+export class V1_DataSpace extends V1_PackageableElement implements Hashable {
+  stereotypes: V1_StereotypePtr[] = [];
+  taggedValues: V1_TaggedValue[] = [];
+  groupId!: string;
+  artifactId!: string;
+  versionId!: string;
+  mapping!: string;
+  runtime!: string;
+  diagrams?: string[] | undefined;
+  description?: string | undefined;
+  supportEmail?: string | undefined;
+
+  override get hashCode(): string {
+    return hashArray([
+      DATA_SPACE_HASH_STRUCTURE.DATA_SPACE,
+      hashArray(this.stereotypes),
+      hashArray(this.taggedValues),
+      this.groupId,
+      this.artifactId,
+      this.versionId,
+      this.mapping,
+      this.runtime,
+      hashArray(this.diagrams ?? []),
+      this.description ?? '',
+      this.supportEmail ?? '',
+    ]);
+  }
+
+  accept_PackageableElementVisitor<T>(
+    visitor: V1_PackageableElementVisitor<T>,
+  ): T {
+    return visitor.visit_PackageableElement(this);
+  }
+}

package/src/models/protocols/pure/v1/transformation/pureGraph/V1_DSLDataSpace_GraphBuilderHelper.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { getDataSpace } from '../../../../../../graphManager/DSLDataSpace_GraphManagerHelper';
+import type { DataSpace } from '../../../../../metamodels/pure/model/packageableElements/dataSpace/DataSpace';
+import type {
+  PackageableElementImplicitReference,
+  V1_GraphBuilderContext,
+} from '@finos/legend-graph';
+
+export const V1_resolveDataSpace = (
+  path: string,
+  context: V1_GraphBuilderContext,
+): PackageableElementImplicitReference<DataSpace> =>
+  context.createImplicitPackageableElementReference(path, (_path: string) =>
+    getDataSpace(_path, context.graph),
+  );

package/src/models/protocols/pure/v1/transformation/pureProtocol/V1_DSLDataSpace_ProtocolHelper.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 type { V1_StereotypePtr } from '@finos/legend-graph';
+import {
+  V1_stereotypePtrSchema,
+  V1_taggedValueSchema,
+} from '@finos/legend-graph';
+import {
+  deserializeArray,
+  serializeArray,
+  usingConstantValueSchema,
+} from '@finos/legend-shared';
+import {
+  createModelSchema,
+  custom,
+  deserialize,
+  optional,
+  primitive,
+  serialize,
+} from 'serializr';
+import { V1_DataSpace } from '../../model/packageableElements/dataSpace/V1_DataSpace';
+
+export const V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE = 'dataSpace';
+
+export const V1_dataSpaceModelSchema = createModelSchema(V1_DataSpace, {
+  _type: usingConstantValueSchema(V1_DATA_SPACE_ELEMENT_PROTOCOL_TYPE),
+  artifactId: primitive(),
+  description: optional(primitive()),
+  diagrams: custom(
+    (values) => serializeArray(values, (value) => value, true),
+    (values) => deserializeArray(values, (value) => value, false),
+  ),
+  groupId: primitive(),
+  mapping: primitive(),
+  name: primitive(),
+  package: primitive(),
+  runtime: primitive(),
+  stereotypes: custom(
+    (values) =>
+      serializeArray(
+        values,
+        (value) => serialize(V1_stereotypePtrSchema, value),
+        true,
+      ),
+    (values) =>
+      deserializeArray(
+        values,
+        (v: V1_StereotypePtr) => deserialize(V1_stereotypePtrSchema, v),
+        false,
+      ),
+  ),
+  supportEmail: optional(primitive()),
+  taggedValues: custom(
+    (values) =>
+      serializeArray(
+        values,
+        (value) => serialize(V1_taggedValueSchema, value),
+        true,
+      ),
+    (values) =>
+      deserializeArray(
+        values,
+        (v: V1_StereotypePtr) => deserialize(V1_taggedValueSchema, v),
+        false,
+      ),
+  ),
+  versionId: primitive(),
+});

package/src/stores/studio/DataSpaceEditorState.ts

@@ -0,0 +1,108 @@
+/**
+ * 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.diagrams.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;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,64 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "esnext",
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "importsNotUsedAsValues": "error",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/prod.tsbuildinfo",
+    "rootDir": "./src",
+    "jsx": "react-jsx"
+  },
+  "references": [
+    {
+      "path": "./tsconfig.package.json"
+    }
+  ],
+  "files": [
+    "./src/DSLDataSpace_Extension.ts",
+    "./src/index.ts",
+    "./src/graph/DSLDataSpace_PureGraphPlugin.ts",
+    "./src/graphManager/DSLDataSpace_GraphManagerHelper.ts",
+    "./src/graphManager/DSLDataSpace_PureGraphManagerPlugin.ts",
+    "./src/models/DSLDataSpace_ModelUtils.ts",
+    "./src/models/metamodels/pure/model/packageableElements/dataSpace/DataSpace.ts",
+    "./src/models/protocols/pure/DSLDataSpace_PureProtocolProcessorPlugin.ts",
+    "./src/models/protocols/pure/v1/model/packageableElements/dataSpace/V1_DataSpace.ts",
+    "./src/models/protocols/pure/v1/transformation/pureGraph/V1_DSLDataSpace_GraphBuilderHelper.ts",
+    "./src/models/protocols/pure/v1/transformation/pureProtocol/V1_DSLDataSpace_ProtocolHelper.ts",
+    "./src/stores/studio/DataSpaceEditorState.ts",
+    "./src/components/studio/DSLDataSpace_StudioPlugin.tsx",
+    "./src/components/studio/DataSpaceEditor.tsx"
+  ],
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "src/**/*.json"
+  ],
+  "exclude": [
+    "src/**/__tests__/**/*.ts",
+    "src/**/__tests__/**/*.tsx",
+    "src/**/__mocks__/**/*.ts",
+    "src/**/__mocks__/**/*.tsx"
+  ]
+}

package/tsconfig.package.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "esnext",
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "importsNotUsedAsValues": "error",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/package.tsbuildinfo",
+    "rootDir": "./"
+  },
+  "files": [
+    "./package.json"
+  ],
+  "include": [
+    "package.json"
+  ],
+  "exclude": [
+    "lib"
+  ]
+}