From 432e0a5079576788b59d0424abe444a30da6240c Mon Sep 17 00:00:00 2001
From: Henrik Giesel <hengiesel@gmail.com>
Date: Fri, 9 Apr 2021 18:59:57 +0200
Subject: [PATCH] Introduce ToolbarItem as a better base type instead of
 DynamicSvelteComponent

---
 ts/editor-toolbar/ButtonDropdown.svelte   |  4 +--
 ts/editor-toolbar/ButtonGroup.d.ts        |  4 +--
 ts/editor-toolbar/ButtonGroup.svelte      | 13 ++-----
 ts/editor-toolbar/DropdownMenu.d.ts       |  4 +--
 ts/editor-toolbar/EditorToolbar.svelte    |  6 ++--
 ts/editor-toolbar/WithDropdownMenu.d.ts   |  4 +--
 ts/editor-toolbar/WithDropdownMenu.svelte |  4 +--
 ts/editor-toolbar/index.ts                | 43 ++++++++++-------------
 ts/editor-toolbar/types.d.ts              |  8 +++++
 9 files changed, 42 insertions(+), 48 deletions(-)
 create mode 100644 ts/editor-toolbar/types.d.ts

diff --git a/ts/editor-toolbar/ButtonDropdown.svelte b/ts/editor-toolbar/ButtonDropdown.svelte
index 0bd366887..ad050ce22 100644
--- a/ts/editor-toolbar/ButtonDropdown.svelte
+++ b/ts/editor-toolbar/ButtonDropdown.svelte
@@ -1,5 +1,5 @@
 <script lang="typescript">
-    import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+    import type { ToolbarItem } from "./types";
     import ButtonGroup from "./ButtonGroup.svelte";
 
     export let id = "";
@@ -9,7 +9,7 @@
         return `dropdown-menu bg-transparent border-0 ${className}`;
     }
 
-    export let buttons: DynamicSvelteComponent[];
+    export let buttons: ToolbarItem[];
 </script>
 
 <ButtonGroup {id} className={extendClassName(className)} {buttons} {...$$restProps} />
diff --git a/ts/editor-toolbar/ButtonGroup.d.ts b/ts/editor-toolbar/ButtonGroup.d.ts
index d4131ce9d..6a762eaa3 100644
--- a/ts/editor-toolbar/ButtonGroup.d.ts
+++ b/ts/editor-toolbar/ButtonGroup.d.ts
@@ -1,7 +1,7 @@
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { ToolbarItem } from "./types";
 
 export interface ButtonGroupProps {
     id: string;
     className?: string;
-    buttons: DynamicSvelteComponent[];
+    buttons: ToolbarItem[];
 }
diff --git a/ts/editor-toolbar/ButtonGroup.svelte b/ts/editor-toolbar/ButtonGroup.svelte
index 23c0d0179..fd6e38b19 100644
--- a/ts/editor-toolbar/ButtonGroup.svelte
+++ b/ts/editor-toolbar/ButtonGroup.svelte
@@ -1,18 +1,11 @@
 <script lang="typescript">
-    import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
-
-    interface Hidden {
-        hidden: boolean;
-    }
+    import type { ToolbarItem } from "./types";
 
     export let id;
     export let className = "";
-    export let buttons: DynamicSvelteComponent<Hidden>[];
+    export let buttons: ToolbarItem[];
 
