Merge pull request #112 from com-pas/merge_upstream_v090

Merge Upstream Version v0.9.0

Author: Rob Tjalma

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.9.0](https://github.com/openscd/open-scd/compare/v0.8.2...v0.9.0) (2022-02-04)
+
+
+### Features
+
+* **settings:** load nsdoc to local storage ([#502](https://github.com/openscd/open-scd/issues/502)) ([659aa8e](https://github.com/openscd/open-scd/commits/659aa8ef3459ab8f513df2cf7971a02753a3a21b)), closes [#516](https://github.com/openscd/open-scd/issues/516)
+* **wizards/reportcontrol:** added new IED wizard to update name/description ([#494](https://github.com/openscd/open-scd/issues/494)) ([110c83d](https://github.com/openscd/open-scd/commits/110c83d658f9c2a0f0c273249aefbee0f50fcfc1))
+* **wizards/reportcontrol:** allow basic ReportControl manipulation capability ([#505](https://github.com/openscd/open-scd/issues/505)) ([943b8dc](https://github.com/openscd/open-scd/commits/943b8dc2b82e6039bd6de99aabbfd10e31527256)), closes [#438](https://github.com/openscd/open-scd/issues/438) [#492](https://github.com/openscd/open-scd/issues/492) [#493](https://github.com/openscd/open-scd/issues/493) [#499](https://github.com/openscd/open-scd/issues/499)
+* **wizards/sampledvaluecontrol:** add edit wizards accessable from selection ([#510](https://github.com/openscd/open-scd/issues/510)) ([fa468b7](https://github.com/openscd/open-scd/commits/fa468b714b714623031fdd754a0056a9cd793214))
+* **wizards/smv:** add edit wizard and allow access from sampledvaluecontrol wizard ([#519](https://github.com/openscd/open-scd/issues/519)) ([aff0367](https://github.com/openscd/open-scd/commits/aff036776eba7434d619de20a67f8f07b3b3c5c7))
+
+
+### Bug Fixes
+
+* **editors/SingleLineDiagram:** added check if a substation is available/selected before drawing ([4eabdb3](https://github.com/openscd/open-scd/commits/4eabdb3ac9fdc2f2db2ebb2058bd8675592e12d6))
+* **editors:** In IED and SLD Editors fixed preserving the selection (IED or Substation) ([#501](https://github.com/openscd/open-scd/issues/501)) ([b10df43](https://github.com/openscd/open-scd/commits/b10df4364e4c5b8c1f4cb14766f1e50c1d6af567))
+* **menu/Help:** incorrect import of markup parser ([#531](https://github.com/openscd/open-scd/issues/531)) ([b6f7ea1](https://github.com/openscd/open-scd/commits/b6f7ea1024a30d7ed0f1f3af5bf42536f0f82fb5))
+* **wizards/fcda:** make sure lnInst is non empty string ([#512](https://github.com/openscd/open-scd/issues/512)) ([f8d2dc7](https://github.com/openscd/open-scd/commits/f8d2dc75a804b06c2e4f1178d0f9768b967ea806))
+
 ### [0.8.2](https://github.com/openscd/open-scd/compare/v0.8.1...v0.8.2) (2022-01-15)
 
 

manifest.json

@@ -40,5 +40,5 @@
       "purpose": "maskable"
     }
   ],
-  "version": "0.8.2"
+  "version": "0.9.0"
 }

package-lock.json

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

@@ -26,6 +26,7 @@ import { TextField } from '@material/mwc-textfield';
 import { ifImplemented, LitElementConstructor, Mixin } from './foundation.js';
 import { EditingElement } from './Editing.js';
 import { officialPlugins } from '../public/js/plugins.js';
+import { initializeNsdoc } from './foundation/nsdoc.js';
 
 type PluginKind = 'editor' | 'menu' | 'validator';
 const menuPosition = ['top', 'middle', 'bottom'] as const;
@@ -208,6 +209,7 @@ export function Plugging<TBase extends new (...args: any[]) => EditingElement>(
             .docName=${this.docName}
             .docId=${this.docId}
             .pluginId=${plugin.src}
+            .nsdoc=${await initializeNsdoc()}
           ></${loadedPlugins.get(plugin.src)}>`;
         },
       };

src/Plugging.ts

@@ -1,31 +1,42 @@
 import { html, property, query, TemplateResult } from 'lit-element';
-import { registerTranslateConfig, translate, use } from 'lit-translate';
+import { get, registerTranslateConfig, translate, use } from 'lit-translate';
 
 import '@material/mwc-button';
 import '@material/mwc-dialog';
 import '@material/mwc-formfield';
 import '@material/mwc-list/mwc-list-item';
 import '@material/mwc-select';
 import '@material/mwc-switch';
+
 import { Dialog } from '@material/mwc-dialog';
 import { Select } from '@material/mwc-select';
 import { Switch } from '@material/mwc-switch';
 
-import { ifImplemented, LitElementConstructor, Mixin } from './foundation.js';
+import { ifImplemented, LitElementConstructor, Mixin, newLogEvent } from './foundation.js';
 import { Language, languages, loader } from './translations/loader.js';
+
+import './WizardDivider.js';
 import { WizardDialog } from './wizard-dialog.js';
 
 export type Settings = {
   language: Language;
   theme: 'light' | 'dark';
   mode: 'safe' | 'pro';
   showieds: 'on' | 'off';
+  'IEC 61850-7-2': string | undefined;
+  'IEC 61850-7-3': string | undefined;
+  'IEC 61850-7-4': string | undefined;
+  'IEC 61850-8-1': string | undefined;
 };
 export const defaults: Settings = {
   language: 'en',
   theme: 'light',
   mode: 'safe',
   showieds: 'off',
+  'IEC 61850-7-2': undefined,
+  'IEC 61850-7-3': undefined,
+  'IEC 61850-7-4': undefined,
+  'IEC 61850-8-1': undefined
 };
 
 /** Mixin that saves [[`Settings`]] to `localStorage`, reflecting them in the
@@ -42,6 +53,10 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
         theme: this.getSetting('theme'),
         mode: this.getSetting('mode'),
         showieds: this.getSetting('showieds'),
+        'IEC 61850-7-2': this.getSetting('IEC 61850-7-2'),
+        'IEC 61850-7-3': this.getSetting('IEC 61850-7-3'),
+        'IEC 61850-7-4': this.getSetting('IEC 61850-7-4'),
+        'IEC 61850-8-1': this.getSetting('IEC 61850-8-1')
       };
     }
 
@@ -56,11 +71,15 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
     @query('#showieds')
     showiedsUI!: Switch;
 
+    @query('#nsdoc-file')
+    private nsdocFileUI!: HTMLInputElement;
+
     private getSetting<T extends keyof Settings>(setting: T): Settings[T] {
       return (
         <Settings[T] | null>localStorage.getItem(setting) ?? defaults[setting]
       );
     }
+
     /** Update the `value` of `setting`, storing to `localStorage`. */
     setSetting<T extends keyof Settings>(setting: T, value: Settings[T]): void {
       localStorage.setItem(setting, <string>(<unknown>value));
@@ -70,6 +89,15 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
       this.requestUpdate();
     }
 
+    /** Remove the `setting` in `localStorage`. */
+    removeSetting<T extends keyof Settings>(setting: T): void {
+      localStorage.removeItem(setting);
+      this.shadowRoot
+        ?.querySelector<WizardDialog>('wizard-dialog')
+        ?.requestUpdate();
+      this.requestUpdate();
+    }
+
     private onClosing(ae: CustomEvent<{ action: string } | null>): void {
       if (ae.detail?.action === 'reset') {
         Object.keys(this.settings).forEach(item =>
@@ -90,6 +118,78 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
       if (changedProperties.has('settings')) use(this.settings.language);
     }
 
+    private renderFileSelect(): TemplateResult {
+      return html `
+        <input id="nsdoc-file" accept=".nsdoc" type="file" hidden required multiple
+          @change=${(evt: Event) => this.loadNsdocFile(evt)}}>
+        <mwc-button label="${translate('settings.selectFileButton')}"
+                    id="selectFileButton"
+                    @click=${() => {
+                      const input = <HTMLInputElement | null>this.shadowRoot!.querySelector("#nsdoc-file");
+                      input?.click();
+                    }}>
+        </mwc-button>
+      `;
+    }
+
+    private async loadNsdocFile(evt: Event): Promise<void> {
+      const files = Array.from(
+        (<HTMLInputElement | null>evt.target)?.files ?? []
+      );
+      
+      if (files.length == 0) return;
+      files.forEach(async file => {
+        const text = await file.text();
+        const id = this.parseToXmlObject(text).querySelector('NSDoc')?.getAttribute('id');
+        if (!id) {
+          document
+          .querySelector('open-scd')!
+          .dispatchEvent(
+              newLogEvent({ kind: 'error', title: get('settings.invalidFileNoIdFound') })
+            );
+          return;
+        }
+  
+        this.setSetting(id as keyof Settings, text);
+      })
+
+      this.nsdocFileUI.value = '';
+      this.requestUpdate();
+    }
+
+    /**
+     * Render one .nsdoc item in the Settings wizard
+     * @param key - The key of the nsdoc file in the settings.
+     * @returns a .nsdoc item for the Settings wizard
+     */
+    private renderNsdocItem<T extends keyof Settings>(key: T): TemplateResult {
+      const nsdSetting = this.settings[key];
+      let nsdVersion: string | undefined | null;
+      let nsdRevision: string | undefined | null;
+      let nsdRelease: string | undefined | null;
+      
+      if (nsdSetting) {
+        const nsdoc = this.parseToXmlObject(nsdSetting)!.querySelector('NSDoc');
+        nsdVersion = nsdoc?.getAttribute('version');
+        nsdRevision = nsdoc?.getAttribute('revision');
+        nsdRelease = nsdoc?.getAttribute('release');
+      }
+
+      return html`<mwc-list-item id=${key} graphic="avatar" hasMeta twoline .disabled=${!nsdSetting}>
+        <span>${key}</span>
+        ${nsdSetting ? html`<span slot="secondary">${nsdVersion}${nsdRevision}${nsdRelease}</span>` :
+          html``}
+        ${nsdSetting ? html`<mwc-icon slot="graphic" style="color:green;">done</mwc-icon>` :
+          html`<mwc-icon slot="graphic" style="color:red;">close</mwc-icon>`}
+        ${nsdSetting ? html`<mwc-icon id="deleteNsdocItem" slot="meta" @click=${() => {this.removeSetting(key)}}>delete</mwc-icon>` :
+          html``}
+      </mwc-list-item>`;
+    }
+
+    private parseToXmlObject(text: string): XMLDocument {
+      return new DOMParser().parseFromString(text, 'application/xml');
+    }
+
     constructor(...params: any[]) {
       super(...params);
 
@@ -140,6 +240,17 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
               ></mwc-switch>
             </mwc-formfield>
           </form>
+          <wizard-divider></wizard-divider>
+          <section>
+            <h3>${translate('settings.loadNsdTranslations')}</h3>
+            ${this.renderFileSelect()}
+          </section>
+          <mwc-list id="nsdocList">
+            ${this.renderNsdocItem('IEC 61850-7-2')}
+            ${this.renderNsdocItem('IEC 61850-7-3')}
+            ${this.renderNsdocItem('IEC 61850-7-4')}
+            ${this.renderNsdocItem('IEC 61850-8-1')}
+          </mwc-list>
           <mwc-button slot="secondaryAction" dialogAction="close">
             ${translate('cancel')}
           </mwc-button>

src/Setting.ts

@@ -0,0 +1,22 @@
+import {css, customElement, html, LitElement, TemplateResult} from "lit-element";
+
+@customElement('wizard-divider')
+export class WizardDividerElement extends LitElement {
+  render(): TemplateResult {
+    return html `
+      <div role="separator"></div>
+    `
+  }
+
+  static styles = css`
+    div {
+      height: 0px;
+      margin: 10px 0px 10px 0px;
+      border-top: none;
+      border-right: none;
+      border-left: none;
+      border-image: initial;
+      border-bottom: 1px solid rgba(0, 0, 0, 0.12);
+    }
+  `
+}

src/WizardDivider.ts

@@ -152,7 +152,7 @@ export class ActionPane extends LitElement {
       color: var(--mdc-theme-on-surface);
       font-family: 'Roboto', sans-serif;
       font-weight: 300;
-      overflow: visible;
+      overflow: clip visible;
       white-space: nowrap;
       text-overflow: ellipsis;
       margin: 0px;