npm - @oneblink/sdk-core - Versions diffs - 9.2.2 → 10.0.0-beta.2 - Mend

@oneblink/sdk-core 9.2.2 → 10.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/dist/conditionalLogicService/generateFormElementsConditionallyShown.d.ts CHANGED Viewed

@@ -23,16 +23,22 @@ export type FormElementsConditionallyShownParameters = {
     submission: SubmissionTypes.S3SubmissionData['submission'];
     /** Optional callback for handling errors caught during the evaluation */
     errorCallback?: ErrorCallback;
+    /** Conditionally enable form submission based on predicates */
+    enableSubmission: FormTypes.Form['enableSubmission'] | undefined;
+};
+export type FormElementsConditionallyShownResult = {
+    formElementsConditionallyShown: FormElementsConditionallyShown;
+    isSubmissionEnabled: boolean;
 };
 /**
- * Given a form element and submission data, evaluate which elements are
- * currently shown. The function also takes an optional errorCallback for
- * handling errors caught during the evaluation.
+ * Given form elements and submission data, evaluate which elements are
+ * currently shown and whether submission is enabled. The function also takes an
+ * optional errorCallback for handling errors caught during the evaluation.
  *
  * #### Example
  *
  * ```js
- * const formElementsConditionallyShown =
+ * const { formElementsConditionallyShown, isSubmissionEnabled } =
  *   conditionalLogicService.generateFormElementsConditionallyShown({
  *     submission: {
  *       radio: ['hide'],
@@ -85,7 +91,6 @@ export type FormElementsConditionallyShownParameters = {
  *         isElementLookup: false,
  *       },
  *     ],
- *     parentFormElementsCtrl: undefined,
  *     errorCallback: (error) => {
  *       //do something with the error here
  *       console.error(error)
@@ -97,18 +102,21 @@ export type FormElementsConditionallyShownParameters = {
  *
  * ```json
  * {
- *   "radio": {
- *     "isHidden": false,
- *     "type": "formElement"
+ *   "formElementsConditionallyShown": {
+ *     "radio": {
+ *       "isHidden": false,
+ *       "type": "formElement"
+ *     },
+ *     "text": {
+ *       "isHidden": true,
+ *       "type": "formElement"
+ *     }
  *   },
- *   "text": {
- *     "isHidden": true,
- *     "type": "formElement"
- *   }
+ *   "isSubmissionEnabled": true
  * }
  * ```
  *
  * @param parameters
  * @returns
  */
-export declare function generateFormElementsConditionallyShown(parameters: FormElementsConditionallyShownParameters): FormElementsConditionallyShown;
+export declare function generateFormElementsConditionallyShown({ formElements, submission, errorCallback, enableSubmission, }: FormElementsConditionallyShownParameters): FormElementsConditionallyShownResult;

package/dist/conditionalLogicService/generateFormElementsConditionallyShown.js CHANGED Viewed

@@ -2,18 +2,28 @@ import { flattenFormElements } from '../formElementsService.js';
 import conditionallyShowElement from './conditionallyShowElement.js';
 import conditionallyShowOption from './conditionallyShowOption.js';
 import { typeCastService } from '../index.js';
