oro-sdk-apis 1.47.0 → 1.48.0

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.47.0",
+    "version": "1.48.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/workflow.ts

@@ -78,9 +78,45 @@ export interface EntryData {
     summaryHidden?: boolean
     className?: string
     /**
-     * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed.
+     * This field represents a list of `selectedAnswers` that must be set for this entry to be displayed using the followng logical combination 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 ]
+     * ]
+     * ```
      */
-    triggers?: string[]
+    triggers?: string[][] | string[] | string
     /**
      * This field represents a list of `StateTrigger` that must be fulfilled for this entry to be displayed.
      */
@@ -130,7 +166,7 @@ export interface ImagesAliasQuestionOptions {
     /**
      * Should display photo guide instructions or not
      */
-     photoGuide?: boolean
+    photoGuide?: boolean
 }
 
 export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>, O = undefined> extends EntryData {
@@ -167,12 +203,14 @@ export declare type QuestionData =
           | 'place-address'
       >
     | GenericQuestionData<'images-alias', IndexedData<ChoiceInputData>, ImagesAliasQuestionOptions>
-    | GenericQuestionData<'checkbox-group' | 'hair-loss-frontal' | 'select' | 'multiple' | 'text-select-group', IndexedData<ChoiceInputData>>
-    | GroupedGenericQuestionData<'radio'
-        | 'hair-selector-women'
-        | 'hair-selector-men'
-        | 'hair-loss-stage', 
-        IndexedData<RadioInputData>>
+    | GenericQuestionData<
+          'checkbox-group' | 'hair-loss-frontal' | 'select' | 'multiple' | 'text-select-group',
+          IndexedData<ChoiceInputData>
+      >
+    | GroupedGenericQuestionData<
+          'radio' | 'hair-selector-women' | 'hair-selector-men' | 'hair-loss-stage',
+          IndexedData<RadioInputData>
+      >
     | GroupedGenericQuestionData<'radio-card' | 'profile-selector', IndexedData<RadioCardInputData>>
     | GroupedGenericQuestionData<'language-picker', IndexedData<LanguagePickerData>>
 
@@ -258,4 +296,4 @@ export interface PopulatedWorkflowData {
     workflowCreatedAt: string // The workflow version
     locale?: string
     fields: Record<string, PopulatedWorkflowField> // key corresponds to the QuestionData key in the workflow
-}
+}