From 02e5e66992f71bdfdbda1337a08ab4ee0aceecce Mon Sep 17 00:00:00 2001
From: Andrew Kingston <andrew@kingston.dev>
Date: Thu, 30 Jun 2022 19:31:25 +0100
Subject: [PATCH] Add ability to eject blocks into raw components

---
 .../src/builderStore/store/frontend.js        |  8 ++
 .../AppPreview/CurrentItemPreview.svelte      |  3 +
 .../ComponentDropdownMenu.svelte              |  6 ++
 packages/client/src/components/Block.svelte   | 61 +++++++++++-
 .../src/components/BlockComponent.svelte      |  4 +
 .../components/app/blocks/TableBlock.svelte   | 99 +++++++++----------
 packages/client/src/stores/builder.js         |  3 +
 7 files changed, 130 insertions(+), 54 deletions(-)

diff --git a/packages/builder/src/builderStore/store/frontend.js b/packages/builder/src/builderStore/store/frontend.js
index ec810e5c31..333e74bd60 100644
--- a/packages/builder/src/builderStore/store/frontend.js
+++ b/packages/builder/src/builderStore/store/frontend.js
@@ -575,6 +575,14 @@ export const getFrontendStore = () => {
         })
         await store.actions.preview.saveSelected()
       },
+      ejectBlock: async (id, definition) => {
+        const asset = get(currentAsset)
+        let parent = findComponentParent(asset.props, id)
+        const childIndex = parent._children.findIndex(x => x._id === id)
+        parent._children[childIndex] = definition
+        await store.actions.preview.saveSelected()
+        await store.actions.components.select(definition)
+      },
     },
     links: {
       save: async (url, title) => {
diff --git a/packages/builder/src/components/design/AppPreview/CurrentItemPreview.svelte b/packages/builder/src/components/design/AppPreview/CurrentItemPreview.svelte
index 706550cca7..1b5bbb1dbc 100644
--- a/packages/builder/src/components/design/AppPreview/CurrentItemPreview.svelte
+++ b/packages/builder/src/components/design/AppPreview/CurrentItemPreview.svelte
@@ -202,6 +202,9 @@
             block: "center",
           })
         }
+      } else if (type === "eject-block") {
+        const { id, definition } = data
+        await store.actions.components.ejectBlock(id, definition)
       } else {
         console.warn(`Client sent unknown event type: ${type}`)
       }
diff --git a/packages/builder/src/components/design/NavigationPanel/ComponentNavigationTree/ComponentDropdownMenu.svelte b/packages/builder/src/components/design/NavigationPanel/ComponentNavigationTree/ComponentDropdownMenu.svelte
index ae031e14bd..43306d309d 100644
--- a/packages/builder/src/components/design/NavigationPanel/ComponentNavigationTree/ComponentDropdownMenu.svelte
+++ b/packages/builder/src/components/design/NavigationPanel/ComponentNavigationTree/ComponentDropdownMenu.svelte
@@ -12,6 +12,7 @@
   $: definition = store.actions.components.getDefinition(component?._component)
   $: noChildrenAllowed = !component || !definition?.hasChildren
   $: noPaste = !$store.componentToPaste
+  $: isBlock = definition?.block === true
 
   // "editable" has been repurposed for inline text editing.
   // It remains here for legacy compatibility.
@@ -83,6 +84,8 @@
       notifications.error("Error saving component")
     }
   }
