@mappedin/mappedin-js 6.0.1-alpha.21 → 6.0.1-alpha.22

package/lib/esm/index.d.ts

@@ -4,6 +4,7 @@
 //   ../maker/geojson
 //   ../maker/three
 //   ../maker/@mappedin/core-sdk
+//   ../maker/@mappedin/core-sdk/src/camera
 //   ../maker/minisearch
 //   ../maker/@turf/turf
 //   ../maker/@tweenjs/tween.js
@@ -1036,8 +1037,8 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-geojson' {
     import { GeoJSONTEvents as TEvents } from '@mappedin/mappedin-js/maker/src/events';
     import { Floor, MapObject, Space } from '@mappedin/mappedin-js/maker/src/map-data-objects';
     import MapData from '@mappedin/mappedin-js/maker/src/map-data';
-    import { ICamera, IMapView, IMarkers, IPaths, TUpdateState, INavigation, TNavigationTarget, TGetDirectionsOptions, TGeometryState, TLabelState } from '@mappedin/mappedin-js/maker/src/map-view-interface';
-    import { Directions, Label } from '@mappedin/mappedin-js/maker/src/map-view-objects';
+    import { ICamera, IMapView, IMarkers, IPaths, TUpdateState, INavigation, TNavigationTarget, TGetDirectionsOptions, TGeometryState, TLabelState, TMarkerState } from '@mappedin/mappedin-js/maker/src/map-view-interface';
+    import { Directions, Label, Marker } from '@mappedin/mappedin-js/maker/src/map-view-objects';
     import type { RendererCore } from '@mappedin/core-sdk';
     import { LabelsApi } from '@mappedin/mappedin-js/maker/src/api-geojson/labels';
     import { Inspector } from '@mappedin/mappedin-js/maker/src/api-geojson';
@@ -1100,11 +1101,11 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-geojson' {
                 * // Update the color of a space to red.
                 * map.updateState(space, { color: 'red' });
                 */
-            updateState<T extends Space | MapObject | Label | string>(target: T, state: TUpdateState<T>): void;
+            updateState<T extends Space | MapObject | Label | Marker | string>(target: T, state: TUpdateState<T>): void;
             setHoverColor(c: string): void;
-            getHoverColor(): string | undefined;
+            getHoverColor(): any;
             getState(id: string): TGeometryState | TLabelState | undefined;
-            getState(target: Space | Label | MapObject): TGeometryState | TLabelState;
+            getState(target: Space | Label | Marker | MapObject): TGeometryState | TLabelState | TMarkerState;
             /**
                 * Retrieves the current floor of the map.
                 *
@@ -1144,6 +1145,7 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
     import type { Coordinate, Floor, Door, Space, MapObject, PointOfInterest, Connection } from '@mappedin/mappedin-js/maker/src/map-data-objects';
     import { Label, Marker, Path, Directions } from '@mappedin/mappedin-js/maker/src/map-view-objects';
     import type { MapData, TNavigationOptions } from '@mappedin/mappedin-js/maker/src';
+    import { EasingCurve } from '@mappedin/core-sdk/src/camera';
     /**
         * Interface defining the controls and actions for a label on the map.
         */
@@ -1158,6 +1160,20 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
                 */
             readonly __type: 'Label';
     }
+    /**
+        * Interface defining the controls and actions for a label on the map.
+        */
+    export interface IMarker {
+            /**
+                * Label's id
+                */
+            id: string;
+            /**
+                * Label's internal type
+                * @internal
+                */
+            readonly __type: 'Marker';
+    }
     /**
         * Interface defining the controls and actions for labels ({@link Label}) on the map.
         */
@@ -1230,7 +1246,7 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
                 * @example
                 * map.Markers.removeAll();
                 */
-            removeAll: () => void;
+            removeAll: () => Marker[];
     }
     /**
         * Interface defining the controls and actions for paths ({@link Path}) on the map.
@@ -1290,6 +1306,18 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
             priority: number | 'initial';
             interactive: boolean;
     };
+    export type TMarkerState = {
+            type: 'marker';
+            /**
+                * HTML element for the marker.
+                */
+            element: HTMLElement;
+            /**
+                * Priority level of the marker, used for determining display order.
+                */
+            priority: number | 'initial';
+            interactive: boolean;
+    };
     /**
         * Defines the state for geometry elements like {@link Space} when updated.
         */
