feat(JavaScript): allow passing submit complete options (#190)

FlatFilers · Sep 13, 2024 · d6e80ce · d6e80ce
1 parent 5477b40
commit d6e80ce
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 29 deletions.
diff --git a/.changeset/young-peaches-occur.md b/.changeset/young-peaches-occur.md
@@ -0,0 +1,6 @@
+---
+'@flatfile/embedded-utils': patch
+'@flatfile/javascript': patch
+---
+
+JavaScript: allow specifying submit complete options
diff --git a/apps/vanilla/cdn.html b/apps/vanilla/cdn.html
@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
-
-<head>
+  <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Hello, world!</title>
@@ -11,35 +10,50 @@
     <link rel="stylesheet" type="text/css" href="./styles.css" />
 
     <script>
-        start = () => {
-            const { initializeFlatfile: startFlatfile, FlatfileClient } = FlatFileJavaScript
+      const publishableKey =
+        localStorage.getItem('override-publishable-key') ?? 'pk_123456'
+
+      start = () => {
+        const { initializeFlatfile: startFlatfile, FlatfileClient } =
+          FlatFileJavaScript
 
-            console.log({ FlatfileClient })
-            const flatfileApi = new FlatfileClient({ environment: 'https://platform.eu.flatfile.com/api/v1' })
+        console.log({ FlatfileClient })
+        const flatfileApi = new FlatfileClient({
+          //   environment: 'https://platform.eu.flatfile.com/api/v1',
+        })
 
-            startFlatfile({
-                publishableKey: localStorage.getItem('override-publishable-key') ?? 'pk_123456',
-                apiUrl: 'https://platform.eu.flatfile.com/api',
-                spaceBody: {
-                    namespace: "portal",
-                },
-                sheet: blueprint,
-                onSubmit: async ({ event }) => {
-                    console.log('onSubmit', { event })
-                    const {
-                        data,
-                    } = await flatfileApi.files.list({
-                        spaceId: event.context.spaceId,
-                    });
-                    console.log('file', { data });
-                },
-            });
-        };
+        startFlatfile({
+          publishableKey,
+          //   apiUrl: 'https://platform.eu.flatfile.com/api',
+          spaceBody: {
+            namespace: 'portal',
+          },
+          sheet: blueprint,
+          submitSettings: {
+            complete: {
+              acknowledge: true, // required for auto close
+              message: 'Submitting data is now complete!',
+            },
+          },
+          onSubmit: async ({ event }) => {
+            console.log('onSubmit', { event })
+            const { data } = await flatfileApi.files.list({
+              spaceId: event.context.spaceId,
+            })
+            console.log('file', { data })
+          },
+          closeSpace: {
+            operation: 'simpleSubmitAction',
+            onClose: () => {
+              console.log('Portal is now closed!')
+            },
+          },
+        })
+      }
     </script>
-</head>
+  </head>
 
-<body>
+  <body>
     <button onClick="start()">Open Flatfile</button>
-</body>
-
+  </body>
 </html>
diff --git a/packages/embedded-utils/src/types/Space.ts b/packages/embedded-utils/src/types/Space.ts
@@ -101,6 +101,10 @@ export interface ReusedSpaceWithAccessToken extends BaseSpace {
 }
 
 type SubmitSettings = {
+  complete?: {
+    acknowledge?: boolean
+    message?: string
+  }
   deleteSpaceAfterSubmit?: boolean
 }
 export const DefaultSubmitSettings = {

diff --git a/packages/javascript/src/listener.ts b/packages/javascript/src/listener.ts
@@ -87,7 +87,8 @@ export const createSimpleListener = ({
 
             await api.jobs.complete(jobId, {
               outcome: {
-                message: 'complete',
+                acknowledge: submitSettings?.complete?.acknowledge ?? true,
+                message: submitSettings?.complete?.message ?? 'complete',
               },
             })
             if (onSubmitSettings.deleteSpaceAfterSubmit) {

diff --git a/packages/javascript/src/startFlatfile.ts b/packages/javascript/src/startFlatfile.ts
@@ -170,6 +170,7 @@ export async function startFlatfile(options: SimpleOnboarding | ISpace) {
           onRecordHook: simpleOnboardingOptions?.onRecordHook,
           onSubmit: simpleOnboardingOptions?.onSubmit,
           slug: simpleListenerSlug,
+          submitSettings: simpleOnboardingOptions?.submitSettings,
         }),
         closeSpace,
         closeSpaceNow,