@vcmap/core 5.0.0-rc.35 → 5.0.0-rc.37

package/src/category/categoryCollection.ts

@@ -9,6 +9,9 @@ function getLogger(): Logger {
   return getLoggerByName('CategoryCollection');
 }
 
+/**
+ * @group Category
+ */
 class CategoryCollection extends IndexedCollection<Category> {
   private _app: VcsApp;
 

package/src/featureProvider/abstractFeatureProvider.ts

@@ -10,10 +10,7 @@ import { defaultVectorStyle } from '../style/vectorStyleItem.js';
 import VectorProperties, {
   type VectorPropertiesOptions,
 } from '../layer/vectorProperties.js';
-import {
-  isProvidedFeature,
-  showProvidedFeature,
-} from './featureProviderSymbols.js';
+import { isProvidedFeature } from './featureProviderSymbols.js';
 import StyleItem, { type StyleItemOptions } from '../style/styleItem.js';
 import type VcsMap from '../map/vcsMap.js';
 
@@ -131,7 +128,6 @@ class AbstractFeatureProvider extends VcsObject {
     }
     feature[vcsLayerName] = this.layerName;
     feature[isProvidedFeature] = true;
-    feature[showProvidedFeature] = this.showGeometry;
     Object.entries(this.vectorProperties.getValues()).forEach(
       ([key, value]) => {
         const olcsKey = `olcs_${key}`;

package/src/featureProvider/featureProviderSymbols.ts

@@ -1,10 +1,5 @@
 /**
  * Added to ol.Feature, if they are not part of a layer, but provided by an {@link AbstractFeatureProvider}.
  */
+// eslint-disable-next-line import/prefer-default-export
 export const isProvidedFeature: unique symbol = Symbol('isProvidedFeature');
-
-/**
- * A boolean value, indicating whether selecting should add the feature to the selected item layer
- * @deprecated
- */
-export const showProvidedFeature: unique symbol = Symbol('showProvidedFeature');

package/src/interaction/abstractInteraction.ts

@@ -79,6 +79,7 @@ export type EventAfterEventHandler = Omit<
 
 /**
  * An abstract interface for all interactions
+ * @group Interaction
  */
 class AbstractInteraction {
   /**

package/src/interaction/coordinateAtPixel.ts

@@ -18,6 +18,9 @@ import { transformFromImage } from '../oblique/helpers.js';
 import type CesiumMap from '../map/cesiumMap.js';
 import type ObliqueMap from '../map/obliqueMap.js';
 
+/**
+ * @group Interaction
+ */
 class CoordinateAtPixel extends AbstractInteraction {
   private _scratchCartographic = new Cartographic();
 

package/src/interaction/featureAtPixelInteraction.ts

@@ -26,6 +26,9 @@ import type OpenlayersMap from '../map/openlayersMap.js';
 import type ObliqueMap from '../map/obliqueMap.js';
 import type CesiumMap from '../map/cesiumMap.js';
 
+/**
+ * @group Interaction
+ */
 class FeatureAtPixelInteraction extends AbstractInteraction {
   private _pickPosition = EventType.CLICK;
 

package/src/interaction/featureProviderInteraction.ts

@@ -9,6 +9,9 @@ import {
   PointerKeyType,
 } from './interactionType.js';
 
+/**
+ * @group Interaction
+ */
 class FeatureProviderInteraction extends AbstractInteraction {
   constructor() {
     super(EventType.CLICK, ModificationKeyType.ALL, PointerKeyType.ALL);

package/src/interaction/interactionChain.ts

@@ -7,6 +7,9 @@ import {
   PointerKeyType,
 } from './interactionType.js';
 
+/**
+ * @group Interaction
+ */
 class InteractionChain extends AbstractInteraction {
   /**
    * The interactions to handle one after the other

package/src/layer/cesium/cesiumTilesetCesiumImpl.ts

@@ -129,7 +129,7 @@ class CesiumTilesetCesiumImpl
         this.tilesetProperties.forEach(({ key, value }) => {
           // eslint-disable-next-line @typescript-eslint/ban-ts-comment
           // @ts-ignore
-          this.cesium3DTileset![key] = value;
+          this.cesium3DTileset[key] = value;
         });
       }
       this.cesium3DTileset[vcsLayerName] = this.name;

package/src/layer/cesium/openStreetMapCesiumImpl.ts

@@ -12,13 +12,15 @@ class OpenStreetMapCesiumImpl extends RasterLayerCesiumImpl {
     return 'OpenStreetMapCesiumImpl';
   }
 
-  getCesiumLayer(): CesiumImageryLayer {
-    return new CesiumImageryLayer(
-      new OpenStreetMapImageryProvider({ maximumLevel: this.maxLevel }),
-      {
-        alpha: this.opacity,
-        splitDirection: this.splitDirection,
-      },
+  getCesiumLayer(): Promise<CesiumImageryLayer> {
+    return Promise.resolve(
+      new CesiumImageryLayer(
+        new OpenStreetMapImageryProvider({ maximumLevel: this.maxLevel }),
+        {
+          alpha: this.opacity,
+          splitDirection: this.splitDirection,
+        },
+      ),
     );
   }
 }

package/src/layer/cesium/rasterLayerCesiumImpl.ts

@@ -41,9 +41,9 @@ class RasterLayerCesiumImpl
     this.tilingSchema = options.tilingSchema;
   }
 
-  initialize(): Promise<void> {
+  async initialize(): Promise<void> {
     if (!this.initialized) {
-      this.cesiumLayer = this.getCesiumLayer();
+      this.cesiumLayer = await this.getCesiumLayer();
       this.cesiumLayer[vcsLayerName] = this.name;
       this.cesiumLayer.show = false;
       this.map.addImageryLayer(this.cesiumLayer);
@@ -59,7 +59,7 @@ class RasterLayerCesiumImpl
   }
 
   // eslint-disable-next-line class-methods-use-this
-  getCesiumLayer(): ImageryLayer {
+  getCesiumLayer(): Promise<ImageryLayer> {
     throw new Error('implementation error');
   }
 

package/src/layer/cesium/singleImageCesiumImpl.ts

@@ -23,9 +23,8 @@ class SingleImageCesiumImpl extends RasterLayerCesiumImpl {
     this.credit = options.credit;
   }
 
-  getCesiumLayer(): ImageryLayer {
-    const options: SingleTileImageryProvider.ConstructorOptions = {
-      url: this.url as string,
+  async getCesiumLayer(): Promise<ImageryLayer> {
+    const options: SingleTileImageryProvider.fromUrlOptions = {
       credit: this.credit,
     };
 
@@ -39,7 +38,10 @@ class SingleImageCesiumImpl extends RasterLayerCesiumImpl {
       );
     }
 
-    const imageryProvider = new SingleTileImageryProvider(options);
+    const imageryProvider = await SingleTileImageryProvider.fromUrl(
+      this.url!,
+      options,
+    );
     const layerOptions = {
       rectangle: options.rectangle,
       alpha: this.opacity,

package/src/layer/cesium/tmsCesiumImpl.ts

@@ -25,9 +25,8 @@ class TmsCesiumImpl extends RasterLayerCesiumImpl {
     this.format = options.format;
   }
 
-  getCesiumLayer(): CesiumImageryLayer {
+  async getCesiumLayer(): Promise<CesiumImageryLayer> {
     const options: TileMapServiceImageryProvider.ConstructorOptions = {
-      url: this.url,
       fileExtension: this.format,
       maximumLevel: this.maxLevel,
       minimumLevel: this.minLevel,
@@ -48,7 +47,10 @@ class TmsCesiumImpl extends RasterLayerCesiumImpl {
     if (this.tilingSchema === TilingScheme.GEOGRAPHIC) {
       options.tilingScheme = new GeographicTilingScheme();
     }
-    const imageryProvider = new TileMapServiceImageryProvider(options);
+    const imageryProvider = await TileMapServiceImageryProvider.fromUrl(
+      this.url!,
+      options,
+    );
     const layerOptions = {
       alpha: this.opacity,
       splitDirection: this.splitDirection,

package/src/layer/cesium/vectorRasterTileCesiumImpl.ts

@@ -43,7 +43,7 @@ class VectorRasterTileCesiumImpl extends RasterLayerCesiumImpl {
     this.tileSize = options.tileSize;
   }
 
-  getCesiumLayer(): CesiumImageryLayer {
+  getCesiumLayer(): Promise<CesiumImageryLayer> {
     this.imageryProvider = new VectorTileImageryProvider({
       tileProvider: this.tileProvider,
       tileSize: this.tileSize,
@@ -64,13 +64,14 @@ class VectorRasterTileCesiumImpl extends RasterLayerCesiumImpl {
         extent[3],
       );
     }
-    const imageryLayer = new CesiumImageryLayer(
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      this.imageryProvider,
-      layerOptions,
+    return Promise.resolve(
+      new CesiumImageryLayer(
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        this.imageryProvider,
+        layerOptions,
+      ),
     );
-    return imageryLayer;
   }
 
   /**

package/src/layer/cesium/wmsCesiumImpl.ts

@@ -32,7 +32,7 @@ class WmsCesiumImpl extends RasterLayerCesiumImpl {
     this.tileSize = options.tileSize;
   }
 
-  getCesiumLayer(): CesiumImageryLayer {
+  getCesiumLayer(): Promise<CesiumImageryLayer> {
     const parameters = { ...this.parameters };
     if (this.highResolution) {
       parameters.width = String(this.tileSize[0] * 2);
@@ -68,7 +68,9 @@ class WmsCesiumImpl extends RasterLayerCesiumImpl {
       alpha: this.opacity,
       splitDirection: this.splitDirection,
     };
-    return new CesiumImageryLayer(imageryProvider, layerOptions);
+    return Promise.resolve(
+      new CesiumImageryLayer(imageryProvider, layerOptions),
+    );
   }
 }
 

package/src/layer/cesium/wmtsCesiumImpl.ts

@@ -47,7 +47,7 @@ class WmtsCesiumImpl extends RasterLayerCesiumImpl {
     this.matrixIds = options.matrixIds;
   }
 
-  getCesiumLayer(): CesiumImageryLayer {
+  getCesiumLayer(): Promise<CesiumImageryLayer> {
     const currentUrl = this.url as string;
     // This is a bug in Cesium, they cant cope with {Layer} placeholder..
     const url =
@@ -85,7 +85,9 @@ class WmtsCesiumImpl extends RasterLayerCesiumImpl {
       alpha: this.opacity,
       splitDirection: this.splitDirection,
     };
-    return new CesiumImageryLayer(imageryProvider, layerOptions);
+    return Promise.resolve(
+      new CesiumImageryLayer(imageryProvider, layerOptions),
+    );
   }
 }
 

package/src/layer/cesiumTilesetLayer.ts

@@ -58,6 +58,7 @@ export type CesiumTilesetImplementationOptions =
 
 /**
  * represents a specific Building layer for cesium.
+ * @group Layer
  */
 class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
   static get className(): string {

package/src/layer/czmlLayer.ts

@@ -9,6 +9,9 @@ export type CzmlOptions = LayerOptions & {
   sourceUri?: string;
 };
 
+/**
+ * @group Layer
+ */
 class CzmlLayer extends DataSourceLayer {
   static get className(): string {
     return 'CzmlLayer';

package/src/layer/dataSourceLayer.ts

@@ -20,6 +20,7 @@ export type DataSourceImplementationOptions = LayerImplementationOptions & {
 
 /**
  * Represents a layer of Cesium.Entity
+ * @group Layer
  */
 class DataSourceLayer extends Layer<DataSourceCesiumImpl> {
   static get className(): string {

package/src/layer/featureLayer.ts

@@ -42,6 +42,7 @@ export interface FeatureLayerImplementation {
 
 /**
  * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
+ * @group Layer
  */
 class FeatureLayer<
     T extends LayerImplementation<VcsMap> & FeatureLayerImplementation,

package/src/layer/featureStoreLayer.ts

@@ -100,6 +100,8 @@ export const isTiledFeature: unique symbol = Symbol('isTiledFeature');
 
 /**
  * FeatureStoreLayer Layer
+ * @group Layer
+ * @experimental
  */
 class FeatureStoreLayer extends VectorLayer {
   static get className(): string {

package/src/layer/geojsonHelpers.ts

@@ -265,9 +265,6 @@ function readFeature(
   }
 
   featureObj.vcsMeta = featureObj.vcsMeta || ({} as VcsMeta);
-  if (featureObj.vcsStyle) {
-    featureObj.vcsMeta.style = featureObj.vcsMeta.style || featureObj.vcsStyle;
-  }
   const { properties } = featureObj;
   if (
     properties &&
@@ -352,7 +349,6 @@ export function parseGeoJSON(
       geoJSON.vcsMeta ||
       ({
         embeddedIcons: geoJSON.vcsEmbeddedIcons,
-        style: geoJSON.vcsStyle,
       } as VcsMeta);
 
     let style;

package/src/layer/geojsonLayer.ts

@@ -16,6 +16,9 @@ export type GeoJSONOptions = VectorOptions & {
  */
 export const featureFromOptions = Symbol('featureFromOptions');
 
+/**
+ * @group Layer
+ */
 class GeoJSONLayer extends VectorLayer {
   static get className(): string {
     return 'GeoJSONLayer';

package/src/layer/layer.ts

@@ -2,7 +2,6 @@ import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger } from '@vcsuite/parsers';
 import VcsObject, { VcsObjectOptions } from '../vcsObject.js';
 import Extent, { type ExtentOptions } from '../util/extent.js';
-import { vcsLayerName } from './layerSymbols.js';
 import LayerState from './layerState.js';
 import VcsEvent from '../vcsEvent.js';
 import { layerClassRegistry } from '../classRegistry.js';
@@ -45,6 +44,12 @@ export type LayerOptions = VcsObjectOptions & {
    */
   hiddenObjectIds?: string[];
   copyright?: CopyrightOptions;
+
+  /**
+   * Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection
+   * to other sources of data.
+   */
+  datasourceId?: string;
 };
 
 export type LayerImplementationOptions = {
@@ -56,6 +61,7 @@ export type LayerImplementationOptions = {
  * Abstract base class for Layers.
  * To create a layer Implementation the function `createImplementationsForMap` has to be implemented.
  * To receive implementation options, implement `geImplementationOptions`
+ * @group Layer
  */
 class Layer<
   I extends LayerImplementation<VcsMap> = LayerImplementation<VcsMap>,
@@ -64,14 +70,6 @@ class Layer<
     return 'Layer';
   }
 
-  /**
-   * Symbol to declare a layers name on its visualizations, e.g. ol.layer.Layer, Cesium.Cesium3DTileset
-   * @deprecated
-   */
-  static get vcsLayerNameSymbol(): symbol {
-    return vcsLayerName;
-  }
-
   static getDefaultOptions(): LayerOptions {
     return {
       name: undefined,
@@ -83,6 +81,7 @@ class Layer<
       url: undefined,
       hiddenObjectIds: [],
       copyright: undefined,
+      datasourceId: undefined,
     };
   }
 
@@ -146,6 +145,12 @@ class Layer<
 
   private _locale: string;
 
+  /**
+   * Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection
+   * to other sources of data.
+   */
+  datasourceId?: string;
+
   constructor(options: LayerOptions) {
     super(options);
     const defaultOptions = Layer.getDefaultOptions();
@@ -201,6 +206,8 @@ class Layer<
     this.featureProvider = undefined;
 
     this._locale = 'en';
+
+    this.datasourceId = options.datasourceId || defaultOptions.datasourceId;
   }
 
   /**
@@ -641,6 +648,10 @@ class Layer<
       config.copyright = { ...this.copyright };
     }
 
+    if (this.datasourceId !== defaultOptions.datasourceId) {
+      config.datasourceId = this.datasourceId;
+    }
+
     return config;
   }
 

package/src/layer/layerSymbols.ts

@@ -1,2 +1,5 @@
+/**
+ * Symbol to declare a layers name on its visualizations, e.g. ol.layer.Layer, Cesium.Cesium3DTileset*
+ */
 /* eslint-disable import/prefer-default-export */
 export const vcsLayerName: unique symbol = Symbol('vcsLayerName');

package/src/layer/openStreetMapLayer.ts

@@ -31,6 +31,9 @@ export type OpenStreetMapOptions = LayerOptions & {
   maxLevel?: number;
 };
 
+/**
+ * @group Layer
+ */
 class OpenStreetMapLayer
   extends Layer<OpenStreetMapCesiumImpl | OpenStreetMapOpenlayersImpl>
   implements SplitLayer

package/src/layer/pointCloudLayer.ts

@@ -29,6 +29,7 @@ export const defaultPointCloudStyle = new DeclarativeStyleItem({});
  *  <li>url: string: url to the p3dm dataset
  *  <li>pointSize: number: size of the points to display
  * </ul>
+ * @group Layer
  */
 class PointCloudLayer extends CesiumTilesetLayer {
   static get className(): string {

package/src/layer/rasterLayer.ts

@@ -149,6 +149,7 @@ export function calculateMinLevel(
 /**
  * This abstract class allows for automatic loading scheme determination
  * for raster layers
+ * @group Layer
  */
 class RasterLayer<
     I extends LayerImplementation<VcsMap> & RasterLayerImplementation,

package/src/layer/singleImageLayer.ts

@@ -23,6 +23,7 @@ export type SingleImageImplementationOptions =
 
 /**
  * Image layer for Cesium and OpenlayersMap
+ * @group Layer
  */
 class SingleImageLayer extends RasterLayer<
   SingleImageCesiumImpl | SingleImageOpenlayersImpl

package/src/layer/terrainLayer.ts

@@ -20,6 +20,9 @@ export type TerrainImplementationOptions = LayerImplementationOptions & {
   requestWaterMask: boolean;
 };
 
+/**
+ * @group Layer
+ */
 class TerrainLayer extends Layer<TerrainCesiumImpl> {
   static get className(): string {
     return 'TerrainLayer';

package/src/layer/tmsLayer.ts

@@ -21,6 +21,9 @@ export type TMSImplementationOptions = RasterLayerImplementationOptions & {
   tileSize: Size;
 };
 
+/**
+ * @group Layer
+ */
 class TMSLayer extends RasterLayer<TmsCesiumImpl | TmsOpenlayersImpl> {
   static get className(): string {
     return 'TMSLayer';

package/src/layer/vectorLayer.ts

@@ -33,13 +33,7 @@ import DeclarativeStyleItem, {
   DeclarativeStyleItemOptions,
 } from '../style/declarativeStyleItem.js';
 import writeStyle from '../style/writeStyle.js';
-import {
-  alreadyTransformedToImage,
-  alreadyTransformedToMercator,
-  doNotTransform,
-  obliqueGeometry,
-  originalFeatureSymbol,
-} from './vectorSymbols.js';
+import { alreadyTransformedToMercator } from './vectorSymbols.js';
 import Extent from '../util/extent.js';
 import VectorProperties, {
   VcsMeta,
@@ -144,6 +138,7 @@ export type VectorImplementationOptions = FeatureLayerImplementationOptions & {
 
 /**
  * VectorLayer Layer for OpenlayersMap, Cesium and ObliqueMap
+ * @group Layer
  */
 class VectorLayer
   extends FeatureLayer<
@@ -158,41 +153,6 @@ class VectorLayer
     return 'VectorLayer';
   }
 
-  /**
-   * @deprecated
-   */
-  static get alreadyTransformedToMercator(): symbol {
-    return alreadyTransformedToMercator;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get alreadyTransformedToImage(): symbol {
-    return alreadyTransformedToImage;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get obliqueGeometry(): symbol {
-    return obliqueGeometry;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get doNotTransform(): symbol {
-    return doNotTransform;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get originalFeatureSymbol(): symbol {
-    return originalFeatureSymbol;
-  }
-
   static getDefaultOptions(): VectorOptions {
     return {
       ...Layer.getDefaultOptions(),