@mappedin/mappedin-js 6.0.1-beta.10 → 6.0.1-beta.12

package/lib/esm/index.d.ts

@@ -146,6 +146,11 @@ declare module '@mappedin/mappedin-js' {
                 */
             autoRenderBeauty?: boolean;
     };
+    /**
+        * @interface
+        * Options for the watermark.
+        */
+    export type TWatermarkOptions = Omit<WatermarkOptions, 'visible'>;
     /**
         * Options for showing a 3D map.
         *
@@ -219,18 +224,22 @@ declare module '@mappedin/mappedin-js' {
                 *
                 * @hidden
                 */
-            watermark?: WatermarkOptions;
+            watermark?: TWatermarkOptions;
             /**
                 * Options for the attribution control.
                 *
                 * @hidden
                 */
             attribution?: {
+                    /**
+                        * Custom attribution content.
+                        */
+                    custom?: string[];
                     /**
                         * Attribution position.
                         * @default 'bottom-right'
                         */
-                    position: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+                    position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
             };
             /**
                 * First floor to be rendered.
@@ -502,7 +511,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/map-data' {
             /**
                 * Changes the language of the map data.
                 *
-                * @param localeCode The ISO 639-1 language code to change to (e.g., 'en' for English, 'fr' for French). Check venue.languages for available languages
+                * @param localeCode The ISO 639-1 language code to change to (e.g., 'en' for English, 'fr' for French). Check ({@link EnterpriseVenue.languages}) for available languages
                 * @returns A promise that resolves when the language change is complete.
                 * @throws An error if the language change fails.
                 * @example
@@ -846,7 +855,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/map-data-objects' {
 }
 
 declare module '@mappedin/mappedin-js/mappedin-js/src/map-view' {
-    import type { RendererCore, WatermarkOptions } from '@mappedin/core-sdk';
+    import type { RendererCore, WatermarkUpdateOptions } from '@mappedin/core-sdk';
     import { PubSub } from '@packages/internal/common';
     import { type TEvents, type TShow3DMapOptions } from '@mappedin/mappedin-js/mappedin-js/src';
     import type { Navigation } from '@mappedin/mappedin-js/mappedin-js/src/navigation';
@@ -981,7 +990,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/map-view' {
                 * @param options {WatermarkOptions}
                 * @hidden
                 */
-            updateWatermark(options: Omit<WatermarkOptions, 'onClick'>): void;
+            updateWatermark(options: WatermarkUpdateOptions): void;
             getState<T extends Space | MapObject | Label | Marker | Image | string>(target: T): TGetState<T> | undefined;
             setHoverColor(c: string): void;
             getHoverColor(): string | undefined;
