@abi-software/flatmap-viewer 2.7.2 → 2.7.3-a.2

package/dist/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { standaloneViewer } from '../src/main';
+import { FlatMap, MapManager } from '../src/flatmap-viewer';
+
+export { FlatMap, MapManager, standaloneViewer };

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@abi-software/flatmap-viewer",
-  "version": "2.7.2",
+  "version": "2.7.3-a.2",
   "description": "Flatmap viewer using Maplibre GL",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AnatomicMaps/flatmap-viewer.git"
   },
   "type": "module",
-  "main": "lib/index.ts",
   "files": [
-    "lib",
-    "src",
-    "static",
-    "thirdParty"
+    "dist"
   ],
+  "module": "./dist/flatmap-viewer.es.js",
+  "exports": {
+    ".": {
+      "import": "./dist/flatmapviewer.js"
+    }
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "dev": "vite serve app --port 3000",
@@ -47,6 +49,7 @@
     "glob": "^10.3.12",
     "typescript": "^5.2.2",
     "vite": "^5.1.4",
-    "vite-plugin-dts": "^3.8.1"
+    "vite-plugin-dts": "^3.8.1",
+    "vite-plugin-lib-inject-css": "^2.0.1"
   }
 }

package/lib/index.ts

@@ -1,10 +0,0 @@
-//==============================================================================
-
-import {FlatMap, MapManager} from '../src/flatmap-viewer'
-import {standaloneViewer} from '../src/main'
-
-//==============================================================================
-
-export {FlatMap, MapManager, standaloneViewer}
-
-//==============================================================================

package/src/contextmenu.js

@@ -1,97 +0,0 @@
-/******************************************************************************
-
-Flatmap viewer and annotation tool
-
-Copyright (c) 2019  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';
-
-//==============================================================================
-
-import maplibregl from 'maplibre-gl';
-
-//==============================================================================
-
-function domContextMenu(items, title)
-{
-    const menuElement = document.createElement('ul');
-    menuElement.className = 'flatmap-contextmenu';
-    menuElement.setAttribute('type', 'context');
-
-    for (const item of items) {
-        if (item === '-') {
-            menuElement.appendChild(document.createElement('hr'));
-        } else {
-            const menuItem = document.createElement('li');
-            menuItem.className = 'flatmap-contextmenu-item';
-            menuItem.setAttribute('id', item.id);
-            menuItem.onclick = item.action;
-            menuItem.textContent = item.prompt;
-            menuElement.appendChild(menuItem);
-        }
-    }
-
-    return menuElement;
-}
-
-/*
-<ul>
-  <li>prompt</li>
-  <li>item 2</li>
-</ul>
-*/
-
-//==============================================================================
-
-export class ContextMenu
-{
-    constructor(flatmap, closeCallback)
-    {
-        this._flatmap = flatmap;
-        this._map = flatmap.map;
-        this._closeCallback = closeCallback;
-        this._popup = new maplibregl.Popup({
-            closeButton: true,
-            closeOnClick: true,
-            className: 'flatmap-contextmenu-popup',
-            maxWidth: 'none'
-        });
-        this._popup.on('close', this.popupClose_.bind(this));
-    }
-
-    hide()
-    //====
-    {
-        this._popup.remove();
-    }
-
-    popupClose_(e)
-    //============
-    {
-        this._closeCallback();
-    }
-
-    show(position, menuItems, title)
-    //==============================
-    {
-        this._popup.setLngLat(position);
-        this._popup.setDOMContent(domContextMenu(menuItems, title));
-        this._popup.addTo(this._map);
-    }
-}
-
-//==============================================================================

package/src/controls/annotation.js

