From bda99ee0f113773dd44bc3c5f5d2f4c53d28fdea Mon Sep 17 00:00:00 2001
From: Henrik Giesel <hengiesel@gmail.com>
Date: Fri, 23 Apr 2021 18:53:52 +0200
Subject: [PATCH] Add IterableToolbarItem interface for easier typing

---
 qt/aqt/editor.py                           |  2 +-
 ts/editor-toolbar/ButtonDropdown.d.ts      |  2 +-
 ts/editor-toolbar/ButtonDropdown.svelte    |  4 ++--
 ts/editor-toolbar/ButtonGroup.d.ts         |  2 +-
 ts/editor-toolbar/ButtonGroup.svelte       |  4 ++--
 ts/editor-toolbar/DropdownMenu.d.ts        |  2 +-
 ts/editor-toolbar/DropdownMenu.svelte      |  4 ++--
 ts/editor-toolbar/EditorToolbar.svelte     |  8 +++-----
 ts/editor-toolbar/SelectButton.d.ts        |  3 ---
 ts/editor-toolbar/identifiable.ts          |  6 ++----
 ts/editor-toolbar/index.ts                 | 10 +++++-----
 ts/editor-toolbar/{types.d.ts => types.ts} | 11 +++++++++--
 ts/editor/cloze.ts                         |  7 ++-----
 ts/editor/color.ts                         |  9 +++------
 ts/editor/formatBlock.ts                   | 21 +++++++--------------
 ts/editor/formatInline.ts                  |  9 +++------
 ts/editor/notetype.ts                      |  9 +++------
 ts/editor/template.ts                      | 16 +++++-----------
 ts/editor/toolbar.ts                       | 10 +++-------
 19 files changed, 55 insertions(+), 84 deletions(-)
 rename ts/editor-toolbar/{types.d.ts => types.ts} (50%)

diff --git a/qt/aqt/editor.py b/qt/aqt/editor.py
index 0b0f9ce07..9ab134b6b 100644
--- a/qt/aqt/editor.py
+++ b/qt/aqt/editor.py
@@ -175,7 +175,7 @@ class Editor:
             f"""
 $editorToolbar.addButtonGroup({{
   id: "addons",
-  buttons: [ {righttopbtns_defs} ]
+  items: [ {righttopbtns_defs} ]
 }});
 """
             if righttopbtns_defs
diff --git a/ts/editor-toolbar/ButtonDropdown.d.ts b/ts/editor-toolbar/ButtonDropdown.d.ts
index ad869013e..2b3cdb70f 100644
--- a/ts/editor-toolbar/ButtonDropdown.d.ts
+++ b/ts/editor-toolbar/ButtonDropdown.d.ts
@@ -5,5 +5,5 @@ import type { ToolbarItem } from "./types";
 export interface ButtonDropdownProps {
     id: string;
     className?: string;
-    buttons: ToolbarItem[];
+    items: ToolbarItem[];
 }
diff --git a/ts/editor-toolbar/ButtonDropdown.svelte b/ts/editor-toolbar/ButtonDropdown.svelte
index 0db3df397..344757c59 100644
--- a/ts/editor-toolbar/ButtonDropdown.svelte
+++ b/ts/editor-toolbar/ButtonDropdown.svelte
@@ -13,7 +13,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
         return `dropdown-menu btn-dropdown-menu py-1 mb-0 ${className}`;
     }
 
-    export let buttons: ToolbarItem[];
+    export let items: ToolbarItem[];
 </script>
 
 <style>
@@ -24,4 +24,4 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     }
 </style>
 
-<ButtonGroup {id} className={extendClassName(className)} {buttons} />
+<ButtonGroup {id} className={extendClassName(className)} {items} />
diff --git a/ts/editor-toolbar/ButtonGroup.d.ts b/ts/editor-toolbar/ButtonGroup.d.ts
index e4a2d7ce5..cbf4376ff 100644
--- a/ts/editor-toolbar/ButtonGroup.d.ts
+++ b/ts/editor-toolbar/ButtonGroup.d.ts
@@ -5,5 +5,5 @@ import type { ToolbarItem } from "./types";
 export interface ButtonGroupProps {
     id: string;
     className?: string;
-    buttons: ToolbarItem[];
+    items: ToolbarItem[];
 }
