Implement check and retrieval of NSDoc File and using Event to load it.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

src/Setting.ts

@@ -184,39 +184,6 @@ 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.uploadNsdocFile(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 uploadNsdocFile(evt: Event): Promise<void> {
-      const files = Array.from(
-        (<HTMLInputElement | null>evt.target)?.files ?? []
-      );
-
-      if (files.length == 0) return;
-      for (const file of files) {
-        const text = await file.text();
-        document
-          .querySelector('open-scd')!
-          .dispatchEvent(
-            newLoadNsdocEvent(text, file.name)
-          );
-      }
-
-      this.nsdocFileUI.value = '';
-      this.requestUpdate();
-    }
-
     private async onLoadNsdoc(event: LoadNsdocEvent) {
       const nsdocElement = this.parseToXmlObject(event.detail.nsdoc).querySelector('NSDoc');
 
@@ -355,7 +322,6 @@ export function Setting<TBase extends LitElementConstructor>(Base: TBase) {
           <wizard-divider></wizard-divider>
           <section>
             <h3>${translate('settings.loadNsdTranslations')}</h3>
-            ${this.renderFileSelect()}
           </section>
           <mwc-list id="nsdocList">
             ${this.renderNsdocItem('IEC 61850-7-2')}

src/compas-services/CompasValidatorService.ts

@@ -32,11 +32,10 @@ export function CompasSclValidatorService() {
         .then(parseXml);
     },
 
-    getNsdocFile(id: string): Promise<Document> {
+    getNsdocFile(id: string): Promise<string> {
       const svsUrl = getCompasSettings().sclValidatorServiceUrl + '/nsdoc/v1/' + id;
       return fetch(svsUrl).catch(handleError)
-        .then(handleResponse)
-        .then(parseXml);
+        .then(handleResponse);
     },
   }
 }

src/compas/CompasNsdoc.ts

@@ -1,19 +1,52 @@
+import {newLoadNsdocEvent} from "../Setting.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
+
 import {createLogEvent} from "../compas-services/foundation.js";
 import {CompasSclValidatorService} from "../compas-services/CompasValidatorService.js";
 
-function processNsdocFile(id: string, nsdocId: string, checksum: string) {
-  console.info(`Found NSDoc File '${nsdocId}' with ID '${id}'.`);
+/**
+ * Load a single entry. Use the nsdocId to look in the Local Storage, if already loaded,
+ * and if the checksum is the same.
+ * If one of them isn't the case use the ID to retrieve the content of the NSDoc File and
+ * fire the #newLoadNsdocEvent to add the content to the Local Storage.
+ *
+ * @param id       - A unique id use to retrieve the content of NSDoc File from the SCL Validator Service.
+ * @param nsdocId  - The NSDoc ID to be used in the Local Storage.
+ * @param filename - The name of the file, just for logging.
+ * @param checksum - The checksum of the NSDoc File in the SCL Validator Service.
+ */
+async function processNsdocFile(id: string, nsdocId: string, filename: string, checksum: string): Promise<void> {
+  const checksumKey = nsdocId + '.checksum';
+  const checksumStored = localStorage.getItem(checksumKey);
+  if (localStorage.getItem(nsdocId) === null || checksumStored === null || checksumStored !== checksum) {
+    console.info(`Loading NSDoc File '${nsdocId}' with ID '${id}'.`);
+    await CompasSclValidatorService().getNsdocFile(id)
+      .then(nsdocContent => {
+        dispatchEventOnOpenScd(newLoadNsdocEvent(nsdocContent, filename));
+        localStorage.setItem(checksumKey, checksum);
+      })
+      .catch(reason => {
+        createLogEvent(reason);
+      });
+  } else {
+    console.debug(`Loading NSDoc File '${nsdocId}' skipped, already loaded.`);
+  }
 }
 
+/**
+ * Call backend to get the list of available NSDoc Files on the SCL Validator Service.
+ * Load each item found using the function #processNsdocFile.
+ */
 export async function loadNsdocFiles(): Promise<void> {
   await CompasSclValidatorService().listNsdocFiles()
     .then(response => {
       Array.from(response.querySelectorAll("NsdocFile") ?? [])
         .forEach(element => {
           const id = element.querySelector('Id')!.textContent ?? '';
           const nsdocId = element.querySelector('NsdocId')!.textContent ?? '';
+          const filename = element.querySelector('Filename')!.textContent ?? '';
           const checksum = element.querySelector('Checksum')!.textContent ?? '';
-          processNsdocFile(id, nsdocId, checksum);
+          processNsdocFile(id, nsdocId, filename, checksum);
         });
     })
     .catch(reason => {