@minmaps-dev/mm-web-sdk 1.0.0-rc.33 → 1.0.0-rc.35

package/dist/react.d.ts

@@ -17,6 +17,17 @@ interface POI {
     floorId: string | number;
     /** Category/type of amenity (e.g., 'restroom', 'elevator') */
     amenityType?: string;
+    /** Locale-stable classification text (name + type + keywords, frozen at
+     *  load before any locale patch can translate them). Copied from the
+     *  source `Amenity.classifyText`; used by `amenityCategoryFor`/rank
+     *  instead of the live, possibly-translated fields. See `Amenity.classifyText`. */
+    classifyText?: string;
+    /** Which amenity icon layer this POI renders in — `'connector'`,
+     *  `'entrance'`, `'parking'`, `'bus'`, `'information'` or `'other'`.
+     *  Derived from the amenity's connector flag, name, type and keywords;
+     *  emitted as the `amenityCategory` feature property the theme filters on.
+     *  Amenities only. See `amenityCategoryFor`. */
+    amenityCategory?: 'connector' | 'entrance' | 'parking' | 'bus' | 'information' | 'other';
     /** Search keywords */
     keywords?: string[];
     /** Additional properties */
@@ -49,6 +60,9 @@ interface Waypoint {
     zoneId?: string | number;
 }
 
+/** SW/NE bounding box */
+type Bounds = [[number, number], [number, number]];
+
 /**
  * Padding kept clear inside the viewport when the SDK frames bounds —
  * the initial venue/floor fit and the wayfinding route fit. A plain
@@ -81,16 +95,16 @@ 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;
+    /**
+     * `window` key the SDK instance is published under while `debug` is on, so
+     * a running kiosk can be driven from devtools (`mm.debug.hide('labels')`,
+     * `mm.getMap()`). Defaults to `'mm'`. Pass another name to avoid a clash,
+     * or `false` to publish nothing even in debug mode. Ignored entirely when
+     * `debug` is off.
+     */
+    debugGlobal?: string | false;
     /**
      * Initial theme. `'default'` uses the bundled hybrid 3D theme.
      * `'high-contrast'` uses the WCAG-AA tuned theme. Pass a
@@ -117,6 +131,20 @@ interface SDKOptions {
      * controls the automatic highlight on `routeReady`.
      */
     routeStepHighlight?: boolean;
+    /**
+     * Whether restroom pins that are too close together to draw individually
+     * collapse into a single Material `wc` badge. Defaults to `true`.
+     *
+     * Venues author men's and women's restrooms as two amenities a few metres
+     * apart. Both are wayfinding-critical (rank 0) and both draw on a layer that
+     * doesn't allow icon overlap, so without this MapLibre resolves the collision
+     * by hiding one of them outright until the camera is very close in. Grouping
+     * shows one badge in their place and hands back *all* the members when it's
+     * tapped, so the consumer can offer directions to each.
+     *
+     * Set `false` to opt out and get the raw collision behaviour back.
+     */
+    groupRestroomIcons?: boolean;
     initialFloor?: string | number;
     enableInteractions?: boolean;
     customSprite?: string;
@@ -129,6 +157,16 @@ interface SDKOptions {
      */
     wallThickness?: number;
     boundsPadding?: BoundsPadding;
+    /**
+     * Caps how far a visitor can pan/zoom out. By default the SDK derives this
+     * from the venue's own bounds, scaled to 3x its width/height around the
+     * same center — enough room to pan around the building without drifting
+     * into an empty, un-tiled region. Pass a number to use a different
+     * multiplier (e.g. `1.5` for a tighter leash), explicit `[[west, south],
+     * [east, north]]` bounds to override entirely, or `false` to disable
+     * max-bounds clamping.
+     */
+    maxBounds?: Bounds | number | false;
     /**
      * Pitch (deg) for the opening view, applied centred on the kiosk ("You
      * are here"). Omit for top-down.
@@ -180,13 +218,20 @@ interface SDKOptions {
      */
     connectorBadge?: 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.
+     * Badge for information-desk amenities (curated `information`/`info`
+     * icon). These render as their own visual class — a green disc with a
+     * white glyph by default — so information reads distinct from the gold
+     * service amenities. Pass `false` to fall them back into the regular gold
+     * badge, or an object to tune the disc / ring. When `amenityBadge` is
+     * `false`, information icons are badge-less too unless this is set
+     * explicitly.
+     */
+    informationBadge?: AmenityBadgeStyle | false;
+    /**
+     * Glyph colour for information icons on their badge. Default white
+     * (matches `informationBadge`'s default green disc).
      */
-    destinationChip?: DestinationChipStyle | false;
+    informationIconColor?: string;
     styleMode?: 'venueStyleUrl' | 'sdkTemplate';
     templateOverrideMode?: 'colorsOnly' | 'colorsAndConstants' | 'all';
 }