@mappedin/mappedin-js 5.27.0 → 5.27.1

package/lib/esm/renderer/chunk-LJYUKB3N.js

@@ -0,0 +1 @@
+import{b as a}from"./chunk-ZRT45YCM.js";var e,c=a((()=>{e={env:{NODE_ENV:"production",npm_package_version:"5.27.1"}}}));export{c as a,e as b};

package/lib/esm/renderer/index.d.ts

@@ -6528,7 +6528,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/outdoor-context/Mappedin
 declare module '@mappedin/mappedin-js/renderer/private/Core.interface' {
     import { Color, Vector2, Vector3, Mesh } from 'three';
     import type { TPadding, TGetPolygonsAtCoordinateOptions, TMapViewOptions, TileManager, BillboardManager, StackedMapsController, SmartCollisionEngine, OutdoorViewController, LayerController } from '@mappedin/mappedin-js/renderer/internal';
-    import { BlueDotController, CameraController, STATE, MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode, changeListenerFn, RENDER, INTERNAL_EVENT_PAYLOAD, INTERNAL_EVENT, TaskScheduler, SceneManager, PubSub, FlatLabel, MapObject, PathsController, FloatingLabelsController, FlatLabelsController, PolygonColorsController, MarkersController, PolygonInteractionController, TooltipsController, PolygonStatesController, PolygonImagesController, ThreeDMarkersController, ExportController, EventSystem, Element } from '@mappedin/mappedin-js/renderer/internal';
+    import { BlueDotController, CameraController, STATE, MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode, changeListenerFn, RENDER, INTERNAL_EVENT_PAYLOAD, INTERNAL_EVENT, TaskScheduler, SceneManager, PubSub, FlatLabel, MapObject, PathsController, FloatingLabelsController, FlatLabelsController, PolygonColorsController, MarkersController, PolygonInteractionController, TooltipsController, PolygonStatesController, PolygonImagesController, ThreeDMarkersController, ExportController, EventSystem } from '@mappedin/mappedin-js/renderer/internal';
     import Tween, { Easing } from '@tweenjs/tween.js';
     import WatermarkController from '@mappedin/mappedin-js/renderer/private/controllers/WatermarkController';
     import PolygonHoverColorsController from '@mappedin/mappedin-js/renderer/private/controllers/PolygonHoverColorsController';
@@ -6631,7 +6631,6 @@ declare module '@mappedin/mappedin-js/renderer/private/Core.interface' {
             cachedPadding: TPadding;
             getCameraFrameForPoints: any;
             polygonMeshesById: Record<string, Mesh>;
-            renderedElementsById: Record<string, Element>;
             textLabelsByPolygonId: Record<string, FlatLabel>;
             renderer: any;
             scene: any;
@@ -7451,21 +7450,60 @@ declare module '@mappedin/mappedin-js/renderer/private/scene-manager/MapView.Dyn
 }
 
 declare module '@mappedin/mappedin-js/get-venue/pub-sub.typed' {
+    /**
+        * Generic PubSub class implementing the Publish-Subscribe pattern for event handling.
+        *
+        * @template EVENT_PAYLOAD - The type of the event payload.
+        * @template EVENT - The type of the event.
+        */
     export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD> {
             /**
                 * @private
+                * @internal
                 */
             _subscribers: any;
             /**
                 * @private
+                * @internal
                 */
             publish<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, data?: EVENT_PAYLOAD[EVENT_NAME]): void;
+            /**
+                * Subscribe a function to an event.
+                *
+                * @param eventName An event name which, when fired, will call the provided
+                * function.
+                * @param fn A callback that gets called when the corresponding event is fired. The
+                * callback will get passed an argument with a type that's one of event payloads.
+                * @example
+                * // Subscribe to the 'click' event
+                * const handler = (event) => {
+                *  const { coordinate } = event;
+                *  const { latitude, longitude } = coordinate;
+                * 	console.log(`Map was clicked at ${latitude}, ${longitude}`);
+                * };
+                * map.on('click', handler);
+                */
             on<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME] extends {
                     data: null;
             } ? EVENT_PAYLOAD[EVENT_NAME]['data'] : EVENT_PAYLOAD[EVENT_NAME]) => void): void;
+            /**
+                * Unsubscribe a function previously subscribed with {@link on}
+                *
+                * @param eventName An event name to which the provided function was previously
+                * subscribed.
+                * @param fn A function that was previously passed to {@link on}. The function must
+                * have the same reference as the function that was subscribed.
+                * @example
+                * // Unsubscribe from the 'click' event
+                * const handler = (event) => {
+                * 	console.log('Map was clicked', event);
+                * };
+                * map.off('click', handler);
+                */
             off<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME]) => void): void;
             /**
                 * @private
+                * @internal
                 */
             destroy(): void;
     }
@@ -9811,7 +9849,7 @@ declare module '@mappedin/mappedin-js/renderer/private/Core' {
     import { Color, Mesh, PerspectiveCamera, Scene, Vector2 } from 'three';
     import '../internal/object3D.destroy';
     import type { TGetPolygonsAtCoordinateOptions, TMapViewOptions, TPadding, MappedinPolygon } from '@mappedin/mappedin-js/renderer/internal';
-    import { Renderer, TaskScheduler, MapManager, FlatLabel, SmartCollisionEngine, PubSub, INTERNAL_EVENT, INTERNAL_EVENT_PAYLOAD, MapView, STATE, MapObject, SceneManager, TileManager, PathsController, FloatingLabelsController, FlatLabelsController, PolygonColorsController, MarkersController, PolygonInteractionController, TooltipsController, PolygonStatesController, PolygonImagesController, ThreeDMarkersController, EventSystem, BlueDotController, CameraController, Element, BillboardManager, StackedMapsController, OutdoorViewController, WatermarkController, PolygonHoverColorsController, ExportController, LayerController } from '@mappedin/mappedin-js/renderer/internal';
+    import { Renderer, TaskScheduler, MapManager, FlatLabel, SmartCollisionEngine, PubSub, INTERNAL_EVENT, INTERNAL_EVENT_PAYLOAD, MapView, STATE, MapObject, SceneManager, TileManager, PathsController, FloatingLabelsController, FlatLabelsController, PolygonColorsController, MarkersController, PolygonInteractionController, TooltipsController, PolygonStatesController, PolygonImagesController, ThreeDMarkersController, EventSystem, BlueDotController, CameraController, BillboardManager, StackedMapsController, OutdoorViewController, WatermarkController, PolygonHoverColorsController, ExportController, LayerController } from '@mappedin/mappedin-js/renderer/internal';
     import { Mappedin as IMappedin, MappedinCoordinate, MappedinMap, MappedinNode } from '@mappedin/mappedin-js/get-venue';
     import { E_MAP_CHANGED_REASON } from '@mappedin/mappedin-js/renderer/MapView.enums';
     import type { PerformanceController } from '@mappedin/mappedin-js/renderer/private/controllers/PerformanceController';
@@ -9882,7 +9920,6 @@ declare module '@mappedin/mappedin-js/renderer/private/Core' {
             focusZoomFactor: number;
             cameraObject: PerspectiveCamera;
             polygonMeshesById: Record<string, Mesh>;
-            renderedElementsById: Record<string, Element>;
             textLabelsByPolygonId: Record<string, FlatLabel>;
             labelOrientationDelay: number;
             isWebGL2: boolean;