Implemented Import from API plugin

Signed-off-by: Flurb <[email protected]>

Author: Flurb

public/cim/README.md

@@ -0,0 +1,8 @@
+Directory containing fixed files for the 'Import from API' plugin, namely:
+
+- cim-eq-hoorn-v3.xml
+- cim-eq-makkum.xml
+- cim-eq-winselingseweg-voorbeeld.xml
+- EQ-entsoe-voorbeeld.xml
+
+Without these files, the 'Import from API' doesn't work and the hardcoded files cannot be opened.

public/js/plugins.js

@@ -84,8 +84,8 @@ export const officialPlugins = [
   },
   {
     name: 'Import from API',
-    src: '/src/menu/CompasImportFromLiander.js',
-    icon: 'create_new_folder',
+    src: '/src/menu/CompasImportFromApi.js',
+    icon: 'cloud_download',
     default: false,
     kind: 'menu',
     requireDoc: false,

src/compas/CompasImportFromApi.ts

@@ -0,0 +1,61 @@
+import {customElement, html, LitElement, TemplateResult} from "lit-element";
+
+import '@material/mwc-button';
+
+import {newOpenDocEvent, newWizardEvent} from "../foundation.js";
+
+import {createLogEvent, handleError, handleResponse, parseXml} from "../compas-services/foundation.js";
+import {dispatchEventOnOpenScd} from "./foundation.js";
+
+import '../WizardDivider.js';
+import './CompasSclTypeList.js';
+import './CompasScl.js';
+import { CompasSettings } from "./CompasSettings.js";
+import { CompasCimMappingService } from "../compas-services/CompasCimMappingService.js";
+
+@customElement('compas-import-from-api')
+export default class CompasImportFromApiElement extends LitElement {
+  private async processCimFile(name: string) {
+    const url = CompasSettings().compasSettings.importFromApiUrl;
+
+    const doc = await fetch(url + '/' + name + '.xml')
+    .catch(handleError)
+    .then(handleResponse)
+    .then(parseXml);
+    
+    await CompasCimMappingService().map({cimData: [{name: name + '.xml', doc: doc}]}).then(response => {
+      const sclName = name + ".ssd";
+
+      const sclElement = response.querySelectorAll("SCL").item(0);
+      const sclDocument = document.implementation.createDocument("", "", null);
+      sclDocument.getRootNode().appendChild(sclElement.cloneNode(true));
+
+      dispatchEventOnOpenScd(newOpenDocEvent(sclDocument, sclName));
+    }).catch(createLogEvent);
+
+    dispatchEventOnOpenScd(newWizardEvent());
+  }
+
+  render(): TemplateResult {
+    return html `
+    <filtered-list>
+    <mwc-list-item
+      @click=${() => this.processCimFile('cim-eq-hoorn-v3')}>
+      cim-eq-hoorn-v3
+    </mwc-list-item>
+    <mwc-list-item
+      @click=${() => this.processCimFile('cim-eq-makkum')}>
+      cim-eq-makkum
+    </mwc-list-item>
+    <mwc-list-item
+      @click=${() => this.processCimFile('cim-eq-winselingseweg-voorbeeld')}>
+      cim-eq-winselingseweg-voorbeeld
+    </mwc-list-item>
+    <mwc-list-item
+      @click=${() => this.processCimFile('EQ-entsoe-voorbeeld')}>
+      EQ-entsoe-voorbeeld
+    </mwc-list-item>
+  </filtered-list>
+    `
+  }
+}

src/compas/CompasSettings.ts

@@ -13,6 +13,7 @@ export type CompasSettingsRecord = {
   sclValidatorServiceUrl: string;
   cimMappingServiceUrl: string;
   sclAutoAlignmentServiceUrl: string;
+  importFromApiUrl: string;
 };
 
 export function CompasSettings() {
@@ -24,6 +25,7 @@ export function CompasSettings() {
         sclValidatorServiceUrl: this.getCompasSetting('sclValidatorServiceUrl'),
         cimMappingServiceUrl: this.getCompasSetting('cimMappingServiceUrl'),
         sclAutoAlignmentServiceUrl: this.getCompasSetting('sclAutoAlignmentServiceUrl'),
+        importFromApiUrl: this.getCompasSetting('importFromApiUrl'),
       };
     },
 
@@ -32,7 +34,8 @@ export function CompasSettings() {
         sclDataServiceUrl: '/compas-scl-data-service',
         sclValidatorServiceUrl: '/compas-scl-validator',
         cimMappingServiceUrl: '/compas-cim-mapping',
-        sclAutoAlignmentServiceUrl: '/compas-scl-auto-alignment'
+        sclAutoAlignmentServiceUrl: '/compas-scl-auto-alignment',
+        importFromApiUrl: '/public/cim'
       }
     },
 
@@ -72,11 +75,16 @@ export class CompasSettingsElement extends LitElement {
     return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="sclAutoAlignmentServiceUrl"]');
   }
 