@@ -1311,8 +1339,8 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
     /**
         * The type for updating the state of map elements (colors, texts, etc.).
         */
-    export type TUpdateState<T> = T extends ILabel ? Partial<TLabelState> : T extends Space | MapObject ? Partial<TGeometryState> : T extends string ? Record<string, any> : never;
-    export type TGetState<T> = T extends Label ? TLabelState : T extends Space | MapObject ? TGeometryState : T extends string ? TLabelState | TGeometryState | undefined : never;
+    export type TUpdateState<T> = T extends IMarker ? Partial<TMarkerState> : T extends ILabel ? Partial<TLabelState> : T extends Space | MapObject ? Partial<TGeometryState> : T extends string ? Record<string, any> : never;
+    export type TGetState<T> = T extends Marker ? TMarkerState : T extends Label ? TLabelState : T extends Space | MapObject ? TGeometryState : T extends string ? TLabelState | TGeometryState | TMarkerState | undefined : never;
     /**
         * Options for {@link ICamera} animations on the map.
         */
@@ -1324,7 +1352,7 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
             /**
                 * Easing function to use for the animation.
                 */
-            easing?: TEasingFunction;
+            easing?: EasingCurve;
     };
     /**
         * Types of easing for animations.
@@ -5340,7 +5368,11 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-objects/marker' {
             /**
                 * @internal
                 */
-            readonly __type: 'Marker';
+            static readonly __type = "Marker";
+            /**
+                * @internal
+                */
+            readonly __type = "Marker";
             /**
                 * The HTML element that represents the marker.
                 */
@@ -5349,6 +5381,13 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-objects/marker' {
                 * Updates the marker's position on the map.
                 */
             readonly update: () => void;
+            /**
+                * Checks if the provided instance is of type Label.
+                *
+                * @param instance The instance to check.
+                * @returns {boolean} True if the instance is a Label, false otherwise.
+                */
+            static is(instance: object): instance is Marker;
             /**
                 * @internal
                 */
@@ -9736,7 +9775,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
 declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controllers/StackedMapsController' {
     import { MappedinDirections, MappedinMap, MappedinNode } from '@mappedin/mappedin-js/packages/get-venue';
     import { STACKED_MAPS_STATE, MapViewScene, MapViewStackScene, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
-    import type { ICore, TCameraTransform } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
+    import type { ICore, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
     import { TStackedMapsOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/MapView.types';
     enum ACTION {
         enable = "enable",
@@ -9755,18 +9794,24 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
         stackScene: MapViewStackScene;
         directions: MappedinDirections | MappedinDirections[];
         verticalDistanceBetweenMaps?: number;
+        animationOptions?: TCameraAnimationOptions;
     } | {
         stackScene: MapViewStackScene;
         verticalDistanceBetweenMaps?: number;
         map: MappedinMap;
         nodes: MappedinNode[];
+        cameraOptions?: TCameraTransform & TCameraAnimationOptions;
+        duration?: number;
+        animationOptions?: TCameraAnimationOptions;
     } | {
         stackScene: MapViewStackScene;
         map: MappedinMap;
         nodes: MappedinNode[];
         rotation: number;
-        cameraTransform?: TCameraTransform;
+        cameraOptions?: TCameraTransform & TCameraAnimationOptions;
         verticalDistanceBetweenMaps?: number;
+        duration?: number;
+        animationOptions?: TCameraAnimationOptions;
     };
     type TActionFn = [STACKED_MAPS_STATE, TTargetTransitionFunction[]];
     type TState = {
@@ -9799,6 +9844,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
                     tilt: number;
                     rotation: number;
                     position?: MappedinNode | import("../../internal").MappedinCoordinate | undefined;
+                    duration?: number | undefined;
                     easing: CAMERA_EASING_MODE;
                 };
             };
@@ -9810,8 +9856,9 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
             activeMap: MappedinMap;
             focusOn: {
                 options: {
-                    tilt: number;
                     duration: number;
+                    easing?: CAMERA_EASING_MODE | undefined;
+                    tilt: number;
                 };
             };
             verticalDistanceBetweenMaps: number | undefined;
@@ -9827,6 +9874,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
                 };
             };
             activeMap: MappedinMap;
