@abi-software/flatmap-viewer 2.2.13 → 2.3.0-a.2

package/README.rst

@@ -38,7 +38,7 @@ The map server endpoint is specified as ``MAP_ENDPOINT`` in ``src/main.js``. It
 Package Installation
 ====================
 
-* ``npm install @abi-software/flatmap-viewer@2.2.13``
+* ``npm install @abi-software/flatmap-viewer@2.3.0-a.2``
 
 Documentation
 -------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/flatmap-viewer",
-  "version": "2.2.13",
+  "version": "2.3.0-a.2",
   "description": "Flatmap viewer using Maplibre GL",
   "repository": "https://github.com/AnatomicMaps/flatmap-viewer.git",
   "main": "src/main.js",
@@ -23,6 +23,8 @@
     "@turf/helpers": "^6.1.4",
     "@turf/projection": "^6.5.0",
     "bezier-js": "^6.1.0",
+    "html-es6cape": "^2.0.2",
+    "jspanel4": "^4.16.1",
     "maplibre-gl": ">=2.4.0",
     "minisearch": "^2.2.1",
     "polylabel": "^1.1.0"
@@ -38,7 +40,7 @@
     "css-loader": "^6.5.1",
     "eslint": "^8.7.0",
     "express": "^4.17.1",
-    "html-webpack-plugin": "^4.5.1",
+    "html-webpack-plugin": "^4.5.2",
     "strip-ansi": "^7.0.1",
     "style-loader": "^1.0.0",
     "url-loader": "^4.1.0",

package/src/annotation.js

