Merge pull request #314 from com-pas/275-warning-instead-of-error-in-case-of-no-nsdoc-files-are-found-more-descriptive-warning-message

fix: altered no nsdoc file warning message

Author: Stef3st

packages/compas-open-scd/src/compas-services/foundation.ts

@@ -103,6 +103,20 @@ export function createLogEvent(element: Element, reason: any): void {
   }
 }
 
+export function createNSDocLogEvent(element: Element, fileName: string): void {
+  if (element) {
+    element.dispatchEvent(
+      newLogEvent({
+        kind: 'warning',
+        title: get('compas.warning.nsdoc'),
+        message: get('compas.warning.nsdocDetails', {
+          url: `/public/nsdoc/${fileName}`,
+        }),
+      })
+    );
+  }
+}
+
 export function getWebsocketUri(settingsUrl: string): string {
   if (settingsUrl.startsWith('http://') || settingsUrl.startsWith('https://')) {
     return settingsUrl

packages/compas-open-scd/src/compas/CompasNsdoc.ts

@@ -1,6 +1,9 @@
 import { newLoadNsdocEvent } from '../Setting.js';
 
-import { createLogEvent } from '../compas-services/foundation.js';
+import {
+  createLogEvent,
+  createNSDocLogEvent,
+} from '../compas-services/foundation.js';
 import { CompasSclValidatorService } from '../compas-services/CompasValidatorService.js';
 import { CompasNSDocFileService } from '../compas-services/CompasNSDocFileService.js';
 
@@ -39,8 +42,8 @@ async function processNsdocFile(
         component.dispatchEvent(newLoadNsdocEvent(nsdocContent, filename));
         localStorage.setItem(checksumKey, checksum);
       })
-      .catch(reason => {
-        createLogEvent(component, reason);
+      .catch(() => {
+        createNSDocLogEvent(component, filename);
       });
   } else {
     console.debug(`Loading NSDoc File '${nsdocId}' skipped, already loaded.`);

packages/compas-open-scd/src/translations/de.ts

@@ -878,6 +878,10 @@ export const de: Translations = {
       server: '???',
       serverDetails: '{{type}}: {{message}}',
     },
+    warning: {
+      nsdoc: 'NSDoc-Datei konnte nicht geladen werden',
+      nsdocDetails: 'Die {{url}} kann nicht geladen werden',
+    },
     changeset: {
       major: '???',
       minor: '???',

packages/compas-open-scd/src/translations/en.ts

@@ -871,6 +871,10 @@ export const en = {
       server: 'Error communicating with CoMPAS Ecosystem',
       serverDetails: '{{type}}: {{message}}',
     },
+    warning: {
+      nsdoc: 'Could not load NSDoc file',
+      nsdocDetails: 'Cannot load {{url}}',
+    },
     changeset: {
       major: 'Major change',
       minor: 'Minor change',