refactor(foundation): make reference within editor-action optional (#325

) * refactor(foundation): change EditorAction api make reference optional * refactor(Editor): get reference onAction with undefined reference * test(Editing): add integration test * fix(lnodetype-wizard): fix getReference with addig LNodeType from template * refactor(templates): remove reference from create actions * refactor(communication): remove reference from create actions * refactor(substation): remove reference from create action * refactor(templates): remove reference from create action * refactor(communication mapping): remove reference from create action * refactor(iedimport): remove reference from create action
openscd · Nov 18, 2021 · b4c69c5 · b4c69c5
1 parent 81e1d3d
commit b4c69c5
Show file tree

Hide file tree

Showing 27 changed files with 300 additions and 112 deletions.
diff --git a/src/Editing.ts b/src/Editing.ts
@@ -6,6 +6,7 @@ import {
   Delete,
   EditorAction,
   EditorActionEvent,
+  getReference,
   isCreate,
   isDelete,
   isMove,
@@ -17,6 +18,7 @@ import {
   newLogEvent,
   newValidateEvent,
   OpenDocEvent,
+  SCLTag,
   SimpleAction,
   Update,
 } from './foundation.js';
@@ -72,6 +74,12 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
     private onCreate(action: Create) {
       if (!this.checkCreateValidity(action)) return false;
 
+      if (action.new.reference === undefined)
+        action.new.reference = getReference(
+          action.new.parent,
+          <SCLTag>action.new.element.tagName
+        );
+
       action.new.parent.insertBefore(action.new.element, action.new.reference);
       return true;
     }
@@ -89,6 +97,9 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
     }
 
     private onDelete(action: Delete) {
+      if (!action.old.reference)
+        action.old.reference = action.old.element.nextSibling;
+
       action.old.element.remove();
       return true;
     }
@@ -138,6 +149,15 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
     private onMove(action: Move) {
       if (!this.checkMoveValidity(action)) return false;
 
+      if (!action.old.reference)
+        action.old.reference = action.old.element.nextSibling;
+
+      if (action.new.reference === undefined)
+        action.new.reference = getReference(
+          action.new.parent,
+          <SCLTag>action.old.element.tagName
+        );
+
       action.new.parent.insertBefore(action.old.element, action.new.reference);
       return true;
     }

diff --git a/src/editors/Communication.ts b/src/editors/Communication.ts
@@ -5,7 +5,6 @@ import {
   newWizardEvent,
   newActionEvent,
   createElement,
-  getReference,
 } from '../foundation.js';
 
 import { selectors, styles } from './communication/foundation.js';
@@ -25,7 +24,6 @@ export default class CommunicationPlugin extends LitElement {
         new: {
           parent: this.doc.documentElement,
           element: createElement(this.doc, 'Communication', {}),
-          reference: getReference(this.doc.documentElement, 'Communication'),
         },
       })
     );

diff --git a/src/editors/Templates.ts b/src/editors/Templates.ts
@@ -3,7 +3,6 @@ import { translate } from 'lit-translate';
 
 import {
   createElement,
-  getReference,
   identity,
   newActionEvent,
   newWizardEvent,
@@ -127,10 +126,6 @@ export default class TemplatesPlugin extends LitElement {
           new: {
             parent: this.doc.documentElement,
             element: createElement(this.doc, 'DataTypeTemplates', {}),
-            reference: getReference(
-              this.doc.documentElement,
-              'DataTypeTemplates'
-            ),
           },
         })
       );

diff --git a/src/editors/communication/connectedap-editor.ts b/src/editors/communication/connectedap-editor.ts
@@ -24,7 +24,6 @@ import {
   getValue,
   createElement,
   ComplexAction,
-  getReference,
 } from '../../foundation.js';
 
 import {
@@ -114,7 +113,6 @@ function createConnectedApAction(parent: Element): WizardActor {
               iedName: value.iedName,
               apName: value.apName,
             }),
-            reference: getReference(parent, 'ConnectedAP'),
           },
         }
     );
@@ -225,7 +223,6 @@ export function editConnectedApAction(parent: Element): WizardActor {
         new: {
           parent: parent,
           element: newAddress,
-          reference: getReference(parent, 'Address'),
         },
       });
 

diff --git a/src/editors/communication/subnetwork-editor.ts b/src/editors/communication/subnetwork-editor.ts
@@ -20,7 +20,6 @@ import {
   patterns,
   compareNames,
   createElement,
-  getReference,
   cloneElement,
 } from '../../foundation.js';
 
@@ -149,7 +148,6 @@ export function createSubNetworkAction(parent: Element): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, 'SubNetwork'),
       },
     };
 

diff --git a/src/editors/substation/guess-wizard.ts b/src/editors/substation/guess-wizard.ts
@@ -8,7 +8,6 @@ import {
   compareNames,
   createElement,
   EditorAction,
-  getReference,
   Wizard,
   WizardActor,
   WizardInput,
@@ -205,7 +204,6 @@ function guessBasedOnCSWI(doc: XMLDocument): WizardActor {
       new: {
         parent: substation,
         element: voltageLevel,
-        reference: getReference(substation, 'VoltageLevel'),
       },
     });
 

diff --git a/src/editors/templates/datype-wizards.ts b/src/editors/templates/datype-wizards.ts
@@ -4,13 +4,11 @@ import { get, translate } from 'lit-translate';
 import {
   Create,
   EditorAction,
-  getReference,
   getValue,
   identity,
   newActionEvent,
   newWizardEvent,
   patterns,
-  SCLTag,
   selector,
   Wizard,
   WizardActor,
@@ -167,7 +165,6 @@ function addPredefinedDAType(
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     });
 