@@ -1,302 +0,0 @@
-/******************************************************************************
-
-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.
-
-**/
-
-/*
- *   Annotation drawing mode is enabled/disabled by:
- *
- *   1. A call to ``Flatmap.enableAnnotation()``
- *   2. An on-map control button calls this when in standalone viewing mode.
- *
- *   Drawn features include a GeoJSON geometry. Existing geometries of annotated
- *   features are added to the MapboxDraw control when the map is loaded. These
- *   should only be visible on the map when the draw control is active.
- *
- *   We listen for drawn features being created, updated and deleted, and notify
- *   the external annotator, first assigning new features and ID wrt the flatmap.
- *   The external annotator may reject a new feature (the user's cancelled the
- *   resulting dialog) which results in the newly drawn feature being removed from
- *   the control.
- *
- *   The external annotator is responsible for saving/obtaining drawn geometries
- *   from an annotation service.
- *
- */
-
-//==============================================================================
-
-import MapboxDraw from "@mapbox/mapbox-gl-draw"
-import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css'
-
-
-//==============================================================================
-
-const drawStyleIds = MapboxDraw.lib.theme.map(s => s.id)
-
-export const DRAW_ANNOTATION_LAYERS = [...drawStyleIds.map(id => `${id}.cold`),
-                                       ...drawStyleIds.map(id => `${id}.hot`)]
-
-//==============================================================================
-
-export class AnnotationDrawControl
-{
-    constructor(flatmap, visible=false)
-    {
-        MapboxDraw.constants.classes.CONTROL_BASE  = 'maplibregl-ctrl'
-        MapboxDraw.constants.classes.CONTROL_PREFIX = 'maplibregl-ctrl-'
-        MapboxDraw.constants.classes.CONTROL_GROUP = 'maplibregl-ctrl-group'
-
-        this.__flatmap = flatmap
-        this.__committedFeatures = new Map()
-        this.__uncommittedFeatureIds = new Set()
-        this.__visible = visible
-        this.__draw = new MapboxDraw({
-            displayControlsDefault: false,
-            controls: {
-                point: true,
-                line_string: true,
-                polygon: true,
-                trash: true
-            },
-            userProperties: true,
-            keybindings: true
-        })
-        this.__map = null
-        this.__inDrawing = false
-    }
-
-    onAdd(map)
-    //========
-    {
-        this.__map = map
-        this.__container = this.__draw.onAdd(map)
-
-        // Fix to allow deletion with Del Key when default trash icon is not shown.
-        // See https://github.com/mapbox/mapbox-gl-draw/issues/989
-        this.__draw.options.controls.trash = true
-
-        // Prevent firefox menu from appearing on Alt key up
-        window.addEventListener('keyup', function (e) {
-            if (e.key === "Alt") {
-                e.preventDefault();
-            }
-        }, false)
-        map.on('draw.modechange', this.modeChangedEvent.bind(this))
-        map.on('draw.create', this.createdFeature.bind(this))
-        map.on('draw.delete', this.deletedFeature.bind(this))
-        map.on('draw.update', this.updatedFeature.bind(this))
-        map.on('draw.selectionchange', this.selectionChangedEvent.bind(this))
-        this.show(this.__visible)
-        return this.__container
-    }
-
-    onRemove()
-    //========
-    {
-        this.__container.parentNode.removeChild(this.__container)
-        this.__container = null
-        this.__map = null
-    }
-
-    show(visible=true)
-    //================
-    {
-        if (this.__container) {
-            this.__container.style.display = visible ? 'block' : 'none'
-            if (visible && !this.__visible) {
-                for (const layerId of DRAW_ANNOTATION_LAYERS) {
-                    this.__map.setLayoutProperty(layerId, 'visibility', 'visible')
-                }
-            } else if (!visible && this.__visible) {
-                for (const layerId of DRAW_ANNOTATION_LAYERS) {
-                    this.__map.setLayoutProperty(layerId, 'visibility', 'none')
-                }
-            }
-        }
-        this.__visible = visible
-    }
-
-    #cleanFeature(event)
-    //==================
-    {
-        const features = event.features.filter(f => f.type === 'Feature')
-                                       .map(f => {
-                                            return {
-                                                id: f.id,
-                                                type: 'Feature',
-                                                geometry: f.geometry
-                                            }
-                                        })
-        return features.length ? features[0] : null
-    }
-
-    #sendEvent(type, feature)
-    //=======================
-    {
-        if (feature.id) {
-            // Add when the event is 'created', 'updated' or 'deleted'
-            this.__uncommittedFeatureIds.add(feature.id)
-        }
-        this.__flatmap.annotationEvent(type, feature)
-    }
-
-    createdFeature(event)
-    //===================
-    {
-        const feature = this.#cleanFeature(event)
-        if (feature) {
-            // Set properties to indicate that this is a drawn annotation
-            this.__draw.setFeatureProperty(feature.id, 'drawn', true)
-            this.__draw.setFeatureProperty(feature.id, 'label', 'Drawn annotation')
-            // They need to be on the feature passed to the annotator for storage
-            feature.properties = {
-                user_drawn: true,
-                user_label: 'Drawn annotation'
-            }
-            this.#sendEvent('created', feature)
-        }
-    }
-
-    deletedFeature(event)
-    //===================
-    {
-        const feature = this.#cleanFeature(event)
-        if (feature) {
-            if (this.__uncommittedFeatureIds.has(feature.id)) {
-                // Ignore delete on an uncommitted create or update
-            } else {
-                this.#sendEvent('deleted', feature)
-            }
-        }
-    }
-
-    updatedFeature(event)
-    //===================
-    {
-        const feature = this.#cleanFeature(event)
-        if (feature) {
-            // specify updated callback type, either `move` or `change_coordinates`
-            feature.action = event.action
-            if (this.__uncommittedFeatureIds.has(feature.id)) {
-                // Ignore updates on an uncommitted create or update
-            } else {
-                this.#sendEvent('updated', feature)
-            }
-        }
-    }
-
-    modeChangedEvent(event)
-    //=====================
-    {
-        // Used as a flag to indicate the feature mode
-        this.__inDrawing = (event.mode.startsWith('draw'))
-        this.#sendEvent('modeChanged', event)
-    }
-
-    selectionChangedEvent(event)
-    //==========================
-    {
-        // Used to indicate a feature is selected or deselected
-        this.#sendEvent('selectionChanged', event)
-    }
-
-    inDrawingMode()
-    //=============
-    {
-        return this.__inDrawing
-    }
-
-    commitEvent(event)
-    //================
-    {
-        const feature = event.feature
-        if (event.type === 'deleted') {
-            this.__committedFeatures.delete(feature.id)
-        } else {
-            this.__committedFeatures.set(feature.id, feature)
-        }
-        this.__uncommittedFeatureIds.delete(feature.id)
-    }
-
-    abortEvent(event)
-    //===============
-    {
-        // Used as a flag to indicate the popup is closed
-        // Rollback should be performed when triggered 'aborted' event
-        this.#sendEvent('aborted', event)
-    }
-
-    rollbackEvent(event)
-    //==================
-    {
-        const feature = event.feature
-        if (event.type === 'created') {
-            this.__draw.delete(feature.id)
-            this.__committedFeatures.delete(feature.id)
-            this.__uncommittedFeatureIds.delete(feature.id)
-        } else if (event.type === 'deleted') {
-            this.__draw.add(feature)
-            this.__committedFeatures.set(feature.id, feature)
-            this.__uncommittedFeatureIds.delete(feature.id)
-        } else if (event.type === 'updated') {
-            const savedFeature = this.__committedFeatures.get(feature.id)
-            if (savedFeature) {
-                this.__draw.delete(feature.id)
-                this.__draw.add(savedFeature)
-                this.__uncommittedFeatureIds.delete(feature.id)
-            }
-        }
-    }
-    
-    clearFeatures()
-    //=============
-    {
-        this.__draw.deleteAll()
-    }
-
-    removeFeature()
-    //=============
-    {
-        this.__draw.trash()
-    }
-
-    addFeature(feature)
-    //=================
-    {
-        feature = Object.assign({}, feature, {type: 'Feature'})
-        const ids = this.__draw.add(feature)
-        this.__committedFeatures.set(ids[0], feature)
-        this.__uncommittedFeatureIds.delete(ids[0])
-    }
-
-    refreshGeometry(feature)
-    //======================
-    {
-        return this.__draw.get(feature.id) || null
-    }
-
-    changeMode(type)
-    //==============
-    {
-        // Change the mode directly without listening to modes callback
-        this.__draw.changeMode(type.mode, type.options)
-    }
-}
-
-//==============================================================================