@@ -0,0 +1,487 @@
+/******************************************************************************
+
+Flatmap viewer and annotation tool
+
+Copyright (c) 2019 - 2023  David Brooks
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+******************************************************************************/
+
+'use strict';
+
+//==============================================================================
+
+// We use Font Awesome icons
+import '../static/css/font-awesome.min.css';
+import escape from 'html-es6cape';
+import { jsPanel } from 'jspanel4';
+import 'jspanel4/dist/jspanel.css';
+
+//==============================================================================
+
+const FETCH_TIMEOUT = 3000;   //  3 seconds
+const UPDATE_TIMEOUT = 5000;  //  5 seconds
+const LOGIN_TIMEOUT = 30000;  // 30 seconds
+const LOGOUT_TIMEOUT = 5000;  //  5 seconds
+
+const STATUS_MESSAGE_TIMEOUT = 3000;
+
+//==============================================================================
+
+const FEATURE_DISPLAY_PROPERTIES = {
+    'id': 'Feature',
+    'label': 'Tooltip',
+    'models': 'Models',
+    'name': 'Name',
+    'sckan': 'SCKAN valid',
+    'fc-class': 'FC class',
+    'fc-kind': 'FC kind',
+    'layer': 'Map layer',
+}
+
+const ANNOTATION_FIELDS = [
+    {
+        prompt: 'Feature derived from',
+        key: 'prov:wasDerivedFrom',
+        update: true,
+        kind: 'list',
+        size: 6
+    },
+    {
+        prompt: 'Comment',
+        key: 'rdfs:comment',
+        update: false,
+        kind: 'textbox'
+    },
+];
+
+//==============================================================================
+
+export class Annotator
+{
+    constructor(flatmap)
+    {
+        this.__flatmap = flatmap;
+        this.__haveAnnotation = false;
+        this.__user = undefined;
+        this.__savedStatusMessage = '';
+        this.__authorised = false;
+    }
+
+    get user()
+    {
+        return this.__user;
+    }
+
+    __creatorName(creator)
+    {
+        return creator.name || creator.email || creator.login || creator.company || creator;
+    }
+
+    __setUser(creator)
+    {
+        this.__user = creator;
+        this.__setStatusMessage(`Annotating as ${this.__creatorName(creator)}`, 0)
+    }
+
+    __clearUser()
+    {
+        this.__user = undefined;
+        this.__setStatusMessage('', 0);
+    }
+
+    __authorise(panel, callback)
+    //==========================
+    {
+        const abortController = new AbortController();
+        const url = `${this.__flatmap._baseUrl}login`;
+        panel.headerlogo.innerHTML = '<span class="fa fa-spinner fa-spin ml-2"></span>';
+        fetch(url, {
+            headers: { "Content-Type": "application/json; charset=utf-8" },
+            signal: abortController.signal
+        }).then((response) => {
+            panel.headerlogo.innerHTML = '';
+            if (response.ok) {
+                const creator = response.json();
+                if ('error' in creator) {
+                    callback({error: creator.error});
+                } else {
+                    this.__setUser(creator);
+                    this.__authorised = true;
+                    callback(creator);
+                }
+            } else {
+                callback({error: `${response.status} ${response.statusText}`});
+            }
+        });
+        setTimeout((panel) => {
+            if (this.user === 'undefined') {
+                console.log("Aborting login...");
+                abortController.abort();
+                panel.headerlogo.innerHTML = '';
+                this.__setStatusMessage('Unable to login...');
+                }
+            },
+            LOGIN_TIMEOUT, panel);
+    }
+
+    __unauthorise()
+    //=============
+    {
+        this.__clearUser();
+        const abortController = new AbortController();
+        const url = `${this.__flatmap._baseUrl}logout`;
+        fetch(url, {
+            headers: { "Content-Type": "application/json; charset=utf-8" },
+            signal: abortController.signal
+        }).then((response) => {
+            if (response.ok) {
+                this.__authorised = false;
+                console.log('Annotator logout:', response.json());
+            } else {
+                console.log('Annotator logout:', `${response.status} ${response.statusText}`);
+            }
+        });
+        setTimeout(() => {
+            if (this.__authorised) {
+                console.log("Aborting logout...");
+                abortController.abort();
+                this.__setStatusMessage('Unable to logout...');
+                }
+            },
+            LOGOUT_TIMEOUT);
+    }
+
+    __setStatusMessage(message, timeout=STATUS_MESSAGE_TIMEOUT)
+    //=========================================================
+    {
+        if (timeout == 0) {
+            this.__savedStatusMessage = message;
+        }
+        this.__statusMessage.innerHTML = message;
+        if (+timeout > 0) {
+            setTimeout(() => {
+                this.__statusMessage.innerHTML = this.__savedStatusMessage;
+            }, +timeout);
+        }
+    }
+
+    __featureHtml(featureProperties)
+    //==============================
+    {
+        // Feature properties
+        const html = [];
+        for (const [key, prompt] of Object.entries(FEATURE_DISPLAY_PROPERTIES)) {
+            const value = featureProperties[key];
+            if (value !== undefined && value !== '') {
+                const escapedValue = escape(value).replaceAll('\n', '<br/>');
+                html.push(`<div><span class="flatmap-annotation-prompt">${prompt}:</span><span class="flatmap-annotation-value">${escapedValue}</span></div>`)
+            }
+        }
+        return html;
+    }
+
+    __annotationHtml(annotations)
+    //===========================
+    {
+        const html = [];
+        let firstBlock = true;
+        for (const annotation of annotations) {
+            if (firstBlock) {
+                firstBlock = false;
+            } else {
+                html.push('<hr/>')
+            }
+            if (annotation['rdf:type'] === 'prov:Entity') {
+                const annotator = this.__creatorName(annotation['dct:creator']);
+                html.push(`<div><span class="flatmap-annotation-prompt">${annotation['dct:created']}</span><span class="flatmap-annotation-value">${annotator}</span></div>`);
+                for (const field of ANNOTATION_FIELDS) {
+                    const value = annotation[field.key];
+                    if (value !== undefined && value !== '') {
+                        const escapedValue = (field.kind === 'list')
+                                           ? value.filter(v => v.trim()).map(v => escape(v.trim())).join(', ')
+                                           : escape(value).replaceAll('\n', '<br/>');
+                        html.push(`<div><span class="flatmap-annotation-prompt">${field.prompt}:</span><span class="flatmap-annotation-value">${escapedValue}</span></div>`);
+                    }
+                }
+            }
+        }
+        return html.join('\n');
+    }
+
+    __editFormHtml(annotation)
+    //========================
+    {
+        const html = [];
+        html.push('<div id="flatmap-annotation-formdata">');
+        for (const field of ANNOTATION_FIELDS) {
+            html.push('<div class="flatmap-annotation-entry">');
+            html.push(`  <label for="${field.key}">${field.prompt}:</label>`);
+            const value = field.update ? annotation[field.key] || '' : '';
+            if (field.kind === 'textbox') {
+                html.push(`  <textarea rows="5" cols="40" id="${field.key}" name="${field.key}">${value.trim()}</textarea>`)
+            } else if (!('kind' in field) || field.kind !== 'list') {
+                html.push(`  <input type="text" size="40" id="${field.key}" name="${field.key}" value="${value.trim()}"/>`)
+            } else {   // field.kind === 'list'
+                html.push('  <div class="multiple">')
+                for (let n = 1; n <= field.size; n++) {
+                    const fieldValue = (n <= value.length) ? value[n-1].trim() : '';
+                    html.push(`    <input type="text" size="40" id="${field.key}_${n}" name="${field.key}" value="${fieldValue}"/>`)
+                }
+                html.push('  </div>')
+            }
+            html.push('</div>');
+        }
+        html.push('  <div><input id="annotation-save-button" type="button" value="Save"/></div>');
+        html.push('</div>');
+        return html.join('\n');
+    }
+
+    __changedAnnotation(lastAnnotation)
+    //=================================
+    {
+        const newProperties = {};
+        let propertiesChanged = false;
+        for (const field of ANNOTATION_FIELDS) {
+            const lastValue = field.update ? lastAnnotation[field.key] || '' : '';
+            if (!('kind' in field) || field.kind !== 'list') {
+                const inputField = document.getElementById(field.key);
+                newProperties[field.key] = inputField.value.trim();
+                if (!propertiesChanged && newProperties[field.key] !== lastValue.trim()) {
+                    propertiesChanged = true;
+                }
+            } else {   // field.kind === 'list'
+                newProperties[field.key] = [];
+                const changedList = false;
+                for (let n = 1; n <= field.size; n++) {
+                    const lastListValue = (n <= lastValue.length) ? lastValue[n-1].trim() : '';
+                    const inputField = document.getElementById(`${field.key}_${n}`);
+                    const newListValue = inputField.value.trim();
+                    newProperties[field.key].push(newListValue);
+                    if (!propertiesChanged && newListValue !== lastListValue) {
+                        propertiesChanged = true;
+                    }
+                }
+            }
+        }
+        return {
+            changed: propertiesChanged,
+            properties: newProperties
+        }
+    }
+
+    __updateRemoteAnnotation(annotation, callback)
+    //============================================
+    {
+        const abortController = new AbortController();
+        const url = this.__flatmap.addBaseUrl_(`/annotations/${this.__currentFeatureId}`);
+        fetch(url, {
+            headers: { "Content-Type": "application/json; charset=utf-8" },
+            method: 'POST',
+            body: JSON.stringify(annotation),
+            signal: abortController.signal
+        }).then((response) => {
+            if (response.ok) {
+                callback(response.json());
+            } else {
+                callback({error: `${response.status} ${response.statusText}`});
+            }
+        });
+        return abortController;
+    }
+
+    __saveAnnotation(panel, lastAnnotation)
+    //=====================================
+    {
+        const changedProperties = this.__changedAnnotation(lastAnnotation);
+        if (this.__currentFeatureId !== undefined && changedProperties.changed) {
+            const annotation = {
+                ...changedProperties.properties,
+                'rdf:type': 'prov:Entity',
+                'dct:subject': `flatmaps:${this.__flatmap.uuid}/${this.__currentFeatureId}`,
+                'dct:creator': this.user
+            }
+            panel.headerlogo.innerHTML = '<span class="fa fa-spinner fa-spin ml-2"></span>';
+            const remoteUpdate = this.__updateRemoteAnnotation(annotation,
+                (response) => {
+                    if ('error' in response) {
+                        panel.headerlogo.innerHTML = response.error;
+                    } else {
+                        panel.headerlogo.innerHTML = '';
+                        panel.close();
+                    }
+                });
+            setTimeout((panel) => {
+                if (panel.status !== 'closed') {
+                    console.log("Aborting remote update...");
+                    remoteUpdate.abort();
+                    panel.headerlogo.innerHTML = '';
+                    this.__setStatusMessage('Cannot update annotation...');
+                }
+            }, UPDATE_TIMEOUT, panel);
+        } else {
+            this.__
+            this.__setStatusMessage('No changes to save...');
+        }
+    }
+
+    __finishPanelContent(panel, response)
+    //====================================
+    {
+        this.__haveAnnotation = true;
+        this.__existingAnnotation.innerHTML = this.__annotationHtml(response);
+        const lastAnnotation = response.length ? response[0] : {};
+        this.__annotationForm.innerHTML = this.__editFormHtml(lastAnnotation);
+
+        // Lock focus to focusable elements within the panel
+        const inputElements = panel.content.querySelectorAll('input, textarea, button');
+        this.__firstInputField = inputElements[0];
+        const lastInput = inputElements[inputElements.length - 1];
+        const saveButton = document.getElementById('annotation-save-button');
+
+        panel.addEventListener('keydown', function (e) {
+            if (e.key === 'Tab') {
+                if ( e.shiftKey ) /* shift + tab */ {
+                    if (document.activeElement === this.__firstInputField) {
+                        lastInput.focus();
+                        e.preventDefault();
+                    }
+                } else /* tab */ {
+                    if (document.activeElement === lastInput) {
+                        this.__firstInputField.focus();
+                        e.preventDefault();
+                    }
+                }
+            } else if (e.key === 'Enter') {
+                if (e.target === saveButton) {
+                    this.__saveAnnotation(panel, lastAnnotation);
+                }
+            }
+        }.bind(this));
+
+        saveButton.addEventListener('mousedown', function (e) {
+            this.__saveAnnotation(panel, lastAnnotation);
+        }.bind(this));
+    }
+
+    annotate(feature, closedCallback)
+    //===============================
+    {
+        this.__currentFeatureId = feature.properties['id']
+
+        if (this.__currentFeatureId === undefined) {
+            closedCallback();
+            return;
+        }
+
+        const panelContent = [];
+        panelContent.push('<div id="flatmap-annotation-panel">');
+        panelContent.push('  <div id="flatmap-annotation-feature">');
+        panelContent.push(...this.__featureHtml(feature.properties));
+        panelContent.push('  </div>');
+        panelContent.push('  <form id="flatmap-annotation-form"></form>');
+        panelContent.push('  <div id="flatmap-annotation-existing"></div>');
+        panelContent.push('</div>');
+
+        const annotator = this;             // To use in panel code
+        const flatmap = this.__flatmap;     // To use in panel code
+        const contentFetchAbort = new AbortController();
+        this.__panel = jsPanel.create({
+            theme: 'light',
+            border: '2px solid #080',
+            borderRadius: '.5rem',
+            panelSize: '725px auto',
+            position: 'left-top',
+            data: {
+                flatmap: this.__flatmap
+            },
+            content: panelContent.join('\n'),
+            closeOnEscape: true,
+            closeOnBackdrop: false,
+            headerTitle: 'Feature annotations',
+            headerControls: 'closeonly xs',
+            footerToolbar: [
+                '<span id="flatmap-annotation-status" class="flex-auto"></span>',
+                '<span id="flatmap-annotation-lock" class="jsPanel-ftr-btn fa fa-lock"></span>',
+            ],
+            contentFetch: {
+                resource: flatmap.addBaseUrl_(`/annotations/${this.__currentFeatureId}`),
+                fetchInit: {
+                    method: 'GET',
+                    mode: 'cors',
+                    headers: {
+                        "Accept": "application/json; charset=utf-8",
+                        "Cache-Control": "no-store"
+                    },
+                    signal: contentFetchAbort.signal
+                },
+                bodyMethod: 'json',
+                beforeSend: (fetchConfig, panel) => {
+                    panel.headerlogo.innerHTML = '<span class="fa fa-spinner fa-spin ml-2"></span>';
+                    setTimeout((panel) => {
+                        if (!annotator.__haveAnnotation) {
+                            console.log("Aborting content fetch...");
+                            contentFetchAbort.abort();
+                            panel.headerlogo.innerHTML = '';
+                            annotator.__setStatusMessage('Cannot fetch annotation...');
+                            annotator.__authoriseLock.className = '';
+                        }
+                    }, FETCH_TIMEOUT, panel);
+                },
+                done: (response, panel) => {
+                    annotator.__finishPanelContent(panel, response);
+                    panel.headerlogo.innerHTML = '';
+                }
+            },
+            callback: (panel) => {
+                annotator.__annotationForm = document.getElementById('flatmap-annotation-form');
+                // Data entry only once authorised
+                annotator.__annotationForm.hidden = true;
+
+                // Populate once we have content from server
+                annotator.__existingAnnotation = document.getElementById('flatmap-annotation-existing');
+                annotator.__statusMessage = document.getElementById('flatmap-annotation-status');
+
+                annotator.__authoriseLock = document.getElementById('flatmap-annotation-lock');
+                annotator.__authoriseLock.addEventListener('click', (e) => {
+                    const lockClasses = annotator.__authoriseLock.classList;
+                    if (lockClasses.contains('fa-lock')) {
+                        annotator.__authorise(panel, (response) => {
+                            if ('error' in response) {
+                                annotator.__setStatusMessage(response.error);
+                            } else {
+                                annotator.__annotationForm.hidden = false;
+                                annotator.__firstInputField.focus();
+                                lockClasses.remove('fa-lock');
+                                lockClasses.add('fa-unlock');
+                            }
+                        });
+                    } else {
+                        annotator.__unauthorise();
+                        annotator.__annotationForm.hidden = true;
+                        lockClasses.remove('fa-unlock');
+                        lockClasses.add('fa-lock');
+                    }
+                });
+
+                // should we warn if unsaved changes when closing??
+                document.addEventListener('jspanelclosed', closedCallback, false);
+            }
+        });
+
+    }
+
+}
+
+//==============================================================================