@@ -1106,7 +1115,7 @@ declare module '@mappedin/mappedin-js/geojson/src' {
     export { mountSceneGraphVisualizer };
     export type { EntityId, EntityState, LineStyle, PaintStyle, ModelStyle, ModelProperties, Shading } from '@mappedin/mappedin-js/geojson/src/types';
     export type * from 'geojson';
-    export type { WatermarkOptions, WatermarkPosition } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
+    export type { WatermarkUpdateOptions, WatermarkOptions, WatermarkPosition } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
     export type { GLTFExportOptions } from '@mappedin/mappedin-js/geojson/src/systems/exporter';
     export type { AttributionControlOptions, AttributionPosition } from '@mappedin/mappedin-js/geojson/src/systems/html-controls/system';
     export { ATTRIBUTION_POSITIONS } from '@mappedin/mappedin-js/geojson/src/systems/html-controls/system';
@@ -3656,6 +3665,11 @@ declare module '@mappedin/mappedin-js/mappedin-js/src' {
                 */
             autoRenderBeauty?: boolean;
     };
+    /**
+        * @interface
+        * Options for the watermark.
+        */
+    export type TWatermarkOptions = Omit<WatermarkOptions, 'visible'>;
     /**
         * Options for showing a 3D map.
         *
@@ -3729,18 +3743,22 @@ declare module '@mappedin/mappedin-js/mappedin-js/src' {
                 *
                 * @hidden
                 */
-            watermark?: WatermarkOptions;
+            watermark?: TWatermarkOptions;
             /**
                 * Options for the attribution control.
                 *
                 * @hidden
                 */
             attribution?: {
+                    /**
+                        * Custom attribution content.
+                        */
+                    custom?: string[];
                     /**
                         * Attribution position.
                         * @default 'bottom-right'
                         */
-                    position: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+                    position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
             };
             /**
                 * First floor to be rendered.
@@ -5568,7 +5586,7 @@ declare module '@mappedin/mappedin-js/geojson/src/renderer' {
     import type { GeometryGroupState } from '@mappedin/mappedin-js/geojson/src/entities/geometry-group';
     import { DOMResizeSystem } from '@mappedin/mappedin-js/geojson/src/systems/dom-resize/system';
     import { Camera } from '@mappedin/mappedin-js/geojson/src/camera';
-    import { type WatermarkOptions, WatermarkSystem } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
+    import { type WatermarkUpdateOptions, WatermarkSystem } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
     import { PanBoundsSystem } from '@mappedin/mappedin-js/geojson/src/systems/pan-bounds/system';
     import { HTMLControlsSystem } from '@mappedin/mappedin-js/geojson/src/systems/html-controls/system';
     import { type CustomGeometryBuilder, type ShapeState } from '@mappedin/mappedin-js/geojson/src/components/custom';
@@ -5702,9 +5720,9 @@ declare module '@mappedin/mappedin-js/geojson/src/renderer' {
             /**
                 * Updates the watermark on the map.
                 *
-                * @param options {WatermarkOptions}
+                * @param options {WatermarkUpdateOptions}
                 */
-            updateWatermark(options: Omit<WatermarkOptions, 'onClick'>): void;
+            updateWatermark(options: WatermarkUpdateOptions): void;
             /**
                 * Remove an entity from the renderer and release associated resources.
                 */
@@ -6234,6 +6252,7 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/watermark/system' {
     import { PubSub } from '@packages/internal/common';
     import type { Geometry2D } from '@mappedin/mappedin-js/geojson/src/entities';
     import type { QuadTree } from '@packages/internal/quad-tree';
+    import type { RendererState } from '@mappedin/mappedin-js/geojson/src/renderer';
     export type WatermarkPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' | 'top' | 'bottom' | 'left' | 'right';
     export type WatermarkOptions = {
             /**
@@ -6268,18 +6287,26 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/watermark/system' {
             scale?: number;
             /**
                 * Callback when the watermark is clicked.
+                * @hidden
                 */
             onClick?: () => void;
+            /**
+                * Whether the watermark should be visible.
+                * @hidden
+                * @default true
+                */
+            visible?: boolean;
     };
+    export type WatermarkUpdateOptions = Omit<WatermarkOptions, 'onClick' | 'visible'>;
     export class WatermarkSystem extends PubSub<{
             'texture-loaded': void;
     }> {
             #private;
             dirty: boolean;
-            get options(): WatermarkOptions;
-            set options(options: WatermarkOptions);
+            get options(): Required<WatermarkOptions>;
+            set options(options: WatermarkUpdateOptions);
             get icon(): string;
-            constructor(cameraObject: PerspectiveCamera, canvasWidth: number, canvasHeight: number, rendererState: any, options?: WatermarkOptions);
+            constructor(cameraObject: PerspectiveCamera, rendererState: RendererState, options?: Partial<WatermarkOptions>);
             get width(): number;
             get height(): number;
             getPositionAlignedOffset(width: number, height: number): {
@@ -6301,6 +6328,7 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/watermark/system' {
             }>): void;
             resize(canvasWidth: number, canvasHeight: number): void;
             update(): void;
+            destroy(): void;
     }
 }
 
@@ -6317,7 +6345,8 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/html-controls/system'
     export const ATTRIBUTION_POSITIONS: readonly ["top-left", "top-right", "bottom-left", "bottom-right"];
     export type AttributionPosition = (typeof ATTRIBUTION_POSITIONS)[number];
     export type AttributionControlOptions = {
-            position: AttributionPosition;
+            custom?: string[];
+            position?: AttributionPosition;
     };
     export class HTMLControlsSystem {
             controlContainerEl: HTMLDivElement;
@@ -6328,6 +6357,7 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/html-controls/system'
             attribButtonEl?: HTMLElement;
             feedbackLinkEl?: HTMLAnchorElement;
             attribHTML: string;
+            customAttributions: string[];
             constructor(container: HTMLElement);
             addAttributionControl(options?: AttributionControlOptions): void;
             toggleAttribution: (e: MouseEvent) => void;
@@ -6511,6 +6541,10 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/map-view-objects/path' {
                 * The label's id
                 */
             id: string;
+            /**
+                * The promise that resolves when the current path animation is complete.
+                */
+            animation: Promise<void>;
             /**
                 * @internal
                 */
@@ -6518,7 +6552,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/map-view-objects/path' {
             /**
                 * @internal
                 */
-            constructor(id: string);
+            constructor(id: string, drawAnimation: Promise<void>);
     }
 }
 
