@oneblink/sdk-core 0.3.6-beta.2 → 0.4.0-beta.1

package/dist/conditionalLogicService/generateFormElementsConditionallyShown.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateFormElementsConditionallyShown = void 0;
 const formElementsService_1 = require("../formElementsService");
 const conditionallyShowElement_1 = __importDefault(require("./conditionallyShowElement"));
 const conditionallyShowOption_1 = __importDefault(require("./conditionallyShowOption"));
@@ -25,7 +26,7 @@ const handleConditionallyShowOption = (formElementsCtrl, element, option, errorC
         return false;
     }
 };
-const generateFormElementsConditionallyShown = ({ formElements, submission, parentFormElementsCtrl, errorCallback, }) => {
+const generateFormElementsConditionallyShownWithParent = ({ formElements, submission, parentFormElementsCtrl, errorCallback, }) => {
     const formElementsCtrl = {
         flattenedElements: (0, formElementsService_1.flattenFormElements)(formElements),
         model: submission,
@@ -75,7 +76,7 @@ const generateFormElementsConditionallyShown = ({ formElements, submission, pare
                 formElementsConditionallyShown[element.name] = {
                     type: 'formElements',
                     isHidden: !handleConditionallyShowElement(formElementsCtrl, element, errorCallback),
-                    formElements: generateFormElementsConditionallyShown({
+                    formElements: generateFormElementsConditionallyShownWithParent({
                         formElements: element.elements || [],
                         submission: nestedModel || {},
                         parentFormElementsCtrl: formElementsCtrl,
@@ -93,7 +94,7 @@ const generateFormElementsConditionallyShown = ({ formElements, submission, pare
                     isHidden: !handleConditionallyShowElement(formElementsCtrl, element, errorCallback),
                     entries: (entries || []).reduce((result, entry, index) => {
                         result[index.toString()] =
-                            generateFormElementsConditionallyShown({
+                            generateFormElementsConditionallyShownWithParent({
                                 formElements: element.elements,
                                 submission: entry,
                                 parentFormElementsCtrl: formElementsCtrl,
@@ -134,5 +135,95 @@ const generateFormElementsConditionallyShown = ({ formElements, submission, pare
         return formElementsConditionallyShown;
     }, {});
 };
-exports.default = generateFormElementsConditionallyShown;
+/**
+ * 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.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formElementsConditionallyShown =
+ *   conditionalLogicService.generateFormElementsConditionallyShown({
+ *     submission: {
+ *       radio: ['hide'],
+ *       text: 'hidden text',
+ *     },
+ *     formElements: [
+ *       {
+ *         name: 'radio',
+ *         label: 'Radio',
+ *         type: 'radio',
+ *         required: false,
+ *         id: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',
+ *         conditionallyShow: false,
+ *         options: [
+ *           {
+ *             id: '9a44e15a-5929-419d-825e-b3dc0a29591f',
+ *             label: 'Show',
+ *             value: 'show',
+ *           },
+ *           {
+ *             id: 'd776ed42-072c-4bf8-9879-874b2bef85d3',
+ *             label: 'Hide',
+ *             value: 'Hide',
+ *           },
+ *         ],
+ *         readOnly: false,
+ *         isDataLookup: false,
+ *         isElementLookup: false,
+ *         buttons: false,
+ *         optionsType: 'CUSTOM',
+ *         conditionallyShowOptions: false,
+ *       },
+ *       {
+ *         name: 'text',
+ *         label: 'Text',
+ *         type: 'text',
+ *         required: false,
+ *         id: '8fbddb41-348d-494c-904b-56a2c4361f13',
+ *         requiresAllConditionallyShowPredicates: false,
+ *         conditionallyShow: true,
+ *         conditionallyShowPredicates: [
+ *           {
+ *             elementId: '5ef3beb8-8ac8-4c8d-9fd3-d8197113bf54',
+ *             optionIds: ['9a44e15a-5929-419d-825e-b3dc0a29591f'],
+ *             type: 'OPTIONS',
+ *           },
+ *         ],
+ *         readOnly: false,
+ *         isDataLookup: false,
+ *         isElementLookup: false,
+ *       },
+ *     ],
+ *     parentFormElementsCtrl: undefined,
+ *     errorCallback: (error) => {
+ *       //do something with the error here
+ *       console.error(error)
+ *     },
+ *   })
+ * ```
+ *
+ * The above example returns an object like below
+ *
+ * ```json
+ * {
+ *   "radio": {
+ *     "isHidden": false,
+ *     "type": "formElement"
+ *   },
+ *   "text": {
+ *     "isHidden": true,
+ *     "type": "formElement"
+ *   }
+ * }
+ * ```
+ *
+ * @param parameters
+ * @returns
+ */
+function generateFormElementsConditionallyShown(parameters) {
+    return generateFormElementsConditionallyShownWithParent(parameters);
+}
+exports.generateFormElementsConditionallyShown = generateFormElementsConditionallyShown;
 //# sourceMappingURL=generateFormElementsConditionallyShown.js.map

package/dist/conditionalLogicService/generateFormElementsConditionallyShown.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateFormElementsConditionallyShown.js","sourceRoot":"","sources":["../../src/conditionalLogicService/generateFormElementsConditionallyShown.ts"],"names":[],"mappings":";;;;;AAMA,gEAA4D;AAC5D,0FAAiE;AACjE,wFAA+D;AAI/D,MAAM,8BAA8B,GAAG,CACrC,gBAAkC,EAClC,OAA8B,EAC9B,aAA6B,EAC7B,EAAE;IACF,IAAI;QACF,OAAO,IAAA,kCAAwB,EAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;KAC/D;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,IAAI,CAAC,sDAAsD,EAAE,KAAK,CAAC,CAAA;QAC3E,aAAa,IAAI,aAAa,CAAC,KAAc,CAAC,CAAA;QAC9C,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CACpC,gBAAkC,EAClC,OAAyC,EACzC,MAAqC,EACrC,aAA6B,EAC7B,EAAE;IACF,IAAI;QACF,OAAO,IAAA,iCAAuB,EAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;KACtE;IAAC,OAAO,KAAK,EAAE;QACd,aAAa,IAAI,aAAa,CAAC,KAAc,CAAC,CAAA;QAC9C,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,MAAM,sCAAsC,GAAG,CAAC,EAC9C,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,aAAa,GAMd,EAAkC,EAAE;IACnC,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,IAAA,yCAAmB,EAAC,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;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,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;oBACZ,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;wBACxC,QAAQ,YAAY,CAAC,IAAI,EAAE;4BACzB,KAAK,SAAS,CAAC;4BACf,KAAK,MAAM,CAAC,CAAC;gCACX,8BAA8B,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG;oCAChD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;gCACD,MAAK;6BACN;4BACD,OAAO,CAAC,CAAC;gCACP,8BAA8B,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG;oCAClD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;6BACF;yBACF;oBACH,CAAC,CAAC,CAAA;iBACH;gBACD,MAAK;aACN;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;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,sCAAsC,CAAC;wBACnD,YAAY,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;wBACpC,UAAU,EAAE,WAAW,IAAI,EAAE;wBAC7B,sBAAsB,EAAE,gBAAgB;qBACzC,CAAC;iBACH,CAAA;gBACD,MAAK;aACN;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;gBACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAEtC,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,sCAAsC,CAAC;gCACrC,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;aACN;YACD,OAAO,CAAC,CAAC;gBACP,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;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;oBAC3C,QAAQ,OAAO,CAAC,IAAI,EAAE;wBACpB,KAAK,YAAY,CAAC;wBAClB,KAAK,cAAc,CAAC;wBACpB,KAAK,OAAO,CAAC;wBACb,KAAK,YAAY,CAAC;wBAClB,KAAK,QAAQ,CAAC,CAAC;4BACb,IACE,OAAO,CAAC,wBAAwB;gCAChC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAC9B;gCACA,6BAA6B,CAAC,OAAO;oCACnC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAChC,6BAA6B,CAC3B,gBAAgB,EAChB,OAAO,EACP,MAAM,EACN,aAAa,CACd,CACF,CAAA;6BACJ;4BACD,MAAK;yBACN;qBACF;iBACF;gBAED,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC;oBAC1C,6BAA6B,CAAA;aAChC;SACF;QAED,OAAO,8BAA8B,CAAA;IACvC,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC,CAAA;AAED,kBAAe,sCAAsC,CAAA","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport {\n  FormElementsCtrl,\n  FormElementsConditionallyShown,\n  FormElementConditionallyShown,\n} from '../types'\nimport { flattenFormElements } from '../formElementsService'\nimport conditionallyShowElement from './conditionallyShowElement'\nimport conditionallyShowOption from './conditionallyShowOption'\n\ntype ErrorCallback = (error: Error) => void\n\nconst handleConditionallyShowElement = (\n  formElementsCtrl: FormElementsCtrl,\n  element: FormTypes.FormElement,\n  errorCallback?: ErrorCallback,\n) => {\n  try {\n    return conditionallyShowElement(formElementsCtrl, element, [])\n  } catch (error) {\n    console.warn('Error while checking if element is conditional shown', error)\n    errorCallback && 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,\n) => {\n  try {\n    return conditionallyShowOption(formElementsCtrl, element, option, [])\n  } catch (error) {\n    errorCallback && errorCallback(error as Error)\n    return false\n  }\n}\n\nconst generateFormElementsConditionallyShown = ({\n  formElements,\n  submission,\n  parentFormElementsCtrl,\n  errorCallback,\n}: {\n  formElements: FormTypes.FormElement[]\n  submission: Record<string, unknown>\n  parentFormElementsCtrl?: FormElementsCtrl['parentFormElementsCtrl']\n  errorCallback?: ErrorCallback\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            | Record<string, unknown>\n            | undefined\n          formElementsConditionallyShown[element.name] = {\n            type: 'formElements',\n            isHidden: !handleConditionallyShowElement(\n              formElementsCtrl,\n              element,\n              errorCallback,\n            ),\n            formElements: generateFormElementsConditionallyShown({\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<Record<string, unknown>>\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                  generateFormElementsConditionallyShown({\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            switch (element.type) {\n              case 'compliance':\n              case 'autocomplete':\n              case 'radio':\n              case 'checkboxes':\n              case 'select': {\n                if (\n                  element.conditionallyShowOptions &&\n                  Array.isArray(element.options)\n                ) {\n                  formElementConditionallyShown.options =\n                    element.options.filter((option) =>\n                      handleConditionallyShowOption(\n                        formElementsCtrl,\n                        element,\n                        option,\n                        errorCallback,\n                      ),\n                    )\n                }\n                break\n              }\n            }\n          }\n\n          formElementsConditionallyShown[element.name] =\n            formElementConditionallyShown\n        }\n      }\n\n      return formElementsConditionallyShown\n    },\n    {},\n  )\n}\n\nexport default generateFormElementsConditionallyShown\n"]}
+{"version":3,"file":"generateFormElementsConditionallyShown.js","sourceRoot":"","sources":["../../src/conditionalLogicService/generateFormElementsConditionallyShown.ts"],"names":[],"mappings":";;;;;;AAEA,gEAA4D;AAC5D,0FAAiE;AACjE,wFAA+D;AA2B/D,MAAM,8BAA8B,GAAG,CACrC,gBAAkC,EAClC,OAA8B,EAC9B,aAA6B,EAC7B,EAAE;IACF,IAAI;QACF,OAAO,IAAA,kCAAwB,EAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;KAC/D;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,IAAI,CAAC,sDAAsD,EAAE,KAAK,CAAC,CAAA;QAC3E,aAAa,IAAI,aAAa,CAAC,KAAc,CAAC,CAAA;QAC9C,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CACpC,gBAAkC,EAClC,OAAyC,EACzC,MAAqC,EACrC,aAA6B,EAC7B,EAAE;IACF,IAAI;QACF,OAAO,IAAA,iCAAuB,EAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;KACtE;IAAC,OAAO,KAAK,EAAE;QACd,aAAa,IAAI,aAAa,CAAC,KAAc,CAAC,CAAA;QAC9C,OAAO,KAAK,CAAA;KACb;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,IAAA,yCAAmB,EAAC,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;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,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;oBACZ,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;wBACxC,QAAQ,YAAY,CAAC,IAAI,EAAE;4BACzB,KAAK,SAAS,CAAC;4BACf,KAAK,MAAM,CAAC,CAAC;gCACX,8BAA8B,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG;oCAChD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;gCACD,MAAK;6BACN;4BACD,OAAO,CAAC,CAAC;gCACP,8BAA8B,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG;oCAClD,IAAI,EAAE,aAAa;oCACnB,QAAQ,EAAE,IAAI;iCACf,CAAA;6BACF;yBACF;oBACH,CAAC,CAAC,CAAA;iBACH;gBACD,MAAK;aACN;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;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;aACN;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;gBACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAEtC,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;aACN;YACD,OAAO,CAAC,CAAC;gBACP,IAAI,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChD,MAAK;iBACN;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;oBAC3C,QAAQ,OAAO,CAAC,IAAI,EAAE;wBACpB,KAAK,YAAY,CAAC;wBAClB,KAAK,cAAc,CAAC;wBACpB,KAAK,OAAO,CAAC;wBACb,KAAK,YAAY,CAAC;wBAClB,KAAK,QAAQ,CAAC,CAAC;4BACb,IACE,OAAO,CAAC,wBAAwB;gCAChC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAC9B;gCACA,6BAA6B,CAAC,OAAO;oCACnC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAChC,6BAA6B,CAC3B,gBAAgB,EAChB,OAAO,EACP,MAAM,EACN,aAAa,CACd,CACF,CAAA;6BACJ;4BACD,MAAK;yBACN;qBACF;iBACF;gBAED,8BAA8B,CAAC,OAAO,CAAC,IAAI,CAAC;oBAC1C,6BAA6B,CAAA;aAChC;SACF;QAED,OAAO,8BAA8B,CAAA;IACvC,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,SAAgB,sCAAsC,CACpD,UAAoD;IAEpD,OAAO,gDAAgD,CAAC,UAAU,CAAC,CAAA;AACrE,CAAC;AAJD,wFAIC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { FormElementsCtrl } from '../types'\nimport { flattenFormElements } from '../formElementsService'\nimport conditionallyShowElement from './conditionallyShowElement'\nimport conditionallyShowOption from './conditionallyShowOption'\n\nexport type FormElementsConditionallyShown = Record<\n  string,\n  FormElementConditionallyShown\n>\n\nexport type FormElementConditionallyShown =\n  | undefined\n  | {\n      type: 'formElement'\n      isHidden: boolean\n      options?: import('@oneblink/types').FormTypes.ChoiceElementOption[]\n    }\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,\n) => {\n  try {\n    return conditionallyShowElement(formElementsCtrl, element, [])\n  } catch (error) {\n    console.warn('Error while checking if element is conditional shown', error)\n    errorCallback && 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,\n) => {\n  try {\n    return conditionallyShowOption(formElementsCtrl, element, option, [])\n  } catch (error) {\n    errorCallback && errorCallback(error as Error)\n    return false\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            | Record<string, unknown>\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<Record<string, unknown>>\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            switch (element.type) {\n              case 'compliance':\n              case 'autocomplete':\n              case 'radio':\n              case 'checkboxes':\n              case 'select': {\n                if (\n                  element.conditionallyShowOptions &&\n                  Array.isArray(element.options)\n                ) {\n                  formElementConditionallyShown.options =\n                    element.options.filter((option) =>\n                      handleConditionallyShowOption(\n                        formElementsCtrl,\n                        element,\n                        option,\n                        errorCallback,\n                      ),\n                    )\n                }\n                break\n              }\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"]}

package/dist/conditionalLogicService.d.ts

@@ -0,0 +1,71 @@
+import { ConditionTypes, FormTypes, SubmissionTypes } from '@oneblink/types';
+export * from './conditionalLogicService/generateFormElementsConditionallyShown';
+/**
+ * Given a set of form elements and submission data, evaluate if predicates are
+ * met or not.
+ *
+ * #### Example
+ *
+ * ```js
+ * const evaluation = conditionalLogicService.evaluateConditionalPredicates(
+ *   {
+ *     isConditional: true,
+ *     requiresAllConditionalPredicates: false,
+ *     conditionalPredicates: [
+ *       {
+ *         type: 'OPTIONS',
+ *         elementId: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',
+ *         optionIds: ['9ce633dd-22d6-4e0e-a9e0-1aa62d435e72'],
+ *       },
+ *     ],
+ *     submission: {
+ *       checkboxes: ['a'],
+ *     },
+ *     formElements: [
+ *       {
+ *         name: 'checkboxes',
+ *         label: 'Checkboxes',
+ *         type: 'checkboxes',
+ *         required: false,
+ *         id: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',
+ *         options: [
+ *           {
+ *             id: '9ce633dd-22d6-4e0e-a9e0-1aa62d435e72',
+ *             label: 'First',
+ *             value: 'a',
+ *           },
+ *           {
+ *             id: '5850b32c-3833-4498-a072-47fcc8122242',
+ *             label: 'Second',
+ *             value: 'b',
+ *           },
+ *           {
+ *             id: 'ab363e9f-a63f-4923-ba0d-47892fc26a93',
+ *             label: 'Third',
+ *             value: 'c',
+ *           },
+ *         ],
+ *         readOnly: false,
+ *         buttons: false,
+ *         optionsType: 'CUSTOM',
+ *         conditionallyShowOptions: false,
+ *         isDataLookup: false,
+ *         isElementLookup: false,
+ *         conditionallyShow: false,
+ *         requiresAllConditionallyShowPredicates: false,
+ *       },
+ *     ],
+ *   },
+ * )
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export declare function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, }: {
+    isConditional: boolean;
+    requiresAllConditionalPredicates: boolean;
+    conditionalPredicates: ConditionTypes.ConditionalPredicate[];
+    formElements: FormTypes.FormElement[];
+    submission: SubmissionTypes.S3SubmissionData['submission'];
+}): boolean;

package/dist/conditionalLogicService.js

@@ -0,0 +1,106 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateConditionalPredicates = void 0;
+const evaluateConditionalPredicate_1 = __importDefault(require("./conditionalLogicService/evaluateConditionalPredicate"));
+const formElementsService_1 = require("./formElementsService");
+__exportStar(require("./conditionalLogicService/generateFormElementsConditionallyShown"), exports);
+/**
+ * Given a set of form elements and submission data, evaluate if predicates are
+ * met or not.
+ *
+ * #### Example
+ *
+ * ```js
+ * const evaluation = conditionalLogicService.evaluateConditionalPredicates(
+ *   {
+ *     isConditional: true,
+ *     requiresAllConditionalPredicates: false,
+ *     conditionalPredicates: [
+ *       {
+ *         type: 'OPTIONS',
+ *         elementId: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',
+ *         optionIds: ['9ce633dd-22d6-4e0e-a9e0-1aa62d435e72'],
+ *       },
+ *     ],
+ *     submission: {
+ *       checkboxes: ['a'],
+ *     },
+ *     formElements: [
+ *       {
+ *         name: 'checkboxes',
+ *         label: 'Checkboxes',
+ *         type: 'checkboxes',
+ *         required: false,
+ *         id: '3534abe4-b0b5-4ffa-a216-49c223ab6f95',
+ *         options: [
+ *           {
+ *             id: '9ce633dd-22d6-4e0e-a9e0-1aa62d435e72',
+ *             label: 'First',
+ *             value: 'a',
+ *           },
+ *           {
+ *             id: '5850b32c-3833-4498-a072-47fcc8122242',
+ *             label: 'Second',
+ *             value: 'b',
+ *           },
+ *           {
+ *             id: 'ab363e9f-a63f-4923-ba0d-47892fc26a93',
+ *             label: 'Third',
+ *             value: 'c',
+ *           },
+ *         ],
+ *         readOnly: false,
+ *         buttons: false,
+ *         optionsType: 'CUSTOM',
+ *         conditionallyShowOptions: false,
+ *         isDataLookup: false,
+ *         isElementLookup: false,
+ *         conditionallyShow: false,
+ *         requiresAllConditionallyShowPredicates: false,
+ *       },
+ *     ],
+ *   },
+ * )
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+function evaluateConditionalPredicates({ isConditional, requiresAllConditionalPredicates, conditionalPredicates, formElements, submission, }) {
+    if (!isConditional || !conditionalPredicates.length) {
+        return true;
+    }
+    const formElementsCtrl = {
+        flattenedElements: (0, formElementsService_1.flattenFormElements)(formElements),
+        model: submission,
+    };
+    const predicateFn = (predicate) => (0, evaluateConditionalPredicate_1.default)({
+        predicate,
+        formElementsCtrl,
+    });
+    if (requiresAllConditionalPredicates) {
+        return conditionalPredicates.every(predicateFn);
+    }
+    else {
+        return conditionalPredicates.some(predicateFn);
+    }
+}
+exports.evaluateConditionalPredicates = evaluateConditionalPredicates;
+//# sourceMappingURL=conditionalLogicService.js.map

package/dist/conditionalLogicService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionalLogicService.js","sourceRoot":"","sources":["../src/conditionalLogicService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,0HAAiG;AACjG,+DAA2D;AAG3D,mGAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,SAAgB,6BAA6B,CAAC,EAC5C,aAAa,EACb,gCAAgC,EAChC,qBAAqB,EACrB,YAAY,EACZ,UAAU,GAOX;IACC,IAAI,CAAC,aAAa,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE;QACnD,OAAO,IAAI,CAAA;KACZ;IACD,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE,IAAA,yCAAmB,EAAC,YAAY,CAAC;QACpD,KAAK,EAAE,UAAU;KAClB,CAAA;IAED,MAAM,WAAW,GAAG,CAAC,SAA8C,EAAE,EAAE,CACrE,IAAA,sCAA4B,EAAC;QAC3B,SAAS;QACT,gBAAgB;KACjB,CAAC,CAAA;IACJ,IAAI,gCAAgC,EAAE;QACpC,OAAO,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;KAChD;SAAM;QACL,OAAO,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;KAC/C;AACH,CAAC;AA/BD,sEA+BC","sourcesContent":["import evaluateConditionalPredicate from './conditionalLogicService/evaluateConditionalPredicate'\nimport { flattenFormElements } from './formElementsService'\nimport { ConditionTypes, FormTypes, SubmissionTypes } from '@oneblink/types'\n\nexport * from './conditionalLogicService/generateFormElementsConditionallyShown'\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"]}

package/dist/fileUploadService.d.ts

@@ -1 +1,15 @@
+/**
+ * Attempts to get the content disposition for the header by compiling a string
+ * of UTF-8 formatting based on the file name.
+ *
+ * #### Example
+ *
+ * ```js
+ * const contentDisposition =
+ *   fileUploadService.getContentDisposition(fileName)
+ * ```
+ *
+ * @param filename The name of the file being uploaded
+ * @returns
+ */
 export declare function getContentDisposition(filename: string): string;

package/dist/fileUploadService.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContentDisposition = void 0;
+/**
+ * Attempts to get the content disposition for the header by compiling a string
+ * of UTF-8 formatting based on the file name.
+ *
+ * #### Example
+ *
+ * ```js
+ * const contentDisposition =
+ *   fileUploadService.getContentDisposition(fileName)
+ * ```
+ *
+ * @param filename The name of the file being uploaded
+ * @returns
+ */
 function getContentDisposition(filename) {
     return `attachment; filename*=UTF-8''${encodeURIComponent(filename)}`;
 }

package/dist/fileUploadService.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileUploadService.js","sourceRoot":"","sources":["../src/fileUploadService.ts"],"names":[],"mappings":";;;AAAA,SAAgB,qBAAqB,CAAC,QAAgB;IACpD,OAAO,gCAAgC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAA;AACvE,CAAC;AAFD,sDAEC","sourcesContent":["export function getContentDisposition(filename: string): string {\n  return `attachment; filename*=UTF-8''${encodeURIComponent(filename)}`\n}\n"]}
+{"version":3,"file":"fileUploadService.js","sourceRoot":"","sources":["../src/fileUploadService.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,QAAgB;IACpD,OAAO,gCAAgC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAA;AACvE,CAAC;AAFD,sDAEC","sourcesContent":["/**\n * Attempts to get the content disposition for the header by compiling a string\n * of UTF-8 formatting based on the file name.\n *\n * #### Example\n *\n * ```js\n * const contentDisposition =\n *   fileUploadService.getContentDisposition(fileName)\n * ```\n *\n * @param filename The name of the file being uploaded\n * @returns\n */\nexport function getContentDisposition(filename: string): string {\n  return `attachment; filename*=UTF-8''${encodeURIComponent(filename)}`\n}\n"]}

package/dist/formElementsService.d.ts

@@ -1,10 +1,89 @@
 import { FormTypes } from '@oneblink/types';
+/**
+ * Iterate over all form elements, also iterating over nested form element (e.g.
+ * page elements).
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.forEachFormElement(form.elements, (formElement) => {
+ *   // do something with formElement
+ * })
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param forEach Function to execute on each form element
+ */
 declare function forEachFormElement(elements: FormTypes.FormElement[], forEach: (element: FormTypes.FormElement, elements: FormTypes.FormElement[]) => void): void;
+/**
+ * Iterate over all form elements that have options (e.g. `'select'` type
+ * elements), also iterating over nested form element (e.g. page elements).
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.forEachFormElementWithOptions(
+ *   form.elements,
+ *   (formElementWithOptions) => {
+ *     // do something with formElementWithOptions
+ *   },
+ * )
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param forEach Function to execute on each form element with options
+ */
 declare function forEachFormElementWithOptions(elements: FormTypes.FormElement[], forEach: (elementWithOptions: FormTypes.FormElementWithOptions, elements: FormTypes.FormElement[]) => void): void;
+/**
+ * Iterate over all form elements and return an element that matches a
+ * predicate, also iterating over nested form element (e.g. page elements). Will
+ * return `undefined` if no matching element is found.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formElement = formElementsService.findFormElement(
+ *   form.elements,
+ *   (formElement) => {
+ *     return formElement.id === '123-abc'
+ *   },
+ * )
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param predicate Predicate function to execute on each form element
+ * @param parentElements
+ * @returns
+ */
 declare function findFormElement(elements: FormTypes.FormElement[], predicate: (element: FormTypes.FormElement, elements: FormTypes.FormElement[]) => boolean, parentElements?: FormTypes.FormElement[]): FormTypes.FormElement | void;
+/**
+ * Parse unknown data as valid options for a forms element. This will always
+ * return an Array of valid options.
+ *
+ * #### Example
+ *
+ * ```js
+ * const options = formElementsService.parseFormElementOptionsSet(data)
+ * // "options" are valid for a form element
+ * ```
+ *
+ * @param data
+ * @returns
+ */
 declare function parseFormElementOptionsSet(data: unknown): FormTypes.ChoiceElementOption[];
+/**
+ * Takes the nested definition structure and returns all form elements as 1d array.
+ *
+ * #### Example
+ *
+ * ```js
+ * const flattenedElements = formElementsService.flattenFormElements(
+ *   form.elements,
+ * )
+ * ```
+ *
+ * @param elements
+ * @returns
+ */
 declare function flattenFormElements(elements: FormTypes.FormElement[]): FormTypes.FormElement[];
-declare function getRootElementValueById(formElementId: string, formElements: FormTypes.FormElement[], submission: {
-    readonly [key: string]: unknown;
-}): unknown;
-export { getRootElementValueById, forEachFormElement, forEachFormElementWithOptions, findFormElement, parseFormElementOptionsSet, flattenFormElements, };
+export { forEachFormElement, forEachFormElementWithOptions, findFormElement, parseFormElementOptionsSet, flattenFormElements, };

package/dist/formElementsService.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.flattenFormElements = exports.parseFormElementOptionsSet = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = exports.getRootElementValueById = void 0;
+exports.flattenFormElements = exports.parseFormElementOptionsSet = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = void 0;
+/**
+ * Iterate over all form elements, also iterating over nested form element (e.g.
+ * page elements).
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.forEachFormElement(form.elements, (formElement) => {
+ *   // do something with formElement
+ * })
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param forEach Function to execute on each form element
+ */
 function forEachFormElement(elements, forEach) {
     findFormElement(elements, (formElement, parentElements) => {
         forEach(formElement, parentElements);
@@ -8,6 +23,24 @@ function forEachFormElement(elements, forEach) {
     });
 }
 exports.forEachFormElement = forEachFormElement;
+/**
+ * Iterate over all form elements that have options (e.g. `'select'` type
+ * elements), also iterating over nested form element (e.g. page elements).
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.forEachFormElementWithOptions(
+ *   form.elements,
+ *   (formElementWithOptions) => {
+ *     // do something with formElementWithOptions
+ *   },
+ * )
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param forEach Function to execute on each form element with options
+ */
 function forEachFormElementWithOptions(elements, forEach) {
     findFormElement(elements, (formElement, parentElements) => {
         if (formElement.type === 'select' ||
@@ -21,6 +54,27 @@ function forEachFormElementWithOptions(elements, forEach) {
     });
 }
 exports.forEachFormElementWithOptions = forEachFormElementWithOptions;
+/**
+ * Iterate over all form elements and return an element that matches a
+ * predicate, also iterating over nested form element (e.g. page elements). Will
+ * return `undefined` if no matching element is found.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formElement = formElementsService.findFormElement(
+ *   form.elements,
+ *   (formElement) => {
+ *     return formElement.id === '123-abc'
+ *   },
+ * )
+ * ```
+ *
+ * @param elements The form elements to iterate over
+ * @param predicate Predicate function to execute on each form element
+ * @param parentElements
+ * @returns
+ */
 function findFormElement(elements, predicate, parentElements = []) {
     for (const element of elements) {
         if (predicate(element, parentElements)) {
@@ -43,6 +97,20 @@ function findFormElement(elements, predicate, parentElements = []) {
     }
 }
 exports.findFormElement = findFormElement;
+/**
+ * Parse unknown data as valid options for a forms element. This will always
+ * return an Array of valid options.
+ *
+ * #### Example
+ *
+ * ```js
+ * const options = formElementsService.parseFormElementOptionsSet(data)
+ * // "options" are valid for a form element
+ * ```
+ *
+ * @param data
+ * @returns
+ */
 function parseFormElementOptionsSet(data) {
     if (!Array.isArray(data)) {
         return [];
@@ -79,6 +147,20 @@ function parseFormElementOptionsSet(data) {
     }, []);
 }
 exports.parseFormElementOptionsSet = parseFormElementOptionsSet;
+/**
+ * Takes the nested definition structure and returns all form elements as 1d array.
+ *
+ * #### Example
+ *
+ * ```js
+ * const flattenedElements = formElementsService.flattenFormElements(
+ *   form.elements,
+ * )
+ * ```
+ *
+ * @param elements
+ * @returns
+ */
 function flattenFormElements(elements) {
     return elements.reduce((flattenedElements, element) => {
         flattenedElements.push(element);
@@ -92,18 +174,4 @@ function flattenFormElements(elements) {
     }, []);
 }
 exports.flattenFormElements = flattenFormElements;
-function getRootElementValueById(formElementId, formElements, submission) {
-    for (const formElement of formElements) {
-        if (formElement.type === 'page' || formElement.type === 'section') {
-            const value = getRootElementValueById(formElementId, formElement.elements, submission);
-            if (value !== undefined) {
-                return value;
-            }
-        }
-        else if (formElement.id === formElementId) {
-            return submission[formElement.name];
-        }
-    }
-}
-exports.getRootElementValueById = getRootElementValueById;
 //# sourceMappingURL=formElementsService.js.map