From f77f7c1e5f09a8dd95ad6c07f6b858d3e5af3903 Mon Sep 17 00:00:00 2001
From: Andrew Kingston <aptkingston@ssl-mail.com>
Date: Thu, 18 Nov 2021 15:36:16 +0000
Subject: [PATCH] Add dynamic filter component

---
 .../design/AppPreview/componentStructure.json |   3 +-
 packages/client/manifest.json                 |  11 ++
 .../app/dynamic-filter/DynamicFilter.svelte   |  37 ++++
 .../app/dynamic-filter/FilterModal.svelte     | 176 ++++++++++++++++++
 .../components/app/dynamic-filter/index.js    |   1 +
 packages/client/src/components/app/index.js   |   1 +
 6 files changed, 228 insertions(+), 1 deletion(-)
 create mode 100644 packages/client/src/components/app/dynamic-filter/DynamicFilter.svelte
 create mode 100644 packages/client/src/components/app/dynamic-filter/FilterModal.svelte
 create mode 100644 packages/client/src/components/app/dynamic-filter/index.js

diff --git a/packages/builder/src/components/design/AppPreview/componentStructure.json b/packages/builder/src/components/design/AppPreview/componentStructure.json
index 357ea5a7be..b237347c44 100644
--- a/packages/builder/src/components/design/AppPreview/componentStructure.json
+++ b/packages/builder/src/components/design/AppPreview/componentStructure.json
@@ -67,6 +67,7 @@
       "icon",
       "embed"
     ]
-  }
+  },
+  "dynamicfilter"
 ]
 
diff --git a/packages/client/manifest.json b/packages/client/manifest.json
index 050ac4a63a..ba7f95e42e 100644
--- a/packages/client/manifest.json
+++ b/packages/client/manifest.json
@@ -2623,6 +2623,17 @@
       }
     ]
   },
