ap-6007 # Added support for multiple post submission pdf downloads

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Support for downloading multiple post submission PDFs
 - `formService.searchPointV3Addresses`
 - `formService.getPointV3Address`
 

src/services/submit.ts

@@ -173,6 +173,19 @@ export default async function submit({
       abortSignal,
     )
 
+    const downloadSubmissionPdfUrl = () => {
+      if (!data.pdfAccessToken) {
+        return undefined
+      }
+      if (
+        formSubmission.definition.postSubmissionReceipt?.allowPDFDownload &&
+        !Array.isArray(
+          formSubmission.definition.postSubmissionReceipt?.allowPDFDownload,
+        )
+      ) {
+        return `${tenants.current.apiOrigin}/forms/${formSubmission.definition.id}/submissions/${data.submissionId}/pdf-document?accessToken=${data.pdfAccessToken}`
+      }
+    }
     const formSubmissionResult: FormSubmissionResult = {
       ...formSubmission,
       payment: null,
@@ -182,9 +195,11 @@ export default async function submit({
       submissionTimestamp: data.submissionTimestamp,
       submissionId: data.submissionId,
       isUploadingAttachments: false,
-      downloadSubmissionPdfUrl: !data.pdfAccessToken
+      downloadSubmissionPdfUrl: downloadSubmissionPdfUrl(),
+      getDownloadSubmissionPdfUrl: !data.pdfAccessToken
         ? undefined
-        : `${tenants.current.apiOrigin}/forms/${formSubmission.definition.id}/submissions/${data.submissionId}/pdf-document?accessToken=${data.pdfAccessToken}`,
+        : (configurationId: string) =>
+            `${tenants.current.apiOrigin}/forms/${formSubmission.definition.id}/submissions/${data.submissionId}/pdf-document?accessToken=${data.pdfAccessToken}&configurationId=${configurationId}`,
       attachmentsAccessToken: data.attachmentsAccessToken,
     }
 

src/types/submissions.ts

@@ -161,7 +161,18 @@ export type FormSubmissionResult = FormSubmission & {
   /** True if the submission was attempted whilst attachments were uploading */
   isUploadingAttachments: boolean
   /** Exists if the form allows PDF download */
+  /**
+   * @deprecated Only returned when legacy post submission download
+   *   configuration is in use. For non legacy configured forms, use
+   *   `getDownloadSubmissionPdfUrl` instead.
+   */
   downloadSubmissionPdfUrl?: string
+  /**
+   * The URL to download the form submission PDF.
+   *
+   * @param configurationId - The configuration ID to use for the PDF download.
+   */
+  getDownloadSubmissionPdfUrl?: (configurationId: string) => string
   /** The access token to download post-submission attachment urls and metadata. */
   attachmentsAccessToken?: string
 }