-const handleConditionallyShowElement = (formElementsCtrl, element, errorCallback) => {
+import evaluateFormElementConditionalPredicate from './evaluateFormElementConditionalPredicate.js';
+const handleConditionallyShowElement = ({ formElementsCtrl, element, errorCallback, }) => {
     try {
-        return conditionallyShowElement(formElementsCtrl, element, []);
+        return conditionallyShowElement({
+            formElementsCtrl,
+            elementToEvaluate: element,
+            elementsEvaluated: [],
+        });
     }
     catch (error) {
         errorCallback?.(error);
         return false;
     }
 };
-const handleConditionallyShowOption = (formElementsCtrl, element, option, errorCallback) => {
+const handleConditionallyShowOption = ({ formElementsCtrl, element, option, errorCallback, }) => {
     try {
-        return conditionallyShowOption(formElementsCtrl, element, option, []);
+        return conditionallyShowOption({
+            formElementsCtrl,
+            elementToEvaluate: element,
+            optionToEvaluate: option,
+            optionsEvaluated: [],
+        });
     }
     catch (error) {
         errorCallback?.(error);
@@ -33,7 +43,11 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
                 const formElementConditionallyShown = formElementsConditionallyShown[element.id];
                 const isHidden = formElementConditionallyShown
                     ? formElementConditionallyShown.isHidden
-                    : !handleConditionallyShowElement(formElementsCtrl, element, errorCallback);
+                    : !handleConditionallyShowElement({
+                        formElementsCtrl,
+                        element,
+                        errorCallback,
+                    });
                 formElementsConditionallyShown[element.id] = {
                     type: 'formElement',
                     isHidden,
@@ -69,11 +83,16 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
                 const nestedModel = submission[element.name];
                 formElementsConditionallyShown[element.name] = {
                     type: 'formElements',
-                    isHidden: !handleConditionallyShowElement(formElementsCtrl, element, errorCallback),
+                    isHidden: !handleConditionallyShowElement({
+                        formElementsCtrl,
+                        element,
+                        errorCallback,
+                    }),
                     formElements: generateFormElementsConditionallyShownWithParent({
                         formElements: element.elements || [],
                         submission: nestedModel || {},
                         parentFormElementsCtrl: formElementsCtrl,
+                        errorCallback,
                     }),
                 };
                 break;
@@ -85,13 +104,18 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
                 const entries = formElementsCtrl.model?.[element.name];
                 formElementsConditionallyShown[element.name] = {
                     type: 'repeatableSet',
-                    isHidden: !handleConditionallyShowElement(formElementsCtrl, element, errorCallback),
+                    isHidden: !handleConditionallyShowElement({
+                        formElementsCtrl,
+                        element,
+                        errorCallback,
+                    }),
                     entries: (entries || []).reduce((result, entry, index) => {
                         result[index.toString()] =
                             generateFormElementsConditionallyShownWithParent({
                                 formElements: element.elements,
                                 submission: entry,
                                 parentFormElementsCtrl: formElementsCtrl,
+                                errorCallback,
                             });
                         return result;
                     }, {}),
@@ -104,7 +128,11 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
                 }
                 const formElementConditionallyShown = {
                     type: 'formElement',
-                    isHidden: !handleConditionallyShowElement(formElementsCtrl, element, errorCallback),
+                    isHidden: !handleConditionallyShowElement({
+                        formElementsCtrl,
+                        element,
+                        errorCallback,
+                    }),
                 };
                 if (!formElementConditionallyShown.isHidden) {
                     const optionsElement = typeCastService.formElements.toOptionsElement(element);
@@ -113,7 +141,12 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
                         Array.isArray(optionsElement.options)) {
                         const newOptions = [];
                         for (const option of optionsElement.options) {
-                            const optionPredicatesResult = handleConditionallyShowOption(formElementsCtrl, optionsElement, option, errorCallback);
+                            const optionPredicatesResult = handleConditionallyShowOption({
+                                formElementsCtrl,
+                                element: optionsElement,
+                                option,
+                                errorCallback,
+                            });
                             switch (optionPredicatesResult) {
                                 case 'SHOW': {
                                     newOptions.push(option);
@@ -141,14 +174,14 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
     }, {});
 };
 /**
- * Given a form element and submission data, evaluate which elements are
- * currently shown. The function also takes an optional errorCallback for
- * handling errors caught during the evaluation.
+ * Given form elements and submission data, evaluate which elements are
+ * currently shown and whether submission is enabled. The function also takes an
+ * optional errorCallback for handling errors caught during the evaluation.
  *
  * #### Example
  *
  * ```js
- * const formElementsConditionallyShown =
+ * const { formElementsConditionallyShown, isSubmissionEnabled } =
  *   conditionalLogicService.generateFormElementsConditionallyShown({
  *     submission: {
  *       radio: ['hide'],
@@ -201,7 +234,6 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
  *         isElementLookup: false,
  *       },
  *     ],
- *     parentFormElementsCtrl: undefined,
  *     errorCallback: (error) => {
  *       //do something with the error here
  *       console.error(error)
@@ -213,21 +245,65 @@ const generateFormElementsConditionallyShownWithParent = ({ formElements, submis
  *
  * ```json
  * {
- *   "radio": {
- *     "isHidden": false,
- *     "type": "formElement"
+ *   "formElementsConditionallyShown": {
+ *     "radio": {
+ *       "isHidden": false,
+ *       "type": "formElement"
+ *     },
+ *     "text": {
+ *       "isHidden": true,
+ *       "type": "formElement"
+ *     }
  *   },
- *   "text": {
- *     "isHidden": true,
- *     "type": "formElement"
- *   }
+ *   "isSubmissionEnabled": true
  * }
  * ```
  *
  * @param parameters
  * @returns
  */
-export function generateFormElementsConditionallyShown(parameters) {
-    return generateFormElementsConditionallyShownWithParent(parameters);
+export function generateFormElementsConditionallyShown({ formElements, submission, errorCallback, enableSubmission, }) {
+    const formElementsConditionallyShown = generateFormElementsConditionallyShownWithParent({
+        formElements,
+        submission,
+        errorCallback,
+        parentFormElementsCtrl: undefined,
+    });
+    if (!enableSubmission?.conditionalPredicates.length) {
+        return {
+            formElementsConditionallyShown,
+            isSubmissionEnabled: true,
+        };
+    }
+    const formElementsCtrl = {
+        flattenedElements: flattenFormElements(formElements),
+        model: submission,
+    };
+    const predicateFn = (predicate) => {
+        try {
+            const predicateElement = evaluateFormElementConditionalPredicate({
+                predicate,
+                formElementsCtrl,
+            });
+            if (!predicateElement) {
+                return false;
+            }
+            // Reuse visibility already computed above instead of re-evaluating
+            // conditionally show predicates for the predicate element / parents.
+            const shown = formElementsConditionallyShown[predicateElement.name];
+            return !!shown && !shown.isHidden;
+        }
+        catch (error) {
+            errorCallback?.(error);
+            return false;
+        }
+    };
+    const isSubmissionEnabled = enableSubmission.requiresAllConditionalPredicates
+        ? enableSubmission.conditionalPredicates.every(predicateFn)
+        : enableSubmission.conditionalPredicates.some(predicateFn);
+    return {
+        formElementsConditionallyShown,
+        isSubmissionEnabled,
+    };
 }
 //# sourceMappingURL=generateFormElementsConditionallyShown.js.map

package/dist/conditionalLogicService/generateFormElementsConditionallyShown.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"generateFormElementsConditionallyShown.js","sourceRoot":"","sources":["../../src/conditionalLogicService/generateFormElementsConditionallyShown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,wBAAwB,MAAM,+BAA+B,CAAA;AACpE,OAAO,uBAEN,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AA8B7C,MAAM,8BAA8B,GAAG,CACrC,gBAAkC,EAClC,OAA8B,EAC9B,aAAwC,EACxC,EAAE;IACF,IAAI,CAAC;QACH,OAAO,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,EAAE,CAAC,KAAc,CAAC,CAAA;QAC/B,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CACpC,gBAAkC,EAClC,OAAyC,EACzC,MAAqC,EACrC,aAAwC,EACtB,EAAE;IACpB,IAAI,CAAC;QACH,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;IACvE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,EAAE,CAAC,KAAc,CAAC,CAAA;QAC/B,OAAO,MAAM,CAAA;IACf,CAAC;AACH,CAAC,CAAA;AAWD,MAAM,gDAAgD,GAAG,CAAC,EACxD,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,aAAa,GAGd,EAAkC,EAAE;IACnC,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,mBAAmB,CAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;QACjB,sBAAsB;KACvB,CAAA;IACD,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAC9C,CAAC,8BAA8B,EAAE,OAAO,EAAE,EAAE;QAC1C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,6BAA6B,GACjC,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC5C,MAAM,QAAQ,GAAG,6BAA6B;oBAC5C,CAAC,CAAC,6BAA6B,CAAC,QAAQ;oBACxC,CAAC,CAAC,CAAC,8BAA8B,CAC7B,gBAAgB,EAChB,OAAO,EACP,aAAa,CACd,CAAA;gBAEL,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG;oBAC3C,IAAI,EAAE,aAAa;oBACnB,QAAQ;iBACT,CAAA;gBAED,+DAA+D;gBAC/D,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;wBACxC,QAAQ,YAAY,CAAC,IAAI,EAAE,CAAC;4BAC1B,KAAK,SAAS,CAAC;4BACf,KAAK,MAAM,CAAC,CAAC,CAAC;gCACZ,8BAA8B,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG;oCAChD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;gCACD,MAAK;4BACP,CAAC;4BACD,OAAO,CAAC,CAAC,CAAC;gCACR,8BAA8B,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG;oCAClD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC;gBACD,MAAK;YACP,CAAC;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAE9B,CAAA;gBACb,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBAC7C,IAAI,EAAE,cAAc;oBACpB,QAAQ,EAAE,CAAC,8BAA8B,CACvC,gBAAgB,EAChB,OAAO,EACP,aAAa,CACd;oBACD,YAAY,EAAE,gDAAgD,CAAC;wBAC7D,YAAY,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;wBACpC,UAAU,EAAE,WAAW,IAAI,EAAE;wBAC7B,sBAAsB,EAAE,gBAAgB;qBACzC,CAAC;iBACH,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,IAAI,CAExC,CAAA;gBACb,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBAC7C,IAAI,EAAE,eAAe;oBACrB,QAAQ,EAAE,CAAC,8BAA8B,CACvC,gBAAgB,EAChB,OAAO,EACP,aAAa,CACd;oBACD,OAAO,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAC7B,CACE,MAGC,EACD,KAAK,EACL,KAAK,EACL,EAAE;wBACF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;4BACtB,gDAAgD,CAAC;gCAC/C,YAAY,EAAE,OAAO,CAAC,QAAQ;gCAC9B,UAAU,EAAE,KAAK;gCACjB,sBAAsB,EAAE,gBAAgB;6BACzC,CAAC,CAAA;wBACJ,OAAO,MAAM,CAAA;oBACf,CAAC,EACD,EAAE,CACH;iBACF,CAAA;gBACD,MAAK;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,6BAA6B,GAAkC;oBACnE,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,CAAC,8BAA8B,CACvC,gBAAgB,EAChB,OAAO,EACP,aAAa,CACd;iBACF,CAAA;gBAED,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,CAAC;oBAC5C,MAAM,cAAc,GAClB,eAAe,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;oBACxD,IACE,cAAc;wBACd,cAAc,CAAC,wBAAwB;wBACvC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,EACrC,CAAC;wBACD,MAAM,UAAU,GAAG,EAAE,CAAA;wBACrB,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;4BAC5C,MAAM,sBAAsB,GAAG,6BAA6B,CAC1D,gBAAgB,EAChB,cAAc,EACd,MAAM,EACN,aAAa,CACd,CAAA;4BACD,QAAQ,sBAAsB,EAAE,CAAC;gCAC/B,KAAK,MAAM,CAAC,CAAC,CAAC;oCACZ,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oCACvB,MAAK;gCACP,CAAC;gCACD,KAAK,2BAA2B,CAAC,CAAC,CAAC;oCACjC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oCACvB,6BAA6B,CAAC,mBAAmB,GAAG,IAAI,CAAA;oCACxD,MAAK;gCACP,CAAC;gCACD,KAAK,4BAA4B,CAAC,CAAC,CAAC;oCAClC,6BAA6B,CAAC,mBAAmB,GAAG,IAAI,CAAA;oCACxD,MAAK;gCACP,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,6BAA6B,CAAC,OAAO,GAAG,UAAU,CAAA;oBACpD,CAAC;gBACH,CAAC;gBAED,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC;oBAC1C,6BAA6B,CAAA;YACjC,CAAC;QACH,CAAC;QAED,OAAO,8BAA8B,CAAA;IACvC,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,MAAM,UAAU,sCAAsC,CACpD,UAAoD;IAEpD,OAAO,gDAAgD,CAAC,UAAU,CAAC,CAAA;AACrE,CAAC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { FormElementsCtrl } from './types.js'\nimport { flattenFormElements } from '../formElementsService.js'\nimport conditionallyShowElement from './conditionallyShowElement.js'\nimport conditionallyShowOption, {\n ShouldShowOption,\n} from './conditionallyShowOption.js'\nimport { typeCastService } from '../index.js'\n\nexport type FormElementsConditionallyShown = Record<\n string,\n FormElementConditionallyShown\n>\n\nexport type FormElementConditionallyShownElement = {\n type: 'formElement'\n isHidden: boolean\n options?: FormTypes.ChoiceElementOption[]\n dependencyIsLoading?: boolean\n}\n\nexport type FormElementConditionallyShown =\n \| undefined\n \| FormElementConditionallyShownElement\n \| {\n type: 'formElements'\n isHidden: boolean\n formElements: FormElementsConditionallyShown \| undefined\n }\n \| {\n type: 'repeatableSet'\n isHidden: boolean\n entries: Record<string, FormElementsConditionallyShown \| undefined>\n }\n\nexport type ErrorCallback = (error: Error) => void\n\nconst handleConditionallyShowElement = (\n formElementsCtrl: FormElementsCtrl,\n element: FormTypes.FormElement,\n errorCallback: ErrorCallback \| undefined,\n) => {\n try {\n return conditionallyShowElement(formElementsCtrl, element, [])\n } catch (error) {\n errorCallback?.(error as Error)\n return false\n }\n}\n\nconst handleConditionallyShowOption = (\n formElementsCtrl: FormElementsCtrl,\n element: FormTypes.FormElementWithOptions,\n option: FormTypes.ChoiceElementOption,\n errorCallback: ErrorCallback \| undefined,\n): ShouldShowOption => {\n try {\n return conditionallyShowOption(formElementsCtrl, element, option, [])\n } catch (error) {\n errorCallback?.(error as Error)\n return 'HIDE'\n }\n}\n\nexport type FormElementsConditionallyShownParameters = {\n /** Form elements to evaluate /\n formElements: FormTypes.FormElement[]\n /* Current submission data /\n submission: SubmissionTypes.S3SubmissionData['submission']\n /* Optional callback for handling errors caught during the evaluation /\n errorCallback?: ErrorCallback\n}\n\nconst generateFormElementsConditionallyShownWithParent = ({\n formElements,\n submission,\n parentFormElementsCtrl,\n errorCallback,\n}: FormElementsConditionallyShownParameters & {\n parentFormElementsCtrl?: FormElementsCtrl['parentFormElementsCtrl']\n}): FormElementsConditionallyShown => {\n const formElementsCtrl = {\n flattenedElements: flattenFormElements(formElements),\n model: submission,\n parentFormElementsCtrl,\n }\n return formElementsCtrl.flattenedElements.reduce<FormElementsConditionallyShown>(\n (formElementsConditionallyShown, element) => {\n switch (element.type) {\n case 'section':\n case 'page': {\n const formElementConditionallyShown =\n formElementsConditionallyShown[element.id]\n const isHidden = formElementConditionallyShown\n ? formElementConditionallyShown.isHidden\n : !handleConditionallyShowElement(\n formElementsCtrl,\n element,\n errorCallback,\n )\n\n formElementsConditionallyShown[element.id] = {\n type: 'formElement',\n isHidden,\n }\n\n // If the parent element is hidden, hide all the child elements\n if (isHidden) {\n element.elements.forEach((childElement) => {\n switch (childElement.type) {\n case 'section':\n case 'page': {\n formElementsConditionallyShown[childElement.id] = {\n type: 'formElement',\n isHidden: true,\n }\n break\n }\n default: {\n formElementsConditionallyShown[childElement.name] = {\n type: 'formElement',\n isHidden: true,\n }\n }\n }\n })\n }\n break\n }\n case 'infoPage':\n case 'form': {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const nestedModel = submission[element.name] as\n \| SubmissionTypes.S3SubmissionData['submission']\n \| undefined\n formElementsConditionallyShown[element.name] = {\n type: 'formElements',\n isHidden: !handleConditionallyShowElement(\n formElementsCtrl,\n element,\n errorCallback,\n ),\n formElements: generateFormElementsConditionallyShownWithParent({\n formElements: element.elements \|\| [],\n submission: nestedModel \|\| {},\n parentFormElementsCtrl: formElementsCtrl,\n }),\n }\n break\n }\n case 'repeatableSet': {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const entries = formElementsCtrl.model?.[element.name] as\n \| Array<SubmissionTypes.S3SubmissionData['submission']>\n \| undefined\n formElementsConditionallyShown[element.name] = {\n type: 'repeatableSet',\n isHidden: !handleConditionallyShowElement(\n formElementsCtrl,\n element,\n errorCallback,\n ),\n entries: (entries \|\| []).reduce(\n (\n result: Record<\n string,\n FormElementsConditionallyShown \| undefined\n >,\n entry,\n index,\n ) => {\n result[index.toString()] =\n generateFormElementsConditionallyShownWithParent({\n formElements: element.elements,\n submission: entry,\n parentFormElementsCtrl: formElementsCtrl,\n })\n return result\n },\n {},\n ),\n }\n break\n }\n default: {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const formElementConditionallyShown: FormElementConditionallyShown = {\n type: 'formElement',\n isHidden: !handleConditionallyShowElement(\n formElementsCtrl,\n element,\n errorCallback,\n ),\n }\n\n if (!formElementConditionallyShown.isHidden) {\n const optionsElement =\n typeCastService.formElements.toOptionsElement(element)\n if (\n optionsElement &&\n optionsElement.conditionallyShowOptions &&\n Array.isArray(optionsElement.options)\n ) {\n const newOptions = []\n for (const option of optionsElement.options) {\n const optionPredicatesResult = handleConditionallyShowOption(\n formElementsCtrl,\n optionsElement,\n option,\n errorCallback,\n )\n switch (optionPredicatesResult) {\n case 'SHOW': {\n newOptions.push(option)\n break\n }\n case 'LOADING_STATIC_DEPENDENCY': {\n newOptions.push(option)\n formElementConditionallyShown.dependencyIsLoading = true\n break\n }\n case 'LOADING_DYNAMIC_DEPENDENCY': {\n formElementConditionallyShown.dependencyIsLoading = true\n break\n }\n }\n }\n formElementConditionallyShown.options = newOptions\n }\n }\n\n formElementsConditionallyShown[element.name] =\n formElementConditionallyShown\n }\n }\n\n return formElementsConditionallyShown\n },\n {},\n )\n}\n\n/\n Given a form element and submission data, evaluate which elements are\n * currently shown. The function also takes an optional errorCallback for\n * handling errors caught during the evaluation.\n \n #### Example\n \n ```js\n * const formElementsConditionallyShown =\n * conditionalLogicService.generateFormElementsConditionallyShown({\n * submission: {\n * radio: ['hide'],\n * text: 'hidden text',\n * },\n * formElements: [\n * {\n * name: 'radio',\n * label: 'Radio',\n * type: 'radio',\n * required: false,\n * id: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',\n * conditionallyShow: false,\n * options: [\n * {\n * id: '9a44e15a-5929-419d-825e-b3dc0a29591f',\n * label: 'Show',\n * value: 'show',\n * },\n * {\n * id: 'd776ed42-072c-4bf8-9879-874b2bef85d3',\n * label: 'Hide',\n * value: 'Hide',\n * },\n * ],\n * readOnly: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * buttons: false,\n * optionsType: 'CUSTOM',\n * conditionallyShowOptions: false,\n * },\n * {\n * name: 'text',\n * label: 'Text',\n * type: 'text',\n * required: false,\n * id: '8fbddb41-348d-494c-904b-56a2c4361f13',\n * requiresAllConditionallyShowPredicates: false,\n * conditionallyShow: true,\n * conditionallyShowPredicates: [\n * {\n * elementId: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',\n * optionIds: ['9a44e15a-5929-419d-825e-b3dc0a29591f'],\n * type: 'OPTIONS',\n * },\n * ],\n * readOnly: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * },\n * ],\n * parentFormElementsCtrl: undefined,\n * errorCallback: (error) => {\n * //do something with the error here\n * console.error(error)\n * },\n * })\n * ```\n \n The above example returns an object like below\n \n ```json\n * {\n * \"radio\": {\n * \"isHidden\": false,\n * \"type\": \"formElement\"\n * },\n * \"text\": {\n * \"isHidden\": true,\n * \"type\": \"formElement\"\n * }\n * }\n * ```\n \n @param parameters\n * @returns\n */\nexport function generateFormElementsConditionallyShown(\n parameters: FormElementsConditionallyShownParameters,\n): FormElementsConditionallyShown {\n return generateFormElementsConditionallyShownWithParent(parameters)\n}\n"]}
1	+ {"version":3,"file":"generateFormElementsConditionallyShown.js","sourceRoot":"","sources":["../../src/conditionalLogicService/generateFormElementsConditionallyShown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,wBAAwB,MAAM,+BAA+B,CAAA;AACpE,OAAO,uBAEN,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,uCAAuC,MAAM,8CAA8C,CAAA;AA8BlG,MAAM,8BAA8B,GAAG,CAAC,EACtC,gBAAgB,EAChB,OAAO,EACP,aAAa,GAKd,EAAE,EAAE;IACH,IAAI,CAAC;QACH,OAAO,wBAAwB,CAAC;YAC9B,gBAAgB;YAChB,iBAAiB,EAAE,OAAO;YAC1B,iBAAiB,EAAE,EAAE;SACtB,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,EAAE,CAAC,KAAc,CAAC,CAAA;QAC/B,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CAAC,EACrC,gBAAgB,EAChB,OAAO,EACP,MAAM,EACN,aAAa,GAMd,EAAoB,EAAE;IACrB,IAAI,CAAC;QACH,OAAO,uBAAuB,CAAC;YAC7B,gBAAgB;YAChB,iBAAiB,EAAE,OAAO;YAC1B,gBAAgB,EAAE,MAAM;YACxB,gBAAgB,EAAE,EAAE;SACrB,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,EAAE,CAAC,KAAc,CAAC,CAAA;QAC/B,OAAO,MAAM,CAAA;IACf,CAAC;AACH,CAAC,CAAA;AAkBD,MAAM,gDAAgD,GAAG,CAAC,EACxD,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,aAAa,GAMd,EAAkC,EAAE;IACnC,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,mBAAmB,CAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;QACjB,sBAAsB;KACvB,CAAA;IACD,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAC9C,CAAC,8BAA8B,EAAE,OAAO,EAAE,EAAE;QAC1C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,6BAA6B,GACjC,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC5C,MAAM,QAAQ,GAAG,6BAA6B;oBAC5C,CAAC,CAAC,6BAA6B,CAAC,QAAQ;oBACxC,CAAC,CAAC,CAAC,8BAA8B,CAAC;wBAC9B,gBAAgB;wBAChB,OAAO;wBACP,aAAa;qBACd,CAAC,CAAA;gBAEN,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG;oBAC3C,IAAI,EAAE,aAAa;oBACnB,QAAQ;iBACT,CAAA;gBAED,+DAA+D;gBAC/D,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;wBACxC,QAAQ,YAAY,CAAC,IAAI,EAAE,CAAC;4BAC1B,KAAK,SAAS,CAAC;4BACf,KAAK,MAAM,CAAC,CAAC,CAAC;gCACZ,8BAA8B,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG;oCAChD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;gCACD,MAAK;4BACP,CAAC;4BACD,OAAO,CAAC,CAAC,CAAC;gCACR,8BAA8B,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG;oCAClD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC;gBACD,MAAK;YACP,CAAC;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAE9B,CAAA;gBACb,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBAC7C,IAAI,EAAE,cAAc;oBACpB,QAAQ,EAAE,CAAC,8BAA8B,CAAC;wBACxC,gBAAgB;wBAChB,OAAO;wBACP,aAAa;qBACd,CAAC;oBACF,YAAY,EAAE,gDAAgD,CAAC;wBAC7D,YAAY,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;wBACpC,UAAU,EAAE,WAAW,IAAI,EAAE;wBAC7B,sBAAsB,EAAE,gBAAgB;wBACxC,aAAa;qBACd,CAAC;iBACH,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,IAAI,CAExC,CAAA;gBACb,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBAC7C,IAAI,EAAE,eAAe;oBACrB,QAAQ,EAAE,CAAC,8BAA8B,CAAC;wBACxC,gBAAgB;wBAChB,OAAO;wBACP,aAAa;qBACd,CAAC;oBACF,OAAO,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAC7B,CACE,MAGC,EACD,KAAK,EACL,KAAK,EACL,EAAE;wBACF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;4BACtB,gDAAgD,CAAC;gCAC/C,YAAY,EAAE,OAAO,CAAC,QAAQ;gCAC9B,UAAU,EAAE,KAAK;gCACjB,sBAAsB,EAAE,gBAAgB;gCACxC,aAAa;6BACd,CAAC,CAAA;wBACJ,OAAO,MAAM,CAAA;oBACf,CAAC,EACD,EAAE,CACH;iBACF,CAAA;gBACD,MAAK;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjD,MAAK;gBACP,CAAC;gBACD,MAAM,6BAA6B,GAAkC;oBACnE,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,CAAC,8BAA8B,CAAC;wBACxC,gBAAgB;wBAChB,OAAO;wBACP,aAAa;qBACd,CAAC;iBACH,CAAA;gBAED,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,CAAC;oBAC5C,MAAM,cAAc,GAClB,eAAe,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;oBACxD,IACE,cAAc;wBACd,cAAc,CAAC,wBAAwB;wBACvC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,EACrC,CAAC;wBACD,MAAM,UAAU,GAAG,EAAE,CAAA;wBACrB,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;4BAC5C,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;gCAC3D,gBAAgB;gCAChB,OAAO,EAAE,cAAc;gCACvB,MAAM;gCACN,aAAa;6BACd,CAAC,CAAA;4BACF,QAAQ,sBAAsB,EAAE,CAAC;gCAC/B,KAAK,MAAM,CAAC,CAAC,CAAC;oCACZ,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oCACvB,MAAK;gCACP,CAAC;gCACD,KAAK,2BAA2B,CAAC,CAAC,CAAC;oCACjC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oCACvB,6BAA6B,CAAC,mBAAmB,GAAG,IAAI,CAAA;oCACxD,MAAK;gCACP,CAAC;gCACD,KAAK,4BAA4B,CAAC,CAAC,CAAC;oCAClC,6BAA6B,CAAC,mBAAmB,GAAG,IAAI,CAAA;oCACxD,MAAK;gCACP,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,6BAA6B,CAAC,OAAO,GAAG,UAAU,CAAA;oBACpD,CAAC;gBACH,CAAC;gBAED,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC;oBAC1C,6BAA6B,CAAA;YACjC,CAAC;QACH,CAAC;QAED,OAAO,8BAA8B,CAAA;IACvC,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,MAAM,UAAU,sCAAsC,CAAC,EACrD,YAAY,EACZ,UAAU,EACV,aAAa,EACb,gBAAgB,GACyB;IACzC,MAAM,8BAA8B,GAClC,gDAAgD,CAAC;QAC/C,YAAY;QACZ,UAAU;QACV,aAAa;QACb,sBAAsB,EAAE,SAAS;KAClC,CAAC,CAAA;IAEJ,IAAI,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO;YACL,8BAA8B;YAC9B,mBAAmB,EAAE,IAAI;SAC1B,CAAA;IACH,CAAC;IAED,MAAM,gBAAgB,GAAqB;QACzC,iBAAiB,EAAE,mBAAmB,CAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;KAClB,CAAA;IAED,MAAM,WAAW,GAAG,CAClB,SAEkC,EAClC,EAAE;QACF,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,uCAAuC,CAAC;gBAC/D,SAAS;gBACT,gBAAgB;aACjB,CAAC,CAAA;YACF,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,mEAAmE;YACnE,qEAAqE;YACrE,MAAM,KAAK,GAAG,8BAA8B,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACnE,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAA;QACnC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,EAAE,CAAC,KAAc,CAAC,CAAA;YAC/B,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC,CAAA;IAED,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,gCAAgC;QAC3E,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3D,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAE5D,OAAO;QACL,8BAA8B;QAC9B,mBAAmB;KACpB,CAAA;AACH,CAAC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { FormElementsCtrl } from './types.js'\nimport { flattenFormElements } from '../formElementsService.js'\nimport conditionallyShowElement from './conditionallyShowElement.js'\nimport conditionallyShowOption, {\n ShouldShowOption,\n} from './conditionallyShowOption.js'\nimport { typeCastService } from '../index.js'\nimport evaluateFormElementConditionalPredicate from './evaluateFormElementConditionalPredicate.js'\n\nexport type FormElementsConditionallyShown = Record<\n string,\n FormElementConditionallyShown\n>\n\nexport type FormElementConditionallyShownElement = {\n type: 'formElement'\n isHidden: boolean\n options?: FormTypes.ChoiceElementOption[]\n dependencyIsLoading?: boolean\n}\n\nexport type FormElementConditionallyShown =\n \| undefined\n \| FormElementConditionallyShownElement\n \| {\n type: 'formElements'\n isHidden: boolean\n formElements: FormElementsConditionallyShown \| undefined\n }\n \| {\n type: 'repeatableSet'\n isHidden: boolean\n entries: Record<string, FormElementsConditionallyShown \| undefined>\n }\n\nexport type ErrorCallback = (error: Error) => void\n\nconst handleConditionallyShowElement = ({\n formElementsCtrl,\n element,\n errorCallback,\n}: {\n formElementsCtrl: FormElementsCtrl\n element: FormTypes.FormElement\n errorCallback: ErrorCallback \| undefined\n}) => {\n try {\n return conditionallyShowElement({\n formElementsCtrl,\n elementToEvaluate: element,\n elementsEvaluated: [],\n })\n } catch (error) {\n errorCallback?.(error as Error)\n return false\n }\n}\n\nconst handleConditionallyShowOption = ({\n formElementsCtrl,\n element,\n option,\n errorCallback,\n}: {\n formElementsCtrl: FormElementsCtrl\n element: FormTypes.FormElementWithOptions\n option: FormTypes.ChoiceElementOption\n errorCallback: ErrorCallback \| undefined\n}): ShouldShowOption => {\n try {\n return conditionallyShowOption({\n formElementsCtrl,\n elementToEvaluate: element,\n optionToEvaluate: option,\n optionsEvaluated: [],\n })\n } catch (error) {\n errorCallback?.(error as Error)\n return 'HIDE'\n }\n}\n\nexport type FormElementsConditionallyShownParameters = {\n /** Form elements to evaluate /\n formElements: FormTypes.FormElement[]\n /* Current submission data /\n submission: SubmissionTypes.S3SubmissionData['submission']\n /* Optional callback for handling errors caught during the evaluation /\n errorCallback?: ErrorCallback\n /* Conditionally enable form submission based on predicates /\n enableSubmission: FormTypes.Form['enableSubmission'] \| undefined\n}\n\nexport type FormElementsConditionallyShownResult = {\n formElementsConditionallyShown: FormElementsConditionallyShown\n isSubmissionEnabled: boolean\n}\n\nconst generateFormElementsConditionallyShownWithParent = ({\n formElements,\n submission,\n parentFormElementsCtrl,\n errorCallback,\n}: {\n formElements: FormTypes.FormElement[]\n submission: SubmissionTypes.S3SubmissionData['submission']\n errorCallback: ErrorCallback \| undefined\n parentFormElementsCtrl: FormElementsCtrl['parentFormElementsCtrl'] \| undefined\n}): FormElementsConditionallyShown => {\n const formElementsCtrl = {\n flattenedElements: flattenFormElements(formElements),\n model: submission,\n parentFormElementsCtrl,\n }\n return formElementsCtrl.flattenedElements.reduce<FormElementsConditionallyShown>(\n (formElementsConditionallyShown, element) => {\n switch (element.type) {\n case 'section':\n case 'page': {\n const formElementConditionallyShown =\n formElementsConditionallyShown[element.id]\n const isHidden = formElementConditionallyShown\n ? formElementConditionallyShown.isHidden\n : !handleConditionallyShowElement({\n formElementsCtrl,\n element,\n errorCallback,\n })\n\n formElementsConditionallyShown[element.id] = {\n type: 'formElement',\n isHidden,\n }\n\n // If the parent element is hidden, hide all the child elements\n if (isHidden) {\n element.elements.forEach((childElement) => {\n switch (childElement.type) {\n case 'section':\n case 'page': {\n formElementsConditionallyShown[childElement.id] = {\n type: 'formElement',\n isHidden: true,\n }\n break\n }\n default: {\n formElementsConditionallyShown[childElement.name] = {\n type: 'formElement',\n isHidden: true,\n }\n }\n }\n })\n }\n break\n }\n case 'infoPage':\n case 'form': {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const nestedModel = submission[element.name] as\n \| SubmissionTypes.S3SubmissionData['submission']\n \| undefined\n formElementsConditionallyShown[element.name] = {\n type: 'formElements',\n isHidden: !handleConditionallyShowElement({\n formElementsCtrl,\n element,\n errorCallback,\n }),\n formElements: generateFormElementsConditionallyShownWithParent({\n formElements: element.elements \|\| [],\n submission: nestedModel \|\| {},\n parentFormElementsCtrl: formElementsCtrl,\n errorCallback,\n }),\n }\n break\n }\n case 'repeatableSet': {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const entries = formElementsCtrl.model?.[element.name] as\n \| Array<SubmissionTypes.S3SubmissionData['submission']>\n \| undefined\n formElementsConditionallyShown[element.name] = {\n type: 'repeatableSet',\n isHidden: !handleConditionallyShowElement({\n formElementsCtrl,\n element,\n errorCallback,\n }),\n entries: (entries \|\| []).reduce(\n (\n result: Record<\n string,\n FormElementsConditionallyShown \| undefined\n >,\n entry,\n index,\n ) => {\n result[index.toString()] =\n generateFormElementsConditionallyShownWithParent({\n formElements: element.elements,\n submission: entry,\n parentFormElementsCtrl: formElementsCtrl,\n errorCallback,\n })\n return result\n },\n {},\n ),\n }\n break\n }\n default: {\n if (formElementsConditionallyShown[element.name]) {\n break\n }\n const formElementConditionallyShown: FormElementConditionallyShown = {\n type: 'formElement',\n isHidden: !handleConditionallyShowElement({\n formElementsCtrl,\n element,\n errorCallback,\n }),\n }\n\n if (!formElementConditionallyShown.isHidden) {\n const optionsElement =\n typeCastService.formElements.toOptionsElement(element)\n if (\n optionsElement &&\n optionsElement.conditionallyShowOptions &&\n Array.isArray(optionsElement.options)\n ) {\n const newOptions = []\n for (const option of optionsElement.options) {\n const optionPredicatesResult = handleConditionallyShowOption({\n formElementsCtrl,\n element: optionsElement,\n option,\n errorCallback,\n })\n switch (optionPredicatesResult) {\n case 'SHOW': {\n newOptions.push(option)\n break\n }\n case 'LOADING_STATIC_DEPENDENCY': {\n newOptions.push(option)\n formElementConditionallyShown.dependencyIsLoading = true\n break\n }\n case 'LOADING_DYNAMIC_DEPENDENCY': {\n formElementConditionallyShown.dependencyIsLoading = true\n break\n }\n }\n }\n formElementConditionallyShown.options = newOptions\n }\n }\n\n formElementsConditionallyShown[element.name] =\n formElementConditionallyShown\n }\n }\n\n return formElementsConditionallyShown\n },\n {},\n )\n}\n\n/\n Given form elements and submission data, evaluate which elements are\n * currently shown and whether submission is enabled. The function also takes an\n * optional errorCallback for handling errors caught during the evaluation.\n \n #### Example\n \n ```js\n * const { formElementsConditionallyShown, isSubmissionEnabled } =\n * conditionalLogicService.generateFormElementsConditionallyShown({\n * submission: {\n * radio: ['hide'],\n * text: 'hidden text',\n * },\n * formElements: [\n * {\n * name: 'radio',\n * label: 'Radio',\n * type: 'radio',\n * required: false,\n * id: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',\n * conditionallyShow: false,\n * options: [\n * {\n * id: '9a44e15a-5929-419d-825e-b3dc0a29591f',\n * label: 'Show',\n * value: 'show',\n * },\n * {\n * id: 'd776ed42-072c-4bf8-9879-874b2bef85d3',\n * label: 'Hide',\n * value: 'Hide',\n * },\n * ],\n * readOnly: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * buttons: false,\n * optionsType: 'CUSTOM',\n * conditionallyShowOptions: false,\n * },\n * {\n * name: 'text',\n * label: 'Text',\n * type: 'text',\n * required: false,\n * id: '8fbddb41-348d-494c-904b-56a2c4361f13',\n * requiresAllConditionallyShowPredicates: false,\n * conditionallyShow: true,\n * conditionallyShowPredicates: [\n * {\n * elementId: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',\n * optionIds: ['9a44e15a-5929-419d-825e-b3dc0a29591f'],\n * type: 'OPTIONS',\n * },\n * ],\n * readOnly: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * },\n * ],\n * errorCallback: (error) => {\n * //do something with the error here\n * console.error(error)\n * },\n * })\n * ```\n \n The above example returns an object like below\n \n ```json\n * {\n * \"formElementsConditionallyShown\": {\n * \"radio\": {\n * \"isHidden\": false,\n * \"type\": \"formElement\"\n * },\n * \"text\": {\n * \"isHidden\": true,\n * \"type\": \"formElement\"\n * }\n * },\n * \"isSubmissionEnabled\": true\n * }\n * ```\n \n @param parameters\n * @returns\n */\nexport function generateFormElementsConditionallyShown({\n formElements,\n submission,\n errorCallback,\n enableSubmission,\n}: FormElementsConditionallyShownParameters): FormElementsConditionallyShownResult {\n const formElementsConditionallyShown =\n generateFormElementsConditionallyShownWithParent({\n formElements,\n submission,\n errorCallback,\n parentFormElementsCtrl: undefined,\n })\n\n if (!enableSubmission?.conditionalPredicates.length) {\n return {\n formElementsConditionallyShown,\n isSubmissionEnabled: true,\n }\n }\n\n const formElementsCtrl: FormElementsCtrl = {\n flattenedElements: flattenFormElements(formElements),\n model: submission,\n }\n\n const predicateFn = (\n predicate: NonNullable<\n FormTypes.Form['enableSubmission']\n >['conditionalPredicates'][number],\n ) => {\n try {\n const predicateElement = evaluateFormElementConditionalPredicate({\n predicate,\n formElementsCtrl,\n })\n if (!predicateElement) {\n return false\n }\n\n // Reuse visibility already computed above instead of re-evaluating\n // conditionally show predicates for the predicate element / parents.\n const shown = formElementsConditionallyShown[predicateElement.name]\n return !!shown && !shown.isHidden\n } catch (error) {\n errorCallback?.(error as Error)\n return false\n }\n }\n\n const isSubmissionEnabled = enableSubmission.requiresAllConditionalPredicates\n ? enableSubmission.conditionalPredicates.every(predicateFn)\n : enableSubmission.conditionalPredicates.some(predicateFn)\n\n return {\n formElementsConditionallyShown,\n isSubmissionEnabled,\n }\n}\n"]}

package/dist/conditionalLogicService/types.d.ts CHANGED Viewed

@@ -1,4 +1,14 @@
 import { FormTypes, SubmissionTypes } from '@oneblink/types';
+/**
+ * Parse a date/datetime string into a `Date`. Callers supply timezone-aware
+ * parsing (e.g. treating `YYYY-MM-DD` as the start of day in an organisation
+ * timezone).
+ */
+export type ParseDate = (value: string) => Date;
+/**
+ * Add an offset to a date. Callers supply timezone-aware calendar arithmetic.
+ */
+export type AddOffsetToDate = (date: Date, offset: number) => Date;
 export type FormElementsCtrl = {
     model: SubmissionTypes.S3SubmissionData['submission'] | undefined;
     flattenedElements: FormTypes.FormElement[];

package/dist/conditionalLogicService/types.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/conditionalLogicService/types.ts"],"names":[],"mappings":"","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\n\nexport type FormElementsCtrl = {\n model: SubmissionTypes.S3SubmissionData['submission'] \| undefined\n flattenedElements: FormTypes.FormElement[]\n parentFormElementsCtrl?: FormElementsCtrl\n}\n"]}
1	+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/conditionalLogicService/types.ts"],"names":[],"mappings":"","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\n\n/*\n Parse a date/datetime string into a `Date`. Callers supply timezone-aware\n * parsing (e.g. treating `YYYY-MM-DD` as the start of day in an organisation\n * timezone).\n /\nexport type ParseDate = (value: string) => Date\n\n/\n Add an offset to a date. Callers supply timezone-aware calendar arithmetic.\n */\nexport type AddOffsetToDate = (date: Date, offset: number) => Date\n\nexport type FormElementsCtrl = {\n model: SubmissionTypes.S3SubmissionData['submission'] \| undefined\n flattenedElements: FormTypes.FormElement[]\n parentFormElementsCtrl?: FormElementsCtrl\n}\n"]}

package/dist/conditionalLogicService.d.ts CHANGED Viewed

@@ -1,5 +1,7 @@
 import { ConditionTypes, FormTypes, SubmissionTypes } from '@oneblink/types';
+import { AddOffsetToDate, ParseDate } from './conditionalLogicService/types.js';
 export * from './conditionalLogicService/generateFormElementsConditionallyShown.js';
+export type { AddOffsetToDate, ParseDate } from './conditionalLogicService/types.js';
 /**
  * Given a set of form elements and submission data, evaluate if predicates are
  * met or not.
@@ -55,6 +57,12 @@ export * from './conditionalLogicService/generateFormElementsConditionallyShown.
  *         requiresAllConditionallyShowPredicates: false,
  *       },
  *     ],
+ *     submissionTimestamp: new Date().toISOString(),
+ *     parseDate: (value) => new Date(value),
+ *     addDaysToDate: (date, days) => {
+ *       date.setUTCDate(date.getUTCDate() + days)
+ *       return date
+ *     },
  *   },
  * )
  * ```
@@ -62,10 +70,16 @@ export * from './conditionalLogicService/generateFormElementsConditionallyShown.
  * @param options
  * @returns
  */
-export declare function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, }: {
+export declare function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, submissionTimestamp, parseDate, addDaysToDate, }: {
     isConditional: boolean;
     requiresAllConditionalPredicates: boolean;
     conditionalPredicates: ConditionTypes.ConditionalPredicate[];
     formElements: FormTypes.FormElement[];
     submission: SubmissionTypes.S3SubmissionData['submission'];
+    /** ISO timestamp the form was submitted. When evaluating during submission, pass `new Date().toISOString()`. */
+    submissionTimestamp: string;
+    /** Parse date/datetime strings when evaluating date based predicates */
+    parseDate: ParseDate;
+    /** Add days to a date when evaluating date based predicates */
+    addDaysToDate: AddOffsetToDate;
 }): boolean;

package/dist/conditionalLogicService.js CHANGED Viewed

@@ -1,4 +1,5 @@
-import evaluateConditionalPredicate from './conditionalLogicService/evaluateConditionalPredicate.js';
+import evaluateFormElementConditionalPredicate from './conditionalLogicService/evaluateFormElementConditionalPredicate.js';
+import evaluateConditionalSubmissionTimestampPredicate from './conditionalLogicService/evaluateConditionalSubmissionTimestampPredicate.js';
 import { flattenFormElements } from './formElementsService.js';
 export * from './conditionalLogicService/generateFormElementsConditionallyShown.js';
 /**
@@ -56,6 +57,12 @@ export * from './conditionalLogicService/generateFormElementsConditionallyShown.
  *         requiresAllConditionallyShowPredicates: false,
  *       },
  *     ],
+ *     submissionTimestamp: new Date().toISOString(),
+ *     parseDate: (value) => new Date(value),
+ *     addDaysToDate: (date, days) => {
+ *       date.setUTCDate(date.getUTCDate() + days)
+ *       return date
+ *     },
  *   },
  * )
  * ```
@@ -63,7 +70,7 @@ export * from './conditionalLogicService/generateFormElementsConditionallyShown.
  * @param options
  * @returns
  */
-export function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, }) {
+export function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, submissionTimestamp, parseDate, addDaysToDate, }) {
     if (!isConditional || !conditionalPredicates.length) {
         return true;
     }
@@ -71,10 +78,21 @@ export function evaluateConditionalPredicates({ isConditional, requiresAllCondit
         flattenedElements: flattenFormElements(formElements),
         model: submission,
     };
-    const predicateFn = (predicate) => evaluateConditionalPredicate({
-        predicate,
-        formElementsCtrl,
-    });
+    const predicateFn = (predicate) => {
+        if (predicate.type === 'SUBMISSION_TIMESTAMP') {
+            return evaluateConditionalSubmissionTimestampPredicate({
+                predicate,
+                formElementsCtrl,
+                submissionTimestamp,
+                parseDate,
+                addDaysToDate,
+            });
+        }
+        return !!evaluateFormElementConditionalPredicate({
+            predicate,
+            formElementsCtrl,
+        });
+    };
     if (requiresAllConditionalPredicates) {
         return conditionalPredicates.every(predicateFn);
     }

package/dist/conditionalLogicService.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"conditionalLogicService.js","sourceRoot":"","sources":["../src/conditionalLogicService.ts"],"names":[],"mappings":"AAAA,OAAO,~~4BAA4B~~,MAAM,~~2DAA2D~~,CAAA;~~AACpG~~,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;~~AAG9D~~,cAAc,qEAAqE,CAAA;~~AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG~~;AACH,MAAM,UAAU,6BAA6B,CAAC,EAC5C,aAAa,EACb,gCAAgC,EAChC,qBAAqB,EACrB,YAAY,EACZ,UAAU,~~GAOX~~;IACC,IAAI,CAAC,aAAa,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,mBAAmB,CAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;KAClB,CAAA;IAED,MAAM,WAAW,GAAG,CAAC,SAA8C,EAAE,EAAE,~~CACrE~~,~~4BAA4B~~,CAAC;~~QAC3B~~,SAAS;~~QACT~~,gBAAgB;~~KACjB~~,CAAC,CAAA;IACJ,IAAI,gCAAgC,EAAE,CAAC;QACrC,OAAO,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACjD,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAChD,CAAC;AACH,CAAC","sourcesContent":["import ~~evaluateConditionalPredicate~~ from './conditionalLogicService/~~evaluateConditionalPredicate~~.js'\nimport { flattenFormElements } from './formElementsService.js'\nimport { ConditionTypes, FormTypes, SubmissionTypes } from '@oneblink/types'\n\nexport * from './conditionalLogicService/generateFormElementsConditionallyShown.js'\n\n/*\n Given a set of form elements and submission data, evaluate if predicates are\n * met or not.\n \n #### Example\n \n ```js\n * const evaluation = conditionalLogicService.evaluateConditionalPredicates(\n * {\n * isConditional: true,\n * requiresAllConditionalPredicates: false,\n * conditionalPredicates: [\n * {\n * type: 'OPTIONS',\n * elementId: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',\n * optionIds: ['9ce633dd-22d6-4e0e-a9e0-1aa62d435e72'],\n * },\n * ],\n * submission: {\n * checkboxes: ['a'],\n * },\n * formElements: [\n * {\n * name: 'checkboxes',\n * label: 'Checkboxes',\n * type: 'checkboxes',\n * required: false,\n * id: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',\n * options: [\n * {\n * id: '9ce633dd-22d6-4e0e-a9e0-1aa62d435e72',\n * label: 'First',\n * value: 'a',\n * },\n * {\n * id: '5850b32c-3833-4498-a072-47fcc8122242',\n * label: 'Second',\n * value: 'b',\n * },\n * {\n * id: 'ab363e9f-a63f-4923-ba0d-47892fc26a93',\n * label: 'Third',\n * value: 'c',\n * },\n * ],\n * readOnly: false,\n * buttons: false,\n * optionsType: 'CUSTOM',\n * conditionallyShowOptions: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * conditionallyShow: false,\n * requiresAllConditionallyShowPredicates: false,\n * },\n * ],\n * },\n * )\n * ```\n \n @param options\n * @returns\n */\nexport function evaluateConditionalPredicates({\n isConditional,\n requiresAllConditionalPredicates,\n conditionalPredicates,\n formElements,\n submission,\n}: {\n isConditional: boolean\n requiresAllConditionalPredicates: boolean\n conditionalPredicates: ConditionTypes.ConditionalPredicate[]\n formElements: FormTypes.FormElement[]\n submission: SubmissionTypes.S3SubmissionData['submission']\n}): boolean {\n if (!isConditional \|\| !conditionalPredicates.length) {\n return true\n }\n const formElementsCtrl = {\n flattenedElements: flattenFormElements(formElements),\n model: submission,\n }\n\n const predicateFn = (predicate: ConditionTypes.ConditionalPredicate) ~~=>\~~n ~~evaluateConditionalPredicate~~({\n predicate,\n formElementsCtrl,\n })\n if (requiresAllConditionalPredicates) {\n return conditionalPredicates.every(predicateFn)\n } else {\n return conditionalPredicates.some(predicateFn)\n }\n}\n"]}
1	+ {"version":3,"file":"conditionalLogicService.js","sourceRoot":"","sources":["../src/conditionalLogicService.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,MAAM,sEAAsE,CAAA;AAC1H,OAAO,+CAA+C,MAAM,8EAA8E,CAAA;AAC1I,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAI9D,cAAc,qEAAqE,CAAA;AAGnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,MAAM,UAAU,6BAA6B,CAAC,EAC5C,aAAa,EACb,gCAAgC,EAChC,qBAAqB,EACrB,YAAY,EACZ,UAAU,EACV,mBAAmB,EACnB,SAAS,EACT,aAAa,GAad;IACC,IAAI,CAAC,aAAa,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,mBAAmB,CAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;KAClB,CAAA;IAED,MAAM,WAAW,GAAG,CAAC,SAA8C,EAAE,EAAE;QACrE,IAAI,SAAS,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;YAC9C,OAAO,+CAA+C,CAAC;gBACrD,SAAS;gBACT,gBAAgB;gBAChB,mBAAmB;gBACnB,SAAS;gBACT,aAAa;aACd,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,CAAC,CAAC,uCAAuC,CAAC;YAC/C,SAAS;YACT,gBAAgB;SACjB,CAAC,CAAA;IACJ,CAAC,CAAA;IACD,IAAI,gCAAgC,EAAE,CAAC;QACrC,OAAO,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACjD,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAChD,CAAC;AACH,CAAC","sourcesContent":["import evaluateFormElementConditionalPredicate from './conditionalLogicService/evaluateFormElementConditionalPredicate.js'\nimport evaluateConditionalSubmissionTimestampPredicate from './conditionalLogicService/evaluateConditionalSubmissionTimestampPredicate.js'\nimport { flattenFormElements } from './formElementsService.js'\nimport { ConditionTypes, FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { AddOffsetToDate, ParseDate } from './conditionalLogicService/types.js'\n\nexport * from './conditionalLogicService/generateFormElementsConditionallyShown.js'\nexport type { AddOffsetToDate, ParseDate } from './conditionalLogicService/types.js'\n\n/*\n Given a set of form elements and submission data, evaluate if predicates are\n * met or not.\n \n #### Example\n \n ```js\n * const evaluation = conditionalLogicService.evaluateConditionalPredicates(\n * {\n * isConditional: true,\n * requiresAllConditionalPredicates: false,\n * conditionalPredicates: [\n * {\n * type: 'OPTIONS',\n * elementId: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',\n * optionIds: ['9ce633dd-22d6-4e0e-a9e0-1aa62d435e72'],\n * },\n * ],\n * submission: {\n * checkboxes: ['a'],\n * },\n * formElements: [\n * {\n * name: 'checkboxes',\n * label: 'Checkboxes',\n * type: 'checkboxes',\n * required: false,\n * id: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',\n * options: [\n * {\n * id: '9ce633dd-22d6-4e0e-a9e0-1aa62d435e72',\n * label: 'First',\n * value: 'a',\n * },\n * {\n * id: '5850b32c-3833-4498-a072-47fcc8122242',\n * label: 'Second',\n * value: 'b',\n * },\n * {\n * id: 'ab363e9f-a63f-4923-ba0d-47892fc26a93',\n * label: 'Third',\n * value: 'c',\n * },\n * ],\n * readOnly: false,\n * buttons: false,\n * optionsType: 'CUSTOM',\n * conditionallyShowOptions: false,\n * isDataLookup: false,\n * isElementLookup: false,\n * conditionallyShow: false,\n * requiresAllConditionallyShowPredicates: false,\n * },\n * ],\n * submissionTimestamp: new Date().toISOString(),\n * parseDate: (value) => new Date(value),\n * addDaysToDate: (date, days) => {\n * date.setUTCDate(date.getUTCDate() + days)\n * return date\n * },\n * },\n * )\n * ```\n \n @param options\n * @returns\n /\nexport function evaluateConditionalPredicates({\n isConditional,\n requiresAllConditionalPredicates,\n conditionalPredicates,\n formElements,\n submission,\n submissionTimestamp,\n parseDate,\n addDaysToDate,\n}: {\n isConditional: boolean\n requiresAllConditionalPredicates: boolean\n conditionalPredicates: ConditionTypes.ConditionalPredicate[]\n formElements: FormTypes.FormElement[]\n submission: SubmissionTypes.S3SubmissionData['submission']\n /* ISO timestamp the form was submitted. When evaluating during submission, pass `new Date().toISOString()`. /\n submissionTimestamp: string\n /* Parse date/datetime strings when evaluating date based predicates /\n parseDate: ParseDate\n /* Add days to a date when evaluating date based predicates */\n addDaysToDate: AddOffsetToDate\n}): boolean {\n if (!isConditional \|\| !conditionalPredicates.length) {\n return true\n }\n const formElementsCtrl = {\n flattenedElements: flattenFormElements(formElements),\n model: submission,\n }\n\n const predicateFn = (predicate: ConditionTypes.ConditionalPredicate) => {\n if (predicate.type === 'SUBMISSION_TIMESTAMP') {\n return evaluateConditionalSubmissionTimestampPredicate({\n predicate,\n formElementsCtrl,\n submissionTimestamp,\n parseDate,\n addDaysToDate,\n })\n }\n\n return !!evaluateFormElementConditionalPredicate({\n predicate,\n formElementsCtrl,\n })\n }\n if (requiresAllConditionalPredicates) {\n return conditionalPredicates.every(predicateFn)\n } else {\n return conditionalPredicates.some(predicateFn)\n }\n}\n"]}

package/dist/paymentService.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 import { FormTypes, SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
 import { ReplaceInjectablesFormatters } from './submissionService.js';
+import { AddOffsetToDate, ParseDate } from './conditionalLogicService/types.js';
 /**
  * Examine a submission and its form definition to validate whether a payment
  * workflow event needs to run.
@@ -7,14 +8,31 @@ import { ReplaceInjectablesFormatters } from './submissionService.js';
  * #### Example
  *
  * ```js
- * const result = paymentService.checkForPaymentEvent(form, submission)
+ * const result = paymentService.checkForPaymentEvent({
+ *   definition: form,
+ *   submission,
+ *   submissionTimestamp,
+ *   parseDate: (value) => new Date(value),
+ *   addDaysToDate: (date, days) => {
+ *     date.setUTCDate(date.getUTCDate() + days)
+ *     return date
+ *   },
+ * })
  * ```
  *
- * @param definition
- * @param submission
+ * @param options
  * @returns
  */
-export declare function checkForPaymentEvent(definition: FormTypes.Form, submission: SubmissionTypes.S3SubmissionData['submission']): {
+export declare function checkForPaymentEvent({ definition, submission, submissionTimestamp, parseDate, addDaysToDate, }: {
+    definition: FormTypes.Form;
+    submission: SubmissionTypes.S3SubmissionData['submission'];
+    /** ISO timestamp the form was submitted. When evaluating during submission, pass `new Date().toISOString()`. */
+    submissionTimestamp: string;
+    /** Parse date/datetime strings when evaluating date based predicates */
+    parseDate: ParseDate;
+    /** Add days to a date when evaluating date based predicates */
+    addDaysToDate: AddOffsetToDate;
+}): {
     paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
     amount: number;
 } | undefined;

package/dist/paymentService.js CHANGED Viewed

@@ -7,14 +7,22 @@ import { getRootElementValueById, } from './submissionService.js';
  * #### Example
  *
  * ```js
- * const result = paymentService.checkForPaymentEvent(form, submission)
+ * const result = paymentService.checkForPaymentEvent({
+ *   definition: form,
+ *   submission,
+ *   submissionTimestamp,
+ *   parseDate: (value) => new Date(value),
+ *   addDaysToDate: (date, days) => {
+ *     date.setUTCDate(date.getUTCDate() + days)
+ *     return date
+ *   },
+ * })
  * ```
  *
- * @param definition
- * @param submission
+ * @param options
  * @returns
  */
-export function checkForPaymentEvent(definition, submission) {
+export function checkForPaymentEvent({ definition, submission, submissionTimestamp, parseDate, addDaysToDate, }) {
     const paymentSubmissionEvents = definition.paymentEvents || [];
     const paymentSubmissionEvent = paymentSubmissionEvents.find((paymentSubmissionEvent) => {
         return (paymentSubmissionEvent &&
@@ -24,6 +32,9 @@ export function checkForPaymentEvent(definition, submission) {
                 conditionalPredicates: paymentSubmissionEvent.conditionallyExecutePredicates || [],
                 submission: submission,
                 formElements: definition.elements,
+                submissionTimestamp,
+                parseDate,
+                addDaysToDate,
             }));
     });
     if (!paymentSubmissionEvent) {