package/src/flatmap-viewer.js

@@ -29,18 +29,17 @@ import 'maplibre-gl/dist/maplibre-gl.css';
 
 // Load our stylesheet last so we can overide styling rules
 
-import '../static/flatmap-viewer.css';
+import '../static/css/flatmap-viewer.css';
 
 //==============================================================================
 
 import {MapServer} from './mapserver.js';
 import {MinimapControl} from './minimap.js';
 import {NavigationControl} from './controls.js';
-import {SearchIndex, SearchResults} from './search.js';
+import {SearchIndex} from './search.js';
 import {UserInteractions} from './interactions.js';
 
 import * as images from './images.js';
-import * as pathways from './pathways.js';
 import * as utils from './utils.js';
 
 //==============================================================================
@@ -419,6 +418,20 @@ class FlatMap
      */
     get id()
     //======
+    {
+        return this.__id;
+    }
+
+    /**
+     * The map's unique universal identifier.
+     *
+     * For published maps this is different to the map's ``id``;
+     * it might be the same as ``id`` for unpublished maps.
+     *
+     * @type string
+     */
+    get uuid()
+    //========
     {
         return this.__uuid;
     }
@@ -587,9 +600,10 @@ class FlatMap
     //=======
     {
         return {
-            'minZoom': this._map.getMinZoom(),
-            'zoom':    this._map.getZoom(),
-            'maxZoom': this._map.getMaxZoom()
+            mapUUID: this.__uuid,
+            minZoom: this._map.getMinZoom(),
+            zoom:    this._map.getZoom(),
+            maxZoom: this._map.getMaxZoom()
         }
     }
 
