@oneblink/sdk-core 3.2.0 → 4.0.0

package/dist/formElementsService.d.ts

@@ -57,20 +57,20 @@ declare function forEachFormElementWithOptions(elements: FormTypes.FormElement[]
  */
 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.
+ * Parse unknown data as valid dynamic options for a forms element. This will
+ * always return an Array of valid dynamic options.
  *
  * #### Example
  *
  * ```js
- * const options = formElementsService.parseFormElementOptionsSet(data)
+ * const options = formElementsService.parseDynamicFormElementOptions(data)
  * // "options" are valid for a form element
  * ```
  *
  * @param data
  * @returns
  */
-declare function parseFormElementOptionsSet(data: unknown): FormTypes.ChoiceElementOption[];
+declare function parseDynamicFormElementOptions(data: unknown): FormTypes.DynamicChoiceElementOption[];
 /**
  * Takes the nested definition structure and returns all form elements as 1d
  * array.
@@ -125,4 +125,4 @@ declare const matchElementsTagRegex: (data: string, matchHandler: (options: {
  * @returns
  */
 declare function determineIsInfoPage(form: FormTypes.Form): boolean;
-export { forEachFormElement, forEachFormElementWithOptions, findFormElement, parseFormElementOptionsSet, flattenFormElements, ElementWYSIWYGRegex, matchElementsTagRegex, determineIsInfoPage, };
+export { forEachFormElement, forEachFormElementWithOptions, findFormElement, parseDynamicFormElementOptions, flattenFormElements, ElementWYSIWYGRegex, matchElementsTagRegex, determineIsInfoPage, };

package/dist/formElementsService.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.determineIsInfoPage = exports.matchElementsTagRegex = exports.ElementWYSIWYGRegex = exports.flattenFormElements = exports.parseFormElementOptionsSet = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = void 0;
+exports.determineIsInfoPage = exports.matchElementsTagRegex = exports.ElementWYSIWYGRegex = exports.flattenFormElements = exports.parseDynamicFormElementOptions = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = void 0;
 const _1 = require(".");
 /**
  * Iterate over all form elements, also iterating over nested form element (e.g.
@@ -96,27 +96,26 @@ 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.
+ * Parse unknown data as valid dynamic options for a forms element. This will
+ * always return an Array of valid dynamic options.
  *
  * #### Example
  *
  * ```js
- * const options = formElementsService.parseFormElementOptionsSet(data)
+ * const options = formElementsService.parseDynamicFormElementOptions(data)
  * // "options" are valid for a form element
  * ```
  *
  * @param data
  * @returns
  */
-function parseFormElementOptionsSet(data) {
+function parseDynamicFormElementOptions(data) {
     if (!Array.isArray(data)) {
         return [];
     }
     return data.reduce((options, record, index) => {
         if (typeof record === 'string') {
             options.push({
-                id: index.toString(),
                 value: record,
                 label: record,
             });
@@ -126,25 +125,46 @@ function parseFormElementOptionsSet(data) {
             const value = typeof option.value === 'string' && option.value
                 ? option.value
                 : index.toString();
-            const id = typeof option.id === 'string' && option.id ? option.id : value;
             const label = typeof option.label === 'string' && option.label
                 ? option.label
                 : value;
             const colour = typeof option.colour === 'string' && option.colour
                 ? option.colour
                 : undefined;
+            const displayAlways = typeof option.displayAlways === 'boolean'
+                ? option.displayAlways
+                : undefined;
+            const attributes = Array.isArray(option.attributes)
+                ? option.attributes.reduce((memo, attribute) => {
+                    if (typeof attribute === 'object' &&
+                        attribute &&
+                        'value' in attribute &&
+                        typeof attribute.value === 'string' &&
+                        'label' in attribute &&
+                        typeof attribute.label === 'string') {
+                        memo.push({
+                            value: attribute.value,
+                            label: attribute.label,
+                        });
+                    }
+                    return memo;
+                }, [])
+                : undefined;
             options.push({
-                ...option,
-                id,
                 value,
                 label,
                 colour,
+                attributes,
+                displayAlways,
+                options: Array.isArray(option.options)
+                    ? parseDynamicFormElementOptions(option.options)
+                    : undefined,
             });
         }
         return options;
     }, []);
 }
-exports.parseFormElementOptionsSet = parseFormElementOptionsSet;
+exports.parseDynamicFormElementOptions = parseDynamicFormElementOptions;
 /**
  * Takes the nested definition structure and returns all form elements as 1d
  * array.

package/dist/formElementsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"formElementsService.js","sourceRoot":"","sources":["../src/formElementsService.ts"],"names":[],"mappings":";;;AACA,wBAAmC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,SAAS,kBAAkB,CACzB,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;QACpC,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AA6PC,gDAAkB;AA3PpB;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,6BAA6B,CACpC,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,MAAM,kBAAkB,GACtB,kBAAe,CAAC,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAC5D,IAAI,kBAAkB,EAAE;YACtB,OAAO,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAA;SAC5C;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AA2NC,sEAA6B;AAzN/B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,eAAe,CACtB,QAAiC,EACjC,SAGY,EACZ,iBAA0C,EAAE;IAE5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,IAAI,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE;YACtC,OAAO,OAAO,CAAA;SACf;QAED,IACE,CAAC,OAAO,CAAC,IAAI,KAAK,eAAe;YAC/B,OAAO,CAAC,IAAI,KAAK,MAAM;YACvB,OAAO,CAAC,IAAI,KAAK,MAAM;YACvB,OAAO,CAAC,IAAI,KAAK,UAAU;YAC3B,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;YAC7B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC/B;YACA,MAAM,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE;gBACjE,GAAG,cAAc;gBACjB,OAAO;aACR,CAAC,CAAA;YAEF,IAAI,aAAa,EAAE;gBACjB,OAAO,aAAa,CAAA;aACrB;SACF;KACF;AACH,CAAC;AAsKC,0CAAe;AApKjB;;;;;;;;;;;;;GAaG;AACH,SAAS,0BAA0B,CACjC,IAAa;IAEb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxB,OAAO,EAAE,CAAA;KACV;IACD,OAAO,IAAI,CAAC,MAAM,CAChB,CACE,OAAwC,EACxC,MAAe,EACf,KAAa,EACb,EAAE;QACF,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;gBACpB,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,MAAM;aACd,CAAC,CAAA;SACH;aAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YACrC,MAAM,MAAM,GAAG,MAAiC,CAAA;YAChD,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK;gBAC9C,CAAC,CAAC,MAAM,CAAC,KAAK;gBACd,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAA;YACtB,MAAM,EAAE,GACN,OAAO,MAAM,CAAC,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YAChE,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK;gBAC9C,CAAC,CAAC,MAAM,CAAC,KAAK;gBACd,CAAC,CAAC,KAAK,CAAA;YACX,MAAM,MAAM,GACV,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM;gBAChD,CAAC,CAAC,MAAM,CAAC,MAAM;gBACf,CAAC,CAAC,SAAS,CAAA;YACf,OAAO,CAAC,IAAI,CAAC;gBACX,GAAG,MAAM;gBACT,EAAE;gBACF,KAAK;gBACL,KAAK;gBACL,MAAM;aACP,CAAC,CAAA;SACH;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC;AAyGC,gEAA0B;AAvG5B;;;;;;;;;;;;;;GAcG;AACH,SAAS,mBAAmB,CAC1B,QAAiC;IAEjC,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE;QAC7B,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC/B,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,iBAAiB,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;aACjE;SACF;QACD,OAAO,iBAAiB,CAAA;IAC1B,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC;AAyEC,kDAAmB;AAvErB;;;GAGG;AACH,MAAM,mBAAmB,GAAG,wBAAwB,CAAA;AAoElD,kDAAmB;AAlErB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,qBAAqB,GAAG,CAC5B,IAAY,EACZ,YAGU,EACV,EAAE;IACF,IAAI,OAAO,CAAA;IACX,OAAO,CAAC,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,IAAG,CAAC;YAAE,SAAQ;QAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QAC9B,YAAY,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;KACxD;AACH,CAAC,CAAA;AAgCC,sDAAqB;AA9BvB,MAAM,gBAAgB,GAAgC;IACpD,SAAS;IACT,MAAM;IACN,OAAO;IACP,SAAS;IACT,MAAM;IACN,UAAU;IACV,MAAM;CACP,CAAA;AACD;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,IAAoB;IAC/C,MAAM,iBAAiB,GAAG,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7D,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IACF,OAAO,CAAC,iBAAiB,CAAA;AAC3B,CAAC;AAUC,kDAAmB","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport { typeCastService } from '.'\n\n/**\n * Iterate over all form elements, also iterating over nested form element (e.g.\n * page elements).\n *\n * #### Example\n *\n * ```js\n * formElementsService.forEachFormElement(form.elements, (formElement) => {\n *   // do something with formElement\n * })\n * ```\n *\n * @param elements The form elements to iterate over\n * @param forEach Function to execute on each form element\n */\nfunction forEachFormElement(\n  elements: FormTypes.FormElement[],\n  forEach: (\n    element: FormTypes.FormElement,\n    elements: FormTypes.FormElement[],\n  ) => void,\n): void {\n  findFormElement(elements, (formElement, parentElements) => {\n    forEach(formElement, parentElements)\n    return false\n  })\n}\n\n/**\n * Iterate over all form elements that have options (e.g. `'select'` type\n * elements), also iterating over nested form element (e.g. page elements).\n *\n * #### Example\n *\n * ```js\n * formElementsService.forEachFormElementWithOptions(\n *   form.elements,\n *   (formElementWithOptions) => {\n *     // do something with formElementWithOptions\n *   },\n * )\n * ```\n *\n * @param elements The form elements to iterate over\n * @param forEach Function to execute on each form element with options\n */\nfunction forEachFormElementWithOptions(\n  elements: FormTypes.FormElement[],\n  forEach: (\n    elementWithOptions: FormTypes.FormElementWithOptions,\n    elements: FormTypes.FormElement[],\n  ) => void,\n): void {\n  findFormElement(elements, (formElement, parentElements) => {\n    const optionsFormElement =\n      typeCastService.formElements.toOptionsElement(formElement)\n    if (optionsFormElement) {\n      forEach(optionsFormElement, parentElements)\n    }\n    return false\n  })\n}\n\n/**\n * Iterate over all form elements and return an element that matches a\n * predicate, also iterating over nested form element (e.g. page elements). Will\n * return `undefined` if no matching element is found.\n *\n * #### Example\n *\n * ```js\n * const formElement = formElementsService.findFormElement(\n *   form.elements,\n *   (formElement) => {\n *     return formElement.id === '123-abc'\n *   },\n * )\n * ```\n *\n * @param elements The form elements to iterate over\n * @param predicate Predicate function to execute on each form element\n * @param parentElements\n * @returns\n */\nfunction findFormElement(\n  elements: FormTypes.FormElement[],\n  predicate: (\n    element: FormTypes.FormElement,\n    elements: FormTypes.FormElement[],\n  ) => boolean,\n  parentElements: FormTypes.FormElement[] = [],\n): FormTypes.FormElement | void {\n  for (const element of elements) {\n    if (predicate(element, parentElements)) {\n      return element\n    }\n\n    if (\n      (element.type === 'repeatableSet' ||\n        element.type === 'page' ||\n        element.type === 'form' ||\n        element.type === 'infoPage' ||\n        element.type === 'section') &&\n      Array.isArray(element.elements)\n    ) {\n      const nestedElement = findFormElement(element.elements, predicate, [\n        ...parentElements,\n        element,\n      ])\n\n      if (nestedElement) {\n        return nestedElement\n      }\n    }\n  }\n}\n\n/**\n * Parse unknown data as valid options for a forms element. This will always\n * return an Array of valid options.\n *\n * #### Example\n *\n * ```js\n * const options = formElementsService.parseFormElementOptionsSet(data)\n * // \"options\" are valid for a form element\n * ```\n *\n * @param data\n * @returns\n */\nfunction parseFormElementOptionsSet(\n  data: unknown,\n): FormTypes.ChoiceElementOption[] {\n  if (!Array.isArray(data)) {\n    return []\n  }\n  return data.reduce(\n    (\n      options: FormTypes.ChoiceElementOption[],\n      record: unknown,\n      index: number,\n    ) => {\n      if (typeof record === 'string') {\n        options.push({\n          id: index.toString(),\n          value: record,\n          label: record,\n        })\n      } else if (typeof record === 'object') {\n        const option = record as Record<string, unknown>\n        const value =\n          typeof option.value === 'string' && option.value\n            ? option.value\n            : index.toString()\n        const id =\n          typeof option.id === 'string' && option.id ? option.id : value\n        const label =\n          typeof option.label === 'string' && option.label\n            ? option.label\n            : value\n        const colour =\n          typeof option.colour === 'string' && option.colour\n            ? option.colour\n            : undefined\n        options.push({\n          ...option,\n          id,\n          value,\n          label,\n          colour,\n        })\n      }\n      return options\n    },\n    [],\n  )\n}\n\n/**\n * Takes the nested definition structure and returns all form elements as 1d\n * array.\n *\n * #### Example\n *\n * ```js\n * const flattenedElements = formElementsService.flattenFormElements(\n *   form.elements,\n * )\n * ```\n *\n * @param elements\n * @returns\n */\nfunction flattenFormElements(\n  elements: FormTypes.FormElement[],\n): FormTypes.FormElement[] {\n  return elements.reduce<FormTypes.FormElement[]>(\n    (flattenedElements, element) => {\n      flattenedElements.push(element)\n      switch (element.type) {\n        case 'section':\n        case 'page': {\n          flattenedElements.push(...flattenFormElements(element.elements))\n        }\n      }\n      return flattenedElements\n    },\n    [],\n  )\n}\n\n/**\n * The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink\n * platform.\n */\nconst ElementWYSIWYGRegex = /({ELEMENT:)([^}]+)(})/g\n\n/**\n * Takes a string and calls a provided handler function for each found instance\n * of `{ELEMENT:<elementName>}` in the string. Used to replace values in\n * OneBlink calculation and info (HTML) elements.\n *\n * #### Example\n *\n * ```js\n * formElementsService.matchElementsTagRegex(\n *   myString,\n *   ({ elementName, elementMatch }) => {\n *     const v = submission[elementName]\n *     myString = myString.replace(elementMatch, v)\n *   },\n * )\n * ```\n *\n * @param data\n * @param handler\n * @returns\n */\nconst matchElementsTagRegex = (\n  data: string,\n  matchHandler: (options: {\n    elementName: string\n    elementMatch: string\n  }) => void,\n) => {\n  let matches\n  while ((matches = ElementWYSIWYGRegex.exec(data)) !== null) {\n    if (matches?.length < 3) continue\n\n    const elementName = matches[2]\n    matchHandler({ elementName, elementMatch: matches[0] })\n  }\n}\n\nconst infoPageElements: FormTypes.FormElementType[] = [\n  'heading',\n  'html',\n  'image',\n  'section',\n  'page',\n  'infoPage',\n  'form',\n]\n/**\n * Determine a form is considered an info page. This means the form does not\n * allow any user input.\n *\n * @param form\n * @returns\n */\nfunction determineIsInfoPage(form: FormTypes.Form): boolean {\n  const foundInputElement = findFormElement(form.elements, (e) => {\n    return !infoPageElements.includes(e.type)\n  })\n  return !foundInputElement\n}\n\nexport {\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseFormElementOptionsSet,\n  flattenFormElements,\n  ElementWYSIWYGRegex,\n  matchElementsTagRegex,\n  determineIsInfoPage,\n}\n"]}
+{"version":3,"file":"formElementsService.js","sourceRoot":"","sources":["../src/formElementsService.ts"],"names":[],"mappings":";;;AACA,wBAAmC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,SAAS,kBAAkB,CACzB,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;QACpC,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AAiRC,gDAAkB;AA/QpB;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,6BAA6B,CACpC,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,MAAM,kBAAkB,GACtB,kBAAe,CAAC,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAC5D,IAAI,kBAAkB,EAAE;YACtB,OAAO,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAA;SAC5C;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AA+OC,sEAA6B;AA7O/B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,eAAe,CACtB,QAAiC,EACjC,SAGY,EACZ,iBAA0C,EAAE;IAE5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,IAAI,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE;YACtC,OAAO,OAAO,CAAA;SACf;QAED,IACE,CAAC,OAAO,CAAC,IAAI,KAAK,eAAe;YAC/B,OAAO,CAAC,IAAI,KAAK,MAAM;YACvB,OAAO,CAAC,IAAI,KAAK,MAAM;YACvB,OAAO,CAAC,IAAI,KAAK,UAAU;YAC3B,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;YAC7B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC/B;YACA,MAAM,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE;gBACjE,GAAG,cAAc;gBACjB,OAAO;aACR,CAAC,CAAA;YAEF,IAAI,aAAa,EAAE;gBACjB,OAAO,aAAa,CAAA;aACrB;SACF;KACF;AACH,CAAC;AA0LC,0CAAe;AAxLjB;;;;;;;;;;;;;GAaG;AACH,SAAS,8BAA8B,CACrC,IAAa;IAEb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxB,OAAO,EAAE,CAAA;KACV;IACD,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;QACzB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,MAAM;aACd,CAAC,CAAA;SACH;aAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YACrC,MAAM,MAAM,GAAG,MAAiC,CAAA;YAChD,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK;gBAC9C,CAAC,CAAC,MAAM,CAAC,KAAK;gBACd,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAA;YACtB,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK;gBAC9C,CAAC,CAAC,MAAM,CAAC,KAAK;gBACd,CAAC,CAAC,KAAK,CAAA;YACX,MAAM,MAAM,GACV,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM;gBAChD,CAAC,CAAC,MAAM,CAAC,MAAM;gBACf,CAAC,CAAC,SAAS,CAAA;YACf,MAAM,aAAa,GACjB,OAAO,MAAM,CAAC,aAAa,KAAK,SAAS;gBACvC,CAAC,CAAC,MAAM,CAAC,aAAa;gBACtB,CAAC,CAAC,SAAS,CAAA;YACf,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;gBACjD,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAEtB,CAAC,IAAI,EAAE,SAAkB,EAAE,EAAE;oBAC7B,IACE,OAAO,SAAS,KAAK,QAAQ;wBAC7B,SAAS;wBACT,OAAO,IAAI,SAAS;wBACpB,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ;wBACnC,OAAO,IAAI,SAAS;wBACpB,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,EACnC;wBACA,IAAI,CAAC,IAAI,CAAC;4BACR,KAAK,EAAE,SAAS,CAAC,KAAK;4BACtB,KAAK,EAAE,SAAS,CAAC,KAAK;yBACvB,CAAC,CAAA;qBACH;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC,EAAE,EAAE,CAAC;gBACR,CAAC,CAAC,SAAS,CAAA;YACb,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK;gBACL,KAAK;gBACL,MAAM;gBACN,UAAU;gBACV,aAAa;gBACb,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;oBACpC,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,OAAO,CAAC;oBAChD,CAAC,CAAC,SAAS;aACd,CAAC,CAAA;SACH;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC;AAyGC,wEAA8B;AAvGhC;;;;;;;;;;;;;;GAcG;AACH,SAAS,mBAAmB,CAC1B,QAAiC;IAEjC,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE;QAC7B,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC/B,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,iBAAiB,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;aACjE;SACF;QACD,OAAO,iBAAiB,CAAA;IAC1B,CAAC,EACD,EAAE,CACH,CAAA;AACH,CAAC;AAyEC,kDAAmB;AAvErB;;;GAGG;AACH,MAAM,mBAAmB,GAAG,wBAAwB,CAAA;AAoElD,kDAAmB;AAlErB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,qBAAqB,GAAG,CAC5B,IAAY,EACZ,YAGU,EACV,EAAE;IACF,IAAI,OAAO,CAAA;IACX,OAAO,CAAC,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,IAAG,CAAC;YAAE,SAAQ;QAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QAC9B,YAAY,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;KACxD;AACH,CAAC,CAAA;AAgCC,sDAAqB;AA9BvB,MAAM,gBAAgB,GAAgC;IACpD,SAAS;IACT,MAAM;IACN,OAAO;IACP,SAAS;IACT,MAAM;IACN,UAAU;IACV,MAAM;CACP,CAAA;AACD;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,IAAoB;IAC/C,MAAM,iBAAiB,GAAG,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7D,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IACF,OAAO,CAAC,iBAAiB,CAAA;AAC3B,CAAC;AAUC,kDAAmB","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport { typeCastService } from '.'\n\n/**\n * Iterate over all form elements, also iterating over nested form element (e.g.\n * page elements).\n *\n * #### Example\n *\n * ```js\n * formElementsService.forEachFormElement(form.elements, (formElement) => {\n *   // do something with formElement\n * })\n * ```\n *\n * @param elements The form elements to iterate over\n * @param forEach Function to execute on each form element\n */\nfunction forEachFormElement(\n  elements: FormTypes.FormElement[],\n  forEach: (\n    element: FormTypes.FormElement,\n    elements: FormTypes.FormElement[],\n  ) => void,\n): void {\n  findFormElement(elements, (formElement, parentElements) => {\n    forEach(formElement, parentElements)\n    return false\n  })\n}\n\n/**\n * Iterate over all form elements that have options (e.g. `'select'` type\n * elements), also iterating over nested form element (e.g. page elements).\n *\n * #### Example\n *\n * ```js\n * formElementsService.forEachFormElementWithOptions(\n *   form.elements,\n *   (formElementWithOptions) => {\n *     // do something with formElementWithOptions\n *   },\n * )\n * ```\n *\n * @param elements The form elements to iterate over\n * @param forEach Function to execute on each form element with options\n */\nfunction forEachFormElementWithOptions(\n  elements: FormTypes.FormElement[],\n  forEach: (\n    elementWithOptions: FormTypes.FormElementWithOptions,\n    elements: FormTypes.FormElement[],\n  ) => void,\n): void {\n  findFormElement(elements, (formElement, parentElements) => {\n    const optionsFormElement =\n      typeCastService.formElements.toOptionsElement(formElement)\n    if (optionsFormElement) {\n      forEach(optionsFormElement, parentElements)\n    }\n    return false\n  })\n}\n\n/**\n * Iterate over all form elements and return an element that matches a\n * predicate, also iterating over nested form element (e.g. page elements). Will\n * return `undefined` if no matching element is found.\n *\n * #### Example\n *\n * ```js\n * const formElement = formElementsService.findFormElement(\n *   form.elements,\n *   (formElement) => {\n *     return formElement.id === '123-abc'\n *   },\n * )\n * ```\n *\n * @param elements The form elements to iterate over\n * @param predicate Predicate function to execute on each form element\n * @param parentElements\n * @returns\n */\nfunction findFormElement(\n  elements: FormTypes.FormElement[],\n  predicate: (\n    element: FormTypes.FormElement,\n    elements: FormTypes.FormElement[],\n  ) => boolean,\n  parentElements: FormTypes.FormElement[] = [],\n): FormTypes.FormElement | void {\n  for (const element of elements) {\n    if (predicate(element, parentElements)) {\n      return element\n    }\n\n    if (\n      (element.type === 'repeatableSet' ||\n        element.type === 'page' ||\n        element.type === 'form' ||\n        element.type === 'infoPage' ||\n        element.type === 'section') &&\n      Array.isArray(element.elements)\n    ) {\n      const nestedElement = findFormElement(element.elements, predicate, [\n        ...parentElements,\n        element,\n      ])\n\n      if (nestedElement) {\n        return nestedElement\n      }\n    }\n  }\n}\n\n/**\n * Parse unknown data as valid dynamic options for a forms element. This will\n * always return an Array of valid dynamic options.\n *\n * #### Example\n *\n * ```js\n * const options = formElementsService.parseDynamicFormElementOptions(data)\n * // \"options\" are valid for a form element\n * ```\n *\n * @param data\n * @returns\n */\nfunction parseDynamicFormElementOptions(\n  data: unknown,\n): FormTypes.DynamicChoiceElementOption[] {\n  if (!Array.isArray(data)) {\n    return []\n  }\n  return data.reduce<FormTypes.DynamicChoiceElementOption[]>(\n    (options, record, index) => {\n      if (typeof record === 'string') {\n        options.push({\n          value: record,\n          label: record,\n        })\n      } else if (typeof record === 'object') {\n        const option = record as Record<string, unknown>\n        const value =\n          typeof option.value === 'string' && option.value\n            ? option.value\n            : index.toString()\n        const label =\n          typeof option.label === 'string' && option.label\n            ? option.label\n            : value\n        const colour =\n          typeof option.colour === 'string' && option.colour\n            ? option.colour\n            : undefined\n        const displayAlways =\n          typeof option.displayAlways === 'boolean'\n            ? option.displayAlways\n            : undefined\n        const attributes = Array.isArray(option.attributes)\n          ? option.attributes.reduce<\n              FormTypes.DynamicChoiceElementOptionAttribute[]\n            >((memo, attribute: unknown) => {\n              if (\n                typeof attribute === 'object' &&\n                attribute &&\n                'value' in attribute &&\n                typeof attribute.value === 'string' &&\n                'label' in attribute &&\n                typeof attribute.label === 'string'\n              ) {\n                memo.push({\n                  value: attribute.value,\n                  label: attribute.label,\n                })\n              }\n              return memo\n            }, [])\n          : undefined\n        options.push({\n          value,\n          label,\n          colour,\n          attributes,\n          displayAlways,\n          options: Array.isArray(option.options)\n            ? parseDynamicFormElementOptions(option.options)\n            : undefined,\n        })\n      }\n      return options\n    },\n    [],\n  )\n}\n\n/**\n * Takes the nested definition structure and returns all form elements as 1d\n * array.\n *\n * #### Example\n *\n * ```js\n * const flattenedElements = formElementsService.flattenFormElements(\n *   form.elements,\n * )\n * ```\n *\n * @param elements\n * @returns\n */\nfunction flattenFormElements(\n  elements: FormTypes.FormElement[],\n): FormTypes.FormElement[] {\n  return elements.reduce<FormTypes.FormElement[]>(\n    (flattenedElements, element) => {\n      flattenedElements.push(element)\n      switch (element.type) {\n        case 'section':\n        case 'page': {\n          flattenedElements.push(...flattenFormElements(element.elements))\n        }\n      }\n      return flattenedElements\n    },\n    [],\n  )\n}\n\n/**\n * The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink\n * platform.\n */\nconst ElementWYSIWYGRegex = /({ELEMENT:)([^}]+)(})/g\n\n/**\n * Takes a string and calls a provided handler function for each found instance\n * of `{ELEMENT:<elementName>}` in the string. Used to replace values in\n * OneBlink calculation and info (HTML) elements.\n *\n * #### Example\n *\n * ```js\n * formElementsService.matchElementsTagRegex(\n *   myString,\n *   ({ elementName, elementMatch }) => {\n *     const v = submission[elementName]\n *     myString = myString.replace(elementMatch, v)\n *   },\n * )\n * ```\n *\n * @param data\n * @param handler\n * @returns\n */\nconst matchElementsTagRegex = (\n  data: string,\n  matchHandler: (options: {\n    elementName: string\n    elementMatch: string\n  }) => void,\n) => {\n  let matches\n  while ((matches = ElementWYSIWYGRegex.exec(data)) !== null) {\n    if (matches?.length < 3) continue\n\n    const elementName = matches[2]\n    matchHandler({ elementName, elementMatch: matches[0] })\n  }\n}\n\nconst infoPageElements: FormTypes.FormElementType[] = [\n  'heading',\n  'html',\n  'image',\n  'section',\n  'page',\n  'infoPage',\n  'form',\n]\n/**\n * Determine a form is considered an info page. This means the form does not\n * allow any user input.\n *\n * @param form\n * @returns\n */\nfunction determineIsInfoPage(form: FormTypes.Form): boolean {\n  const foundInputElement = findFormElement(form.elements, (e) => {\n    return !infoPageElements.includes(e.type)\n  })\n  return !foundInputElement\n}\n\nexport {\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseDynamicFormElementOptions,\n  flattenFormElements,\n  ElementWYSIWYGRegex,\n  matchElementsTagRegex,\n  determineIsInfoPage,\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/sdk-core",
   "description": "OneBlink SDK for JavaScript (works in Browsers and NodeJS)",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-core-js/issues"