Merge pull request #15706 from Budibase/BUDI-9077/type-fields

Type fields

packages/client/src/components/app/forms/BBReferenceField.svelte

@@ -1,31 +1,36 @@
-<script>
+<script lang="ts">
   import { sdk } from "@budibase/shared-core"
   import { FieldType } from "@budibase/types"
   import RelationshipField from "./RelationshipField.svelte"
 
-  export let defaultValue
+  export let defaultValue: string
   export let type = FieldType.BB_REFERENCE
 
-  function updateUserIDs(value) {
+  function updateUserIDs(value: string | string[]) {
     if (Array.isArray(value)) {
-      return value.map(val => sdk.users.getGlobalUserID(val))
+      return value.map(val => sdk.users.getGlobalUserID(val)!)
     } else {
       return sdk.users.getGlobalUserID(value)
     }
   }
 
-  function updateReferences(value) {
+  function updateReferences(value: string) {
     if (sdk.users.containsUserID(value)) {
       return updateUserIDs(value)
     }
     return value
   }
+
+  $: updatedDefaultValue = updateReferences(defaultValue)
+
+  // This cannot be typed, as svelte does not provide typed inheritance
+  $: allProps = $$props as any
 </script>
 
 <RelationshipField
-  {...$$props}
+  {...allProps}
   {type}
   datasourceType={"user"}
   primaryDisplay={"email"}
-  defaultValue={updateReferences(defaultValue)}
+  defaultValue={updatedDefaultValue}
 />

packages/client/src/components/app/forms/Field.svelte

@@ -1,43 +1,60 @@
 <script lang="ts">
   import { getContext, onDestroy } from "svelte"
+  import type { Readable } from "svelte/store"
   import { writable } from "svelte/store"
   import { Icon } from "@budibase/bbui"
   import { memo } from "@budibase/frontend-core"
   import Placeholder from "../Placeholder.svelte"
   import InnerForm from "./InnerForm.svelte"
-  import type { FieldApi } from "."
+  import type { FieldSchema, FieldType } from "@budibase/types"
+  import type {
+    FieldApi,
+    FieldState,
+    FieldValidation,
+    FormField,
+  } from "@/types"
+
+  interface FieldInfo {
+    field: string
+    type: FieldType
+    defaultValue: string | undefined
+    disabled: boolean
+    readonly: boolean
+    validation?: FieldValidation
+    formStep: number
+  }
 
   export let label: string | undefined = undefined
   export let field: string | undefined = undefined
-  export let fieldState: any
-  export let fieldApi: FieldApi
-  export let fieldSchema: any
+  export let fieldState: FieldState | undefined
+  export let fieldApi: FieldApi | undefined
+  export let fieldSchema: FieldSchema | undefined
   export let defaultValue: string | undefined = undefined
-  export let type: any
+  export let type: FieldType
   export let disabled = false
   export let readonly = false
-  export let validation: any
+  export let validation: FieldValidation | undefined
   export let span = 6
   export let helpText: string | undefined = undefined
 
   // Get contexts
-  const formContext: any = getContext("form")
-  const formStepContext: any = getContext("form-step")
-  const fieldGroupContext: any = getContext("field-group")
+  const formContext = getContext("form")
+  const formStepContext = getContext("form-step")
+  const fieldGroupContext = getContext("field-group")
   const { styleable, builderStore, Provider } = getContext("sdk")
-  const component: any = getContext("component")
+  const component = getContext("component")
 
   // Register field with form
   const formApi = formContext?.formApi
   const labelPos = fieldGroupContext?.labelPosition || "above"
 
-  let formField: any
+  let formField: Readable<FormField> | undefined
   let touched = false
-  let labelNode: any
+  let labelNode: HTMLElement | undefined
 
   // Memoize values required to register the field to avoid loops
   const formStep = formStepContext || writable(1)
-  const fieldInfo = memo({
+  const fieldInfo = memo<FieldInfo>({
     field: field || $component.name,
     type,
     defaultValue,
@@ -66,16 +83,22 @@
   $: $component.editing && labelNode?.focus()
 
   // Update form properties in parent component on every store change
-  $: unsubscribe = formField?.subscribe((value: any) => {
-    fieldState = value?.fieldState
-    fieldApi = value?.fieldApi
-    fieldSchema = value?.fieldSchema
-  })
+  $: unsubscribe = formField?.subscribe(
+    (value?: {
+      fieldState: FieldState
+      fieldApi: FieldApi
+      fieldSchema: FieldSchema
+    }) => {
+      fieldState = value?.fieldState
+      fieldApi = value?.fieldApi
+      fieldSchema = value?.fieldSchema
+    }
+  )
 
   // Determine label class from position
   $: labelClass = labelPos === "above" ? "" : `spectrum-FieldLabel--${labelPos}`
 
-  const registerField = (info: any) => {
+  const registerField = (info: FieldInfo) => {
     formField = formApi?.registerField(
       info.field,
       info.type,
@@ -87,10 +110,10 @@
     )
   }
 
-  const updateLabel = (e: any) => {
+  const updateLabel = (e: Event) => {
     if (touched) {
-      // @ts-expect-error and TODO updateProp isn't recognised - need builder TS conversion
-      builderStore.actions.updateProp("label", e.target.textContent)
+      const label = e.target as HTMLLabelElement
+      builderStore.actions.updateProp("label", label.textContent)
     }
     touched = false
   }

packages/client/src/components/app/forms/RelationshipField.svelte

@@ -9,17 +9,19 @@
     RelationshipFieldMetadata,
     Row,
   } from "@budibase/types"
-  import type { FieldApi, FieldState } from "."
+  import type { FieldApi, FieldState, FieldValidation } from "@/types"
+
+  type ValueType = string | string[]
 
   export let field: string | undefined = undefined
   export let label: string | undefined = undefined
   export let placeholder: string | undefined = undefined
   export let disabled: boolean = false
   export let readonly: boolean = false
-  export let validation: any
+  export let validation: FieldValidation | undefined = undefined
   export let autocomplete: boolean = true
-  export let defaultValue: string | string[] | undefined = undefined
-  export let onChange: any
+  export let defaultValue: ValueType | undefined = undefined
+  export let onChange: (_props: { value: ValueType }) => void
   export let filter: SearchFilter[]
   export let datasourceType: "table" | "user" = "table"
   export let primaryDisplay: string | undefined = undefined
@@ -88,14 +90,14 @@
   // Ensure backwards compatibility
   $: enrichedDefaultValue = enrichDefaultValue(defaultValue)
 
+  $: emptyValue = multiselect ? [] : undefined
   // We need to cast value to pass it down, as those components aren't typed
-  $: emptyValue = multiselect ? [] : null
-  $: displayValue = missingIDs.length ? emptyValue : (selectedValue as any)
+  $: displayValue = (missingIDs.length ? emptyValue : selectedValue) as any
 
   // Ensures that we flatten any objects so that only the IDs of the selected
   // rows are passed down. Not sure how this can be an object to begin with?
   const parseSelectedValue = (
-    value: any,
+    value: ValueType | undefined,
     multiselect: boolean
   ): undefined | string | string[] => {
     return multiselect ? flatten(value) : flatten(value)[0]
@@ -140,7 +142,7 @@
 
   // Builds a map of all available options, in a consistent structure
   const processOptions = (
-    realValue: any | any[],
+    realValue: ValueType | undefined,
     rows: Row[],
     primaryDisplay?: string
   ) => {
@@ -171,7 +173,7 @@
 
   // Parses a row-like structure into a properly shaped option
   const parseOption = (
-    option: any | BasicRelatedRow | Row,
+    option: string | BasicRelatedRow | Row,
     primaryDisplay?: string
   ): BasicRelatedRow | null => {
     if (!option || typeof option !== "object" || !option?._id) {

packages/client/src/components/app/forms/index.ts

@@ -19,15 +19,3 @@ export { default as codescanner } from "./CodeScannerField.svelte"
 export { default as signaturesinglefield } from "./SignatureField.svelte"
 export { default as bbreferencefield } from "./BBReferenceField.svelte"
 export { default as bbreferencesinglefield } from "./BBReferenceSingleField.svelte"
-
-export interface FieldApi {
-  setValue(value: any): boolean
-  deregister(): void
-}
-
-export interface FieldState<T> {
-  value: T
-  fieldId: string
-  disabled: boolean
-  readonly: boolean
-}

packages/client/src/context.d.ts

@@ -1,7 +1,12 @@
-import { Component, Context, SDK } from "."
+import { Writable } from "svelte"
+import { Component, FieldGroupContext, FormContext, SDK } from "@/types"
+import { Readable } from "svelte/store"
 
 declare module "svelte" {
   export function getContext(key: "sdk"): SDK
   export function getContext(key: "component"): Component
-  export function getContext(key: "context"): Context
+  export function getContext(key: "context"): Readable<Record<string, any>>
+  export function getContext(key: "form"): FormContext | undefined
+  export function getContext(key: "form-step"): Writable<number> | undefined
+  export function getContext(key: "field-group"): FieldGroupContext | undefined
 }

packages/client/src/index.ts

@@ -14,8 +14,6 @@ import {
 } from "@/stores"
 import { get } from "svelte/store"
 import { initWebsocket } from "@/websocket"
-import { APIClient } from "@budibase/frontend-core"
-import type { ActionTypes } from "@/constants"
 import { Readable } from "svelte/store"
 import {
   Screen,
@@ -39,6 +37,7 @@ window.svelte = svelte
 // Initialise spectrum icons
 // eslint-disable-next-line local-rules/no-budibase-imports
 import loadSpectrumIcons from "@budibase/bbui/spectrum-icons-vite.js"
+
 loadSpectrumIcons()
 
 // Extend global window scope
@@ -73,32 +72,6 @@ declare global {
   }
 }
 
-export interface SDK {
-  API: APIClient
-  styleable: any
-  Provider: any
-  ActionTypes: typeof ActionTypes
-  fetchDatasourceSchema: any
-  generateGoldenSample: any
-  builderStore: Readable<{
-    inBuilder: boolean
-  }> & {
-    actions: {
-      highlightSetting: (key: string) => void
-      addParentComponent: (
-        componentId: string,
-        fullAncestorType: string
-      ) => void
-    }
-  }
-}
-
-export type Component = Readable<{
-  id: string
-  styles: any
-  errorState: boolean
-}>
-
 export type Context = Readable<Record<string, any>>
 
 let app: ClientApp

packages/client/src/types/components.ts

@@ -0,0 +1,9 @@
+import { Readable } from "svelte/store"
+
+export type Component = Readable<{
+  id: string
+  name: string
+  styles: any
+  editing: boolean
+  errorState: boolean
+}>

packages/client/src/types/fields.ts

@@ -0,0 +1,3 @@
+export interface FieldGroupContext {
+  labelPosition: string
+}

packages/client/src/types/forms.ts

@@ -0,0 +1,37 @@
+import { Readable } from "svelte/store"
+import { FieldSchema, FieldType } from "@budibase/types"
+
+export interface FormContext {
+  formApi?: {
+    registerField: (
+      field: string,
+      type: FieldType,
+      defaultValue: string | undefined,
+      disabled: boolean,
+      readonly: boolean,
+      validation: FieldValidation | undefined,
+      formStep: number
+    ) => Readable<FormField>
+  }
+}
+
+export type FieldValidation = () => string | undefined
+
+export interface FormField {
+  fieldState: FieldState
+  fieldApi: FieldApi
+  fieldSchema: FieldSchema
+}
+
+export interface FieldApi {
+  setValue(value: any): boolean
+  deregister(): void
+}
+
+export interface FieldState<T = any> {
+  value: T
+  fieldId: string
+  disabled: boolean
+  readonly: boolean
+  error?: string
+}

packages/client/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./components"
+export * from "./fields"
+export * from "./forms"
+export * from "./sdk"

packages/client/src/types/sdk.ts

@@ -0,0 +1,24 @@
+import { ActionTypes } from "@/constants"
+import { APIClient } from "@budibase/frontend-core"
+import { Readable } from "svelte/store"
+
+export interface SDK {
+  API: APIClient
+  styleable: any
+  Provider: any
+  ActionTypes: typeof ActionTypes
+  fetchDatasourceSchema: any
+  generateGoldenSample: any
+  builderStore: Readable<{
+    inBuilder: boolean
+  }> & {
+    actions: {
+      highlightSetting: (key: string) => void
+      addParentComponent: (
+        componentId: string,
+        fullAncestorType: string
+      ) => void
+      updateProp: (key: string, value: any) => void
+    }
+  }
+}