oro-sdk 3.12.0 → 3.13.0

package/dist/helpers/workflow.d.ts

@@ -11,7 +11,53 @@ export declare function filterTriggeredAnsweredWithKind(workflowData: WorkflowDa
  */
 export declare function getWorkflowDataByCategory(workflowData: WorkflowData, category: MetadataCategory): Promise<PopulatedWorkflowData>;
 export declare function getImagesFromIndexDb(answer: SelectedAnswerData): Promise<WorkflowUploadedImage[]>;
-export declare function isTriggered(triggers: string[], answers: string[]): boolean;
+/**
+ * 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 declare function isTriggered(triggers: string[][] | string[] | string, answers: string[]): boolean;
 export declare function flattenSelectedAnswers(answers: SelectedAnswersData): string[];
 /**
  * This function helps you to get a valid workflow selectedAnswers structure

package/dist/oro-sdk.cjs.development.js

@@ -982,6 +982,53 @@ function _getImagesFromIndexDb() {
 function populateWorkflowField(_x6, _x7) {
   return _populateWorkflowField.apply(this, arguments);
 }
+/**
+ * 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
+ */
+
 
 function _populateWorkflowField() {
   _populateWorkflowField = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(question, answerValue) {
@@ -1060,21 +1107,34 @@ function _populateWorkflowField() {
 }
 
 function isTriggered(triggers, answers) {
-  for (var _iterator = _createForOfIteratorHelperLoose(triggers), _step; !(_step = _iterator()).done;) {
-    var trigger = _step.value;
+  // is triggers contained in answers
+  if (typeof triggers === 'string') {
+    return answers.includes(triggers);
+  }
 
-    if (!answers.includes(trigger)) {
-      return false;
+  if (Array.isArray(triggers)) {
+    // rule combination kind: rule1 OR (rule2 AND rule3)
+    if (Array.isArray(triggers[0])) {
+      return triggers.some(function (subSetTriggers) {
+        return subSetTriggers.every(function (trigger) {
+          return answers.includes(trigger);
+        });
+      });
+    } else {
+      // rule combination kind: rule1 AND rule2
+      return triggers.every(function (trigger) {
+        return answers.includes(trigger);
+      });
     }
   }
 
-  return true;
+  throw Error('[isTriggered] triggers is not typed well');
 }
 function flattenSelectedAnswers(answers) {
   var linearAnswers = [];
 
-  for (var _iterator2 = _createForOfIteratorHelperLoose(answers), _step2; !(_step2 = _iterator2()).done;) {
-    var answer = _step2.value;
+  for (var _iterator = _createForOfIteratorHelperLoose(answers), _step; !(_step = _iterator()).done;) {
+    var answer = _step.value;
     linearAnswers.push.apply(linearAnswers, Object.values(answer));
   }