From 0b909b434a51f9b2336c0bdb20e1d2dd29683271 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Wed, 15 Jan 2025 14:34:36 +0000
Subject: [PATCH] Work on binding drawer typing.

---
 packages/bbui/src/Label/Label.svelte          |  2 +-
 .../common/CodeEditor/CodeEditor.svelte       | 67 ++++++++++++-------
 .../common/bindings/BindingPanel.svelte       | 39 ++++++-----
 packages/types/src/ui/bindings/binding.ts     |  9 +++
 .../types/src/ui/components/codeEditor.ts     | 43 +++++++-----
 5 files changed, 95 insertions(+), 65 deletions(-)

diff --git a/packages/bbui/src/Label/Label.svelte b/packages/bbui/src/Label/Label.svelte
index 71b0967d99..41e1ccf794 100644
--- a/packages/bbui/src/Label/Label.svelte
+++ b/packages/bbui/src/Label/Label.svelte
@@ -4,7 +4,7 @@
 
   export let size = "M"
   export let tooltip = ""
-  export let muted
+  export let muted = undefined
 </script>
 
 <TooltipWrapper {tooltip} {size}>
diff --git a/packages/builder/src/components/common/CodeEditor/CodeEditor.svelte b/packages/builder/src/components/common/CodeEditor/CodeEditor.svelte
index f94d26603d..1fa2eb3fae 100644
--- a/packages/builder/src/components/common/CodeEditor/CodeEditor.svelte
+++ b/packages/builder/src/components/common/CodeEditor/CodeEditor.svelte
@@ -1,4 +1,4 @@
-<script>
+<script lang="ts">
   import { Label } from "@budibase/bbui"
   import { onMount, createEventDispatcher, onDestroy } from "svelte"
   import { FIND_ANY_HBS_REGEX } from "@budibase/string-templates"
