From 08cd5bbb91b8504b38879280d262e9573f066f47 Mon Sep 17 00:00:00 2001
From: Andrew Kingston <andrew@kingston.dev>
Date: Wed, 13 Dec 2023 13:09:57 +0000
Subject: [PATCH] Refactor form block layout and add functional update and view
 multi step forms

---
 .../src/DetailSummary/DetailSummary.svelte    |  2 +-
 .../Component/ComponentSettingsSection.svelte | 22 +++----
 .../app/blocks/MultiStepFormblock.svelte      | 29 +++++----
 .../app/blocks/form/FormBlock.svelte          | 60 ++---------------
 .../app/blocks/form/FormBlockWrapper.svelte   | 64 +++++++++++++++++++
 packages/frontend-core/src/utils/utils.js     | 33 ++++++++--
 6 files changed, 123 insertions(+), 87 deletions(-)
 create mode 100644 packages/client/src/components/app/blocks/form/FormBlockWrapper.svelte

diff --git a/packages/bbui/src/DetailSummary/DetailSummary.svelte b/packages/bbui/src/DetailSummary/DetailSummary.svelte
index 598d82ed61..2cbb6796f3 100644
--- a/packages/bbui/src/DetailSummary/DetailSummary.svelte
+++ b/packages/bbui/src/DetailSummary/DetailSummary.svelte
@@ -78,7 +78,7 @@
       var(--spacing-xl);
   }
   .property-panel.no-title {
-    padding-top: 0;
+    padding-top: var(--spacing-xl);
   }
 
   .show {
diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsSection.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsSection.svelte
index d96729d3d2..27f0f7bf7a 100644
--- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsSection.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsSection.svelte
@@ -32,21 +32,19 @@
     const generalSettings = settings.filter(
       setting => !setting.section && setting.tag === tag
     )
-
     const customSections = settings.filter(
       setting => setting.section && setting.tag === tag
     )
-    let sections = [
-      ...(generalSettings?.length
-        ? [
-            {
-              name: "General",
-              settings: generalSettings,
-            },
-          ]
-        : []),
-      ...(customSections || []),
-    ]
+    let sections = []
+    if (generalSettings.length) {
+      sections.push({
+        name: "General",
+        settings: generalSettings,
+      })
+    }
+    if (customSections.length) {
+      sections = sections.concat(customSections)
+    }
 
     // Filter out settings which shouldn't be rendered
     sections.forEach(section => {
diff --git a/packages/client/src/components/app/blocks/MultiStepFormblock.svelte b/packages/client/src/components/app/blocks/MultiStepFormblock.svelte
index db7d31eef1..4a9621f68e 100644
--- a/packages/client/src/components/app/blocks/MultiStepFormblock.svelte
+++ b/packages/client/src/components/app/blocks/MultiStepFormblock.svelte
@@ -1,10 +1,13 @@
 <script>
   import BlockComponent from "components/BlockComponent.svelte"
-  import Block from "components/Block.svelte"
   import { getContext } from "svelte"
   import { builderStore } from "stores"
   import { Utils } from "@budibase/frontend-core"
+  import FormBlockWrapper from "./form/FormBlockWrapper.svelte"
 
+  export let actionType
+  export let rowId
+  export let noRowsMessage
   export let steps
   export let dataSource
   export let initialFormStep = 1
@@ -102,6 +105,8 @@
         _id: id,
         stepCount: safeSteps.length,
         currentStep: idx,
+        actionType,
+        dataSource,
       })
       return {
         fields: getDefaultFields(fields || [], schema),
@@ -113,27 +118,29 @@
   }
 </script>
 
-<Block>
+<FormBlockWrapper {actionType} {dataSource} {rowId} {noRowsMessage}>
   <BlockComponent
     type="form"
+    context="form"
     props={{
       dataSource,
       initialFormStep,
       step: currentStep,
+      actionType: actionType === "Create" ? "Create" : "Update",
+      readonly: actionType === "View",
+    }}
+    styles={{
+      normal: {
+        width: "600px",
+        "margin-left": "auto",
+        "margin-right": "auto",
+      },
     }}
-    context="form"
   >
     {#each enrichedSteps as step, idx}
       <BlockComponent
         type="formstep"
         props={{ step: idx + 1, _instanceName: `Step ${idx + 1}` }}
-        styles={{
-          normal: {
-            width: "600px",
-            "margin-left": "auto",
-            "margin-right": "auto",
-          },
-        }}
       >
         <BlockComponent
           type="container"
@@ -176,4 +183,4 @@
       </BlockComponent>
     {/each}
   </BlockComponent>
-</Block>
+</FormBlockWrapper>
diff --git a/packages/client/src/components/app/blocks/form/FormBlock.svelte b/packages/client/src/components/app/blocks/form/FormBlock.svelte
index c0f1a53bae..cdf1a05628 100644
--- a/packages/client/src/components/app/blocks/form/FormBlock.svelte
+++ b/packages/client/src/components/app/blocks/form/FormBlock.svelte
@@ -1,10 +1,8 @@
 <script>
   import { getContext } from "svelte"
-  import BlockComponent from "components/BlockComponent.svelte"
-  import Block from "components/Block.svelte"
-  import { makePropSafe as safe } from "@budibase/string-templates"
   import InnerFormBlock from "./InnerFormBlock.svelte"
   import { Utils } from "@budibase/frontend-core"
+  import FormBlockWrapper from "./FormBlockWrapper.svelte"
 
   export let actionType
   export let dataSource
@@ -71,22 +69,10 @@
   }
 
   let schema
-  let providerId
-  let repeaterId
 
   $: formattedFields = convertOldFieldFormat(fields)
   $: fieldsOrDefault = getDefaultFields(formattedFields, schema)
   $: fetchSchema(dataSource)
-  $: dataProvider = `{{ literal ${safe(providerId)} }}`
-  $: filter = [
-    {
-      field: "_id",
-      operator: "equal",
-      type: "string",
-      value: !rowId ? `{{ ${safe("url")}.${safe("id")} }}` : rowId,
-      valueType: "Binding",
-    },
-  ]
   // We could simply spread $$props into the inner form and append our
   // additions, but that would create svelte warnings about unused props and
   // make maintenance in future more confusing as we typically always have a
@@ -102,7 +88,6 @@
     title,
     description,
     schema,
-    repeaterId,
     notificationOverride,
     buttons:
       buttons ||
@@ -124,43 +109,6 @@
   }
 </script>
 
