Validate required settings messages from builder

packages/builder/src/helpers/screen.ts

@@ -38,7 +38,7 @@ export function findComponentsBySettingsType(
   return result
 }
 
-function getManifestDefinition(component: Component) {
+export function getManifestDefinition(component: Component) {
   const componentType = component._component.split("/").slice(-1)[0]
   const definition =
     clientManifest[componentType as keyof typeof clientManifest]

packages/builder/src/stores/builder/screenComponent.ts

@@ -2,11 +2,15 @@ import { derived } from "svelte/store"
 import { tables } from "./tables"
 import { selectedScreen } from "./screens"
 import { viewsV2 } from "./viewsV2"
-import { findComponentsBySettingsType } from "@/helpers/screen"
-import { UIDatasourceType, Screen } from "@budibase/types"
+import {
+  findComponentsBySettingsType,
+  getManifestDefinition,
+} from "@/helpers/screen"
+import { UIDatasourceType, Screen, Component } from "@budibase/types"
 import { queries } from "./queries"
 import { views } from "./views"
 import { featureFlag } from "@/helpers"
+import { findAllComponents } from "@/helpers/components"
 
 function reduceBy<TItem extends {}, TKey extends keyof TItem>(
   key: TKey,
@@ -42,16 +46,36 @@ export const screenComponentErrors = derived(
     if (!featureFlag.isEnabled("CHECK_SCREEN_COMPONENT_SETTINGS_ERRORS")) {
       return {}
     }
-    function getInvalidDatasources(
+
+    const datasources = {
+      ...reduceBy("_id", $tables.list),
+      ...reduceBy("name", $views.list),
+      ...reduceBy("id", $viewsV2.list),
+      ...reduceBy("_id", $queries.list),
+    }
+
+    const errors = {
+      ...getInvalidDatasources($selectedScreen, datasources),
+      ...getMissingRequiredSettings($selectedScreen),
+    }
+    return errors
+  }
+)
+
+function getInvalidDatasources(
   screen: Screen,
   datasources: Record<string, any>
-    ) {
+) {
   const result: Record<string, string[]> = {}
-      for (const { component, setting } of findComponentsBySettingsType(
-        screen,
-        ["table", "dataSource"]
-      )) {
+  for (const { component, setting } of findComponentsBySettingsType(screen, [
+    "table",
+    "dataSource",
+  ])) {
     const componentSettings = component[setting.key]
+    if (!componentSettings) {
+      continue
+    }
+
     const { label } = componentSettings
     const type = componentSettings.type as UIDatasourceType
 
@@ -69,15 +93,71 @@ export const screenComponentErrors = derived(
   }
 
   return result
+}
+
+function getAllComponentsInScreen(screen: Screen) {
+  const result: Component[] = []
+  function recursiveCheck(component: Component) {
+    result.push(...findAllComponents(component))
+    component._children?.forEach(recursiveCheck)
+  }
+  recursiveCheck(screen.props)
+  return result
+}
+
+function getMissingRequiredSettings(screen: Screen) {
+  const allComponents = getAllComponentsInScreen(screen)
+
+  const result: Record<string, string[]> = {}
+  for (const component of allComponents) {
+    const definition = getManifestDefinition(component)
+    if (!("settings" in definition)) {
+      continue
     }
 
-    const datasources = {
-      ...reduceBy("_id", $tables.list),
-      ...reduceBy("name", $views.list),
-      ...reduceBy("id", $viewsV2.list),
-      ...reduceBy("_id", $queries.list),
+    const missingRequiredSettings = definition.settings.filter(
+      (setting: any) => {
+        let empty =
+          component[setting.key] == null || component[setting.key] === ""
+        let missing = setting.required && empty
+
+        // Check if this setting depends on another, as it may not be required
+        if (setting.dependsOn) {
+          const dependsOnKey = setting.dependsOn.setting || setting.dependsOn
+          const dependsOnValue = setting.dependsOn.value
+          const realDependentValue = component[dependsOnKey]
+
+          const sectionDependsOnKey =
+            setting.sectionDependsOn?.setting || setting.sectionDependsOn
+          const sectionDependsOnValue = setting.sectionDependsOn?.value
+          const sectionRealDependentValue = component[sectionDependsOnKey]
+
+          if (dependsOnValue == null && realDependentValue == null) {
+            return false
+          }
+          if (dependsOnValue != null && dependsOnValue !== realDependentValue) {
+            return false
           }
 
-    return getInvalidDatasources($selectedScreen, datasources)
+          if (
+            sectionDependsOnValue != null &&
+            sectionDependsOnValue !== sectionRealDependentValue
+          ) {
+            return false
           }
-)
+        }
+
+        return missing
+      }
+    )
+
+    if (missingRequiredSettings.length) {
+      result[component._id!] = missingRequiredSettings.map(
+        (s: any) =>
+          `Add the <mark>${s.label}</mark> setting to start using your component`
+      )
+    }
+  }
+
+  return result
+}

packages/client/src/components/Component.svelte

@@ -695,11 +695,7 @@
     use:gridLayout={gridMetadata}
   >
     {#if errorState}
-      <ComponentErrorState
-        {missingRequiredSettings}
-        {missingRequiredAncestors}
-        {componentErrors}
-      />
+      <ComponentErrorState {componentErrors} />
     {:else}
       <svelte:component this={constructor} bind:this={ref} {...initialSettings}>
         {#if children.length}

packages/client/src/components/error-states/ComponentErrorState.svelte

@@ -26,7 +26,7 @@
       {#if requiredAncestor}
         <MissingRequiredAncestor {requiredAncestor} />
       {:else if errorMessage}
-        {errorMessage}
+        {@html errorMessage}
       {:else if requiredSetting}
         <MissingRequiredSetting {requiredSetting} />
       {/if}