+
+  const ejectBlock = () => {}
 </script>
 
 {#if showMenu}
@@ -93,6 +96,9 @@
     <MenuItem icon="Delete" on:click={confirmDeleteDialog.show}>
       Delete
     </MenuItem>
+    {#if isBlock}
+      <MenuItem icon="Delete" on:click={ejectBlock}>Eject block</MenuItem>
+    {/if}
     <MenuItem noClose icon="ChevronUp" on:click={moveUpComponent}>
       Move up
     </MenuItem>
diff --git a/packages/client/src/components/Block.svelte b/packages/client/src/components/Block.svelte
index b5e610c1bb..5605ebb711 100644
--- a/packages/client/src/components/Block.svelte
+++ b/packages/client/src/components/Block.svelte
@@ -1,12 +1,65 @@
 <script>
   import { getContext, setContext } from "svelte"
+  import { builderStore } from "../stores/builder.js"
+  import { Button } from "@budibase/bbui"
 
   const component = getContext("component")
 
-  // We need to set a block context to know we're inside a block, but also
-  // to be able to reference the actual component ID of the block from
-  // any depth
-  setContext("block", { id: $component.id })
+  let structureLookupMap = {}
+  const registerBlockComponent = (id, order, parentId, instance) => {
+    // Ensure child array exists
+    if (!structureLookupMap[parentId]) {
+      structureLookupMap[parentId] = []
+    }
+    // Remove existing instance of this component in case props changed
+    structureLookupMap[parentId] = structureLookupMap[parentId].filter(
+      x => x.instance._id !== id
+    )
+    // Add new instance of this component
+    structureLookupMap[parentId].push({ order, instance })
+  }
+
+  const eject = () => {
+    // Start the new structure with the first top level component
+    let definition = structureLookupMap[$component.id][0].instance
+    attachChildren(definition, structureLookupMap)
+    builderStore.actions.ejectBlock($component.id, definition)
+  }
+
+  const attachChildren = (rootComponent, map) => {
+    let id = rootComponent._id
+    if (!map[id]?.length) {
+      return
+    }
+
+    // Sort children by order
+    map[id].sort((a, b) => (a.order < b.order ? -1 : 1))
+
+    // Attach all children of this component
+    rootComponent._children = map[id].map(x => x.instance)
+
+    // Recurse for each child
+    rootComponent._children.forEach(child => {
+      attachChildren(child, map)
+    })
+  }
+
+  setContext("block", {
+    // We need to set a block context to know we're inside a block, but also
+    // to be able to reference the actual component ID of the block from
+    // any depth
+    id: $component.id,
+
+    // We register block components with their raw props so that we can eject
+    // blocks later on
+    registerComponent: registerBlockComponent,
+  })
 </script>
 
 <slot />
+
+{#if $component.selected}
+  <div>
+    <Button cta on:click={eject}>Eject block</Button>
+  </div>
+{/if}
diff --git a/packages/client/src/components/BlockComponent.svelte b/packages/client/src/components/BlockComponent.svelte
index c23f18f55c..75ad7b57fe 100644
--- a/packages/client/src/components/BlockComponent.svelte
+++ b/packages/client/src/components/BlockComponent.svelte
@@ -7,11 +7,13 @@
   export let props
   export let styles
   export let context
+  export let order = 0
 
   // ID is only exposed as a prop so that it can be bound to from parent
   // block components
   export let id
 
+  const component = getContext("component")
   const block = getContext("block")
   const rand = generate()
 
@@ -21,6 +23,7 @@
   $: instance = {
     _component: `@budibase/standard-components/${type}`,
     _id: id,
+    _instanceName: type,
     _styles: {
       normal: {
         ...styles,
@@ -28,6 +31,7 @@
     },
     ...props,
   }
+  $: block.registerComponent(id, order, $component?.id, instance)
 </script>
 
 <Component {instance} isBlock>
diff --git a/packages/client/src/components/app/blocks/TableBlock.svelte b/packages/client/src/components/app/blocks/TableBlock.svelte
index 4f5e0e1114..151d2bcadb 100644
--- a/packages/client/src/components/app/blocks/TableBlock.svelte
+++ b/packages/client/src/components/app/blocks/TableBlock.svelte
@@ -112,28 +112,52 @@
         props={{ dataSource, disableValidation: true }}
       >
         {#if title || enrichedSearchColumns?.length || showTitleButton}
-          <div class="header" class:mobile={$context.device.mobile}>
-            <div class="title">
-              <Heading>{title || ""}</Heading>
-            </div>
-            <div class="controls">
+          <BlockComponent
+            type="container"
+            props={{
+              direction: "row",
+              hAlign: "stretch",
+              vAlign: "middle",
+              gap: "M",
+            }}
+            styles={{
+              "margin-bottom": "20px",
+            }}
+            order={0}
+          >
+            <BlockComponent
+              type="heading"
+              props={{
+                text: title,
+              }}
+              order={0}
+            />
+            <BlockComponent
+              type="container"
+              props={{
+                direction: "row",
+                hAlign: "right",
+                vAlign: "center",
+                gap: "M",
+              }}
+              order={1}
+            >
               {#if enrichedSearchColumns?.length}
-                <div
-                  class="search"
-                  style="--cols:{enrichedSearchColumns?.length}"
-                >
-                  {#each enrichedSearchColumns as column}
-                    <BlockComponent
-                      type={column.componentType}
-                      props={{
-                        field: column.name,
-                        placeholder: column.name,
-                        text: column.name,
-                        autoWidth: true,
-                      }}
-                    />
-                  {/each}
-                </div>
+                {#each enrichedSearchColumns as column, idx}
+                  <BlockComponent
+                    type={column.componentType}
+                    props={{
+                      field: column.name,
+                      placeholder: column.name,
+                      text: column.name,
+                      autoWidth: true,
+                    }}
+                    styles={{
+                      width: "192px",
+                    }}
+                    order={idx}
+                  />
+                {/each}
               {/if}
               {#if showTitleButton}
                 <BlockComponent
@@ -143,10 +167,11 @@
                     text: titleButtonText,
                     type: "cta",
                   }}
+                  order={3}
                 />
               {/if}
-            </div>
-          </div>
+            </BlockComponent>
+          </BlockComponent>
         {/if}
         <BlockComponent
           type="dataprovider"
@@ -159,6 +184,7 @@
             paginate,
             limit: rowCount,
           }}
+          order={1}
         >
           <BlockComponent
             type="table"
@@ -185,33 +211,6 @@
 {/if}
 
 <style>
-  .header {
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    align-items: center;
-    gap: 20px;
-    margin-bottom: 20px;
-  }
-
-  .title {
-    overflow: hidden;
-  }
-  .title :global(.spectrum-Heading) {
-    flex: 1 1 auto;
-    white-space: nowrap;
-    overflow: hidden;
-    text-overflow: ellipsis;
-  }
-
-  .controls {
-    flex: 0 1 auto;
-    display: flex;
-    flex-direction: row;
-    justify-content: flex-end;
-    align-items: center;
-    gap: 20px;
-  }
   .controls :global(.spectrum-InputGroup .spectrum-InputGroup-input) {
     width: 100%;
   }
diff --git a/packages/client/src/stores/builder.js b/packages/client/src/stores/builder.js
index f641bb56e6..4311c8e272 100644
--- a/packages/client/src/stores/builder.js
+++ b/packages/client/src/stores/builder.js
@@ -71,6 +71,9 @@ const createBuilderStore = () => {
     highlightSetting: setting => {
       dispatchEvent("highlight-setting", { setting })
     },
+    ejectBlock: (id, definition) => {
+      dispatchEvent("eject-block", { id, definition })
+    },
   }
   return {
     ...store,