From 46265ade7a42792731ce012309f81d798864fcf4 Mon Sep 17 00:00:00 2001
From: Andrew Kingston <andrew@kingston.dev>
Date: Mon, 3 Feb 2025 12:05:07 +0000
Subject: [PATCH] Add type for component conditions and find usages of updating
 state within conditions

---
 .../Component/ConditionalUIDrawer.svelte      |   6 +-
 .../[screenId]/_components/StatePanel.svelte  | 106 ++++++++++++------
 packages/types/src/documents/app/component.ts |  13 +++
 3 files changed, 86 insertions(+), 39 deletions(-)

diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ConditionalUIDrawer.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ConditionalUIDrawer.svelte
index 2309737cb8..863333e91d 100644
--- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ConditionalUIDrawer.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ConditionalUIDrawer.svelte
@@ -190,7 +190,7 @@
                 <Icon name="DragHandle" size="XL" />
               </div>
               <Select
-                placeholder={null}
+                placeholder={false}
                 options={actionOptions}
                 bind:value={condition.action}
               />
@@ -227,7 +227,7 @@
                 on:change={e => (condition.newValue = e.detail)}
               />
               <Select
-                placeholder={null}
+                placeholder={false}
                 options={getOperatorOptions(condition)}
                 bind:value={condition.operator}
                 on:change={e => onOperatorChange(condition, e.detail)}
@@ -236,7 +236,7 @@
                 disabled={condition.noValue || condition.operator === "oneOf"}
                 options={valueTypeOptions}
                 bind:value={condition.valueType}
-                placeholder={null}
+                placeholder={false}
                 on:change={e => onValueTypeChange(condition, e.detail)}
               />
               {#if ["string", "number"].includes(condition.valueType)}
diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/StatePanel.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/StatePanel.svelte
index 99ffea0314..3a59b60f7c 100644
--- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/StatePanel.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/StatePanel.svelte
@@ -1,7 +1,11 @@
 <script lang="ts">
   import { onMount } from "svelte"
   import { Select } from "@budibase/bbui"
-  import type { Component, EventHandler } from "@budibase/types"
+  import type {
+    Component,
+    ComponentCondition,
+    EventHandler,
+  } from "@budibase/types"
   import { getAllStateVariables, getBindableProperties } from "@/dataBinding"
   import {
     componentStore,
@@ -16,11 +20,12 @@
     processStringSync,
   } from "@budibase/string-templates"
   import DrawerBindableInput from "@/components/common/bindings/DrawerBindableInput.svelte"
+  import { type ComponentSetting } from "@/stores/builder/components"
 
   interface ComponentUsingState {
     id: string
     name: string
-    settings: string[]
+    setting: string
   }
 
   let selectedKey: string | undefined = undefined
@@ -73,11 +78,12 @@
       componentsUpdatingState.push({
         id: $selectedScreen._id!,
         name: "Screen - On load",
-        settings: ["onLoad"],
+        setting: "onLoad",
       })
     }
   }
 
+  // Checks if an event setting updates a certain state key
   const eventUpdatesState = (
     handlers: EventHandler[] | undefined,
     stateKey: string
@@ -90,44 +96,74 @@
     })
   }
 
