@vcmap/core 5.0.0-rc.27 → 5.0.0-rc.28

package/index.js

@@ -10,7 +10,6 @@ import './src/cesium/entity.js';
 export { default as Category } from './src/category/category.js';
 export { default as CategoryCollection } from './src/category/categoryCollection.js';
 export { layerClassRegistry, tileProviderClassRegistry, featureProviderClassRegistry, mapClassRegistry, styleClassRegistry, categoryClassRegistry, getObjectFromClassRegistry, default as ClassRegistry } from './src/classRegistry.js';
-export { volatileContextId, markVolatile, default as Context } from './src/context.js';
 export { default as AbstractFeatureProvider } from './src/featureProvider/abstractFeatureProvider.js';
 export { isProvidedFeature, showProvidedFeature } from './src/featureProvider/featureProviderSymbols.js';
 export { default as TileProviderFeatureProvider } from './src/featureProvider/tileProviderFeatureProvider.js';
@@ -122,7 +121,7 @@ export { default as startEditFeaturesSession } from './src/util/editor/editFeatu
 export { default as startEditGeometrySession } from './src/util/editor/editGeometrySession.js';
 export { createVertex, getClosestPointOn2DLine, pointOnLine3D, pointOnLine2D, createCameraVerticalPlane, createHorizontalPlane, getCartographicFromPlane, drapeGeometryOnTerrain, placeGeometryOnTerrain, ensureFeatureAbsolute, clampFeature } from './src/util/editor/editorHelpers.js';
 export { SessionType, setupScratchLayer, GeometryType } from './src/util/editor/editorSessionHelpers.js';
-export { vertexSymbol, vertexIndex, handlerSymbol } from './src/util/editor/editorSymbols.js';
+export { vertexSymbol, vertexIndex, handlerSymbol, mouseOverSymbol } from './src/util/editor/editorSymbols.js';
 export { default as CreateBBoxInteraction } from './src/util/editor/interactions/createBBoxInteraction.js';
 export { default as CreateCircleInteraction } from './src/util/editor/interactions/createCircleInteraction.js';
 export { default as CreateLineStringInteraction } from './src/util/editor/interactions/createLineStringInteraction.js';
@@ -134,9 +133,11 @@ export { default as EnsureHandlerSelectionInteraction } from './src/util/editor/
 export { default as InsertVertexInteraction } from './src/util/editor/interactions/insertVertexInteraction.js';
 export { default as MapInteractionController } from './src/util/editor/interactions/mapInteractionController.js';
 export { default as RemoveVertexInteraction } from './src/util/editor/interactions/removeVertexInteraction.js';
+export { SelectionMode, default as SelectFeatureMouseOverInteraction } from './src/util/editor/interactions/selectFeatureMouseOverInteraction.js';
 export { default as SelectMultiFeatureInteraction } from './src/util/editor/interactions/selectMultiFeatureInteraction.js';
 export { default as SelectSingleFeatureInteraction } from './src/util/editor/interactions/selectSingleFeatureInteraction.js';
 export { default as TranslateVertexInteraction } from './src/util/editor/interactions/translateVertexInteraction.js';
+export { getDefaultHighlightStyle, default as startSelectFeaturesSession } from './src/util/editor/selectFeaturesSession.js';
 export { default as create2DHandlers } from './src/util/editor/transformation/create2DHandlers.js';
 export { default as create3DHandlers } from './src/util/editor/transformation/create3DHandlers.js';
 export { default as ExtrudeInteraction } from './src/util/editor/transformation/extrudeInteraction.js';
@@ -169,7 +170,8 @@ export { isOverrideCollection, default as makeOverrideCollection } from './src/u
 export { wgs84ToMercatorTransformer, mercatorToWgs84Transformer, setDefaultProjectionOptions, getDefaultProjection, wgs84Projection, mercatorProjection, default as Projection } from './src/util/projection.js';
 export { isSameOrigin } from './src/util/urlHelpers.js';
 export { propertyEqualsEpsilon, angleEqualsEpsilon, coordinateEqualsEpsilon, default as Viewpoint } from './src/util/viewpoint.js';
