@vcmap/core 5.0.0-rc.32 → 5.0.0-rc.34

package/src/layer/{featureVisibility.js → featureVisibility.ts}

@@ -13,49 +13,56 @@ import VcsEvent from '../vcsEvent.js';
 /**
  * Set on an ol.Feature or Cesium.Cesium3DTileFeature to indicate its style before it was hidden or highlighted.
  * Can be undefined or ol.style.Style for ol.Features and Cesium.Color for Cesium.Cesium3DTileFeatures.
- * @type {symbol}
  */
 export const originalStyle = Symbol('originalStyle');
 
 /**
  * Set on an ol.Feature or Cesium.Cesium3DTileFeature to indicate that this features is highlighted.
  * Its value is a {@link VectorStyleItem}.
- * @type {symbol}
  */
 export const highlighted = Symbol('highlighted');
 
 /**
  * Is a boolean value set on ol.Feature or Cesium.Cesium3DTileFeature to indicate it is hidden
  * by the layers {@link FeatureVisibility}.
- * @type {symbol}
  */
 export const hidden = Symbol('hidden');
 
 /**
  * Is a boolean value set on ol.Feature or Cesium.Cesium3DTileFeature to indicate it is hidden
  * by the {@link GlobalHider}
- * @type {symbol}
  */
 export const globalHidden = Symbol('globalHidden');
 
-/**
- * @typedef {Object} HighlightedObject
- * @property {VectorStyleItem} style
- * @property {Set<import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature>} features
- */
+export type HighlightableFeature =
+  | Feature
+  | Cesium3DTileFeature
+  | Cesium3DTilePointFeature
+  | CesiumEntity;
 
 /**
- * @typedef {Object} FeatureVisibilityEvent
- * @property {FeatureVisibilityAction} action
- * @property {Array<string>} ids
- * @api
+ * Enumeration of feature visibility actions.
  */
