Merge pull request #6 from FlowSquad/fix/selection_bug

Fix #5: Plugin not working in Camunda Modeler v.4.8+

README.md

@@ -16,7 +16,7 @@ To use this plugin in your installation, follow these simple steps:
 2. Download the latest release artifact
 3. Extract it and put it inside the "resources/plugins" directory relative to your `{APP_DATA_DIRECTORY}` or `{USER_DATA_DIRECTORY}`.
 4. Restart the modeler
-5. Click Plugins > Choose Language and select the language of your choice  
+5. Click on the language dropdown in the toolbar and select the language of your choice
 
 ## Development
 
@@ -80,16 +80,13 @@ If you want to add a new language, follow these steps, after you set up your loc
    
    // ...
    ```
-5. Open the "menu/menu.js" file and add a new entry to it:
+5. Open the "config/I18NPlugin.js" file and add a new entry to the language options:
    ```javascript
    // ...
-   {
-       label: 'Français',
-       enabled: () => menuState.bpmn,
-       action: function () {
-           electronApp.emit('menu:action', 'language.changed', 'fr');
-       }
-   }
+   const options = [
+      // ...
+      {value: 'fr', label: 'Français'}
+   ]
    // ...
    ```
 6. Create a pull request to this repository and help us with adding new languages and improving the existing ones! :)
@@ -98,7 +95,7 @@ If you want to add a new language, follow these steps, after you set up your loc
 
 ```
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

client/i18n-extension/index.js → client/bpmnjs-i18n-extension/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ import translate from './translate';
  * Creates the plugin structure and tells the modeler, how to initialize it.
  */
 export default {
-  __init__: [ 'translate' ],
-  translate: [ 'type', translate ]
+    translateModule: translate,
+    __init__: ['translate'],
+    translate: ['type', translate]
 };

client/i18n-extension/languages/de.js → client/bpmnjs-i18n-extension/languages/de.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ export default {
     ...dmnJs,
     ...propertiesPanel,
     ...other
-};
+};

client/i18n-extension/languages/de/bpmn-js.js → client/bpmnjs-i18n-extension/languages/de/bpmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,4 +77,4 @@ export default {
     'unsupported bpmnElement for {plane}: {rootElement}': 'Nicht unterstütztes bpmnElement für {plane}: {rootElement}',
     'unrecognized flowElement {element} in context {context}': 'FlowElement {element} im Context {context} nicht erkannt',
     'HELLO {you}!': 'HALLO {you}!'
-};
+};

client/i18n-extension/languages/de/dmn-js.js → client/bpmnjs-i18n-extension/languages/de/dmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -78,4 +78,4 @@ export default {
     'Set Value': 'Wert setzen',
     'Strings must be in double quotes.': 'Strings müssen von doppelten Anführungszeichen umschlossen werden',
     'Type': 'Typ',
-};
+};

client/i18n-extension/languages/de/other.js → client/bpmnjs-i18n-extension/languages/de/other.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -93,4 +93,4 @@ export default {
     'Annotation': 'Annotation',
     'Output Expression': 'Output-Expression',
     'Data Type': 'Datentyp'
-}
+}

client/i18n-extension/languages/de/properties-panel.js → client/bpmnjs-i18n-extension/languages/de/properties-panel.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -199,4 +199,4 @@ export default {
     'Wait for Completion': 'Auf Abschluss warten',
     '[unknown template: {templateId}]': '[Unbekanntes Template: {templateId}]',
     '{label} must not contain whitespace': '{label} darf keine Leerzeichen enthalten'
-};
+};

client/i18n-extension/languages/en.js → client/bpmnjs-i18n-extension/languages/en.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ export default {
     ...dmnJs,
     ...propertiesPanel,
     ...other
-};
+};

client/i18n-extension/languages/en/bpmn-js.js → client/bpmnjs-i18n-extension/languages/en/bpmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,4 +77,4 @@ export default {
     'unsupported bpmnElement for {plane}: {rootElement}': 'unsupported bpmnElement for {plane}: {rootElement}',
     'unrecognized flowElement {element} in context {context}': 'unrecognized flowElement {element} in context {context}',
     'HELLO {you}!': 'HALLO {you}!'
-};
+};

client/i18n-extension/languages/en/dmn-js.js → client/bpmnjs-i18n-extension/languages/en/dmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -78,4 +78,4 @@ export default {
     'Set Value': 'Set Value',
     'Strings must be in double quotes.': 'Strings must be in double quotes.',
     'Type': 'Type',
-};
+};

client/i18n-extension/languages/en/other.js → client/bpmnjs-i18n-extension/languages/en/other.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -93,4 +93,4 @@ export default {
     'Annotation': 'Annotation',
     'Output Expression': 'Output Expression',
     'Data Type': 'Data Type'
-}
+}

client/i18n-extension/languages/en/properties-panel.js → client/bpmnjs-i18n-extension/languages/en/properties-panel.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -199,4 +199,4 @@ export default {
     'Wait for Completion': 'Wait for Completion',
     '[unknown template: {templateId}]': '[unknown template: {templateId}]',
     '{label} must not contain whitespace': '{label} darf keine Leerzeichen enthalten'
-};
+};

