@oneblink/sdk-core 2.0.1-beta.1 → 2.0.1-beta.2

package/dist/formElementsService.d.ts

@@ -87,7 +87,7 @@ declare function parseFormElementOptionsSet(data: unknown): FormTypes.ChoiceElem
  */
 declare function flattenFormElements(elements: FormTypes.FormElement[]): FormTypes.FormElement[];
 /** The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink platform. */
-declare const WYSIWYGRegex: RegExp;
+declare const ElementWYSIWYGRegex: RegExp;
 /**
  * Takes a string and calls a provided handler function for each found instance
  * of `{ELEMENT:<elementName>}` in the string. Used to replace values in
@@ -113,4 +113,28 @@ declare const matchElementsTagRegex: (data: string, matchHandler: (options: {
     elementName: string;
     elementMatch: string;
 }) => void) => void;
-export { forEachFormElement, forEachFormElementWithOptions, findFormElement, parseFormElementOptionsSet, flattenFormElements, WYSIWYGRegex, matchElementsTagRegex, };
+/** The regex used for matching the `{USER:email}` tag in the OneBlink platform. */
+declare const UserWYSIWYGRegex: RegExp;
+/**
+ * Takes a string and calls a provided handler function for each found instance
+ * of `{ELEMENT:<elementName>}` in the string. Used to replace values in
+ * OneBlink calculation and info (HTML) elements.
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.matchElementsTagRegex(
+ *   myString,
+ *   ({ elementName, elementMatch }) => {
+ *     const v = submission[elementName]
+ *     myString = myString.replace(elementMatch, v)
+ *   },
+ * )
+ * ```
+ *
+ * @param data
+ * @param handler
+ * @returns
+ */
+declare const matchUserTagRegex: (data: string, matchHandler: (userMatch: string) => void) => void;
+export { forEachFormElement, forEachFormElementWithOptions, findFormElement, parseFormElementOptionsSet, flattenFormElements, ElementWYSIWYGRegex, UserWYSIWYGRegex, matchElementsTagRegex, matchUserTagRegex, };

package/dist/formElementsService.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchElementsTagRegex = exports.WYSIWYGRegex = exports.flattenFormElements = exports.parseFormElementOptionsSet = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = void 0;
+exports.matchUserTagRegex = exports.matchElementsTagRegex = exports.UserWYSIWYGRegex = exports.ElementWYSIWYGRegex = exports.flattenFormElements = exports.parseFormElementOptionsSet = exports.findFormElement = exports.forEachFormElementWithOptions = exports.forEachFormElement = void 0;
 const _1 = require(".");
 /**
  * Iterate over all form elements, also iterating over nested form element (e.g.
@@ -173,8 +173,8 @@ function flattenFormElements(elements) {
 }
 exports.flattenFormElements = flattenFormElements;
 /** The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink platform. */
