Merge pull request #38 from com-pas/cim-mapping-plugin

Added CIM Mapping as plugin

Author: Flurb

__snapshots__/compas-scl-list.md

@@ -1,6 +1,8 @@
 # `compas-scl-list`
 
-#### `looks like the latest snapshot`
+## `show-loading`
+
+####   `looks like the latest snapshot`
 
 ```html
 <mwc-list>
@@ -15,3 +17,52 @@
 
 ```
 
+## `no-items-in-list`
+
+####   `looks like the latest snapshot`
+
+```html
+<mwc-list>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="0"
+  >
+    [compas.open.noScls]
+  </mwc-list-item>
+</mwc-list>
+
+```
+
+## `after-list-loaded`
+
+####   `looks like the latest snapshot`
+
+```html
+<mwc-list>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="0"
+  >
+    Station-Utrecht-0001 (
+    <version>
+      2.1.0
+    </version>
+    )
+  </mwc-list-item>
+  <mwc-list-item
+    aria-disabled="false"
+    mwc-list-item=""
+    tabindex="-1"
+  >
+    Station-Utrecht-0002 (
+    <version>
+      1.3.0
+    </version>
+    )
+  </mwc-list-item>
+</mwc-list>
+
+```
+

__snapshots__/compas-settings.md

@@ -11,6 +11,14 @@
   value="http://localhost:9090/compas-scl-data-service"
 >
 </mwc-textfield>
+<mwc-textfield
+  dialoginitialfocus=""
+  id="cimMappingServiceUrl"
+  label="[compas.settings.cimMappingServiceUrl]"
+  required=""
+  value="http://localhost:9091/compas-cim-mapping"
+>
+</mwc-textfield>
 <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)">
   [reset]
 </mwc-button>

__snapshots__/open-scd.md

@@ -70,6 +70,23 @@
       <mwc-linear-progress indeterminate="">
       </mwc-linear-progress>
     </mwc-list-item>
+    <mwc-list-item
+      aria-disabled="false"
+      class="top"
+      graphic="icon"
+      iconid="input"
+      mwc-list-item=""
+      tabindex="-1"
+    >
+      <mwc-icon slot="graphic">
+        input
+      </mwc-icon>
+      <span>
+        New project from CIM
+      </span>
+      <mwc-linear-progress indeterminate="">
+      </mwc-linear-progress>
+    </mwc-list-item>
     <mwc-list-item
       aria-disabled="true"
       class="top"
@@ -427,6 +444,14 @@
       New project
     </div>
   </mwc-icon-button>
+  <mwc-icon-button
+    class="landing_icon"
+    icon="input"
+  >
+    <div class="landing_label">
+      New project from CIM
+    </div>
+  </mwc-icon-button>
 </div>
 <mwc-dialog
   heading="Log"
@@ -702,6 +727,22 @@
       </mwc-icon>
       New project
     </mwc-check-list-item>
+    <mwc-check-list-item
+      aria-disabled="false"
+      class="official"
+      graphic="control"
+      hasmeta=""
+      left=""
+      mwc-list-item=""
+      selected=""
+      tabindex="-1"
+      value="/src/menu/CompasCimMapping.js"
+    >
+      <mwc-icon slot="meta">
+        input
+      </mwc-icon>
+      New project from CIM
+    </mwc-check-list-item>
     <mwc-check-list-item
       aria-disabled="false"
       class="official"

public/js/plugins.js

@@ -55,6 +55,15 @@ export const officialPlugins = [
     requireDoc: false,
     position: 'top'
   },
