refactor(foundation): change menu action API (openscd#769)

JakobVogelsang · web-flow · commit 5368cf3a4b1d · 2022-05-24T10:30:39.000+02:00
* refactor(foundation): change menu action API

* fix(wizards/ied): add missing import statement
diff --git a/src/editors/templates/datype-wizards.ts b/src/editors/templates/datype-wizards.ts
@@ -18,12 +18,13 @@ import {
   EditorAction,
   getValue,
   identity,
+  newActionEvent,
   newSubWizardEvent,
+  newWizardEvent,
   patterns,
   Replace,
   selector,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
@@ -36,14 +37,17 @@ import {
 } from './foundation.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
 function openAddBda(parent: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => createBDAWizard(parent)];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => createBDAWizard(parent)));
   };
 }
 
diff --git a/src/editors/templates/dotype-wizards.ts b/src/editors/templates/dotype-wizards.ts
@@ -19,11 +19,12 @@ import {
   getValue,
   identity,
   isPublic,
+  newActionEvent,
   newSubWizardEvent,
+  newWizardEvent,
   Replace,
   selector,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
@@ -40,8 +41,11 @@ import {
 } from './foundation.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
@@ -296,14 +300,14 @@ export function createDOTypeWizard(
 }
 
 function openAddSdo(parent: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => sDOWizard({ parent })!];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => sDOWizard({ parent })!));
   };
 }
 
 function openAddDa(parent: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => createDaWizard(parent)!];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => createDaWizard(parent)!));
   };
 }
 
diff --git a/src/editors/templates/enumtype-wizard.ts b/src/editors/templates/enumtype-wizard.ts
@@ -18,21 +18,25 @@ import {
   getValue,
   identity,
   isPublic,
+  newActionEvent,
   newSubWizardEvent,
+  newWizardEvent,
   patterns,
   Replace,
   selector,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
 } from '../../foundation.js';
 import { CreateOptions, UpdateOptions, WizardOptions } from './foundation.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
@@ -250,8 +254,8 @@ export function createEnumTypeWizard(
 }
 
 function openAddEnumVal(parent: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => eNumValWizard({ parent })];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => eNumValWizard({ parent })));
   };
 }
 
diff --git a/src/editors/templates/lnodetype-wizard.ts b/src/editors/templates/lnodetype-wizard.ts
@@ -22,13 +22,13 @@ import {
   getValue,
   identity,
   isPublic,
+  newActionEvent,
   newSubWizardEvent,
   newWizardEvent,
   patterns,
   Replace,
   selector,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
@@ -44,14 +44,17 @@ import {
 } from './foundation.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
 function openAddDo(parent: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => dOWizard({ parent })!];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => dOWizard({ parent })!));
   };
 }
 
diff --git a/src/foundation.ts b/src/foundation.ts
@@ -293,7 +293,7 @@ interface WizardInputCheckbox extends WizardInputBase {
 }
 
 /** @returns [[`WizardAction`]]s to dispatch on [[`WizardDialog`]] menu action. */
