oro-sdk 3.10.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