+  {
+    name: 'New project from CIM',
+    src: '/src/menu/CompasCimMapping.js',
+    icon: 'input',
+    default: true,
+    kind: 'menu',
+    requireDoc: false,
+    position: 'top'
+  },
   {
     name: 'Save project',
     src: '/src/menu/SaveProject.js',

src/compas-editors/CompasVersions.ts

@@ -103,8 +103,13 @@ function openScl(docName: string, docId: string, version: string) {
   return function () {
     const type = getTypeFromDocName(docName);
     CompasSclDataService().getSclDocumentVersion(type, docId, version)
-      .then(doc => {
-        updateDocumentInOpenSCD(doc);
+      .then(response => {
+        // Copy the SCL Result from the Response and create a new Document from it.
+        const sclElement = response.querySelectorAll("SCL").item(0);
+        const sclDocument = document.implementation.createDocument("", "", null);
+        sclDocument.getRootNode().appendChild(sclElement.cloneNode(true));
+
+        updateDocumentInOpenSCD(sclDocument);
       });
 
     // Close the Restore Dialog.

src/compas/CompasCimMappingService.ts

@@ -0,0 +1,43 @@
+import {CompasSettings} from "./CompasSettingsElement.js";
+
+export const CMS_NAMESPACE = 'https://www.lfenergy.org/compas/CimMappingService';
+
+export interface CimData {
+  name: string,
+  doc: Document;
+}
+
+export interface MapRequestBody {
+  cimData: CimData[]
+}
+
+export function CompasCimMappingService() {
+
+  function getCompasSettings() {
+    return CompasSettings().compasSettings;
+  }
+
+  return {
+    map(body: MapRequestBody): Promise<Document> {
+      const cmsUrl = getCompasSettings().cimMappingServiceUrl + '/cim/v1/map';
+      return fetch(cmsUrl, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/xml'
+        },
+        body: `<?xml version="1.0" encoding="UTF-8"?>
+               <cms:MapRequest xmlns:cms="${CMS_NAMESPACE}">
+               ${body.cimData.map(cimData => {
+                  return `
+                    <cms:CimData>
+                        <cms:Name>${cimData.name}</cms:Name>
+                        ${new XMLSerializer().serializeToString(cimData.doc.documentElement)}
+                    </cms:CimData>`;
+                }) }
+               </cms:MapRequest>`
+      })
+        .then(response => response.text())
+        .then(str => new DOMParser().parseFromString(str, 'application/xml'))
+    },
+  }
+}

src/compas/CompasSaveTo.ts

@@ -60,8 +60,13 @@ export class CompasSaveTo extends LitElement {
 
 function getSclDocument(type: string, id: string): void {
   CompasSclDataService().getSclDocument(type, id)
-    .then(doc => {
-      updateDocumentInOpenSCD(doc);
+    .then(response => {
+      // Copy the SCL Result from the Response and create a new Document from it.
+      const sclElement = response.querySelectorAll("SCL").item(0);
+      const sclDocument = document.implementation.createDocument("", "", null);
+      sclDocument.getRootNode().appendChild(sclElement.cloneNode(true));
+
+      updateDocumentInOpenSCD(sclDocument);
     });
 }
 

src/compas/CompasScl.ts

@@ -17,6 +17,10 @@ export class CompasScl extends LitElement {
   scls!: Element[];
 
   firstUpdated() {
+    this.fetchData();
+  }
+
+  fetchData() {
     CompasSclDataService().listScls(this.type)
       .then(xmlResponse => {
         this.scls = Array.from(xmlResponse.querySelectorAll('Item') ?? [])
@@ -28,8 +32,14 @@ export class CompasScl extends LitElement {
   }
 
   private async getSclDocument(id?: string): Promise<void> {
-    const doc = await CompasSclDataService().getSclDocument(this.type, id ?? '');
-    updateDocumentInOpenSCD(doc);
+    const response = await CompasSclDataService().getSclDocument(this.type, id ?? '');
+
+    // Copy the SCL Result from the Response and create a new Document from it.
+    const sclElement = response.querySelectorAll("SCL").item(0);
+    const sclDocument = document.implementation.createDocument("", "", null);
+    sclDocument.getRootNode().appendChild(sclElement.cloneNode(true));
+
+    updateDocumentInOpenSCD(sclDocument);
   }
 
   render(): TemplateResult {

src/compas/CompasSclDataService.ts

@@ -51,14 +51,14 @@ export function CompasSclDataService() {
     },
 
     getSclDocument(type: string, id: string): Promise<Document> {
-      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id + '/scl';
+      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id;
       return fetch(sclUrl)
         .then(response => response.text())
         .then(str => new DOMParser().parseFromString(str, 'application/xml'))
     },
 
     getSclDocumentVersion(type: string, id: string, version: string): Promise<Document> {
-      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id + '/' + version + '/scl';
+      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id + '/' + version;
       return fetch(sclUrl)
         .then(response => response.text())
         .then(str => new DOMParser().parseFromString(str, 'application/xml'))

src/compas/CompasSettingsElement.ts

@@ -7,9 +7,11 @@ import {TextFieldBase} from "@material/mwc-textfield/mwc-textfield-base";
 
 export type CompasSettingsRecord = {
   sclDataServiceUrl: string;
+  cimMappingServiceUrl: string;
 };
 export const defaults: CompasSettingsRecord = {
-  sclDataServiceUrl: 'http://localhost:9090/compas-scl-data-service'
+  sclDataServiceUrl: 'http://localhost:9090/compas-scl-data-service',
+  cimMappingServiceUrl: 'http://localhost:9091/compas-cim-mapping'
 };
 
 export function CompasSettings() {
@@ -18,6 +20,7 @@ export function CompasSettings() {
     get compasSettings(): CompasSettingsRecord {
       return {
         sclDataServiceUrl: this.getCompasSetting('sclDataServiceUrl'),
+        cimMappingServiceUrl: this.getCompasSetting('cimMappingServiceUrl'),
       };
     },
 
@@ -45,8 +48,13 @@ export class CompasSettingsElement extends LitElement {
     return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="sclDataServiceUrl"]');
   }
 
+  getCimMappingServiceUrlField(): TextFieldBase {
+    return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="cimMappingServiceUrl"]');
+  }
+
   valid(): boolean {
-    return this.getSclDataServiceUrlField().checkValidity();
+    return this.getSclDataServiceUrlField().checkValidity()
+      && this.getCimMappingServiceUrlField().checkValidity();
   }
 
   save(): boolean {
@@ -56,6 +64,7 @@ export class CompasSettingsElement extends LitElement {
 
     // Update settings from TextField.
     CompasSettings().setCompasSetting('sclDataServiceUrl', this.getSclDataServiceUrlField().value);
+    CompasSettings().setCompasSetting('cimMappingServiceUrl', this.getCimMappingServiceUrlField().value);
     return true;
   }
 
@@ -78,6 +87,10 @@ export class CompasSettingsElement extends LitElement {
                      label="${translate('compas.settings.sclDataServiceUrl')}"
                      value="${this.compasSettings.sclDataServiceUrl}" required>
       </mwc-textfield>
+      <mwc-textfield dialogInitialFocus id="cimMappingServiceUrl"
+                     label="${translate('compas.settings.cimMappingServiceUrl')}"
+                     value="${this.compasSettings.cimMappingServiceUrl}" required>
+      </mwc-textfield>
 
       <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)"
                   @click=${() => {