@minmaps-dev/mm-web-sdk 1.0.0-rc.23 → 1.0.0-rc.25

package/dist/index.d.ts

@@ -115,6 +115,20 @@ interface Destination {
     category?: string;
     /** Additional properties */
     properties?: Record<string, unknown>;
+    /** Uploaded image (e.g. brand/store logo). JACS `/all` fullcall serves this
+     *  as `{ items: [{ resourceType, mimeType, path }] }`; the legacy/basic shape
+     *  is `[{ locales: [{ uriPath }] }]`. `DestinationIcons.register` handles both. */
+    uris?: unknown;
+    /** Free-form CMS metadata (reserved for future destination icon options). */
+    extensors?: Record<string, unknown>;
+    /** Map-manager "Label Display" mode (JACS `displayMode`):
+     *  `0` Hidden (dot only) · `1` Label (dot + text) · `2` Image (uploaded logo).
+     *  Undefined → treated as Label (backwards-compatible default). */
+    displayMode?: number;
+    /** Runtime-assigned map-image id, decorated in place by
+     *  `DestinationIcons.register` (only for `displayMode === 2`).
+     *  Read by the POI builder + theme layer. */
+    iconId?: string;
 }
 /**
  * Waypoint - a specific point location
@@ -300,6 +314,14 @@ type AmenityBadgeStyle = {
     /** Ring width in logical px. Default `2`. */
     ringWidth?: number;
 };
+type DestinationChipStyle = {
+    /** Chip fill colour. Default `'#FFFFFF'`. */
+    color?: string;
+    /** Chip border colour. Default navy `'#162e51'`. */
+    borderColor?: string;
+    /** Chip border width in logical px. Default `2`. */
+    borderWidth?: number;
+};
 interface SDKOptions {
     debug?: boolean;
     /**
@@ -361,6 +383,14 @@ interface SDKOptions {
      * the icon hiding while the disc stays painted.
      */
     amenityBadge?: AmenityBadgeStyle | false;
+    /**
+     * Chip composited behind each destination's uploaded logo. Destinations are
+     * full-colour brand images (not recoloured), so they get a neutral white
+     * rounded chip for legibility instead of the amenity gold badge. Pass `false`
+     * to render the logo bare, or an object to tune the chip fill / border.
+     * Defaults to a white chip with a 2px navy border.
+     */
+    destinationChip?: DestinationChipStyle | false;
     styleMode?: 'venueStyleUrl' | 'sdkTemplate';
     templateOverrideMode?: 'colorsOnly' | 'colorsAndConstants' | 'all';
 }
@@ -571,6 +601,17 @@ declare class MinuteMaps {
      * cone rendered next to the "You are here" marker.
      */
     getKioskHeading(): number | null;
+    /**
+     * Display name of the JACS device the kiosk is anchored to (e.g.
+     * "Main Lobby Kiosk", "Information Desk Kiosk"). `null` when the venue
+     * has no kiosk anchor or the device record carries no `name`.
+     *
+     * Distinct from `getYouAreHerePOI()?.name`, which is always the
+     * literal "You are here" label rendered on the map. Use this for chrome
+     * that needs the kiosk's identity — e.g. the directions overlay's
+     * "From <kiosk>" header.
+     */
+    getKioskName(): string | null;
     /**
      * Distance + walking time from the kiosk's anchor waypoint to a target,
      * computed over the JACS path graph (the same graph the routing engine
@@ -702,6 +743,28 @@ declare class MinuteMaps {
      * single-venue scale, and avoids a turf dependency on the hot path.
      */
     findClosestWaypoint(waypoints: Waypoint[], from?: [number, number]): Waypoint | null;
+    /**
+     * Route from the kiosk to the closest physical instance of an amenity.
+     * Resolves the amenity venue-wide, picks the instance with the smallest
+     * path-graph walk time from the kiosk (falling back to planar Euclidean
+     * when the walk-time graph can't resolve any waypoint), switches the
+     * active floor if needed, and routes via the same plumbing as
+     * `navigateFromKioskToPOI` — so step-by-step directions, the
+     * `routeReady` event, and the active-floor camera fit all "just work."
+     *
+     * Pass `accessible` / `avoidStairs` to weight the *route* (the SDK's
+     * routing engine reads these per call). Note: closest-instance picking
+     * itself is currently distance-based and does not yet honor those
+     * weights — the underlying walk-time graph applies pixel-length only.
+     * In practice this matters when an amenity has multiple instances and
+     * the geometrically closest is reachable only via stairs; the picked
+     * instance won't change today, but the *route* to it will avoid stairs
+     * (or fail gracefully) if `accessible`/`avoidStairs` is set.
+     */
+    navigateFromKioskToClosestAmenity(amenityId: string | number, options?: {
+        accessible?: boolean;
+        avoidStairs?: boolean;
+    }): Promise<any>;
     /**
      * Highlight + center on the closest physical instance of an amenity.
      * The amenity is resolved against `amenities.getDistinct()` (venue-wide,
@@ -767,4 +830,4 @@ declare class MinuteMaps {
 declare function createMinuteMapsSDK(config: SDKConfig): MinuteMaps;
 
 export { MinuteMaps, createMinuteMapsSDK };
-export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, Destination, EventCallback, Floor, FloorMetadata, JMapAuth, JMapConfig, JacsAuth, JacsConfig, MapEvent, POI, POISearchResult, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, ThemeName, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint };
+export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, Destination, DestinationChipStyle, EventCallback, Floor, FloorMetadata, JMapAuth, JMapConfig, JacsAuth, JacsConfig, MapEvent, POI, POISearchResult, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, ThemeName, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint };