Fix #21 : Add before commit MF/NF to verify context

Author: JelteMX

README.md

@@ -81,9 +81,10 @@ Verification can be done in two ways:
 
 ### 4. Events
 
-![configuration4](/assets/configuration4.png)
-
-- This microflow/nanoflow (can be used both) will be executed after a succesful upload. It will send the file object itself as an input parameter
+- Before commit:
+  - Microflow/Nanoflow that is executed before committing new files. It can be used to test out context object, to see if we need to commit it first (when associating the files with our context)
+- After commit:
+  - This microflow/nanoflow (can be used both) will be executed after a succesful upload. It will send the file object itself as an input parameter
 
 ### 5. UI
 

package.json

@@ -8,7 +8,7 @@
   "config": {
     "widgetPath": "./dist/MxTestProject/widgets",
     "projectPath": "./dist/MxTestProject/",
-    "mendixHost": "http://10.211.55.3:8080",
+    "mendixHost": "http://windows:8080",
     "developmentPort": "3000"
   },
   "packagePath": "com.mendix.widget.custom",

src/FileDropper.tsx

@@ -193,6 +193,11 @@ class FileDropperContainer extends Component<FileDropperContainerProps, {}> {
             return false;
         }
 
+        const beforeCommitAction = await this.executeBeforeCommit();
+        if (!beforeCommitAction) {
+            return false;
+        }
+
         try {
             obj = await createObject(dataFileEntity);
             if (dataContextAssociation !== "" && this.store.contextObject !== null) {
@@ -333,6 +338,25 @@ class FileDropperContainer extends Component<FileDropperContainerProps, {}> {
         return true;
     }
 
+    private async executeBeforeCommit(): Promise<boolean> {
+        const { eventsBeforeCommitMf, eventsBeforeCommitNf } = this.props;
+        const obj = this.store.contextObject;
+        if (obj && (eventsBeforeCommitMf !== "" || (eventsBeforeCommitNf && eventsBeforeCommitNf.nanoflow))) {
+            let action: Action = {};
+            if (eventsBeforeCommitMf !== "") {
+                action = {
+                    microflow: eventsBeforeCommitMf
+                };
+            } else if (eventsBeforeCommitNf && eventsBeforeCommitNf.nanoflow) {
+                action = {
+                    nanoflow: eventsBeforeCommitNf
+                };
+            }
+            return this.executeAction(action, true, obj) as Promise<boolean>;
+        }
+        return true;
+    }
+
     private async executeAfterCommit(obj: mendix.lib.MxObject): Promise<void> {
         const { eventsAfterCommitMf, eventsAfterCommitNf } = this.props;
         if (obj && (eventsAfterCommitMf !== "" || (eventsAfterCommitNf && eventsAfterCommitNf.nanoflow))) {

src/FileDropper.xml

@@ -151,16 +151,30 @@ Note 3: To avoid any other problem, make sure this helper object is detached fro
         <!-- EVENTS -->
 
         <propertyGroup caption="Events">
-            <property key="eventsAfterCommitMf" type="microflow" required="false" entityProperty="dataFileEntity">
-                <caption>After commit microflow</caption>
-                <description>After the file is succesfully committed, this microflow can be executed</description>
-                <returnType type="Void" />
-            </property>
-            <property key="eventsAfterCommitNf" type="nanoflow" required="false" entityProperty="dataFileEntity">
-                <caption>After commit nanoflow</caption>
-                <description>After the file is succesfully committed, this nanoflow can be executed</description>
-                <returnType type="Void" />
-            </property>
+            <propertyGroup caption="Before commit">
+                <property key="eventsBeforeCommitMf" type="microflow" required="false">
+                    <caption>Before commit microflow</caption>
+                    <description>Before committing any file, run this microflow. This can be used to verify the context object (needs to be committed before you can commit any file you associate with). It should return a boolean with True before it commits the files</description>
+                    <returnType type="Boolean" />
+                </property>
+                <property key="eventsBeforeCommitNf" type="nanoflow" required="false">
+                    <caption>Before commit nanoflow</caption>
+                    <description>Before committing any file, run this nanoflow. This can be used to verify the context object (needs to be committed before you can commit any file you associate with). It should return a boolean with True before it commits the files</description>
+                    <returnType type="Boolean" />
+                </property>
+            </propertyGroup>
+            <propertyGroup caption="After commit">
+                <property key="eventsAfterCommitMf" type="microflow" required="false" entityProperty="dataFileEntity">
+                    <caption>After commit microflow</caption>
+                    <description>After the file is succesfully committed, this microflow can be executed</description>
+                    <returnType type="Void" />
+                </property>
+                <property key="eventsAfterCommitNf" type="nanoflow" required="false" entityProperty="dataFileEntity">
+                    <caption>After commit nanoflow</caption>
+                    <description>After the file is succesfully committed, this nanoflow can be executed</description>
+                    <returnType type="Void" />
+                </property>
+            </propertyGroup>
         </propertyGroup>
 
         <!-- UI -->

typings/FileDropperProps.d.ts

@@ -51,6 +51,8 @@ export interface FileDropperContainerProps extends CommonProps {
 
     eventsAfterCommitMf: string;
     eventsAfterCommitNf: Nanoflow;
+    eventsBeforeCommitMf: string;
+    eventsBeforeCommitNf: Nanoflow;
 
     uiDeleteButtonStyle: TypeButtonStyle;
     uiDeleteButtonGlyph: string;