@@ -6561,7 +6595,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/map-object' {
     import type { Position, AddLabelOptions, RendererCore, PathState, MarkerState, LineStyle, PaintStyle, EntityId } from '@mappedin/core-sdk';
     import { FloorObject } from '@mappedin/mappedin-js/mappedin-js/src/api-geojson/floor-object';
     import type { Coordinate, TAddMarkerOptions, TAddPathOptions, TShow3DMapOptions } from '@mappedin/mappedin-js/mappedin-js/src';
-    import type { GLTFExportOptions, TAnimationOptions, TAddModelOptions, TAddModel, TAddImageOptions, CancellablePromise } from '@mappedin/mappedin-js/mappedin-js/src/types';
+    import type { GLTFExportOptions, TAnimationOptions, TAddModelOptions, TAddModel, TAddImageOptions } from '@mappedin/mappedin-js/mappedin-js/src/types';
     import { type AggregatedStyleMap } from '@mappedin/mappedin-js/mappedin-js/src/api-geojson/utils';
     import { StackedMaps } from '@mappedin/mappedin-js/mappedin-js/src/api-geojson/stacked-maps/stacked-maps';
     import type { TFloorChangeReason } from '@mappedin/mappedin-js/mappedin-js/src/events';
@@ -6627,7 +6661,10 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/map-object' {
             removeAll: () => void;
         };
         Paths: {
-            add: (coordinates: Coordinate[], options?: TAddPathOptions) => CancellablePromise<EntityId<PathState>[]>;
+            add: (coordinates: Coordinate[], options?: TAddPathOptions) => {
+                paths: EntityId<PathState>[];
+                animation: Promise<void>;
+            };
             remove: (entityIds: string[]) => void;
         };
         constructor(id: string, mvf: any, styleMap: AggregatedStyleMap, options: TShow3DMapOptions | undefined, renderer: RendererCore);
@@ -7054,7 +7091,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/paths' {
                 * // Add a red path to the map
                 * map.Paths.add(coordinate,  { color: '#ff0000' });
                 */
-            add(coordinate: Coordinate[], options?: TAddPathOptions): Promise<Path>;
+            add(coordinate: Coordinate[], options?: TAddPathOptions): Path;
             /**
                 * Removes a specific path ({@link Path}) from the map.
                 * @param path The path to be removed.
@@ -7142,9 +7179,9 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/directions' {
             /**
                 * @hidden
                 */
