@oneblink/apps-react 13.5.1-beta.4 → 14.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/dist/apps/approvals-service.d.ts +13 -1
  2. package/dist/apps/approvals-service.js +22 -1
  3. package/dist/apps/approvals-service.js.map +1 -1
  4. package/dist/apps/payment-service.d.ts +22 -0
  5. package/dist/apps/payment-service.js +43 -0
  6. package/dist/apps/payment-service.js.map +1 -1
  7. package/dist/apps/services/api/payment.d.ts +5 -1
  8. package/dist/apps/services/api/payment.js.map +1 -1
  9. package/dist/apps/services/fetch.d.ts +3 -1
  10. package/dist/apps/services/fetch.js +16 -4
  11. package/dist/apps/services/fetch.js.map +1 -1
  12. package/dist/apps/services/payment-handoff.d.ts +47 -0
  13. package/dist/apps/services/payment-handoff.js +79 -0
  14. package/dist/apps/services/payment-handoff.js.map +1 -0
  15. package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.d.ts +35 -19
  16. package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.js +41 -27
  17. package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.js.map +1 -1
  18. package/dist/apps/submission-service.js +2 -1
  19. package/dist/apps/submission-service.js.map +1 -1
  20. package/dist/components/payments/PaymentForm.d.ts +11 -6
  21. package/dist/components/payments/PaymentForm.js +10 -17
  22. package/dist/components/payments/PaymentForm.js.map +1 -1
  23. package/dist/components/payments/WestpacQuickStreamPaymentForm.d.ts +7 -11
  24. package/dist/components/payments/WestpacQuickStreamPaymentForm.js +25 -31
  25. package/dist/components/payments/WestpacQuickStreamPaymentForm.js.map +1 -1
  26. package/dist/services/form-validation/getApproverEditableFormElementIds.js +3 -0
  27. package/dist/services/form-validation/getApproverEditableFormElementIds.js.map +1 -1
  28. package/dist/services/getFlowInstanceNodesWithMeta.js +22 -3
  29. package/dist/services/getFlowInstanceNodesWithMeta.js.map +1 -1
  30. package/package.json +1 -1
@@ -19,11 +19,22 @@ export async function generateHeaders() {
19
19
  return headers;
20
20
  }