client/i18n-extension/languages/pt-br.js → client/bpmnjs-i18n-extension/languages/pt-br.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,8 +23,8 @@ import other from './pt-br/other';
  * Joins and exports the translated strings.
  */
 export default {
-  ...bpmnJs,
-  ...dmnJs,
-  ...propertiesPanel,
-  ...other
+    ...bpmnJs,
+    ...dmnJs,
+    ...propertiesPanel,
+    ...other
 };

client/i18n-extension/languages/pt-br/bpmn-js.js → client/bpmnjs-i18n-extension/languages/pt-br/bpmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

client/i18n-extension/languages/pt-br/dmn-js.js → client/bpmnjs-i18n-extension/languages/pt-br/dmn-js.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

client/i18n-extension/languages/pt-br/other.js → client/bpmnjs-i18n-extension/languages/pt-br/other.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

client/i18n-extension/languages/pt-br/properties-panel.js → client/bpmnjs-i18n-extension/languages/pt-br/properties-panel.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

client/i18n-extension/translate.js → client/bpmnjs-i18n-extension/translate.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020 FlowSquad GmbH
+ * Copyright 2021 FlowSquad GmbH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import {config} from '../configuration';
 import de from "./languages/de.js";
 import en from "./languages/en.js";
 import pt_br from "./languages/pt-br.js";
@@ -29,68 +28,28 @@ const languages = {
 // The default language to use if none is specified in the configuration
 const defaultLanguage = "en";
 
-// The key in the configuration that specifies the language
-const CONFIG_KEY = "editor_language";
-
-// The events to listen to / send
-const I18N_EVENT = "i18n.changed";
-const MENU_EVENT = "language.changed";
-const INIT_ACTION = "editorActions.init";
-const SELECTION_EVENT = "selection.changed";
 
 // Contains all missing translations discovered to prevent logging them
 // multiple times.
 const missing = [];
 
+console.log("Please help us translate by creating a pull request!");
+
 /**
  * This function initializes the translation plugin.
- *
- * @param eventBus The application's event bus
- * @return The translator function
  */
-export default function Translator(eventBus) {
-    let currentLanguage = languages[defaultLanguage];
-
-    // Read the language from configuration
-    config.get(CONFIG_KEY).then((language) => {
-
-        // Check if the specified language exists
-        if (languages[language] && language !== defaultLanguage) {
-
-            // Set the language as current
-            currentLanguage = languages[language];
-
-            // Notify parts of the application that the language has changed. Triggers a re-rendering.
-            eventBus.fire(I18N_EVENT);
-            eventBus.fire(SELECTION_EVENT, {newSelection: []});
-        }
-    });
-
-    // After the editor has initialized, register the menu listeners
-    eventBus.on(INIT_ACTION, function (event) {
-        const editorActions = event.editorActions;
-        editorActions.register(MENU_EVENT, function (language) {
-
-            // Persist the new language
-            config.set(CONFIG_KEY, language);
-
-            // Set the language as above
-            currentLanguage = languages[language];
-            eventBus.fire(I18N_EVENT);
-            eventBus.fire(SELECTION_EVENT, {newSelection: []});
-        });
-    });
+export default function Translator() {
+    let currentLanguage = languages[this.currentLanguage()];
 
     // Return the translation function. It takes the template string and the parameters,
     // translates it and returns it.
     return (template, parameters) => {
-
         // If the requested string is not available in the current language
         if (!currentLanguage[template]) {
             // Check if it was already printed to the console
             if (missing.indexOf(template) === -1) {
                 // Print the missing translation to the console ´
-                console.log("Missing translation: " + template, parameters);
+                console.log(`Missing translation: ${template}`);
                 missing.push(template);
             }
         }
@@ -100,10 +59,14 @@ export default function Translator(eventBus) {
 
         // Replace all parameters in the template string with the provided values
         return translation.replace(/{([^}]+)}/g, function (_, key) {
-            return (parameters || {})[key] || '{' + key + '}';
+            return (parameters || {})[key] || '{' + key + '}'
         });
     };
 };
 
+Translator.prototype.currentLanguage = function () {
+    return defaultLanguage;
+}
+
 // Specify what values should be injected into the function above
-Translator.$inject = ['eventBus'];
+Translator.$inject = [];

client/config/ConfigModal.js

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2021 FlowSquad GmbH
+ *
+ * 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 React from 'camunda-modeler-plugin-helpers/react';
+import {Modal} from 'camunda-modeler-plugin-helpers/components';
+
+const Title = Modal.Title || (({children}) => <h2>{children}</h2>);
+const Body = Modal.Body || (({children}) => <div>{children}</div>);
+const Footer = Modal.Footer || (({children}) => <div>{children}</div>);
+
+
+export default function ConfigModal({onClose}) {
+
+    return (<Modal onClose={onClose}>
+        <Title>
+            Language changed
+        </Title>
+        <Body>
+            <p>
+                Restart the modeler to apply the configuration.
+            </p>
+        </Body>
+        <Footer>
+            <div id="languageChangeButton">
+                <button type="button" class="btn btn-primary" onClick={() => onClose()}>Ok</button>
+            </div>
+        </Footer>
+    </Modal>);
+}
+