diff --git a/src/editors/templates/dotype-wizards.ts b/src/editors/templates/dotype-wizards.ts
@@ -6,13 +6,11 @@ import {
   Create,
   createElement,
   EditorAction,
-  getReference,
   getValue,
   identity,
   isPublic,
   newActionEvent,
   newWizardEvent,
-  SCLTag,
   selector,
   Wizard,
   WizardActor,
@@ -74,7 +72,6 @@ function createSDoAction(parent: Element): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     });
 
@@ -216,7 +213,6 @@ function addPredefinedDOType(
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     });
 

diff --git a/src/editors/templates/enumtype-wizard.ts b/src/editors/templates/enumtype-wizard.ts
@@ -5,14 +5,12 @@ import {
   cloneElement,
   createElement,
   EditorAction,
-  getReference,
   getValue,
   identity,
   isPublic,
   newActionEvent,
   newWizardEvent,
   patterns,
-  SCLTag,
   selector,
   Wizard,
   WizardActor,
@@ -57,7 +55,6 @@ function createEnumValAction(parent: Element): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, 'EnumVal'),
       },
     };
 
@@ -195,7 +192,6 @@ function createAction(parent: Element, templates: XMLDocument): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     };
 

diff --git a/src/editors/templates/foundation.ts b/src/editors/templates/foundation.ts
@@ -5,10 +5,8 @@ import {
   cloneElement,
   Create,
   EditorAction,
-  getReference,
   getValue,
   isPublic,
-  SCLTag,
   WizardActor,
   WizardInput,
 } from '../../foundation.js';
@@ -98,7 +96,6 @@ export function addReferencedDataTypes(
       new: {
         parent,
         element: <Element>adjacent.cloneNode(true),
-        reference: getReference(parent, <SCLTag>adjacent.tagName),
       },
     });
   });

diff --git a/src/editors/templates/lnodetype-wizard.ts b/src/editors/templates/lnodetype-wizard.ts
@@ -7,14 +7,12 @@ import {
   createElement,
   EditorAction,
   getChildElementsByTagName,
-  getReference,
   getValue,
   identity,
   isPublic,
   newActionEvent,
   newWizardEvent,
   patterns,
-  SCLTag,
   selector,
   Wizard,
   WizardActor,
@@ -97,7 +95,6 @@ function createDoAction(parent: Element): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     });
 
@@ -271,7 +268,6 @@ function createNewLNodeType(parent: Element, element: Element): WizardActor {
         new: {
           parent: element,
           element: DO,
-          reference: getReference(element, <SCLTag>DO.tagName),
         },
       });
     });
@@ -280,7 +276,6 @@ function createNewLNodeType(parent: Element, element: Element): WizardActor {
       new: {
         parent,
         element,
-        reference: getReference(parent, <SCLTag>element.tagName),
       },
     });
 
@@ -358,7 +353,6 @@ function addPredefinedLNodeType(
     new: {
       parent,
       element: newLNodeType,
-      reference: getReference(parent, 'LNodeType'),
     },
   });
 

diff --git a/src/foundation.ts b/src/foundation.ts
@@ -19,20 +19,20 @@ export type ComplexAction = {
 export type EditorAction = SimpleAction | ComplexAction;
 /** Inserts `new.element` to `new.parent` before `new.reference`. */
 export interface Create {
-  new: { parent: Element; element: Element; reference: Node | null };
+  new: { parent: Element; element: Element; reference?: Node | null };
   derived?: boolean;
   checkValidity?: () => boolean;
 }
 /** Removes `old.element` from `old.parent` before `old.reference`. */
 export interface Delete {
-  old: { parent: Element; element: Element; reference: Node | null };
+  old: { parent: Element; element: Element; reference?: Node | null };
   derived?: boolean;
   checkValidity?: () => boolean;
 }
 /** Reparents of `old.element` to `new.parent` before `new.reference`. */
 export interface Move {
-  old: { parent: Element; element: Element; reference: Node | null };
-  new: { parent: Element; reference: Node | null };
+  old: { parent: Element; element: Element; reference?: Node | null };
+  new: { parent: Element; reference?: Node | null };
   derived?: boolean;
   checkValidity?: () => boolean;
 }
@@ -48,26 +48,22 @@ export function isCreate(action: EditorAction): action is Create {
   return (
     (action as Update).old === undefined &&
     (action as Create).new?.parent !== undefined &&
-    (action as Create).new?.element !== undefined &&
-    (action as Create).new?.reference !== undefined
+    (action as Create).new?.element !== undefined
   );
 }
 export function isDelete(action: EditorAction): action is Delete {
   return (
     (action as Delete).old?.parent !== undefined &&
     (action as Delete).old?.element !== undefined &&
-    (action as Delete).old?.reference !== undefined &&
     (action as Update).new === undefined
   );
 }
 export function isMove(action: EditorAction): action is Move {
   return (
     (action as Move).old?.parent !== undefined &&
     (action as Move).old?.element !== undefined &&
-    (action as Move).old?.reference !== undefined &&
     (action as Move).new?.parent !== undefined &&
-    (action as Update).new?.element == undefined &&
-    (action as Move).new?.reference !== undefined
+    (action as Update).new?.element == undefined
   );
 }
 export function isUpdate(action: EditorAction): action is Update {