Refactoring foundation functions, more stable.

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

Author: Dennis Labordus

src/compas-editors/CompasVersions.ts

@@ -9,14 +9,20 @@ import '@material/mwc-list/mwc-list-item';
 import '@material/mwc-list/mwc-check-list-item';
 
 import {newLogEvent, newWizardEvent, Wizard} from "../foundation.js";
+import {MultiSelectedEvent} from "@material/mwc-list/mwc-list-foundation";
 
 import {CompasSclDataService, SDS_NAMESPACE} from "../compas-services/CompasSclDataService.js";
 import {createLogEvent} from "../compas-services/foundation.js";
-import {getTypeFromDocName, updateDocumentInOpenSCD} from "../compas/foundation.js";
-import {getElementByName, getOpenScdElement, styles} from './foundation.js';
+import {
+  dispatchEventOnOpenScd,
+  getOpenScdElement,
+  getTypeFromDocName,
+  setDocIdOnOpenScd,
+  updateDocumentInOpenSCD
+} from "../compas/foundation.js";
 import {addVersionToCompasWizard} from "../compas/CompasUploadVersion.js";
 import {compareWizard} from "../compas/CompasCompareDialog.js";
-import {MultiSelectedEvent} from "@material/mwc-list/mwc-list-foundation";
+import {getElementByName, styles} from './foundation.js';
 
 // Save the selection for the current document.
 let selectedVersionsOnCompasVersionsEditor: Set<number> = new Set();
