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

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

@@ -5,56 +5,38 @@ import {
   cacheOriginalStyle,
   showFeature,
   FeatureVisibilityAction,
+  HighlightableFeature,
+  FeatureVisibilityEvent,
 } from './featureVisibility.js';
 import VcsEvent from '../vcsEvent.js';
 
-/**
- * @typedef {Object} HiddenObject
- * @property {string} id
- */
-
 /**
  * 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.
+ * Features can be defined as hidden by {@link VcsModuleConfig} or {@link LayerOptions}.
+ * Hiding will be performed, when a {@link VcsModule} is loaded, a {@link Layer} is activated or GlobalHider API is called.
  * 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
+ * A feature will be shown again, when a {@link VcsModule} is removed, a {@link Layer} is deactivated or GlobalHider API is called.
  */
 class GlobalHider {
-  constructor() {
-    /**
-     * @type {Object<string, number>}
-     * @api
-     */
-    this.hiddenObjects = {};
-    /**
-     * @type {Object<string, Set<import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Entity>>}
-     * @private
-     */
-    this._hiddenObjectFeatures = {};
-    /**
-     * @type {number}
-     * @api
-     */
-    this.lastUpdated = Date.now();
-    /**
-     * An event raised when the hidden ids change. Is called with
-     * {@link FeatureVisibilityEvent} as its only argument
-     * @type {VcsEvent<FeatureVisibilityEvent>}
-     */
-    this.changed = new VcsEvent();
-  }
+  hiddenObjects: Record<string, number> = {};
+
+  private _hiddenObjectFeatures: Record<string, Set<HighlightableFeature>> = {};
+
+  lastUpdated: number = Date.now();
+
+  /**
+   * An event raised when the hidden ids change. Is called with
+   * {@link FeatureVisibilityEvent} as its only argument
+   */
+  changed: VcsEvent<FeatureVisibilityEvent> = new VcsEvent();
 
   /**
    * Add a tick to the hide count, hidding the features if they are not already hidden
-   * @param {Array<string>} uuids
-   * @api
    */
-  hideObjects(uuids) {
+  hideObjects(uuids: string[]): void {
     check(uuids, [String]);
 
-    const updatedIds = [];
+    const updatedIds: string[] = [];
     uuids.forEach((uuid) => {
       if (!this.hiddenObjects[uuid]) {
         updatedIds.push(uuid);
@@ -74,13 +56,11 @@ class GlobalHider {
 
   /**
    * Subtract from the hide count for an Array of ids. If the array reaches 0, features with said UUID will be shown
-   * @param {Array<string>} uuids
-   * @api
    */
-  showObjects(uuids) {
+  showObjects(uuids: string[]): void {
     check(uuids, [String]);
 
-    const updatedIds = [];
+    const updatedIds: string[] = [];
     uuids.forEach((uuid) => {
       if (this.hiddenObjects[uuid]) {
         this.hiddenObjects[uuid] -= 1;
@@ -105,11 +85,7 @@ class GlobalHider {
     }
   }
 
-  /**
-   * @param {number|string} uuid
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Entity} feature
-   */
-  addFeature(uuid, feature) {
+  addFeature(uuid: number | string, feature: HighlightableFeature): void {
     if (!this._hiddenObjectFeatures[uuid]) {
       this._hiddenObjectFeatures[uuid] = new Set();
     }
@@ -119,18 +95,13 @@ class GlobalHider {
     hideFeature(feature);
   }
 
-  /**
-   * @param {string|number} uuid
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Entity} feature
-   * @returns {boolean}
-   */
-  hasFeature(uuid, feature) {
+  hasFeature(uuid: string | number, feature: HighlightableFeature): boolean {
     return this._hiddenObjectFeatures[uuid]
       ? this._hiddenObjectFeatures[uuid].has(feature)
       : false;
   }
 
-  destroy() {
+  destroy(): void {
     this.hiddenObjects = {};
     Object.values(this._hiddenObjectFeatures).forEach((set) => {
       set.clear();