+            duration: number | undefined;
         })[] | undefined;
         getRestackOptions: (params: TParams) => (MapViewStackScene | {
             activeMap: MappedinMap;
@@ -9852,10 +9900,10 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
         disable: () => Promise<void>;
         enable: (opts?: TStackedMapsOptions) => Promise<void>;
         get nodesInJourneyOrMap(): any[];
-        showOverview: () => Promise<void>;
-        scrollToMap: (map: MappedinMap) => Promise<void>;
+        showOverview: (animationOptions?: TCameraAnimationOptions) => Promise<void>;
+        scrollToMap: (map: MappedinMap, duration?: number) => Promise<void>;
         restack: (options?: TStackedMapsOptions) => Promise<void>;
-        zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+        zoomInToMap: (map: MappedinMap, cameraOptions?: TCameraTransform & TCameraAnimationOptions) => Promise<void>;
         get currentMap(): MappedinMap;
     }
     export default StackedMapsController;
@@ -13030,10 +13078,9 @@ declare module '@mappedin/mappedin-js/maker/src/map-data-objects/base-metadata-o
 declare module '@mappedin/mappedin-js/maker/src/api-geojson/map-object' {
     import { ParsedMVF } from '@mappedin/mvf';
     import { FloorObject } from '@mappedin/mappedin-js/maker/src/api-geojson/floor-object';
-    import { AddLabelOptions } from '@mappedin/core-sdk';
     import { Position } from '@mappedin/core-sdk';
     import { TAddMarkerOptions } from '@mappedin/mappedin-js/maker/src';
-    import { Geometry2D, RendererCore } from '@mappedin/core-sdk';
+    import { AddLabelOptions, Geometry2D, RendererCore } from '@mappedin/core-sdk';
     export class GeojsonApiMapObject {
         floors: FloorObject[];
         currentFloorId: string;
@@ -13046,7 +13093,7 @@ declare module '@mappedin/mappedin-js/maker/src/api-geojson/map-object' {
                 floorId?: string;
             }) => import("@mappedin/core-sdk").Marker;
             remove: (_id: string) => void;
-            getContentEl: (id: string) => HTMLDivElement | null;
+            getContentEl: (id: string) => any;
             removeAll: () => void;
             all({ onCreate }: {
                 onCreate: (entity: Geometry2D) => void;
@@ -13085,7 +13132,7 @@ declare module '@mappedin/mappedin-js/maker/src/api-geojson/api' {
     import MapData from '@mappedin/mappedin-js/maker/src/map-data';
     import { Coordinate, Floor, MapDataInternal, Space, MapObject } from '@mappedin/mappedin-js/maker/src/map-data-objects';
     import { ICamera, IMapView, INavigation, TGetState, TUpdateState } from '@mappedin/mappedin-js/maker/src/map-view-interface';
-    import { CameraTransform, Label, Path } from '@mappedin/mappedin-js/maker/src/map-view-objects';
+    import { CameraTransform, Label, Marker, Path } from '@mappedin/mappedin-js/maker/src/map-view-objects';
     import { RendererCore, InteractionPayload } from '@mappedin/core-sdk';
     import { GeojsonApiMapObject } from '@mappedin/mappedin-js/maker/src/api-geojson/map-object';
     import GUI from 'lil-gui';
@@ -13109,7 +13156,7 @@ declare module '@mappedin/mappedin-js/maker/src/api-geojson/api' {
             Markers: MarkersApi;
             constructor(rendererCore: RendererCore, _options?: any);
             updateStackState: RendererCore['updateStackState'];
-            updateState<T extends Space | MapObject | Label | string>(target: T, state: TUpdateState<T>): void;
+            updateState<T extends Space | MapObject | Label | Marker | string>(target: T, state: TUpdateState<T>): void;
             update: () => void;
             getMapData(): MapDataInternal | undefined;
             addMap(mapData: MapData): Promise<MapData>;
@@ -13120,9 +13167,9 @@ declare module '@mappedin/mappedin-js/maker/src/api-geojson/api' {
                     remove: (_label: any) => void;
                     removeAll: () => void;
             };
-            getState<T extends Space | MapObject | Label | string>(target: T): TGetState<T> | undefined;
+            getState<T extends Space | MapObject | Label | Marker | string>(target: T): TGetState<T> | undefined;
             setHoverColor(c: string): void;
-            getHoverColor(): string | undefined;
+            getHoverColor(): any;
             getDirections: IMapView['getDirections'];
             Navigation: INavigation;
             createCoordinate(latitude: number, longitude: number, floor?: Floor): Coordinate;
@@ -13144,14 +13191,16 @@ declare module '@mappedin/mappedin-js/maker/src/api-geojson/utils' {
     import type { Position, EntranceCollection, LineString, ObstructionProperties } from '@mappedin/mvf';
     import { FeatureCollection } from '@turf/turf';
     import { Feature, MultiLineString } from 'geojson';
-    import { CollisionRankingTier, LabelState } from '@mappedin/core-sdk';
+    import { CollisionRankingTier, LabelState, MarkerState } from '@mappedin/core-sdk';
     import { TGeometryState, TLabelState } from '@mappedin/mappedin-js/maker/src';
     import { GeometryState } from '@mappedin/core-sdk';
+    import { TMarkerState } from '@mappedin/mappedin-js/maker/src/map-view-interface';
     export function convertCoordinateToPosition(coord: Coordinate): Position;
     export function convertPositionToCoordinate(coord: Position): Coordinate;
     export const cutEntracesFromLineStrings: (lineStrings: FeatureCollection<LineString, ObstructionProperties>['features'], entranceCollection: EntranceCollection['features']) => Feature<MultiLineString, any>;
     export function convertPriorityToCollisionTier(priority: TLabelState['priority']): CollisionRankingTier;
     export function translateLabelStateToGeojsonCore(state: Partial<TLabelState>): Partial<LabelState>;
+    export function translateMarkerStateToGeojsonCore(state: Partial<TMarkerState>): Partial<MarkerState>;
     export function translateSpaceStateToGeojsonCore(state: Partial<TGeometryState>): Partial<GeometryState>;
 }
 
@@ -14622,7 +14671,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Camera
 declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/StackedMaps' {
     import { MappedinMap } from '@mappedin/mappedin-js/packages/get-venue';
     import { TStackedMapsOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/MapView.types';
-    import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
+    import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
     /**
         * @experimental
         * API for showing multiple maps involved in a {@link Journey} as a vertical stack.
@@ -14686,7 +14735,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
                 *
                 * @returns Promise when all animations are complete.
                 */
-            showOverview: () => Promise<void>;
+            showOverview: (animationOptions?: TCameraAnimationOptions) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -14694,7 +14743,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
                 *
                 * @example
                 * ```ts
-                * // Zoom into a clicked map if Stacked Maps is in Overview state
+                * // Scroll the camera to a specific map if Stacked Maps is in Overview state
                 * mapView.on(E_SDK_EVENT.CLICK, ({ maps }) => {
                 * 	if (maps.length <= 0) return;
                 * 	if (mapView.StackedMaps.state === STACKED_MAPS_STATE.OVERVIEW) {
@@ -14705,7 +14754,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
                 *
                 * @returns Promise when all animations are complete.
                 */
-            scrollToMap: (map: MappedinMap) => Promise<void>;
+            scrollToMap: (map: MappedinMap, duration?: number) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -14724,7 +14773,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
                 *
                 * @returns Promise when all animations are complete.
                 */
-            zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+            zoomInToMap: (map: MappedinMap, cameraOptions?: TCameraTransform & TCameraAnimationOptions) => Promise<void>;
             /**
                 * @experimental
                 *