@minmaps-dev/mm-web-sdk 1.0.0-rc.34 → 1.0.0-rc.36

package/dist/react.d.ts

@@ -17,12 +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'` 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' | 'other';
+     *  `'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 */
@@ -36,6 +41,12 @@ interface POI {
     /** For kiosk POIs only: compass heading the device physically faces, in
      *  degrees clockwise from north. Sourced from JACS `Device.heading`. */
     heading?: number | null;
+    /** Per-instance name for this specific placement of an amenity (e.g.
+     *  "Parking Lot A" for a "Parking" amenity), resolved from the waypoint's
+     *  `amenityAssociations`. Distinct from `name`, which is the amenity's
+     *  type-level name shared by every instance — see `Amenity.name`. Amenities
+     *  only, and only set when JACS actually returned an instance name. */
+    instanceName?: string;
 }
 /**
  * Waypoint - a specific point location
@@ -53,8 +64,20 @@ interface Waypoint {
      *  link between a location and its department — read at runtime across the
      *  data provider (see the package CLAUDE.md zone landmine). */
     zoneId?: string | number;
+    /** Per-instance names JACS attaches to this waypoint's amenities (e.g. a
+     *  "Parking" amenity placed twice as "Parking Lot A" / "Parking Lot B").
+     *  `id` matches an `Amenity.id`, not this waypoint — a waypoint can carry
+     *  more than one amenity, so a consumer must find the entry for the
+     *  specific amenity it's rendering rather than assuming index 0. */
+    amenityAssociations?: Array<{
+        id: string | number;
+        name: string;
+    }>;
 }
 
+/** 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
@@ -86,6 +109,11 @@ type AmenityBadgeStyle = {
     ringColor?: string;
     /** Ring width in logical px. Default `2`. */
     ringWidth?: number;
+    /** Extra inset between the icon and the badge's inner edge, in logical px
+     *  (applied on all sides). Default `0` — the icon fills ~85% of the disc
+     *  as before. Raise this if an icon's own artwork reaches close to its
+     *  viewBox edges and ends up touching the ring. */
+    padding?: number;
 };
 interface SDKOptions {
     debug?: boolean;
@@ -123,18 +151,67 @@ 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;
     minIndoorZoom?: number;
     /**
-     * Interior unit-wall thickness in feet (default 1). Each wall is built by
-     * insetting a ring into each unit by `wallThickness / 2`, so adjacent units
-     * share a wall (their rings abut at the common edge). Floored at 0.5 — a
-     * thinner value collapses the negative buffer and drops the wall.
+     * How far, in **metres** (default `0.3`, ≈1 ft), extruded interior polygons
+     * (restrooms, back-of-house, obstacles, connectors) are inset so their edges
+     * don't z-fight the neighbouring room block. A polygon too thin to survive
+     * the inset (it would keep under half its area, e.g. a ~0.3 m back-of-house
+     * perimeter band) is left at its original size rather than erased. Metres to match the theme's
+     * `fill-extrusion-height` values, which MapLibre defines in metres — unlike
+     * the distances shown to visitors, which are in feet. Was feet before this
+     * option changed units; a value of `1` is now ~3.3× thicker.
      */
     wallThickness?: number;
+    /**
+     * How much costlier a candidate on a **different floor** from the kiosk is
+     * treated when choosing the closest instance of an amenity (default `1.5`).
+     * Used by `findClosestByWalkTime`, and so by `navigateFromKioskToClosestAmenity`
+     * and `highlightAmenity`.
+     *
+     * A multiplier on the trip's effort — walk time plus the elevator wait — not
+     * a distance: `1.5` means another floor's instance has to be a third cheaper
+     * to beat one on the kiosk's floor. It is a *preference* for not making the
+     * visitor change floors, layered on top of the physical cost of doing so
+     * (which is already in the effort). `1` turns it off and ranks by effort
+     * alone; a value below `1` is treated as `1`. It only affects which instance
+     * is chosen — never a route.
+     *
+     * For scale: at the Las Vegas VA the nearest other-floor Lactation Pod costs
+     * ~400 ft-equivalent against ~530 for the one on the kiosk's floor, so it
+     * takes a value above ~1.32 to keep the visitor on their floor.
+     */
+    otherFloorPenalty?: 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. The default box is never smaller than
+     * ~3.7 km a side, so a small venue isn't forced to zoom in tighter than a
+     * large one. 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.
@@ -155,6 +232,16 @@ interface SDKOptions {
      * massing/region. `0` locks zoom-out exactly to the opening view.
      */
     minZoomBelowInitialFit?: number;
+    /**
+     * Zoom-out floor expressed as ground scale: the most metres one CSS pixel
+     * may span. The SDK converts it to a `minZoom` at the venue's latitude, so
+     * every venue shows the same amount of surrounding map when fully zoomed
+     * out — a plain zoom number doesn't, because Web Mercator shows less ground
+     * per zoom level the further a venue is from the equator. Takes precedence
+     * over `minZoomBelowInitialFit`. For scale, `1.207` is zoom 15.8 at Orlando
+     * (about 2.3 km x 1.3 km on a 1920x1080 screen).
+     */
+    minZoomMetersPerPixel?: number;
     /**
      * Override the colour the SDK recolours every amenity SVG to before it
      * composites the badge. `none` / `transparent` fills are preserved so
@@ -185,6 +272,21 @@ interface SDKOptions {
      * unless this is set explicitly.
      */
     connectorBadge?: AmenityBadgeStyle | false;
+    /**
+     * 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).
+     */
+    informationIconColor?: string;
     styleMode?: 'venueStyleUrl' | 'sdkTemplate';
     templateOverrideMode?: 'colorsOnly' | 'colorsAndConstants' | 'all';
 }