+  // Checks if a setting for the given component updates a certain state key
+  const settingUpdatesState = (
+    component: Record<string, any>,
+    setting: ComponentSetting,
+    stateKey: string
+  ) => {
+    if (setting.type === "event") {
+      return eventUpdatesState(component[setting.key], stateKey)
+    } else if (setting.type === "buttonConfiguration") {
+      const buttons = component[setting.key]
+      if (Array.isArray(buttons)) {
+        for (let button of buttons) {
+          if (eventUpdatesState(button.onClick, stateKey)) {
+            return true
+          }
+        }
+      }
+    }
+    return false
+  }
+
+  // Checks if a condition updates a certain state key
+  const conditionUpdatesState = (
+    condition: ComponentCondition,
+    settings: ComponentSetting[],
+    stateKey: string
+  ) => {
+    const setting = settings.find(s => s.key === condition.setting)
+    if (!setting) {
+      return false
+    }
+    const component = { [setting.key]: condition.settingValue }
+    return settingUpdatesState(component, setting, stateKey)
+  }
+
   const findComponentsUpdatingState = (
     component: Component,
     stateKey: string,
     foundComponents: ComponentUsingState[] = []
   ): ComponentUsingState[] => {
-    // Check all settings of this component
-    componentStore
-      .getComponentSettings(component._component)
+    const { _children, _conditions, _component, _instanceName, _id } = component
+    const settings = componentStore
+      .getComponentSettings(_component)
       .filter(s => s.type === "event" || s.type === "buttonConfiguration")
-      .forEach(setting => {
-        if (setting.type === "event") {
-          if (eventUpdatesState(component[setting.key], stateKey)) {
-            let label = setting.label || setting.key
-            foundComponents.push({
-              id: component._id!,
-              name: `${component._instanceName} - ${label}`,
-              settings: [setting.key],
-            })
-          }
-        } else if (setting.type === "buttonConfiguration") {
-          const buttons = component[setting.key]
-          if (Array.isArray(buttons)) {
-            buttons.forEach(button => {
-              if (eventUpdatesState(button.onClick, stateKey)) {
-                let label = setting.label || setting.key
-                foundComponents.push({
-                  id: component._id!,
-                  name: `${component._instanceName} - ${label}`,
-                  settings: [setting.key],
-                })
-              }
-            })
-          }
-        }
+
+    // Check all settings of this component
+    settings.forEach(setting => {
+      if (settingUpdatesState(component, setting, stateKey)) {
+        const label = setting.label || setting.key
+        foundComponents.push({
+          id: _id!,
+          name: `${_instanceName} - ${label}`,
+          setting: setting.key,
+        })
+      }
+    })
+
+    // Check if conditions update these settings to update this state key
+    if (_conditions?.some(c => conditionUpdatesState(c, settings, stateKey))) {
+      foundComponents.push({
+        id: _id!,
+        name: `${_instanceName} - Conditions`,
+        setting: "_conditions",
       })
+    }
 
     // Check children
-    component._children?.forEach(child => {
+    _children?.forEach(child => {
       findComponentsUpdatingState(child, stateKey, foundComponents)
     })
     return foundComponents
@@ -153,7 +189,7 @@
       componentsUsingState.push({
         id: component._id!,
         name: `${component._instanceName} - ${label}`,
-        settings: [setting],
+        setting,
       })
     })
 
@@ -186,7 +222,7 @@
 
   const onClickComponentLink = (component: ComponentUsingState) => {
     componentStore.select(component.id)
-    builderStore.highlightSetting(component.settings[0])
+    builderStore.highlightSetting(component.setting)
   }
 
   const handleStateInspectorChange = (e: CustomEvent) => {
@@ -274,7 +310,6 @@
     color: var(--spectrum-global-color-gray-700);
     font-size: 12px;
   }
-
   .updates-colour {
     color: var(--bb-indigo-light);
   }
@@ -294,7 +329,6 @@
   .component-link:hover {
     text-decoration: underline;
   }
-
   .updates-section {
     display: flex;
     flex-direction: column;
diff --git a/packages/types/src/documents/app/component.ts b/packages/types/src/documents/app/component.ts
index 654b2c87cb..abf9db26ff 100644
--- a/packages/types/src/documents/app/component.ts
+++ b/packages/types/src/documents/app/component.ts
@@ -1,9 +1,22 @@
 import { Document } from "../document"
+import { BasicOperator } from "../../sdk"
 
 export interface Component extends Document {
   _instanceName: string
   _styles: { [key: string]: any }
   _component: string
   _children?: Component[]
+  _conditions?: ComponentCondition[]
   [key: string]: any
 }
+
+export interface ComponentCondition {
+  id: string
+  operator: BasicOperator
+  action: "update" | "show" | "hide"
+  valueType: "string" | "number" | "datetime" | "boolean"
+  newValue?: any
+  referenceValue?: any
+  setting?: string
+  settingValue?: any
+}