@vcmap/core 5.0.2 → 5.1.0-rc.1

package/src/featureProvider/abstractFeatureProvider.ts

@@ -145,11 +145,13 @@ class AbstractFeatureProvider extends VcsObject {
    * to handle your feature is called: (e.g. <code>return features.map(f => this.getProviderFeature(f)</code>);
    * @param coordinate - in mercator
    * @param resolution - meters per pixel for the given location
+   * @param headers - headers optional request headers to be sent with the server request
    */
   // eslint-disable-next-line no-unused-vars,class-methods-use-this
   getFeaturesByCoordinate(
     _coordinate: Coordinate,
     _resolution: number,
+    _headers?: Record<string, string>,
   ): Promise<Feature[]> {
     return Promise.resolve([]);
   }

package/src/featureProvider/tileProviderFeatureProvider.ts

@@ -32,10 +32,12 @@ class TileProviderFeatureProvider extends AbstractFeatureProvider {
   async getFeaturesByCoordinate(
     coordinate: Coordinate,
     resolution: number,
+    headers?: Record<string, string>,
   ): Promise<Feature[]> {
     const features = await this.tileProvider.getFeaturesByCoordinate(
       coordinate,
       resolution,
+      headers,
     );
     const checkShow = (feature: Feature): boolean =>
       this.style ? !!this.style.cesiumStyle.show.evaluate(feature) : true;

package/src/featureProvider/wmsFeatureProvider.ts

@@ -24,7 +24,7 @@ import Projection, {
 import type { WMSSourceOptions } from '../layer/wmsHelpers.js';
 import { getWMSSource } from '../layer/wmsHelpers.js';
 import Extent, { ExtentOptions } from '../util/extent.js';
-import { requestJson } from '../util/fetch.js';
+import { getInitForUrl, requestJson } from '../util/fetch.js';
 import { featureProviderClassRegistry } from '../classRegistry.js';
 import { TilingScheme } from '../layer/rasterLayer.js';
 
@@ -239,6 +239,7 @@ class WMSFeatureProvider extends AbstractFeatureProvider {
   async getFeaturesByCoordinate(
     coordinate: Coordinate,
     resolution: number,
+    headers?: Record<string, string>,
   ): Promise<Feature[]> {
     const projection = this.wmsSource.getProjection() as OLProjection;
     let coords = coordinate;
@@ -257,9 +258,10 @@ class WMSFeatureProvider extends AbstractFeatureProvider {
     );
 
     if (url) {
+      const init = getInitForUrl(url, headers);
       let data: GeoJSONObject;
       try {
-        data = await requestJson<GeoJSONObject>(url);
+        data = await requestJson<GeoJSONObject>(url, init);
       } catch (ex) {
         this.getLogger().error(`Failed fetching WMS FeatureInfo ${url}`);
         return [];

package/src/interaction/eventHandler.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from 'uuid';
 import { Cartesian2 } from '@vcmap-cesium/engine';
-import { check, checkMaybe } from '@vcsuite/check';
+import { check, maybe } from '@vcsuite/check';
 import { getLogger as getLoggerByName, type Logger } from '@vcsuite/logger';
 import AbstractInteraction, {
   InteractionEvent,
@@ -165,8 +165,8 @@ class EventHandler {
   ): () => void {
     check(interaction, AbstractInteraction);
     check(removed, Function);
-    checkMaybe(index, Number);
-    checkMaybe(id, String);
+    check(index, maybe(Number));
+    check(id, maybe(String));
 
     if (this._exclusiveInteraction && this._exclusiveInteraction.id !== id) {
       this.removeExclusive();

package/src/interaction/featureProviderInteraction.ts

@@ -44,6 +44,7 @@ class FeatureProviderInteraction extends AbstractInteraction {
                 l.featureProvider?.getFeaturesByCoordinate?.(
                   event.position as Coordinate,
                   resolution,
+                  l.headers,
                 ),
             ),
           )

package/src/layer/cesium/cesiumTilesetCesiumImpl.ts

@@ -10,6 +10,7 @@ import {
   type SplitDirection,
   Cesium3DTile,
   Cesium3DTileContent,
+  type CustomShader,
 } from '@vcmap-cesium/engine';
 import { createEmpty, Extent as OLExtent } from 'ol/extent.js';
 import type { Coordinate } from 'ol/coordinate.js';
@@ -32,6 +33,7 @@ import type CesiumMap from '../../map/cesiumMap.js';
 import type { FeatureLayerImplementation } from '../featureLayer.js';
 import type StyleItem from '../../style/styleItem.js';
 import GlobalHider from '../globalHider.js';
+import { getResourceOrUrl } from './resourceHelper.js';
 
 export const cesiumTilesetLastUpdated: unique symbol = Symbol(
   'cesiumTilesetLastUpdated',
@@ -111,6 +113,8 @@ class CesiumTilesetCesiumImpl
 
   private _onStyleChangeRemover: (() => void) | null = null;
 
+  private _customShader: CustomShader | undefined;
+
   constructor(map: CesiumMap, options: CesiumTilesetImplementationOptions) {
     super(map, options);
 
@@ -123,15 +127,43 @@ class CesiumTilesetCesiumImpl
     this.tilesetProperties = options.tilesetProperties;
     this.modelMatrix = options.modelMatrix;
     this.offset = options.offset;
+    this._customShader = options.customShader;
+  }
+
+  get customShader(): CustomShader | undefined {
+    return this._customShader;
   }
 
   async initialize(): Promise<void> {
     if (!this._initializedPromise) {
-      this._initializedPromise = Cesium3DTileset.fromUrl(this.url as string, {
-        ...this.tilesetOptions,
-        show: false, // show is handled by activate
-      });
-      this.cesium3DTileset = await this._initializedPromise;
+      this._initializedPromise = Cesium3DTileset.fromUrl(
+        getResourceOrUrl(this.url!, this.headers),
+        {
+          ...this.tilesetOptions,
+          show: false, // show is handled by activate
+        },
+      );
+
+      // if url could not be loaded, we have a fallback and try again with a prefixed tileset.json.
+      try {
+        this.cesium3DTileset = await this._initializedPromise;
+      } catch (e) {
+        if (this.url && !/\.json$/.test(this.url)) {
+          this.url = `${this.url.replace(/\/$/, '')}/tileset.json`;
+          this._initializedPromise = Cesium3DTileset.fromUrl(
+            getResourceOrUrl(this.url, this.headers),
+            {
+              ...this.tilesetOptions,
+              show: false, // show is handled by activate
+            },
+          );
+          this.cesium3DTileset = await this._initializedPromise;
+        } else {
+          throw e;
+        }
+      }
+
+      this.cesium3DTileset.customShader = this._customShader;
       if (this.isDestroyed) {
         this.cesium3DTileset.destroy();
         return;
@@ -214,6 +246,13 @@ class CesiumTilesetCesiumImpl
     this._calculateOffset();
   }
 
+  updateCustomShader(shader?: CustomShader): void {
+    this._customShader = shader;
+    if (this.cesium3DTileset) {
+      this.cesium3DTileset.customShader = this._customShader;
+    }
+  }
+
   async activate(): Promise<void> {
     await super.activate();
     if (this.active && this.cesium3DTileset) {

package/src/layer/cesium/resourceHelper.ts

@@ -0,0 +1,15 @@
+import { Resource } from '@vcmap-cesium/engine';
+
+// eslint-disable-next-line import/prefer-default-export
+export function getResourceOrUrl(
+  url: string,
+  headers?: Record<string, string>,
+): string | Resource {
+  if (headers) {
+    return new Resource({
+      url,
+      headers,
+    });
+  }
+  return url;
+}

package/src/layer/cesium/singleImageCesiumImpl.ts

@@ -7,6 +7,7 @@ import RasterLayerCesiumImpl from './rasterLayerCesiumImpl.js';
 import { wgs84Projection } from '../../util/projection.js';
 import type { SingleImageImplementationOptions } from '../singleImageLayer.js';
 import type CesiumMap from '../../map/cesiumMap.js';
+import { getResourceOrUrl } from './resourceHelper.js';
 
 /**
  * represents a specific Cesium SingleTileImagery Layer class.
@@ -39,7 +40,7 @@ class SingleImageCesiumImpl extends RasterLayerCesiumImpl {
     }
 
     const imageryProvider = await SingleTileImageryProvider.fromUrl(
-      this.url!,
+      getResourceOrUrl(this.url!, this.headers),
       options,
     );
     const layerOptions = {

package/src/layer/cesium/terrainCesiumImpl.ts

@@ -29,11 +29,12 @@ class TerrainCesiumImpl extends LayerImplementation<CesiumMap> {
   async initialize(): Promise<void> {
     if (!this.initialized) {
       this.terrainProvider = await getTerrainProviderForUrl(
-        this.url as string,
+        this.url!,
         {
           requestVertexNormals: this.requestVertexNormals,
           requestWaterMask: this.requestWaterMask,
         },
+        this.headers,
       );
       this.terrainProvider[vcsLayerName] = this.name;
     }

package/src/layer/cesium/tmsCesiumImpl.ts

@@ -9,6 +9,7 @@ import { wgs84Projection } from '../../util/projection.js';
 import { TilingScheme } from '../rasterLayer.js';
 import type CesiumMap from '../../map/cesiumMap.js';
 import type { TMSImplementationOptions } from '../tmsLayer.js';
+import { getResourceOrUrl } from './resourceHelper.js';
 
 /**
  * TmsLayer implementation for {@link CesiumMap}.
@@ -48,7 +49,7 @@ class TmsCesiumImpl extends RasterLayerCesiumImpl {
       options.tilingScheme = new GeographicTilingScheme();
     }
     const imageryProvider = await TileMapServiceImageryProvider.fromUrl(
-      this.url!,
+      getResourceOrUrl(this.url!, this.headers),
       options,
     );
     const layerOptions = {

package/src/layer/cesium/vectorRasterTileCesiumImpl.ts

@@ -47,6 +47,7 @@ class VectorRasterTileCesiumImpl extends RasterLayerCesiumImpl {
     this.imageryProvider = new VectorTileImageryProvider({
       tileProvider: this.tileProvider,
       tileSize: this.tileSize,
+      headers: this.headers,
     });
 
     const layerOptions: CesiumImageryLayer.ConstructorOptions = {

package/src/layer/cesium/vectorTileImageryProvider.ts

@@ -96,6 +96,7 @@ export function getCanvasFromFeatures(
 export type VectorTileImageryProviderOptions = {
   tileProvider: TileProvider;
   tileSize: Size;
+  headers?: Record<string, string>;
 };
 
 /**
@@ -110,6 +111,8 @@ class VectorTileImageryProvider {
 
   private _errorEvent = new CesiumEvent();
 
+  headers?: Record<string, string>;
+
   emptyCanvas: HTMLCanvasElement;
 
   minLevel = 0;
@@ -127,6 +130,7 @@ class VectorTileImageryProvider {
     this.emptyCanvas = document.createElement('canvas');
     this.emptyCanvas.width = this.tileWidth;
     this.emptyCanvas.height = this.tileHeight;
+    this.headers = options.headers;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -204,7 +208,12 @@ class VectorTileImageryProvider {
     y: number,
     level: number,
   ): Promise<HTMLImageElement | HTMLCanvasElement> {
-    const features = await this.tileProvider.getFeaturesForTile(x, y, level);
+    const features = await this.tileProvider.getFeaturesForTile(
+      x,
+      y,
+      level,
+      this.headers,
+    );
     if (features.length === 0) {
       return this.emptyCanvas;
     }

package/src/layer/cesium/wmsCesiumImpl.ts

@@ -10,6 +10,7 @@ import RasterLayerCesiumImpl from './rasterLayerCesiumImpl.js';
 import { wgs84Projection } from '../../util/projection.js';
 import type { WMSImplementationOptions } from '../wmsLayer.js';
 import type CesiumMap from '../../map/cesiumMap.js';
+import { getResourceOrUrl } from './resourceHelper.js';
 
 /**
  * represents a specific Cesium WmsCesiumImpl Layer class.
@@ -39,7 +40,7 @@ class WmsCesiumImpl extends RasterLayerCesiumImpl {
       parameters.height = String(this.tileSize[1] * 2);
     }
     const options: WebMapServiceImageryProvider.ConstructorOptions = {
-      url: this.url as string,
+      url: getResourceOrUrl(this.url!, this.headers),
       layers: parameters.LAYERS,
       minimumLevel: this.minLevel,
       maximumLevel: this.maxLevel,

package/src/layer/cesium/wmtsCesiumImpl.ts

@@ -9,6 +9,7 @@ import { wgs84Projection } from '../../util/projection.js';
 import { getTilingScheme } from '../rasterLayer.js';
 import type { WMTSImplementationOptions } from '../wmtsLayer.js';
 import type CesiumMap from '../../map/cesiumMap.js';
+import { getResourceOrUrl } from './resourceHelper.js';
 
 /**
  * represents a specific WmtsLayer Implementation for {@link CesiumMap}.
@@ -50,13 +51,14 @@ class WmtsCesiumImpl extends RasterLayerCesiumImpl {
   getCesiumLayer(): Promise<CesiumImageryLayer> {
     const currentUrl = this.url as string;
     // This is a bug in Cesium, they cant cope with {Layer} placeholder..
-    const url =
+    const url: string =
       currentUrl.indexOf('{Layer}') !== -1
         ? currentUrl.replace('{Layer}', this.layer)
         : currentUrl;
+
     const extent = this.extent!.getCoordinatesInProjection(wgs84Projection);
     const options: WebMapTileServiceImageryProvider.ConstructorOptions = {
-      url,
+      url: getResourceOrUrl(url, this.headers),
       layer: this.layer,
       style: this.style,
       format: this.format,

package/src/layer/cesiumTilesetLayer.ts

@@ -1,6 +1,10 @@
-import { type Cesium3DTileset, Matrix4 } from '@vcmap-cesium/engine';
+import {
+  type Cesium3DTileset,
+  type CustomShader,
+  Matrix4,
+} from '@vcmap-cesium/engine';
 
-import { checkMaybe } from '@vcsuite/check';
+import { check, maybe } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
 import type { Coordinate } from 'ol/coordinate.js';
 import VectorStyleItem, {
@@ -50,6 +54,7 @@ export type CesiumTilesetImplementationOptions =
     tilesetProperties?: CesiumTilesetTilesetProperties[];
     modelMatrix?: Matrix4;
     offset?: Coordinate;
+    customShader?: CustomShader;
   };
 
 /**
@@ -86,13 +91,12 @@ class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
 
   protected _supportedMaps = [CesiumMap.className];
 
+  private _customShader: CustomShader | undefined = undefined;
+
   constructor(options: CesiumTilesetOptions) {
     super(options);
     this._supportedMaps = [CesiumMap.className];
     const defaultOptions = CesiumTilesetLayer.getDefaultOptions();
-    if (this.url && !/\.json$/.test(this.url)) {
-      this.url = `${this.url.replace(/\/$/, '')}/tileset.json`;
-    }
 
     this.highlightStyle = null;
     if (options.highlightStyle) {
@@ -136,7 +140,7 @@ class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
   }
 
   set modelMatrix(modelMatrix: Matrix4 | undefined) {
-    checkMaybe(modelMatrix, Matrix4);
+    check(modelMatrix, maybe(Matrix4));
 
     this._modelMatrix = modelMatrix;
     this.getImplementations().forEach((impl) => {
@@ -154,7 +158,7 @@ class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
   }
 
   set offset(offset: Coordinate | undefined) {
-    checkMaybe(offset, [Number]);
+    check(offset, maybe([Number]));
 
     this._offset = offset;
     this.getImplementations().forEach((impl) => {
@@ -162,12 +166,26 @@ class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
     });
   }
 
+  get customShader(): CustomShader | undefined {
+    return this._customShader;
+  }
+
+  set customShader(shader: CustomShader | undefined) {
+    if (this._customShader !== shader) {
+      this._customShader = shader;
+      this.getImplementations().forEach((impl) => {
+        impl.updateCustomShader(shader);
+      });
+    }
+  }
+
   getImplementationOptions(): CesiumTilesetImplementationOptions {
     return {
       ...super.getImplementationOptions(),
       tilesetOptions: this.tilesetOptions,
       modelMatrix: this.modelMatrix,
       offset: this.offset,
+      customShader: this.customShader,
     };
   }
 

package/src/layer/czmlLayer.ts

@@ -4,6 +4,7 @@ import DataSourceLayer from './dataSourceLayer.js';
 import { vcsLayerName } from './layerSymbols.js';
 import { layerClassRegistry } from '../classRegistry.js';
 import type { LayerOptions } from './layer.js';
+import { getResourceOrUrl } from './cesium/resourceHelper.js';
 
 export type CzmlOptions = LayerOptions & {
   sourceUri?: string;
@@ -82,7 +83,7 @@ class CzmlLayer extends DataSourceLayer {
 
   private async _loadData(): Promise<void> {
     await this.dataSource.load(
-      this.url,
+      getResourceOrUrl(this.url, this.headers),
       this.sourceUri ? { sourceUri: this.sourceUri } : undefined,
     );
 

package/src/layer/featureLayer.ts

@@ -1,6 +1,6 @@
 import Style, { type StyleFunction } from 'ol/style/Style.js';
 
-import { check } from '@vcsuite/check';
+import { check, oneOf } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
 import { SplitDirection } from '@vcmap-cesium/engine';
 import Layer, {
@@ -176,7 +176,7 @@ class FeatureLayer<
    * Sets the style based on a styleName on a layer
    */
   setStyle(style: Style | StyleFunction | StyleItem, silent?: boolean): void {
-    check(style, [Style, StyleItem, Function]);
+    check(style, oneOf(Style, StyleItem, Function));
 
     if (style instanceof StyleItem) {
       this._style = style;

package/src/layer/featureStoreLayer.ts

@@ -10,10 +10,7 @@ import VectorLayer, {
   VectorImplementationOptions,
   VectorOptions,
 } from './vectorLayer.js';
-import {
-  featureStoreStateSymbol,
-  FeatureStoreLayerState,
-} from './featureStoreLayerState.js';
+import { featureStoreStateSymbol } from './featureStoreLayerState.js';
 import { parseGeoJSON } from './geojsonHelpers.js';
 import { mercatorProjection } from '../util/projection.js';
 import FeatureStoreLayerChanges from './featureStoreLayerChanges.js';
@@ -206,7 +203,7 @@ class FeatureStoreLayer extends VectorLayer {
 
     this._removeVectorPropertiesChangeHandler =
       this.vectorProperties.propertyChanged.addEventListener(() => {
-        this.changeTracker.values.changed = true;
+        this.changeTracker.changed.raiseEvent();
       });
 
     this.injectedFetchDynamicFeatureFunc =
@@ -264,7 +261,9 @@ class FeatureStoreLayer extends VectorLayer {
     const { twoDim } = this.staticRepresentation;
     if (!this._twoDimLoaded) {
       this._twoDimLoaded = (async (): Promise<void> => {
-        const data = await requestJson<GeoJSONObject>(twoDim);
+        const data = await requestJson<GeoJSONObject>(twoDim, {
+          headers: this.headers,
+        });
         const { features } = parseGeoJSON(data, {
           targetProjection: mercatorProjection,
           dynamicStyle: true,
@@ -330,6 +329,7 @@ class FeatureStoreLayer extends VectorLayer {
           featureVisibility: this._staticFeatureVisibility,
           globalHider: this.globalHider,
           splitDirection: SplitDirection.NONE,
+          headers: this.headers,
         }),
       );
     } else if (this.staticRepresentation && this.staticRepresentation.twoDim) {
@@ -406,7 +406,7 @@ class FeatureStoreLayer extends VectorLayer {
     });
     if (changeTrackerActive) {
       this.changeTracker.track();
-      this.changeTracker.values.changed = true;
+      this.changeTracker.changed.raiseEvent();
     }
   }
 
@@ -551,7 +551,7 @@ class FeatureStoreLayer extends VectorLayer {
     this.hiddenStaticFeatureIds.add(featureId);
     const feature = new Feature();
     feature.setId(featureId);
-    feature[featureStoreStateSymbol] = FeatureStoreLayerState.STATIC;
+    feature[featureStoreStateSymbol] = 'static';
     this.changeTracker.removeFeature(feature);
   }