oro-sdk 3.12.0 → 3.13.0

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "3.12.0",
+    "version": "3.13.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [
@@ -54,8 +54,8 @@
         "form-data": "^4.0.0",
         "formdata-node": "^4.3.1",
         "idb-keyval": "^5.0.6",
-        "oro-sdk-apis": "1.47.0",
+        "oro-sdk-apis": "1.48.0",
         "oro-toolbox": "0.0.6",
         "uuid": "^8.3.2"
     }
-}
+}

package/src/helpers/workflow.ts

@@ -179,13 +179,71 @@ async function populateWorkflowField(
     })
 }
 
-export function isTriggered(triggers: string[], answers: string[]): boolean {
-    for (let trigger of triggers) {
-        if (!answers.includes(trigger)) {
-            return false
+/**
+ * Determine if a question is triggered by some answers
+ *
+ * We use the following logical combinations of rules:
+ *
+ * #### Single string
+ *
+ * ```
+ * // Required: rule1
+ * rules: rule1
+ * ```
+ *
+ * #### Array of strings (AND is applied between statements):
+ *
+ * ```
+ * // Required: rule1 AND rule2
+ * rules: [ rule1, rule2 ]
+ * ```
+ *
+ * #### Array of arrays of strings (OR is applied between inner arrays. AND is applied between inner arrays statements)
+ *
+ * ```
+ * // Required: rule1 OR rule2
+ * rules: [
+ *   [ rule1 ],
+ *   [ rule2 ]
+ * ]
+ *
+ * // Required: rule1 OR (rule2 AND rule3)
+ * rules: [
+ *   [ rule1 ],
+ *   [ rule2, rule3 ]
+ * ]
+ *
+ * // THIS IS FORBIDDEN
+ * rules: [
+ *   rule1, // <-- THIS IS FORBIDDEN. Instead use [ rule1 ]
+ *   [ rule2, rule3 ]
+ * ]
+ * ```
+ *
+ * @param triggers the triggering rules
+ * @param answers the answers to check againts triggering rules
+ * @returns `true` if triggers are verified against ansers. Otherwise, returns `false`.
+ * @throws an Error if triggers typing is wrong
+ */
+export function isTriggered(triggers: string[][] | string[] | string, answers: string[]): boolean {
+    // is triggers contained in answers
+    if (typeof triggers === 'string') {
+        return answers.includes(triggers)
+    }
+
+    if (Array.isArray(triggers)) {
+        // rule combination kind: rule1 OR (rule2 AND rule3)
+        if (Array.isArray(triggers[0])) {
+            return (triggers as string[][]).some((subSetTriggers) =>
+                subSetTriggers.every((trigger) => answers.includes(trigger))
+            )
+        } else {
+            // rule combination kind: rule1 AND rule2
+            return (triggers as string[]).every((trigger) => answers.includes(trigger))
         }
     }
-    return true
+
+    throw Error('[isTriggered] triggers is not typed well')
 }
 
 export function flattenSelectedAnswers(answers: SelectedAnswersData) {