-const WYSIWYGRegex = /({ELEMENT:)([^}]+)(})/g;
-exports.WYSIWYGRegex = WYSIWYGRegex;
+const ElementWYSIWYGRegex = /({ELEMENT:)([^}]+)(})/g;
+exports.ElementWYSIWYGRegex = ElementWYSIWYGRegex;
 /**
  * Takes a string and calls a provided handler function for each found instance
  * of `{ELEMENT:<elementName>}` in the string. Used to replace values in
@@ -198,7 +198,7 @@ exports.WYSIWYGRegex = WYSIWYGRegex;
  */
 const matchElementsTagRegex = (data, matchHandler) => {
     let matches;
-    while ((matches = WYSIWYGRegex.exec(data)) !== null) {
+    while ((matches = ElementWYSIWYGRegex.exec(data)) !== null) {
         if ((matches === null || matches === void 0 ? void 0 : matches.length) < 3)
             continue;
         const elementName = matches[2];
@@ -206,4 +206,37 @@ const matchElementsTagRegex = (data, matchHandler) => {
     }
 };
 exports.matchElementsTagRegex = matchElementsTagRegex;
+/** The regex used for matching the `{USER:email}` tag in the OneBlink platform. */
+const UserWYSIWYGRegex = /{USER:email}/g;
+exports.UserWYSIWYGRegex = UserWYSIWYGRegex;
+/**
+ * Takes a string and calls a provided handler function for each found instance
+ * of `{ELEMENT:<elementName>}` in the string. Used to replace values in
+ * OneBlink calculation and info (HTML) elements.
+ *
+ * #### Example
+ *
+ * ```js
+ * formElementsService.matchElementsTagRegex(
+ *   myString,
+ *   ({ elementName, elementMatch }) => {
+ *     const v = submission[elementName]
+ *     myString = myString.replace(elementMatch, v)
+ *   },
+ * )
+ * ```
+ *
+ * @param data
+ * @param handler
+ * @returns
+ */
+const matchUserTagRegex = (data, matchHandler) => {
+    let matches;
+    while ((matches = UserWYSIWYGRegex.exec(data)) !== null) {
+        if ((matches === null || matches === void 0 ? void 0 : matches.length) < 1)
+            continue;
+        matchHandler(matches[0]);
+    }
+};
+exports.matchUserTagRegex = matchUserTagRegex;
 //# sourceMappingURL=formElementsService.js.map

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;AAkOC,gDAAkB;AAhOpB;;;;;;;;;;;;;;;;;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;AAgMC,sEAA6B;AA9L/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;AA2IC,0CAAe;AAzIjB;;;;;;;;;;;;;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;AA8EC,gEAA0B;AA5E5B;;;;;;;;;;;;;GAaG;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;AA+CC,kDAAmB;AA7CrB,2FAA2F;AAC3F,MAAM,YAAY,GAAG,wBAAwB,CAAA;AA6C3C,oCAAY;AA3Cd;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,qBAAqB,GAAG,CAC5B,IAAY,EACZ,YAGU,EACV,EAAE;IACF,IAAI,OAAO,CAAA;IACX,OAAO,CAAC,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;QACnD,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;AASC,sDAAqB","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 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/** The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink platform. */\nconst WYSIWYGRegex = /({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 = WYSIWYGRegex.exec(data)) !== null) {\n    if (matches?.length < 3) continue\n\n    const elementName = matches[2]\n    matchHandler({ elementName, elementMatch: matches[0] })\n  }\n}\n\nexport {\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseFormElementOptionsSet,\n  flattenFormElements,\n  WYSIWYGRegex,\n  matchElementsTagRegex,\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;AAsQC,gDAAkB;AApQpB;;;;;;;;;;;;;;;;;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;AAoOC,sEAA6B;AAlO/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;AA+KC,0CAAe;AA7KjB;;;;;;;;;;;;;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;AAkHC,gEAA0B;AAhH5B;;;;;;;;;;;;;GAaG;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;AAmFC,kDAAmB;AAjFrB,2FAA2F;AAC3F,MAAM,mBAAmB,GAAG,wBAAwB,CAAA;AAiFlD,kDAAmB;AA/ErB;;;;;;;;;;;;;;;;;;;;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;AA8CC,sDAAqB;AA5CvB,mFAAmF;AACnF,MAAM,gBAAgB,GAAG,eAAe,CAAA;AA0CtC,4CAAgB;AAxClB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,iBAAiB,GAAG,CACxB,IAAY,EACZ,YAAyC,EACzC,EAAE;IACF,IAAI,OAAO,CAAA;IACX,OAAO,CAAC,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;QACvD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,IAAG,CAAC;YAAE,SAAQ;QAEjC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;KACzB;AACH,CAAC,CAAA;AAWC,8CAAiB","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 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/** The regex used for matching `{ELEMENT:<elementName>}` tags in the OneBlink platform. */\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\n/** The regex used for matching the `{USER:email}` tag in the OneBlink platform. */\nconst UserWYSIWYGRegex = /{USER:email}/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 matchUserTagRegex = (\n  data: string,\n  matchHandler: (userMatch: string) => void,\n) => {\n  let matches\n  while ((matches = UserWYSIWYGRegex.exec(data)) !== null) {\n    if (matches?.length < 1) continue\n\n    matchHandler(matches[0])\n  }\n}\n\nexport {\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseFormElementOptionsSet,\n  flattenFormElements,\n  ElementWYSIWYGRegex,\n  UserWYSIWYGRegex,\n  matchElementsTagRegex,\n  matchUserTagRegex,\n}\n"]}

package/dist/replaceCustomValues.d.ts

@@ -1,4 +1,4 @@
-import { FormTypes, SubmissionTypes } from '@oneblink/types';
+import { FormTypes, MiscTypes, SubmissionTypes } from '@oneblink/types';
 export type ReplaceInjectablesFormatters = {
     formatDateTime: (value: string) => string;
     formatDate: (value: string) => string;
@@ -13,6 +13,7 @@ export type ReplaceInjectablesOptions = ReplaceInjectablesFormatters & {
     externalId: string | undefined;
     previousApprovalId: string | undefined;
     submission: SubmissionTypes.S3SubmissionData['submission'];
+    userProfile: MiscTypes.UserProfile | undefined;
 };
 /**
  * Function to get the display value of a property in submission
@@ -99,6 +100,7 @@ export declare function getElementSubmissionValue({ propertyName, submission, fo
 export declare function replaceInjectablesWithElementValues(text: string, options: {
     formElements: FormTypes.FormElement[];
     submission: SubmissionTypes.S3SubmissionData['submission'];
+    userProfile: MiscTypes.UserProfile | undefined;
 } & ReplaceInjectablesFormatters): string;
 /**
  * Replace the `{ELEMENT:<elementName>}` values in text after a successful form
@@ -156,4 +158,4 @@ export declare function replaceInjectablesWithElementValues(text: string, option
  * @param options
  * @returns
  */
-export declare function replaceInjectablesWithSubmissionValues(text: string, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, }: ReplaceInjectablesOptions): string;
+export declare function replaceInjectablesWithSubmissionValues(text: string, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, userProfile, }: ReplaceInjectablesOptions): string;

package/dist/replaceCustomValues.js

@@ -232,17 +232,28 @@ exports.getElementSubmissionValue = getElementSubmissionValue;
  * @returns
  */
 function replaceInjectablesWithElementValues(text, options) {
-    const matches = text.match(formElementsService_1.WYSIWYGRegex);
-    if (!matches) {
+    const matchesElement = text.match(formElementsService_1.ElementWYSIWYGRegex);
+    const matchesUser = text.match(formElementsService_1.UserWYSIWYGRegex);
+    if (!matchesElement && !matchesUser) {
         return text;
     }
-    (0, formElementsService_1.matchElementsTagRegex)(text, ({ elementName, elementMatch }) => {
-        const value = getElementSubmissionValue({
-            propertyName: elementName,
-            ...options,
+    if (matchesElement) {
+        (0, formElementsService_1.matchElementsTagRegex)(text, ({ elementName, elementMatch }) => {
+            const value = getElementSubmissionValue({
+                propertyName: elementName,
+                ...options,
+            });
+            text = text.replace(elementMatch, value === undefined ? '' : value);
         });
-        text = text.replace(elementMatch, value === undefined ? '' : value);
-    });
+    }
+    if (matchesUser) {
+        (0, formElementsService_1.matchUserTagRegex)(text, (userMatch) => {
+            const { userProfile } = options;
+            if (userProfile === null || userProfile === void 0 ? void 0 : userProfile.email) {
+                text = text.replace(userMatch, userProfile.email);
+            }
+        });
+    }
     return text;
 }
 exports.replaceInjectablesWithElementValues = replaceInjectablesWithElementValues;
@@ -302,7 +313,7 @@ exports.replaceInjectablesWithElementValues = replaceInjectablesWithElementValue
  * @param options
  * @returns
  */
-function replaceInjectablesWithSubmissionValues(text, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, }) {
+function replaceInjectablesWithSubmissionValues(text, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, userProfile, }) {
     const string = replaceInjectablesWithElementValues(text, {
         formElements: form.elements,
         submission,
@@ -311,6 +322,7 @@ function replaceInjectablesWithSubmissionValues(text, { form, submission, extern
         formatTime,
         formatNumber,
         formatCurrency,
+        userProfile,
     });
     return CUSTOM_VALUES.reduce((newString, customValue) => {
         return newString.replace(new RegExp(customValue.string, 'g'), customValue.value({
@@ -325,6 +337,7 @@ function replaceInjectablesWithSubmissionValues(text, { form, submission, extern
             formatCurrency,
             previousApprovalId,
             submission,
+            userProfile,
         }));
     }, string);
 }

package/dist/replaceCustomValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"replaceCustomValues.js","sourceRoot":"","sources":["../src/replaceCustomValues.ts"],"names":[],"mappings":";;;AAQA,+DAI8B;AAC9B,6CAAwD;AAmBxD,MAAM,aAAa,GAAG;IACpB;QACE,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACnE;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC1D;IACD;QACE,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACnE;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC1D;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,CAAC,EACN,mBAAmB,EACnB,cAAc,GACY,EAAE,EAAE;YAC9B,IAAI,CAAC,mBAAmB,EAAE;gBACxB,OAAO,EAAE,CAAA;aACV;YACD,OAAO,cAAc,CAAC,mBAAmB,CAAC,CAAA;QAC5C,CAAC;KACF;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,mBAAmB,EAA6B,EAAE,EAAE,CAC5D,mBAAmB,IAAI,EAAE;KAC5B;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,KAAK,EAAE,CAAC,EAAE,YAAY,EAA6B,EAAE,EAAE,CAAC,YAAY,IAAI,EAAE;KAC3E;IACD;QACE,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,CAAC,EAAE,UAAU,EAA6B,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE;KACvE;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE,CAAC,EAAE,kBAAkB,EAA6B,EAAE,EAAE,CAC3D,kBAAkB,IAAI,EAAE;KAC3B;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,yBAAyB,CAAC,EACxC,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,cAAc,GAKgB;;IAC9B,MAAM,WAAW,GAAG,IAAA,qCAAe,EACjC,YAAY,EACZ,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,IAAI,KAAK,MAAM;QACvB,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,OAAO,CAAC,IAAI,KAAK,YAAY,CAChC,CAAA;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;IACxC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE;QAC7C,OAAO,SAAS,CAAA;KACjB;IAED,QAAQ,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE;QACzB,KAAK,UAAU,CAAC,CAAC;YACf,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,cAAc,CAAC,KAAK,CAAC,CAAA;SAC7B;QACD,KAAK,MAAM,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,MAAM,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,OAAO,CAAC;QACb,KAAK,cAAc,CAAC,CAAC;YACnB,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,MAAM,MAAM,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;YACtE,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,KAAK,CAAA;SAC9B;QAED,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,OAAmB,CAAA;YACjC,MAAM,oBAAoB,GAAa,KAAK,CAAC,MAAM,CACjD,CAAC,MAAgB,EAAE,cAAsB,EAAE,EAAE;;gBAC3C,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,cAAc,CAClC,CAAA;gBACD,IAAI,WAAW;oBAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;gBAC/C,OAAO,MAAM,CAAA;YACf,CAAC,EACD,EAAE,CACH,CAAA;YACD,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAA;SACtE;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,OAEb,CAAA;YACD,MAAM,MAAM,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAC7C,CAAC,MAAqC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CACxE,CAAA;YACD,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,KAAK,CAAC,KAAK;aACpC,CAAA;SACF;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,IAAI,WAAW,CAAC,KAAK,EAAE;gBACrB,MAAM,KAAK,GAAG,OAAmB,CAAA;gBACjC,MAAM,oBAAoB,GAAa,KAAK,CAAC,MAAM,CACjD,CAAC,MAAgB,EAAE,cAAsB,EAAE,EAAE;;oBAC3C,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,cAAc,CAClC,CAAA;oBACD,IAAI,WAAW;wBAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;oBAC/C,OAAO,MAAM,CAAA;gBACf,CAAC,EACD,EAAE,CACH,CAAA;gBACD,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAA;aACtE;iBAAM;gBACL,MAAM,KAAK,GAAG,OAAiB,CAAA;gBAC/B,MAAM,MAAM,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;gBACtE,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,EAAE,CAAA;aAC3B;SACF;QACD,KAAK,SAAS,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,OAAkB,CAAA;YAChC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;SAC5B;QACD,KAAK,aAAa,CAAC,CAAC;YAClB,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAA;gBACR,IAAI,WAAW,CAAC,iBAAiB,EAAE;oBACjC,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;iBAC7B;qBAAM;oBACL,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;iBAC3B;gBACD,OAAO,IAAI,CAAA;aACZ;YACD,OAAO,SAAS,CAAA;SACjB;QACD,KAAK,cAAc,CAAC;QACpB,KAAK,iBAAiB,CAAC,CAAC;YACtB,MAAM,KAAK,GAAG,OAEmB,CAAA;YACjC,OAAO,CAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc,0CAAE,gBAAgB,MAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,CAAA,CAAA;SACnE;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,MAAM,KAAK,GAAG,OAAuC,CAAA;YACrD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA;SAC9B;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,MAAM,KAAK,GAAG,OAAuC,CAAA;YACrD,OAAO,CACL,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,CAAC;iBACjD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;iBAChB,IAAI,CAAC,GAAG,CAAC,KAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAA,CACpC,CAAA;SACF;QACD,KAAK,KAAK,CAAC,CAAC;YACV,MAAM,KAAK,GAAG,OAA8B,CAAA;YAC5C,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,CAAC,CAAC;YACP,OAAO,OAAO,CAAA;SACf;KACF;AACH,CAAC;AAzID,8DAyIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,SAAgB,mCAAmC,CACjD,IAAY,EACZ,OAGgC;IAEhC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,kCAAY,CAAC,CAAA;IACxC,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAA;KACZ;IAED,IAAA,2CAAqB,EAAC,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,EAAE;QAC5D,MAAM,KAAK,GAAG,yBAAyB,CAAC;YACtC,YAAY,EAAE,WAAW;YACzB,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,YAAY,EACZ,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,KAAgB,CAC7C,CAAA;IACH,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC;AAxBD,kFAwBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,SAAgB,sCAAsC,CACpD,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,cAAc,EACd,kBAAkB,GACQ;IAE5B,MAAM,MAAM,GAAG,mCAAmC,CAAC,IAAI,EAAE;QACvD,YAAY,EAAE,IAAI,CAAC,QAAQ;QAC3B,UAAU;QACV,UAAU;QACV,cAAc;QACd,UAAU;QACV,YAAY;QACZ,cAAc;KACf,CAAC,CAAA;IACF,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,EAAE;QACrD,OAAO,SAAS,CAAC,OAAO,CACtB,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,EACnC,WAAW,CAAC,KAAK,CAAC;YAChB,IAAI;YACJ,mBAAmB;YACnB,UAAU;YACV,YAAY;YACZ,UAAU;YACV,cAAc;YACd,UAAU;YACV,YAAY;YACZ,cAAc;YACd,kBAAkB;YAClB,UAAU;SACX,CAAC,CACH,CAAA;IACH,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC;AA3CD,wFA2CC","sourcesContent":["import {\n  CivicaTypes,\n  FormTypes,\n  GeoscapeTypes,\n  MiscTypes,\n  PointTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport {\n  findFormElement,\n  matchElementsTagRegex,\n  WYSIWYGRegex,\n} from './formElementsService'\nimport { getABNNumberFromABNRecord } from './abnService'\n\nexport type ReplaceInjectablesFormatters = {\n  formatDateTime: (value: string) => string\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n}\n\nexport type ReplaceInjectablesOptions = ReplaceInjectablesFormatters & {\n  form: FormTypes.Form\n  submissionId: string\n  submissionTimestamp: string\n  externalId: string | undefined\n  previousApprovalId: string | undefined\n  submission: SubmissionTypes.S3SubmissionData['submission']\n}\n\nconst CUSTOM_VALUES = [\n  {\n    string: '{INFO_PAGE_ID}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.id.toString(),\n  },\n  {\n    string: '{INFO_PAGE_NAME}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.name,\n  },\n  {\n    string: '{FORM_ID}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.id.toString(),\n  },\n  {\n    string: '{FORM_NAME}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.name,\n  },\n  {\n    string: '{DATE}',\n    value: ({\n      submissionTimestamp,\n      formatDateTime,\n    }: ReplaceInjectablesOptions) => {\n      if (!submissionTimestamp) {\n        return ''\n      }\n      return formatDateTime(submissionTimestamp)\n    },\n  },\n  {\n    string: '{TIMESTAMP}',\n    value: ({ submissionTimestamp }: ReplaceInjectablesOptions) =>\n      submissionTimestamp || '',\n  },\n  {\n    string: '{SUBMISSION_ID}',\n    value: ({ submissionId }: ReplaceInjectablesOptions) => submissionId || '',\n  },\n  {\n    string: '{EXTERNAL_ID}',\n    value: ({ externalId }: ReplaceInjectablesOptions) => externalId || '',\n  },\n  {\n    string: '{PREVIOUS_APPROVAL_ID}',\n    value: ({ previousApprovalId }: ReplaceInjectablesOptions) =>\n      previousApprovalId || '',\n  },\n]\n\n/**\n * Function to get the display value of a property in submission\n *\n * #### Example\n *\n * ```typescript\n * const result = submissionService.getElementSubmissionValue({\n *   propertyName: 'search',\n *   submission: {\n *     search: 'Entered By User',\n *   },\n *   formElements: [\n *     {\n *       id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *       name: 'search',\n *       type: 'text',\n *       label: 'Search',\n *       readOnly: false,\n *       required: false,\n *       conditionallyShow: false,\n *       requiresAllConditionallyShowPredicates: false,\n *       isElementLookup: false,\n *       isDataLookup: false,\n *     },\n *   ],\n *   formatDate: (value) => new Date(value).toDateString(),\n *   formatDateTime: (value) => new Date(value).toString(),\n *   formatTime: (value) => new Date(value).toTimeString(),\n *   formatNumber: (value) => Number(value).toString(),\n *   formatCurrency: (value) => Number(value).toFixed(2),\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function getElementSubmissionValue({\n  propertyName,\n  submission,\n  formElements,\n  formatDate,\n  formatDateTime,\n  formatTime,\n  formatNumber,\n  formatCurrency,\n}: {\n  propertyName: string\n  formElements: FormTypes.FormElement[]\n  submission: SubmissionTypes.S3SubmissionData['submission']\n} & ReplaceInjectablesFormatters): unknown {\n  const formElement = findFormElement(\n    formElements,\n    (element) =>\n      element.type !== 'page' &&\n      element.type !== 'section' &&\n      element.name === propertyName,\n  )\n\n  const unknown = submission[propertyName]\n  if (unknown === undefined || unknown === null) {\n    return undefined\n  }\n\n  switch (formElement?.type) {\n    case 'datetime': {\n      const value = unknown as string\n      return formatDateTime(value)\n    }\n    case 'date': {\n      const value = unknown as string\n      return formatDate(value)\n    }\n    case 'time': {\n      const value = unknown as string\n      return formatTime(value)\n    }\n    case 'radio':\n    case 'autocomplete': {\n      const value = unknown as string\n      const option = formElement.options?.find((opt) => opt.value === value)\n      return option?.label || value\n    }\n\n    case 'checkboxes': {\n      const value = unknown as string[]\n      const selectedOptionLabels: string[] = value.reduce(\n        (labels: string[], selectedOption: string) => {\n          const foundOption = formElement.options?.find(\n            (o) => o.value === selectedOption,\n          )\n          if (foundOption) labels.push(foundOption.label)\n          return labels\n        },\n        [],\n      )\n      return selectedOptionLabels.length ? selectedOptionLabels : undefined\n    }\n    case 'compliance': {\n      const value = unknown as {\n        value?: string\n      }\n      const option = (formElement.options || []).find(\n        (option: FormTypes.ChoiceElementOption) => option.value === value.value,\n      )\n      return {\n        ...value,\n        value: option?.label || value.value,\n      }\n    }\n    case 'select': {\n      if (formElement.multi) {\n        const value = unknown as string[]\n        const selectedOptionLabels: string[] = value.reduce(\n          (labels: string[], selectedOption: string) => {\n            const foundOption = formElement.options?.find(\n              (o) => o.value === selectedOption,\n            )\n            if (foundOption) labels.push(foundOption.label)\n            return labels\n          },\n          [],\n        )\n        return selectedOptionLabels.length ? selectedOptionLabels : undefined\n      } else {\n        const value = unknown as string\n        const option = formElement.options?.find((opt) => opt.value === value)\n        return option?.label || ''\n      }\n    }\n    case 'boolean': {\n      const value = unknown as boolean\n      return value ? 'Yes' : 'No'\n    }\n    case 'calculation': {\n      const value = unknown as number\n      if (!Number.isNaN(value) && Number.isFinite(value)) {\n        let text\n        if (formElement.displayAsCurrency) {\n          text = formatCurrency(value)\n        } else {\n          text = formatNumber(value)\n        }\n        return text\n      }\n      return undefined\n    }\n    case 'pointAddress':\n    case 'geoscapeAddress': {\n      const value = unknown as\n        | PointTypes.PointAddress\n        | GeoscapeTypes.GeoscapeAddress\n      return value?.addressDetails?.formattedAddress || value?.addressId\n    }\n    case 'civicaStreetName': {\n      const value = unknown as CivicaTypes.CivicaStreetName\n      return value?.formattedStreet\n    }\n    case 'civicaNameRecord': {\n      const value = unknown as CivicaTypes.CivicaNameRecord\n      return (\n        [value?.title, value?.givenName1, value?.familyName]\n          .filter((t) => t)\n          .join(' ') || value?.emailAddress\n      )\n    }\n    case 'abn': {\n      const value = unknown as MiscTypes.ABNRecord\n      return value ? getABNNumberFromABNRecord(value) : undefined\n    }\n    default: {\n      return unknown\n    }\n  }\n}\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text while a form is being\n * filled out. The replacements are suppose to be user friendly and for display\n * purposes, e.g. dates should be displayed in the user's desired format and timezone.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceInjectablesWithElementValues(\n *   'https://example.com/path?search{ELEMENT:search}',\n *   {\n *     formatDate: (value) => new Date(value).toDateString(),\n *     formatDateTime: (value) => new Date(value).toString(),\n *     formatTime: (value) => new Date(value).toTimeString(),\n *     formatNumber: (value) => Number(value).toString(),\n *     formatCurrency: (value) => Number(value).toFixed(2),\n *     submission: {\n *       search: 'Entered By User',\n *     },\n *     elements: [\n *       {\n *         id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *         name: 'search',\n *         type: 'text',\n *         label: 'Search',\n *         readOnly: false,\n *         required: false,\n *         conditionallyShow: false,\n *         requiresAllConditionallyShowPredicates: false,\n *         isElementLookup: false,\n *         isDataLookup: false,\n *       },\n *     ],\n *   },\n * )\n * ```\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithElementValues(\n  text: string,\n  options: {\n    formElements: FormTypes.FormElement[]\n    submission: SubmissionTypes.S3SubmissionData['submission']\n  } & ReplaceInjectablesFormatters,\n): string {\n  const matches = text.match(WYSIWYGRegex)\n  if (!matches) {\n    return text\n  }\n\n  matchElementsTagRegex(text, ({ elementName, elementMatch }) => {\n    const value = getElementSubmissionValue({\n      propertyName: elementName,\n      ...options,\n    })\n\n    text = text.replace(\n      elementMatch,\n      value === undefined ? '' : (value as string),\n    )\n  })\n  return text\n}\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text after a successful form\n * submission as well as other replaceable parameters e.g. `submissionId`. The\n * replacements are suppose to be user friendly and for display purposes, e.g.\n * dates should be displayed in the user's desired format and timezone.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceInjectablesWithSubmissionValues(\n *   'https://example.com/path?submissionId={SUBMISSION_ID}&externalId={EXTERNAL_ID}&search{ELEMENT:search}',\n *   {\n *     submissionId: 'abc-123',\n *     submissionTimestamp: '2021-07-02T02:19:13.670Z',\n *     formatDate: (value) => new Date(value).toDateString(),\n *     formatDateTime: (value) => new Date(value).toString(),\n *     formatTime: (value) => new Date(value).toTimeString(),\n *     submission: {\n *       search: 'Entered By User',\n *     },\n *     form: {\n *       id: 1,\n *       name: 'Form',\n *       organisationId: '',\n *       formsAppEnvironmentId: 1,\n *       formsAppIds: [],\n *       isAuthenticated: false,\n *       isMultiPage: false,\n *       isInfoPage: false,\n *       postSubmissionAction: 'FORMS_LIBRARY',\n *       cancelAction: 'FORMS_LIBRARY',\n *       submissionEvents: [],\n *       tags: [],\n *       elements: [\n *         {\n *           id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *           name: 'search',\n *           type: 'text',\n *           label: 'Search',\n *           readOnly: false,\n *           required: false,\n *           conditionallyShow: false,\n *           requiresAllConditionallyShowPredicates: false,\n *           isElementLookup: false,\n *           isDataLookup: false,\n *         },\n *       ],\n *     },\n *   },\n * )\n * ```\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithSubmissionValues(\n  text: string,\n  {\n    form,\n    submission,\n    externalId,\n    submissionId,\n    submissionTimestamp,\n    formatDate,\n    formatDateTime,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n    previousApprovalId,\n  }: ReplaceInjectablesOptions,\n): string {\n  const string = replaceInjectablesWithElementValues(text, {\n    formElements: form.elements,\n    submission,\n    formatDate,\n    formatDateTime,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  })\n  return CUSTOM_VALUES.reduce((newString, customValue) => {\n    return newString.replace(\n      new RegExp(customValue.string, 'g'),\n      customValue.value({\n        form,\n        submissionTimestamp,\n        externalId,\n        submissionId,\n        formatDate,\n        formatDateTime,\n        formatTime,\n        formatNumber,\n        formatCurrency,\n        previousApprovalId,\n        submission,\n      }),\n    )\n  }, string)\n}\n"]}
+{"version":3,"file":"replaceCustomValues.js","sourceRoot":"","sources":["../src/replaceCustomValues.ts"],"names":[],"mappings":";;;AAQA,+DAM8B;AAC9B,6CAAwD;AAoBxD,MAAM,aAAa,GAAG;IACpB;QACE,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACnE;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC1D;IACD;QACE,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACnE;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC1D;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,CAAC,EACN,mBAAmB,EACnB,cAAc,GACY,EAAE,EAAE;YAC9B,IAAI,CAAC,mBAAmB,EAAE;gBACxB,OAAO,EAAE,CAAA;aACV;YACD,OAAO,cAAc,CAAC,mBAAmB,CAAC,CAAA;QAC5C,CAAC;KACF;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,mBAAmB,EAA6B,EAAE,EAAE,CAC5D,mBAAmB,IAAI,EAAE;KAC5B;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,KAAK,EAAE,CAAC,EAAE,YAAY,EAA6B,EAAE,EAAE,CAAC,YAAY,IAAI,EAAE;KAC3E;IACD;QACE,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,CAAC,EAAE,UAAU,EAA6B,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE;KACvE;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE,CAAC,EAAE,kBAAkB,EAA6B,EAAE,EAAE,CAC3D,kBAAkB,IAAI,EAAE;KAC3B;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,yBAAyB,CAAC,EACxC,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,UAAU,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,cAAc,GAKgB;;IAC9B,MAAM,WAAW,GAAG,IAAA,qCAAe,EACjC,YAAY,EACZ,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,IAAI,KAAK,MAAM;QACvB,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,OAAO,CAAC,IAAI,KAAK,YAAY,CAChC,CAAA;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;IACxC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE;QAC7C,OAAO,SAAS,CAAA;KACjB;IAED,QAAQ,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE;QACzB,KAAK,UAAU,CAAC,CAAC;YACf,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,cAAc,CAAC,KAAK,CAAC,CAAA;SAC7B;QACD,KAAK,MAAM,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,MAAM,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,OAAO,CAAC;QACb,KAAK,cAAc,CAAC,CAAC;YACnB,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,MAAM,MAAM,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;YACtE,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,KAAK,CAAA;SAC9B;QAED,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,OAAmB,CAAA;YACjC,MAAM,oBAAoB,GAAa,KAAK,CAAC,MAAM,CACjD,CAAC,MAAgB,EAAE,cAAsB,EAAE,EAAE;;gBAC3C,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,cAAc,CAClC,CAAA;gBACD,IAAI,WAAW;oBAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;gBAC/C,OAAO,MAAM,CAAA;YACf,CAAC,EACD,EAAE,CACH,CAAA;YACD,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAA;SACtE;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,OAEb,CAAA;YACD,MAAM,MAAM,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAC7C,CAAC,MAAqC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CACxE,CAAA;YACD,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,KAAK,CAAC,KAAK;aACpC,CAAA;SACF;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,IAAI,WAAW,CAAC,KAAK,EAAE;gBACrB,MAAM,KAAK,GAAG,OAAmB,CAAA;gBACjC,MAAM,oBAAoB,GAAa,KAAK,CAAC,MAAM,CACjD,CAAC,MAAgB,EAAE,cAAsB,EAAE,EAAE;;oBAC3C,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,cAAc,CAClC,CAAA;oBACD,IAAI,WAAW;wBAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;oBAC/C,OAAO,MAAM,CAAA;gBACf,CAAC,EACD,EAAE,CACH,CAAA;gBACD,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAA;aACtE;iBAAM;gBACL,MAAM,KAAK,GAAG,OAAiB,CAAA;gBAC/B,MAAM,MAAM,GAAG,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;gBACtE,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,EAAE,CAAA;aAC3B;SACF;QACD,KAAK,SAAS,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,OAAkB,CAAA;YAChC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;SAC5B;QACD,KAAK,aAAa,CAAC,CAAC;YAClB,MAAM,KAAK,GAAG,OAAiB,CAAA;YAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAA;gBACR,IAAI,WAAW,CAAC,iBAAiB,EAAE;oBACjC,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;iBAC7B;qBAAM;oBACL,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;iBAC3B;gBACD,OAAO,IAAI,CAAA;aACZ;YACD,OAAO,SAAS,CAAA;SACjB;QACD,KAAK,cAAc,CAAC;QACpB,KAAK,iBAAiB,CAAC,CAAC;YACtB,MAAM,KAAK,GAAG,OAEmB,CAAA;YACjC,OAAO,CAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc,0CAAE,gBAAgB,MAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,CAAA,CAAA;SACnE;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,MAAM,KAAK,GAAG,OAAuC,CAAA;YACrD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA;SAC9B;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,MAAM,KAAK,GAAG,OAAuC,CAAA;YACrD,OAAO,CACL,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,CAAC;iBACjD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;iBAChB,IAAI,CAAC,GAAG,CAAC,KAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAA,CACpC,CAAA;SACF;QACD,KAAK,KAAK,CAAC,CAAC;YACV,MAAM,KAAK,GAAG,OAA8B,CAAA;YAC5C,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,CAAC,CAAC;YACP,OAAO,OAAO,CAAA;SACf;KACF;AACH,CAAC;AAzID,8DAyIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,SAAgB,mCAAmC,CACjD,IAAY,EACZ,OAIgC;IAEhC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,yCAAmB,CAAC,CAAA;IACtD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,sCAAgB,CAAC,CAAA;IAChD,IAAI,CAAC,cAAc,IAAI,CAAC,WAAW,EAAE;QACnC,OAAO,IAAI,CAAA;KACZ;IAED,IAAI,cAAc,EAAE;QAClB,IAAA,2CAAqB,EAAC,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,EAAE;YAC5D,MAAM,KAAK,GAAG,yBAAyB,CAAC;gBACtC,YAAY,EAAE,WAAW;gBACzB,GAAG,OAAO;aACX,CAAC,CAAA;YAEF,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,YAAY,EACZ,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,KAAgB,CAC7C,CAAA;QACH,CAAC,CAAC,CAAA;KACH;IAED,IAAI,WAAW,EAAE;QACf,IAAA,uCAAiB,EAAC,IAAI,EAAE,CAAC,SAAS,EAAE,EAAE;YACpC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;YAC/B,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE;gBACtB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;aAClD;QACH,CAAC,CAAC,CAAA;KACH;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AArCD,kFAqCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,SAAgB,sCAAsC,CACpD,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,WAAW,GACe;IAE5B,MAAM,MAAM,GAAG,mCAAmC,CAAC,IAAI,EAAE;QACvD,YAAY,EAAE,IAAI,CAAC,QAAQ;QAC3B,UAAU;QACV,UAAU;QACV,cAAc;QACd,UAAU;QACV,YAAY;QACZ,cAAc;QACd,WAAW;KACZ,CAAC,CAAA;IACF,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,EAAE;QACrD,OAAO,SAAS,CAAC,OAAO,CACtB,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,EACnC,WAAW,CAAC,KAAK,CAAC;YAChB,IAAI;YACJ,mBAAmB;YACnB,UAAU;YACV,YAAY;YACZ,UAAU;YACV,cAAc;YACd,UAAU;YACV,YAAY;YACZ,cAAc;YACd,kBAAkB;YAClB,UAAU;YACV,WAAW;SACZ,CAAC,CACH,CAAA;IACH,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC;AA9CD,wFA8CC","sourcesContent":["import {\n  CivicaTypes,\n  FormTypes,\n  GeoscapeTypes,\n  MiscTypes,\n  PointTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport {\n  findFormElement,\n  matchElementsTagRegex,\n  matchUserTagRegex,\n  ElementWYSIWYGRegex,\n  UserWYSIWYGRegex,\n} from './formElementsService'\nimport { getABNNumberFromABNRecord } from './abnService'\n\nexport type ReplaceInjectablesFormatters = {\n  formatDateTime: (value: string) => string\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n}\n\nexport type ReplaceInjectablesOptions = ReplaceInjectablesFormatters & {\n  form: FormTypes.Form\n  submissionId: string\n  submissionTimestamp: string\n  externalId: string | undefined\n  previousApprovalId: string | undefined\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  userProfile: MiscTypes.UserProfile | undefined\n}\n\nconst CUSTOM_VALUES = [\n  {\n    string: '{INFO_PAGE_ID}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.id.toString(),\n  },\n  {\n    string: '{INFO_PAGE_NAME}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.name,\n  },\n  {\n    string: '{FORM_ID}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.id.toString(),\n  },\n  {\n    string: '{FORM_NAME}',\n    value: ({ form }: ReplaceInjectablesOptions) => form.name,\n  },\n  {\n    string: '{DATE}',\n    value: ({\n      submissionTimestamp,\n      formatDateTime,\n    }: ReplaceInjectablesOptions) => {\n      if (!submissionTimestamp) {\n        return ''\n      }\n      return formatDateTime(submissionTimestamp)\n    },\n  },\n  {\n    string: '{TIMESTAMP}',\n    value: ({ submissionTimestamp }: ReplaceInjectablesOptions) =>\n      submissionTimestamp || '',\n  },\n  {\n    string: '{SUBMISSION_ID}',\n    value: ({ submissionId }: ReplaceInjectablesOptions) => submissionId || '',\n  },\n  {\n    string: '{EXTERNAL_ID}',\n    value: ({ externalId }: ReplaceInjectablesOptions) => externalId || '',\n  },\n  {\n    string: '{PREVIOUS_APPROVAL_ID}',\n    value: ({ previousApprovalId }: ReplaceInjectablesOptions) =>\n      previousApprovalId || '',\n  },\n]\n\n/**\n * Function to get the display value of a property in submission\n *\n * #### Example\n *\n * ```typescript\n * const result = submissionService.getElementSubmissionValue({\n *   propertyName: 'search',\n *   submission: {\n *     search: 'Entered By User',\n *   },\n *   formElements: [\n *     {\n *       id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *       name: 'search',\n *       type: 'text',\n *       label: 'Search',\n *       readOnly: false,\n *       required: false,\n *       conditionallyShow: false,\n *       requiresAllConditionallyShowPredicates: false,\n *       isElementLookup: false,\n *       isDataLookup: false,\n *     },\n *   ],\n *   formatDate: (value) => new Date(value).toDateString(),\n *   formatDateTime: (value) => new Date(value).toString(),\n *   formatTime: (value) => new Date(value).toTimeString(),\n *   formatNumber: (value) => Number(value).toString(),\n *   formatCurrency: (value) => Number(value).toFixed(2),\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function getElementSubmissionValue({\n  propertyName,\n  submission,\n  formElements,\n  formatDate,\n  formatDateTime,\n  formatTime,\n  formatNumber,\n  formatCurrency,\n}: {\n  propertyName: string\n  formElements: FormTypes.FormElement[]\n  submission: SubmissionTypes.S3SubmissionData['submission']\n} & ReplaceInjectablesFormatters): unknown {\n  const formElement = findFormElement(\n    formElements,\n    (element) =>\n      element.type !== 'page' &&\n      element.type !== 'section' &&\n      element.name === propertyName,\n  )\n\n  const unknown = submission[propertyName]\n  if (unknown === undefined || unknown === null) {\n    return undefined\n  }\n\n  switch (formElement?.type) {\n    case 'datetime': {\n      const value = unknown as string\n      return formatDateTime(value)\n    }\n    case 'date': {\n      const value = unknown as string\n      return formatDate(value)\n    }\n    case 'time': {\n      const value = unknown as string\n      return formatTime(value)\n    }\n    case 'radio':\n    case 'autocomplete': {\n      const value = unknown as string\n      const option = formElement.options?.find((opt) => opt.value === value)\n      return option?.label || value\n    }\n\n    case 'checkboxes': {\n      const value = unknown as string[]\n      const selectedOptionLabels: string[] = value.reduce(\n        (labels: string[], selectedOption: string) => {\n          const foundOption = formElement.options?.find(\n            (o) => o.value === selectedOption,\n          )\n          if (foundOption) labels.push(foundOption.label)\n          return labels\n        },\n        [],\n      )\n      return selectedOptionLabels.length ? selectedOptionLabels : undefined\n    }\n    case 'compliance': {\n      const value = unknown as {\n        value?: string\n      }\n      const option = (formElement.options || []).find(\n        (option: FormTypes.ChoiceElementOption) => option.value === value.value,\n      )\n      return {\n        ...value,\n        value: option?.label || value.value,\n      }\n    }\n    case 'select': {\n      if (formElement.multi) {\n        const value = unknown as string[]\n        const selectedOptionLabels: string[] = value.reduce(\n          (labels: string[], selectedOption: string) => {\n            const foundOption = formElement.options?.find(\n              (o) => o.value === selectedOption,\n            )\n            if (foundOption) labels.push(foundOption.label)\n            return labels\n          },\n          [],\n        )\n        return selectedOptionLabels.length ? selectedOptionLabels : undefined\n      } else {\n        const value = unknown as string\n        const option = formElement.options?.find((opt) => opt.value === value)\n        return option?.label || ''\n      }\n    }\n    case 'boolean': {\n      const value = unknown as boolean\n      return value ? 'Yes' : 'No'\n    }\n    case 'calculation': {\n      const value = unknown as number\n      if (!Number.isNaN(value) && Number.isFinite(value)) {\n        let text\n        if (formElement.displayAsCurrency) {\n          text = formatCurrency(value)\n        } else {\n          text = formatNumber(value)\n        }\n        return text\n      }\n      return undefined\n    }\n    case 'pointAddress':\n    case 'geoscapeAddress': {\n      const value = unknown as\n        | PointTypes.PointAddress\n        | GeoscapeTypes.GeoscapeAddress\n      return value?.addressDetails?.formattedAddress || value?.addressId\n    }\n    case 'civicaStreetName': {\n      const value = unknown as CivicaTypes.CivicaStreetName\n      return value?.formattedStreet\n    }\n    case 'civicaNameRecord': {\n      const value = unknown as CivicaTypes.CivicaNameRecord\n      return (\n        [value?.title, value?.givenName1, value?.familyName]\n          .filter((t) => t)\n          .join(' ') || value?.emailAddress\n      )\n    }\n    case 'abn': {\n      const value = unknown as MiscTypes.ABNRecord\n      return value ? getABNNumberFromABNRecord(value) : undefined\n    }\n    default: {\n      return unknown\n    }\n  }\n}\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text while a form is being\n * filled out. The replacements are suppose to be user friendly and for display\n * purposes, e.g. dates should be displayed in the user's desired format and timezone.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceInjectablesWithElementValues(\n *   'https://example.com/path?search{ELEMENT:search}',\n *   {\n *     formatDate: (value) => new Date(value).toDateString(),\n *     formatDateTime: (value) => new Date(value).toString(),\n *     formatTime: (value) => new Date(value).toTimeString(),\n *     formatNumber: (value) => Number(value).toString(),\n *     formatCurrency: (value) => Number(value).toFixed(2),\n *     submission: {\n *       search: 'Entered By User',\n *     },\n *     elements: [\n *       {\n *         id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *         name: 'search',\n *         type: 'text',\n *         label: 'Search',\n *         readOnly: false,\n *         required: false,\n *         conditionallyShow: false,\n *         requiresAllConditionallyShowPredicates: false,\n *         isElementLookup: false,\n *         isDataLookup: false,\n *       },\n *     ],\n *   },\n * )\n * ```\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithElementValues(\n  text: string,\n  options: {\n    formElements: FormTypes.FormElement[]\n    submission: SubmissionTypes.S3SubmissionData['submission']\n    userProfile: MiscTypes.UserProfile | undefined\n  } & ReplaceInjectablesFormatters,\n): string {\n  const matchesElement = text.match(ElementWYSIWYGRegex)\n  const matchesUser = text.match(UserWYSIWYGRegex)\n  if (!matchesElement && !matchesUser) {\n    return text\n  }\n\n  if (matchesElement) {\n    matchElementsTagRegex(text, ({ elementName, elementMatch }) => {\n      const value = getElementSubmissionValue({\n        propertyName: elementName,\n        ...options,\n      })\n\n      text = text.replace(\n        elementMatch,\n        value === undefined ? '' : (value as string),\n      )\n    })\n  }\n\n  if (matchesUser) {\n    matchUserTagRegex(text, (userMatch) => {\n      const { userProfile } = options\n      if (userProfile?.email) {\n        text = text.replace(userMatch, userProfile.email)\n      }\n    })\n  }\n  return text\n}\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text after a successful form\n * submission as well as other replaceable parameters e.g. `submissionId`. The\n * replacements are suppose to be user friendly and for display purposes, e.g.\n * dates should be displayed in the user's desired format and timezone.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceInjectablesWithSubmissionValues(\n *   'https://example.com/path?submissionId={SUBMISSION_ID}&externalId={EXTERNAL_ID}&search{ELEMENT:search}',\n *   {\n *     submissionId: 'abc-123',\n *     submissionTimestamp: '2021-07-02T02:19:13.670Z',\n *     formatDate: (value) => new Date(value).toDateString(),\n *     formatDateTime: (value) => new Date(value).toString(),\n *     formatTime: (value) => new Date(value).toTimeString(),\n *     submission: {\n *       search: 'Entered By User',\n *     },\n *     form: {\n *       id: 1,\n *       name: 'Form',\n *       organisationId: '',\n *       formsAppEnvironmentId: 1,\n *       formsAppIds: [],\n *       isAuthenticated: false,\n *       isMultiPage: false,\n *       isInfoPage: false,\n *       postSubmissionAction: 'FORMS_LIBRARY',\n *       cancelAction: 'FORMS_LIBRARY',\n *       submissionEvents: [],\n *       tags: [],\n *       elements: [\n *         {\n *           id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',\n *           name: 'search',\n *           type: 'text',\n *           label: 'Search',\n *           readOnly: false,\n *           required: false,\n *           conditionallyShow: false,\n *           requiresAllConditionallyShowPredicates: false,\n *           isElementLookup: false,\n *           isDataLookup: false,\n *         },\n *       ],\n *     },\n *   },\n * )\n * ```\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithSubmissionValues(\n  text: string,\n  {\n    form,\n    submission,\n    externalId,\n    submissionId,\n    submissionTimestamp,\n    formatDate,\n    formatDateTime,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n    previousApprovalId,\n    userProfile,\n  }: ReplaceInjectablesOptions,\n): string {\n  const string = replaceInjectablesWithElementValues(text, {\n    formElements: form.elements,\n    submission,\n    formatDate,\n    formatDateTime,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n    userProfile,\n  })\n  return CUSTOM_VALUES.reduce((newString, customValue) => {\n    return newString.replace(\n      new RegExp(customValue.string, 'g'),\n      customValue.value({\n        form,\n        submissionTimestamp,\n        externalId,\n        submissionId,\n        formatDate,\n        formatDateTime,\n        formatTime,\n        formatNumber,\n        formatCurrency,\n        previousApprovalId,\n        submission,\n        userProfile,\n      }),\n    )\n  }, string)\n}\n"]}

package/package.json

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