@@ -597,6 +611,7 @@ class FlatMap
     //===========================
     {
         if (this._callback) {
+            data.mapUUID = this.__uuid;
             return this._callback(type, data, ...args);
         }
     }

package/src/interactions.js

@@ -33,19 +33,18 @@ import polylabel from 'polylabel';
 
 //==============================================================================
 
-import {ContextMenu} from './contextmenu.js';
-import {displayedProperties} from './info.js';
-import {InfoControl} from './info.js';
-import {LayerManager} from './layers.js';
-import {PATHWAYS_LAYER, Pathways} from './pathways.js';
+import {Annotator} from './annotation';
+import {displayedProperties, InfoControl} from './info';
+import {LayerManager} from './layers';
+import {PATHWAYS_LAYER, Pathways} from './pathways';
 import {BackgroundControl, LayerControl, NerveControl,
-        PathControl, SCKANControl} from './controls.js';
-import {SearchControl} from './search.js';
-import {VECTOR_TILES_SOURCE} from './styling.js';
+        PathControl, SCKANControl} from './controls';
+import {SearchControl} from './search';
+import {VECTOR_TILES_SOURCE} from './styling';
 import {SystemsControl, SystemsManager} from './systems';
 
-import * as pathways from './pathways.js';
-import * as utils from './utils.js';
+import * as pathways from './pathways';
+import * as utils from './utils';
 
 //==============================================================================
 