-    function filterHidden({
-        hidden,
-        ...props
-    }: DynamicSvelteComponent & Hidden): DynamicSvelteComponent {
+    function filterHidden({ hidden, ...props }) {
         return props;
     }
 </script>
diff --git a/ts/editor-toolbar/DropdownMenu.d.ts b/ts/editor-toolbar/DropdownMenu.d.ts
index 0961d680a..1805a3ba7 100644
--- a/ts/editor-toolbar/DropdownMenu.d.ts
+++ b/ts/editor-toolbar/DropdownMenu.d.ts
@@ -1,6 +1,6 @@
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { ToolbarItem } from "./types";
 
 export interface DropdownMenuProps {
     id: string;
-    menuItems: DynamicSvelteComponent[];
+    menuItems: ToolbarItem[];
 }
diff --git a/ts/editor-toolbar/EditorToolbar.svelte b/ts/editor-toolbar/EditorToolbar.svelte
index 0bb9a4caf..49e73d52f 100644
--- a/ts/editor-toolbar/EditorToolbar.svelte
+++ b/ts/editor-toolbar/EditorToolbar.svelte
@@ -14,14 +14,14 @@
 
 <script lang="typescript">
     import type { Readable } from "svelte/store";
-    import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+    import type { ToolbarItem } from "./types";
     import { setContext } from "svelte";
     import { disabledKey, nightModeKey } from "./contextKeys";
 
     import ButtonGroup from "./ButtonGroup.svelte";
 
-    export let buttons: Readable<DynamicSvelteComponent[]>;
-    export let menus: Readable<DynamicSvelteComponent[]>;
+    export let buttons: Readable<ToolbarItem[]>;
+    export let menus: Readable<ToolbarItem[]>;
 
     $: _buttons = $buttons;
     $: _menus = $menus;
diff --git a/ts/editor-toolbar/WithDropdownMenu.d.ts b/ts/editor-toolbar/WithDropdownMenu.d.ts
index ecdb702a7..fc5c3e928 100644
--- a/ts/editor-toolbar/WithDropdownMenu.d.ts
+++ b/ts/editor-toolbar/WithDropdownMenu.d.ts
@@ -1,6 +1,6 @@
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { ToolbarItem } from "./types";
 
 export interface WithDropdownMenuProps {
-    button: DynamicSvelteComponent;
+    button: ToolbarItem;
     menuId: string;
 }
diff --git a/ts/editor-toolbar/WithDropdownMenu.svelte b/ts/editor-toolbar/WithDropdownMenu.svelte
index 8e9f7f40f..a8d2abbae 100644
--- a/ts/editor-toolbar/WithDropdownMenu.svelte
+++ b/ts/editor-toolbar/WithDropdownMenu.svelte
@@ -1,7 +1,7 @@
 <script lang="typescript">
-    import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+    import type { ToolbarItem } from "./types";
 
-    export let button: DynamicSvelteComponent;
+    export let button: ToolbarItem;
     export let menuId: string;
 
     function extend({
diff --git a/ts/editor-toolbar/index.ts b/ts/editor-toolbar/index.ts
index e61b904be..e3b40d1b3 100644
--- a/ts/editor-toolbar/index.ts
+++ b/ts/editor-toolbar/index.ts
@@ -1,5 +1,5 @@
-import type { SvelteComponent } from "svelte";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { SvelteComponentDev } from "svelte/internal";
+import type { ToolbarItem } from "./types";
 
 import ButtonGroup from "./ButtonGroup.svelte";
 import type { ButtonGroupProps } from "./ButtonGroup";
@@ -38,12 +38,10 @@ function toggleComponent(component: Hideable) {
 const buttonGroup = dynamicComponent<typeof ButtonGroup, ButtonGroupProps>(ButtonGroup);
 
 class EditorToolbar extends HTMLElement {
-    component?: SvelteComponent;
+    component?: SvelteComponentDev;
 
-    buttons?: Writable<
-        (DynamicSvelteComponent<typeof ButtonGroup> & ButtonGroupProps)[]
-    >;
-    menus?: Writable<DynamicSvelteComponent[]>;
+    buttons?: Writable<(ToolbarItem<typeof ButtonGroup> & ButtonGroupProps)[]>;
+    menus?: Writable<ToolbarItem[]>;
 
     connectedCallback(): void {
         setupI18n({ modules: [ModuleName.EDITING] }).then(() => {
@@ -68,7 +66,7 @@ class EditorToolbar extends HTMLElement {
 
     updateButtonGroup<T>(
         update: (
-            component: DynamicSvelteComponent<typeof ButtonGroup> & ButtonGroupProps & T
+            component: ToolbarItem<typeof ButtonGroup> & ButtonGroupProps & T
         ) => void,
         group: string | number
     ): void {
@@ -77,9 +75,7 @@ class EditorToolbar extends HTMLElement {
 
             if (foundGroup) {
                 update(
-                    foundGroup as DynamicSvelteComponent<typeof ButtonGroup> &
-                        ButtonGroupProps &
-                        T
+                    foundGroup as ToolbarItem<typeof ButtonGroup> & ButtonGroupProps & T
                 );
             }
 
@@ -113,43 +109,40 @@ class EditorToolbar extends HTMLElement {
         });
     }
 
-    updateButton<T>(
-        update: (component: DynamicSvelteComponent & T) => void,
+    updateButton(
+        update: (component: ToolbarItem) => void,
         group: string | number,
         button: string | number
     ): void {
         this.updateButtonGroup((foundGroup) => {
-            const foundButton = search(
-                foundGroup.buttons as (DynamicSvelteComponent & Identifiable)[],
-                button
-            );
+            const foundButton = search(foundGroup.buttons, button);
 
             if (foundButton) {
-                update(foundButton as DynamicSvelteComponent & T);
+                update(foundButton);
             }
         }, group);
     }
 
     showButton(group: string | number, button: string | number): void {
-        this.updateButton<Hideable>(showComponent, group, button);
+        this.updateButton(showComponent, group, button);
     }
 
     hideButton(group: string | number, button: string | number): void {
-        this.updateButton<Hideable>(hideComponent, group, button);
+        this.updateButton(hideComponent, group, button);
     }
 
     toggleButton(group: string | number, button: string | number): void {
-        this.updateButton<Hideable>(toggleComponent, group, button);
+        this.updateButton(toggleComponent, group, button);
     }
 
     insertButton(
-        newButton: DynamicSvelteComponent & Identifiable,
+        newButton: ToolbarItem & Identifiable,
         group: string | number,
         button: string | number = 0
     ) {
         this.updateButtonGroup((component) => {
             component.buttons = insert(
-                component.buttons as (DynamicSvelteComponent & Identifiable)[],
+                component.buttons as (ToolbarItem & Identifiable)[],
                 newButton,
                 button
             );
@@ -157,13 +150,13 @@ class EditorToolbar extends HTMLElement {
     }
 
     addButton(
-        newButton: DynamicSvelteComponent & Identifiable,
+        newButton: ToolbarItem & Identifiable,
         group: string | number,
         button: string | number = -1
     ) {
         this.updateButtonGroup((component) => {
             component.buttons = add(
-                component.buttons as (DynamicSvelteComponent & Identifiable)[],
+                component.buttons as (ToolbarItem & Identifiable)[],
                 newButton,
                 button
             );
diff --git a/ts/editor-toolbar/types.d.ts b/ts/editor-toolbar/types.d.ts
new file mode 100644
index 000000000..8b5e24218
--- /dev/null
+++ b/ts/editor-toolbar/types.d.ts
@@ -0,0 +1,8 @@
+import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { SvelteComponentDev } from "svelte/internal";
+
+interface ToolbarItem<T extends typeof SvelteComponentDev = typeof SvelteComponentDev>
+    extends DynamicSvelteComponent<T> {
+    id?: string;
+    hidden?: boolean;
+}