-export type WizardMenuActor = () => WizardAction[];
+export type WizardMenuActor = (wizard: Element) => void;
 
 /** User interactions rendered in the wizard-dialog menu */
 export interface MenuAction {
diff --git a/src/wizard-dialog.ts b/src/wizard-dialog.ts
@@ -42,7 +42,6 @@ import {
   identity,
   WizardInput,
   WizardMenuActor,
-  newSubWizardEvent,
 } from './foundation.js';
 
 function renderWizardInput(
@@ -214,20 +213,11 @@ export class WizardDialog extends LitElement {
     return true;
   }
 
-  /** Triggers sub-wizard or editor-action with valid manu action */
-  async menuAct(action?: WizardMenuActor): Promise<boolean> {
-    if (!action) return false;
+  /** Triggers menu action callback */
+  async menuAct(action?: WizardMenuActor): Promise<void> {
+    if (!action) return;
 
-    const wizardActions = action();
-
-    wizardActions.forEach(wa => {
-      if (isWizardFactory(wa)) this.dispatchEvent(newSubWizardEvent(wa));
-      else {
-        this.dispatchEvent(newWizardEvent());
-        this.dispatchEvent(newActionEvent(wa));
-      }
-    });
-    return true;
+    action(this);
   }
 
   private onClosed(ae: CustomEvent<{ action: string } | null>): void {
diff --git a/src/wizards/bda.ts b/src/wizards/bda.ts
@@ -8,6 +8,8 @@ import {
   EditorAction,
   getValue,
   isPublic,
+  newActionEvent,
+  newWizardEvent,
   Wizard,
   WizardActor,
   WizardInputElement,
@@ -16,8 +18,11 @@ import {
 import { getValAction, wizardContent } from './abstractda.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
diff --git a/src/wizards/da.ts b/src/wizards/da.ts
@@ -12,6 +12,8 @@ import {
   EditorAction,
   getValue,
   isPublic,
+  newActionEvent,
+  newWizardEvent,
   Wizard,
   WizardActor,
   WizardInputElement,
@@ -21,8 +23,11 @@ import { getValAction, wizardContent } from './abstractda.js';
 import { functionalConstraintEnum } from './foundation/enums.js';
 
 function remove(element: Element): WizardMenuActor {
-  return (): EditorAction[] => {
-    return [{ old: { parent: element.parentElement!, element } }];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(
+      newActionEvent({ old: { parent: element.parentElement!, element } })
+    );
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
diff --git a/src/wizards/dataset.ts b/src/wizards/dataset.ts
@@ -18,12 +18,13 @@ import {
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
+  newSubWizardEvent,
 } from '../foundation.js';
 import { createFCDAsWizard } from './fcda.js';
 
 function openFcdaWizard(element: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => createFCDAsWizard(element)];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => createFCDAsWizard(element)));
   };
 }
 
diff --git a/src/wizards/gsecontrol.ts b/src/wizards/gsecontrol.ts
@@ -23,10 +23,11 @@ import {
   identity,
   isPublic,
   MenuAction,
+  newActionEvent,
   newSubWizardEvent,
+  newWizardEvent,
   selector,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
   WizardMenuActor,
@@ -432,22 +433,22 @@ export function removeGseControlAction(element: Element): ComplexAction | null {
 }
 
 export function removeGseControl(element: Element): WizardMenuActor {
-  return (): WizardAction[] => {
+  return (wizard: Element): void => {
     const complexAction = removeGseControlAction(element);
-    if (complexAction) return [complexAction];
-    return [];
+    if (complexAction) wizard.dispatchEvent(newActionEvent(complexAction));
+    wizard.dispatchEvent(newWizardEvent());
   };
 }
 
 function openDataSetWizard(element: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => editDataSetWizard(element)];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => editDataSetWizard(element)));
   };
 }
 
 function openGseWizard(element: Element): WizardMenuActor {
-  return (): WizardAction[] => {
-    return [() => editGseWizard(element)];
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(() => editGseWizard(element)));
   };
 }
 
diff --git a/src/wizards/ied.ts b/src/wizards/ied.ts
@@ -11,14 +11,15 @@ import {
   EditorAction,
   identity,
   isPublic,
+  newActionEvent,
+  newSubWizardEvent,
   newWizardEvent,
   Wizard,
-  WizardAction,
   WizardActor,
   WizardInputElement,
-  WizardMenuActor
+  WizardMenuActor,
 } from '../foundation.js';
-import { patterns } from "./foundation/limits.js";
+import { patterns } from './foundation/limits.js';
 
 import { updateNamingAttributeWithReferencesAction } from "./foundation/actions.js";
 import { deleteReferences } from "./foundation/references.js";
@@ -129,13 +130,16 @@ export function removeIEDWizard(element: Element): Wizard | null {
 
 export function editIEDWizard(element: Element): Wizard {
   function removeIED(element: Element): WizardMenuActor {
-    return (): WizardAction[] => {
-      const wizard = removeIEDWizard(element);
-      if (wizard) {
-        return [() => wizard];
-      }
+    return (wizard: Element): void => {
+      const removeWizard = removeIEDWizard(element);
+      if (removeWizard)
+        wizard.dispatchEvent(newSubWizardEvent(() => removeWizard));
+
       // If no Wizard is needed, just remove the element.
-      return [{ old: { parent: element.parentElement!, element } }];
+      wizard.dispatchEvent(
+        newActionEvent({ old: { parent: element.parentElement!, element } })
+      );
+      wizard.dispatchEvent(newWizardEvent());
     };
   }
 
diff --git a/src/wizards/reportcontrol.ts b/src/wizards/reportcontrol.ts
diff --git a/src/wizards/sampledvaluecontrol.ts b/src/wizards/sampledvaluecontrol.ts

Original file line number	Diff line number	Diff line change
`@@ -293,7 +293,7 @@ interface WizardInputCheckbox extends WizardInputBase {`
`293`	`293`	`}`
`294`	`294`
`295`	`295`	/** @returns [[`WizardAction`]]s to dispatch on [[`WizardDialog`]] menu action. */
`296`		`-export type WizardMenuActor = () => WizardAction[];`
	`296`	`+export type WizardMenuActor = (wizard: Element) => void;`
`297`	`297`
`298`	`298`	`/** User interactions rendered in the wizard-dialog menu */`
`299`	`299`	`export interface MenuAction {`