@mappedin/events 6.8.0-beta.0 → 6.9.0-beta.0

package/lib/esm/index.d.ts

@@ -1,6 +1,101 @@
-import { AnnotationCollection, AnnotationSymbol, AreaCollection, AreaId, Category as MVFCategory, CategoryId, Connection as MVFConnection, Details, EnterpriseCategory as MVFEnterpriseCategory, EnterpriseCategory as MvfEnterpriseCategory, EnterpriseCategoryId as MVFEnterpriseCategoryId, EnterpriseLocation as MVFEnterpriseLocation, EnterpriseLocation as MvfEnterpriseLocation, EnterpriseLocationId as MVFEnterpriseLocationId, EnterpriseLocationInstance, EnterpriseVenue as MVFEnterpriseVenue, EnterpriseVenueType, EntranceCollection, EntranceFeature, Facade as MVFFacade, Feature, Feature as MVFFeature, FeatureCollection, FloorCollection, FloorProperties as MVFFloor, FloorProperties as MvfFloor, FloorStack as MVFFloorStack, FloorStack as MvfFloorStack, Geometry, Hyperlink as MVFHyperlink, Image as MVFImage, Language, LineStringStyle as TMVFLineStringStyle, Location as MVF2Location, LocationId, LocationLink, LocationSocial, LocationState, MultiPolygon, NavigationFlagDeclarations, NodeCollection, NodeCollection as MVFNodeCollection, NodeId, ObstructionCollection, ObstructionFeature, ObstructionId, ObstructionProperties, OpeningHoursSpecification, OperationHours, ParsedMVF, ParsedMVF as TMVF, ParsedMVFLocalePack, ParsedMVFv3, Point, PointStyle as TMVFPointStyle, Polygon, PolygonStyle as TMVFPolygonStyle, SiblingGroup, SpaceCollection, SpaceFeature, SpaceId, SpaceProperties, Style as TMVFStyle, StyleCollection as TMVFStyleCollection, TilesetStyle } from '@mappedin/mvf-v2';
+import { AnnotationCollection, AnnotationSymbol, AreaCollection, AreaId, Category as MVFCategory, CategoryId, Connection as MVFConnection, Details, EnterpriseCategory as MVFEnterpriseCategory, EnterpriseCategory as MvfEnterpriseCategory, EnterpriseCategoryId as MVFEnterpriseCategoryId, EnterpriseLocation as MVFEnterpriseLocation, EnterpriseLocation as MvfEnterpriseLocation, EnterpriseLocationId as MVFEnterpriseLocationId, EnterpriseLocationInstance, EnterpriseVenue as MVFEnterpriseVenue, EnterpriseVenueType, EntranceCollection, EntranceFeature, Facade as MVFFacade, Feature, Feature as MVFFeature, FeatureCollection, FloorCollection, FloorProperties as MVFFloor, FloorProperties as MvfFloor, FloorStack as MVFFloorStack, FloorStack as MvfFloorStack, Geometry, Hyperlink as MVFHyperlink, Image as MVFImage, Language, LineStringStyle as TMVFLineStringStyle, Location as MVF2Location, LocationId, LocationLink, LocationSocial, LocationState, MVFv2_STANDARD_MVFv3, MultiPolygon, NavigationFlagDeclarations, NodeCollection, NodeCollection as MVFNodeCollection, NodeId, ObstructionCollection, ObstructionFeature, ObstructionId, ObstructionProperties, OpeningHoursSpecification, OperationHours, ParsedMVF, ParsedMVF as TMVF, ParsedMVFLocalePack, Point, PointStyle as TMVFPointStyle, Polygon, PolygonStyle as TMVFPolygonStyle, SiblingGroup, SpaceCollection, SpaceFeature, SpaceId, SpaceProperties, Style as TMVFStyle, StyleCollection as TMVFStyleCollection, TilesetStyle } from '@mappedin/mvf-v2';
 import { ParsedMVF } from '@mappedin/mvf-v2/no-validator';
 