+export enum FeatureVisibilityAction {
+  HIGHLIGHT = 1,
+  UNHIGHLIGHT = 2,
+  HIDE = 3,
+  SHOW = 4,
+}
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature} feature
- * @returns {boolean}
- */
-export function featureExists(feature) {
+export type HighlightedObject = {
+  style: VectorStyleItem;
+  features: Set<HighlightableFeature>;
+};
+
+export type FeatureVisibilityEvent = {
+  action: FeatureVisibilityAction;
+  ids: (string | number)[];
+};
+
+export function featureExists(
+  feature: Cesium3DTileFeature | Cesium3DTilePointFeature,
+): boolean {
   return (
     feature &&
     feature.content &&
@@ -64,11 +71,7 @@ export function featureExists(feature) {
   );
 }
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
- * @private
- */
-export function hideFeature(feature) {
+export function hideFeature(feature: HighlightableFeature): void {
   if (
     ((feature instanceof Cesium3DTileFeature ||
       feature instanceof Cesium3DTilePointFeature) &&
@@ -83,10 +86,8 @@ export function hideFeature(feature) {
 
 /**
  * Caches the original style on the feature using the originalStyle symbol
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
- * @private
  */
-export function cacheOriginalStyle(feature) {
+export function cacheOriginalStyle(feature: HighlightableFeature): void {
   if (!Reflect.has(feature, originalStyle)) {
     if (
       (feature instanceof Cesium3DTileFeature ||
@@ -100,11 +101,7 @@ export function cacheOriginalStyle(feature) {
   }
 }
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
- * @private
- */
-export function resetOriginalStyle(feature) {
+export function resetOriginalStyle(feature: HighlightableFeature): void {
   if (!(feature[globalHidden] || feature[hidden] || feature[highlighted])) {
     const style = feature[originalStyle];
     if (
@@ -112,7 +109,7 @@ export function resetOriginalStyle(feature) {
         feature instanceof Cesium3DTilePointFeature) &&
       featureExists(feature)
     ) {
-      feature.color = style;
+      feature.color = style as Color;
     } else if (feature instanceof Feature) {
       feature.changed();
     }
@@ -120,19 +117,16 @@ export function resetOriginalStyle(feature) {
   }
 }
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
- * @private
- */
-export function highlightFeature(feature) {
+export function highlightFeature(feature: HighlightableFeature): void {
   if (!(feature[globalHidden] || feature[hidden])) {
     const style = feature[highlighted];
     if (
       (feature instanceof Cesium3DTileFeature ||
         feature instanceof Cesium3DTilePointFeature) &&
-      featureExists(feature)
+      featureExists(feature) &&
+      style
     ) {
-      feature.color = style.cesiumFillColor;
+      feature.color = style.cesiumFillColor as Color;
     } else if (feature instanceof Feature) {
       feature.changed();
     }
@@ -141,10 +135,8 @@ export function highlightFeature(feature) {
 
 /**
  * Updates the cached original style
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
- * @private
  */
-export function updateOriginalStyle(feature) {
+export function updateOriginalStyle(feature: HighlightableFeature): void {
   delete feature[originalStyle];
   cacheOriginalStyle(feature);
   if (feature[hidden] || feature[globalHidden]) {
@@ -154,20 +146,15 @@ export function updateOriginalStyle(feature) {
   }
 }
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
- */
-function unhighlightFeature(feature) {
+function unhighlightFeature(feature: HighlightableFeature): void {
   delete feature[highlighted];
   resetOriginalStyle(feature);
 }
 
-/**
- * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
- * @param {symbol} symbol
- * @private
- */
-export function showFeature(feature, symbol) {
+export function showFeature(
+  feature: HighlightableFeature,
+  symbol: keyof HighlightableFeature,
+): void {
   delete feature[symbol];
 
   if (!(feature[hidden] || feature[globalHidden])) {
@@ -187,32 +174,13 @@ export function showFeature(feature, symbol) {
   }
 }
 
-/**
- * Enumeration of feature visibility actions.
- * @enum {number}
- * @api
- * @property {number} HIGHLIGHT
- * @property {number} UNHIGHLIGHT
- * @property {number} HIDE
- * @property {number} SHOW
- */
-export const FeatureVisibilityAction = {
-  HIGHLIGHT: 1,
-  UNHIGHLIGHT: 2,
-  HIDE: 3,
-  SHOW: 4,
-};
-
-/**
- * @param {FeatureVisibility} source
- * @param {FeatureVisibility} destination
- * @returns {Function}
- */
-export function synchronizeFeatureVisibility(source, destination) {
-  function handler({ action, ids }) {
+export function synchronizeFeatureVisibility(
+  source: FeatureVisibility,
+  destination: FeatureVisibility,
+): () => void {
+  function handler({ action, ids }: FeatureVisibilityEvent): void {
     if (action === FeatureVisibilityAction.HIGHLIGHT) {
-      /** @type {Object<string, VectorStyleItem>} */
-      const toHighlight = {};
+      const toHighlight: Record<string, VectorStyleItem> = {};
       ids.forEach((id) => {
         toHighlight[id] = source.highlightedObjects[id].style;
       });
@@ -243,33 +211,29 @@ export function synchronizeFeatureVisibility(source, destination) {
  * FeatureVisibility handles the visibility and highlighting of features of a specific {@link FeatureLayer} or {@link DataSourceLayer}
  * and its {@link FeatureLayerImplementation} resp. {@link DataSourceCesiumImpl}.
  * The visibility is being synchronized with the {@link GlobalHider}.
- * @class
  */
 class FeatureVisibility {
-  constructor() {
-    /** @type {Object<string, Set<(import("@vcmap-cesium/engine").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity)>>} */
-    this.hiddenObjects = {};
-    /** @type {Object<string, HighlightedObject>} */
-    this.highlightedObjects = {};
-    /** @type {number} */
-    this.lastUpdated = Date.now();
-    /**
-     * An event raised when the hidden or highlighted ids change. Is called with
-     * {@link FeatureVisibilityEvent} as its only argument
-     * @type {VcsEvent<FeatureVisibilityEvent>}
-     */
-    this.changed = new VcsEvent();
-  }
+  hiddenObjects: Record<string, Set<HighlightableFeature>> = {};
+
+  highlightedObjects: Record<string, HighlightedObject> = {};
+
+  lastUpdated: number = Date.now();
+
+  /**
+   * An event raised when the hidden or highlighted ids change. Is called with
+   * {@link FeatureVisibilityEvent} as its only argument
+   */
+  changed: VcsEvent<FeatureVisibilityEvent> = new VcsEvent();
 
   /**
    * highlights a number of features by ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|ol/Feature) with the given color.
-   * @param {Object<string, (VectorStyleItem|import("@vcmap-cesium/engine").Color|import("ol/style/Style").default)>} toHighlight
-   * @api stable
    */
-  highlight(toHighlight) {
-    const updatedIds = [];
+  highlight(
+    toHighlight: Record<string, VectorStyleItem | Color | Style>,
+  ): void {
+    const updatedIds: string[] = [];
     Object.entries(toHighlight).forEach(([id, style]) => {
-      let usedStyle = style;
+      let usedStyle: VectorStyleItem;
       if (style instanceof Color) {
         usedStyle = fromCesiumColor(style);
       } else if (style instanceof Style) {
@@ -279,13 +243,13 @@ class FeatureVisibility {
           style.getText().getText() &&
           !Array.isArray(style.getText().getText())
         ) {
-          // getText can return a rich Text Array<string> We do not support this at the moment.
+          // getText can return a rich Text string[] We do not support this at the moment.
           usedStyle.label = String(style.getText().getText());
         }
         usedStyle.style = style;
+      } else {
+        usedStyle = style;
       }
-      // eslint-disable-next-line no-self-assign
-      usedStyle = /** @type {VectorStyleItem} */ (usedStyle);
 
       if (!this.highlightedObjects[id]) {
         this.highlightedObjects[id] = {
@@ -293,10 +257,9 @@ class FeatureVisibility {
           features: new Set(),
         };
         updatedIds.push(id);
-        // @ts-ignore
       } else if (this.highlightedObjects[id].style !== usedStyle) {
         this.highlightedObjects[id].style = usedStyle;
-        this.highlightedObjects[id].features.forEach((s, feature) => {
+        this.highlightedObjects[id].features.forEach((_s, feature) => {
           feature[highlighted] = usedStyle;
           highlightFeature(feature);
         });
@@ -314,11 +277,10 @@ class FeatureVisibility {
 
   /**
    * unhighlights a number of features given by the ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>)
-   * @param {Array<string>} toUnHighlight Array with IDS to unhighlight
-   * @api stable
+   * @param  toUnHighlight Array with IDS to unhighlight
    */
-  unHighlight(toUnHighlight) {
-    const updatedIds = [];
+  unHighlight(toUnHighlight: (string | number)[]): void {
+    const updatedIds: (string | number)[] = [];
     toUnHighlight.forEach((id) => {
       if (this.highlightedObjects[id]) {
         this.highlightedObjects[id].features.forEach((f) => {
@@ -339,29 +301,25 @@ class FeatureVisibility {
 
   /**
    * clears all highlighted objects
-   * @api stable
    */
-  clearHighlighting() {
+  clearHighlighting(): void {
     this.unHighlight(Object.keys(this.highlightedObjects));
   }
 
-  /**
-   * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature} feature
-   * @returns {boolean}
-   */
-  hasHighlightFeature(id, feature) {
+  hasHighlightFeature(
+    id: string | number,
+    feature: HighlightableFeature,
+  ): boolean {
     return (
       this.highlightedObjects[id] &&
       this.highlightedObjects[id].features.has(feature)
     );
   }
 
-  /**
-   * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature} feature
-   */
-  addHighlightFeature(id, feature) {
+  addHighlightFeature(
+    id: string | number,
+    feature: HighlightableFeature,
+  ): void {
     if (this.highlightedObjects[id]) {
       cacheOriginalStyle(feature);
       this.highlightedObjects[id].features.add(feature);
@@ -372,15 +330,14 @@ class FeatureVisibility {
 
   /**
    * hides a number of objects
-   * @param {Array<string|number>} toHide A list of Object Ids which will be hidden
-   * @api stable
+   * @param  toHide A list of Object Ids which will be hidden
    */
-  hideObjects(toHide) {
-    const updatedIds = [];
+  hideObjects(toHide: (string | number)[]): void {
+    const updatedIds: string[] = [];
     toHide.forEach((id) => {
       if (!this.hiddenObjects[id]) {
         this.hiddenObjects[id] = new Set();
-        updatedIds.push(id);
+        updatedIds.push(String(id));
       }
     });
 
@@ -395,18 +352,17 @@ class FeatureVisibility {
 
   /**
    * unHides a number of objects
-   * @param {Array<string|number>} unHide A list of Object Ids which will be unHidden
-   * @api stable
+   * @param  unHide A list of Object Ids which will be unHidden
    */
-  showObjects(unHide) {
-    const updatedIds = [];
+  showObjects(unHide: (string | number)[]): void {
+    const updatedIds: string[] = [];
     unHide.forEach((id) => {
       if (this.hiddenObjects[id]) {
         this.hiddenObjects[id].forEach((f) => {
           showFeature(f, hidden);
         });
         delete this.hiddenObjects[id];
-        updatedIds.push(id);
+        updatedIds.push(String(id));
       }
     });
 
@@ -420,26 +376,28 @@ class FeatureVisibility {
 
   /**
    * clears all the hidden objects
-   * @api stable
    */
-  clearHiddenObjects() {
+  clearHiddenObjects(): void {
     this.showObjects(Object.keys(this.hiddenObjects));
   }
 
-  /**
-   * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Entity} feature
-   * @returns {boolean}
-   */
-  hasHiddenFeature(id, feature) {
+  hasHiddenFeature(
+    id: string | number,
+    feature:
+      | import('ol').Feature<import('ol/geom/Geometry.js').default>
+      | import('@vcmap-cesium/engine').Cesium3DTileFeature
+      | import('@vcmap-cesium/engine').Entity,
+  ): boolean {
     return this.hiddenObjects[id] && this.hiddenObjects[id].has(feature);
   }
 
-  /**
-   * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Entity} feature
-   */
-  addHiddenFeature(id, feature) {
+  addHiddenFeature(
+    id: string | number,
+    feature:
+      | import('ol').Feature<import('ol/geom/Geometry.js').default>
+      | import('@vcmap-cesium/engine').Cesium3DTileFeature
+      | import('@vcmap-cesium/engine').Entity,
+  ): void {
     if (this.hiddenObjects[id]) {
       cacheOriginalStyle(feature);
       this.hiddenObjects[id].add(feature);
@@ -451,7 +409,7 @@ class FeatureVisibility {
   /**
    * Clears all caches and removes cesium events.
    */
-  destroy() {
+  destroy(): void {
     Object.values(this.hiddenObjects).forEach((s) => {
       s.clear();
     });