+  "dynamicfilter": {
+    "name": "Dynamic Filter",
+    "icon": "FilterEdit",
+    "settings": [
+      {
+        "type": "dataProvider",
+        "label": "Provider",
+        "key": "dataProvider"
+      }
+    ]
+  },
   "tableblock": {
     "block": true,
     "name": "Table block",
diff --git a/packages/client/src/components/app/dynamic-filter/DynamicFilter.svelte b/packages/client/src/components/app/dynamic-filter/DynamicFilter.svelte
new file mode 100644
index 0000000000..6cd0d2be5b
--- /dev/null
+++ b/packages/client/src/components/app/dynamic-filter/DynamicFilter.svelte
@@ -0,0 +1,37 @@
+<script>
+  import { Button, ModalContent, Modal } from "@budibase/bbui"
+  import { getContext } from "svelte"
+  import FilterModal from "./FilterModal.svelte"
+
+  export let dataProvider
+
+  const component = getContext("component")
+  const { styleable } = getContext("sdk")
+
+  $: schema = dataProvider?.schema
+  $: schemaFields = Object.values(schema || {})
+
+  let modal
+  let tmpFilters = []
+  let filters = []
+
+  const openEditor = () => {
+    tmpFilters = [...filters]
+    modal.show()
+  }
+
+  const updateQuery = () => {
+    filters = [...tmpFilters]
+  }
+</script>
+
+<div use:styleable={$component.styles}>
+  <Button on:click={openEditor} secondary icon="FilterEdit">
+    Edit filters
+  </Button>
+  <Modal bind:this={modal}>
+    <ModalContent title="Edit filters" size="XL" onConfirm={updateQuery}>
+      <FilterModal bind:filters={tmpFilters} {schemaFields} />
+    </ModalContent>
+  </Modal>
+</div>
diff --git a/packages/client/src/components/app/dynamic-filter/FilterModal.svelte b/packages/client/src/components/app/dynamic-filter/FilterModal.svelte
new file mode 100644
index 0000000000..99b9a1a6f6
--- /dev/null
+++ b/packages/client/src/components/app/dynamic-filter/FilterModal.svelte
@@ -0,0 +1,176 @@
+<script>
+  import {
+    Body,
+    Button,
+    Combobox,
+    DatePicker,
+    DrawerContent,
+    Icon,
+    Input,
+    Layout,
+    Select,
+  } from "@budibase/bbui"
+  import { generate } from "shortid"
+  import {
+    getValidOperatorsForType,
+    OperatorOptions,
+  } from "builder/src/constants/lucene"
+
+  export let schemaFields
+  export let filters = []
+
+  const BannedTypes = ["link", "attachment", "formula"]
+
+  $: fieldOptions = (schemaFields ?? [])
+    .filter(field => !BannedTypes.includes(field.type))
+    .map(field => field.name)
+
+  const addFilter = () => {
+    filters = [
+      ...filters,
+      {
+        id: generate(),
+        field: null,
+        operator: OperatorOptions.Equals.value,
+        value: null,
+        valueType: "Value",
+      },
+    ]
+  }
+
+  const removeFilter = id => {
+    filters = filters.filter(field => field.id !== id)
+  }
+
+  const duplicateFilter = id => {
+    const existingFilter = filters.find(filter => filter.id === id)
+    const duplicate = { ...existingFilter, id: generate() }
+    filters = [...filters, duplicate]
+  }
+
+  const onFieldChange = (expression, field) => {
+    // Update the field type
+    expression.type = schemaFields.find(x => x.name === field)?.type
+
+    // Ensure a valid operator is set
+    const validOperators = getValidOperatorsForType(expression.type).map(
+      x => x.value
+    )
+    if (!validOperators.includes(expression.operator)) {
+      expression.operator = validOperators[0] ?? OperatorOptions.Equals.value
+      onOperatorChange(expression, expression.operator)
+    }
+
+    // if changed to an array, change default value to empty array
+    const idx = filters.findIndex(x => x.field === field)
+    if (expression.type === "array") {
+      filters[idx].value = []
+    } else {
+      filters[idx].value = null
+    }
+  }
+
+  const onOperatorChange = (expression, operator) => {
+    const noValueOptions = [
+      OperatorOptions.Empty.value,
+      OperatorOptions.NotEmpty.value,
+    ]
+    expression.noValue = noValueOptions.includes(operator)
+    if (expression.noValue) {
+      expression.value = null
+    }
+  }
+
+  const getFieldOptions = field => {
+    const schema = schemaFields.find(x => x.name === field)
+    return schema?.constraints?.inclusion || []
+  }
+</script>
+
+<DrawerContent>
+  <div class="container">
+    <Layout noPadding>
+      <Body size="S">
+        {#if !filters?.length}
+          Add your first filter expression.
+        {:else}
+          Results are filtered to only those which match all of the following
+          constraints.
+        {/if}
+      </Body>
+      {#if filters?.length}
+        <div class="fields">
+          {#each filters as filter, idx}
+            <Select
+              bind:value={filter.field}
+              options={fieldOptions}
+              on:change={e => onFieldChange(filter, e.detail)}
+              placeholder="Column"
+            />
+            <Select
+              disabled={!filter.field}
+              options={getValidOperatorsForType(filter.type)}
+              bind:value={filter.operator}
+              on:change={e => onOperatorChange(filter, e.detail)}
+              placeholder={null}
+            />
+            {#if ["string", "longform", "number"].includes(filter.type)}
+              <Input disabled={filter.noValue} bind:value={filter.value} />
+            {:else if ["options", "array"].includes(filter.type)}
+              <Combobox
+                disabled={filter.noValue}
+                options={getFieldOptions(filter.field)}
+                bind:value={filter.value}
+              />
+            {:else if filter.type === "boolean"}
+              <Combobox
+                disabled={filter.noValue}
+                options={[
+                  { label: "True", value: "true" },
+                  { label: "False", value: "false" },
+                ]}
+                bind:value={filter.value}
+              />
+            {:else if filter.type === "datetime"}
+              <DatePicker disabled={filter.noValue} bind:value={filter.value} />
+            {:else}
+              <Input disabled />
+            {/if}
+            <Icon
+              name="Duplicate"
+              hoverable
+              size="S"
+              on:click={() => duplicateFilter(filter.id)}
+            />
+            <Icon
+              name="Close"
+              hoverable
+              size="S"
+              on:click={() => removeFilter(filter.id)}
+            />
+          {/each}
+        </div>
+      {/if}
+      <div>
+        <Button icon="AddCircle" size="M" secondary on:click={addFilter}>
+          Add filter
+        </Button>
+      </div>
+    </Layout>
+  </div>
+</DrawerContent>
+
+<style>
+  .container {
+    width: 100%;
+    max-width: 1000px;
+    margin: 0 auto;
+  }
+  .fields {
+    display: grid;
+    column-gap: var(--spacing-l);
+    row-gap: var(--spacing-s);
+    align-items: center;
+    grid-template-columns: 1fr 120px 1fr auto auto;
+  }
+</style>
diff --git a/packages/client/src/components/app/dynamic-filter/index.js b/packages/client/src/components/app/dynamic-filter/index.js
new file mode 100644
index 0000000000..5ac7d31730
--- /dev/null
+++ b/packages/client/src/components/app/dynamic-filter/index.js
@@ -0,0 +1 @@
+export { default as dynamicfilter } from "./DynamicFilter.svelte"
diff --git a/packages/client/src/components/app/index.js b/packages/client/src/components/app/index.js
index 92725f0738..f5d085e97b 100644
--- a/packages/client/src/components/app/index.js
+++ b/packages/client/src/components/app/index.js
@@ -33,6 +33,7 @@ export * from "./charts"
 export * from "./forms"
 export * from "./table"
 export * from "./blocks"
+export * from "./dynamic-filter"
 
 // Deprecated component left for compatibility in old apps
 export { default as navigation } from "./deprecated/Navigation.svelte"