+interface DebouncedFunction<T extends (...args: any[]) => void> {
+	(...args: Parameters<T>): void;
+	/**
+	 * Cancels any pending debounced execution
+	 */
+	cancel: () => void;
+}
+declare class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EVENT_PAYLOAD> {
+	/**
+	 * @private
+	 * @internal
+	 */
+	private _subscribers;
+	/**
+	 * @private
+	 * @internal
+	 * AbortController for managing lifecycle and cleanup
+	 */
+	private _abortController;
+	/**
+	 * @protected
+	 * @internal
+	 * Tracks all cleanup functions for subscriptions made via on()
+	 */
+	protected _cleanupFunctions: Array<() => void>;
+	/**
+	 * Returns the AbortSignal for this PubSub instance.
+	 * Use this signal with APIs that support cancellation (fetch, addEventListener, etc.)
+	 * When the PubSub is destroyed, the signal will be aborted and all listeners using it will be automatically removed.
+	 *
+	 * @example
+	 * ```typescript
+	 * // Automatically cleaned up when PubSub is destroyed
+	 * pubsub.addEventListener(window, 'resize', handler, { signal: pubsub.signal });
+	 * ```
+	 */
+	get signal(): AbortSignal;
+	/**
+	 * @private
+	 * @internal
+	 */
+	publish<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, data?: EVENT_PAYLOAD[EVENT_NAME]): void;
+	/**
+	 * Subscribe a function to be called when the signal is aborted.
+	 * @param fn The function to call when the signal is aborted.
+	 */
+	onAbort<T extends (...args: any[]) => void>(fn: T): 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.
+	 * @param options Optional options object. If a signal is provided, the subscription will be
+	 * automatically cleaned up when that signal is aborted.
+	 * @returns A cleanup function that unsubscribes the event listener when called.
+	 * @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, options?: {
+		signal?: AbortSignal;
+	}): () => 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] extends {
+		data: null;
+	} ? EVENT_PAYLOAD[EVENT_NAME]["data"] : EVENT_PAYLOAD[EVENT_NAME]) => void): void;
+	/**
+	 * @private
+	 * @internal
+	 * Destroys the PubSub instance and automatically unsubscribes all listeners registered via on().
+	 */
+	destroy(): void;
+}
 declare const VALID_CONTEXTS: readonly [
 	"websdk",
 	"web",
@@ -71,7 +166,7 @@ declare class AnalyticsInternal {
 	/**
 	 * @internal
 	 */
-	sendGetDirectionsEvent: (start: string, end: string, accessible?: boolean | undefined) => void;
+	sendGetDirectionsEvent: DebouncedFunction<(start: string, end: string, accessible?: boolean) => void | Promise<Response> | Promise<void>>;
 	sendBlueDotEvents(event: BlueDotEvents): void | Promise<Response> | Promise<void>;
 }
 type UpdateStateParam = Partial<Pick<AnalyticState, "geolocationMode" | "context" | "logEvents" | "userPosition" | "mapId" | "sendEvents" | "logEvents" | "accessToken" | "sessionId" | "deviceId">>;
@@ -3909,94 +4004,6 @@ declare function bigint$2<T = unknown>(params?: string | core.$ZodBigIntParams):
 interface ZodCoercedDate<T = unknown> extends schemas$1._ZodDate<core.$ZodDateInternals<T>> {
 }
 declare function date$3<T = unknown>(params?: string | core.$ZodDateParams): ZodCoercedDate<T>;
-declare class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EVENT_PAYLOAD> {
-	/**
-	 * @private
-	 * @internal
-	 */
-	private _subscribers;
-	/**
-	 * @private
-	 * @internal
-	 * AbortController for managing lifecycle and cleanup
-	 */
-	private _abortController;
-	/**
-	 * @protected
-	 * @internal
-	 * Tracks all cleanup functions for subscriptions made via on()
-	 */
-	protected _cleanupFunctions: Array<() => void>;
-	/**
-	 * Returns the AbortSignal for this PubSub instance.
-	 * Use this signal with APIs that support cancellation (fetch, addEventListener, etc.)
-	 * When the PubSub is destroyed, the signal will be aborted and all listeners using it will be automatically removed.
-	 *
-	 * @example
-	 * ```typescript
-	 * // Automatically cleaned up when PubSub is destroyed
-	 * pubsub.addEventListener(window, 'resize', handler, { signal: pubsub.signal });
-	 * ```
-	 */
-	get signal(): AbortSignal;
-	/**
-	 * @private
-	 * @internal
-	 */
-	publish<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, data?: EVENT_PAYLOAD[EVENT_NAME]): void;
-	/**
-	 * Subscribe a function to be called when the signal is aborted.
-	 * @param fn The function to call when the signal is aborted.
-	 */
-	onAbort<T extends (...args: any[]) => void>(fn: T): 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.
-	 * @param options Optional options object. If a signal is provided, the subscription will be
-	 * automatically cleaned up when that signal is aborted.
-	 * @returns A cleanup function that unsubscribes the event listener when called.
-	 * @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, options?: {
-		signal?: AbortSignal;
-	}): () => 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] extends {
-		data: null;
-	} ? EVENT_PAYLOAD[EVENT_NAME]["data"] : EVENT_PAYLOAD[EVENT_NAME]) => void): void;
-	/**
-	 * @private
-	 * @internal
-	 * Destroys the PubSub instance and automatically unsubscribes all listeners registered via on().
-	 */
-	destroy(): void;
-}
 type Primitive$1 = null | undefined | string | number | boolean | symbol | bigint;
 type NodeNeighbor = {
 	id: string;
@@ -4690,7 +4697,7 @@ declare class ImageMetaData extends BaseMetaData {
 	 */
 	destroy(): void;
 }
-type MVF3Location = Required<ParsedMVFv3>["locations"][number];
+type MVF3Location = Required<MVFv2_STANDARD_MVFv3>["locations"][number];
 type LocationData = Omit<MVF2Location, "categories" | "spaces" | "obstructions" | "entrances" | "shapes" | "connections" | "annotations" | "areas" | "openingHoursSpecification" | "links" | "pictures" | "website" | "icon"> & {
 	links: Hyperlink[];
 	images: ImageMetaData[];
@@ -4721,8 +4728,13 @@ declare class LocationProfile extends BaseMetaData implements LocationData, IFoc
 	 * The location's logo
 	 *
 	 * @format uri
+	 * @deprecated Use the {@link logoImage} property instead
 	 */
 	logo?: string;
+	/**
+	 * An image representing the location's logo
+	 */
+	logoImage?: ImageMetaData;
 	phone?: string;
 	/**
 	 * The location's social media links.
@@ -5094,7 +5106,16 @@ declare class Space extends DetailedMapData<SpaceFeature> implements IGeoJSONDat
 	 */
 	get type(): TSpaceType;
 	/**
-	 * @internal
+	 * Gets the {@link EnterpriseLocation}s attached to this space.
+	 *
+	 * @returns {EnterpriseLocation[]} An array of enterprise locations.
+	 */
+	get enterpriseLocations(): EnterpriseLocation[];
+	/**
+	 * Gets the {@link EnterpriseLocation}s attached to this space.
+	 *
+	 * @deprecated Use {@link enterpriseLocations} instead. This property will be removed in a future release.
+	 * @returns {EnterpriseLocation[]} An array of enterprise locations.
 	 */
 	get locations(): EnterpriseLocation[];
 	/**
@@ -5445,7 +5466,16 @@ declare class MapObject extends DetailedMapData<ObstructionFeature> implements I
 	 */
 	get type(): string;
 	/**
-	 * @internal
+	 * Gets the {@link EnterpriseLocation}s attached to this object.
+	 *
+	 * @returns {EnterpriseLocation[]} An array of enterprise locations.
+	 */
+	get enterpriseLocations(): EnterpriseLocation[];
+	/**
+	 * Gets the {@link EnterpriseLocation}s attached to this object.
+	 *
+	 * @deprecated Use {@link enterpriseLocations} instead. This property will be removed in a future release.
+	 * @returns {EnterpriseLocation[]} An array of enterprise locations.
 	 */
 	get locations(): EnterpriseLocation[];
 	/**
@@ -5611,7 +5641,7 @@ type TMapDataInternalOptions = {
 	binaryBundle?: Uint8Array;
 	tokenManager?: TokenManager;
 	getMapDataOptions?: TGetMapDataOptions;
-	mvf3?: ParsedMVFv3;
+	mvf3?: MVFv2_STANDARD_MVFv3;
 };
 type MVFNodeFeature = MVFNodeCollection["features"][number];
 type MVFFloorFeature = FloorCollection["features"][number];
@@ -6039,16 +6069,20 @@ type MapDataRecords = {
 		[floorId: string]: AnnotationCollection["features"][number][];
 	};
 	mvfAreasById: Record<AreaId, AreaCollection["features"][number]>;
-	mvf3LocationsById: Record<string, Required<ParsedMVFv3>["locations"][number]>;
+	mvf3LocationsById: Record<string, Required<MVFv2_STANDARD_MVFv3>["locations"][number]>;
 };
 type EnterpriseMapDataRecords = {
 	connectionsByExternalId: Record<string, Connection[]>;
 	locationsByExternalId: Record<string, EnterpriseLocation[]>;
 	categoriesByExternalId: Record<string, EnterpriseCategory[]>;
 	locationsById: Record<MVFEnterpriseLocationId, EnterpriseLocation>;
+	/** Instance locations by ID - separate from locationsById so they don't appear in getByType */
+	locationInstancesById: Record<string, EnterpriseLocation>;
+	/** Instance locations by polygon ID - for space.enterpriseLocations to check instances first */
+	instanceLocationsByPolygonId: Record<string, EnterpriseLocation>;
 	categoriesById: Record<MVFEnterpriseCategoryId, EnterpriseCategory>;
 	locationIdsByNodeId: Record<string, MVFEnterpriseLocationId[]>;
-	locationInstancesById: Record<string, EnterpriseLocationInstance>;
+	mvfLocationInstancesById: Record<string, EnterpriseLocationInstance>;
 	venue: MVFEnterpriseVenue;
 	mvfCategoriesById: Record<string, MVFEnterpriseCategory>;
 	mvfLocationsById: Record<string, MVFEnterpriseLocation>;
@@ -6624,6 +6658,8 @@ declare class MapDataInternal extends PubSub<{
 	locationProfilesByAttachedFeatureId: MapDataRecords["locationProfilesByAttachedFeatureId"];
 	entranceNodeIdsBySpaceId?: MapDataRecords["entranceNodeIdsBySpaceId"];
 	locationsById: EnterpriseMapDataRecords["locationsById"];
+	locationInstancesById: EnterpriseMapDataRecords["locationInstancesById"];
+	instanceLocationsByPolygonId: EnterpriseMapDataRecords["instanceLocationsByPolygonId"];
 	categoriesById: EnterpriseMapDataRecords["categoriesById"];
 	mvfLocationsByGeometryId: EnterpriseMapDataRecords["mvfLocationsByGeometryId"];
 	locationIdsByNodeId: EnterpriseMapDataRecords["locationIdsByNodeId"];