chore: Fix oscd plugins

Author: clepski

package-lock.json

@@ -20,7 +20,7 @@
   "dependencies": {
     "@compas-oscd/core": "^0.1.23",
     "@compas-oscd/open-scd": "0.34.49",
-    "@compas-oscd/plugins": "0.0.6",
+    "@compas-oscd/plugins": "0.0.13",
     "@compas-oscd/xml": "^0.0.1",
     "@material/mwc-dialog": "0.22.1",
     "@material/mwc-drawer": "0.22.1",

package.json

@@ -9,71 +9,71 @@ export const officialPlugins = [
   },
   {
     name: 'Substation',
-    src: '/plugins/dist/editors/Substation.js',
+    src: '/oscd-plugins/editors/Substation.js',
     icon: 'margin',
     activeByDefault: true,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Single Line Diagram',
-    src: '/plugins/dist/editors/SingleLineDiagram.js',
+    src: '/oscd-plugins/editors/SingleLineDiagram.js',
     icon: 'edit',
     activeByDefault: true,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Subscriber Message Binding (GOOSE)',
-    src: '/plugins/dist/editors/GooseSubscriberMessageBinding.js',
+    src: '/oscd-plugins/editors/GooseSubscriberMessageBinding.js',
     icon: 'link',
     activeByDefault: false,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Subscriber Data Binding (GOOSE)',
-    src: '/plugins/dist/editors/GooseSubscriberDataBinding.js',
+    src: '/oscd-plugins/editors/GooseSubscriberDataBinding.js',
     icon: 'link',
     activeByDefault: false,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Subscriber Message Binding (SMV)',
-    src: '/plugins/dist/editors/SMVSubscriberMessageBinding.js',
+    src: '/oscd-plugins/editors/SMVSubscriberMessageBinding.js',
     icon: 'link',
     activeByDefault: false,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Subscriber Data Binding (SMV)',
-    src: '/plugins/dist/editors/SMVSubscriberDataBinding.js',
+    src: '/oscd-plugins/editors/SMVSubscriberDataBinding.js',
     icon: 'link',
     activeByDefault: false,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Communication',
-    src: '/plugins/dist/editors/Communication.js',
+    src: '/oscd-plugins/editors/Communication.js',
     icon: 'settings_ethernet',
     activeByDefault: true,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: '104',
-    src: '/plugins/dist/editors/Protocol104.js',
+    src: '/oscd-plugins/editors/Protocol104.js',
     icon: 'settings_ethernet',
     activeByDefault: false,
     kind: 'editor',
     requireDoc: true,
   },
   {
     name: 'Templates',
-    src: '/plugins/dist/editors/Templates.js',
+    src: '/oscd-plugins/editors/Templates.js',
     icon: 'copy_all',
     activeByDefault: true,
     kind: 'editor',
@@ -113,7 +113,7 @@ export const officialPlugins = [
   },
   {
     name: 'Cleanup',
-    src: '/plugins/dist/editors/Cleanup.js',
+    src: '/oscd-plugins/editors/Cleanup.js',
     icon: 'cleaning_services',
     activeByDefault: false,
     kind: 'editor',
@@ -162,7 +162,7 @@ export const officialPlugins = [
   },
   {
     name: 'New project',
-    src: '/plugins/dist/menu/NewProject.js',
+    src: '/oscd-plugins/menu/NewProject.js',
     icon: 'create_new_folder',
     activeByDefault: true,
     kind: 'menu',
@@ -223,14 +223,14 @@ export const officialPlugins = [
   },
   {
     name: 'Validate Schema',
-    src: '/plugins/dist/validators/ValidateSchema.js',
+    src: '/oscd-plugins/validators/ValidateSchema.js',
     icon: 'rule_folder',
     activeByDefault: true,
     kind: 'validator',
   },
   {
     name: 'Validate Templates',
-    src: '/plugins/dist/validators/ValidateTemplates.js',
+    src: '/oscd-plugins/validators/ValidateTemplates.js',
     icon: 'rule_folder',
     activeByDefault: true,
     kind: 'validator',
@@ -246,7 +246,7 @@ export const officialPlugins = [
   },
   {
     name: 'Create Virtual IED',
-    src: '/plugins/dist/menu/VirtualTemplateIED.js',
+    src: '/oscd-plugins/menu/VirtualTemplateIED.js',
     icon: 'developer_board',
     activeByDefault: false,
     kind: 'menu',
@@ -255,23 +255,23 @@ export const officialPlugins = [
   },
   {
     name: 'Subscriber Update',
-    src: '/plugins/dist/menu/SubscriberInfo.js',
+    src: '/oscd-plugins/menu/SubscriberInfo.js',
     activeByDefault: true,
     kind: 'menu',
     requireDoc: true,
     position: 'middle',
   },
   {
     name: 'Update desc (ABB)',
-    src: '/plugins/dist/menu/UpdateDescriptionABB.js',
+    src: '/oscd-plugins/menu/UpdateDescriptionABB.js',
     activeByDefault: false,
     kind: 'menu',
     requireDoc: true,
     position: 'middle',
   },
   {
     name: 'Update desc (SEL)',
-    src: '/plugins/dist/menu/UpdateDescriptionSEL.js',
+    src: '/oscd-plugins/menu/UpdateDescriptionSEL.js',
     activeByDefault: false,
     kind: 'menu',
     requireDoc: true,
@@ -342,7 +342,7 @@ export const officialPlugins = [
   },
   {
     name: 'Show SCL History',
-    src: '/plugins/dist/menu/SclHistory.js',
+    src: '/oscd-plugins/menu/SclHistory.js',
     icon: 'history_toggle_off',
     activeByDefault: true,
     kind: 'menu',
@@ -360,7 +360,7 @@ export const officialPlugins = [
   },
   {
     name: 'Help',
-    src: '/plugins/dist/menu/Help.js',
+    src: '/oscd-plugins/menu/Help.js',
     icon: 'help',
     activeByDefault: true,
     kind: 'menu',
@@ -369,7 +369,7 @@ export const officialPlugins = [
   },
   {
     name: 'Export Communication Section',
-    src: '/plugins/dist/menu/ExportCommunication.js',
+    src: '/oscd-plugins/menu/ExportCommunication.js',
     icon: 'sim_card_download',
     activeByDefault: false,
     kind: 'menu',
@@ -392,14 +392,5 @@ export const officialPlugins = [
     kind: 'menu',
     requireDoc: true,
     position: 'middle',
-  },
-  {
-    name: 'Export IEC 104 CSV',
-    src: '/plugins/dist/menu/Export104.js',
-    icon: 'sim_card_download',
-    activeByDefault: false,
-    kind: 'menu',
-    requireDoc: true,
-    position: 'middle',
-  },
+  }
 ];

public/js/plugins.js

@@ -44,6 +44,7 @@ import packageJson from '../package.json';
 import { CompasSclDataService } from './compas-services/CompasSclDataService.js';
 import { createLogEvent } from './compas-services/foundation.js';
 import { languages, loader } from './translations/loader.js';
+import { registerOscdPlugins, OscdPluginSrc } from './oscd-plugins.js';
 
 const LNODE_LIB_DOC_ID = 'fc55c46d-c109-4ccd-bf66-9f1d0e135689';
 
@@ -224,6 +225,7 @@ export class OpenSCD extends LitElement {
   connectedCallback(): void {
     super.connectedCallback();
     this.checkAppVersion();
+    registerOscdPlugins();
     this.loadPlugins();
 
     this.unsubscribers.push(this.editor.subscribe(() => this.editCount++));
@@ -465,9 +467,20 @@ export class OpenSCD extends LitElement {
     return builtinPlugins as CorePlugin[];
   }
 
-  private addContent(plugin: Omit<Plugin, 'content'>): Plugin {
+  private addContent(plugin: Plugin): Plugin {
     const tag = this.pluginTag(plugin.src);
 
+    const isOscdPlugin = Object.values(OscdPluginSrc).includes(plugin.src as any);
+    if (isOscdPlugin) {
+      const tag = pluginTag(plugin.src);
+      return {
+        ...plugin,
+        content: {
+          tag,
+        },
+      };
+    }
+
     if (!this.loadedPlugins.has(tag)) {
       this.loadedPlugins.add(tag);
       import(plugin.src).then(mod => {

src/open-scd.ts

@@ -0,0 +1,79 @@
+import { pluginTag } from '@compas-oscd/open-scd/dist/plugin-tag.js';
+
+// editor plugins
+import { default as Substation } from '@compas-oscd/plugins/dist/editors/Substation.js';
+// import { default as SingleLineDiagram } from '@compas-oscd/plugins/dist/editors/SingleLineDiagram.js';
+import { default as GooseSubscriberMessageBinding } from '@compas-oscd/plugins/dist/editors/GooseSubscriberMessageBinding.js';
+import { default as GooseSubscriberDataBinding } from '@compas-oscd/plugins/dist/editors/GooseSubscriberDataBinding.js';
+import { default as SMVSubscriberMessageBinding } from '@compas-oscd/plugins/dist/editors/SMVSubscriberMessageBinding.js';
+import { default as SMVSubscriberDataBinding } from '@compas-oscd/plugins/dist/editors/SMVSubscriberDataBinding.js';
+import { default as Communication } from '@compas-oscd/plugins/dist/editors/Communication.js';
+import { default as Protocol104 } from '@compas-oscd/plugins/dist/editors/Protocol104.js';
+import { default as Templates } from '@compas-oscd/plugins/dist/editors/Templates.js';
+import { default as Cleanup } from '@compas-oscd/plugins/dist/editors/Cleanup.js';
+// validator plugins
+import { default as ValidateSchema } from '@compas-oscd/plugins/dist/validators/ValidateSchema.js';
+import { default as ValidateTemplates } from '@compas-oscd/plugins/dist/validators/ValidateTemplates.js';
+// menu plugins
+import { default as NewProject } from '@compas-oscd/plugins/dist/menu/NewProject.js';
+import { default as VirtualTemplateIED } from '@compas-oscd/plugins/dist/menu/VirtualTemplateIED.js';
+import { default as SubscriberInfo } from '@compas-oscd/plugins/dist/menu/SubscriberInfo.js';
+import { default as UpdateDescriptionABB } from '@compas-oscd/plugins/dist/menu/UpdateDescriptionABB.js';
+import { default as UpdateDescriptionSEL } from '@compas-oscd/plugins/dist/menu/UpdateDescriptionSEL.js';
+import { default as SclHistory } from '@compas-oscd/plugins/dist/menu/SclHistory.js';
+import { default as Help } from '@compas-oscd/plugins/dist/menu/Help.js';
+import { default as ExportCommunication } from '@compas-oscd/plugins/dist/menu/ExportCommunication.js';
+
+export enum OscdPluginSrc {
+  Substation = '/oscd-plugins/editors/Substation.js',
+  // SingleLineDiagram = '/oscd-plugins/editors/SingleLineDiagram.js',
+  GooseSubscriberMessageBinding = '/oscd-plugins/editors/GooseSubscriberMessageBinding.js',
+  GooseSubscriberDataBinding = '/oscd-plugins/editors/GooseSubscriberDataBinding.js',
+  SMVSubscriberMessageBinding = '/oscd-plugins/editors/SMVSubscriberMessageBinding.js',
+  SMVSubscriberDataBinding = '/oscd-plugins/editors/SMVSubscriberDataBinding.js',
+  Communication = '/oscd-plugins/editors/Communication.js',
+  Protocol104 = '/oscd-plugins/editors/Protocol104.js',
+  Templates = '/oscd-plugins/editors/Templates.js',
+  Cleanup = '/oscd-plugins/editors/Cleanup.js',
+  ValidateSchema = '/oscd-plugins/validators/ValidateSchema.js',
+  ValidateTemplates = '/oscd-plugins/validators/ValidateTemplates.js',
+  NewProject = '/oscd-plugins/menu/NewProject.js',
+  VirtualTemplateIED = '/oscd-plugins/menu/VirtualTemplateIED.js',
+  SubscriberInfo = '/oscd-plugins/menu/SubscriberInfo.js',
+  UpdateDescriptionABB = '/oscd-plugins/menu/UpdateDescriptionABB.js',
+  UpdateDescriptionSEL = '/oscd-plugins/menu/UpdateDescriptionSEL.js',
+  SclHistory = '/oscd-plugins/menu/SclHistory.js',
+  Help = '/oscd-plugins/menu/Help.js',
+  ExportCommunication = '/oscd-plugins/menu/ExportCommunication.js'
+}
+
+const plugins: { [key in OscdPluginSrc]: CustomElementConstructor } = {
+  [OscdPluginSrc.Substation]: Substation,
+  // [OscdPluginSrc.SingleLineDiagram]: SingleLineDiagram,
+  [OscdPluginSrc.GooseSubscriberMessageBinding]: GooseSubscriberMessageBinding,
+  [OscdPluginSrc.GooseSubscriberDataBinding]: GooseSubscriberDataBinding,
+  [OscdPluginSrc.SMVSubscriberMessageBinding]: SMVSubscriberMessageBinding,
+  [OscdPluginSrc.SMVSubscriberDataBinding]: SMVSubscriberDataBinding,
+  [OscdPluginSrc.Communication]: Communication,
+  [OscdPluginSrc.Protocol104]: Protocol104,
+  [OscdPluginSrc.Templates]: Templates,
+  [OscdPluginSrc.Cleanup]: Cleanup,
+  [OscdPluginSrc.ValidateSchema]: ValidateSchema,
+  [OscdPluginSrc.ValidateTemplates]: ValidateTemplates,
+  [OscdPluginSrc.NewProject]: NewProject,
+  [OscdPluginSrc.VirtualTemplateIED]: VirtualTemplateIED,
+  [OscdPluginSrc.SubscriberInfo]: SubscriberInfo,
+  [OscdPluginSrc.UpdateDescriptionABB]: UpdateDescriptionABB,
+  [OscdPluginSrc.UpdateDescriptionSEL]: UpdateDescriptionSEL,
+  [OscdPluginSrc.SclHistory]: SclHistory,
+  [OscdPluginSrc.Help]: Help,
+  [OscdPluginSrc.ExportCommunication]: ExportCommunication
+};
+
+export function registerOscdPlugins() {
+  for (const [src, pluginConstructor] of Object.entries(plugins)) {
+    const tag = pluginTag(src);
+
+    customElements.define(tag, pluginConstructor);
+  }
+}

src/oscd-plugins.ts

@@ -9,5 +9,11 @@ export default defineConfig({
         { src: 'node_modules/@compas-oscd/plugins/**/*', dest: 'plugins', rename: { stripBase: 3 } }
       ]
     })
-  ]
+  ],
+  optimizeDeps: {
+    exclude: ['@compas-oscd/plugins']
+  },
+  server: {
+    port: 8080
+  }
 })