-export { defaultDynamicContextId, getVcsAppById, default as VcsApp } from './src/vcsApp.js';
-export { contextIdSymbol, deserializeMap, deserializeViewpoint, deserializeLayer, serializeLayer, getLayerIndex, destroyCollection } from './src/vcsAppContextHelpers.js';
+export { defaultDynamicModuleId, getVcsAppById, default as VcsApp } from './src/vcsApp.js';
 export { default as VcsEvent } from './src/vcsEvent.js';
+export { volatileModuleId, markVolatile, default as VcsModule } from './src/vcsModule.js';
+export { moduleIdSymbol, deserializeMap, deserializeViewpoint, deserializeLayer, serializeLayer, getLayerIndex, destroyCollection } from './src/vcsModuleHelpers.js';
 export { default as VcsObject } from './src/vcsObject.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.27",
+  "version": "5.0.0-rc.28",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/category/category.js

@@ -1,7 +1,7 @@
 import { check } from '@vcsuite/check';
 import { v4 as uuidv4 } from 'uuid';
 import { Feature } from 'ol';
-import { contextIdSymbol, destroyCollection } from '../vcsAppContextHelpers.js';
+import { moduleIdSymbol, destroyCollection } from '../vcsModuleHelpers.js';
 import makeOverrideCollection, { isOverrideCollection } from '../util/overrideCollection.js';
 import VcsObject from '../vcsObject.js';
 import VectorLayer from '../layer/vectorLayer.js';
@@ -25,7 +25,7 @@ import VcsEvent from '../vcsEvent.js';
 /**
  * @type {*|string}
  */
-const categoryContextId = uuidv4();
+const categoryModuleId = uuidv4();
 
 /**
  * @param {import("@vcmap/core").VectorLayer} layer
@@ -69,7 +69,7 @@ function checkMergeOptionOverride(key, value, defaultOption, option) {
 /**
  * A category contains user based items and is a special container. The container should not be created directly, but via
  * the requestCategory API on the categories collection. Do not use toJSON to retrieve the state of a category, since
- * categories outlive contexts and may be changed with mergeOptions to no longer reflect your initial state. Requestors
+ * categories outlive modules and may be changed with mergeOptions to no longer reflect your initial state. Requestors
  * should keep track of the requested options themselves.
  * @class
  * @extends {VcsObject}
@@ -128,7 +128,7 @@ class Category extends VcsObject {
     this._layer = null;
     if (this._featureProperty) {
       this._layer = new VectorLayer(this._layerOptions);
-      this._layer[contextIdSymbol] = categoryContextId;
+      this._layer[moduleIdSymbol] = categoryModuleId;
     }
     /**
      * @type {string}
@@ -156,7 +156,7 @@ class Category extends VcsObject {
      * @type {function():void}
      * @private
      */
-    this._contextRemovedListener = () => {};
+    this._moduleRemovedListener = () => {};
   }
 
   /**
@@ -246,11 +246,11 @@ class Category extends VcsObject {
    * @returns {string}
    * @private
    */
