Merge pull request #127 from com-pas/upstream-v0.11

Merge Upstream v0.11.0 into CoMPAS

Author: Rob Tjalma

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.11.0](https://github.com/openscd/open-scd/compare/v0.10.0...v0.11.0) (2022-03-08)
+
+
+### Features
+
+* **plugins/IED:** Added Functional Constraint value to DA Container. ([f389c2c](https://github.com/openscd/open-scd/commits/f389c2cf7595f9c2486dff0ef0f40a5feff028fb))
+* **wizards/reportcontrol:** add create wizard ([#544](https://github.com/openscd/open-scd/issues/544)) ([546419f](https://github.com/openscd/open-scd/commits/546419f31afe82ebf1315e2acce59e11f97d8ca8))
+* **wizards/smvopts:** add edit wizard ([#547](https://github.com/openscd/open-scd/issues/547)) ([10343c6](https://github.com/openscd/open-scd/commits/10343c605bcaf31c59d108b33838990a9615eaa4))
+
+
+### Bug Fixes
+
+* **editors/template:** create element with NS definition ([#567](https://github.com/openscd/open-scd/issues/567)) ([6fe49d2](https://github.com/openscd/open-scd/commits/6fe49d234df4730bc7838f6e597312e60171b0d5))
+* **editors/template:** three minor issues ([#565](https://github.com/openscd/open-scd/issues/565)) ([f00092a](https://github.com/openscd/open-scd/commits/f00092a96d78f2c86c94d4978b2886489e14c952))
+* **Settings:** remove 'undefined' when no NSDoc version can be read ([d557d26](https://github.com/openscd/open-scd/commits/d557d264ed7a65370d774f174b0ad77c01ba934d))
+* **wizard/foundation/limits:** abstractDataAttributeName ([#573](https://github.com/openscd/open-scd/issues/573)) ([179cad1](https://github.com/openscd/open-scd/commits/179cad1f0d05846111a9d868b800465c7e2bc0a5))
+
 ## [0.10.0](https://github.com/openscd/open-scd/compare/v0.9.0...v0.10.0) (2022-02-21)
 
 

manifest.json

@@ -40,5 +40,5 @@
       "purpose": "maskable"
     }
   ],
-  "version": "0.10.0"
+  "version": "0.11.0"
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "open-scd",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "repository": "https://github.com/openscd/open-scd.git",
   "description": "A bottom-up substation configuration designer for projects described using SCL `IEC 61850-6` Edition 2 or greater.",
   "keywords": [

package.json

@@ -789,7 +789,7 @@
     </DAType>
     <DAType id="OpenSCD_Unit_Hz">
       <BDA name="SIUnit" bType="Enum" type="SIUnitKind">
-        <Val>A</Val>
+        <Val>Hz</Val>
       </BDA>
     </DAType>
     <DAType id="OpenSCD_ValWithTrans_wo_transInd">

public/xml/templates.scd

@@ -11,7 +11,7 @@ import {
   isDelete,
   isMove,
   isSimple,
-  isUpdate,
+  isReplace,
   LitElementConstructor,
   Mixin,
   Move,
@@ -20,7 +20,9 @@ import {
   OpenDocEvent,
   SCLTag,
   SimpleAction,
+  Replace,
   Update,
+  isUpdate,
 } from './foundation.js';
 
 /** Mixin that edits an `XML` `doc`, listening to [[`EditorActionEvent`]]s */
@@ -42,12 +44,19 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
     private checkCreateValidity(create: Create): boolean {
       if (create.checkValidity !== undefined) return create.checkValidity();
 
+      if (
+        !(create.new.element instanceof Element) ||
+        !(create.new.parent instanceof Element)
+      )
+        return true;
+
       const invalid =
         create.new.element.hasAttribute('name') &&
         Array.from(create.new.parent.children).some(
           elm =>
-            elm.tagName === create.new.element.tagName &&
-            elm.getAttribute('name') === create.new.element.getAttribute('name')
+            elm.tagName === (<Element>create.new.element).tagName &&
+            elm.getAttribute('name') ===
+              (<Element>create.new.element).getAttribute('name')
         );
 
       if (invalid)
@@ -74,24 +83,32 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
     private onCreate(action: Create) {
       if (!this.checkCreateValidity(action)) return false;
 
-      if (action.new.reference === undefined)
+      if (
+        action.new.reference === undefined &&
+        action.new.element instanceof Element &&
+        action.new.parent instanceof Element
+      )
         action.new.reference = getReference(
           action.new.parent,
           <SCLTag>action.new.element.tagName
         );
+      else action.new.reference = action.new.reference ?? null;
 
       action.new.parent.insertBefore(action.new.element, action.new.reference);
       return true;
     }
 
     private logCreate(action: Create) {
+      const name =
+        action.new.element instanceof Element
+          ? action.new.element.tagName
+          : get('editing.node');
+
       this.dispatchEvent(
         newLogEvent({
           kind: 'action',
-          title: get('editing.created', {
-            name: action.new.element.tagName,
-          }),
-          action: action,
+          title: get('editing.created', { name }),
+          action,
         })
       );
     }
@@ -100,18 +117,23 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
       if (!action.old.reference)
         action.old.reference = action.old.element.nextSibling;
 
-      action.old.element.remove();
+      if (action.old.element.parentNode !== action.old.parent) return false;
+
+      action.old.parent.removeChild(action.old.element);
       return true;
     }
 
     private logDelete(action: Delete) {
+      const name =
+        action.old.element instanceof Element
+          ? action.old.element.tagName
+          : get('editing.node');
+
       this.dispatchEvent(
         newLogEvent({
           kind: 'action',
-          title: get('editing.deleted', {
-            name: action.old.element.tagName,
-          }),
-          action: action,
+          title: get('editing.deleted', { name }),
+          action,
         })
       );
     }
@@ -174,68 +196,118 @@ export function Editing<TBase extends LitElementConstructor>(Base: TBase) {
       );
     }
 
-    private checkUpdateValidity(update: Update): boolean {
-      if (update.checkValidity !== undefined) return update.checkValidity();
+    private checkReplaceValidity(replace: Replace): boolean {
+      if (replace.checkValidity !== undefined) return replace.checkValidity();
 
       const invalid =
-        update.new.element.hasAttribute('name') &&
-        update.new.element.getAttribute('name') !==
-          update.old.element.getAttribute('name') &&
-        Array.from(update.old.element.parentElement?.children ?? []).some(
+        replace.new.element.hasAttribute('name') &&
+        replace.new.element.getAttribute('name') !==
+          replace.old.element.getAttribute('name') &&
+        Array.from(replace.old.element.parentElement?.children ?? []).some(
           elm =>
-            elm.tagName === update.new.element.tagName &&
-            elm.getAttribute('name') === update.new.element.getAttribute('name')
+            elm.tagName === replace.new.element.tagName &&
+            elm.getAttribute('name') ===
+              replace.new.element.getAttribute('name')
         );
 
       if (invalid)
         this.dispatchEvent(
           newLogEvent({
             kind: 'error',
             title: get('editing.error.update', {
-              name: update.new.element.tagName,
+              name: replace.new.element.tagName,
             }),
             message: get('editing.error.nameClash', {
-              parent: update.old.element.parentElement!.tagName,
-              child: update.new.element.tagName,
-              name: update.new.element.getAttribute('name')!,
+              parent: replace.old.element.parentElement!.tagName,
+              child: replace.new.element.tagName,
+              name: replace.new.element.getAttribute('name')!,
             }),
           })
         );
 
       return !invalid;
     }
 
-    private onUpdate(action: Update) {
-      if (!this.checkUpdateValidity(action)) return false;
+    private onReplace(action: Replace) {
+      if (!this.checkReplaceValidity(action)) return false;
 
       action.new.element.append(...Array.from(action.old.element.children));
       action.old.element.replaceWith(action.new.element);
       return true;
     }
 
-    private logUpdate(action: Update) {
+    private logUpdate(action: Replace | Update) {
+      const name = isReplace(action)
+        ? action.new.element.tagName
+        : (action as Update).element.tagName;
+
       this.dispatchEvent(
         newLogEvent({
           kind: 'action',
           title: get('editing.updated', {
-            name: action.new.element.tagName,
+            name,
           }),
           action: action,
         })
       );
     }
 
+    private checkUpdateValidity(update: Update): boolean {
+      if (update.checkValidity !== undefined) return update.checkValidity();
+
+      const invalid = Array.from(
+        update.element.parentElement?.children ?? []
+      ).some(
+        elm =>
+          elm.tagName === update.element.tagName &&
+          elm.getAttribute('name') === update.newAttributes['name']
+      );
+
+      if (invalid)
+        this.dispatchEvent(
+          newLogEvent({
+            kind: 'error',
+            title: get('editing.error.update', {
+              name: update.element.tagName,
+            }),
+            message: get('editing.error.nameClash', {
+              parent: update.element.parentElement!.tagName,
+              child: update.element.tagName,
+              name: update.newAttributes['name']!,
+            }),
+          })
+        );
+
+      return !invalid;
+    }
+
+    private onUpdate(action: Update) {
+      if (!this.checkUpdateValidity(action)) return false;
+
+      Array.from(action.element.attributes).forEach(attr =>
+        action.element.removeAttributeNode(attr)
+      );
+
+      Object.entries(action.newAttributes).forEach(([key, value]) => {
+        if (value) action.element.setAttribute(key, value);
+      });
+
+      return true;
+    }
+
     private onSimpleAction(action: SimpleAction) {
       if (isMove(action)) return this.onMove(action as Move);
       else if (isCreate(action)) return this.onCreate(action as Create);
       else if (isDelete(action)) return this.onDelete(action as Delete);
+      else if (isReplace(action)) return this.onReplace(action as Replace);
       else if (isUpdate(action)) return this.onUpdate(action as Update);
     }
 
     private logSimpleAction(action: SimpleAction) {
       if (isMove(action)) this.logMove(action as Move);
       else if (isCreate(action)) this.logCreate(action as Create);
       else if (isDelete(action)) this.logDelete(action as Delete);
+      else if (isReplace(action)) this.logUpdate(action as Replace);
       else if (isUpdate(action)) this.logUpdate(action as Update);
     }
 

src/Editing.ts

@@ -200,9 +200,9 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
         }
         const nsdVersion = nsdVersions[id as keyof NsdVersions];
         const nsdocVersion = {
-          version: nsdocElement!.getAttribute('version') ?? undefined,
-          revision: nsdocElement!.getAttribute('revision') ?? undefined,
-          release: nsdocElement!.getAttribute('release') ?? undefined
+          version: nsdocElement!.getAttribute('version') ?? '',
+          revision: nsdocElement!.getAttribute('revision') ?? '',
+          release: nsdocElement!.getAttribute('release') ?? ''
         }
 
         if (!this.isEqual(nsdVersion, nsdocVersion)) {

src/Setting.ts

@@ -5,7 +5,7 @@ import '@material/mwc-list';
 import '@material/mwc-list/mwc-check-list-item';
 
 import {newLogEvent, newOpenDocEvent, newWizardEvent} from "../foundation.js";
-import {dispatchEventOnOpenScd, getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
 
 import {CompasSclAutoAlignmentService} from "../compas-services/CompasSclAutoAlignmentService.js";
 import {createLogEvent} from "../compas-services/foundation.js";

src/compas/CompasAutoAlignment.ts

@@ -21,7 +21,7 @@ import { Nsdoc } from '../../foundation/nsdoc.js';
 @customElement('da-container')
 export class DAContainer extends LitElement {
   /**
-   * The DA itself.
+   * The (B)DA itself.
    */
   @property({ attribute: false })
   element!: Element;
@@ -40,17 +40,19 @@ export class DAContainer extends LitElement {
 
   @property()
   nsdoc!: Nsdoc;
-  
-  @query('#toggleButton') toggleButton: IconButtonToggle | undefined;
+
+  @query('#toggleButton')
+  toggleButton: IconButtonToggle | undefined;
 
   private header(): TemplateResult {
     const name = getNameAttribute(this.element);
-    const bType = this.element!.getAttribute('bType') ?? nothing;
+    const bType = this.element.getAttribute('bType') ?? nothing;
+    const fc = this.element.getAttribute("fc");
 
     if (this.instanceElement) {
-      return html`<b>${name}</b> &mdash; ${bType}`;
+      return html`<b>${name}</b> &mdash; ${bType}${fc ? html` [${fc}]`: ``}`;
     } else {
-      return html`${name} &mdash; ${bType}`;
+      return html`${name} &mdash; ${bType}${fc ? html` [${fc}]`: ``}`;
     }
   }
 
@@ -76,6 +78,7 @@ export class DAContainer extends LitElement {
     return element.querySelector('Val') ?? null;
   }
 
+
   /**
    * Get the nested (B)DA element(s) if available.
    * @returns The nested (B)DA element(s) of this (B)DA container.
@@ -132,4 +135,4 @@ export class DAContainer extends LitElement {
       padding-left: 0.3em;
     }
   `;
-}
+}