-<Block>
-  {#if actionType === "Create"}
-    <BlockComponent
-      type="container"
-      props={{
-        direction: "column",
-        hAlign: "left",
-        vAlign: "stretch",
-      }}
-    >
-      <InnerFormBlock {...innerProps} />
-    </BlockComponent>
-  {:else}
-    <BlockComponent
-      type="dataprovider"
-      context="provider"
-      bind:id={providerId}
-      props={{
-        dataSource,
-        filter,
-        limit: 1,
-        paginate: false,
-      }}
-    >
-      <BlockComponent
-        type="repeater"
-        context="repeater"
-        bind:id={repeaterId}
-        props={{
-          dataProvider,
-          noRowsMessage: noRowsMessage || "We couldn't find a row to display",
-          direction: "column",
-          hAlign: "center",
-        }}
-      >
-        <InnerFormBlock {...innerProps} />
-      </BlockComponent>
-    </BlockComponent>
-  {/if}
-</Block>
+<FormBlockWrapper {actionType} {dataSource} {rowId} {noRowsMessage}>
+  <InnerFormBlock {...innerProps} />
+</FormBlockWrapper>
diff --git a/packages/client/src/components/app/blocks/form/FormBlockWrapper.svelte b/packages/client/src/components/app/blocks/form/FormBlockWrapper.svelte
new file mode 100644
index 0000000000..26767f84b3
--- /dev/null
+++ b/packages/client/src/components/app/blocks/form/FormBlockWrapper.svelte
@@ -0,0 +1,64 @@
+<script>
+  import BlockComponent from "components/BlockComponent.svelte"
+  import Block from "components/Block.svelte"
+  import { makePropSafe as safe } from "@budibase/string-templates"
+  import { getContext } from "svelte"
+
+  export let actionType
+  export let dataSource
+  export let rowId
+  export let noRowsMessage
+
+  const component = getContext("component")
+
+  $: providerId = `${$component.id}-provider`
+  $: dataProvider = `{{ literal ${safe(providerId)} }}`
+  $: filter = [
+    {
+      field: "_id",
+      operator: "equal",
+      type: "string",
+      value: !rowId ? `{{ ${safe("url")}.${safe("id")} }}` : rowId,
+      valueType: "Binding",
+    },
+  ]
+</script>
+
+<Block>
+  {#if actionType === "Create"}
+    <BlockComponent
+      type="container"
+      props={{
+        direction: "column",
+        hAlign: "left",
+        vAlign: "stretch",
+      }}
+    >
+      <slot />
+    </BlockComponent>
+  {:else}
+    <BlockComponent
+      type="dataprovider"
+      context="provider"
+      props={{
+        dataSource,
+        filter,
+        limit: 1,
+        paginate: false,
+      }}
+    >
+      <BlockComponent
+        type="repeater"
+        context="repeater"
+        props={{
+          dataProvider,
+          noRowsMessage: noRowsMessage || "We couldn't find a row to display",
+          direction: "column",
+          hAlign: "center",
+        }}
+      >
+        <slot />
+      </BlockComponent>
+    </BlockComponent>
+  {/if}
+</Block>
diff --git a/packages/frontend-core/src/utils/utils.js b/packages/frontend-core/src/utils/utils.js
index 7c3dc2f3b5..65690cd535 100644
--- a/packages/frontend-core/src/utils/utils.js
+++ b/packages/frontend-core/src/utils/utils.js
@@ -242,15 +242,16 @@ export const buildFormBlockButtonConfig = props => {
 }
 
 export const buildMultiStepFormBlockDefaultProps = props => {
-  const { _id, stepCount, currentStep } = props || {}
+  const { _id, stepCount, currentStep, actionType, dataSource } = props || {}
 
   // Sanity check
   if (!_id || !stepCount) {
     return
   }
 
-  // Default the title to "Step X"
   const title = `Step {{ [${_id}-form].[__currentStep] }}`
+  const resourceId = dataSource?.resourceId
+  const formId = `${_id}-form`
   let buttons = []
 
   // Add previous step button if we aren't the first step
@@ -266,7 +267,7 @@ export const buildMultiStepFormBlockDefaultProps = props => {
         {
           parameters: {
             type: "prev",
-            componentId: `${_id}-form`,
+            componentId: formId,
           },
           "##eventHandlerType": "Change Form Step",
         },
@@ -287,13 +288,13 @@ export const buildMultiStepFormBlockDefaultProps = props => {
         {
           "##eventHandlerType": "Validate Form",
           parameters: {
-            componentId: `${_id}-form`,
+            componentId: formId,
           },
         },
         {
           parameters: {
             type: "next",
-            componentId: `${_id}-form`,
+            componentId: formId,
           },
           "##eventHandlerType": "Change Form Step",
         },
@@ -302,7 +303,7 @@ export const buildMultiStepFormBlockDefaultProps = props => {
   }
 
   // Add save button if we are the last step
-  if (currentStep === stepCount - 1) {
+  if (actionType !== "View" && currentStep === stepCount - 1) {
     buttons.push({
       _id: Helpers.uuid(),
       _component: "@budibase/standard-components/button",
@@ -314,9 +315,27 @@ export const buildMultiStepFormBlockDefaultProps = props => {
         {
           "##eventHandlerType": "Validate Form",
           parameters: {
-            componentId: `${_id}-form`,
+            componentId: formId,
           },
         },
+        {
+          "##eventHandlerType": "Save Row",
+          parameters: {
+            tableId: resourceId,
+            providerId: formId,
+          },
+        },
+        // Clear a create form once submitted
+        ...(actionType !== "Create"
+          ? []
+          : [
+              {
+                "##eventHandlerType": "Clear Form",
+                parameters: {
+                  componentId: formId,
+                },
+              },
+            ]),
       ],
     })
   }