@@ -12,7 +12,6 @@
     completionStatus,
   } from "@codemirror/autocomplete"
   import {
-    EditorView,
     lineNumbers,
     keymap,
     highlightSpecialChars,
@@ -25,6 +24,7 @@
     MatchDecorator,
     ViewPlugin,
     Decoration,
+    EditorView,
   } from "@codemirror/view"
   import {
     bracketMatching,
@@ -44,12 +44,14 @@
   import { javascript } from "@codemirror/lang-javascript"
   import { EditorModes } from "./"
   import { themeStore } from "@/stores/portal"
+  import type { EditorMode } from "@budibase/types"
 
-  export let label
-  export let completions = []
-  export let mode = EditorModes.Handlebars
-  export let value = ""
-  export let placeholder = null
+  export let label: string | undefined = undefined
+  // TODO: work out what best type fits this
+  export let completions: any[] = []
+  export let mode: EditorMode = EditorModes.Handlebars
+  export let value: string | null = ""
+  export let placeholder: string | null = null
   export let autocompleteEnabled = true
   export let autofocus = false
   export let jsBindingWrapping = true
@@ -58,8 +60,8 @@
 
   const dispatch = createEventDispatcher()
 
-  let textarea
-  let editor
+  let textarea: HTMLDivElement | undefined
+  let editor: EditorView | undefined
   let mounted = false
   let isEditorInitialised = false
   let queuedRefresh = false
@@ -71,7 +73,7 @@
 
   $: {
     if (autofocus && isEditorInitialised) {
-      editor.focus()
+      editor?.focus()
     }
   }
 
@@ -88,7 +90,7 @@
       isDark = !currentTheme.includes("light")
 
       // Issue theme compartment update
-      editor.dispatch({
+      editor?.dispatch({
         effects: themeConfig.reconfigure([...(isDark ? [oneDark] : [])]),
       })
     }
@@ -100,17 +102,24 @@
   /**
    * Will refresh the editor contents only after
    * it has been fully initialised
-   * @param value {string} the editor value
    */
-  const refresh = (value, initialised, mounted) => {
+  const refresh = (
+    value: string | null,
+    initialised?: boolean,
+    mounted?: boolean
+  ) => {
     if (!initialised || !mounted) {
       queuedRefresh = true
       return
     }
 
-    if (editor.state.doc.toString() !== value || queuedRefresh) {
+    if (
+      editor &&
+      value &&
+      (editor.state.doc.toString() !== value || queuedRefresh)
+    ) {
       editor.dispatch({
-        changes: { from: 0, to: editor.state.doc.length, insert: value },
+        changes: { from: 0, to: editor.state.doc.length, insert: value! },
       })
       queuedRefresh = false
     }
@@ -118,17 +127,22 @@
 
   // Export a function to expose caret position
   export const getCaretPosition = () => {
-    const selection_range = editor.state.selection.ranges[0]
+    const selection_range = editor?.state.selection.ranges[0]
     return {
-      start: selection_range.from,
-      end: selection_range.to,
+      start: selection_range?.from,
+      end: selection_range?.to,
     }
   }
 
-  export const insertAtPos = opts => {
+  export const insertAtPos = (opts: {
+    start: number
+    end?: number
+    value: string
+    cursor: { anchor: number }
+  }) => {
     // Updating the value inside.
     // Retain focus
-    editor.dispatch({
+    editor?.dispatch({
       changes: {
         from: opts.start || editor.state.doc.length,
         to: opts.end || editor.state.doc.length,
@@ -192,7 +206,7 @@
 
   const indentWithTabCustom = {
     key: "Tab",
-    run: view => {
+    run: (view: EditorView) => {
       if (completionStatus(view.state) === "active") {
         acceptCompletion(view)
         return true
@@ -200,7 +214,7 @@
       indentMore(view)
       return true
     },
-    shift: view => {
+    shift: (view: EditorView) => {
       indentLess(view)
       return true
     },
@@ -232,7 +246,8 @@
 
   // None of this is reactive, but it never has been, so we just assume most
   // config flags aren't changed at runtime
-  const buildExtensions = base => {
+  // TODO: work out type for base
+  const buildExtensions = (base: any[]) => {
     let complete = [...base]
 
     if (autocompleteEnabled) {
@@ -242,7 +257,7 @@
           closeOnBlur: true,
           icons: false,
           optionClass: completion =>
-            completion.simple
+            "simple" in completion && completion.simple
               ? "autocomplete-option-simple"
               : "autocomplete-option",
         })
@@ -308,7 +323,7 @@
         keymap.of(buildKeymap()),
         EditorView.domEventHandlers({
           blur: () => {
-            dispatch("blur", editor.state.doc.toString())
+            dispatch("blur", editor?.state.doc.toString())
           },
         }),
         EditorView.updateListener.of(v => {
@@ -347,7 +362,7 @@
 
 {#if label}
   <div>
-    <Label small>{label}</Label>
+    <Label size="S">{label}</Label>
   </div>
 {/if}
 
diff --git a/packages/builder/src/components/common/bindings/BindingPanel.svelte b/packages/builder/src/components/common/bindings/BindingPanel.svelte
index 6b9119f433..04dc92f920 100644
--- a/packages/builder/src/components/common/bindings/BindingPanel.svelte
+++ b/packages/builder/src/components/common/bindings/BindingPanel.svelte
@@ -31,20 +31,21 @@
   import { capitalise } from "@/helpers"
   import { Utils, JsonFormatter } from "@budibase/frontend-core"
   import { licensing } from "@/stores/portal"
-  import {
+  import { BindingMode, EditorMode, SidePanel } from "@budibase/types"
+  import type {
     EnrichedBinding,
-    BindingMode,
-    SidePanel,
     BindingCompletion,
     Snippet,
     Helper,
+    CaretPositionFn,
+    InsertAtPositionFn,
   } from "@budibase/types"
-  import { CompletionContext } from "@codemirror/autocomplete"
+  import type { CompletionContext } from "@codemirror/autocomplete"
 
   const dispatch = createEventDispatcher()
 
   export let bindings: EnrichedBinding[] = []
-  export let value = ""
+  export let value: string = ""
   export let allowHBS = true
   export let allowJS = false
   export let allowHelpers = true
@@ -58,14 +59,10 @@
   let mode: BindingMode | null
   let sidePanel: SidePanel | null
   let initialValueJS = value?.startsWith?.("{{ js ")
-  let jsValue = initialValueJS ? value : null
-  let hbsValue = initialValueJS ? null : value
-  let getCaretPosition: () => { start: number; end: number } | undefined
-  let insertAtPos: (_: {
-    start: number
-    end: number
-    value: string
-  }) => void | undefined
+  let jsValue: string | null = initialValueJS ? value : null
+  let hbsValue: string | null = initialValueJS ? null : value
+  let getCaretPosition: CaretPositionFn | undefined
+  let insertAtPos: InsertAtPositionFn | undefined
   let targetMode: BindingMode | null = null
   let expressionResult: string | undefined | null
   let expressionError: string | undefined | null
@@ -83,7 +80,9 @@
   $: usingJS = mode === BindingMode.JavaScript
   $: editorMode =
     mode === BindingMode.JavaScript ? EditorModes.JS : EditorModes.Handlebars
-  $: editorValue = editorMode === EditorModes.JS ? jsValue : hbsValue
+  $: editorValue = (editorMode === EditorModes.JS ? jsValue : hbsValue) as
+    | string
+    | null
   $: runtimeExpression = readableToRuntimeBinding(enrichedBindings, value)
   $: requestEval(runtimeExpression, context, snippets)
   $: bindingCompletions = bindingsToCompletions(enrichedBindings, editorMode)
@@ -300,6 +299,9 @@
     }
   }
 
+  const addSnippet = (snippet: Snippet) =>
+    bindingHelpers.onSelectSnippet(snippet)
+
   onMount(() => {
     // Set the initial mode appropriately
     const initialValueMode = initialValueJS
@@ -365,7 +367,7 @@
         {:else if mode === BindingMode.JavaScript}
           {#key jsCompletions}
             <CodeEditor
-              value={decodeJSBinding(jsValue)}
+              value={jsValue ? decodeJSBinding(jsValue) : jsValue}
               on:change={onChangeJSValue}
               completions={jsCompletions}
               mode={EditorModes.JS}
@@ -419,13 +421,10 @@
           {expressionResult}
           {expressionError}
           {evaluating}
-          expression={editorValue}
+          expression={editorValue ? editorValue : ""}
         />
       {:else if sidePanel === SidePanel.Snippets}
-        <SnippetSidePanel
-          addSnippet={snippet => bindingHelpers.onSelectSnippet(snippet)}
-          {snippets}
-        />
+        <SnippetSidePanel {addSnippet} {snippets} />
       {/if}
     </div>
   </div>
diff --git a/packages/types/src/ui/bindings/binding.ts b/packages/types/src/ui/bindings/binding.ts
index bfe394aaf8..2cfb23ed2d 100644
--- a/packages/types/src/ui/bindings/binding.ts
+++ b/packages/types/src/ui/bindings/binding.ts
@@ -15,3 +15,12 @@ export enum BindingMode {
   Text = "Text",
   JavaScript = "JavaScript",
 }
+
+export type CaretPositionFn = () => { start: number; end: number }
+
+export type InsertAtPositionFn = (_: {
+  start: number
+  end?: number
+  value: string
+  cursor?: { anchor: number }
+}) => void
diff --git a/packages/types/src/ui/components/codeEditor.ts b/packages/types/src/ui/components/codeEditor.ts
index 8ea885b667..ffbea1d643 100644
--- a/packages/types/src/ui/components/codeEditor.ts
+++ b/packages/types/src/ui/components/codeEditor.ts
@@ -1,19 +1,26 @@
-type EditorMode =
-  | {
-      key: "JS"
-      name: "javascript"
-      json: boolean
-      match: RegExp
-    }
-  | {
-      key: "Handlebars"
-      name: "handlebars"
-      base: "text/html"
-      match: RegExp
-    }
-  | {
-      key: "Text"
-      name: "text/html"
-    }
+interface JSEditorMode {
+  name: "javascript"
+  json: boolean
+  match: RegExp
+}
 
-export type EditorModesMap = { [M in EditorMode as M["key"]]: Omit<M, "key"> }
+interface HBSEditorMode {
+  name: "handlebars"
+  base: "text/html"
+  match: RegExp
+}
+
+interface HTMLEditorMode {
+  name: "text/html"
+}
+
+export type EditorMode = JSEditorMode | HBSEditorMode | HTMLEditorMode
+
+type EditorModeMapBase =
+  | (JSEditorMode & { key: "JS" })
+  | (HBSEditorMode & { key: "Handlebars" })
+  | (HTMLEditorMode & { key: "Text" })
+
+export type EditorModesMap = {
+  [M in EditorModeMapBase as M["key"]]: Omit<M, "key">
+}