Merge pull request #180 from com-pas/upstream-v0.22.0

Merge version v0.22.0 from OpenSCD

Author: Dennis Labordus

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 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.22.0](https://github.com/openscd/open-scd/compare/v0.21.0...v0.22.0) (2022-08-22)
+
+
+### Features
+
+* **editor/laterbinding:** Added first part for SMV Later Binding Editor ([#927](https://github.com/openscd/open-scd/issues/927)) ([5bfc3aa](https://github.com/openscd/open-scd/commits/5bfc3aa5f5e91c8a313875beb6b225a81f88f663))
+* **editor/laterbinding:** Show connected and available ExtRef Element from selected FCDA Element ([#941](https://github.com/openscd/open-scd/issues/941)) ([d06d0b4](https://github.com/openscd/open-scd/commits/d06d0b463a5cc150bfdf1d9ea24739c8f96d3f4f))
+* **editor/laterbinding:** Subscribe and unsubscribe from ExtRef for Later Binding (SMV) ([#944](https://github.com/openscd/open-scd/issues/944)) ([b25f9a6](https://github.com/openscd/open-scd/commits/b25f9a67d541583678a19f5a5a211cc8ef5d0d2a))
+* **menu/compareied:** ignore attributes/elements when comparing IED Elements ([#926](https://github.com/openscd/open-scd/issues/926)) ([7e25149](https://github.com/openscd/open-scd/commits/7e2514929d3997f598990d41a01696e567b5d6a6))
+* **menu/history:** move history from log to own menu plugin ([30d568f](https://github.com/openscd/open-scd/commits/30d568fd7596df307f301170b96a74b47af5053a))
+
 ## [0.21.0](https://github.com/openscd/open-scd/compare/v0.20.0...v0.21.0) (2022-08-08)
 
 

manifest.json

@@ -40,5 +40,5 @@
       "purpose": "maskable"
     }
   ],
-  "version": "0.21.0"
+  "version": "0.22.0"
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-scd",
-  "version": "0.21.0",
+  "version": "0.22.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": [

public/js/plugins.js

@@ -34,6 +34,13 @@ export const officialPlugins = [
     default: true,
     kind: 'editor',
   },
+  {
+    name: 'Subscriber Later Binding (SMV)',
+    src: '/src/editors/SMVSubscriberLaterBinding.js',
+    icon: 'link',
+    default: true,
+    kind: 'editor',
+  },
   {
     name: 'Communication',
     src: '/src/editors/Communication.js',
@@ -247,6 +254,15 @@ export const officialPlugins = [
     requireDoc: true,
     position: 'middle',
   },
+  {
+    name: 'Show SCL History',
+    src: '/src/menu/SclHistory.js',
+    icon: 'history_toggle_off',
+    default: true,
+    kind: 'menu',
+    requireDoc: true,
+    position: 'bottom',
+  },
   {
     name: 'CoMPAS Settings',
     src: '/src/menu/CompasSettings.js',

src/Logging.ts

@@ -32,8 +32,6 @@ import {
   LogEvent,
   Mixin,
   newActionEvent,
-  OpenDocEvent,
-  SclhistoryEntry,
 } from './foundation.js';
 import { getFilterIcon, iconColors } from './icons/icons.js';
 import { Plugin } from './Plugging.js';
@@ -43,7 +41,6 @@ const icons = {
   warning: 'warning',
   error: 'report',
   action: 'history',
-  sclhistory: 'history_toggle_off',
 };
 
 function getPluginName(src: string): string {
@@ -113,58 +110,6 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
       return index;
     }
 
-    private convertToDate(when: string | null): Date | null {
-      const convertedTime = new Date(when ?? '');
-      if (!isNaN(convertedTime.getTime())) {
-        return convertedTime;
-      }
-      return null;
-    }
-
-    private createMessage(
-      who: string | null,
-      why: string | null
-    ): string | undefined {
-      let message = who;
-      if (message !== null && why !== null) {
-        message += ' : ' + why;
-      } else if (why !== null) {
-        message = why;
-      }
-      return message ?? undefined;
-    }
-
-    private createSclHistoryEntry(
-      who: string | null,
-      what: string | null,
-      why: string | null,
-      when: string | null
-    ): SclhistoryEntry {
-      return {
-        kind: 'sclhistory',
-        title: what ?? 'UNDEFINED',
-        message: this.createMessage(who, why),
-        time: this.convertToDate(when),
-      };
-    }
-
-    private onLoadHistoryFromDoc(event: OpenDocEvent) {
-      const doc = event.detail.doc;
-
-      Array.from(
-        doc.querySelectorAll(':root > Header > History > Hitem')
-      ).forEach(historyItem => {
-        this.history.push(
-          this.createSclHistoryEntry(
-            historyItem.getAttribute('who'),
-            historyItem.getAttribute('what'),
-            historyItem.getAttribute('why'),
-            historyItem.getAttribute('when')
-          )
-        );
-      });
-    }
-
     private onIssue(de: IssueEvent): void {
       const issues = this.diagnoses.get(de.detail.validatorId);
 
@@ -249,7 +194,6 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
 
       this.addEventListener('log', this.onLog);
       this.addEventListener('issue', this.onIssue);
-      this.addEventListener('open-doc', this.onLoadHistoryFromDoc);
     }
 
     renderLogEntry(
@@ -330,9 +274,7 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
 
     private renderFilterButtons() {
       return (<LogEntryType[]>Object.keys(icons)).map(
-        kind => html`<mwc-icon-button-toggle
-          id="${kind}filter"
-          ?on=${kind !== 'sclhistory'}
+        kind => html`<mwc-icon-button-toggle id="${kind}filter" on
           >${getFilterIcon(kind, false)}
           ${getFilterIcon(kind, true)}</mwc-icon-button-toggle
         >`
@@ -362,8 +304,7 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
           #content mwc-list-item.info,
           #content mwc-list-item.warning,
           #content mwc-list-item.error,
-          #content mwc-list-item.action,
-          #content mwc-list-item.sclhistory {
+          #content mwc-list-item.action {
             display: none;
           }
           #infofilter[on] ~ #content mwc-list-item.info {
@@ -378,9 +319,6 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
           #actionfilter[on] ~ #content mwc-list-item.action {
             display: flex;
           }
-          #sclhistoryfilter[on] ~ #content mwc-list-item.sclhistory {
-            display: flex;
-          }
 
           #log {
             --mdc-dialog-min-width: 92vw;

src/editors/SMVSubscriberLaterBinding.ts

@@ -0,0 +1,41 @@
+import { css, html, LitElement, property, TemplateResult } from 'lit-element';
+
+import './subscription/smv-laterbinding/svc-laterbinding-list.js';
+import './subscription/smv-laterbinding/ext-ref-laterbinding-list.js';
+
+/** An editor [[`plugin`]] for Subscribe Later Binding (SMV). */
+export default class SMVSubscribeLaterBindingPlugin extends LitElement {
+  @property({ attribute: false })
+  doc!: XMLDocument;
+
+  render(): TemplateResult {
+    return html`<div>
+      <div class="container">
+        <svc-later-binding-list class="column" .doc=${this.doc}>
+        </svc-later-binding-list>
+        <extref-later-binding-list class="column" .doc=${this.doc}>
+        </extref-later-binding-list>
+      </div>
+    </div>`;
+  }
+
+  static styles = css`
+    :host {
+      width: 100vw;
+    }
+
+    .container {
+      display: flex;
+      padding: 8px 6px 16px;
+      height: calc(100vh - 136px);
+    }
+
+    .column {
+      flex: 50%;
+      margin: 0px 6px 0px;
+      min-width: 300px;
+      height: 100%;
+      overflow-y: auto;
+    }
+  `;
+}

src/editors/publisher/data-set-editor.ts

@@ -20,34 +20,34 @@ import '../../filtered-list.js';
 import { FilteredList } from '../../filtered-list.js';
 
 import { compareNames, identity, selector } from '../../foundation.js';
-import { styles } from './foundation.js';
+import { styles, updateElementReference } from './foundation.js';
 
 @customElement('data-set-editor')
 export class DataSetEditor extends LitElement {
   /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
   @property({ attribute: false })
-  set doc(newDoc: XMLDocument) {
-    if (this._doc === newDoc) return;
-
-    this.selectedDataSet = undefined;
-    if (this.selectionList && this.selectionList.selected)
-      (this.selectionList.selected as ListItem).selected = false;
-
-    this._doc = newDoc;
-
-    this.requestUpdate();
-  }
-  get doc(): XMLDocument {
-    return this._doc;
-  }
-  private _doc!: XMLDocument;
+  doc!: XMLDocument;
 
   @state()
   selectedDataSet?: Element;
 
   @query('.selectionlist') selectionList!: FilteredList;
   @query('mwc-button') selectDataSetButton!: Button;
 
+  /** Resets selected GOOSE, if not existing in new doc */
+  update(props: Map<string | number | symbol, unknown>): void {
+    if (props.has('doc') && this.selectedDataSet) {
+      const newDataSet = updateElementReference(this.doc, this.selectedDataSet);
+
+      this.selectedDataSet = newDataSet ?? undefined;
+
+      if (!newDataSet && this.selectionList && this.selectionList.selected)
+        (this.selectionList.selected as ListItem).selected = false;
+    }
+
+    super.update(props);
+  }
+
   private selectDataSet(evt: Event): void {
     const id = ((evt.target as FilteredList).selected as ListItem).value;
     const dataSet = this.doc.querySelector(selector('DataSet', id));

src/editors/publisher/foundation.ts

@@ -1,5 +1,19 @@
 import { css } from 'lit-element';
 
+import { identity, selector } from '../../foundation.js';
+
+export function updateElementReference(
+  newDoc: XMLDocument,
+  oldElement: Element
+): Element | null {
+  if (!oldElement || !oldElement.closest('SCL')) return null;
+
+  const id = identity(oldElement);
+  const newElement = newDoc.querySelector(selector(oldElement.tagName, id));
+
+  return newElement;
+}
+
 export const styles = css`
   .content {
     display: flex;

src/editors/publisher/gse-control-editor.ts

@@ -22,28 +22,13 @@ import { FilteredList } from '../../filtered-list.js';
 
 import { gooseIcon } from '../../icons/icons.js';
 import { compareNames, identity, selector } from '../../foundation.js';
-import { styles } from './foundation.js';
+import { styles, updateElementReference } from './foundation.js';
 
 @customElement('gse-control-editor')
 export class GseControlEditor extends LitElement {
   /** The document being edited as provided to plugins by [[`OpenSCD`]]. */
   @property({ attribute: false })
-  set doc(newDoc: XMLDocument) {
-    if (this._doc === newDoc) return;
-
-    this.selectedDataSet = undefined;
-    this.selectedGseControl = undefined;
-    if (this.selectionList && this.selectionList.selected)
-      (this.selectionList.selected as ListItem).selected = false;
-
-    this._doc = newDoc;
-
-    this.requestUpdate();
-  }
-  get doc(): XMLDocument {
-    return this._doc;
-  }
-  private _doc!: XMLDocument;
+  doc!: XMLDocument;
 
   @state()
   selectedGseControl?: Element;
@@ -53,6 +38,26 @@ export class GseControlEditor extends LitElement {
   @query('.selectionlist') selectionList!: FilteredList;
   @query('mwc-button') selectGSEControlButton!: Button;
 
+  /** Resets selected GOOSE and its DataSet, if not existing in new doc */
+  update(props: Map<string | number | symbol, unknown>): void {
+    if (props.has('doc') && this.selectedGseControl) {
+      const newGseControl = updateElementReference(
+        this.doc,
+        this.selectedGseControl
+      );
+
+      this.selectedGseControl = newGseControl ?? undefined;
+      this.selectedDataSet = this.selectedGseControl
+        ? updateElementReference(this.doc, this.selectedDataSet!)
+        : undefined;
+
+      if (!newGseControl && this.selectionList && this.selectionList.selected)
+        (this.selectionList.selected as ListItem).selected = false;
+    }
+
+    super.update(props);
+  }
+
   private selectGSEControl(evt: Event): void {
     const id = ((evt.target as FilteredList).selected as ListItem).value;
     const gseControl = this.doc.querySelector(selector('GSEControl', id));