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

package/dist/formElementsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"formElementsService.js","sourceRoot":"","sources":["../src/formElementsService.ts"],"names":[],"mappings":";;;AAEA,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;AAiJC,gDAAkB;AA/IpB,SAAS,6BAA6B,CACpC,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,IACE,WAAW,CAAC,IAAI,KAAK,QAAQ;YAC7B,WAAW,CAAC,IAAI,KAAK,cAAc;YACnC,WAAW,CAAC,IAAI,KAAK,YAAY;YACjC,WAAW,CAAC,IAAI,KAAK,OAAO;YAC5B,WAAW,CAAC,IAAI,KAAK,YAAY,EACjC;YACA,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;SACrC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AA6HC,sEAA6B;AA3H/B,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;AA6FC,0CAAe;AA3FjB,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;AA8CC,gEAA0B;AA5C5B,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;AA6BC,kDAAmB;AA3BrB,SAAS,uBAAuB,CAC9B,aAAqB,EACrB,YAAqC,EACrC,UAA+C;IAE/C,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE;YACjE,MAAM,KAAK,GAAG,uBAAuB,CACnC,aAAa,EACb,WAAW,CAAC,QAAQ,EACpB,UAAU,CACX,CAAA;YACD,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,OAAO,KAAK,CAAA;aACb;SACF;aAAM,IAAI,WAAW,CAAC,EAAE,KAAK,aAAa,EAAE;YAC3C,OAAO,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SACpC;KACF;AACH,CAAC;AAGC,0DAAuB","sourcesContent":["import { FormTypes } from '@oneblink/types'\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\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    if (\n      formElement.type === 'select' ||\n      formElement.type === 'autocomplete' ||\n      formElement.type === 'checkboxes' ||\n      formElement.type === 'radio' ||\n      formElement.type === 'compliance'\n    ) {\n      forEach(formElement, parentElements)\n    }\n    return false\n  })\n}\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\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\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\nfunction getRootElementValueById(\n  formElementId: string,\n  formElements: FormTypes.FormElement[],\n  submission: { readonly [key: string]: unknown },\n): unknown {\n  for (const formElement of formElements) {\n    if (formElement.type === 'page' || formElement.type === 'section') {\n      const value = getRootElementValueById(\n        formElementId,\n        formElement.elements,\n        submission,\n      )\n      if (value !== undefined) {\n        return value\n      }\n    } else if (formElement.id === formElementId) {\n      return submission[formElement.name]\n    }\n  }\n}\n\nexport {\n  getRootElementValueById,\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseFormElementOptionsSet,\n  flattenFormElements,\n}\n"]}
+{"version":3,"file":"formElementsService.js","sourceRoot":"","sources":["../src/formElementsService.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;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;AA8LC,gDAAkB;AA5LpB;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,6BAA6B,CACpC,QAAiC,EACjC,OAGS;IAET,eAAe,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;QACxD,IACE,WAAW,CAAC,IAAI,KAAK,QAAQ;YAC7B,WAAW,CAAC,IAAI,KAAK,cAAc;YACnC,WAAW,CAAC,IAAI,KAAK,YAAY;YACjC,WAAW,CAAC,IAAI,KAAK,OAAO;YAC5B,WAAW,CAAC,IAAI,KAAK,YAAY,EACjC;YACA,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;SACrC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC;AAwJC,sEAA6B;AAtJ/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;AAmGC,0CAAe;AAjGjB;;;;;;;;;;;;;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;AAsCC,gEAA0B;AApC5B;;;;;;;;;;;;;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;AAOC,kDAAmB","sourcesContent":["import { FormTypes } from '@oneblink/types'\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    if (\n      formElement.type === 'select' ||\n      formElement.type === 'autocomplete' ||\n      formElement.type === 'checkboxes' ||\n      formElement.type === 'radio' ||\n      formElement.type === 'compliance'\n    ) {\n      forEach(formElement, 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\nexport {\n  forEachFormElement,\n  forEachFormElementWithOptions,\n  findFormElement,\n  parseFormElementOptionsSet,\n  flattenFormElements,\n}\n"]}

package/dist/index.d.ts

@@ -1,9 +1,91 @@
+/**
+ * ## Form Elements Service
+ *
+ * Helper functions for handling form elements
+ *
+ * ```js
+ * import { formElementsService } from '@oneblink/sdk-core'
+ * ```
+ */
 export * as formElementsService from './formElementsService';
+/**
+ * ## Conditional Logic Service
+ *
+ * Helper functions for handling conditional logic
+ *
+ * ```js
+ * import { conditionalLogicService } from '@oneblink/sdk-core'
+ * ```
+ */
 export * as conditionalLogicService from './conditionalLogicService';
-import replaceCustomValues, { getElementSubmissionValue } from './replaceCustomValues';
+/**
+ * ## Submission Service
+ *
+ * Helper functions for handling form submission data
+ *
+ * ```js
+ * import { submissionService } from '@oneblink/sdk-core'
+ * ```
+ */
+export * as submissionService from './submissionService';
+/**
+ * ## Submission Service
+ *
+ * Helper functions for casting types
+ *
+ * ```js
+ * import { typeCastService } from '@oneblink/sdk-core'
+ * ```
+ */
 export * as typeCastService from './typeCastService';
+/**
+ * ## User Service
+ *
+ * Helper functions for handling users
+ *
+ * ```js
+ * import { userService } from '@oneblink/sdk-core'
+ * ```
+ */
 export * as userService from './userService';
+/**
+ * ## ABN Service
+ *
+ * Helper functions for handling ABN Records
+ *
+ * ```js
+ * import { abnService } from '@oneblink/sdk-core'
+ * ```
+ */
 export * as abnService from './abnService';
-export { validatePaymentAmount } from './paymentAmountValidation';
-export { getContentDisposition } from './fileUploadService';
-export { replaceCustomValues, getElementSubmissionValue };
+/**
+ * ## Payment Service
+ *
+ * Helper functions for payments
+ *
+ * ```js
+ * import { paymentService } from '@oneblink/sdk-core'
+ * ```
+ */
+export * as paymentService from './paymentService';
+/**
+ * ## Scheduling Service
+ *
+ * Helper functions for scheduling
+ *
+ * ```js
+ * import { schedulingService } from '@oneblink/sdk-core'
+ * ```
+ */
+export * as schedulingService from './schedulingService';
+/**
+ * ## File Upload Service
+ *
+ * Helper functions for handling file uploads
+ *
+ * ```js
+ * import { fileUploadService } from '@oneblink/sdk-core'
+ * ```
+ */
+export * as fileUploadService from './fileUploadService';
+export * from '@oneblink/types';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -18,18 +22,100 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getElementSubmissionValue = exports.replaceCustomValues = exports.getContentDisposition = exports.validatePaymentAmount = exports.abnService = exports.userService = exports.typeCastService = exports.conditionalLogicService = exports.formElementsService = void 0;
+exports.fileUploadService = exports.schedulingService = exports.paymentService = exports.abnService = exports.userService = exports.typeCastService = exports.submissionService = exports.conditionalLogicService = exports.formElementsService = void 0;
+/**
+ * ## Form Elements Service
+ *
+ * Helper functions for handling form elements
+ *
+ * ```js
+ * import { formElementsService } from '@oneblink/sdk-core'
+ * ```
+ */
 exports.formElementsService = __importStar(require("./formElementsService"));
+/**
+ * ## Conditional Logic Service
+ *
+ * Helper functions for handling conditional logic
+ *
+ * ```js
+ * import { conditionalLogicService } from '@oneblink/sdk-core'
+ * ```
+ */
 exports.conditionalLogicService = __importStar(require("./conditionalLogicService"));
-const replaceCustomValues_1 = __importStar(require("./replaceCustomValues"));
-exports.replaceCustomValues = replaceCustomValues_1.default;
-Object.defineProperty(exports, "getElementSubmissionValue", { enumerable: true, get: function () { return replaceCustomValues_1.getElementSubmissionValue; } });
+/**
+ * ## Submission Service
+ *
+ * Helper functions for handling form submission data
+ *
+ * ```js
+ * import { submissionService } from '@oneblink/sdk-core'
+ * ```
+ */
+exports.submissionService = __importStar(require("./submissionService"));
+/**
+ * ## Submission Service
+ *
+ * Helper functions for casting types
+ *
+ * ```js
+ * import { typeCastService } from '@oneblink/sdk-core'
+ * ```
+ */
 exports.typeCastService = __importStar(require("./typeCastService"));
+/**
+ * ## User Service
+ *
+ * Helper functions for handling users
+ *
+ * ```js
+ * import { userService } from '@oneblink/sdk-core'
+ * ```
+ */
 exports.userService = __importStar(require("./userService"));
+/**
+ * ## ABN Service
+ *
+ * Helper functions for handling ABN Records
+ *
+ * ```js
+ * import { abnService } from '@oneblink/sdk-core'
+ * ```
+ */
 exports.abnService = __importStar(require("./abnService"));
-var paymentAmountValidation_1 = require("./paymentAmountValidation");
-Object.defineProperty(exports, "validatePaymentAmount", { enumerable: true, get: function () { return paymentAmountValidation_1.validatePaymentAmount; } });
-var fileUploadService_1 = require("./fileUploadService");
-Object.defineProperty(exports, "getContentDisposition", { enumerable: true, get: function () { return fileUploadService_1.getContentDisposition; } });
+/**
+ * ## Payment Service
+ *
+ * Helper functions for payments
+ *
+ * ```js
+ * import { paymentService } from '@oneblink/sdk-core'
+ * ```
+ */
+exports.paymentService = __importStar(require("./paymentService"));
+/**
+ * ## Scheduling Service
+ *
+ * Helper functions for scheduling
+ *
+ * ```js
+ * import { schedulingService } from '@oneblink/sdk-core'
+ * ```
+ */
+exports.schedulingService = __importStar(require("./schedulingService"));
+/**
+ * ## File Upload Service
+ *
+ * Helper functions for handling file uploads
+ *
+ * ```js
+ * import { fileUploadService } from '@oneblink/sdk-core'
+ * ```
+ */
+exports.fileUploadService = __importStar(require("./fileUploadService"));
+__exportStar(require("@oneblink/types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6EAA4D;AAC5D,qFAAoE;AACpE,6EAE8B;AAOrB,8BATF,6BAAmB,CASE;AAAE,0GAR5B,+CAAyB,OAQ4B;AANvD,qEAAoD;AACpD,6DAA4C;AAC5C,2DAA0C;AAC1C,qEAAiE;AAAxD,gIAAA,qBAAqB,OAAA;AAC9B,yDAA2D;AAAlD,0HAAA,qBAAqB,OAAA","sourcesContent":["export * as formElementsService from './formElementsService'\nexport * as conditionalLogicService from './conditionalLogicService'\nimport replaceCustomValues, {\n  getElementSubmissionValue,\n} from './replaceCustomValues'\nexport * as typeCastService from './typeCastService'\nexport * as userService from './userService'\nexport * as abnService from './abnService'\nexport { validatePaymentAmount } from './paymentAmountValidation'\nexport { getContentDisposition } from './fileUploadService'\n\nexport { replaceCustomValues, getElementSubmissionValue }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;GAQG;AACH,6EAA4D;AAC5D;;;;;;;;GAQG;AACH,qFAAoE;AACpE;;;;;;;;GAQG;AACH,yEAAwD;AACxD;;;;;;;;GAQG;AACH,qEAAoD;AACpD;;;;;;;;GAQG;AACH,6DAA4C;AAC5C;;;;;;;;GAQG;AACH,2DAA0C;AAC1C;;;;;;;;GAQG;AACH,mEAAkD;AAClD;;;;;;;;GAQG;AACH,yEAAwD;AACxD;;;;;;;;GAQG;AACH,yEAAwD;AAExD,kDAA+B","sourcesContent":["/**\n * ## Form Elements Service\n *\n * Helper functions for handling form elements\n *\n * ```js\n * import { formElementsService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as formElementsService from './formElementsService'\n/**\n * ## Conditional Logic Service\n *\n * Helper functions for handling conditional logic\n *\n * ```js\n * import { conditionalLogicService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as conditionalLogicService from './conditionalLogicService'\n/**\n * ## Submission Service\n *\n * Helper functions for handling form submission data\n *\n * ```js\n * import { submissionService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as submissionService from './submissionService'\n/**\n * ## Submission Service\n *\n * Helper functions for casting types\n *\n * ```js\n * import { typeCastService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as typeCastService from './typeCastService'\n/**\n * ## User Service\n *\n * Helper functions for handling users\n *\n * ```js\n * import { userService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as userService from './userService'\n/**\n * ## ABN Service\n *\n * Helper functions for handling ABN Records\n *\n * ```js\n * import { abnService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as abnService from './abnService'\n/**\n * ## Payment Service\n *\n * Helper functions for payments\n *\n * ```js\n * import { paymentService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as paymentService from './paymentService'\n/**\n * ## Scheduling Service\n *\n * Helper functions for scheduling\n *\n * ```js\n * import { schedulingService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as schedulingService from './schedulingService'\n/**\n * ## File Upload Service\n *\n * Helper functions for handling file uploads\n *\n * ```js\n * import { fileUploadService } from '@oneblink/sdk-core'\n * ```\n */\nexport * as fileUploadService from './fileUploadService'\n\nexport * from '@oneblink/types'\n"]}

package/dist/paymentService.d.ts

@@ -0,0 +1,19 @@
+import { FormTypes, SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
+/**
+ * Examine a submission and its form definition to validate whether a payment
+ * workflow event needs to run.
+ *
+ * #### Example
+ *
+ * ```js
+ * const result = paymentService.checkForPaymentEvent(form, submission)
+ * ```
+ *
+ * @param definition
+ * @param submission
+ * @returns
+ */
+export declare function checkForPaymentEvent(definition: FormTypes.Form, submission: SubmissionTypes.S3SubmissionData['submission']): {
+    paymentSubmissionEvent: SubmissionEventTypes.PaymentSubmissionEvent;
+    amount: number;
+} | undefined;

package/dist/{paymentAmountValidation.js → paymentService.js}

@@ -1,9 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePaymentAmount = void 0;
+exports.checkForPaymentEvent = void 0;
 const _1 = require(".");
-const formElementsService_1 = require("./formElementsService");
-function validatePaymentAmount(definition, submission) {
+const submissionService_1 = require("./submissionService");
+/**
+ * Examine a submission and its form definition to validate whether a payment
+ * workflow event needs to run.
+ *
+ * #### Example
+ *
+ * ```js
+ * const result = paymentService.checkForPaymentEvent(form, submission)
+ * ```
+ *
+ * @param definition
+ * @param submission
+ * @returns
+ */
+function checkForPaymentEvent(definition, submission) {
     const paymentSubmissionEvents = definition.paymentEvents || [];
     const paymentSubmissionEvent = paymentSubmissionEvents.find((paymentSubmissionEvent) => {
         return (paymentSubmissionEvent &&
@@ -25,7 +39,7 @@ function validatePaymentAmount(definition, submission) {
         throw new Error('We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.');
     }
     console.log('Found form element for payment submission event', amountElement);
-    const amount = (0, formElementsService_1.getRootElementValueById)(amountElement.id, definition.elements, submission);
+    const amount = (0, submissionService_1.getRootElementValueById)(amountElement.id, definition.elements, submission);
     if (!amount) {
         console.log('Form has a payment submission event but the amount has been entered as 0 or not at all, finishing as normal submission');
         return;
@@ -40,5 +54,5 @@ function validatePaymentAmount(definition, submission) {
     };
     return result;
 }
-exports.validatePaymentAmount = validatePaymentAmount;
-//# sourceMappingURL=paymentAmountValidation.js.map
+exports.checkForPaymentEvent = checkForPaymentEvent;
+//# sourceMappingURL=paymentService.js.map

package/dist/paymentService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paymentService.js","sourceRoot":"","sources":["../src/paymentService.ts"],"names":[],"mappings":";;;AAKA,wBAAgE;AAChE,2DAA6D;AAE7D;;;;;;;;;;;;;GAaG;AACH,SAAgB,oBAAoB,CAClC,UAA0B,EAC1B,UAA0D;IAO1D,MAAM,uBAAuB,GAAG,UAAU,CAAC,aAAa,IAAI,EAAE,CAAA;IAC9D,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,IAAI,CACzD,CAAC,sBAAsB,EAAE,EAAE;QACzB,OAAO,CACL,sBAAsB;YACtB,0BAAuB,CAAC,6BAA6B,CAAC;gBACpD,aAAa,EAAE,CAAC,CAAC,sBAAsB,CAAC,oBAAoB;gBAC5D,gCAAgC,EAC9B,CAAC,CAAC,sBAAsB,CAAC,yCAAyC;gBACpE,qBAAqB,EACnB,sBAAsB,CAAC,8BAA8B,IAAI,EAAE;gBAC7D,UAAU,EAAE,UAAU;gBACtB,YAAY,EAAE,UAAU,CAAC,QAAQ;aAClC,CAAC,CACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE;QAC3B,OAAM;KACP;IACD,OAAO,CAAC,GAAG,CACT,uEAAuE,CACxE,CAAA;IAED,MAAM,aAAa,GAAG,sBAAmB,CAAC,eAAe,CACvD,UAAU,CAAC,QAAQ,EACnB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,sBAAsB,CAAC,aAAa,CAAC,SAAS,CAC3E,CAAA;IACD,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE;QACnD,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;QACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;KACF;IAED,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,aAAa,CAAC,CAAA;IAE7E,MAAM,MAAM,GAAG,IAAA,2CAAuB,EACpC,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;IAED,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,GAAG,CACT,wHAAwH,CACzH,CAAA;QACD,OAAM;KACP;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,CAAC,GAAG,CACT,oFAAoF,CACrF,CAAA;QACD,MAAM,IAAI,KAAK,CACb,wKAAwK,CACzK,CAAA;KACF;IAED,MAAM,MAAM,GAAG;QACb,sBAAsB;QACtB,MAAM;KACP,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA7ED,oDA6EC","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport { conditionalLogicService, formElementsService } from '.'\nimport { getRootElementValueById } from './submissionService'\n\n/**\n * Examine a submission and its form definition to validate whether a payment\n * workflow event needs to run.\n *\n * #### Example\n *\n * ```js\n * const result = paymentService.checkForPaymentEvent(form, submission)\n * ```\n *\n * @param definition\n * @param submission\n * @returns\n */\nexport function checkForPaymentEvent(\n  definition: FormTypes.Form,\n  submission: SubmissionTypes.S3SubmissionData['submission'],\n):\n  | {\n      paymentSubmissionEvent: SubmissionEventTypes.PaymentSubmissionEvent\n      amount: number\n    }\n  | undefined {\n  const paymentSubmissionEvents = definition.paymentEvents || []\n  const paymentSubmissionEvent = paymentSubmissionEvents.find(\n    (paymentSubmissionEvent) => {\n      return (\n        paymentSubmissionEvent &&\n        conditionalLogicService.evaluateConditionalPredicates({\n          isConditional: !!paymentSubmissionEvent.conditionallyExecute,\n          requiresAllConditionalPredicates:\n            !!paymentSubmissionEvent.requiresAllConditionallyExecutePredicates,\n          conditionalPredicates:\n            paymentSubmissionEvent.conditionallyExecutePredicates || [],\n          submission: submission,\n          formElements: definition.elements,\n        })\n      )\n    },\n  )\n\n  if (!paymentSubmissionEvent) {\n    return\n  }\n  console.log(\n    'Checking if submission with payment submission event needs processing',\n  )\n\n  const amountElement = formElementsService.findFormElement(\n    definition.elements,\n    (element) => element.id === paymentSubmissionEvent.configuration.elementId,\n  )\n  if (!amountElement || amountElement.type === 'page') {\n    console.log(\n      'Form has a payment submission event but the amount element does not exist, throwing error',\n    )\n    throw new Error(\n      'We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  console.log('Found form element for payment submission event', amountElement)\n\n  const amount = getRootElementValueById(\n    amountElement.id,\n    definition.elements,\n    submission,\n  )\n\n  if (!amount) {\n    console.log(\n      'Form has a payment submission event but the amount has been entered as 0 or not at all, finishing as normal submission',\n    )\n    return\n  }\n\n  if (typeof amount !== 'number') {\n    console.log(\n      'Form has a payment submission event but the amount is not a number, throwing error',\n    )\n    throw new Error(\n      'The configuration required to make a payment is incorrect. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  const result = {\n    paymentSubmissionEvent,\n    amount,\n  }\n\n  return result\n}\n"]}

package/dist/replaceCustomValues.d.ts

@@ -1,5 +1,5 @@
 import { FormTypes, SubmissionTypes } from '@oneblink/types';
-declare type CustomValuesOptions = {
+export declare type CustomValuesOptions = {
     form: FormTypes.Form;
     externalId?: string;
     submissionId: string;
@@ -10,6 +10,50 @@ declare type CustomValuesOptions = {
     formatCurrency: (value: number) => string;
     previousApprovalId?: string;
 };
+/**
+ * Function to get the display value of a property in submission
+ *
+ * #### Example
+ *
+ * ```typescript
+ *
+ * const result = submissionService.getElementSubmissionValue({
+ *   propertyName: 'search',
+ *   submission: {
+ *     search: 'Entered By User',
+ *   },
+ *   formElements: [
+ *     {
+ *       id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',
+ *       name: 'search',
+ *       type: 'text',
+ *       label: 'Search',
+ *       readOnly: false,
+ *       required: false,
+ *       conditionallyShow: false,
+ *       requiresAllConditionallyShowPredicates: false,
+ *       isElementLookup: false,
+ *       isDataLookup: false,
+ *     },
+ *   ],
+ *   formatDate: (value) => new Date(value).toDateString(),
+ *   formatTime: (value) => new Date(value).toTimeString(),
+ *   formatNumber: (value) => Number(value).toString(),
+ *   formatCurrency: (value) => Number(value).toFixed(2),
+ * }: {
+ *   propertyName: string
+ *   formElements: FormTypes.FormElement[]
+ *   submission: SubmissionTypes.S3SubmissionData['submission']
+ *   formatDate: (value: string) => string
+ *   formatTime: (value: string) => string
+ *   formatNumber: (value: number) => string
+ *   formatCurrency: (value: number) => string
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
 export declare function getElementSubmissionValue({ propertyName, submission, formElements, formatDate, formatTime, formatNumber, formatCurrency, }: {
     propertyName: string;
     formElements: FormTypes.FormElement[];
@@ -19,7 +63,58 @@ export declare function getElementSubmissionValue({ propertyName, submission, fo
     formatNumber: (value: number) => string;
     formatCurrency: (value: number) => string;
 }): unknown;
-export default function replaceCustomValues(text: string, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatTime, formatNumber, formatCurrency, previousApprovalId, }: CustomValuesOptions & {
+/**
+ * Function to replace a custom values in text
+ *
+ * #### Example
+ *
+ * ```js
+ * const result = submissionService.replaceCustomValues(
+ *   'https://example.com/path?submissionId={SUBMISSION_ID}&externalId={EXTERNAL_ID}&search{ELEMENT:search}',
+ *   {
+ *     submissionId: 'abc-123',
+ *     submissionTimestamp: '2021-07-02T02:19:13.670Z',
+ *     formatDate: (value) => new Date(value).toDateString(),
+ *     formatTime: (value) => new Date(value).toTimeString(),
+ *     submission: {
+ *       search: 'Entered By User',
+ *     },
+ *     form: {
+ *       id: 1,
+ *       name: 'Form',
+ *       organisationId: '',
+ *       formsAppEnvironmentId: 1,
+ *       formsAppIds: [],
+ *       isAuthenticated: false,
+ *       isMultiPage: false,
+ *       isInfoPage: false,
+ *       postSubmissionAction: 'FORMS_LIBRARY',
+ *       cancelAction: 'FORMS_LIBRARY',
+ *       submissionEvents: [],
+ *       tags: [],
+ *       elements: [
+ *         {
+ *           id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',
+ *           name: 'search',
+ *           type: 'text',
+ *           label: 'Search',
+ *           readOnly: false,
+ *           required: false,
+ *           conditionallyShow: false,
+ *           requiresAllConditionallyShowPredicates: false,
+ *           isElementLookup: false,
+ *           isDataLookup: false,
+ *         },
+ *       ],
+ *     },
+ *   },
+ * )
+ * ```
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
+export declare function replaceCustomValues(text: string, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatTime, formatNumber, formatCurrency, previousApprovalId, }: CustomValuesOptions & {
     submission: SubmissionTypes.S3SubmissionData['submission'];
 }): string;
-export {};

package/dist/replaceCustomValues.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getElementSubmissionValue = void 0;
+exports.replaceCustomValues = exports.getElementSubmissionValue = void 0;
 const formElementsService_1 = require("./formElementsService");
 const abnService_1 = require("./abnService");
 const CUSTOM_VALUES = [
@@ -46,6 +46,50 @@ const CUSTOM_VALUES = [
         value: ({ previousApprovalId }) => previousApprovalId || '',
     },
 ];
+/**
+ * Function to get the display value of a property in submission
+ *
+ * #### Example
+ *
+ * ```typescript
+ *
+ * const result = submissionService.getElementSubmissionValue({
+ *   propertyName: 'search',
+ *   submission: {
+ *     search: 'Entered By User',
+ *   },
+ *   formElements: [
+ *     {
+ *       id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',
+ *       name: 'search',
+ *       type: 'text',
+ *       label: 'Search',
+ *       readOnly: false,
+ *       required: false,
+ *       conditionallyShow: false,
+ *       requiresAllConditionallyShowPredicates: false,
+ *       isElementLookup: false,
+ *       isDataLookup: false,
+ *     },
+ *   ],
+ *   formatDate: (value) => new Date(value).toDateString(),
+ *   formatTime: (value) => new Date(value).toTimeString(),
+ *   formatNumber: (value) => Number(value).toString(),
+ *   formatCurrency: (value) => Number(value).toFixed(2),
+ * }: {
+ *   propertyName: string
+ *   formElements: FormTypes.FormElement[]
+ *   submission: SubmissionTypes.S3SubmissionData['submission']
+ *   formatDate: (value: string) => string
+ *   formatTime: (value: string) => string
+ *   formatNumber: (value: number) => string
+ *   formatCurrency: (value: number) => string
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
 function getElementSubmissionValue({ propertyName, submission, formElements, formatDate, formatTime, formatNumber, formatCurrency, }) {
     var _a, _b, _c;
     const formElement = (0, formElementsService_1.findFormElement)(formElements, (element) => element.type !== 'page' &&
@@ -159,6 +203,58 @@ function replaceElementValues(text, { form, submission, formatDate, formatTime,
         return newString.replace(match, value === undefined ? '' : value);
     }, text);
 }
+/**
+ * Function to replace a custom values in text
+ *
+ * #### Example
+ *
+ * ```js
+ * const result = submissionService.replaceCustomValues(
+ *   'https://example.com/path?submissionId={SUBMISSION_ID}&externalId={EXTERNAL_ID}&search{ELEMENT:search}',
+ *   {
+ *     submissionId: 'abc-123',
+ *     submissionTimestamp: '2021-07-02T02:19:13.670Z',
+ *     formatDate: (value) => new Date(value).toDateString(),
+ *     formatTime: (value) => new Date(value).toTimeString(),
+ *     submission: {
+ *       search: 'Entered By User',
+ *     },
+ *     form: {
+ *       id: 1,
+ *       name: 'Form',
+ *       organisationId: '',
+ *       formsAppEnvironmentId: 1,
+ *       formsAppIds: [],
+ *       isAuthenticated: false,
+ *       isMultiPage: false,
+ *       isInfoPage: false,
+ *       postSubmissionAction: 'FORMS_LIBRARY',
+ *       cancelAction: 'FORMS_LIBRARY',
+ *       submissionEvents: [],
+ *       tags: [],
+ *       elements: [
+ *         {
+ *           id: 'd4135b47-9004-4d75-aeb3-d2f6232da111',
+ *           name: 'search',
+ *           type: 'text',
+ *           label: 'Search',
+ *           readOnly: false,
+ *           required: false,
+ *           conditionallyShow: false,
+ *           requiresAllConditionallyShowPredicates: false,
+ *           isElementLookup: false,
+ *           isDataLookup: false,
+ *         },
+ *       ],
+ *     },
+ *   },
+ * )
+ * ```
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
 function replaceCustomValues(text, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatTime, formatNumber, formatCurrency, previousApprovalId, }) {
     const string = replaceElementValues(text, {
         form,
@@ -182,5 +278,5 @@ function replaceCustomValues(text, { form, submission, externalId, submissionId,
         }));
     }, string);
 }
-exports.default = replaceCustomValues;
+exports.replaceCustomValues = replaceCustomValues;
 //# sourceMappingURL=replaceCustomValues.js.map

package/dist/replaceCustomValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"replaceCustomValues.js","sourceRoot":"","sources":["../src/replaceCustomValues.ts"],"names":[],"mappings":";;;AACA,+DAAuD;AACvD,6CAAwD;AAcxD,MAAM,aAAa,GAAG;IACpB;QACE,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KAC7D;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KACpD;IACD;QACE,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KAC7D;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KACpD;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,CAAC,EACN,mBAAmB,EACnB,UAAU,EACV,UAAU,GACU,EAAE,EAAE;YACxB,IAAI,CAAC,mBAAmB,EAAE;gBACxB,OAAO,EAAE,CAAA;aACV;YACD,OAAO,GAAG,UAAU,CAAC,mBAAmB,CAAC,IAAI,UAAU,CACrD,mBAAmB,CACpB,EAAE,CAAA;QACL,CAAC;KACF;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,mBAAmB,EAAuB,EAAE,EAAE,CACtD,mBAAmB,IAAI,EAAE;KAC5B;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,KAAK,EAAE,CAAC,EAAE,YAAY,EAAuB,EAAE,EAAE,CAAC,YAAY,IAAI,EAAE;KACrE;IACD;QACE,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,CAAC,EAAE,UAAU,EAAuB,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE;KACjE;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE,CAAC,EAAE,kBAAkB,EAAuB,EAAE,EAAE,CACrD,kBAAkB,IAAI,EAAE;KAC3B;CACF,CAAA;AAED,SAAgB,yBAAyB,CAAC,EACxC,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,GASf;;IACC,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,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;QACzC,OAAO,SAAS,CAAA;KACjB;IAED,QAAQ,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE;QACzB,KAAK,UAAU,CAAC,CAAC;YACf,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;SACnD;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,OAAO,CAAC;QACb,KAAK,cAAc,CAAC,CAAC;YACnB,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,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,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,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,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,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;SAC5B;QACD,KAAK,aAAa,CAAC,CAAC;YAClB,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,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,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA;SAC9B;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,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,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,CAAC,CAAC;YACP,OAAO,KAAK,CAAA;SACb;KACF;AACH,CAAC;AA1HD,8DA0HC;AAED,SAAS,oBAAoB,CAC3B,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,GAQf;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;IACpD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QACzC,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAClC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EACtB,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CACvB,CAAA;QAED,MAAM,KAAK,GAAG,yBAAyB,CAAC;YACtC,YAAY;YACZ,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,UAAU;YACV,UAAU;YACV,UAAU;YACV,YAAY;YACZ,cAAc;SACf,CAAC,CAAA;QAEF,OAAO,SAAS,CAAC,OAAO,CACtB,KAAK,EACL,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,KAAgB,CAC7C,CAAA;IACH,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC;AAED,SAAwB,mBAAmB,CACzC,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,EACd,kBAAkB,GAGnB;IAED,MAAM,MAAM,GAAG,oBAAoB,CAAC,IAAI,EAAE;QACxC,IAAI;QACJ,UAAU;QACV,UAAU;QACV,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,WAAW,CAAC,MAAM,EAClB,WAAW,CAAC,KAAK,CAAC;YAChB,IAAI;YACJ,mBAAmB;YACnB,UAAU;YACV,YAAY;YACZ,UAAU;YACV,UAAU;YACV,YAAY;YACZ,cAAc;YACd,kBAAkB;SACnB,CAAC,CACH,CAAA;IACH,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC;AAzCD,sCAyCC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { findFormElement } from './formElementsService'\nimport { getABNNumberFromABNRecord } from './abnService'\n\ntype CustomValuesOptions = {\n  form: FormTypes.Form\n  externalId?: string\n  submissionId: string\n  submissionTimestamp: string\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n  previousApprovalId?: string\n}\n\nconst CUSTOM_VALUES = [\n  {\n    string: '{INFO_PAGE_ID}',\n    value: ({ form }: CustomValuesOptions) => form.id.toString(),\n  },\n  {\n    string: '{INFO_PAGE_NAME}',\n    value: ({ form }: CustomValuesOptions) => form.name,\n  },\n  {\n    string: '{FORM_ID}',\n    value: ({ form }: CustomValuesOptions) => form.id.toString(),\n  },\n  {\n    string: '{FORM_NAME}',\n    value: ({ form }: CustomValuesOptions) => form.name,\n  },\n  {\n    string: '{DATE}',\n    value: ({\n      submissionTimestamp,\n      formatDate,\n      formatTime,\n    }: CustomValuesOptions) => {\n      if (!submissionTimestamp) {\n        return ''\n      }\n      return `${formatDate(submissionTimestamp)} ${formatTime(\n        submissionTimestamp,\n      )}`\n    },\n  },\n  {\n    string: '{TIMESTAMP}',\n    value: ({ submissionTimestamp }: CustomValuesOptions) =>\n      submissionTimestamp || '',\n  },\n  {\n    string: '{SUBMISSION_ID}',\n    value: ({ submissionId }: CustomValuesOptions) => submissionId || '',\n  },\n  {\n    string: '{EXTERNAL_ID}',\n    value: ({ externalId }: CustomValuesOptions) => externalId || '',\n  },\n  {\n    string: '{PREVIOUS_APPROVAL_ID}',\n    value: ({ previousApprovalId }: CustomValuesOptions) =>\n      previousApprovalId || '',\n  },\n]\n\nexport function getElementSubmissionValue({\n  propertyName,\n  submission,\n  formElements,\n  formatDate,\n  formatTime,\n  formatNumber,\n  formatCurrency,\n}: {\n  propertyName: string\n  formElements: FormTypes.FormElement[]\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n}): 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 value = submission[propertyName]\n  if (value === undefined || value === null) {\n    return undefined\n  }\n\n  switch (formElement?.type) {\n    case 'datetime': {\n      return `${formatDate(value)} ${formatTime(value)}`\n    }\n    case 'date': {\n      return formatDate(value)\n    }\n    case 'time': {\n      return formatTime(value)\n    }\n    case 'radio':\n    case 'autocomplete': {\n      const option = formElement.options?.find((opt) => opt.value === value)\n      return option?.label || value\n    }\n\n    case 'checkboxes': {\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 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 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 option = formElement.options?.find((opt) => opt.value === value)\n        return option?.label || ''\n      }\n    }\n    case 'boolean': {\n      return value ? 'Yes' : 'No'\n    }\n    case 'calculation': {\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      return value?.addressDetails?.formattedAddress || value?.addressId\n    }\n    case 'civicaStreetName': {\n      return value?.formattedStreet\n    }\n    case 'civicaNameRecord': {\n      return (\n        [value?.title, value?.givenName1, value?.familyName]\n          .filter((t) => t)\n          .join(' ') || value?.emailAddress\n      )\n    }\n    case 'abn': {\n      return value ? getABNNumberFromABNRecord(value) : undefined\n    }\n    default: {\n      return value\n    }\n  }\n}\n\nfunction replaceElementValues(\n  text: string,\n  {\n    form,\n    submission,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  }: {\n    form: FormTypes.Form\n    submission: SubmissionTypes.S3SubmissionData['submission']\n    formatDate: (value: string) => string\n    formatTime: (value: string) => string\n    formatNumber: (value: number) => string\n    formatCurrency: (value: number) => string\n  },\n): string {\n  const matches = text.match(/({ELEMENT:)([^}]+)(})/g)\n  if (!matches) {\n    return text\n  }\n\n  return matches.reduce((newString, match) => {\n    const propertyName = match.substring(\n      match.indexOf(':') + 1,\n      match.lastIndexOf('}'),\n    )\n\n    const value = getElementSubmissionValue({\n      propertyName,\n      formElements: form.elements,\n      submission,\n      formatDate,\n      formatTime,\n      formatNumber,\n      formatCurrency,\n    })\n\n    return newString.replace(\n      match,\n      value === undefined ? '' : (value as string),\n    )\n  }, text)\n}\n\nexport default function replaceCustomValues(\n  text: string,\n  {\n    form,\n    submission,\n    externalId,\n    submissionId,\n    submissionTimestamp,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n    previousApprovalId,\n  }: CustomValuesOptions & {\n    submission: SubmissionTypes.S3SubmissionData['submission']\n  },\n): string {\n  const string = replaceElementValues(text, {\n    form,\n    submission,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  })\n  return CUSTOM_VALUES.reduce((newString, customValue) => {\n    return newString.replace(\n      customValue.string,\n      customValue.value({\n        form,\n        submissionTimestamp,\n        externalId,\n        submissionId,\n        formatDate,\n        formatTime,\n        formatNumber,\n        formatCurrency,\n        previousApprovalId,\n      }),\n    )\n  }, string)\n}\n"]}
+{"version":3,"file":"replaceCustomValues.js","sourceRoot":"","sources":["../src/replaceCustomValues.ts"],"names":[],"mappings":";;;AACA,+DAAuD;AACvD,6CAAwD;AAcxD,MAAM,aAAa,GAAG;IACpB;QACE,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KAC7D;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KACpD;IACD;QACE,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KAC7D;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KACpD;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,CAAC,EACN,mBAAmB,EACnB,UAAU,EACV,UAAU,GACU,EAAE,EAAE;YACxB,IAAI,CAAC,mBAAmB,EAAE;gBACxB,OAAO,EAAE,CAAA;aACV;YACD,OAAO,GAAG,UAAU,CAAC,mBAAmB,CAAC,IAAI,UAAU,CACrD,mBAAmB,CACpB,EAAE,CAAA;QACL,CAAC;KACF;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,mBAAmB,EAAuB,EAAE,EAAE,CACtD,mBAAmB,IAAI,EAAE;KAC5B;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,KAAK,EAAE,CAAC,EAAE,YAAY,EAAuB,EAAE,EAAE,CAAC,YAAY,IAAI,EAAE;KACrE;IACD;QACE,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,CAAC,EAAE,UAAU,EAAuB,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE;KACjE;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE,CAAC,EAAE,kBAAkB,EAAuB,EAAE,EAAE,CACrD,kBAAkB,IAAI,EAAE;KAC3B;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,SAAgB,yBAAyB,CAAC,EACxC,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,GASf;;IACC,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,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;QACzC,OAAO,SAAS,CAAA;KACjB;IAED,QAAQ,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE;QACzB,KAAK,UAAU,CAAC,CAAC;YACf,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;SACnD;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,KAAK,OAAO,CAAC;QACb,KAAK,cAAc,CAAC,CAAC;YACnB,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,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,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,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,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,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;SAC5B;QACD,KAAK,aAAa,CAAC,CAAC;YAClB,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,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,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA;SAC9B;QACD,KAAK,kBAAkB,CAAC,CAAC;YACvB,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,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,CAAC,CAAC;YACP,OAAO,KAAK,CAAA;SACb;KACF;AACH,CAAC;AA1HD,8DA0HC;AAED,SAAS,oBAAoB,CAC3B,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,GAQf;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;IACpD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QACzC,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAClC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EACtB,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CACvB,CAAA;QAED,MAAM,KAAK,GAAG,yBAAyB,CAAC;YACtC,YAAY;YACZ,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,UAAU;YACV,UAAU;YACV,UAAU;YACV,YAAY;YACZ,cAAc;SACf,CAAC,CAAA;QAEF,OAAO,SAAS,CAAC,OAAO,CACtB,KAAK,EACL,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,KAAgB,CAC7C,CAAA;IACH,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,mBAAmB,CACjC,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,EACd,kBAAkB,GAGnB;IAED,MAAM,MAAM,GAAG,oBAAoB,CAAC,IAAI,EAAE;QACxC,IAAI;QACJ,UAAU;QACV,UAAU;QACV,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,WAAW,CAAC,MAAM,EAClB,WAAW,CAAC,KAAK,CAAC;YAChB,IAAI;YACJ,mBAAmB;YACnB,UAAU;YACV,YAAY;YACZ,UAAU;YACV,UAAU;YACV,YAAY;YACZ,cAAc;YACd,kBAAkB;SACnB,CAAC,CACH,CAAA;IACH,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC;AAzCD,kDAyCC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { findFormElement } from './formElementsService'\nimport { getABNNumberFromABNRecord } from './abnService'\n\nexport type CustomValuesOptions = {\n  form: FormTypes.Form\n  externalId?: string\n  submissionId: string\n  submissionTimestamp: string\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n  previousApprovalId?: string\n}\n\nconst CUSTOM_VALUES = [\n  {\n    string: '{INFO_PAGE_ID}',\n    value: ({ form }: CustomValuesOptions) => form.id.toString(),\n  },\n  {\n    string: '{INFO_PAGE_NAME}',\n    value: ({ form }: CustomValuesOptions) => form.name,\n  },\n  {\n    string: '{FORM_ID}',\n    value: ({ form }: CustomValuesOptions) => form.id.toString(),\n  },\n  {\n    string: '{FORM_NAME}',\n    value: ({ form }: CustomValuesOptions) => form.name,\n  },\n  {\n    string: '{DATE}',\n    value: ({\n      submissionTimestamp,\n      formatDate,\n      formatTime,\n    }: CustomValuesOptions) => {\n      if (!submissionTimestamp) {\n        return ''\n      }\n      return `${formatDate(submissionTimestamp)} ${formatTime(\n        submissionTimestamp,\n      )}`\n    },\n  },\n  {\n    string: '{TIMESTAMP}',\n    value: ({ submissionTimestamp }: CustomValuesOptions) =>\n      submissionTimestamp || '',\n  },\n  {\n    string: '{SUBMISSION_ID}',\n    value: ({ submissionId }: CustomValuesOptions) => submissionId || '',\n  },\n  {\n    string: '{EXTERNAL_ID}',\n    value: ({ externalId }: CustomValuesOptions) => externalId || '',\n  },\n  {\n    string: '{PREVIOUS_APPROVAL_ID}',\n    value: ({ previousApprovalId }: CustomValuesOptions) =>\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 *\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 *   formatTime: (value) => new Date(value).toTimeString(),\n *   formatNumber: (value) => Number(value).toString(),\n *   formatCurrency: (value) => Number(value).toFixed(2),\n * }: {\n *   propertyName: string\n *   formElements: FormTypes.FormElement[]\n *   submission: SubmissionTypes.S3SubmissionData['submission']\n *   formatDate: (value: string) => string\n *   formatTime: (value: string) => string\n *   formatNumber: (value: number) => string\n *   formatCurrency: (value: number) => string\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function getElementSubmissionValue({\n  propertyName,\n  submission,\n  formElements,\n  formatDate,\n  formatTime,\n  formatNumber,\n  formatCurrency,\n}: {\n  propertyName: string\n  formElements: FormTypes.FormElement[]\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  formatDate: (value: string) => string\n  formatTime: (value: string) => string\n  formatNumber: (value: number) => string\n  formatCurrency: (value: number) => string\n}): 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 value = submission[propertyName]\n  if (value === undefined || value === null) {\n    return undefined\n  }\n\n  switch (formElement?.type) {\n    case 'datetime': {\n      return `${formatDate(value)} ${formatTime(value)}`\n    }\n    case 'date': {\n      return formatDate(value)\n    }\n    case 'time': {\n      return formatTime(value)\n    }\n    case 'radio':\n    case 'autocomplete': {\n      const option = formElement.options?.find((opt) => opt.value === value)\n      return option?.label || value\n    }\n\n    case 'checkboxes': {\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 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 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 option = formElement.options?.find((opt) => opt.value === value)\n        return option?.label || ''\n      }\n    }\n    case 'boolean': {\n      return value ? 'Yes' : 'No'\n    }\n    case 'calculation': {\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      return value?.addressDetails?.formattedAddress || value?.addressId\n    }\n    case 'civicaStreetName': {\n      return value?.formattedStreet\n    }\n    case 'civicaNameRecord': {\n      return (\n        [value?.title, value?.givenName1, value?.familyName]\n          .filter((t) => t)\n          .join(' ') || value?.emailAddress\n      )\n    }\n    case 'abn': {\n      return value ? getABNNumberFromABNRecord(value) : undefined\n    }\n    default: {\n      return value\n    }\n  }\n}\n\nfunction replaceElementValues(\n  text: string,\n  {\n    form,\n    submission,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  }: {\n    form: FormTypes.Form\n    submission: SubmissionTypes.S3SubmissionData['submission']\n    formatDate: (value: string) => string\n    formatTime: (value: string) => string\n    formatNumber: (value: number) => string\n    formatCurrency: (value: number) => string\n  },\n): string {\n  const matches = text.match(/({ELEMENT:)([^}]+)(})/g)\n  if (!matches) {\n    return text\n  }\n\n  return matches.reduce((newString, match) => {\n    const propertyName = match.substring(\n      match.indexOf(':') + 1,\n      match.lastIndexOf('}'),\n    )\n\n    const value = getElementSubmissionValue({\n      propertyName,\n      formElements: form.elements,\n      submission,\n      formatDate,\n      formatTime,\n      formatNumber,\n      formatCurrency,\n    })\n\n    return newString.replace(\n      match,\n      value === undefined ? '' : (value as string),\n    )\n  }, text)\n}\n\n/**\n * Function to replace a custom values in text\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceCustomValues(\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 *     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 replaceCustomValues(\n  text: string,\n  {\n    form,\n    submission,\n    externalId,\n    submissionId,\n    submissionTimestamp,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n    previousApprovalId,\n  }: CustomValuesOptions & {\n    submission: SubmissionTypes.S3SubmissionData['submission']\n  },\n): string {\n  const string = replaceElementValues(text, {\n    form,\n    submission,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  })\n  return CUSTOM_VALUES.reduce((newString, customValue) => {\n    return newString.replace(\n      customValue.string,\n      customValue.value({\n        form,\n        submissionTimestamp,\n        externalId,\n        submissionId,\n        formatDate,\n        formatTime,\n        formatNumber,\n        formatCurrency,\n        previousApprovalId,\n      }),\n    )\n  }, string)\n}\n"]}