Unify plugin structure (#141)

* start reorganizing dataflow & qhana

* update imports for dataflow

* reorganize dataflow plugin

* update structure

* fix lint

* add template for plugin structure

* update doc

components/bpmn-q/modeler-component/editor/configurations/ConfigurationsUtil.js

@@ -1,6 +1,6 @@
 import * as configConsts from "./Constants";
 import { getBusinessObject } from "bpmn-js/lib/util/ModelUtil";
-import * as dataConsts from "../../extensions/data-extension/Constants";
+import * as dataConsts from "../../extensions/dataflow/Constants";
 import {
   addCamundaInputMapParameter,
   addCamundaOutputMapParameter,

components/bpmn-q/modeler-component/editor/plugin/PluginHandler.js

@@ -1,6 +1,6 @@
 import PlanQKPlugin from "../../extensions/planqk/PlanQKPlugin";
 import QuantMEPlugin from "../../extensions/quantme/QuantMEPlugin";
-import DataFlowPlugin from "../../extensions/data-extension/DataFlowPlugin";
+import DataFlowPlugin from "../../extensions/dataflow/DataFlowPlugin";
 import QHAnaPlugin from "../../extensions/qhana/QHAnaPlugin";
 import PatternPlugin from "../../extensions/pattern/PatternPlugin";
 import OpenTOSCAPlugin from "../../extensions/opentosca/OpenTOSCAPlugin";

components/bpmn-q/modeler-component/editor/ui/DeploymentButton.js

@@ -4,8 +4,8 @@ import { deployWorkflowToCamunda } from "../util/IoUtilities";
 import { getCamundaEndpoint } from "../config/EditorConfigManager";
 import { getRootProcess } from "../util/ModellingUtilities";
 import DeploymentSelectionModal from "./DeploymentSelectionModal";
+import { startDataFlowReplacementProcess } from "../../extensions/dataflow/replacement/DataFlowTransformator";
 import { startPlanqkReplacementProcess } from "../../extensions/planqk/replacement/PlanQKTransformator";
-import { startDataFlowReplacementProcess } from "../../extensions/data-extension/transformation/TransformationManager";
 import { checkEnabledStatus } from "../plugin/PluginHandler";
 import { pluginNames } from "../EditorConstants";
 

components/bpmn-q/modeler-component/extensions/data-extension/DataFlowPlugin.js → components/bpmn-q/modeler-component/extensions/dataflow/DataFlowPlugin.js

@@ -1,12 +1,13 @@
 import React from "react";
 
-import DataFlowExtensionModule from "./";
+import DataFlowExtensionModule from "./modeling";
 import TransformationButton from "../../editor/ui/TransformationButton";
-import { startDataFlowReplacementProcess } from "./transformation/TransformationManager";
-import TransformationTaskConfigurationsTab from "./transf-task-configs/TransformationTaskConfigurationsTab";
-import dataStyles from "./resources/data-flow-styles.css";
+import { startDataFlowReplacementProcess } from "./replacement/DataFlowTransformator";
+import DataFlowTab from "./configTabs/DataFlowTab";
+import dataStyles from "./resources/styling/data-flow-styles.css";
 import ExtensibleButton from "../../editor/ui/ExtensibleButton";
 import UpdateTransformationTaskConfigurationsButton from "./ui/UpdateTransformationConfigurations";
+import { getModeler } from "../../editor/ModelerHandler";
 
 let dataflowModdleDescriptor = require("./resources/data-flow-extension.json");
 
@@ -20,14 +21,14 @@ export default {
       subButtons={[<UpdateTransformationTaskConfigurationsButton />]}
       title="DataFlow"
       styleClass="dataflow-plugin-icon"
-      description="Show buttons of the QHAna plugin"
+      description="Show buttons of the DataFlow plugin"
     />,
   ],
   configTabs: [
     {
       tabId: "DataEndpointsTab",
       tabTitle: "Data Flow Plugin",
-      configTab: TransformationTaskConfigurationsTab,
+      configTab: DataFlowTab,
     },
   ],
   extensionModule: DataFlowExtensionModule,
@@ -37,7 +38,13 @@ export default {
     <TransformationButton
       name="DataFlow Transformation"
       transformWorkflow={async (xml) => {
-        return await startDataFlowReplacementProcess(xml);
+        let modeler = getModeler();
+        // Initialize 'views' as an empty object if it's undefined
+        let views = modeler.views || {};
+        let transformedXml = await startDataFlowReplacementProcess(xml);
+        modeler.views = views;
+
+        return transformedXml;
       }}
     />
   ),

components/bpmn-q/modeler-component/extensions/data-extension/transf-task-configs/TransformationTaskConfigurationsTab.js → components/bpmn-q/modeler-component/extensions/dataflow/configTabs/DataFlowTab.js

@@ -1,20 +1,20 @@
 import React, { useState } from "react";
 import { getModeler } from "../../../editor/ModelerHandler";
-import * as dataConfigManager from "../config/DataConfigManager";
+import * as dataConfigManager from "../framework-config/DataConfigManager";
 
 /**
  * React component representing a tab for the configuration modal of the editor.
  *
  * @return {JSX.Element} The config tab
  * @constructor
  */
-export default function TransformationTaskConfigurationsTab() {
+export default function DataFlowTab() {
   const [configurationsEndpoint, setConfigurationsEndpoint] = useState(
     dataConfigManager.getConfigurationsEndpoint()
   );
 
   // save changed endpoint url if the modal is closed
-  TransformationTaskConfigurationsTab.prototype.onClose = () => {
+  DataFlowTab.prototype.onClose = () => {
     dataConfigManager.setConfigurationsEndpoint(configurationsEndpoint);
   };
 
@@ -43,7 +43,7 @@ export default function TransformationTaskConfigurationsTab() {
   );
 }
 
-TransformationTaskConfigurationsTab.prototype.config = () => {
+DataFlowTab.prototype.config = () => {
   const modeler = getModeler();
 
   modeler.config.transformationTaskConfigurationsEndpointChanged =

components/bpmn-q/modeler-component/extensions/data-extension/transf-task-configs/TransformationTaskConfigurations.js → components/bpmn-q/modeler-component/extensions/dataflow/configurations/TransformationTaskConfigurations.js

@@ -1,6 +1,6 @@
 import ConfigurationsEndpoint from "../../../editor/configurations/ConfigurationEndpoint";
 import * as consts from "../Constants";
-import * as dataConfig from "../config/DataConfigManager";
+import * as dataConfig from "../framework-config/DataConfigManager";
 
 /**
  * Configurations Endpoint Wrapper for loading configurations for transformation tasks.

components/bpmn-q/modeler-component/extensions/data-extension/menu/DataFlowReplaceMenuProvider.js → components/bpmn-q/modeler-component/extensions/dataflow/modeling/DataFlowReplaceMenuProvider.js

@@ -7,7 +7,7 @@ import {
 } from "../../../editor/util/PopupMenuUtilities";
 import * as consts from "../Constants";
 import { createConfigurationsEntries } from "../../../editor/configurations/ConfigurationsUtil";
-import { getTransformationTaskConfigurations } from "../transf-task-configs/TransformationTaskConfigurations";
+import { getTransformationTaskConfigurations } from "../configurations/TransformationTaskConfigurations";
 import { replaceConnection } from "../../../editor/util/ModellingUtilities";
 import { filter } from "min-dash";
 import { isDifferentType } from "bpmn-js/lib/features/popup-menu/util/TypeUtil";

components/bpmn-q/modeler-component/extensions/data-extension/index.js → components/bpmn-q/modeler-component/extensions/dataflow/modeling/index.js

@@ -1,8 +1,8 @@
-import DataFlowRenderer from "./rendering/DataFlowRenderer";
-import DataFlowReplaceMenuProvider from "./menu/DataFlowReplaceMenuProvider";
-import DataFlowPaletteProvider from "./palette/DataFlowPaletteProvider";
-import DataFlowRulesProvider from "./rules/DataFlowRulesProvider";
-import DataReplaceConnectionBehavior from "./rules/DataReplaceConnectionBehaviour";
+import DataFlowRenderer from "./DataFlowRenderer";
+import DataFlowReplaceMenuProvider from "./DataFlowReplaceMenuProvider";
+import DataFlowPaletteProvider from "./DataFlowPaletteProvider";
+import DataFlowRulesProvider from "./DataFlowRulesProvider";
+import DataReplaceConnectionBehavior from "./DataReplaceConnectionBehaviour";
 import DataFlowPropertiesProvider from "./properties-panel/DataFlowPropertiesProvider";
 
 export default {

components/bpmn-q/modeler-component/extensions/data-extension/properties-panel/DataFlowPropertiesProvider.js → components/bpmn-q/modeler-component/extensions/dataflow/modeling/properties-panel/DataFlowPropertiesProvider.js

@@ -1,10 +1,10 @@
 import keyValueMap from "./KeyValueMap";
 import { is } from "bpmn-js/lib/util/ModelUtil";
 import { ListGroup } from "@bpmn-io/properties-panel";
-import * as consts from "../Constants";
-import * as configConsts from "../../../editor/configurations/Constants";
-import ConfigurationsProperties from "../../../editor/configurations/ConfigurationsProperties";
-import { getTransformationTaskConfiguration } from "../transf-task-configs/TransformationTaskConfigurations";
+import * as consts from "../../Constants";
+import * as configConsts from "../../../../editor/configurations/Constants";
+import ConfigurationsProperties from "../../../../editor/configurations/ConfigurationsProperties";
+import { getTransformationTaskConfiguration } from "../../configurations/TransformationTaskConfigurations";
 
 const LOW_PRIORITY = 500;
 

components/bpmn-q/modeler-component/extensions/data-extension/properties-panel/KeyValueMap.js → components/bpmn-q/modeler-component/extensions/dataflow/modeling/properties-panel/KeyValueMap.js

@@ -1,8 +1,8 @@
 import { getBusinessObject } from "bpmn-js/lib/util/ModelUtil";
 import KeyValueEntry from "./KeyValueEntry";
 import { without } from "min-dash";
-import * as consts from "../Constants";
-import { nextId } from "../../../editor/util/camunda-utils/ElementUtil";
+import * as consts from "../../Constants";
+import { nextId } from "../../../../editor/util/camunda-utils/ElementUtil";
 
 /**
  *  Entry of the properties panel which displays a key value map. Entries can be added or removed over the UI of the

components/bpmn-q/modeler-component/extensions/data-extension/resources/data-flow-styles.css → components/bpmn-q/modeler-component/extensions/dataflow/resources/styling/data-flow-styles.css

@@ -3,7 +3,7 @@
   width: 5px;
   height: 5px;
   background-size: contain;
-  background-image: url("../resources/icons/change-exchange-icon.svg");
+  background-image: url("../icons/change-exchange-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -19,7 +19,7 @@
   width: 30px;
   height: 30px;
   background-size: contain;
-  background-image: url("../resources/icons/data-store-map-icon.svg");
+  background-image: url("../icons/data-store-map-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -35,7 +35,7 @@
   width: 10px;
   height: 10px;
   background-size: contain;
-  background-image: url("../resources/icons/data-map-object-icon.svg");
+  background-image: url("../icons/data-map-object-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
 }
@@ -45,7 +45,7 @@
   width: 10px;
   height: 10px;
   background-size: contain;
-  background-image: url("../resources/icons/data-map-object-icon.svg");
+  background-image: url("../icons/data-map-object-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
 }
@@ -59,7 +59,7 @@
   width: 12px;
   height: 12px;
   background-size: contain;
-  background-image: url("../resources/icons/transformation-task.svg");
+  background-image: url("../icons/transformation-task.svg");
   background-repeat: no-repeat;
   display: inline-block;
   transform: scale(0.6);
@@ -72,7 +72,7 @@
 .dataflow-data-store-map-task-palette-icon {
   content: "";
   background-size: contain;
-  background-image: url("../resources/icons/data-store-map-icon.svg");
+  background-image: url("../icons/data-store-map-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
   transform: scale(0.6);
@@ -85,7 +85,7 @@
 .dataflow-data-map-object-palette-icon {
   content: "";
   background-size: contain;
-  background-image: url("../resources/icons/data-map-object-icon.svg");
+  background-image: url("../icons/data-map-object-icon.svg");
   background-repeat: no-repeat;
   transform: scale(0.8);
 }
@@ -99,7 +99,7 @@
   width: 20px;
   height: 20px;
   background-size: contain;
-  background-image: url("../resources/icons/transformation-association-icon.svg");
+  background-image: url("../icons/transformation-association-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -111,7 +111,7 @@
   width: 20px;
   height: 20px;
   background-size: contain;
-  background-image: url("../resources/icons/data-association.svg");
+  background-image: url("../icons/data-association.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -123,7 +123,7 @@
   width: 15px;
   height: 15px;
   background-size: contain;
-  background-image: url("./icons/structure-diagram-icon-or.svg");
+  background-image: url("../icons/structure-diagram-icon-or.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -135,7 +135,7 @@
   width: 15px;
   height: 15px;
   background-size: contain;
-  background-image: url("./icons/update-icon.svg");
+  background-image: url("../icons/update-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
   float: left;
@@ -147,7 +147,7 @@
   width: 5px;
   height: 5px;
   background-size: contain;
-  background-image: url("../resources/icons/transformation-task.svg");
+  background-image: url("../icons/transformation-task.svg");
   background-repeat: no-repeat;
   display: inline-block;
 }
@@ -157,7 +157,7 @@
   width: 5px;
   height: 5px;
   background-size: contain;
-  background-image: url("../resources/icons/change-exchange-icon.svg");
+  background-image: url("../icons/change-exchange-icon.svg");
   background-repeat: no-repeat;
   display: inline-block;
 }

components/bpmn-q/modeler-component/extensions/data-extension/ui/UpdateTransformationConfigurations.js → components/bpmn-q/modeler-component/extensions/dataflow/ui/UpdateTransformationConfigurations.js

@@ -1,5 +1,5 @@
 import React from "react";
-import { updateTransformationTaskConfigurations } from "../transf-task-configs/TransformationTaskConfigurations";
+import { updateTransformationTaskConfigurations } from "../configurations/TransformationTaskConfigurations";
 
 /**
  * React button component which updates the transformation task configurations when clicked.

components/bpmn-q/modeler-component/extensions/opentosca/OpenTOSCAPlugin.js

@@ -2,7 +2,7 @@ import React from "react";
 
 import OpenTOSCAConfigTab from "./configTabs/OpenTOSCAConfigTab";
 
-import OpenTOSCAStyles from "./styling/opentosca.css";
+import OpenTOSCAStyles from "./resources/styling/opentosca.css";
 import DeploymentPlugin from "./ui/deployment/services/DeploymentPlugin";
 import OpenTOSCAExtensionModule from "./modeling";
 let OpenTOSCAModdleExtension = require("./resources/opentosca4bpmn.json");

components/bpmn-q/modeler-component/extensions/opentosca/modeling/OpenTOSCARenderer.js

@@ -16,7 +16,7 @@ import { createLine } from "diagram-js/lib/util/RenderUtil";
 import BpmnRenderer from "bpmn-js/lib/draw/BpmnRenderer";
 import { getOrientation } from "diagram-js/lib/layout/LayoutUtil";
 
-import buttonIcon from "../resources/show-deployment-button.svg?raw";
+import buttonIcon from "../resources/icons/show-deployment-button.svg?raw";
 import { drawTaskSVG } from "../../../editor/util/RenderUtilities";
 import NotificationHandler from "../../../editor/ui/notifications/NotificationHandler";
 import {