@oneblink/sdk-core 1.0.1 → 2.0.0-beta.2

package/dist/replaceCustomValues.d.ts

@@ -1,14 +1,18 @@
 import { FormTypes, SubmissionTypes } from '@oneblink/types';
-export type CustomValuesOptions = {
-    form: FormTypes.Form;
-    externalId?: string;
-    submissionId: string;
-    submissionTimestamp: string;
+export type ReplaceSubmissionFormatters = {
+    formatDateTime: (value: string) => string;
     formatDate: (value: string) => string;
     formatTime: (value: string) => string;
     formatNumber: (value: number) => string;
     formatCurrency: (value: number) => string;
-    previousApprovalId?: string;
+};
+export type ReplaceSubmissionResultOptions = ReplaceSubmissionFormatters & {
+    form: FormTypes.Form;
+    submissionId: string;
+    submissionTimestamp: string;
+    externalId: string | undefined;
+    previousApprovalId: string | undefined;
+    submission: SubmissionTypes.S3SubmissionData['submission'];
 };
 /**
  * Function to get the display value of a property in submission
@@ -16,7 +20,6 @@ export type CustomValuesOptions = {
  * #### Example
  *
  * ```typescript
- *
  * const result = submissionService.getElementSubmissionValue({
  *   propertyName: 'search',
  *   submission: {
@@ -37,42 +40,40 @@ export type CustomValuesOptions = {
  *     },
  *   ],
  *   formatDate: (value) => new Date(value).toDateString(),
+ *   formatDateTime: (value) => new Date(value).toString(),
  *   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, }: {
+export declare function getElementSubmissionValue({ propertyName, submission, formElements, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, }: {
     propertyName: string;
     formElements: FormTypes.FormElement[];
     submission: SubmissionTypes.S3SubmissionData['submission'];
     formatDate: (value: string) => string;
+    formatDateTime: (value: string) => string;
     formatTime: (value: string) => string;
     formatNumber: (value: number) => string;
     formatCurrency: (value: number) => string;
 }): unknown;
 /**
- * Takes a string and replaces the {ELEMENT:<elementName>} tags.
+ * Replace the `{ELEMENT:<elementName>}` values in text while a form is being
+ * filled out. The replacements are suppose to be user friendly and for display
+ * purposes, e.g. dates should be displayed in the user's desired format and
+ * timezone.
  *
  * #### Example
  *
  * ```js
- * const result = submissionService.replaceElementValues(
+ * const result = submissionService.replaceSubmissionValues(
  *   'https://example.com/path?search{ELEMENT:search}',
  *   {
  *     formatDate: (value) => new Date(value).toDateString(),
+ *     formatDateTime: (value) => new Date(value).toString(),
  *     formatTime: (value) => new Date(value).toTimeString(),
  *     formatNumber: (value) => Number(value).toString(),
  *     formatCurrency: (value) => Number(value).toFixed(2),
@@ -101,26 +102,26 @@ export declare function getElementSubmissionValue({ propertyName, submission, fo
  * @param options
  * @returns
  */
-export declare function replaceElementValues(text: string, { formElements, submission, formatDate, formatTime, formatNumber, formatCurrency, }: {
+export declare function replaceSubmissionValues(text: string, options: {
     formElements: FormTypes.FormElement[];
     submission: SubmissionTypes.S3SubmissionData['submission'];
-    formatDate: (value: string) => string;
-    formatTime: (value: string) => string;
-    formatNumber: (value: number) => string;
-    formatCurrency: (value: number) => string;
-}): string;
+} & ReplaceSubmissionFormatters): string;
 /**
- * Function to replace a custom values in text
+ * Replace the `{ELEMENT:<elementName>}` values in text after a successful form
+ * submission as well as other replaceable parameters e.g. `submissionId`. The
+ * replacements are suppose to be user friendly and for display purposes, e.g.
+ * dates should be displayed in the user's desired format and timezone.
  *
  * #### Example
  *
  * ```js
- * const result = submissionService.replaceCustomValues(
+ * const result = submissionService.replaceSubmissionResultValues(
  *   '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(),
+ *     formatDateTime: (value) => new Date(value).toString(),
  *     formatTime: (value) => new Date(value).toTimeString(),
  *     submission: {
  *       search: 'Entered By User',
@@ -161,6 +162,4 @@ export declare function replaceElementValues(text: string, { formElements, submi
  * @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 declare function replaceSubmissionResultValues(text: string, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, }: ReplaceSubmissionResultOptions): string;

package/dist/replaceCustomValues.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceCustomValues = exports.replaceElementValues = exports.getElementSubmissionValue = void 0;
+exports.replaceSubmissionResultValues = exports.replaceSubmissionValues = exports.getElementSubmissionValue = void 0;
 const formElementsService_1 = require("./formElementsService");
 const abnService_1 = require("./abnService");
 const CUSTOM_VALUES = [
@@ -22,11 +22,11 @@ const CUSTOM_VALUES = [
     },
     {
         string: '{DATE}',
-        value: ({ submissionTimestamp, formatDate, formatTime, }) => {
+        value: ({ submissionTimestamp, formatDateTime, }) => {
             if (!submissionTimestamp) {
                 return '';
             }
-            return `${formatDate(submissionTimestamp)} ${formatTime(submissionTimestamp)}`;
+            return formatDateTime(submissionTimestamp);
         },
     },
     {
@@ -52,7 +52,6 @@ const CUSTOM_VALUES = [
  * #### Example
  *
  * ```typescript
- *
  * const result = submissionService.getElementSubmissionValue({
  *   propertyName: 'search',
  *   submission: {
@@ -73,24 +72,17 @@ const CUSTOM_VALUES = [
  *     },
  *   ],
  *   formatDate: (value) => new Date(value).toDateString(),
+ *   formatDateTime: (value) => new Date(value).toString(),
  *   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, }) {
+function getElementSubmissionValue({ propertyName, submission, formElements, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, }) {
     var _a, _b, _c;
     const formElement = (0, formElementsService_1.findFormElement)(formElements, (element) => element.type !== 'page' &&
         element.type !== 'section' &&
@@ -102,7 +94,7 @@ function getElementSubmissionValue({ propertyName, submission, formElements, for
     switch (formElement === null || formElement === void 0 ? void 0 : formElement.type) {
         case 'datetime': {
             const value = unknown;
-            return `${formatDate(value)} ${formatTime(value)}`;
+            return formatDateTime(value);
         }
         case 'date': {
             const value = unknown;
@@ -199,15 +191,19 @@ function getElementSubmissionValue({ propertyName, submission, formElements, for
 }
 exports.getElementSubmissionValue = getElementSubmissionValue;
 /**
- * Takes a string and replaces the {ELEMENT:<elementName>} tags.
+ * Replace the `{ELEMENT:<elementName>}` values in text while a form is being
+ * filled out. The replacements are suppose to be user friendly and for display
+ * purposes, e.g. dates should be displayed in the user's desired format and
+ * timezone.
  *
  * #### Example
  *
  * ```js
- * const result = submissionService.replaceElementValues(
+ * const result = submissionService.replaceSubmissionValues(
  *   'https://example.com/path?search{ELEMENT:search}',
  *   {
  *     formatDate: (value) => new Date(value).toDateString(),
+ *     formatDateTime: (value) => new Date(value).toString(),
  *     formatTime: (value) => new Date(value).toTimeString(),
  *     formatNumber: (value) => Number(value).toString(),
  *     formatCurrency: (value) => Number(value).toFixed(2),
@@ -236,7 +232,7 @@ exports.getElementSubmissionValue = getElementSubmissionValue;
  * @param options
  * @returns
  */
-function replaceElementValues(text, { formElements, submission, formatDate, formatTime, formatNumber, formatCurrency, }) {
+function replaceSubmissionValues(text, options) {
     const matches = text.match(formElementsService_1.WYSIWYGRegex);
     if (!matches) {
         return text;
@@ -244,30 +240,29 @@ function replaceElementValues(text, { formElements, submission, formatDate, form
     (0, formElementsService_1.matchElementsTagRegex)(text, ({ elementName, elementMatch }) => {
         const value = getElementSubmissionValue({
             propertyName: elementName,
-            formElements,
-            submission,
-            formatDate,
-            formatTime,
-            formatNumber,
-            formatCurrency,
+            ...options,
         });
         text = text.replace(elementMatch, value === undefined ? '' : value);
     });
     return text;
 }
-exports.replaceElementValues = replaceElementValues;
+exports.replaceSubmissionValues = replaceSubmissionValues;
 /**
- * Function to replace a custom values in text
+ * Replace the `{ELEMENT:<elementName>}` values in text after a successful form
+ * submission as well as other replaceable parameters e.g. `submissionId`. The
+ * replacements are suppose to be user friendly and for display purposes, e.g.
+ * dates should be displayed in the user's desired format and timezone.
  *
  * #### Example
  *
  * ```js
- * const result = submissionService.replaceCustomValues(
+ * const result = submissionService.replaceSubmissionResultValues(
  *   '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(),
+ *     formatDateTime: (value) => new Date(value).toString(),
  *     formatTime: (value) => new Date(value).toTimeString(),
  *     submission: {
  *       search: 'Entered By User',
@@ -308,11 +303,12 @@ exports.replaceElementValues = replaceElementValues;
  * @param options
  * @returns
  */
-function replaceCustomValues(text, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatTime, formatNumber, formatCurrency, previousApprovalId, }) {
-    const string = replaceElementValues(text, {
+function replaceSubmissionResultValues(text, { form, submission, externalId, submissionId, submissionTimestamp, formatDate, formatDateTime, formatTime, formatNumber, formatCurrency, previousApprovalId, }) {
+    const string = replaceSubmissionValues(text, {
         formElements: form.elements,
         submission,
         formatDate,
+        formatDateTime,
         formatTime,
         formatNumber,
         formatCurrency,
@@ -324,12 +320,14 @@ function replaceCustomValues(text, { form, submission, externalId, submissionId,
             externalId,
             submissionId,
             formatDate,
+            formatDateTime,
             formatTime,
             formatNumber,
             formatCurrency,
             previousApprovalId,
+            submission,
         }));
     }, string);
 }
-exports.replaceCustomValues = replaceCustomValues;
+exports.replaceSubmissionResultValues = replaceSubmissionResultValues;
 //# sourceMappingURL=replaceCustomValues.js.map

package/dist/replaceCustomValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"replaceCustomValues.js","sourceRoot":"","sources":["../src/replaceCustomValues.ts"],"names":[],"mappings":";;;AAQA,+DAI8B;AAC9B,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,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,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;SACnD;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;AA5ID,8DA4IC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,oBAAoB,CAClC,IAAY,EACZ,EACE,YAAY,EACZ,UAAU,EACV,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,GAQf;IAED,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,YAAY;YACZ,UAAU;YACV,UAAU;YACV,UAAU;YACV,YAAY;YACZ,cAAc;SACf,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;AAxCD,oDAwCC;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,YAAY,EAAE,IAAI,CAAC,QAAQ;QAC3B,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 {\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 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 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 `${formatDate(value)} ${formatTime(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 * Takes a string and replaces the {ELEMENT:<elementName>} tags.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceElementValues(\n *   'https://example.com/path?search{ELEMENT:search}',\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 *     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 replaceElementValues(\n  text: string,\n  {\n    formElements,\n    submission,\n    formatDate,\n    formatTime,\n    formatNumber,\n    formatCurrency,\n  }: {\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): 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      formElements,\n      submission,\n      formatDate,\n      formatTime,\n      formatNumber,\n      formatCurrency,\n    })\n\n    text = text.replace(\n      elementMatch,\n      value === undefined ? '' : (value as string),\n    )\n  })\n  return 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    formElements: form.elements,\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":";;;AAQA,+DAI8B;AAC9B,6CAAwD;AAmBxD,MAAM,aAAa,GAAG;IACpB;QACE,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAkC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACxE;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,KAAK,EAAE,CAAC,EAAE,IAAI,EAAkC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC/D;IACD;QACE,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAkC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;KACxE;IACD;QACE,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAkC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI;KAC/D;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,CAAC,EACN,mBAAmB,EACnB,cAAc,GACiB,EAAE,EAAE;YACnC,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,EAAkC,EAAE,EAAE,CACjE,mBAAmB,IAAI,EAAE;KAC5B;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,KAAK,EAAE,CAAC,EAAE,YAAY,EAAkC,EAAE,EAAE,CAC1D,YAAY,IAAI,EAAE;KACrB;IACD;QACE,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,CAAC,EAAE,UAAU,EAAkC,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE;KAC5E;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE,CAAC,EAAE,kBAAkB,EAAkC,EAAE,EAAE,CAChE,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,GAUf;;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,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;AA9ID,8DA8IC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,SAAgB,uBAAuB,CACrC,IAAY,EACZ,OAG+B;IAE/B,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,0DAwBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,SAAgB,6BAA6B,CAC3C,IAAY,EACZ,EACE,IAAI,EACJ,UAAU,EACV,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,cAAc,EACd,kBAAkB,GACa;IAEjC,MAAM,MAAM,GAAG,uBAAuB,CAAC,IAAI,EAAE;QAC3C,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,WAAW,CAAC,MAAM,EAClB,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,sEA2CC","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 ReplaceSubmissionFormatters = {\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 ReplaceSubmissionResultOptions = ReplaceSubmissionFormatters & {\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 }: ReplaceSubmissionResultOptions) => form.id.toString(),\n  },\n  {\n    string: '{INFO_PAGE_NAME}',\n    value: ({ form }: ReplaceSubmissionResultOptions) => form.name,\n  },\n  {\n    string: '{FORM_ID}',\n    value: ({ form }: ReplaceSubmissionResultOptions) => form.id.toString(),\n  },\n  {\n    string: '{FORM_NAME}',\n    value: ({ form }: ReplaceSubmissionResultOptions) => form.name,\n  },\n  {\n    string: '{DATE}',\n    value: ({\n      submissionTimestamp,\n      formatDateTime,\n    }: ReplaceSubmissionResultOptions) => {\n      if (!submissionTimestamp) {\n        return ''\n      }\n      return formatDateTime(submissionTimestamp)\n    },\n  },\n  {\n    string: '{TIMESTAMP}',\n    value: ({ submissionTimestamp }: ReplaceSubmissionResultOptions) =>\n      submissionTimestamp || '',\n  },\n  {\n    string: '{SUBMISSION_ID}',\n    value: ({ submissionId }: ReplaceSubmissionResultOptions) =>\n      submissionId || '',\n  },\n  {\n    string: '{EXTERNAL_ID}',\n    value: ({ externalId }: ReplaceSubmissionResultOptions) => externalId || '',\n  },\n  {\n    string: '{PREVIOUS_APPROVAL_ID}',\n    value: ({ previousApprovalId }: ReplaceSubmissionResultOptions) =>\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  formatDate: (value: string) => string\n  formatDateTime: (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 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\n * timezone.\n *\n * #### Example\n *\n * ```js\n * const result = submissionService.replaceSubmissionValues(\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 replaceSubmissionValues(\n  text: string,\n  options: {\n    formElements: FormTypes.FormElement[]\n    submission: SubmissionTypes.S3SubmissionData['submission']\n  } & ReplaceSubmissionFormatters,\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.replaceSubmissionResultValues(\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 replaceSubmissionResultValues(\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  }: ReplaceSubmissionResultOptions,\n): string {\n  const string = replaceSubmissionValues(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      customValue.string,\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"]}

package/package.json

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