@@ -198,6 +197,10 @@ export class UserInteractions
             }
         }
 
+        // Add annotation capabilities
+
+        this.__annotator = new Annotator(flatmap);
+
         // Handle mouse events
 
         this._map.on('click', this.clickEvent_.bind(this));
@@ -923,9 +926,34 @@ export class UserInteractions
         }
     }
 
+    __annotationEvent(feature)
+    //========================
+    {
+        event.preventDefault();
+
+        // Remove any tooltip
+        this.removeTooltip_();
+
+        // Select the feature
+        this.selectFeature_(feature.id);
+
+        // Don't respond to mouse events while the dialog is open
+        this.setModal_();
+
+        // The annotation dialog...
+        this.__annotator.annotate(feature, e => {
+            this.__unselectFeatures();
+            this.__clearModal();
+        });
+    }
+
     clickEvent_(event)
     //================
     {
+        if (this._modal) {
+            return;
+        }
+
         this.clearActiveMarker_();
         const clickedFeatures = this._map.queryRenderedFeatures(event.point)
                                     .filter(feature => this.__enabledFeature(feature));
@@ -935,9 +963,14 @@ export class UserInteractions
         }
         const clickedFeature = clickedFeatures[0];
         const originalEvent = event.originalEvent;
+        if (originalEvent.altKey) {
+            this.__annotationEvent(clickedFeature);
+            return;
+        }
+
         this.selectionEvent_(originalEvent, clickedFeature);
         if (this._modal) {
-           // Remove tooltip, reset active features, etc
+            // Remove tooltip, reset active features, etc
             this.__resetFeatureDisplay();
             this.__unselectFeatures();
             this.__clearModal();