+  getImportFromApiUrlField(): TextFieldBase {
+    return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="importFromApiUrl"]');
+  }
+
   valid(): boolean {
     return this.getSclDataServiceUrlField().checkValidity()
       && this.getSclValidatorServiceUrlField().checkValidity()
       && this.getCimMappingServiceUrlField().checkValidity()
-      && this.getSclAutoAlignmentServiceUrlField().checkValidity();
+      && this.getSclAutoAlignmentServiceUrlField().checkValidity()
+      && this.getImportFromApiUrlField().checkValidity();
   }
 
   save(): boolean {
@@ -89,6 +97,7 @@ export class CompasSettingsElement extends LitElement {
     CompasSettings().setCompasSetting('sclValidatorServiceUrl', this.getSclValidatorServiceUrlField().value);
     CompasSettings().setCompasSetting('cimMappingServiceUrl', this.getCimMappingServiceUrlField().value);
     CompasSettings().setCompasSetting('sclAutoAlignmentServiceUrl', this.getSclAutoAlignmentServiceUrlField().value);
+    CompasSettings().setCompasSetting('importFromApiUrl', this.getImportFromApiUrlField().value);
     return true;
   }
 
@@ -122,6 +131,10 @@ export class CompasSettingsElement extends LitElement {
                      label="${translate('compas.settings.sclAutoAlignmentServiceUrl')}"
                      value="${this.compasSettings.sclAutoAlignmentServiceUrl}" required>
       </mwc-textfield>
+      <mwc-textfield id="importFromApiUrl"
+                     label="${translate('compas.settings.importFromApiUrl')}"
+                     value="${this.compasSettings.importFromApiUrl}" required>
+      </mwc-textfield>
 
       <mwc-button @click=${() => {
                     if (this.reset()) {

src/menu/CompasImportFromLiander.ts renamed to src/menu/CompasImportFromApi.ts

@@ -8,15 +8,16 @@ import {
   Wizard,
 } from '../foundation.js';
 
+import "../compas/CompasImportFromApi.js";
+
 export default class ImportFromApiPlugin extends LitElement {
+
   private importFromApiWizard(): Wizard {
     return [
       {
         title: get('compas.import.title'),
         content: [
-          html`<filtered-list>
-          
-          </filtered-list>`,
+          html`<compas-import-from-api></compas-import-from-api>`,
         ],
       },
     ];

src/translations/de.ts

@@ -640,6 +640,7 @@ export const de: Translations = {
       sclValidatorServiceUrl: 'CoMPAS SCL Validator Service URL',
       cimMappingServiceUrl: 'CoMPAS CIM Mapping Service URL',
       sclAutoAlignmentServiceUrl: 'CoMPAS SCL Auto Alignment Service URL',
+      importFromApiUrl: 'CoMPAS Import from API URL',
     },
     session: {
       headingExpiring: '???',

src/translations/en.ts

@@ -636,6 +636,7 @@ export const en = {
       sclValidatorServiceUrl: 'CoMPAS SCL Validator Service URL',
       cimMappingServiceUrl: 'CoMPAS CIM Mapping Service URL',
       sclAutoAlignmentServiceUrl: 'CoMPAS SCL Auto Alignment Service URL',
+      importFromApiUrl: 'CoMPAS Import from API URL',
     },
     session: {
       headingExpiring: 'Your session is about to expire!',

test/integration/__snapshots__/open-scd.test.snap.js

@@ -858,10 +858,10 @@ snapshots["open-scd looks like its snapshot"] =
       left=""
       mwc-list-item=""
       tabindex="-1"
-      value="/src/menu/CompasImportFromLiander.js"
+      value="/src/menu/CompasImportFromApi.js"
     >
       <mwc-icon slot="meta">
-        create_new_folder
+        cloud_download
       </mwc-icon>
       Import from API
     </mwc-check-list-item>

test/unit/compas/CompasImportFromApi.test.ts

@@ -0,0 +1,17 @@
+import {expect, fixtureSync, html} from '@open-wc/testing';
+import CompasImportFromApiElement from '../../../src/compas/CompasImportFromApi.js';
+
+import "../../../src/compas/CompasImportFromApi.js";
+
+describe('compas-import-from-api', () => {
+  let element: CompasImportFromApiElement;
+
+  beforeEach(async () => {
+    element = fixtureSync(html`<compas-import-from-api></compas-import-from-api>`);
+    await element;
+  });
+
+  it('looks like the latest snapshot', () => {
+    expect(element).shadowDom.to.equalSnapshot();
+  });
+});

test/unit/compas/__snapshots__/CompasImportFromApi.test.snap.js

@@ -0,0 +1,37 @@
+/* @web/test-runner snapshot v1 */
+export const snapshots = {};
+
+snapshots["compas-import-from-api looks like the latest snapshot"] = 
+`<filtered-list>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="-1"
+  >
+    cim-eq-hoorn-v3
+  </mwc-list-item>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="-1"
+  >
+    cim-eq-makkum
+  </mwc-list-item>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="-1"
+  >
+    cim-eq-winselingseweg-voorbeeld
+  </mwc-list-item>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="-1"
+  >
+    EQ-entsoe-voorbeeld
+  </mwc-list-item>
+</filtered-list>
+`;
+/* end snapshot compas-import-from-api looks like the latest snapshot */
+