diff --git a/ts/editor-toolbar/ButtonGroup.svelte b/ts/editor-toolbar/ButtonGroup.svelte
index fc8130b7e..b1d47e36a 100644
--- a/ts/editor-toolbar/ButtonGroup.svelte
+++ b/ts/editor-toolbar/ButtonGroup.svelte
@@ -9,7 +9,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
     export let id: string | undefined = undefined;
     export let className = "";
-    export let buttons: ToolbarItem[];
+    export let items: ToolbarItem[];
 
     function filterHidden({ hidden = false, ...props }) {
         return props;
@@ -73,7 +73,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 </style>
 
 <ul {id} class={className} class:border-overlap-group={!nightMode}>
-    {#each buttons as button}
+    {#each items as button}
         {#if !button.hidden}
             <li class:gap-item={nightMode}>
                 <svelte:component this={button.component} {...filterHidden(button)} />
diff --git a/ts/editor-toolbar/DropdownMenu.d.ts b/ts/editor-toolbar/DropdownMenu.d.ts
index 9e43bc953..7d6b6fac9 100644
--- a/ts/editor-toolbar/DropdownMenu.d.ts
+++ b/ts/editor-toolbar/DropdownMenu.d.ts
@@ -4,5 +4,5 @@ import type { ToolbarItem } from "./types";
 
 export interface DropdownMenuProps {
     id: string;
-    menuItems: ToolbarItem[];
+    items: ToolbarItem[];
 }
diff --git a/ts/editor-toolbar/DropdownMenu.svelte b/ts/editor-toolbar/DropdownMenu.svelte
index 546b2d78f..4fdfcadce 100644
--- a/ts/editor-toolbar/DropdownMenu.svelte
+++ b/ts/editor-toolbar/DropdownMenu.svelte
@@ -8,7 +8,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     import { nightModeKey } from "./contextKeys";
 
     export let id: string;
-    export let menuItems: DynamicSvelteComponent[];
+    export let items: ToolbarItem[];
 
     const nightMode = getContext<boolean>(nightModeKey);
 </script>
@@ -27,7 +27,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 </style>
 
 <ul {id} class="dropdown-menu" class:night-mode={nightMode}>
-    {#each menuItems as menuItem}
+    {#each items as menuItem}
         <li>
             <svelte:component this={menuItem.component} {...menuItem} />
         </li>
diff --git a/ts/editor-toolbar/EditorToolbar.svelte b/ts/editor-toolbar/EditorToolbar.svelte
index 676fb260d..5bfc09b2d 100644
--- a/ts/editor-toolbar/EditorToolbar.svelte
+++ b/ts/editor-toolbar/EditorToolbar.svelte
@@ -19,16 +19,14 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
 <script lang="typescript">
     import type { Readable } from "svelte/store";
-    import type { ToolbarItem } from "./types";
+    import type { ToolbarItem, IterableToolbarItem } from "./types";
     import { setContext } from "svelte";
     import { disabledKey, nightModeKey } from "./contextKeys";
 
     import ButtonGroup from "./ButtonGroup.svelte";
     import type { ButtonGroupProps } from "./ButtonGroup";
 
-    export let buttons: Readable<
-        (ToolbarItem<typeof ButtonGroup> & ButtonGroupProps)[]
-    >;
+    export let buttons: Readable<IterableToolbarItem>[];
     export let menus: Readable<ToolbarItem[]>;
 
     $: _buttons = $buttons;
@@ -77,5 +75,5 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 </div>
 
 <nav {style}>
-    <ButtonGroup buttons={_buttons} className="mt-0" />
+    <ButtonGroup items={_buttons} className="mt-0" />
 </nav>
diff --git a/ts/editor-toolbar/SelectButton.d.ts b/ts/editor-toolbar/SelectButton.d.ts
index 854f7eb97..d82ad0ab1 100644
--- a/ts/editor-toolbar/SelectButton.d.ts
+++ b/ts/editor-toolbar/SelectButton.d.ts
@@ -1,7 +1,5 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type { ToolbarItem } from "./types";
-
 export interface Option {
     label: string;
     value: string;
@@ -12,7 +10,6 @@ export interface SelectButtonProps {
     id: string;
     className?: string;
     tooltip?: string;
-    buttons: ToolbarItem[];
     disables: boolean;
     options: Option[];
 }
diff --git a/ts/editor-toolbar/identifiable.ts b/ts/editor-toolbar/identifiable.ts
index 334222022..7b708c983 100644
--- a/ts/editor-toolbar/identifiable.ts
+++ b/ts/editor-toolbar/identifiable.ts
@@ -12,11 +12,9 @@ function normalize<T extends Identifiable>(
 
     if (typeof idOrIndex === "string") {
         normalizedIndex = values.findIndex((value) => value.id === idOrIndex);
-    }
-    else if (idOrIndex < 0) {
+    } else if (idOrIndex < 0) {
         normalizedIndex = values.length + idOrIndex;
-    }
-    else {
+    } else {
         normalizedIndex = idOrIndex;
     }
 
diff --git a/ts/editor-toolbar/index.ts b/ts/editor-toolbar/index.ts
index e08cbe6db..e1fddd15b 100644
--- a/ts/editor-toolbar/index.ts
+++ b/ts/editor-toolbar/index.ts
@@ -134,7 +134,7 @@ export class EditorToolbar extends HTMLElement {
         button: string | number
     ): void {
         this.updateButtonGroup((foundGroup) => {
-            const foundButton = search(foundGroup.buttons, button);
+            const foundButton = search(foundGroup.items, button);
 
             if (foundButton) {
                 update(foundButton);
@@ -160,8 +160,8 @@ export class EditorToolbar extends HTMLElement {
         button: string | number = 0
     ): void {
         this.updateButtonGroup((component) => {
-            component.buttons = insert(
-                component.buttons as (ToolbarItem & Identifiable)[],
+            component.items = insert(
+                component.items as (ToolbarItem & Identifiable)[],
                 newButton,
                 button
             );
@@ -174,8 +174,8 @@ export class EditorToolbar extends HTMLElement {
         button: string | number = -1
     ): void {
         this.updateButtonGroup((component) => {
-            component.buttons = add(
-                component.buttons as (ToolbarItem & Identifiable)[],
+            component.items = add(
+                component.items as (ToolbarItem & Identifiable)[],
                 newButton,
                 button
             );
diff --git a/ts/editor-toolbar/types.d.ts b/ts/editor-toolbar/types.ts
similarity index 50%
rename from ts/editor-toolbar/types.d.ts
rename to ts/editor-toolbar/types.ts
index a272d405d..ef4b39a31 100644
--- a/ts/editor-toolbar/types.d.ts
+++ b/ts/editor-toolbar/types.ts
@@ -3,8 +3,15 @@
 import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
 import type { SvelteComponentDev } from "svelte/internal";
 
-interface ToolbarItem<T extends typeof SvelteComponentDev = typeof SvelteComponentDev>
-    extends DynamicSvelteComponent<T> {
+export interface ToolbarItem<
+    T extends typeof SvelteComponentDev = typeof SvelteComponentDev
+> extends DynamicSvelteComponent<T> {
     id?: string;
     hidden?: boolean;
 }
+
+export interface IterableToolbarItem<
+    T extends typeof SvelteComponentDev = typeof SvelteComponentDev
+> extends ToolbarItem<T> {
+    items: ToolbarItem[];
+}
diff --git a/ts/editor/cloze.ts b/ts/editor/cloze.ts
index 055c3fb25..4de47c97c 100644
--- a/ts/editor/cloze.ts
+++ b/ts/editor/cloze.ts
@@ -1,8 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type WithShortcut from "editor-toolbar/WithShortcut.svelte";
-import type { WithShortcutProps } from "editor-toolbar/WithShortcut";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { ToolbarItem } from "editor-toolbar/types";
 
 import * as tr from "lib/i18n";
 import { iconButton, withShortcut } from "editor-toolbar/dynamicComponents";
@@ -40,8 +38,7 @@ function onCloze(event: KeyboardEvent | MouseEvent): void {
     wrap(`{{c${highestCloze}::`, "}}");
 }
 
-export function getClozeButton(): DynamicSvelteComponent<typeof WithShortcut> &
-    WithShortcutProps {
+export function getClozeButton(): ToolbarItem {
     return withShortcut({
         id: "cloze",
         shortcut: "Control+Shift+KeyC",
diff --git a/ts/editor/color.ts b/ts/editor/color.ts
index eb615258e..4923b8403 100644
--- a/ts/editor/color.ts
+++ b/ts/editor/color.ts
@@ -1,8 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { IterableToolbarItem } from "editor-toolbar/types";
 
 import {
     iconButton,
@@ -29,8 +27,7 @@ function wrapWithForecolor(color: string): void {
     document.execCommand("forecolor", false, color);
 }
 
-export function getColorGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
-    ButtonGroupProps {
+export function getColorGroup(): IterableToolbarItem {
     const forecolorButton = withShortcut({
         shortcut: "F7",
         button: iconButton({
@@ -52,6 +49,6 @@ export function getColorGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
 
     return buttonGroup({
         id: "color",
-        buttons: [forecolorButton, colorpickerButton],
+        items: [forecolorButton, colorpickerButton],
     });
 }
diff --git a/ts/editor/formatBlock.ts b/ts/editor/formatBlock.ts
index 192fd4759..e65c65572 100644
--- a/ts/editor/formatBlock.ts
+++ b/ts/editor/formatBlock.ts
@@ -1,11 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
-import type ButtonDropdown from "editor-toolbar/ButtonDropdown.svelte";
-import type { ButtonDropdownProps } from "editor-toolbar/ButtonDropdown";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
-
+import type { IterableToolbarItem } from "editor-toolbar/types";
 import type { EditingArea } from "./editingArea";
 
 import * as tr from "lib/i18n";
@@ -45,8 +40,7 @@ const indentListItem = () => {
     }
 };
 
-export function getFormatBlockMenus(): (DynamicSvelteComponent<typeof ButtonDropdown> &
-    ButtonDropdownProps)[] {
+export function getFormatBlockMenus(): IterableToolbarItem[] {
     const justifyLeftButton = commandIconButton({
         icon: justifyLeftIcon,
         command: "justifyLeft",
@@ -73,7 +67,7 @@ export function getFormatBlockMenus(): (DynamicSvelteComponent<typeof ButtonDrop
 
     const justifyGroup = buttonGroup({
         id: "justify",
-        buttons: [
+        items: [
             justifyLeftButton,
             justifyCenterButton,
             justifyRightButton,
@@ -95,19 +89,18 @@ export function getFormatBlockMenus(): (DynamicSvelteComponent<typeof ButtonDrop
 
     const indentationGroup = buttonGroup({
         id: "indentation",
-        buttons: [outdentButton, indentButton],
+        items: [outdentButton, indentButton],
     });
 
     const formattingOptions = buttonDropdown({
         id: "listFormatting",
-        buttons: [justifyGroup, indentationGroup],
+        items: [justifyGroup, indentationGroup],
     });
 
     return [formattingOptions];
 }
 
-export function getFormatBlockGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
-    ButtonGroupProps {
+export function getFormatBlockGroup(): IterableToolbarItem {
     const ulButton = commandIconButton({
         icon: ulIcon,
         command: "insertUnorderedList",
@@ -131,6 +124,6 @@ export function getFormatBlockGroup(): DynamicSvelteComponent<typeof ButtonGroup
 
     return buttonGroup({
         id: "blockFormatting",
-        buttons: [ulButton, olButton, listFormatting],
+        items: [ulButton, olButton, listFormatting],
     });
 }
diff --git a/ts/editor/formatInline.ts b/ts/editor/formatInline.ts
index f8ed9fb27..280053d60 100644
--- a/ts/editor/formatInline.ts
+++ b/ts/editor/formatInline.ts
@@ -1,8 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { IterableToolbarItem } from "editor-toolbar/types";
 
 import * as tr from "lib/i18n";
 import {
@@ -19,8 +17,7 @@ import superscriptIcon from "./format-superscript.svg";
 import subscriptIcon from "./format-subscript.svg";
 import eraserIcon from "./eraser.svg";
 
-export function getFormatInlineGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
-    ButtonGroupProps {
+export function getFormatInlineGroup(): IterableToolbarItem {
     const boldButton = withShortcut({
         shortcut: "Control+KeyB",
         button: commandIconButton({
@@ -79,7 +76,7 @@ export function getFormatInlineGroup(): DynamicSvelteComponent<typeof ButtonGrou
 
     return buttonGroup({
         id: "inlineFormatting",
-        buttons: [
+        items: [
             boldButton,
             italicButton,
             underlineButton,
diff --git a/ts/editor/notetype.ts b/ts/editor/notetype.ts
index ac503da86..fe570a8a1 100644
--- a/ts/editor/notetype.ts
+++ b/ts/editor/notetype.ts
@@ -1,8 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { IterableToolbarItem } from "editor-toolbar/types";
 
 import { bridgeCommand } from "lib/bridgecommand";
 import * as tr from "lib/i18n";
@@ -12,8 +10,7 @@ import {
     withShortcut,
 } from "editor-toolbar/dynamicComponents";
 
-export function getNotetypeGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
-    ButtonGroupProps {
+export function getNotetypeGroup(): IterableToolbarItem {
     const fieldsButton = labelButton({
         onClick: () => bridgeCommand("fields"),
         disables: false,
@@ -33,6 +30,6 @@ export function getNotetypeGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
 
     return buttonGroup({
         id: "notetype",
-        buttons: [fieldsButton, cardsButton],
+        items: [fieldsButton, cardsButton],
     });
 }
diff --git a/ts/editor/template.ts b/ts/editor/template.ts
index ffee8f1db..f43e1f677 100644
--- a/ts/editor/template.ts
+++ b/ts/editor/template.ts
@@ -1,10 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type DropdownMenu from "editor-toolbar/DropdownMenu.svelte";
-import type { DropdownMenuProps } from "editor-toolbar/DropdownMenu";
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
-import type { DynamicSvelteComponent } from "sveltelib/dynamicComponent";
+import type { IterableToolbarItem } from "editor-toolbar/types";
 
 import { bridgeCommand } from "lib/bridgecommand";
 import {
@@ -40,8 +36,7 @@ function onHtmlEdit(): void {
 
 const mathjaxMenuId = "mathjaxMenu";
 
-export function getTemplateGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
-    ButtonGroupProps {
+export function getTemplateGroup(): IterableToolbarItem {
     const attachmentButton = withShortcut({
         shortcut: "F3",
         button: iconButton({
@@ -80,7 +75,7 @@ export function getTemplateGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
 
     return buttonGroup({
         id: "template",
-        buttons: [
+        items: [
             attachmentButton,
             recordButton,
             getClozeButton(),
@@ -90,8 +85,7 @@ export function getTemplateGroup(): DynamicSvelteComponent<typeof ButtonGroup> &
     });
 }
 
-export function getTemplateMenus(): (DynamicSvelteComponent<typeof DropdownMenu> &
-    DropdownMenuProps)[] {
+export function getTemplateMenus(): IterableToolbarItem[] {
     const mathjaxMenuItems = [
         withShortcut({
             shortcut: "Control+KeyM, KeyM",
@@ -142,7 +136,7 @@ export function getTemplateMenus(): (DynamicSvelteComponent<typeof DropdownMenu>
 
     const mathjaxMenu = dropdownMenu({
         id: mathjaxMenuId,
-        menuItems: [...mathjaxMenuItems, ...latexMenuItems],
+        items: [...mathjaxMenuItems, ...latexMenuItems],
     });
 
     return [mathjaxMenu];
diff --git a/ts/editor/toolbar.ts b/ts/editor/toolbar.ts
index d03e20490..244b9dbe3 100644
--- a/ts/editor/toolbar.ts
+++ b/ts/editor/toolbar.ts
@@ -1,8 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-import type { ToolbarItem } from "editor-toolbar/types";
-import type ButtonGroup from "editor-toolbar/ButtonGroup.svelte";
-import type { ButtonGroupProps } from "editor-toolbar/ButtonGroup";
+import type { ToolbarItem, IterableToolbarItem } from "editor-toolbar/types";
 import type { Writable } from "svelte/store";
 
 import { getNotetypeGroup } from "./notetype";
@@ -16,10 +14,8 @@ export function initToolbar(i18n: Promise<void>): void {
         i18n.then(() => {
             globalThis.$editorToolbar.buttonsPromise.then(
                 (
-                    buttons: Writable<
-                        (ToolbarItem<typeof ButtonGroup> & ButtonGroupProps)[]
-                    >
-                ): Writable<(ToolbarItem<typeof ButtonGroup> & ButtonGroupProps)[]> => {
+                    buttons: Writable<IterableToolbarItem[]>
+                ): Writable<IterableToolbarItem[]> => {
                     buttons.update(() => [
                         getNotetypeGroup(),
                         getFormatInlineGroup(),