@@ -38,7 +44,7 @@ export default class CompasVersionsPlugin extends LitElement {
 
     // Add event to get a notification when a new document is opened.
     const openSCD = getOpenScdElement();
-    if (openSCD) {
+    if (openSCD !== null) {
       openSCD.addEventListener('open-doc', this.resetSelection);
     }
   }
@@ -273,14 +279,13 @@ export default class CompasVersionsPlugin extends LitElement {
 function confirmDeleteCompasWizard(docName: string, docId: string): Wizard {
   function deleteScl(docName: string, docId: string) {
     return function () {
-      const openScd = getOpenScdElement();
       const type = getTypeFromDocName(docName);
 
       CompasSclDataService()
         .deleteSclDocument(type, docId)
         .then (() => {
-          openScd.docId = '';
-          openScd.dispatchEvent(
+          setDocIdOnOpenScd('');
+          dispatchEventOnOpenScd(
             newLogEvent({
               kind: 'info',
               title: get('compas.versions.deleteSuccess')
@@ -289,7 +294,7 @@ function confirmDeleteCompasWizard(docName: string, docId: string): Wizard {
         .catch(createLogEvent);
 
       // Close the Restore Dialog.
-      openScd.dispatchEvent(newWizardEvent());
+      dispatchEventOnOpenScd(newWizardEvent());
 
       return [];
     }
@@ -313,14 +318,13 @@ function confirmDeleteCompasWizard(docName: string, docId: string): Wizard {
 function confirmRestoreVersionCompasWizard(docName: string, docId: string, version: string): Wizard {
   function openScl(docName: string, docId: string, version: string) {
     return function () {
-      const openScd = getOpenScdElement();
       const type = getTypeFromDocName(docName);
 
       CompasSclDataService().getSclDocumentVersion(type, docId, version)
         .then(sclDocument => {
           updateDocumentInOpenSCD(sclDocument);
 
-          openScd.dispatchEvent(
+          dispatchEventOnOpenScd(
             newLogEvent({
               kind: 'info',
               title: get('compas.versions.restoreVersionSuccess', {version : version})
@@ -329,7 +333,7 @@ function confirmRestoreVersionCompasWizard(docName: string, docId: string, versi
         .catch(createLogEvent);
 
       // Close the Restore Dialog.
-      openScd.dispatchEvent(newWizardEvent());
+      dispatchEventOnOpenScd(newWizardEvent());
 
       return [];
     }
@@ -353,13 +357,12 @@ function confirmRestoreVersionCompasWizard(docName: string, docId: string, versi
 function confirmDeleteVersionCompasWizard(docName: string, docId: string, version: string): Wizard {
   function deleteSclVersion(docName: string, docId: string, version: string) {
     return function () {
-      const openScd = getOpenScdElement();
       const type = getTypeFromDocName(docName);
 
       CompasSclDataService()
         .deleteSclDocumentVersion(type, docId, version)
         .then(() => {
-          openScd.dispatchEvent(
+          dispatchEventOnOpenScd(
             newLogEvent({
               kind: 'info',
               title: get('compas.versions.deleteVersionSuccess', {version : version})
@@ -368,7 +371,7 @@ function confirmDeleteVersionCompasWizard(docName: string, docId: string, versio
         .catch(createLogEvent);
 
       // Close the Restore Dialog.
-      openScd.dispatchEvent(newWizardEvent());
+      dispatchEventOnOpenScd(newWizardEvent());
 
       return [];
     }

src/compas-editors/foundation.ts

@@ -1,5 +1,4 @@
 import {css} from "lit-element";
-import {OpenSCD} from "../open-scd.js";
 
 export function getElementByName(parent: Element, namespace: string, tagName: string): Element | null {
   const elements = parent.getElementsByTagNameNS(namespace, tagName);
@@ -9,10 +8,6 @@ export function getElementByName(parent: Element, namespace: string, tagName: st
   return null;
 }
 
-export function getOpenScdElement(): OpenSCD {
-  return <OpenSCD>document.querySelector('open-scd');
-}
-
 /** Common `CSS` styles used by Compas Editors subeditors */
 export const styles = css`
   :host(.moving) section {

src/compas-services/foundation.ts

@@ -1,18 +1,13 @@
 import {get} from "lit-translate";
-
-import {OpenSCD} from "../open-scd.js";
 import {newLogEvent} from "../foundation.js";
+import {dispatchEventOnOpenScd} from "../compas/foundation.js";
 
 export const NOT_FOUND_ERROR = 'NotFoundError';
 export const APPLICATION_ERROR = 'ApplicationError';
 export const SERVER_ERROR = 'ServerError';
 
 export const COMMONS_NAMESPACE = 'https://www.lfenergy.org/compas/commons/v1';
 
-export function getOpenScdElement(): OpenSCD {
-  return <OpenSCD>document.querySelector('open-scd');
-}
-
 export async function handleResponse(response: Response): Promise<string> {
   if (!response.ok) {
     let type = APPLICATION_ERROR;
@@ -75,7 +70,7 @@ export function createLogEvent(reason: any): void {
     message += " (" + reason.status + ")";
   }
 
-  getOpenScdElement().dispatchEvent(
+  dispatchEventOnOpenScd(
     newLogEvent({
       kind: 'error',
       title: get('compas.error.server'),

src/compas/CompasAutoAlignment.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 {getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd, getOpenScdElement} from "./foundation.js";
 
 import {CompasSclAutoAlignmentService} from "../compas-services/CompasSclAutoAlignmentService.js";
 import {createLogEvent} from "../compas-services/foundation.js";
@@ -37,11 +37,15 @@ export default class CompasAutoAlignmentElement extends LitElement {
     if (this.valid()) {
       await CompasSclAutoAlignmentService().updateSCL(this.doc, this.getSelectedValues())
         .then(sclDocument => {
-          const openScd = getOpenScdElement();
-          openScd.dispatchEvent(newLogEvent({kind: 'reset'}));
-          openScd.dispatchEvent(newOpenDocEvent(sclDocument, this.docName, {detail: {docId: this.docId}}));
+          dispatchEventOnOpenScd(newLogEvent({kind: 'reset'}));
+          dispatchEventOnOpenScd(
+            newOpenDocEvent(
+              sclDocument,
+              this.docName,
+              {detail: {docId: this.docId}}
+            ));
 
-          openScd.dispatchEvent(
+          dispatchEventOnOpenScd(
             newLogEvent({
               kind: 'info',
               title: get('compas.autoAlignment.success')

src/compas/CompasCompareDialog.ts

@@ -8,7 +8,7 @@ import '@material/mwc-icon';
 
 import {identity, isSame, newWizardEvent, Wizard} from "../foundation.js";
 
-import {getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
 
 interface CompareOptions {
   title: string;
@@ -180,7 +180,7 @@ export function compareWizard(
 ): Wizard {
   function close() {
     return function () {
-      getOpenScdElement().dispatchEvent(newWizardEvent())
+      dispatchEventOnOpenScd(newWizardEvent())
       return [];
     };
   }

src/compas/CompasOpen.ts

@@ -7,7 +7,7 @@ import {newPendingStateEvent} from "../foundation.js";
 
 import {CompasSclDataService} from "../compas-services/CompasSclDataService.js";
 import {createLogEvent} from "../compas-services/foundation.js";
-import {getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
 import {SclSelectedEvent} from "./CompasScl.js";
 import {TypeSelectedEvent} from "./CompasSclTypeList.js";
 
@@ -66,7 +66,7 @@ export default class CompasOpenElement extends LitElement {
       <input id="scl-file" accept=".sed,.scd,.ssd,.isd,.iid,.cid,.icd"
              type="file" hidden required
              @change=${(evt: Event) =>
-               getOpenScdElement().dispatchEvent(newPendingStateEvent(this.getSclFile(evt)))
+               dispatchEventOnOpenScd(newPendingStateEvent(this.getSclFile(evt)))
              }>
 
       <mwc-button label="${translate('compas.open.selectFileButton')}"
@@ -92,7 +92,7 @@ export default class CompasOpenElement extends LitElement {
       <p>${translate('compas.open.listScls', {type: this.selectedType??''})}</p>
       <compas-scl-list .type=${this.selectedType}
                        @sclSelected=${(evt: SclSelectedEvent) =>
-                         getOpenScdElement().dispatchEvent(newPendingStateEvent(this.getSclDocument(evt.detail.docId)))
+                         dispatchEventOnOpenScd(newPendingStateEvent(this.getSclDocument(evt.detail.docId)))
                        }/>
       </compas-scl-list>
       <mwc-button id="reselect-type"

src/compas/CompasSave.ts

@@ -14,7 +14,12 @@ import {CompasSclTypeRadiogroup} from "./CompasSclTypeRadiogroup.js";
 import {CompasCommentElement} from "./CompasComment.js";
 import {CompasSclDataService} from "../compas-services/CompasSclDataService.js";
 import {createLogEvent} from "../compas-services/foundation.js";
-import {getOpenScdElement, getTypeFromDocName, stripExtensionFromName, updateDocumentInOpenSCD} from "./foundation.js";
+import {
+  dispatchEventOnOpenScd,
+  getTypeFromDocName,
+  stripExtensionFromName,
+  updateDocumentInOpenSCD
+} from "./foundation.js";
 
 import './CompasChangeSetRadiogroup.js';
 import './CompasComment.js';
@@ -62,8 +67,7 @@ export default class CompasSaveElement extends CompasExistsIn(LitElement) {
       .then(sclDocument => {
         updateDocumentInOpenSCD(sclDocument);
 
-        const openScd = getOpenScdElement();
-        openScd.dispatchEvent(
+        dispatchEventOnOpenScd(
           newLogEvent({
             kind: 'info',
             title: get('compas.save.addSuccess')
@@ -84,8 +88,7 @@ export default class CompasSaveElement extends CompasExistsIn(LitElement) {
       .then(sclDocument => {
         updateDocumentInOpenSCD(sclDocument);
 
-        const openScd = getOpenScdElement();
-        openScd.dispatchEvent(
+        dispatchEventOnOpenScd(
           newLogEvent({
             kind: 'info',
             title: get('compas.save.updateSuccess')

src/compas/CompasSession.ts

@@ -6,7 +6,7 @@ import '@material/mwc-dialog';
 import '@material/mwc-button';
 
 import {saveDocumentToFile} from "../file.js";
-import {getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd, getOpenScdElement} from "./foundation.js";
 
 import {CompasUserInfoService} from "../compas-services/CompasUserInfoService.js";
 import {newUserInfoEvent} from "../foundation.js";
@@ -21,9 +21,13 @@ export class CompasSessionExpiringDialogElement extends LitElement {
 
   private expiringSessionWarningTimer: NodeJS.Timeout | null = null;
 
-  static getElement(): CompasSessionExpiringDialogElement {
-    return (<CompasSessionExpiringDialogElement>getOpenScdElement()
-      .shadowRoot!.querySelector('compas-session-expiring-dialog'));
+  static getElement(): CompasSessionExpiringDialogElement | null {
+    const openScd = getOpenScdElement();
+    if (openScd !== null) {
+      return (<CompasSessionExpiringDialogElement>openScd
+        .shadowRoot!.querySelector('compas-session-expiring-dialog'));
+    }
+    return null;
   }
 
   resetTimer(): void {
@@ -84,9 +88,13 @@ export class CompasSessionExpiredDialogElement extends LitElement {
 
   private expiredSessionMessageTimer: NodeJS.Timeout | null = null;
 
-  static getElement(): CompasSessionExpiredDialogElement {
-    return (<CompasSessionExpiredDialogElement>getOpenScdElement()
-      .shadowRoot!.querySelector('compas-session-expired-dialog'));
+  static getElement(): CompasSessionExpiredDialogElement | null {
+    const openScd = getOpenScdElement();
+    if (openScd !== null) {
+      return (<CompasSessionExpiredDialogElement>openScd
+        .shadowRoot!.querySelector('compas-session-expired-dialog'));
+    }
+    return null;
   }
 
   resetTimer(): void {
@@ -173,18 +181,18 @@ function schedulePing() {
 }
 
 function showExpiringSessionWarning() {
-  CompasSessionExpiringDialogElement.getElement().show();
+  CompasSessionExpiringDialogElement.getElement()!.show();
 }
 
 function showExpiredSessionMessage() {
-  CompasSessionExpiringDialogElement.getElement().close();
-  CompasSessionExpiredDialogElement.getElement().show();
+  CompasSessionExpiringDialogElement.getElement()!.close();
+  CompasSessionExpiredDialogElement.getElement()!.show();
   unregisterEvents();
 }
 
 export function resetTimer(): void {
-  CompasSessionExpiringDialogElement.getElement().resetTimer();
-  CompasSessionExpiredDialogElement.getElement().resetTimer();
+  CompasSessionExpiringDialogElement.getElement()!.resetTimer();
+  CompasSessionExpiredDialogElement.getElement()!.resetTimer();
   schedulePing();
 }
 
@@ -202,9 +210,9 @@ export function setSessionTimeouts(sessionWarning: number, sessionExpires: numbe
   const expiringSessionWarning = sessionWarning * 60 * 1000;
   const expiredSessionMessage = sessionExpires * 60 * 1000;
 
-  CompasSessionExpiringDialogElement.getElement().expiringSessionWarning = expiringSessionWarning;
-  CompasSessionExpiringDialogElement.getElement().expiredSessionMessage = expiredSessionMessage;
-  CompasSessionExpiredDialogElement.getElement().expiredSessionMessage = expiredSessionMessage;
+  CompasSessionExpiringDialogElement.getElement()!.expiringSessionWarning = expiringSessionWarning;
+  CompasSessionExpiringDialogElement.getElement()!.expiredSessionMessage = expiredSessionMessage;
+  CompasSessionExpiredDialogElement.getElement()!.expiredSessionMessage = expiredSessionMessage;
   resetTimer();
   registerEvents();
 }
@@ -214,7 +222,7 @@ export async function retrieveUserInfo(): Promise<void> {
     .then(response => {
       const name = response.querySelectorAll("Name").item(0)?.textContent;
       if (name != null) {
-        getOpenScdElement().dispatchEvent(newUserInfoEvent(name));
+        dispatchEventOnOpenScd(newUserInfoEvent(name));
       }
 
       const sessionWarning = response.querySelectorAll("SessionWarning").item(0)?.textContent??"15";

src/compas/CompasSettings.ts

@@ -6,7 +6,7 @@ import '@material/mwc-button';
 
 import {newWizardEvent} from '../foundation.js';
 import {TextFieldBase} from "@material/mwc-textfield/mwc-textfield-base";
-import {getOpenScdElement} from "./foundation.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
 
 export type CompasSettingsRecord = {
   sclDataServiceUrl: string;
@@ -92,8 +92,7 @@ export class CompasSettingsElement extends LitElement {
 
   close(): void {
     // Close the Save Dialog.
-    const openScd = getOpenScdElement();
-    openScd.dispatchEvent(newWizardEvent());
+    dispatchEventOnOpenScd(newWizardEvent());
   }
 
   render(): TemplateResult {