-            constructor({ nodes, obstructions, connections, groupBy, }: {
+            constructor({ nodes, geojsonCollection, connections, groupBy, }: {
                     nodes: ParsedMVF['node.geojson'];
-                    obstructions: ParsedMVF['obstruction'];
+                    geojsonCollection: ParsedMVF['obstruction'] | ParsedMVF['space'];
                     connections: ParsedMVF['connection.json'];
                     groupBy?: string;
             });
@@ -8075,8 +8112,8 @@ declare module '@mappedin/mappedin-js/geojson/src/entities' {
 declare module '@mappedin/mappedin-js/geojson/src/types/options' {
     import type { Position } from '@mappedin/mappedin-js/geojson/src/types/geometry';
     import type { Map as MapLibreMap } from '@mappedin/mappedin-js/packages/outdoor-context-v4';
-    import type { WatermarkOptions } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
     import type { AttributionControlOptions } from '@mappedin/mappedin-js/geojson/src/systems/html-controls/system';
+    import type { WatermarkOptions } from '@mappedin/mappedin-js/geojson/src';
     export type RendererCoreOptions = Partial<{
         center?: Position;
         zoomLevel?: number;
@@ -8208,7 +8245,7 @@ declare module '@mappedin/mappedin-js/geojson/src/systems/collisions/system' {
     import { PubSub } from '@mappedin/mappedin-js/packages/common/pubsub';
     import type { RendererState } from '@mappedin/mappedin-js/geojson/src/renderer';
     import type { TSerializedCollider, TSerializedColliderResponse } from '@mappedin/mappedin-js/geojson/src/systems/collisions/collider-processor';
-    import { WatermarkPosition } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
+    import type { WatermarkPosition } from '@mappedin/mappedin-js/geojson/src/systems/watermark/system';
     export type TMessageEvent = MessageEvent<{
         msgId: string;
         colliders: TSerializedColliderResponse[];
@@ -8941,6 +8978,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/utils' {
     import type { TDoorsState, TMarkerState, TWallsState } from '@mappedin/mappedin-js/mappedin-js/src/types';
     import type { Image } from '@mappedin/mappedin-js/mappedin-js/src/map-view-objects';
     import type { GeoJsonApi } from '@mappedin/mappedin-js/mappedin-js/src/api-geojson/api';
+    import type TWEEN from '@tweenjs/tween.js';
     export function convertCoordinateToPosition(coord: Coordinate): Position;
     export function convertPositionToCoordinate(coord: Position): Coordinate;
     export const cutEntrancesFromLineStrings: (lineStrings: ObstructionCollection["features"], entranceCollection: EntranceCollection["features"]) => {
@@ -8968,6 +9006,7 @@ declare module '@mappedin/mappedin-js/mappedin-js/src/api-geojson/utils' {
     export function groupGeometryByStyle(features: Feature<LineString | Polygon | Point, SpaceProperties | ObstructionProperties>[], styleMap: AggregatedStyleMap): Map<WithId<PolygonStyle> | WithId<LineStringStyle> | WithId<PointStyle>, Feature<Point | LineString | Polygon, WithPolygonImage<SpaceProperties> | WithPolygonImage<ObstructionProperties>>[]>;
     export function translateToCoreStyle(style: PolygonStyle | LineStringStyle, userOptions?: TShow3DMapOptions): PaintStyle | LineStyle;
     export const getTargetID: <T extends Space | MapObject | Label | Marker | Model | Image | string>(target: T, api: GeoJsonApi) => string | undefined;
+    export function tweenToPromise(tween: TWEEN.Tween): Promise<void>;
 }
 
 declare module '@mappedin/mappedin-js/geojson/src/components/style' {
@@ -17658,6 +17697,7 @@ declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/navigator/n
     import type { Position, Feature, MultiPolygon, Polygon } from 'geojson';
     import type { NodeCollection, NodeFeature } from '@mappedin/mappedin-js/packages/geojson-navigator/src/types/node';
     import type { ObstructionCollection } from '@mappedin/mappedin-js/packages/geojson-navigator/src/types/obstruction';
+    import type { SpaceCollection } from '@mappedin/mappedin-js/packages/geojson-navigator/src/types/space';
     import type { DirectionsCollection } from '@mappedin/mappedin-js/packages/geojson-navigator/src/types/directions';
     import type { CoordinateFeature } from '@mappedin/mappedin-js/packages/geojson-navigator/src/types/coordinate';
     /**
@@ -17695,17 +17735,19 @@ declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/navigator/n
                 *
                 * @param {NodeCollection} nodes - Collection of nodes for the navigation graph.
                 * @param {ObstructionCollection} [obstructions] - Optional collection of obstructions that could block paths.
+                * @param {SpaceCollection} [spaces] - Optional collection of spaces that could block paths.
                 * @param {string} [groupBy] - Optional property name to group nodes and paths for differentiated processing.
                 */
-            constructor({ nodes, obstructions, groupBy, }: {
+            constructor({ nodes, geojsonCollection, groupBy, }: {
                     nodes: NodeCollection;
-                    obstructions?: ObstructionCollection;
+                    geojsonCollection?: ObstructionCollection | SpaceCollection;
                     groupBy?: string;
             });
             findNearestNode: (feature: CoordinateFeature) => NodeFeature | null;
             /**
                 * Calculates and returns a set of directions from origin nodes to destination nodes, including detailed properties.
                 *
+                * @param {DirectionsZone[]} zones - special zones for navigation operations.
                 * @param {string[]} originIds - IDs of origin nodes.
                 * @param {string[]} destinationNodeIds - IDs of destination nodes.
                 * @param {string[]} [excludedNodeIds] - IDs of nodes to exclude from pathfinding.
@@ -17786,32 +17828,15 @@ declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/types/node'
 }
 
 declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/types/obstruction' {
-    import type { LineString, FeatureCollection, Polygon, Feature } from 'geojson';
-    /**
-        * Properties specific to obstruction features in a geospatial context.
-        * Includes a mandatory unique identifier and allows for any additional custom properties.
-        */
-    export type ObstructionProperties = {
-            /**
-                * Unique identifier for the obstruction.
-                */
-            id: string;
-            /**
-                * Additional property specific to the navigator based on the 'groupBy' option.
-                * */
-            [name: string]: any;
-    };
+    import type { LineString, Polygon, Feature } from 'geojson';
+    import type { ObstructionProperties, ObstructionCollection } from '@mappedin/mvf';
     /**
-        * A GeoJSON feature collection that groups multiple obstruction features, which can be line strings or polygons.
-        * This is typically used to represent physical barriers or areas where access is restricted.
-        */
-    export type ObstructionCollection = FeatureCollection<LineString | Polygon, ObstructionProperties>;
-    /**
-        * A GeoJSON feature representing an obstruction, which can be either a line string or a polygon.
-        * This type is crucial for mapping and managing areas that impede or restrict movement, such as barriers or restricted zones.
-        *
-        */
+      * A GeoJSON feature representing an obstruction, which can be either a line string or a polygon.
+      * This type is crucial for mapping and managing areas that impede or restrict movement, such as barriers or restricted zones.
+      *
+      */
     export type ObstructionFeature = Feature<LineString | Polygon, ObstructionProperties>;
+    export { ObstructionCollection, ObstructionProperties };
 }
 
 declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/types/directions' {
@@ -21446,6 +21471,18 @@ declare module '@mappedin/mappedin-js/packages/outdoor-context-v4/ui/handler/tap
     }
 }
 
+declare module '@mappedin/mappedin-js/packages/geojson-navigator/src/types/space' {
+    import type { LineString, Polygon, Point, Feature } from 'geojson';
+    import type { SpaceProperties, SpaceCollection } from '@mappedin/mvf';
+    /**
+      * A GeoJSON feature representing a space, which can be either a line string or a polygon.
+      * This type is crucial for mapping and managing areas that impede or restrict movement, such as barriers or restricted zones.
+      *
+      */
+    export type SpaceFeature = Feature<LineString | Polygon | Point, SpaceProperties>;
+    export { SpaceCollection, SpaceProperties };
+}
+
 declare module '@mappedin/mappedin-js/geojson/src/systems/camera/helpers/input-set' {
     import type { Vector2 } from 'three';
     class InputSet {

package/lib/esm/index.js

@@ -1 +1 @@
-import{A as y,B as z,C as A,D as B,a,b,d as c,e as d,f as e,g as f,h as g,i as h,j as i,k as j,l as k,m as l,n as m,o as n,p as o,q as p,r as q,s as r,t as s,u as t,v as u,x as v,y as w,z as x}from"./chunk-7P6SMTYY.js";import"./chunk-CBWWQFNR.js";import"./chunk-X4O3T5J7.js";import"./chunk-A6QTJRY4.js";import"./chunk-TKFKQMTK.js";import"./chunk-GLHDHW4V.js";export{n as Annotation,j as Connection,e as Coordinate,t as DOORS,g as Door,a as E_SDK_LOG_LEVEL,q as EnterpriseCategory,p as EnterpriseLocation,r as EnterpriseVenue,i as Floor,o as FloorStack,f as Hyperlink,l as Image,k as MapObject,m as PointOfInterest,h as Space,s as WALLS,z as createMapLibreOverlay,u as enableTestMode,x as getMapData,y as getMapDataEnterprise,v as hydrateMapDataFromMVF,c as parseMVF,b as setLoggerLevel,w as setUseEnterpriseAPI,B as show3dMap,A as show3dMapGeojson,d as unzipMVF};
+import{A as y,B as z,C as A,D as B,a,b,d as c,e as d,f as e,g as f,h as g,i as h,j as i,k as j,l as k,m as l,n as m,o as n,p as o,q as p,r as q,s as r,t as s,u as t,v as u,x as v,y as w,z as x}from"./chunk-G4N5XJZG.js";import"./chunk-NLGPMWPZ.js";import"./chunk-G7WXEQJ3.js";import"./chunk-QKN6JD4F.js";import"./chunk-SQXYZZBW.js";import"./chunk-GZ7LZ5UP.js";export{n as Annotation,j as Connection,e as Coordinate,t as DOORS,g as Door,a as E_SDK_LOG_LEVEL,q as EnterpriseCategory,p as EnterpriseLocation,r as EnterpriseVenue,i as Floor,o as FloorStack,f as Hyperlink,l as Image,k as MapObject,m as PointOfInterest,h as Space,s as WALLS,z as createMapLibreOverlay,u as enableTestMode,x as getMapData,y as getMapDataEnterprise,v as hydrateMapDataFromMVF,c as parseMVF,b as setLoggerLevel,w as setUseEnterpriseAPI,B as show3dMap,A as show3dMapGeojson,d as unzipMVF};