21
21
  export class HTTPError extends Error {
22
- constructor(statusCode, message) {
22
+ constructor(statusCode, message, conflict) {
23
23
  super(message);
24
24
  this.status = statusCode;
25
+ this.conflict = conflict;
25
26
  }
26
27
  }
28
+ function readErrorPayload(body) {
29
+ if (!body || typeof body !== 'object') {
30
+ return { message: '' };
31
+ }
32
+ const payload = body;
33
+ return {
34
+ message: typeof payload.message === 'string' ? payload.message : '',
35
+ conflict: typeof payload.conflict === 'string' ? payload.conflict : undefined,
36
+ };
37
+ }
27
38
  export const fetchWithError = async (url, options) => {
28
39
  try {
29
40
  return await fetch(url, options);
@@ -46,7 +57,8 @@ export async function fetchJSON(url, options) {
46
57
  if (response.ok) {
47
58
  return body;
48
59
  }
49
- throw new HTTPError(response.status, body.message);
60
+ const errorPayload = readErrorPayload(body);
61
+ throw new HTTPError(response.status, errorPayload.message, errorPayload.conflict);
50
62
  }
51
63
  export async function searchRequest(url, searchParameters, abortSignal) {
52
64
  const queryStringParams = formatQueryString(searchParameters);
@@ -88,8 +100,8 @@ export async function deleteRequest(url, abortSignal) {
88
100
  };
89
101
  const res = await fetchWithError(url, opts);
90
102
  if (!res.ok) {
91
- const errorPayload = await res.json();
92
- throw new HTTPError(res.status, errorPayload.message);
103
+ const errorPayload = readErrorPayload(await res.json());
104
+ throw new HTTPError(res.status, errorPayload.message, errorPayload.conflict);
93
105
  }
94
106
  }
95
107
  //# sourceMappingURL=fetch.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/apps/services/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,OAAO,GAA2B;QACtC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAA;IAED,sDAAsD;IACtD,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAA;IAClC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,EAAE,CAAA;IAC7C,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,CAAC,uBAAuB,CAAC,GAAG,SAAS,CAAA;IAC9C,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAGlC,YAAY,UAAkB,EAAE,OAAe;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;IAC1B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,cAAc,GAAiB,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;IACjE,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,iBAAiB,CACzB,mKAAmK,EACnK;YACE,KAAK,EAAE,qBAAqB;YAC5B,aAAa,EAAE,KAAc;YAC7B,SAAS,EAAE,IAAI;SAChB,CACF,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,GAAW,EACX,OAAqB;IAErB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAEnD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,mBAAmB;QACnB,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAClC,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;AACpD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,gBAAyC,EACzC,WAAyB;IAEzB,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAA;IAC7D,MAAM,IAAI,GAAG,MAAM,UAAU,CAAI,GAAG,GAAG,IAAI,iBAAiB,EAAE,EAAE,WAAW,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAW,EACX,WAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,eAAe,EAAE,CAAA;IACvC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,CAAA;IACrC,OAAO,SAAS,CAAC,GAAG,EAAE;QACpB,MAAM,EAAE,KAAK;QACb,OAAO;QACP,MAAM,EAAE,WAAW;KACpB,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,GAAW,EACX,QAAkB,EAClB,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAC9B,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,OAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAW,EACX,QAAiB,EACjB,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAC9B,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,OAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;QACrC,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;AACH,CAAC","sourcesContent":["import OneBlinkAppsError from './errors/oneBlinkAppsError'\n\nimport { getIdToken } from './forms-key'\nimport { formatQueryString } from './query-string'\nimport { getUserToken } from './user-token'\n\nexport async function generateHeaders() {\n const headers: Record<string, string> = {\n 'Content-Type': 'application/json',\n Accept: 'application/json',\n }\n\n // Check auth service for a token if user is logged in\n const idToken = await getIdToken()\n if (idToken) {\n headers.Authorization = `Bearer ${idToken}`\n }\n const userToken = getUserToken()\n if (userToken) {\n headers['X-OneBlink-User-Token'] = userToken\n }\n\n return headers\n}\n\nexport class HTTPError extends Error {\n status: number\n\n constructor(statusCode: number, message: string) {\n super(message)\n this.status = statusCode\n }\n}\n\nexport const fetchWithError: typeof fetch = async (url, options) => {\n try {\n return await fetch(url, options)\n } catch (error) {\n throw new OneBlinkAppsError(\n 'We encountered a network related issue. Please ensure you are connected to the internet before trying again. If the problem persists, contact your administrator.',\n {\n title: 'Connectivity Issues',\n originalError: error as Error,\n isOffline: true,\n },\n )\n }\n}\n\nexport async function fetchJSON<T>(\n url: string,\n options?: RequestInit,\n): Promise<T> {\n const response = await fetchWithError(url, options)\n\n if (response.status === 204) {\n // @ts-expect-error\n return\n }\n\n const body = await response.json()\n if (response.ok) {\n return body\n }\n\n throw new HTTPError(response.status, body.message)\n}\n\nexport async function searchRequest<T>(\n url: string,\n searchParameters: Record<string, unknown>,\n abortSignal?: AbortSignal,\n): Promise<T> {\n const queryStringParams = formatQueryString(searchParameters)\n const body = await getRequest<T>(`${url}?${queryStringParams}`, abortSignal)\n return body\n}\n\nexport async function getRequest<T>(\n url: string,\n abortSignal?: AbortSignal,\n): Promise<T> {\n const headers = await generateHeaders()\n headers['Cache-Control'] = 'no-store'\n return fetchJSON(url, {\n method: 'GET',\n headers,\n signal: abortSignal,\n })\n}\n\nexport async function postRequest<OutT>(\n url: string,\n resource?: unknown,\n abortSignal?: AbortSignal,\n): Promise<OutT> {\n const opts = {\n method: 'POST',\n headers: await generateHeaders(),\n body: JSON.stringify(resource),\n signal: abortSignal,\n }\n\n return fetchJSON(url, opts)\n}\n\nexport async function putRequest<OutT>(\n url: string,\n resource: unknown,\n abortSignal?: AbortSignal,\n): Promise<OutT> {\n const opts = {\n method: 'PUT',\n headers: await generateHeaders(),\n body: JSON.stringify(resource),\n signal: abortSignal,\n }\n\n return fetchJSON(url, opts)\n}\n\nexport async function deleteRequest(\n url: string,\n abortSignal?: AbortSignal,\n): Promise<void> {\n const opts = {\n method: 'DELETE',\n headers: await generateHeaders(),\n signal: abortSignal,\n }\n\n const res = await fetchWithError(url, opts)\n if (!res.ok) {\n const errorPayload = await res.json()\n throw new HTTPError(res.status, errorPayload.message)\n }\n}\n"]}
1
+ {"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/apps/services/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,OAAO,GAA2B;QACtC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAA;IAED,sDAAsD;IACtD,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAA;IAClC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,EAAE,CAAA;IAC7C,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,CAAC,uBAAuB,CAAC,GAAG,SAAS,CAAA;IAC9C,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAKlC,YAAY,UAAkB,EAAE,OAAe,EAAE,QAAiB;QAChE,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,IAAa;IAIrC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;IACxB,CAAC;IACD,MAAM,OAAO,GAAG,IAAiD,CAAA;IACjE,OAAO;QACL,OAAO,EAAE,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACnE,QAAQ,EAAE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;KAC9E,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAiB,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;IACjE,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,iBAAiB,CACzB,mKAAmK,EACnK;YACE,KAAK,EAAE,qBAAqB;YAC5B,aAAa,EAAE,KAAc;YAC7B,SAAS,EAAE,IAAI;SAChB,CACF,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,GAAW,EACX,OAAqB;IAErB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAEnD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,mBAAmB;QACnB,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAClC,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC3C,MAAM,IAAI,SAAS,CACjB,QAAQ,CAAC,MAAM,EACf,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,QAAQ,CACtB,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,gBAAyC,EACzC,WAAyB;IAEzB,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAA;IAC7D,MAAM,IAAI,GAAG,MAAM,UAAU,CAAI,GAAG,GAAG,IAAI,iBAAiB,EAAE,EAAE,WAAW,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAW,EACX,WAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,eAAe,EAAE,CAAA;IACvC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,CAAA;IACrC,OAAO,SAAS,CAAC,GAAG,EAAE;QACpB,MAAM,EAAE,KAAK;QACb,OAAO;QACP,MAAM,EAAE,WAAW;KACpB,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,GAAW,EACX,QAAkB,EAClB,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAC9B,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,OAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAW,EACX,QAAiB,EACjB,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAC9B,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,OAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,WAAyB;IAEzB,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,MAAM,eAAe,EAAE;QAChC,MAAM,EAAE,WAAW;KACpB,CAAA;IAED,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;QACvD,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,QAAQ,CACtB,CAAA;IACH,CAAC;AACH,CAAC","sourcesContent":["import OneBlinkAppsError from './errors/oneBlinkAppsError'\n\nimport { getIdToken } from './forms-key'\nimport { formatQueryString } from './query-string'\nimport { getUserToken } from './user-token'\n\nexport async function generateHeaders() {\n const headers: Record<string, string> = {\n 'Content-Type': 'application/json',\n Accept: 'application/json',\n }\n\n // Check auth service for a token if user is logged in\n const idToken = await getIdToken()\n if (idToken) {\n headers.Authorization = `Bearer ${idToken}`\n }\n const userToken = getUserToken()\n if (userToken) {\n headers['X-OneBlink-User-Token'] = userToken\n }\n\n return headers\n}\n\nexport class HTTPError extends Error {\n status: number\n /** Machine-readable conflict from the API error payload, when present. */\n conflict?: string\n\n constructor(statusCode: number, message: string, conflict?: string) {\n super(message)\n this.status = statusCode\n this.conflict = conflict\n }\n}\n\nfunction readErrorPayload(body: unknown): {\n message: string\n conflict?: string\n} {\n if (!body || typeof body !== 'object') {\n return { message: '' }\n }\n const payload = body as { message?: unknown; conflict?: unknown }\n return {\n message: typeof payload.message === 'string' ? payload.message : '',\n conflict: typeof payload.conflict === 'string' ? payload.conflict : undefined,\n }\n}\n\nexport const fetchWithError: typeof fetch = async (url, options) => {\n try {\n return await fetch(url, options)\n } catch (error) {\n throw new OneBlinkAppsError(\n 'We encountered a network related issue. Please ensure you are connected to the internet before trying again. If the problem persists, contact your administrator.',\n {\n title: 'Connectivity Issues',\n originalError: error as Error,\n isOffline: true,\n },\n )\n }\n}\n\nexport async function fetchJSON<T>(\n url: string,\n options?: RequestInit,\n): Promise<T> {\n const response = await fetchWithError(url, options)\n\n if (response.status === 204) {\n // @ts-expect-error\n return\n }\n\n const body = await response.json()\n if (response.ok) {\n return body\n }\n\n const errorPayload = readErrorPayload(body)\n throw new HTTPError(\n response.status,\n errorPayload.message,\n errorPayload.conflict,\n )\n}\n\nexport async function searchRequest<T>(\n url: string,\n searchParameters: Record<string, unknown>,\n abortSignal?: AbortSignal,\n): Promise<T> {\n const queryStringParams = formatQueryString(searchParameters)\n const body = await getRequest<T>(`${url}?${queryStringParams}`, abortSignal)\n return body\n}\n\nexport async function getRequest<T>(\n url: string,\n abortSignal?: AbortSignal,\n): Promise<T> {\n const headers = await generateHeaders()\n headers['Cache-Control'] = 'no-store'\n return fetchJSON(url, {\n method: 'GET',\n headers,\n signal: abortSignal,\n })\n}\n\nexport async function postRequest<OutT>(\n url: string,\n resource?: unknown,\n abortSignal?: AbortSignal,\n): Promise<OutT> {\n const opts = {\n method: 'POST',\n headers: await generateHeaders(),\n body: JSON.stringify(resource),\n signal: abortSignal,\n }\n\n return fetchJSON(url, opts)\n}\n\nexport async function putRequest<OutT>(\n url: string,\n resource: unknown,\n abortSignal?: AbortSignal,\n): Promise<OutT> {\n const opts = {\n method: 'PUT',\n headers: await generateHeaders(),\n body: JSON.stringify(resource),\n signal: abortSignal,\n }\n\n return fetchJSON(url, opts)\n}\n\nexport async function deleteRequest(\n url: string,\n abortSignal?: AbortSignal,\n): Promise<void> {\n const opts = {\n method: 'DELETE',\n headers: await generateHeaders(),\n signal: abortSignal,\n }\n\n const res = await fetchWithError(url, opts)\n if (!res.ok) {\n const errorPayload = readErrorPayload(await res.json())\n throw new HTTPError(\n res.status,\n errorPayload.message,\n errorPayload.conflict,\n )\n }\n}\n"]}
@@ -0,0 +1,47 @@
1
+ import { SubmissionEventTypes } from '@oneblink/types';
2
+ import { FormSubmissionResult } from '../types/submissions';
3
+ /**
4
+ * Payment providers whose payment form is rendered by the application itself
5
+ * (e.g. Westpac QuickStream). Every other provider redirects the user to a
6
+ * payment form hosted by the provider.
7
+ */
8
+ export type InAppPaymentType = 'WESTPAC_QUICK_STREAM';
9
+ /**
10
+ * Everything an in-app payment form needs to take a payment. It is passed
11
+ * between the application that creates the payment and the page that renders
12
+ * the payment form as URL search parameters, so the page does not need to read
13
+ * the submission from local storage.
14
+ */
15
+ export type PaymentFormSession = {
16
+ paymentType: InAppPaymentType;
17
+ formId: number;
18
+ formSubmissionPaymentId: string;
19
+ integrationEnvironmentId: string;
20
+ amount: number;
21
+ customerReferenceNumber: string;
22
+ };
23
+ /**
24
+ * `true` if the payment provider renders its payment form inside the
25
+ * application instead of redirecting to a provider hosted form.
26
+ */
27
+ export declare function paymentProviderRendersInApp(type: string): type is InAppPaymentType;
28
+ /**
29
+ * Get the URL the user should be sent to in order to pay. Hosted providers
30
+ * return the provider's hosted form URL. In-app providers return the
31
+ * application's payment form URL with the payment session appended.
32
+ */
33
+ export declare function getPaymentHandoff({ hostedFormUrl, paymentSubmissionEvent, formId, amount, customerReferenceNumber, }: {
34
+ hostedFormUrl: string;
35
+ paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
36
+ formId: number;
37
+ amount: number;
38
+ /** The resolved customer reference number. Falls back to the configured value. */
39
+ customerReferenceNumber?: string;
40
+ }): string;
41
+ /** Get the payment handoff URL for a form submission that requires a payment. */
42
+ export declare function getFormSubmissionPaymentHandoff(formSubmissionResult: FormSubmissionResult): string;
43
+ /**
44
+ * Read the payment session from the search parameters of an in-app payment form
45
+ * URL. Throws if the URL does not contain a complete session.
46
+ */
47
+ export declare function getPaymentFormSession(search: string | URLSearchParams): PaymentFormSession;
@@ -0,0 +1,79 @@
1
+ import OneBlinkAppsError from './errors/oneBlinkAppsError';
2
+ import replaceInjectablesWithSubmissionValues from './replaceInjectablesWithSubmissionValues';
3
+ /**
4
+ * `true` if the payment provider renders its payment form inside the
5
+ * application instead of redirecting to a provider hosted form.
6
+ */
7
+ export function paymentProviderRendersInApp(type) {
8
+ return type === 'WESTPAC_QUICK_STREAM';
9
+ }
10
+ /**
11
+ * Get the URL the user should be sent to in order to pay. Hosted providers
12
+ * return the provider's hosted form URL. In-app providers return the
13
+ * application's payment form URL with the payment session appended.
14
+ */
15
+ export function getPaymentHandoff({ hostedFormUrl, paymentSubmissionEvent, formId, amount, customerReferenceNumber, }) {
16
+ switch (paymentSubmissionEvent.type) {
17
+ case 'WESTPAC_QUICK_STREAM': {
18
+ const url = new URL(hostedFormUrl);
19
+ url.searchParams.set('paymentType', paymentSubmissionEvent.type);
20
+ url.searchParams.set('formId', String(formId));
21
+ url.searchParams.set('integrationEnvironmentId', paymentSubmissionEvent.configuration.environmentId);
22
+ url.searchParams.set('amount', String(amount));
23
+ url.searchParams.set('customerReferenceNumber', customerReferenceNumber ||
24
+ paymentSubmissionEvent.configuration.customerReferenceNumber);
25
+ return url.href;
26
+ }
27
+ default: {
28
+ return hostedFormUrl;
29
+ }
30
+ }
31
+ }
32
+ /** Get the payment handoff URL for a form submission that requires a payment. */
33
+ export function getFormSubmissionPaymentHandoff(formSubmissionResult) {
34
+ const payment = formSubmissionResult.payment;
35
+ if (!payment) {
36
+ throw new Error('"formSubmissionResult.payment" must have a value to create a payment handoff');
37
+ }
38
+ const { submissionEvent } = payment;
39
+ return getPaymentHandoff({
40
+ hostedFormUrl: payment.hostedFormUrl,
41
+ paymentSubmissionEvent: submissionEvent,
42
+ formId: formSubmissionResult.definition.id,
43
+ amount: payment.amount,
44
+ customerReferenceNumber: submissionEvent.type === 'WESTPAC_QUICK_STREAM'
45
+ ? replaceInjectablesWithSubmissionValues(submissionEvent.configuration.customerReferenceNumber, formSubmissionResult).text
46
+ : undefined,
47
+ });
48
+ }
49
+ /**
50
+ * Read the payment session from the search parameters of an in-app payment form
51
+ * URL. Throws if the URL does not contain a complete session.
52
+ */
53
+ export function getPaymentFormSession(search) {
54
+ const params = typeof search === 'string' ? new URLSearchParams(search) : search;
55
+ const paymentType = params.get('paymentType') || '';
56
+ const formId = Number(params.get('formId'));
57
+ const formSubmissionPaymentId = params.get('formSubmissionPaymentId') || '';
58
+ const integrationEnvironmentId = params.get('integrationEnvironmentId') || '';
59
+ const amount = Number(params.get('amount'));
60
+ const customerReferenceNumber = params.get('customerReferenceNumber') || '';
61
+ if (!paymentProviderRendersInApp(paymentType) ||
62
+ !formId ||
63
+ !formSubmissionPaymentId ||
64
+ !integrationEnvironmentId ||
65
+ !Number.isFinite(amount)) {
66
+ throw new OneBlinkAppsError('This payment link is missing details.', {
67
+ title: 'Invalid Payment Link',
68
+ });
69
+ }
70
+ return {
71
+ paymentType,
72
+ formId,
73
+ formSubmissionPaymentId,
74
+ integrationEnvironmentId,
75
+ amount,
76
+ customerReferenceNumber,
77
+ };
78
+ }
79
+ //# sourceMappingURL=payment-handoff.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"payment-handoff.js","sourceRoot":"","sources":["../../../src/apps/services/payment-handoff.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,4BAA4B,CAAA;AAC1D,OAAO,sCAAsC,MAAM,0CAA0C,CAAA;AAyB7F;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CACzC,IAAY;IAEZ,OAAO,IAAI,KAAK,sBAAsB,CAAA;AACxC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAChC,aAAa,EACb,sBAAsB,EACtB,MAAM,EACN,MAAM,EACN,uBAAuB,GAQxB;IACC,QAAQ,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACpC,KAAK,sBAAsB,CAAC,CAAC,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAA;YAClC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAA;YAChE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9C,GAAG,CAAC,YAAY,CAAC,GAAG,CAClB,0BAA0B,EAC1B,sBAAsB,CAAC,aAAa,CAAC,aAAa,CACnD,CAAA;YACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9C,GAAG,CAAC,YAAY,CAAC,GAAG,CAClB,yBAAyB,EACzB,uBAAuB;gBACrB,sBAAsB,CAAC,aAAa,CAAC,uBAAuB,CAC/D,CAAA;YACD,OAAO,GAAG,CAAC,IAAI,CAAA;QACjB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,aAAa,CAAA;QACtB,CAAC;IACH,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,+BAA+B,CAC7C,oBAA0C;IAE1C,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAA;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAA;IACH,CAAC;IAED,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAA;IACnC,OAAO,iBAAiB,CAAC;QACvB,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,sBAAsB,EAAE,eAAe;QACvC,MAAM,EAAE,oBAAoB,CAAC,UAAU,CAAC,EAAE;QAC1C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,uBAAuB,EACrB,eAAe,CAAC,IAAI,KAAK,sBAAsB;YAC7C,CAAC,CAAC,sCAAsC,CACpC,eAAe,CAAC,aAAa,CAAC,uBAAuB,EACrD,oBAAoB,CACrB,CAAC,IAAI;YACR,CAAC,CAAC,SAAS;KAChB,CAAC,CAAA;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAgC;IAEhC,MAAM,MAAM,GACV,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IAEnE,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IACnD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC3C,MAAM,uBAAuB,GAAG,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAA;IAC3E,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAA;IAC7E,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC3C,MAAM,uBAAuB,GAAG,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAA;IAE3E,IACE,CAAC,2BAA2B,CAAC,WAAW,CAAC;QACzC,CAAC,MAAM;QACP,CAAC,uBAAuB;QACxB,CAAC,wBAAwB;QACzB,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EACxB,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,uCAAuC,EAAE;YACnE,KAAK,EAAE,sBAAsB;SAC9B,CAAC,CAAA;IACJ,CAAC;IAED,OAAO;QACL,WAAW;QACX,MAAM;QACN,uBAAuB;QACvB,wBAAwB;QACxB,MAAM;QACN,uBAAuB;KACxB,CAAA;AACH,CAAC","sourcesContent":["import { SubmissionEventTypes } from '@oneblink/types'\nimport OneBlinkAppsError from './errors/oneBlinkAppsError'\nimport replaceInjectablesWithSubmissionValues from './replaceInjectablesWithSubmissionValues'\nimport { FormSubmissionResult } from '../types/submissions'\n\n/**\n * Payment providers whose payment form is rendered by the application itself\n * (e.g. Westpac QuickStream). Every other provider redirects the user to a\n * payment form hosted by the provider.\n */\nexport type InAppPaymentType = 'WESTPAC_QUICK_STREAM'\n\n/**\n * Everything an in-app payment form needs to take a payment. It is passed\n * between the application that creates the payment and the page that renders\n * the payment form as URL search parameters, so the page does not need to read\n * the submission from local storage.\n */\nexport type PaymentFormSession = {\n paymentType: InAppPaymentType\n formId: number\n formSubmissionPaymentId: string\n integrationEnvironmentId: string\n amount: number\n customerReferenceNumber: string\n}\n\n/**\n * `true` if the payment provider renders its payment form inside the\n * application instead of redirecting to a provider hosted form.\n */\nexport function paymentProviderRendersInApp(\n type: string,\n): type is InAppPaymentType {\n return type === 'WESTPAC_QUICK_STREAM'\n}\n\n/**\n * Get the URL the user should be sent to in order to pay. Hosted providers\n * return the provider's hosted form URL. In-app providers return the\n * application's payment form URL with the payment session appended.\n */\nexport function getPaymentHandoff({\n hostedFormUrl,\n paymentSubmissionEvent,\n formId,\n amount,\n customerReferenceNumber,\n}: {\n hostedFormUrl: string\n paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n formId: number\n amount: number\n /** The resolved customer reference number. Falls back to the configured value. */\n customerReferenceNumber?: string\n}): string {\n switch (paymentSubmissionEvent.type) {\n case 'WESTPAC_QUICK_STREAM': {\n const url = new URL(hostedFormUrl)\n url.searchParams.set('paymentType', paymentSubmissionEvent.type)\n url.searchParams.set('formId', String(formId))\n url.searchParams.set(\n 'integrationEnvironmentId',\n paymentSubmissionEvent.configuration.environmentId,\n )\n url.searchParams.set('amount', String(amount))\n url.searchParams.set(\n 'customerReferenceNumber',\n customerReferenceNumber ||\n paymentSubmissionEvent.configuration.customerReferenceNumber,\n )\n return url.href\n }\n default: {\n return hostedFormUrl\n }\n }\n}\n\n/** Get the payment handoff URL for a form submission that requires a payment. */\nexport function getFormSubmissionPaymentHandoff(\n formSubmissionResult: FormSubmissionResult,\n): string {\n const payment = formSubmissionResult.payment\n if (!payment) {\n throw new Error(\n '\"formSubmissionResult.payment\" must have a value to create a payment handoff',\n )\n }\n\n const { submissionEvent } = payment\n return getPaymentHandoff({\n hostedFormUrl: payment.hostedFormUrl,\n paymentSubmissionEvent: submissionEvent,\n formId: formSubmissionResult.definition.id,\n amount: payment.amount,\n customerReferenceNumber:\n submissionEvent.type === 'WESTPAC_QUICK_STREAM'\n ? replaceInjectablesWithSubmissionValues(\n submissionEvent.configuration.customerReferenceNumber,\n formSubmissionResult,\n ).text\n : undefined,\n })\n}\n\n/**\n * Read the payment session from the search parameters of an in-app payment form\n * URL. Throws if the URL does not contain a complete session.\n */\nexport function getPaymentFormSession(\n search: string | URLSearchParams,\n): PaymentFormSession {\n const params =\n typeof search === 'string' ? new URLSearchParams(search) : search\n\n const paymentType = params.get('paymentType') || ''\n const formId = Number(params.get('formId'))\n const formSubmissionPaymentId = params.get('formSubmissionPaymentId') || ''\n const integrationEnvironmentId = params.get('integrationEnvironmentId') || ''\n const amount = Number(params.get('amount'))\n const customerReferenceNumber = params.get('customerReferenceNumber') || ''\n\n if (\n !paymentProviderRendersInApp(paymentType) ||\n !formId ||\n !formSubmissionPaymentId ||\n !integrationEnvironmentId ||\n !Number.isFinite(amount)\n ) {\n throw new OneBlinkAppsError('This payment link is missing details.', {\n title: 'Invalid Payment Link',\n })\n }\n\n return {\n paymentType,\n formId,\n formSubmissionPaymentId,\n integrationEnvironmentId,\n amount,\n customerReferenceNumber,\n }\n}\n"]}
@@ -1,6 +1,7 @@
1
- import { SubmissionEventTypes } from '@oneblink/types';
1
+ import { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
2
2
  import { PaymentProvider } from '../../types/payments';
3
3
  import { FormSubmissionResult } from '../../types/submissions';
4
+ import { PaymentFormSession } from '../payment-handoff';
4
5
  export default class WestpacQuickStreamPaymentProvider implements PaymentProvider<SubmissionEventTypes.WestpacQuickStreamSubmissionEvent> {
5
6
  constructor(paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent, formSubmissionResult: FormSubmissionResult);
6
7
  formSubmissionResult: FormSubmissionResult;
@@ -14,32 +15,47 @@ export default class WestpacQuickStreamPaymentProvider implements PaymentProvide
14
15
  submissionResult: FormSubmissionResult;
15
16
  }>;
16
17
  }
17
- export declare function getPaymentFormConfiguration({ formSubmissionResult, formSubmissionPaymentId, paymentSubmissionEvent, abortSignal, }: {
18
- formSubmissionResult: FormSubmissionResult;
19
- formSubmissionPaymentId: string;
20
- paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent;
18
+ /**
19
+ * Get the QuickStream configuration needed to render the card form for a
20
+ * payment session.
21
+ */
22
+ export declare function getPaymentFormConfiguration({ session, abortSignal, }: {
23
+ session: PaymentFormSession;
21
24
  abortSignal: AbortSignal;
22
25
  }): Promise<{
23
26
  supplierBusinessCode: string;
24
27
  publishableApiKey: string;
25
28
  isTestMode: boolean;
26
29
  }>;
27
- export declare function completeTransaction({ formSubmissionPaymentId, formSubmissionResult, paymentSubmissionEvent, singleUseTokenId, captchaSiteKey, captchaToken, abortSignal, }: {
28
- formSubmissionPaymentId: string;
29
- formSubmissionResult: FormSubmissionResult;
30
- paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent;
30
+ /**
31
+ * Complete the QuickStream transaction for a payment session.
32
+ *
33
+ * `recaptcha` is required for payments started from a form submission and
34
+ * omitted for payments started from an approval step.
35
+ */
36
+ export declare function completeTransaction({ session, singleUseTokenId, recaptcha, abortSignal, }: {
37
+ session: PaymentFormSession;
31
38
  singleUseTokenId: string;
32
- captchaSiteKey: string;
33
- captchaToken: string;
39
+ recaptcha?: {
40
+ siteKey: string;
41
+ token: string;
42
+ };
34
43
  abortSignal?: AbortSignal;
35
44
  }): Promise<{
36
- formSubmissionPayment: import("@oneblink/types/typescript/submissions").FormSubmissionPayment;
37
- paymentReceiptUrl: string;
45
+ formSubmissionPayment: SubmissionTypes.FormSubmissionPayment;
38
46
  }>;
39
- export declare function cancelPayment({ formSubmissionPaymentId, formSubmissionResult, abortSignal, }: {
40
- formSubmissionPaymentId: string;
41
- formSubmissionResult: FormSubmissionResult;
47
+ /** Cancel the QuickStream payment for a payment session. */
48
+ export declare function cancelPayment({ session, abortSignal, }: {
49
+ session: PaymentFormSession;
42
50
  abortSignal?: AbortSignal;
43
- }): Promise<{
44
- paymentReceiptUrl: string;
45
- }>;
51
+ }): Promise<void>;
52
+ /**
53
+ * Get the receipt URL for a completed QuickStream transaction. The receipt page
54
+ * verifies the transaction using the query parameters added here.
55
+ */
56
+ export declare function getCompletedPaymentReceiptUrl({ formSubmissionResult, formSubmissionPayment, }: {
57
+ formSubmissionResult: FormSubmissionResult;
58
+ formSubmissionPayment: SubmissionTypes.FormSubmissionPayment;
59
+ }): string;
60
+ /** Get the receipt URL for a cancelled QuickStream payment. */
61
+ export declare function getCancelledPaymentReceiptUrl(formSubmissionResult: FormSubmissionResult, formSubmissionPaymentId: string): string;
@@ -1,4 +1,3 @@
1
- import replaceInjectablesWithSubmissionValues from '../replaceInjectablesWithSubmissionValues';
2
1
  import OneBlinkAppsError from '../errors/oneBlinkAppsError';
3
2
  import { generateAmountReceiptItem, generateCreditCardMaskReceiptItem, generateSubmissionIdReceiptItem, prepareReceiptItems, } from './receipt-items';
4
3
  import { cancelWestpacQuickStreamPayment, completeWestpacQuickStreamTransaction, getCustomFormPaymentConfiguration, } from '../api/payment';
@@ -41,9 +40,13 @@ export default class WestpacQuickStreamPaymentProvider {
41
40
  };
42
41
  }
43
42
  }
44
- export async function getPaymentFormConfiguration({ formSubmissionResult, formSubmissionPaymentId, paymentSubmissionEvent, abortSignal, }) {
45
- const { supplierBusinessCode, publishableApiKey, isTestMode } = await getCustomFormPaymentConfiguration(`/forms/${formSubmissionResult.definition.id}/westpac-quick-stream-payment/${formSubmissionPaymentId}`, {
46
- integrationEnvironmentId: paymentSubmissionEvent.configuration.environmentId,
43
+ /**
44
+ * Get the QuickStream configuration needed to render the card form for a
45
+ * payment session.
46
+ */
47
+ export async function getPaymentFormConfiguration({ session, abortSignal, }) {
48
+ const { supplierBusinessCode, publishableApiKey, isTestMode } = await getCustomFormPaymentConfiguration(`/forms/${session.formId}/westpac-quick-stream-payment/${session.formSubmissionPaymentId}`, {
49
+ integrationEnvironmentId: session.integrationEnvironmentId,
47
50
  }, abortSignal);
48
51
  return {
49
52
  supplierBusinessCode,
@@ -51,22 +54,38 @@ export async function getPaymentFormConfiguration({ formSubmissionResult, formSu
51
54
  isTestMode,
52
55
  };
53
56
  }
54
- export async function completeTransaction({ formSubmissionPaymentId, formSubmissionResult, paymentSubmissionEvent, singleUseTokenId, captchaSiteKey, captchaToken, abortSignal, }) {
57
+ /**
58
+ * Complete the QuickStream transaction for a payment session.
59
+ *
60
+ * `recaptcha` is required for payments started from a form submission and
61
+ * omitted for payments started from an approval step.
62
+ */
63
+ export async function completeTransaction({ session, singleUseTokenId, recaptcha, abortSignal, }) {
64
+ const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(session.formId, {
65
+ formSubmissionPaymentId: session.formSubmissionPaymentId,
66
+ singleUseTokenId,
67
+ integrationEnvironmentId: session.integrationEnvironmentId,
68
+ customerReferenceNumber: session.customerReferenceNumber,
69
+ principalAmount: session.amount,
70
+ recaptcha,
71
+ }, abortSignal);
72
+ return {
73
+ formSubmissionPayment,
74
+ };
75
+ }
76
+ /** Cancel the QuickStream payment for a payment session. */
77
+ export async function cancelPayment({ session, abortSignal, }) {
78
+ await cancelWestpacQuickStreamPayment(session.formId, session.formSubmissionPaymentId, abortSignal);
79
+ }
80
+ /**
81
+ * Get the receipt URL for a completed QuickStream transaction. The receipt page
82
+ * verifies the transaction using the query parameters added here.
83
+ */
84
+ export function getCompletedPaymentReceiptUrl({ formSubmissionResult, formSubmissionPayment, }) {
55
85
  var _a, _b;
56
86
  if (!formSubmissionResult.payment) {
57
- throw new Error('"formSubmissionResult.payment" must have a value to complete transactions');
87
+ throw new Error('"formSubmissionResult.payment" must have a value to create a receipt URL');
58
88
  }
59
- const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(formSubmissionResult.definition.id, {
60
- formSubmissionPaymentId,
61
- singleUseTokenId,
62
- integrationEnvironmentId: paymentSubmissionEvent.configuration.environmentId,
63
- customerReferenceNumber: replaceInjectablesWithSubmissionValues(paymentSubmissionEvent.configuration.customerReferenceNumber, formSubmissionResult).text,
64
- principalAmount: formSubmissionResult.payment.amount,
65
- recaptcha: {
66
- siteKey: captchaSiteKey,
67
- token: captchaToken,
68
- },
69
- }, abortSignal);
70
89
  const url = new URL(formSubmissionResult.payment.paymentReceiptUrl);
71
90
  if (formSubmissionPayment.type === 'WESTPAC_QUICK_STREAM' &&
72
91
  formSubmissionPayment.paymentTransaction) {
@@ -79,16 +98,13 @@ export async function completeTransaction({ formSubmissionPaymentId, formSubmiss
79
98
  url.searchParams.append('maskedCardNumber4Digits', (_b = formSubmissionPayment.paymentTransaction.creditCard) === null || _b === void 0 ? void 0 : _b.maskedCardNumber4Digits);
80
99
  }
81
100
  }
82
- return {
83
- formSubmissionPayment,
84
- paymentReceiptUrl: url.href,
85
- };
101
+ return url.href;
86
102
  }
87
- export async function cancelPayment({ formSubmissionPaymentId, formSubmissionResult, abortSignal, }) {
103
+ /** Get the receipt URL for a cancelled QuickStream payment. */
104
+ export function getCancelledPaymentReceiptUrl(formSubmissionResult, formSubmissionPaymentId) {
88
105
  if (!formSubmissionResult.payment) {
89
- throw new Error('"formSubmissionResult.payment" must have a value to cancel payments');
106
+ throw new Error('"formSubmissionResult.payment" must have a value to create a receipt URL');
90
107
  }
91
- await cancelWestpacQuickStreamPayment(formSubmissionResult.definition.id, formSubmissionPaymentId, abortSignal);
92
108
  const url = new URL(formSubmissionResult.payment.paymentReceiptUrl);
93
109
  if (formSubmissionResult.submissionId) {
94
110
  url.searchParams.append('paymentReferenceNumber', formSubmissionResult.submissionId);
@@ -97,8 +113,6 @@ export async function cancelPayment({ formSubmissionPaymentId, formSubmissionRes
97
113
  url.searchParams.append('totalAmount', formSubmissionResult.payment.amount.toString());
98
114
  url.searchParams.append('summaryCode', '1');
99
115
  url.searchParams.append('responseDescription', 'Payment Cancelled');
100
- return {
101
- paymentReceiptUrl: url.href,
102
- };
116
+ return url.href;
103
117
  }
104
118
  //# sourceMappingURL=WestpacQuickStreamPaymentProvider.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"WestpacQuickStreamPaymentProvider.js","sourceRoot":"","sources":["../../../../src/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.ts"],"names":[],"mappings":"AAGA,OAAO,sCAAsC,MAAM,2CAA2C,CAAA;AAC9F,OAAO,iBAAiB,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,+BAA+B,EAC/B,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,+BAA+B,EAC/B,qCAAqC,EACrC,iCAAiC,GAClC,MAAM,gBAAgB,CAAA;AAEvB,MAAM,CAAC,OAAO,OAAO,iCAAiC;IACpD,YACE,sBAA8E,EAC9E,oBAA0C;QAE1C,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;IACtD,CAAC;IAKD,KAAK,CAAC,wBAAwB,CAAC,KAA8B;QAC3D,MAAM,EACJ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,mBAAmB,EACnB,WAAW,GACZ,GAAG,KAOH,CAAA;QACD,IACE,CAAC,sBAAsB;YACvB,CAAC,aAAa;YACd,CAAC,WAAW;YACZ,CAAC,mBAAmB;YACpB,CAAC,WAAW,EACZ,CAAC;YACD,MAAM,IAAI,iBAAiB,CACzB,mFAAmF,CACpF,CAAA;QACH,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,CAAC,YAAY,KAAK,sBAAsB,EAAE,CAAC;YACtE,MAAM,IAAI,iBAAiB,CACzB,+EAA+E,CAChF,CAAA;QACH,CAAC;QAED,OAAO;YACL,YAAY,EAAE,mBAAmB,CAAC;gBAChC,+BAA+B,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC;gBACvE;oBACE,SAAS,EAAE,oCAAoC;oBAC/C,cAAc,EAAE,wCAAwC;oBACxD,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,aAAa;oBACpB,oBAAoB,EAAE,IAAI;iBAC3B;gBACD,iCAAiC,CAAC,uBAAuB,CAAC;gBAC1D,yBAAyB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACnD,CAAC;YACF,WAAW,EAAE;gBACX,SAAS,EAAE,WAAW,KAAK,GAAG;gBAC9B,YAAY,EAAE,mBAAmB;aAClC;YACD,gBAAgB,EAAE,IAAI,CAAC,oBAAoB;SAC5C,CAAA;IACH,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,EAChD,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,GAMZ;IAKC,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAC3D,MAAM,iCAAiC,CAKrC,UAAU,oBAAoB,CAAC,UAAU,CAAC,EAAE,iCAAiC,uBAAuB,EAAE,EACtG;QACE,wBAAwB,EACtB,sBAAsB,CAAC,aAAa,CAAC,aAAa;KACrD,EACD,WAAW,CACZ,CAAA;IAEH,OAAO;QACL,oBAAoB;QACpB,iBAAiB;QACjB,UAAU;KACX,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,WAAW,GASZ;;IACC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;IACH,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,qCAAqC,CAC3E,oBAAoB,CAAC,UAAU,CAAC,EAAE,EAClC;QACE,uBAAuB;QACvB,gBAAgB;QAChB,wBAAwB,EACtB,sBAAsB,CAAC,aAAa,CAAC,aAAa;QACpD,uBAAuB,EAAE,sCAAsC,CAC7D,sBAAsB,CAAC,aAAa,CAAC,uBAAuB,EAC5D,oBAAoB,CACrB,CAAC,IAAI;QACN,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,MAAM;QACpD,SAAS,EAAE;YACT,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,YAAY;SACpB;KACF,EACD,WAAW,CACZ,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IACE,qBAAqB,CAAC,IAAI,KAAK,sBAAsB;QACrD,qBAAqB,CAAC,kBAAkB,EACxC,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,qBAAqB,CAAC,kBAAkB,CAAC,sBAAsB,CAChE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,eAAe,EACf,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CACvD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CACvE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CACrD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,qBAAqB,EACrB,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC7D,CAAA;QACD,IACE,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,EAC3B,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,yBAAyB,EACzB,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,CAC5B,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,qBAAqB;QACrB,iBAAiB,EAAE,GAAG,CAAC,IAAI;KAC5B,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,uBAAuB,EACvB,oBAAoB,EACpB,WAAW,GAKZ;IACC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,MAAM,+BAA+B,CACnC,oBAAoB,CAAC,UAAU,CAAC,EAAE,EAClC,uBAAuB,EACvB,WAAW,CACZ,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IAAI,oBAAoB,CAAC,YAAY,EAAE,CAAC;QACtC,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,oBAAoB,CAAC,YAAY,CAClC,CAAA;IACH,CAAC;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC,CAAA;IACjE,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAC/C,CAAA;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;IAC3C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAA;IAEnE,OAAO;QACL,iBAAiB,EAAE,GAAG,CAAC,IAAI;KAC5B,CAAA;AACH,CAAC","sourcesContent":["import { SubmissionEventTypes } from '@oneblink/types'\nimport { PaymentProvider } from '../../types/payments'\nimport { FormSubmissionResult } from '../../types/submissions'\nimport replaceInjectablesWithSubmissionValues from '../replaceInjectablesWithSubmissionValues'\nimport OneBlinkAppsError from '../errors/oneBlinkAppsError'\nimport {\n generateAmountReceiptItem,\n generateCreditCardMaskReceiptItem,\n generateSubmissionIdReceiptItem,\n prepareReceiptItems,\n} from './receipt-items'\nimport {\n cancelWestpacQuickStreamPayment,\n completeWestpacQuickStreamTransaction,\n getCustomFormPaymentConfiguration,\n} from '../api/payment'\n\nexport default class WestpacQuickStreamPaymentProvider implements PaymentProvider<SubmissionEventTypes.WestpacQuickStreamSubmissionEvent> {\n constructor(\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent,\n formSubmissionResult: FormSubmissionResult,\n ) {\n this.formSubmissionResult = formSubmissionResult\n this.paymentSubmissionEvent = paymentSubmissionEvent\n }\n\n formSubmissionResult: FormSubmissionResult\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n\n async verifyPaymentTransaction(query: Record<string, unknown>) {\n const {\n paymentReferenceNumber,\n receiptNumber,\n maskedCardNumber4Digits,\n summaryCode,\n responseDescription,\n totalAmount,\n } = query as {\n paymentReferenceNumber?: string\n receiptNumber?: string\n maskedCardNumber4Digits?: string\n summaryCode?: string\n responseDescription?: string\n totalAmount?: string\n }\n if (\n !paymentReferenceNumber ||\n !receiptNumber ||\n !summaryCode ||\n !responseDescription ||\n !totalAmount\n ) {\n throw new OneBlinkAppsError(\n 'Transactions can not be verified unless navigating here directly after a payment.',\n )\n }\n if (this.formSubmissionResult.submissionId !== paymentReferenceNumber) {\n throw new OneBlinkAppsError(\n 'It looks like you are attempting to view a receipt for the incorrect payment.',\n )\n }\n\n return {\n receiptItems: prepareReceiptItems([\n generateSubmissionIdReceiptItem(this.formSubmissionResult.submissionId),\n {\n className: 'ob-payment-receipt__transaction-id',\n valueClassName: 'cypress-payment-receipt-transaction-id',\n icon: 'shopping_cart',\n label: 'Receipt Number',\n value: receiptNumber,\n allowCopyToClipboard: true,\n },\n generateCreditCardMaskReceiptItem(maskedCardNumber4Digits),\n generateAmountReceiptItem(parseFloat(totalAmount)),\n ]),\n transaction: {\n isSuccess: summaryCode === '0',\n errorMessage: responseDescription,\n },\n submissionResult: this.formSubmissionResult,\n }\n }\n}\n\nexport async function getPaymentFormConfiguration({\n formSubmissionResult,\n formSubmissionPaymentId,\n paymentSubmissionEvent,\n abortSignal,\n}: {\n formSubmissionResult: FormSubmissionResult\n formSubmissionPaymentId: string\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n abortSignal: AbortSignal\n}): Promise<{\n supplierBusinessCode: string\n publishableApiKey: string\n isTestMode: boolean\n}> {\n const { supplierBusinessCode, publishableApiKey, isTestMode } =\n await getCustomFormPaymentConfiguration<{\n supplierBusinessCode: string\n publishableApiKey: string\n isTestMode: boolean\n }>(\n `/forms/${formSubmissionResult.definition.id}/westpac-quick-stream-payment/${formSubmissionPaymentId}`,\n {\n integrationEnvironmentId:\n paymentSubmissionEvent.configuration.environmentId,\n },\n abortSignal,\n )\n\n return {\n supplierBusinessCode,\n publishableApiKey,\n isTestMode,\n }\n}\n\nexport async function completeTransaction({\n formSubmissionPaymentId,\n formSubmissionResult,\n paymentSubmissionEvent,\n singleUseTokenId,\n captchaSiteKey,\n captchaToken,\n abortSignal,\n}: {\n formSubmissionPaymentId: string\n formSubmissionResult: FormSubmissionResult\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n singleUseTokenId: string\n captchaSiteKey: string\n captchaToken: string\n abortSignal?: AbortSignal\n}) {\n if (!formSubmissionResult.payment) {\n throw new Error(\n '\"formSubmissionResult.payment\" must have a value to complete transactions',\n )\n }\n\n const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(\n formSubmissionResult.definition.id,\n {\n formSubmissionPaymentId,\n singleUseTokenId,\n integrationEnvironmentId:\n paymentSubmissionEvent.configuration.environmentId,\n customerReferenceNumber: replaceInjectablesWithSubmissionValues(\n paymentSubmissionEvent.configuration.customerReferenceNumber,\n formSubmissionResult,\n ).text,\n principalAmount: formSubmissionResult.payment.amount,\n recaptcha: {\n siteKey: captchaSiteKey,\n token: captchaToken,\n },\n },\n abortSignal,\n )\n\n const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n if (\n formSubmissionPayment.type === 'WESTPAC_QUICK_STREAM' &&\n formSubmissionPayment.paymentTransaction\n ) {\n url.searchParams.append(\n 'paymentReferenceNumber',\n formSubmissionPayment.paymentTransaction.paymentReferenceNumber,\n )\n url.searchParams.append(\n 'receiptNumber',\n formSubmissionPayment.paymentTransaction.receiptNumber,\n )\n url.searchParams.append(\n 'totalAmount',\n formSubmissionPayment.paymentTransaction.totalAmount.amount.toString(),\n )\n url.searchParams.append(\n 'summaryCode',\n formSubmissionPayment.paymentTransaction.summaryCode,\n )\n url.searchParams.append(\n 'responseDescription',\n formSubmissionPayment.paymentTransaction.responseDescription,\n )\n if (\n formSubmissionPayment.paymentTransaction.creditCard\n ?.maskedCardNumber4Digits\n ) {\n url.searchParams.append(\n 'maskedCardNumber4Digits',\n formSubmissionPayment.paymentTransaction.creditCard\n ?.maskedCardNumber4Digits,\n )\n }\n }\n\n return {\n formSubmissionPayment,\n paymentReceiptUrl: url.href,\n }\n}\n\nexport async function cancelPayment({\n formSubmissionPaymentId,\n formSubmissionResult,\n abortSignal,\n}: {\n formSubmissionPaymentId: string\n formSubmissionResult: FormSubmissionResult\n abortSignal?: AbortSignal\n}) {\n if (!formSubmissionResult.payment) {\n throw new Error(\n '\"formSubmissionResult.payment\" must have a value to cancel payments',\n )\n }\n\n await cancelWestpacQuickStreamPayment(\n formSubmissionResult.definition.id,\n formSubmissionPaymentId,\n abortSignal,\n )\n\n const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n if (formSubmissionResult.submissionId) {\n url.searchParams.append(\n 'paymentReferenceNumber',\n formSubmissionResult.submissionId,\n )\n }\n url.searchParams.append('receiptNumber', formSubmissionPaymentId)\n url.searchParams.append(\n 'totalAmount',\n formSubmissionResult.payment.amount.toString(),\n )\n url.searchParams.append('summaryCode', '1')\n url.searchParams.append('responseDescription', 'Payment Cancelled')\n\n return {\n paymentReceiptUrl: url.href,\n }\n}\n"]}
1
+ {"version":3,"file":"WestpacQuickStreamPaymentProvider.js","sourceRoot":"","sources":["../../../../src/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.ts"],"names":[],"mappings":"AAGA,OAAO,iBAAiB,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,+BAA+B,EAC/B,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,+BAA+B,EAC/B,qCAAqC,EACrC,iCAAiC,GAClC,MAAM,gBAAgB,CAAA;AAGvB,MAAM,CAAC,OAAO,OAAO,iCAAiC;IACpD,YACE,sBAA8E,EAC9E,oBAA0C;QAE1C,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;IACtD,CAAC;IAKD,KAAK,CAAC,wBAAwB,CAAC,KAA8B;QAC3D,MAAM,EACJ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,mBAAmB,EACnB,WAAW,GACZ,GAAG,KAOH,CAAA;QACD,IACE,CAAC,sBAAsB;YACvB,CAAC,aAAa;YACd,CAAC,WAAW;YACZ,CAAC,mBAAmB;YACpB,CAAC,WAAW,EACZ,CAAC;YACD,MAAM,IAAI,iBAAiB,CACzB,mFAAmF,CACpF,CAAA;QACH,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,CAAC,YAAY,KAAK,sBAAsB,EAAE,CAAC;YACtE,MAAM,IAAI,iBAAiB,CACzB,+EAA+E,CAChF,CAAA;QACH,CAAC;QAED,OAAO;YACL,YAAY,EAAE,mBAAmB,CAAC;gBAChC,+BAA+B,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC;gBACvE;oBACE,SAAS,EAAE,oCAAoC;oBAC/C,cAAc,EAAE,wCAAwC;oBACxD,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,aAAa;oBACpB,oBAAoB,EAAE,IAAI;iBAC3B;gBACD,iCAAiC,CAAC,uBAAuB,CAAC;gBAC1D,yBAAyB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACnD,CAAC;YACF,WAAW,EAAE;gBACX,SAAS,EAAE,WAAW,KAAK,GAAG;gBAC9B,YAAY,EAAE,mBAAmB;aAClC;YACD,gBAAgB,EAAE,IAAI,CAAC,oBAAoB;SAC5C,CAAA;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,EAChD,OAAO,EACP,WAAW,GAIZ;IAKC,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAC3D,MAAM,iCAAiC,CAKrC,UAAU,OAAO,CAAC,MAAM,iCAAiC,OAAO,CAAC,uBAAuB,EAAE,EAC1F;QACE,wBAAwB,EAAE,OAAO,CAAC,wBAAwB;KAC3D,EACD,WAAW,CACZ,CAAA;IAEH,OAAO;QACL,oBAAoB;QACpB,iBAAiB;QACjB,UAAU;KACX,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,WAAW,GASZ;IAGC,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,qCAAqC,CAC3E,OAAO,CAAC,MAAM,EACd;QACE,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,gBAAgB;QAChB,wBAAwB,EAAE,OAAO,CAAC,wBAAwB;QAC1D,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,eAAe,EAAE,OAAO,CAAC,MAAM;QAC/B,SAAS;KACV,EACD,WAAW,CACZ,CAAA;IAED,OAAO;QACL,qBAAqB;KACtB,CAAA;AACH,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,OAAO,EACP,WAAW,GAIZ;IACC,MAAM,+BAA+B,CACnC,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,uBAAuB,EAC/B,WAAW,CACZ,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAAC,EAC5C,oBAAoB,EACpB,qBAAqB,GAItB;;IACC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;IACH,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IACE,qBAAqB,CAAC,IAAI,KAAK,sBAAsB;QACrD,qBAAqB,CAAC,kBAAkB,EACxC,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,qBAAqB,CAAC,kBAAkB,CAAC,sBAAsB,CAChE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,eAAe,EACf,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CACvD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CACvE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CACrD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,qBAAqB,EACrB,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC7D,CAAA;QACD,IACE,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,EAC3B,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,yBAAyB,EACzB,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,CAC5B,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC,IAAI,CAAA;AACjB,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,6BAA6B,CAC3C,oBAA0C,EAC1C,uBAA+B;IAE/B,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;IACH,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IAAI,oBAAoB,CAAC,YAAY,EAAE,CAAC;QACtC,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,oBAAoB,CAAC,YAAY,CAClC,CAAA;IACH,CAAC;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC,CAAA;IACjE,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAC/C,CAAA;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;IAC3C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAA;IAEnE,OAAO,GAAG,CAAC,IAAI,CAAA;AACjB,CAAC","sourcesContent":["import { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types'\nimport { PaymentProvider } from '../../types/payments'\nimport { FormSubmissionResult } from '../../types/submissions'\nimport OneBlinkAppsError from '../errors/oneBlinkAppsError'\nimport {\n generateAmountReceiptItem,\n generateCreditCardMaskReceiptItem,\n generateSubmissionIdReceiptItem,\n prepareReceiptItems,\n} from './receipt-items'\nimport {\n cancelWestpacQuickStreamPayment,\n completeWestpacQuickStreamTransaction,\n getCustomFormPaymentConfiguration,\n} from '../api/payment'\nimport { PaymentFormSession } from '../payment-handoff'\n\nexport default class WestpacQuickStreamPaymentProvider implements PaymentProvider<SubmissionEventTypes.WestpacQuickStreamSubmissionEvent> {\n constructor(\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent,\n formSubmissionResult: FormSubmissionResult,\n ) {\n this.formSubmissionResult = formSubmissionResult\n this.paymentSubmissionEvent = paymentSubmissionEvent\n }\n\n formSubmissionResult: FormSubmissionResult\n paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n\n async verifyPaymentTransaction(query: Record<string, unknown>) {\n const {\n paymentReferenceNumber,\n receiptNumber,\n maskedCardNumber4Digits,\n summaryCode,\n responseDescription,\n totalAmount,\n } = query as {\n paymentReferenceNumber?: string\n receiptNumber?: string\n maskedCardNumber4Digits?: string\n summaryCode?: string\n responseDescription?: string\n totalAmount?: string\n }\n if (\n !paymentReferenceNumber ||\n !receiptNumber ||\n !summaryCode ||\n !responseDescription ||\n !totalAmount\n ) {\n throw new OneBlinkAppsError(\n 'Transactions can not be verified unless navigating here directly after a payment.',\n )\n }\n if (this.formSubmissionResult.submissionId !== paymentReferenceNumber) {\n throw new OneBlinkAppsError(\n 'It looks like you are attempting to view a receipt for the incorrect payment.',\n )\n }\n\n return {\n receiptItems: prepareReceiptItems([\n generateSubmissionIdReceiptItem(this.formSubmissionResult.submissionId),\n {\n className: 'ob-payment-receipt__transaction-id',\n valueClassName: 'cypress-payment-receipt-transaction-id',\n icon: 'shopping_cart',\n label: 'Receipt Number',\n value: receiptNumber,\n allowCopyToClipboard: true,\n },\n generateCreditCardMaskReceiptItem(maskedCardNumber4Digits),\n generateAmountReceiptItem(parseFloat(totalAmount)),\n ]),\n transaction: {\n isSuccess: summaryCode === '0',\n errorMessage: responseDescription,\n },\n submissionResult: this.formSubmissionResult,\n }\n }\n}\n\n/**\n * Get the QuickStream configuration needed to render the card form for a\n * payment session.\n */\nexport async function getPaymentFormConfiguration({\n session,\n abortSignal,\n}: {\n session: PaymentFormSession\n abortSignal: AbortSignal\n}): Promise<{\n supplierBusinessCode: string\n publishableApiKey: string\n isTestMode: boolean\n}> {\n const { supplierBusinessCode, publishableApiKey, isTestMode } =\n await getCustomFormPaymentConfiguration<{\n supplierBusinessCode: string\n publishableApiKey: string\n isTestMode: boolean\n }>(\n `/forms/${session.formId}/westpac-quick-stream-payment/${session.formSubmissionPaymentId}`,\n {\n integrationEnvironmentId: session.integrationEnvironmentId,\n },\n abortSignal,\n )\n\n return {\n supplierBusinessCode,\n publishableApiKey,\n isTestMode,\n }\n}\n\n/**\n * Complete the QuickStream transaction for a payment session.\n *\n * `recaptcha` is required for payments started from a form submission and\n * omitted for payments started from an approval step.\n */\nexport async function completeTransaction({\n session,\n singleUseTokenId,\n recaptcha,\n abortSignal,\n}: {\n session: PaymentFormSession\n singleUseTokenId: string\n recaptcha?: {\n siteKey: string\n token: string\n }\n abortSignal?: AbortSignal\n}): Promise<{\n formSubmissionPayment: SubmissionTypes.FormSubmissionPayment\n}> {\n const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(\n session.formId,\n {\n formSubmissionPaymentId: session.formSubmissionPaymentId,\n singleUseTokenId,\n integrationEnvironmentId: session.integrationEnvironmentId,\n customerReferenceNumber: session.customerReferenceNumber,\n principalAmount: session.amount,\n recaptcha,\n },\n abortSignal,\n )\n\n return {\n formSubmissionPayment,\n }\n}\n\n/** Cancel the QuickStream payment for a payment session. */\nexport async function cancelPayment({\n session,\n abortSignal,\n}: {\n session: PaymentFormSession\n abortSignal?: AbortSignal\n}): Promise<void> {\n await cancelWestpacQuickStreamPayment(\n session.formId,\n session.formSubmissionPaymentId,\n abortSignal,\n )\n}\n\n/**\n * Get the receipt URL for a completed QuickStream transaction. The receipt page\n * verifies the transaction using the query parameters added here.\n */\nexport function getCompletedPaymentReceiptUrl({\n formSubmissionResult,\n formSubmissionPayment,\n}: {\n formSubmissionResult: FormSubmissionResult\n formSubmissionPayment: SubmissionTypes.FormSubmissionPayment\n}): string {\n if (!formSubmissionResult.payment) {\n throw new Error(\n '\"formSubmissionResult.payment\" must have a value to create a receipt URL',\n )\n }\n\n const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n if (\n formSubmissionPayment.type === 'WESTPAC_QUICK_STREAM' &&\n formSubmissionPayment.paymentTransaction\n ) {\n url.searchParams.append(\n 'paymentReferenceNumber',\n formSubmissionPayment.paymentTransaction.paymentReferenceNumber,\n )\n url.searchParams.append(\n 'receiptNumber',\n formSubmissionPayment.paymentTransaction.receiptNumber,\n )\n url.searchParams.append(\n 'totalAmount',\n formSubmissionPayment.paymentTransaction.totalAmount.amount.toString(),\n )\n url.searchParams.append(\n 'summaryCode',\n formSubmissionPayment.paymentTransaction.summaryCode,\n )\n url.searchParams.append(\n 'responseDescription',\n formSubmissionPayment.paymentTransaction.responseDescription,\n )\n if (\n formSubmissionPayment.paymentTransaction.creditCard\n ?.maskedCardNumber4Digits\n ) {\n url.searchParams.append(\n 'maskedCardNumber4Digits',\n formSubmissionPayment.paymentTransaction.creditCard\n ?.maskedCardNumber4Digits,\n )\n }\n }\n\n return url.href\n}\n\n/** Get the receipt URL for a cancelled QuickStream payment. */\nexport function getCancelledPaymentReceiptUrl(\n formSubmissionResult: FormSubmissionResult,\n formSubmissionPaymentId: string,\n): string {\n if (!formSubmissionResult.payment) {\n throw new Error(\n '\"formSubmissionResult.payment\" must have a value to create a receipt URL',\n )\n }\n\n const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n if (formSubmissionResult.submissionId) {\n url.searchParams.append(\n 'paymentReferenceNumber',\n formSubmissionResult.submissionId,\n )\n }\n url.searchParams.append('receiptNumber', formSubmissionPaymentId)\n url.searchParams.append(\n 'totalAmount',\n formSubmissionResult.payment.amount.toString(),\n )\n url.searchParams.append('summaryCode', '1')\n url.searchParams.append('responseDescription', 'Payment Cancelled')\n\n return url.href\n}\n"]}
@@ -2,6 +2,7 @@ import { isOffline } from './offline-service';
2
2
  import { getFormsKeyId, isLoggedIn } from './auth-service';
3
3
  import { registerPendingQueueListener, getPendingQueueSubmissions, updatePendingQueueSubmission, cancelEditingPendingQueueSubmission, deletePendingQueueSubmission, editPendingQueueSubmission, registerPendingQueueAttachmentProgressListener, registerPendingQueueProgressListener, executePendingQueueProgressListeners, removePendingQueueSubmission, } from './services/pending-queue';
4
4
  import replaceInjectablesWithSubmissionValues from './services/replaceInjectablesWithSubmissionValues';
5
+ import { getFormSubmissionPaymentHandoff } from './services/payment-handoff';
5
6
  import Sentry from './Sentry';
6
7
  import prepareSubmissionData from './services/prepareSubmissionData';
7
8
  import submitForm from './services/submit';
@@ -343,7 +344,7 @@ async function executePostSubmissionAction(submissionResult, { onRedirectToRelat
343
344
  }
344
345
  else if (submissionResult.payment) {
345
346
  postSubmissionAction = 'URL';
346
- redirectUrl = submissionResult.payment.hostedFormUrl;
347
+ redirectUrl = getFormSubmissionPaymentHandoff(submissionResult);
347
348
  }
348
349
  else if (submissionResult.taskCompletion) {
349
350
  postSubmissionAction = 'URL';
@@ -1 +1 @@
1
- {"version":3,"file":"submission-service.js","sourceRoot":"","sources":["../../src/apps/submission-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,mCAAmC,EACnC,4BAA4B,EAC5B,0BAA0B,EAC1B,8CAA8C,EAC9C,oCAAoC,EACpC,oCAAoC,EACpC,4BAA4B,GAG7B,MAAM,0BAA0B,CAAA;AACjC,OAAO,sCAAsC,MAAM,mDAAmD,CAAA;AAEtG,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,qBAAqB,MAAM,kCAAkC,CAAA;AACpE,OAAO,UAIN,MAAM,mBAAmB,CAAA;AAW1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EACL,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,4BAA4B,MAAM,gDAAgD,CAAA;AAEzF,IAAI,yBAAyB,GAAG,KAAK,CAAA;AAErC;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,mBAAmB,CAAC,EACjC,6BAA6B,EAC7B,yBAAyB,GAI1B;IACC,IAAI,yBAAyB,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IACD,yBAAyB,GAAG,IAAI,CAAA;IAEhC,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAA;IACtD,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,EAAE,CAAA;IAElE,OAAO,CAAC,GAAG,CACT,SAAS,uBAAuB,CAAC,MAAM,sCAAsC,CAC9E,CAAA;IACD,KAAK,MAAM,sBAAsB,IAAI,uBAAuB,EAAE,CAAC;QAC7D,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CACT,kEAAkE,EAClE,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IAAI,sBAAsB,CAAC,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CACT,sEAAsE,EACtE,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IACE,sBAAsB,CAAC,UAAU,CAAC,eAAe;YACjD,CAAC,UAAU,EAAE;YACb,CAAC,aAAa,EAAE,EAChB,CAAC;YACD,OAAO,CAAC,GAAG,CACT,6HAA6H,EAC7H,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CACT,sDAAsD,EACtD,sBAAsB,CACvB,CAAA;YAED,sBAAsB,CAAC,YAAY,GAAG,IAAI,CAAA;YAC1C,sBAAsB,CAAC,KAAK,GAAG,SAAS,CAAA;YACxC,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,sBAAsB,EACtB,gBAAgB,CACjB,CAAA;YAED,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CACpD,sBAAsB,CACvB,CAAA;YACD,sBAAsB,CAAC,UAAU,GAAG;gBAClC,GAAG,kBAAkB;aACtB,CAAA;YACD,MAAM,WAAW,GAAG,8BAA8B,CAChD,sBAAsB,CAAC,UAAU,CAAC,QAAQ,EAC1C,sBAAsB,CAAC,UAAU,CAClC,CAAA;YACD,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAC1C,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAClD,CAAA;YACD,IAAI,iBAAiB,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,oBAAoB,iBAAiB,CAAC,MAAM,cAC1C,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EACvC,GAAG,CACJ,CAAA;YACH,CAAC;YACD,MAAM,6BAA6B,CAAC;gBAClC,qBAAqB,EAAE,IAAI;gBAC3B,cAAc,EAAE,sBAAsB;gBACtC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBACpB,oCAAoC,CAAC;wBACnC,GAAG,KAAK;wBACR,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;qBAC1D,CAAC,CAAA;gBACJ,CAAC;gBACD,6BAA6B;gBAC7B,yBAAyB;gBACzB,cAAc,EAAE,SAAS;gBACzB,iBAAiB,EAAE,SAAS;gBAC5B,mBAAmB,EAAE,sBAAsB,CAAC,gBAAgB;aAC7D,CAAC,CAAA;YAEF,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,kBAAkB,CACnB,CAAA;YAED,OAAO,CAAC,GAAG,CACT,0DAA0D,EAC1D,sBAAsB,CACvB,CAAA;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,KAAK,CAAC,oDAAoD,EAAE,KAAK,CAAC,CAAA;YAC1E,sBAAsB,CAAC,YAAY,GAAG,KAAK,CAAA;YAC3C,IAAK,KAAe,CAAC,OAAO,EAAE,CAAC;gBAC7B,sBAAsB,CAAC,KAAK,GAAI,KAAe,CAAC,OAAO,CAAA;YACzD,CAAC;iBAAM,CAAC;gBACN,sBAAsB,CAAC,KAAK;oBAC1B,wJAAwJ,CAAA;YAC5J,CAAC;YACD,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,sBAAsB,EACtB,eAAe,CAChB,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CACT,qEAAqE,CACtE,CAAA;IACD,yBAAyB,GAAG,KAAK,CAAA;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,KAAK,UAAU,MAAM,CACnB,MAEC;IAED,OAAO,MAAM,6BAA6B,CAAC;QACzC,GAAG,MAAM;QACT,mBAAmB,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KAC9C,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,6BAA6B,CAAC,EAC3C,WAAW,EACX,GAAG,MAAM,EAIV;IACC,MAAM,oBAAoB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;IACrD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC;YACH,MAAM,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,WAAW,CAAC,CAAA;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAA;YACtD,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IACD,OAAO,oBAAoB,CAAA;AAC7B,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,mBAAmB;IACnB,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClD,mBAAmB;QACnB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;QAC7B,OAAM;IACR,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,CAAA;IAEd,+CAA+C;IAC/C,2CAA2C;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;YACxE,MAAM,CACJ,IAAI,KAAK,CACP,kFAAkF,CACnF,CACF,CAAA;QACH,CAAC,EAAE,GAAG,CAAC,CAAA;IACT,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,mBAAmB;IAChC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,WAAW,EAAE,CAAA;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,KAAK,UAAU,mBAAmB,CAChC,2BAIC,EACD,EACE,uBAAuB,EACvB,uBAAuB,GAIxB;IAED,MAAM,oBAAoB,GAAyB;QACjD,GAAG,2BAA2B;QAC9B,UAAU,EAAE,GAAG;QACf,qBAAqB,EAAE,SAAS;QAChC,KAAK,EAAE,SAAS;QAChB,UAAU,EAAE,SAAS;QACrB,iBAAiB,EAAE,IAAI;QACvB,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,EAAE;QACd,gBAAgB,EAAE,KAAK;QACvB,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,IAAI;QAClB,mBAAmB,EAAE,IAAI;QACzB,sBAAsB,EAAE,KAAK;KAC9B,CAAA;IAED,IAAI,YAAY,GAAG,oBAAoB,CAAC,UAAU,CAAC,YAAY,CAAA;IAC/D,IAAI,iBAAiB,GAAG,oBAAoB,CAAC,UAAU,CAAC,iBAAiB,CAAA;IAEzE,IAAI,oBAAoB,CAAC,cAAc,EAAE,CAAC;QACxC,YAAY,GAAG,KAAK,CAAA;QACpB,iBAAiB,GAAG,oBAAoB,CAAC,cAAc,CAAC,WAAW,CAAA;IACrE,CAAC;IAED,MAAM,aAAa,CAAC,oBAAoB,EAAE;QACxC,MAAM,EAAE,YAAY;QACpB,WAAW,EAAE,iBAAiB;QAC9B,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,KAAK,UAAU,2BAA2B,CACxC,gBAAsC,EACtC,EACE,uBAAuB,EACvB,uBAAuB,GAIxB;IAED,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;IACvD,IAAI,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,oBAAoB,CAAA;IAC3E,IAAI,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAA;IAEzD,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;QAChC,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAA;IACtD,CAAC;SAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;QACpC,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAA;IACtD,CAAC;SAAM,IAAI,gBAAgB,CAAC,cAAc,EAAE,CAAC;QAC3C,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,gBAAgB,CAAC,cAAc,CAAC,WAAW,CAAA;IAC3D,CAAC;IAED,MAAM,aAAa,CAAC,gBAAgB,EAAE;QACpC,MAAM,EAAE,oBAAoB;QAC5B,WAAW;QACX,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,gBAAsC,EACtC,EACE,MAAM,EACN,WAAW,EACX,uBAAuB,EACvB,uBAAuB,GAMxB;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO;YACV,OAAO,WAAW,EAAE,CAAA;QACtB,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;gBACrC,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YACjD,CAAC;iBAAM,CAAC;gBACN,uBAAuB,CAAC,GAAG,CAAC,CAAA;YAC9B,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,MAAM,GAAG,sCAAsC,CACnD,WAAW,IAAI,GAAG,EAClB,gBAAgB,CACjB,CAAC,IAAI,CAAA;YACN,+CAA+C;YAC/C,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBACtB,uBAAuB,CAAC,MAAM,CAAC,CAAA;gBAC/B,OAAM;YACR,CAAC;YAED,uBAAuB,CAAC,MAAM,CAAC,CAAA;YAE/B,8CAA8C;YAC9C,yCAAyC;YACzC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,qDAAqD;gBACrD,gDAAgD;gBAChD,UAAU,CAAC,GAAG,EAAE;oBACd,uBAAuB,CAAC,GAAG,CAAC,CAAA;gBAC9B,CAAC,EAAE,IAAI,CAAC,CAAA;YACV,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,OAAO,CAAC,CAAC,CAAC;YACR,2EAA2E;YAC3E,OAAO,mBAAmB,EAAE,CAAA;QAC9B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,KAAK,UAAU,iBAAiB,CAAC,EAC/B,MAAM,EACN,YAAY,EACZ,WAAW,EACX,SAAS,EACT,WAAW,GAQZ;IAIC,OAAO,MAAM,sBAAsB,CAAC;QAClC,MAAM;QACN,YAAY;QACZ,WAAW;QACX,SAAS;QACT,WAAW;KACZ,CAAC,CAAA;AACJ,CAAC;AAED,OAAO,EACL,MAAM,EACN,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,mBAAmB,EAUnB,8CAA8C,EAC9C,oCAAoC,EAKpC,iBAAiB,EACjB,wBAAwB,EACxB,4BAA4B,GAC7B,CAAA","sourcesContent":["import { isOffline } from './offline-service'\nimport { getFormsKeyId, isLoggedIn } from './auth-service'\nimport {\n registerPendingQueueListener,\n getPendingQueueSubmissions,\n updatePendingQueueSubmission,\n cancelEditingPendingQueueSubmission,\n deletePendingQueueSubmission,\n editPendingQueueSubmission,\n registerPendingQueueAttachmentProgressListener,\n registerPendingQueueProgressListener,\n executePendingQueueProgressListeners,\n removePendingQueueSubmission,\n PendingQueueListener,\n PendingQueueAction,\n} from './services/pending-queue'\nimport replaceInjectablesWithSubmissionValues from './services/replaceInjectablesWithSubmissionValues'\nimport { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport Sentry from './Sentry'\nimport prepareSubmissionData from './services/prepareSubmissionData'\nimport submitForm, {\n SubmissionParams,\n ProgressListener,\n ProgressListenerEvent,\n} from './services/submit'\nimport {\n PendingFormSubmission,\n FormSubmission,\n FormSubmissionResult,\n BaseFormSubmission,\n NewDraftSubmission,\n NewFormSubmission,\n DraftSubmission,\n DraftSubmissionInput,\n} from './types/submissions'\nimport { deleteAutoSaveData } from './auto-save-service'\nimport {\n downloadFormSubmission,\n uploadFormSubmissionEdit,\n} from './services/api/submissions'\nimport { getSubmissionAttachmentDetails } from './attachments-service'\nimport getPostSubmissionAttachments from './services/api/post-submission-attachment-urls'\n\nlet _isProcessingPendingQueue = false\n\n/**\n * Force processing the pending queue. This must be called to process the\n * pending queue and is best used when the application comes back online.\n *\n * ### Example\n *\n * ```js\n * await submissionService.processPendingQueue()\n * ```\n *\n * @returns\n */\nasync function processPendingQueue({\n shouldRunExternalIdGeneration,\n shouldRunServerValidation,\n}: {\n shouldRunExternalIdGeneration: boolean\n shouldRunServerValidation: boolean\n}): Promise<void> {\n if (_isProcessingPendingQueue) {\n return\n }\n _isProcessingPendingQueue = true\n\n console.log('Checking pending queue for submissions.')\n const pendingQueueSubmissions = await getPendingQueueSubmissions()\n\n console.log(\n `Found ${pendingQueueSubmissions.length} submission(s) in the pending queue.`,\n )\n for (const pendingQueueSubmission of pendingQueueSubmissions) {\n if (isOffline()) {\n console.log(\n 'Application is offline, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n if (pendingQueueSubmission.isEditing) {\n console.log(\n 'submission is being edited, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n if (\n pendingQueueSubmission.definition.isAuthenticated &&\n !isLoggedIn() &&\n !getFormsKeyId()\n ) {\n console.log(\n 'Authentication is required for this form but the user does not have a valid token, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n try {\n console.log(\n 'Attempting to process submission from pending queue:',\n pendingQueueSubmission,\n )\n\n pendingQueueSubmission.isSubmitting = true\n pendingQueueSubmission.error = undefined\n await updatePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n pendingQueueSubmission,\n 'SUBMIT_STARTED',\n )\n\n const preparedSubmission = await prepareSubmissionData(\n pendingQueueSubmission,\n )\n pendingQueueSubmission.submission = {\n ...preparedSubmission,\n }\n const attachments = getSubmissionAttachmentDetails(\n pendingQueueSubmission.definition.elements,\n pendingQueueSubmission.submission,\n )\n const failedAttachments = attachments.filter(\n (attachment) => attachment.value.type === 'ERROR',\n )\n if (failedAttachments.length) {\n throw new Error(\n `Failed to upload ${failedAttachments.length} attachment${\n failedAttachments.length > 1 ? 's' : ''\n }.`,\n )\n }\n await submitWithCompletionTimestamp({\n isPendingQueueEnabled: true,\n formSubmission: pendingQueueSubmission,\n onProgress: (event) => {\n executePendingQueueProgressListeners({\n ...event,\n pendingTimestamp: pendingQueueSubmission.pendingTimestamp,\n })\n },\n shouldRunExternalIdGeneration,\n shouldRunServerValidation,\n paymentFormUrl: undefined,\n paymentReceiptUrl: undefined,\n completionTimestamp: pendingQueueSubmission.pendingTimestamp,\n })\n\n await removePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n 'SUBMIT_SUCCEEDED',\n )\n\n console.log(\n 'Successfully processed submission from the pending queue',\n pendingQueueSubmission,\n )\n } catch (error) {\n Sentry.captureException(error)\n console.error('Error processing submission from the pending queue', error)\n pendingQueueSubmission.isSubmitting = false\n if ((error as Error).message) {\n pendingQueueSubmission.error = (error as Error).message\n } else {\n pendingQueueSubmission.error =\n 'An unknown error has occurred, which has prevented your Form from submitting. Please try again, or contact your Administrator if the problem persists.'\n }\n await updatePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n pendingQueueSubmission,\n 'SUBMIT_FAILED',\n )\n }\n }\n\n console.log(\n 'Finished attempting to processing submissions in the pending queue.',\n )\n _isProcessingPendingQueue = false\n}\n\n/**\n * Submit a FormSubmission. Offline submissions will be added to a pending queue\n * and be processed using the `processPendingQueue()` function. FormSubmissions\n * with payment submission events will return the FormSubmissionResult with a\n * `payment` property set, this should be used to redirect the user to the\n * payment URL. Will also handle cleaning up auto save data (if the\n * `autoSaveKey` property is passed), locally stored drafts and prefill data.\n *\n * ### Example\n *\n * ```js\n * const formSubmission = {\n * formsAppId: 1,\n * submission: {\n * form: 'data',\n * goes: 'here',\n * },\n * definition: OneBlinkForm,\n * captchaTokens: [],\n * formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',\n * jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',\n * preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',\n * externalId: 'external-id-set-by-developer',\n * }\n *\n * // Pass paymentReceiptUrl if submission may require a payment\n * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`\n *\n * // Pass schedulingBookingUrlConfiguration if submission utilise scheduling\n * const schedulingBookingUrlConfiguration = {\n * schedulingBookingUrl: 'https://my-website.com/booking',\n * schedulingRescheduleUrl: 'https://my-website.com/reschedule',\n * schedulingCancelUrl: 'https://my-website.com/cancel',\n * }\n * const submissionResult = await submissionService.submit({\n * formSubmission,\n * paymentReceiptUrl,\n * schedulingBookingUrlConfiguration,\n * })\n *\n * if (submissionResult.scheduling) {\n * // Redirect user to booking form\n * window.location.href = submissionResult.scheduling.bookingUrl\n * return\n * }\n *\n * if (submissionResult.payment) {\n * // Redirect user to payment form\n * window.location.href = submissionResult.payment.hostedFormUrl\n * return\n * }\n *\n * if (submissionResult.isOffline) {\n * if (submissionResult.isInPendingQueue) {\n * // Display message to user that the submission\n * // has been added to the pending queue\n * } else {\n * // Display message to user that this submission can\n * // not be processed while offline (most likely because it requires a payment)\n * }\n * return\n * }\n *\n * // submissionResult.submissionId and submissionResult.submissionTimestamp\n * // will be set if the submission was successful\n * ```\n *\n * @param params\n * @returns\n */\nasync function submit(\n params: SubmissionParams & {\n autoSaveKey?: string\n },\n): Promise<FormSubmissionResult> {\n return await submitWithCompletionTimestamp({\n ...params,\n completionTimestamp: new Date().toISOString(),\n })\n}\n\nasync function submitWithCompletionTimestamp({\n autoSaveKey,\n ...params\n}: SubmissionParams & {\n autoSaveKey?: string\n completionTimestamp: string\n}): Promise<FormSubmissionResult> {\n const formSubmissionResult = await submitForm(params)\n if (typeof autoSaveKey === 'string') {\n try {\n await deleteAutoSaveData(params.formSubmission.definition.id, autoSaveKey)\n } catch (error) {\n console.warn('Error removing auto save data: ', error)\n Sentry.captureException(error)\n }\n }\n return formSubmissionResult\n}\n\nasync function closeWindow(): Promise<void> {\n // @ts-expect-error\n if (window.cordova && window.cordova.plugins.exit) {\n // @ts-expect-error\n window.cordova.plugins.exit()\n return\n }\n\n window.close()\n\n // If the browser has not closed after timeout,\n // we throw an error to display to the user\n return new Promise((resolve, reject) => {\n setTimeout(() => {\n console.log('Could not close as window was not opened using JavaScript')\n reject(\n new Error(\n 'We were unable to close your browser, could you please close it manually for us?',\n ),\n )\n }, 500)\n })\n}\n\n/**\n * Go back in the browser history or attempts to close the browser tab if there\n * is no history.\n *\n * ### Example\n *\n * ```js\n * try {\n * await submissionService.goBackOrCloseWindow()\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @returns\n */\nasync function goBackOrCloseWindow(): Promise<void> {\n if (window.history.length <= 1) {\n return closeWindow()\n } else {\n window.history.back()\n }\n}\n\n/**\n * Action to cancel completing a form, currently goes back in the browser\n * history or attempts to close the browser tab if there is no history.\n *\n * ### Example\n *\n * ```js\n * const options = {\n * definition: OneBlinkForm,\n * externalId: 'external-id-set-by-developer',\n * }\n * // Only used for relative URLs\n * const pushRelativePath = (path) => {\n * window.location.href = path\n * }\n * // Only used for aboslute URLS\n * const replaceAbsolutePath = window.location.replace\n *\n * try {\n * await submissionService.executeCancelAction(options, {\n * onRedirectToRelativeUrl: pushRelativePath,\n * onRedirectToAbsoluteUrl: replaceAbsolutePath,\n * })\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @param options\n * @param redirectConfig\n */\nasync function executeCancelAction(\n formSubmissionResultOptions: {\n definition: FormTypes.Form\n externalId: string | null\n taskCompletion?: FormSubmissionResult['taskCompletion']\n },\n {\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n const formSubmissionResult: FormSubmissionResult = {\n ...formSubmissionResultOptions,\n formsAppId: NaN,\n formSubmissionDraftId: undefined,\n jobId: undefined,\n externalId: undefined,\n preFillFormDataId: null,\n recaptchas: [],\n submission: {},\n isInPendingQueue: false,\n isOffline: false,\n payment: null,\n scheduling: null,\n submissionId: null,\n submissionTimestamp: null,\n isUploadingAttachments: false,\n }\n\n let cancelAction = formSubmissionResult.definition.cancelAction\n let cancelRedirectUrl = formSubmissionResult.definition.cancelRedirectUrl\n\n if (formSubmissionResult.taskCompletion) {\n cancelAction = 'URL'\n cancelRedirectUrl = formSubmissionResult.taskCompletion.redirectUrl\n }\n\n await executeAction(formSubmissionResult, {\n action: cancelAction,\n redirectUrl: cancelRedirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n })\n}\n\n/**\n * Execute the post submission action for a form after a successful form\n * submission.\n *\n * ### Example\n *\n * ```js\n * const formSubmissionResult = {\n * submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',\n * submissionTimestamp: '2020-07-29T01:03:26.573Z'\n * formsAppId: 1,\n * submission: {\n * form: 'data',\n * goes: 'here'\n * },\n * definition: OneBlinkForm,\n * payment: {\n * hostedFormUrl: 'https://payment.com/transaction'\n * },\n * formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',\n * jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',\n * preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',\n * externalId: 'external-id-set-by-developer',\n * }\n * // Only used for relative URLs\n * const pushRelativePath = (path) => {\n * window.location.href = path\n * }\n * // Only used for aboslute URLS\n * const replaceAbsolutePath = window.location.replace\n *\n * try {\n * await submissionService.executePostSubmissionAction(formSubmissionResult, {\n * onRedirectToRelativeUrl: pushRelativePath,\n * onRedirectToAbsoluteUrl: replaceAbsolutePath,\n * })\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @param submissionResult\n * @param redirectConfig\n */\nasync function executePostSubmissionAction(\n submissionResult: FormSubmissionResult,\n {\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n console.log('Attempting to run post submission action')\n let postSubmissionAction = submissionResult.definition.postSubmissionAction\n let redirectUrl = submissionResult.definition.redirectUrl\n\n if (submissionResult.scheduling) {\n postSubmissionAction = 'URL'\n redirectUrl = submissionResult.scheduling.bookingUrl\n } else if (submissionResult.payment) {\n postSubmissionAction = 'URL'\n redirectUrl = submissionResult.payment.hostedFormUrl\n } else if (submissionResult.taskCompletion) {\n postSubmissionAction = 'URL'\n redirectUrl = submissionResult.taskCompletion.redirectUrl\n }\n\n await executeAction(submissionResult, {\n action: postSubmissionAction,\n redirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n })\n}\n\nasync function executeAction(\n submissionResult: FormSubmissionResult,\n {\n action,\n redirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n action: FormTypes.FormPostSubmissionAction\n redirectUrl: string | undefined\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n switch (action) {\n case 'CLOSE':\n return closeWindow()\n case 'FORMS_LIBRARY': {\n if (window.location.pathname === '/') {\n onRedirectToAbsoluteUrl(window.location.origin)\n } else {\n onRedirectToRelativeUrl('/')\n }\n break\n }\n case 'URL': {\n const newUrl = replaceInjectablesWithSubmissionValues(\n redirectUrl || '/',\n submissionResult,\n ).text\n // Relative URLs can be navigated to internally\n if (newUrl[0] === '/') {\n onRedirectToRelativeUrl(newUrl)\n return\n }\n\n onRedirectToAbsoluteUrl(newUrl)\n\n // If we are in cordova land, we will navigate\n // back to the home screen after redirect\n if (window.cordova) {\n // Wait a couple of seconds to ensure the browser has\n // been opened before navigating away from form.\n setTimeout(() => {\n onRedirectToRelativeUrl('/')\n }, 2000)\n }\n break\n }\n case 'BACK':\n default: {\n // if there's no post submission action for some reason, use prev. logic...\n return goBackOrCloseWindow()\n }\n }\n}\n\n/**\n * Retrieve submission data for a known formId and submissionId\n *\n * #### Example\n *\n * ```js\n * const formId = 1\n * const submissionId = 'fba95b9d-5a9c-463d-ab68-867f431e4120'\n * const credentials = await formSubmissionService.getSubmissionData({\n * formId,\n * submissionId,\n * })\n * ```\n *\n * @param options\n * @param options.formId\n * @param options.submissionId\n * @param options.abortSignal\n * @param options.versionId\n * @param options.asSubmitted\n * @returns\n */\nasync function getSubmissionData({\n formId,\n submissionId,\n abortSignal,\n versionId,\n asSubmitted,\n}: {\n formId: number\n submissionId: string\n abortSignal?: AbortSignal\n versionId?: string\n /** Download the submission data as it was originally submitted. */\n asSubmitted?: boolean\n}): Promise<{\n data: SubmissionTypes.S3SubmissionData\n versionId: string | undefined\n}> {\n return await downloadFormSubmission({\n formId,\n submissionId,\n abortSignal,\n versionId,\n asSubmitted,\n })\n}\n\nexport {\n submit,\n executePostSubmissionAction,\n executeCancelAction,\n goBackOrCloseWindow,\n getPendingQueueSubmissions,\n deletePendingQueueSubmission,\n editPendingQueueSubmission,\n cancelEditingPendingQueueSubmission,\n registerPendingQueueListener,\n processPendingQueue,\n BaseFormSubmission,\n NewDraftSubmission,\n NewFormSubmission,\n DraftSubmissionInput,\n DraftSubmission,\n FormSubmission,\n FormSubmissionResult,\n PendingFormSubmission,\n SubmissionParams,\n registerPendingQueueAttachmentProgressListener,\n registerPendingQueueProgressListener,\n ProgressListener,\n ProgressListenerEvent,\n PendingQueueListener,\n PendingQueueAction,\n getSubmissionData,\n uploadFormSubmissionEdit,\n getPostSubmissionAttachments,\n}\n"]}
1
+ {"version":3,"file":"submission-service.js","sourceRoot":"","sources":["../../src/apps/submission-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,mCAAmC,EACnC,4BAA4B,EAC5B,0BAA0B,EAC1B,8CAA8C,EAC9C,oCAAoC,EACpC,oCAAoC,EACpC,4BAA4B,GAG7B,MAAM,0BAA0B,CAAA;AACjC,OAAO,sCAAsC,MAAM,mDAAmD,CAAA;AACtG,OAAO,EAAE,+BAA+B,EAAE,MAAM,4BAA4B,CAAA;AAE5E,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,qBAAqB,MAAM,kCAAkC,CAAA;AACpE,OAAO,UAIN,MAAM,mBAAmB,CAAA;AAW1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EACL,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,4BAA4B,MAAM,gDAAgD,CAAA;AAEzF,IAAI,yBAAyB,GAAG,KAAK,CAAA;AAErC;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,mBAAmB,CAAC,EACjC,6BAA6B,EAC7B,yBAAyB,GAI1B;IACC,IAAI,yBAAyB,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IACD,yBAAyB,GAAG,IAAI,CAAA;IAEhC,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAA;IACtD,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,EAAE,CAAA;IAElE,OAAO,CAAC,GAAG,CACT,SAAS,uBAAuB,CAAC,MAAM,sCAAsC,CAC9E,CAAA;IACD,KAAK,MAAM,sBAAsB,IAAI,uBAAuB,EAAE,CAAC;QAC7D,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CACT,kEAAkE,EAClE,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IAAI,sBAAsB,CAAC,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CACT,sEAAsE,EACtE,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IACE,sBAAsB,CAAC,UAAU,CAAC,eAAe;YACjD,CAAC,UAAU,EAAE;YACb,CAAC,aAAa,EAAE,EAChB,CAAC;YACD,OAAO,CAAC,GAAG,CACT,6HAA6H,EAC7H,sBAAsB,CACvB,CAAA;YACD,SAAQ;QACV,CAAC;QAED,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CACT,sDAAsD,EACtD,sBAAsB,CACvB,CAAA;YAED,sBAAsB,CAAC,YAAY,GAAG,IAAI,CAAA;YAC1C,sBAAsB,CAAC,KAAK,GAAG,SAAS,CAAA;YACxC,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,sBAAsB,EACtB,gBAAgB,CACjB,CAAA;YAED,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CACpD,sBAAsB,CACvB,CAAA;YACD,sBAAsB,CAAC,UAAU,GAAG;gBAClC,GAAG,kBAAkB;aACtB,CAAA;YACD,MAAM,WAAW,GAAG,8BAA8B,CAChD,sBAAsB,CAAC,UAAU,CAAC,QAAQ,EAC1C,sBAAsB,CAAC,UAAU,CAClC,CAAA;YACD,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAC1C,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAClD,CAAA;YACD,IAAI,iBAAiB,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,oBAAoB,iBAAiB,CAAC,MAAM,cAC1C,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EACvC,GAAG,CACJ,CAAA;YACH,CAAC;YACD,MAAM,6BAA6B,CAAC;gBAClC,qBAAqB,EAAE,IAAI;gBAC3B,cAAc,EAAE,sBAAsB;gBACtC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBACpB,oCAAoC,CAAC;wBACnC,GAAG,KAAK;wBACR,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;qBAC1D,CAAC,CAAA;gBACJ,CAAC;gBACD,6BAA6B;gBAC7B,yBAAyB;gBACzB,cAAc,EAAE,SAAS;gBACzB,iBAAiB,EAAE,SAAS;gBAC5B,mBAAmB,EAAE,sBAAsB,CAAC,gBAAgB;aAC7D,CAAC,CAAA;YAEF,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,kBAAkB,CACnB,CAAA;YAED,OAAO,CAAC,GAAG,CACT,0DAA0D,EAC1D,sBAAsB,CACvB,CAAA;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,KAAK,CAAC,oDAAoD,EAAE,KAAK,CAAC,CAAA;YAC1E,sBAAsB,CAAC,YAAY,GAAG,KAAK,CAAA;YAC3C,IAAK,KAAe,CAAC,OAAO,EAAE,CAAC;gBAC7B,sBAAsB,CAAC,KAAK,GAAI,KAAe,CAAC,OAAO,CAAA;YACzD,CAAC;iBAAM,CAAC;gBACN,sBAAsB,CAAC,KAAK;oBAC1B,wJAAwJ,CAAA;YAC5J,CAAC;YACD,MAAM,4BAA4B,CAChC,sBAAsB,CAAC,gBAAgB,EACvC,sBAAsB,EACtB,eAAe,CAChB,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CACT,qEAAqE,CACtE,CAAA;IACD,yBAAyB,GAAG,KAAK,CAAA;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,KAAK,UAAU,MAAM,CACnB,MAEC;IAED,OAAO,MAAM,6BAA6B,CAAC;QACzC,GAAG,MAAM;QACT,mBAAmB,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KAC9C,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,6BAA6B,CAAC,EAC3C,WAAW,EACX,GAAG,MAAM,EAIV;IACC,MAAM,oBAAoB,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;IACrD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC;YACH,MAAM,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,WAAW,CAAC,CAAA;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAA;YACtD,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IACD,OAAO,oBAAoB,CAAA;AAC7B,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,mBAAmB;IACnB,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClD,mBAAmB;QACnB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;QAC7B,OAAM;IACR,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,CAAA;IAEd,+CAA+C;IAC/C,2CAA2C;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;YACxE,MAAM,CACJ,IAAI,KAAK,CACP,kFAAkF,CACnF,CACF,CAAA;QACH,CAAC,EAAE,GAAG,CAAC,CAAA;IACT,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,mBAAmB;IAChC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,WAAW,EAAE,CAAA;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,KAAK,UAAU,mBAAmB,CAChC,2BAIC,EACD,EACE,uBAAuB,EACvB,uBAAuB,GAIxB;IAED,MAAM,oBAAoB,GAAyB;QACjD,GAAG,2BAA2B;QAC9B,UAAU,EAAE,GAAG;QACf,qBAAqB,EAAE,SAAS;QAChC,KAAK,EAAE,SAAS;QAChB,UAAU,EAAE,SAAS;QACrB,iBAAiB,EAAE,IAAI;QACvB,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,EAAE;QACd,gBAAgB,EAAE,KAAK;QACvB,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,IAAI;QAClB,mBAAmB,EAAE,IAAI;QACzB,sBAAsB,EAAE,KAAK;KAC9B,CAAA;IAED,IAAI,YAAY,GAAG,oBAAoB,CAAC,UAAU,CAAC,YAAY,CAAA;IAC/D,IAAI,iBAAiB,GAAG,oBAAoB,CAAC,UAAU,CAAC,iBAAiB,CAAA;IAEzE,IAAI,oBAAoB,CAAC,cAAc,EAAE,CAAC;QACxC,YAAY,GAAG,KAAK,CAAA;QACpB,iBAAiB,GAAG,oBAAoB,CAAC,cAAc,CAAC,WAAW,CAAA;IACrE,CAAC;IAED,MAAM,aAAa,CAAC,oBAAoB,EAAE;QACxC,MAAM,EAAE,YAAY;QACpB,WAAW,EAAE,iBAAiB;QAC9B,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,KAAK,UAAU,2BAA2B,CACxC,gBAAsC,EACtC,EACE,uBAAuB,EACvB,uBAAuB,GAIxB;IAED,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;IACvD,IAAI,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,oBAAoB,CAAA;IAC3E,IAAI,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAA;IAEzD,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;QAChC,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAA;IACtD,CAAC;SAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;QACpC,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,+BAA+B,CAAC,gBAAgB,CAAC,CAAA;IACjE,CAAC;SAAM,IAAI,gBAAgB,CAAC,cAAc,EAAE,CAAC;QAC3C,oBAAoB,GAAG,KAAK,CAAA;QAC5B,WAAW,GAAG,gBAAgB,CAAC,cAAc,CAAC,WAAW,CAAA;IAC3D,CAAC;IAED,MAAM,aAAa,CAAC,gBAAgB,EAAE;QACpC,MAAM,EAAE,oBAAoB;QAC5B,WAAW;QACX,uBAAuB;QACvB,uBAAuB;KACxB,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,gBAAsC,EACtC,EACE,MAAM,EACN,WAAW,EACX,uBAAuB,EACvB,uBAAuB,GAMxB;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO;YACV,OAAO,WAAW,EAAE,CAAA;QACtB,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;gBACrC,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YACjD,CAAC;iBAAM,CAAC;gBACN,uBAAuB,CAAC,GAAG,CAAC,CAAA;YAC9B,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,MAAM,GAAG,sCAAsC,CACnD,WAAW,IAAI,GAAG,EAClB,gBAAgB,CACjB,CAAC,IAAI,CAAA;YACN,+CAA+C;YAC/C,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBACtB,uBAAuB,CAAC,MAAM,CAAC,CAAA;gBAC/B,OAAM;YACR,CAAC;YAED,uBAAuB,CAAC,MAAM,CAAC,CAAA;YAE/B,8CAA8C;YAC9C,yCAAyC;YACzC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,qDAAqD;gBACrD,gDAAgD;gBAChD,UAAU,CAAC,GAAG,EAAE;oBACd,uBAAuB,CAAC,GAAG,CAAC,CAAA;gBAC9B,CAAC,EAAE,IAAI,CAAC,CAAA;YACV,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,OAAO,CAAC,CAAC,CAAC;YACR,2EAA2E;YAC3E,OAAO,mBAAmB,EAAE,CAAA;QAC9B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,KAAK,UAAU,iBAAiB,CAAC,EAC/B,MAAM,EACN,YAAY,EACZ,WAAW,EACX,SAAS,EACT,WAAW,GAQZ;IAIC,OAAO,MAAM,sBAAsB,CAAC;QAClC,MAAM;QACN,YAAY;QACZ,WAAW;QACX,SAAS;QACT,WAAW;KACZ,CAAC,CAAA;AACJ,CAAC;AAED,OAAO,EACL,MAAM,EACN,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,mBAAmB,EAUnB,8CAA8C,EAC9C,oCAAoC,EAKpC,iBAAiB,EACjB,wBAAwB,EACxB,4BAA4B,GAC7B,CAAA","sourcesContent":["import { isOffline } from './offline-service'\nimport { getFormsKeyId, isLoggedIn } from './auth-service'\nimport {\n registerPendingQueueListener,\n getPendingQueueSubmissions,\n updatePendingQueueSubmission,\n cancelEditingPendingQueueSubmission,\n deletePendingQueueSubmission,\n editPendingQueueSubmission,\n registerPendingQueueAttachmentProgressListener,\n registerPendingQueueProgressListener,\n executePendingQueueProgressListeners,\n removePendingQueueSubmission,\n PendingQueueListener,\n PendingQueueAction,\n} from './services/pending-queue'\nimport replaceInjectablesWithSubmissionValues from './services/replaceInjectablesWithSubmissionValues'\nimport { getFormSubmissionPaymentHandoff } from './services/payment-handoff'\nimport { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport Sentry from './Sentry'\nimport prepareSubmissionData from './services/prepareSubmissionData'\nimport submitForm, {\n SubmissionParams,\n ProgressListener,\n ProgressListenerEvent,\n} from './services/submit'\nimport {\n PendingFormSubmission,\n FormSubmission,\n FormSubmissionResult,\n BaseFormSubmission,\n NewDraftSubmission,\n NewFormSubmission,\n DraftSubmission,\n DraftSubmissionInput,\n} from './types/submissions'\nimport { deleteAutoSaveData } from './auto-save-service'\nimport {\n downloadFormSubmission,\n uploadFormSubmissionEdit,\n} from './services/api/submissions'\nimport { getSubmissionAttachmentDetails } from './attachments-service'\nimport getPostSubmissionAttachments from './services/api/post-submission-attachment-urls'\n\nlet _isProcessingPendingQueue = false\n\n/**\n * Force processing the pending queue. This must be called to process the\n * pending queue and is best used when the application comes back online.\n *\n * ### Example\n *\n * ```js\n * await submissionService.processPendingQueue()\n * ```\n *\n * @returns\n */\nasync function processPendingQueue({\n shouldRunExternalIdGeneration,\n shouldRunServerValidation,\n}: {\n shouldRunExternalIdGeneration: boolean\n shouldRunServerValidation: boolean\n}): Promise<void> {\n if (_isProcessingPendingQueue) {\n return\n }\n _isProcessingPendingQueue = true\n\n console.log('Checking pending queue for submissions.')\n const pendingQueueSubmissions = await getPendingQueueSubmissions()\n\n console.log(\n `Found ${pendingQueueSubmissions.length} submission(s) in the pending queue.`,\n )\n for (const pendingQueueSubmission of pendingQueueSubmissions) {\n if (isOffline()) {\n console.log(\n 'Application is offline, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n if (pendingQueueSubmission.isEditing) {\n console.log(\n 'submission is being edited, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n if (\n pendingQueueSubmission.definition.isAuthenticated &&\n !isLoggedIn() &&\n !getFormsKeyId()\n ) {\n console.log(\n 'Authentication is required for this form but the user does not have a valid token, leaving submission in the pending queue:',\n pendingQueueSubmission,\n )\n continue\n }\n\n try {\n console.log(\n 'Attempting to process submission from pending queue:',\n pendingQueueSubmission,\n )\n\n pendingQueueSubmission.isSubmitting = true\n pendingQueueSubmission.error = undefined\n await updatePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n pendingQueueSubmission,\n 'SUBMIT_STARTED',\n )\n\n const preparedSubmission = await prepareSubmissionData(\n pendingQueueSubmission,\n )\n pendingQueueSubmission.submission = {\n ...preparedSubmission,\n }\n const attachments = getSubmissionAttachmentDetails(\n pendingQueueSubmission.definition.elements,\n pendingQueueSubmission.submission,\n )\n const failedAttachments = attachments.filter(\n (attachment) => attachment.value.type === 'ERROR',\n )\n if (failedAttachments.length) {\n throw new Error(\n `Failed to upload ${failedAttachments.length} attachment${\n failedAttachments.length > 1 ? 's' : ''\n }.`,\n )\n }\n await submitWithCompletionTimestamp({\n isPendingQueueEnabled: true,\n formSubmission: pendingQueueSubmission,\n onProgress: (event) => {\n executePendingQueueProgressListeners({\n ...event,\n pendingTimestamp: pendingQueueSubmission.pendingTimestamp,\n })\n },\n shouldRunExternalIdGeneration,\n shouldRunServerValidation,\n paymentFormUrl: undefined,\n paymentReceiptUrl: undefined,\n completionTimestamp: pendingQueueSubmission.pendingTimestamp,\n })\n\n await removePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n 'SUBMIT_SUCCEEDED',\n )\n\n console.log(\n 'Successfully processed submission from the pending queue',\n pendingQueueSubmission,\n )\n } catch (error) {\n Sentry.captureException(error)\n console.error('Error processing submission from the pending queue', error)\n pendingQueueSubmission.isSubmitting = false\n if ((error as Error).message) {\n pendingQueueSubmission.error = (error as Error).message\n } else {\n pendingQueueSubmission.error =\n 'An unknown error has occurred, which has prevented your Form from submitting. Please try again, or contact your Administrator if the problem persists.'\n }\n await updatePendingQueueSubmission(\n pendingQueueSubmission.pendingTimestamp,\n pendingQueueSubmission,\n 'SUBMIT_FAILED',\n )\n }\n }\n\n console.log(\n 'Finished attempting to processing submissions in the pending queue.',\n )\n _isProcessingPendingQueue = false\n}\n\n/**\n * Submit a FormSubmission. Offline submissions will be added to a pending queue\n * and be processed using the `processPendingQueue()` function. FormSubmissions\n * with payment submission events will return the FormSubmissionResult with a\n * `payment` property set, this should be used to redirect the user to the\n * payment URL. Will also handle cleaning up auto save data (if the\n * `autoSaveKey` property is passed), locally stored drafts and prefill data.\n *\n * ### Example\n *\n * ```js\n * const formSubmission = {\n * formsAppId: 1,\n * submission: {\n * form: 'data',\n * goes: 'here',\n * },\n * definition: OneBlinkForm,\n * captchaTokens: [],\n * formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',\n * jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',\n * preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',\n * externalId: 'external-id-set-by-developer',\n * }\n *\n * // Pass paymentReceiptUrl if submission may require a payment\n * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`\n *\n * // Pass schedulingBookingUrlConfiguration if submission utilise scheduling\n * const schedulingBookingUrlConfiguration = {\n * schedulingBookingUrl: 'https://my-website.com/booking',\n * schedulingRescheduleUrl: 'https://my-website.com/reschedule',\n * schedulingCancelUrl: 'https://my-website.com/cancel',\n * }\n * const submissionResult = await submissionService.submit({\n * formSubmission,\n * paymentReceiptUrl,\n * schedulingBookingUrlConfiguration,\n * })\n *\n * if (submissionResult.scheduling) {\n * // Redirect user to booking form\n * window.location.href = submissionResult.scheduling.bookingUrl\n * return\n * }\n *\n * if (submissionResult.payment) {\n * // Redirect user to payment form\n * window.location.href = submissionResult.payment.hostedFormUrl\n * return\n * }\n *\n * if (submissionResult.isOffline) {\n * if (submissionResult.isInPendingQueue) {\n * // Display message to user that the submission\n * // has been added to the pending queue\n * } else {\n * // Display message to user that this submission can\n * // not be processed while offline (most likely because it requires a payment)\n * }\n * return\n * }\n *\n * // submissionResult.submissionId and submissionResult.submissionTimestamp\n * // will be set if the submission was successful\n * ```\n *\n * @param params\n * @returns\n */\nasync function submit(\n params: SubmissionParams & {\n autoSaveKey?: string\n },\n): Promise<FormSubmissionResult> {\n return await submitWithCompletionTimestamp({\n ...params,\n completionTimestamp: new Date().toISOString(),\n })\n}\n\nasync function submitWithCompletionTimestamp({\n autoSaveKey,\n ...params\n}: SubmissionParams & {\n autoSaveKey?: string\n completionTimestamp: string\n}): Promise<FormSubmissionResult> {\n const formSubmissionResult = await submitForm(params)\n if (typeof autoSaveKey === 'string') {\n try {\n await deleteAutoSaveData(params.formSubmission.definition.id, autoSaveKey)\n } catch (error) {\n console.warn('Error removing auto save data: ', error)\n Sentry.captureException(error)\n }\n }\n return formSubmissionResult\n}\n\nasync function closeWindow(): Promise<void> {\n // @ts-expect-error\n if (window.cordova && window.cordova.plugins.exit) {\n // @ts-expect-error\n window.cordova.plugins.exit()\n return\n }\n\n window.close()\n\n // If the browser has not closed after timeout,\n // we throw an error to display to the user\n return new Promise((resolve, reject) => {\n setTimeout(() => {\n console.log('Could not close as window was not opened using JavaScript')\n reject(\n new Error(\n 'We were unable to close your browser, could you please close it manually for us?',\n ),\n )\n }, 500)\n })\n}\n\n/**\n * Go back in the browser history or attempts to close the browser tab if there\n * is no history.\n *\n * ### Example\n *\n * ```js\n * try {\n * await submissionService.goBackOrCloseWindow()\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @returns\n */\nasync function goBackOrCloseWindow(): Promise<void> {\n if (window.history.length <= 1) {\n return closeWindow()\n } else {\n window.history.back()\n }\n}\n\n/**\n * Action to cancel completing a form, currently goes back in the browser\n * history or attempts to close the browser tab if there is no history.\n *\n * ### Example\n *\n * ```js\n * const options = {\n * definition: OneBlinkForm,\n * externalId: 'external-id-set-by-developer',\n * }\n * // Only used for relative URLs\n * const pushRelativePath = (path) => {\n * window.location.href = path\n * }\n * // Only used for aboslute URLS\n * const replaceAbsolutePath = window.location.replace\n *\n * try {\n * await submissionService.executeCancelAction(options, {\n * onRedirectToRelativeUrl: pushRelativePath,\n * onRedirectToAbsoluteUrl: replaceAbsolutePath,\n * })\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @param options\n * @param redirectConfig\n */\nasync function executeCancelAction(\n formSubmissionResultOptions: {\n definition: FormTypes.Form\n externalId: string | null\n taskCompletion?: FormSubmissionResult['taskCompletion']\n },\n {\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n const formSubmissionResult: FormSubmissionResult = {\n ...formSubmissionResultOptions,\n formsAppId: NaN,\n formSubmissionDraftId: undefined,\n jobId: undefined,\n externalId: undefined,\n preFillFormDataId: null,\n recaptchas: [],\n submission: {},\n isInPendingQueue: false,\n isOffline: false,\n payment: null,\n scheduling: null,\n submissionId: null,\n submissionTimestamp: null,\n isUploadingAttachments: false,\n }\n\n let cancelAction = formSubmissionResult.definition.cancelAction\n let cancelRedirectUrl = formSubmissionResult.definition.cancelRedirectUrl\n\n if (formSubmissionResult.taskCompletion) {\n cancelAction = 'URL'\n cancelRedirectUrl = formSubmissionResult.taskCompletion.redirectUrl\n }\n\n await executeAction(formSubmissionResult, {\n action: cancelAction,\n redirectUrl: cancelRedirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n })\n}\n\n/**\n * Execute the post submission action for a form after a successful form\n * submission.\n *\n * ### Example\n *\n * ```js\n * const formSubmissionResult = {\n * submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',\n * submissionTimestamp: '2020-07-29T01:03:26.573Z'\n * formsAppId: 1,\n * submission: {\n * form: 'data',\n * goes: 'here'\n * },\n * definition: OneBlinkForm,\n * payment: {\n * hostedFormUrl: 'https://payment.com/transaction'\n * },\n * formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',\n * jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',\n * preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',\n * externalId: 'external-id-set-by-developer',\n * }\n * // Only used for relative URLs\n * const pushRelativePath = (path) => {\n * window.location.href = path\n * }\n * // Only used for aboslute URLS\n * const replaceAbsolutePath = window.location.replace\n *\n * try {\n * await submissionService.executePostSubmissionAction(formSubmissionResult, {\n * onRedirectToRelativeUrl: pushRelativePath,\n * onRedirectToAbsoluteUrl: replaceAbsolutePath,\n * })\n * } catch (error) {\n * // Handle error while closing browser tab.\n * // Display message to user to close it manually\n * }\n * ```\n *\n * @param submissionResult\n * @param redirectConfig\n */\nasync function executePostSubmissionAction(\n submissionResult: FormSubmissionResult,\n {\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n console.log('Attempting to run post submission action')\n let postSubmissionAction = submissionResult.definition.postSubmissionAction\n let redirectUrl = submissionResult.definition.redirectUrl\n\n if (submissionResult.scheduling) {\n postSubmissionAction = 'URL'\n redirectUrl = submissionResult.scheduling.bookingUrl\n } else if (submissionResult.payment) {\n postSubmissionAction = 'URL'\n redirectUrl = getFormSubmissionPaymentHandoff(submissionResult)\n } else if (submissionResult.taskCompletion) {\n postSubmissionAction = 'URL'\n redirectUrl = submissionResult.taskCompletion.redirectUrl\n }\n\n await executeAction(submissionResult, {\n action: postSubmissionAction,\n redirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n })\n}\n\nasync function executeAction(\n submissionResult: FormSubmissionResult,\n {\n action,\n redirectUrl,\n onRedirectToRelativeUrl,\n onRedirectToAbsoluteUrl,\n }: {\n action: FormTypes.FormPostSubmissionAction\n redirectUrl: string | undefined\n onRedirectToRelativeUrl: (url: string) => void\n onRedirectToAbsoluteUrl: (url: string) => void\n },\n): Promise<void> {\n switch (action) {\n case 'CLOSE':\n return closeWindow()\n case 'FORMS_LIBRARY': {\n if (window.location.pathname === '/') {\n onRedirectToAbsoluteUrl(window.location.origin)\n } else {\n onRedirectToRelativeUrl('/')\n }\n break\n }\n case 'URL': {\n const newUrl = replaceInjectablesWithSubmissionValues(\n redirectUrl || '/',\n submissionResult,\n ).text\n // Relative URLs can be navigated to internally\n if (newUrl[0] === '/') {\n onRedirectToRelativeUrl(newUrl)\n return\n }\n\n onRedirectToAbsoluteUrl(newUrl)\n\n // If we are in cordova land, we will navigate\n // back to the home screen after redirect\n if (window.cordova) {\n // Wait a couple of seconds to ensure the browser has\n // been opened before navigating away from form.\n setTimeout(() => {\n onRedirectToRelativeUrl('/')\n }, 2000)\n }\n break\n }\n case 'BACK':\n default: {\n // if there's no post submission action for some reason, use prev. logic...\n return goBackOrCloseWindow()\n }\n }\n}\n\n/**\n * Retrieve submission data for a known formId and submissionId\n *\n * #### Example\n *\n * ```js\n * const formId = 1\n * const submissionId = 'fba95b9d-5a9c-463d-ab68-867f431e4120'\n * const credentials = await formSubmissionService.getSubmissionData({\n * formId,\n * submissionId,\n * })\n * ```\n *\n * @param options\n * @param options.formId\n * @param options.submissionId\n * @param options.abortSignal\n * @param options.versionId\n * @param options.asSubmitted\n * @returns\n */\nasync function getSubmissionData({\n formId,\n submissionId,\n abortSignal,\n versionId,\n asSubmitted,\n}: {\n formId: number\n submissionId: string\n abortSignal?: AbortSignal\n versionId?: string\n /** Download the submission data as it was originally submitted. */\n asSubmitted?: boolean\n}): Promise<{\n data: SubmissionTypes.S3SubmissionData\n versionId: string | undefined\n}> {\n return await downloadFormSubmission({\n formId,\n submissionId,\n abortSignal,\n versionId,\n asSubmitted,\n })\n}\n\nexport {\n submit,\n executePostSubmissionAction,\n executeCancelAction,\n goBackOrCloseWindow,\n getPendingQueueSubmissions,\n deletePendingQueueSubmission,\n editPendingQueueSubmission,\n cancelEditingPendingQueueSubmission,\n registerPendingQueueListener,\n processPendingQueue,\n BaseFormSubmission,\n NewDraftSubmission,\n NewFormSubmission,\n DraftSubmissionInput,\n DraftSubmission,\n FormSubmission,\n FormSubmissionResult,\n PendingFormSubmission,\n SubmissionParams,\n registerPendingQueueAttachmentProgressListener,\n registerPendingQueueProgressListener,\n ProgressListener,\n ProgressListenerEvent,\n PendingQueueListener,\n PendingQueueAction,\n getSubmissionData,\n uploadFormSubmissionEdit,\n getPostSubmissionAttachments,\n}\n"]}