-  _getDynamicContextId() {
+  _getDynamicModuleId() {
     if (!this._app) {
-      throw new Error('Cannot get dynamic context id, before setting the vcApp');
+      throw new Error('Cannot get dynamic module id, before setting the vcApp');
     }
-    return this._app.dynamicContextId;
+    return this._app.dynamicModuleId;
   }
 
   /**
@@ -305,7 +305,7 @@ class Category extends VcsObject {
       /** @type {OverrideCollection} */ (collection) :
       makeOverrideCollection(
         collection,
-        this._getDynamicContextId.bind(this),
+        this._getDynamicModuleId.bind(this),
         this._serializeItem.bind(this),
         this._deserializeItem.bind(this),
       );
@@ -337,8 +337,8 @@ class Category extends VcsObject {
       throw new Error('Cannot switch apps');
     }
     this._app = app;
-    this._contextRemovedListener = this._app.contextRemoved.addEventListener((context) => {
-      this._collection.removeContext(context.id);
+    this._moduleRemovedListener = this._app.moduleRemoved.addEventListener((module) => {
+      this._collection.removeModule(module._id);
     });
     if (this._layer) {
       this._app.layers.add(this._layer);
@@ -378,17 +378,17 @@ class Category extends VcsObject {
   }
 
   /**
-   * @param {string} contextId
+   * @param {string} moduleId
    * @returns {{ name: string, items: Array<Object>}|null}
    */
-  serializeForContext(contextId) {
+  serializeModule(moduleId) {
     if (this._collection.size === 0) {
       return null;
     }
 
     return {
       name: this.name,
-      items: this.collection.serializeContext(contextId),
+      items: this.collection.serializeModule(moduleId),
     };
   }
 
@@ -431,8 +431,8 @@ class Category extends VcsObject {
 
     this._collectionListeners.forEach((cb) => { cb(); });
     this._collectionListeners.splice(0);
-    this._contextRemovedListener();
-    this._contextRemovedListener = () => {};
+    this._moduleRemovedListener();
+    this._moduleRemovedListener = () => {};
     destroyCollection(this._collection);
     this._collectionChanged.destroy();
     this._app = null;

package/src/category/categoryCollection.js

@@ -26,7 +26,7 @@ class CategoryCollection extends IndexedCollection {
      */
     this._app = app;
     /**
-     * Map of category names, where the value is a map of contextId and items.
+     * Map of category names, where the value is a map of moduleId and items.
      * @type {Map<string, Map<string, Array<Object>>>}
      * @private
      */
@@ -35,10 +35,10 @@ class CategoryCollection extends IndexedCollection {
      * @type {Function}
      * @private
      */
-    this._contextRemovedListener = this._app.contextRemoved.addEventListener((context) => {
-      this._cache.forEach((contextMap, name) => {
-        contextMap.delete(context.id);
-        if (contextMap.size === 0) {
+    this._moduleRemovedListener = this._app.moduleRemoved.addEventListener((module) => {
+      this._cache.forEach((moduleMap, name) => {
+        moduleMap.delete(module._id);
+        if (moduleMap.size === 0) {
           this._cache.delete(name);
         }
       });
@@ -60,8 +60,8 @@ class CategoryCollection extends IndexedCollection {
     if (added != null && this._cache.has(category.name)) {
       this._cache
         .get(category.name)
-        .forEach((items, contextId) => {
-          this.parseCategoryItems(category.name, items, contextId);
+        .forEach((items, moduleId) => {
+          this.parseCategoryItems(category.name, items, moduleId);
         });
 
       this._cache.delete(category.name);
@@ -83,18 +83,18 @@ class CategoryCollection extends IndexedCollection {
    * they will be cached, until such a category is requested.
    * @param {string} name
    * @param {Array<Object>} items
-   * @param {string} contextId
+   * @param {string} moduleId
    * @returns {Promise<void>}
    */
-  async parseCategoryItems(name, items, contextId) {
+  async parseCategoryItems(name, items, moduleId) {
     const category = this.getByKey(name);
 
     if (category) {
-      await category.collection.parseItems(items, contextId);
+      await category.collection.parseItems(items, moduleId);
     } else if (this._cache.has(name)) {
-      this._cache.get(name).set(contextId, items);
+      this._cache.get(name).set(moduleId, items);
     } else {
-      this._cache.set(name, new Map([[contextId, items]]));
+      this._cache.set(name, new Map([[moduleId, items]]));
     }
   }
 
@@ -135,7 +135,7 @@ class CategoryCollection extends IndexedCollection {
 
   destroy() {
     super.destroy();
-    this._contextRemovedListener();
+    this._moduleRemovedListener();
     this._cache.clear();
     this._app = null;
   }

package/src/interaction/eventHandler.js

@@ -215,18 +215,18 @@ class EventHandler {
    * Add a dynamic interaction to the interaction chain. This is the default methodology for
    * user map interactions, such as drawing or measuring. If another exclusive interaction is added,
    * this interaction is removed and a provided callback is called. Use the id parameter to add multiple interactions
-   * from the same source (if you don't wish to provide an {@link InteractionChain}
+   * from the same source (if you don't wish to provide an {@link InteractionChain})
    * @param {AbstractInteraction} interaction
    * @param {Function} removed - the callback for when the interaction is forcefully removed.
-   * @param {number=} [index=3] - the position at which to push the interaction
+   * @param {number=} index - the position at which to push the interaction. If no index is provided, the interaction is pushed at the end and therefore is executed last.
    * @param {string=} id - an id to allow for multiple interactions to belong to the same exclusive registerer
    * @returns {Function} function to remove the interaction with. returns number of removed interactions (0|1)
    * @api
    */
-  addExclusiveInteraction(interaction, removed, index = 3, id) {
+  addExclusiveInteraction(interaction, removed, index, id) {
     check(interaction, AbstractInteraction);
     check(removed, Function);
-    check(index, Number);
+    checkMaybe(index, Number);
     checkMaybe(id, String);
 
     if (this._exclusiveInteraction && this._exclusiveInteraction.id !== id) {

package/src/layer/featureVisibility.js

@@ -3,7 +3,6 @@ import Feature from 'ol/Feature.js';
 import Style from 'ol/style/Style.js';
 
 import VectorStyleItem, { fromCesiumColor } from '../style/vectorStyleItem.js';
-import { emptyStyle } from '../style/styleHelpers.js';
 import VcsEvent from '../vcsEvent.js';
 
 /**
@@ -71,7 +70,7 @@ export function hideFeature(feature) {
   ) {
     feature.show = false;
   } else if (feature instanceof Feature) {
-    feature.setStyle(emptyStyle.clone());
+    feature.changed();
   }
 }
 
@@ -106,7 +105,7 @@ export function resetOriginalStyle(feature) {
     ) {
       feature.color = style;
     } else if (feature instanceof Feature) {
-      feature.setStyle(style);
+      feature.changed();
     }
     delete feature[originalStyle];
   }
@@ -125,7 +124,7 @@ export function highlightFeature(feature) {
     ) {
       feature.color = style.cesiumFillColor;
     } else if (feature instanceof Feature) {
-      feature.setStyle(/** @type {import("ol/style/Style").default} */ (style.style));
+      feature.changed();
     }
   }
 }

package/src/layer/globalHider.js

@@ -17,7 +17,7 @@ import VcsEvent from '../vcsEvent.js';
  * GlobalHider globally hides features existing within a layer of a {@link LayerCollection}.
  * Features can be defined as hidden by {@link VcsAppConfig} or {@link LayerOptions}.
  * Hiding will be performed, when a {@link Context} is loaded, a {@link Layer} is activated or GlobalHider API is called.
- * A feature can be hidden multiple times by different actors, e.g. contexts, layers, which is handled by this class.
+ * A feature can be hidden multiple times by different actors, e.g. modules, layers, which is handled by this class.
  * A feature will be shown again, when a {@link Context} is removed, a {@link Layer} is deactivated or GlobalHider API is called.
  * @class
  */

package/src/layer/layer.js

@@ -31,6 +31,7 @@ import GlobalHider from './globalHider.js';
  * @property {number|undefined} screenSpaceError
  * @property {*|undefined} flightOptions
  * @property {string|undefined} baseUrl
+ * @property {Object|undefined} [layerProperties] - the layers properties bag
  * @api
  */
 
@@ -86,7 +87,7 @@ import GlobalHider from './globalHider.js';
  * @type {string}
  * @const
  */
-export const vcsMetaVersion = '2.0';
+export const vcsMetaVersion = '2.1';
 
 /**
  * Abstract base class for Layers.

package/src/layer/vectorLayer.js

@@ -288,6 +288,10 @@ class VectorLayer extends FeatureLayer {
       // TODO embed icons here by running over all features? this is never used anywhere
     }
 
+    if (Object.keys(this.properties).length !== 0) {
+      vcsMeta.layerProperties = { ...this.properties };
+    }
+
     return vcsMeta;
   }
 
@@ -297,6 +301,9 @@ class VectorLayer extends FeatureLayer {
    */
   setVcsMeta(vcsMeta) { // XXX what about the style?
     this.vectorProperties.setVcsMeta(vcsMeta);
+    if (vcsMeta.layerProperties) {
+      Object.assign(this.properties, vcsMeta.layerProperties);
+    }
   }
 
   /**

package/src/oblique/helpers.js

@@ -437,16 +437,14 @@ export async function transformFromImage(image, imageCoordinate, options = {}) {
  * @returns {boolean}
  */
 export function hasSameOrigin(url) {
-  // relative Url, return true;
-  if (!/^[a-z][a-z0-9+.-]*:/.test(url)) {
-    return true;
-  }
-  // data uri, return true
-  if (/^data:/.test(url)) {
+  const windowUrl = new URL(window.location.href);
+  const parsedUrl = new URL(url, window.location.href);
+
+  if (parsedUrl.protocol === 'data:') {
     return true;
   }
 
-  const currentUri = new URL(window.location.href);
-  const uri = new URL(url);
-  return currentUri.host.toLowerCase() === uri.host.toLocaleLowerCase();
+  return windowUrl.origin === parsedUrl.origin &&
+    windowUrl.port === parsedUrl.port &&
+    windowUrl.protocol === parsedUrl.protocol;
 }

package/src/ol/feature.js

@@ -1,4 +1,6 @@
 import Feature from 'ol/Feature.js';
+import { Style } from 'ol/style.js';
+import { globalHidden, hidden, highlighted } from '../layer/featureVisibility.js';
 
 /**
  * To be used for cesium 3D style functions
@@ -43,5 +45,31 @@ Feature.prototype.getPropertyInherited = function getPropertyInherited(property)
   return this.getProperty(property);
 };
 
+const originalStyleFunction = Feature.prototype.getStyleFunction;
+Feature.prototype.getStyleFunction = function getStyleFunction() {
+  if (this[hidden] || this[globalHidden]) {
+    return () => [];
+  }
+
+  if (this[highlighted]) {
+    return () => [this[highlighted].style];
+  }
+  return originalStyleFunction.bind(this)();
+};
+
+const originalGetStyle = Feature.prototype.getStyle;
+Feature.prototype.getStyle = function getStyle() {
+  if (this[hidden] || this[globalHidden]) {
+    return new Style({});
+  }
+
+  if (this[highlighted]) {
+    return this[highlighted].style;
+  }
+
+  return originalGetStyle.bind(this)();
+};
+
 // TODO implement getExactClassName, isClass & isExactClass
 // TODO implement feature.content.tileset.timeSinceLoad
+

package/src/overrideClassRegistry.js

@@ -20,12 +20,12 @@ class OverrideClassRegistry {
   constructor(coreClassRegistry) {
     this._coreClassRegistry = coreClassRegistry;
     /**
-     * @type {Map<string, { contextId: string, ctor: function(new: T, ...*) }>}
+     * @type {Map<string, { moduleId: string, ctor: function(new: T, ...*) }>}
      * @private
      */
     this._classMap = new Map();
     /**
-     * @type {Map<string, Array<{ contextId: string, ctor: function(new: T, ...*) }>>}
+     * @type {Map<string, Array<{ moduleId: string, ctor: function(new: T, ...*) }>>}
      * @private
      */
     this._classShadows = new Map();
@@ -49,18 +49,18 @@ class OverrideClassRegistry {
   }
 
   /**
-   * Register a class for a given context by name. If the class already exists, it will be replaced and replaced called with the classeName.
-   * @param {string} contextId
+   * Register a class for a given module by name. If the class already exists, it will be replaced and replaced called with the classeName.
+   * @param {string} moduleId
    * @param {string} className
    * @param {function(new: T, ...*)} ctor
    */
-  registerClass(contextId, className, ctor) {
-    check(contextId, String);
+  registerClass(moduleId, className, ctor) {
+    check(moduleId, String);
     check(className, String);
     check(ctor, Function);
 
     const entry = {
-      contextId,
+      moduleId,
       ctor,
     };
 
@@ -83,16 +83,16 @@ class OverrideClassRegistry {
    * Unregister a previously registered class. You can only unregister classes added to this registry, not the underlying core registry.
    * If when registering this class you have replaced class, it will be re-instated and replaced called.
    * If there is no previously registered class, it will be removed and removed will be called.
-   * @param {string} contextId
+   * @param {string} moduleId
    * @param {string} className
    */
-  unregisterClass(contextId, className) {
-    check(contextId, String);
+  unregisterClass(moduleId, className) {
+    check(moduleId, String);
     check(className, String);
 
     if (this._classShadows.has(className)) {
       const shadowsArray = this._classShadows.get(className);
-      const newShadowsArray = shadowsArray.filter(e => e.contextId !== contextId);
+      const newShadowsArray = shadowsArray.filter(e => e.moduleId !== moduleId);
       if (newShadowsArray.length === 0) {
         this._classShadows.delete(className);
       } else if (newShadowsArray.length !== shadowsArray.length) {
@@ -102,7 +102,7 @@ class OverrideClassRegistry {
 
     if (
       this._classMap.has(className) &&
-      this._classMap.get(className).contextId === contextId
+      this._classMap.get(className).moduleId === moduleId
     ) {
       this._classMap.delete(className);
       if (this._classShadows.has(className)) {
@@ -177,15 +177,15 @@ class OverrideClassRegistry {
   }
 
   /**
-   * Removes all classes registered from within a certain context. Will re-instate classes overwritten by the context
+   * Removes all classes registered from within a certain module. Will re-instate classes overwritten by the module
    * and call the appropriate events, outlined in unregisterClass.
-   * @param {string} contextId
+   * @param {string} moduleId
    */
-  removeContext(contextId) {
-    check(contextId, String);
+  removeModule(moduleId) {
+    check(moduleId, String);
 
     this._classMap.forEach((cb, className) => {
-      this.unregisterClass(contextId, className);
+      this.unregisterClass(moduleId, className);
     });
   }
 

package/src/style/declarativeStyleItem.js

@@ -11,7 +11,6 @@ import Fill from 'ol/style/Fill.js';
 import StyleItem from './styleItem.js';
 import {
   cesiumColorToColor,
-  emptyStyle,
   getDefaultCondition,
   whiteColor,
 } from './styleHelpers.js';
@@ -191,7 +190,7 @@ class DeclarativeStyleItem extends StyleItem {
   _styleFunction(feature) {
     const actualFeature = feature[originalFeatureSymbol] || feature;
     if (!this.cesiumStyle.show.evaluate(actualFeature)) {
-      return emptyStyle;
+      return undefined;
     }
 
     const geometryType = actualFeature.getGeometry().getType();
@@ -219,7 +218,7 @@ class DeclarativeStyleItem extends StyleItem {
     }
 
     this.getLogger().warning(`could not style geometry type: ${geometryType}`);
-    return emptyStyle;
+    return undefined;
   }
 
   /**