@minmaps-dev/mm-web-sdk 1.0.0-rc.29 → 1.0.0-rc.30

package/dist/index.d.ts

@@ -225,7 +225,7 @@ type RoutePoint = {
     isEndpoint?: boolean;
 };
 
-type WayfindStep = DepartStep | TurnStep | ContinueStep | TransitionStep | ArriveStep;
+type WayfindStep = DepartStep | TurnStep | ContinueStep | TransitionStep$1 | ArriveStep;
 type StepBase = {
     /** Indices into the input `points` array that this step spans. */
     pointRange: [startInclusive: number, endInclusive: number];
@@ -247,7 +247,7 @@ type TurnStep = StepBase & {
 type ContinueStep = StepBase & {
     type: 'continue';
 };
-type TransitionStep = StepBase & {
+type TransitionStep$1 = StepBase & {
     type: 'transition';
     transition: 'elevator' | 'stairs' | 'escalator';
     fromFloorId: number | null;
@@ -336,6 +336,20 @@ interface SDKOptions {
      * mirror their app's `prefers-reduced-motion` state into this.
      */
     reducedMotion?: boolean;
+    /**
+     * Whether a freshly computed route auto-highlights its first step's
+     * segment (the brighter `route-line-active` overlay). Defaults to
+     * `true`, preserving the turn-by-turn segment highlight that
+     * `setActiveStep` drives.
+     *
+     * Set `false` for kiosk-style "show the whole route at once" UIs:
+     * the entire route line is shown without singling out one segment,
+     * which reads more clearly at a glance and avoids implying the visitor
+     * must step through the route. `setActiveStep` still works when called
+     * explicitly (e.g. a paginated QR-handoff / mobile flow) — this only
+     * controls the automatic highlight on `routeReady`.
+     */
+    routeStepHighlight?: boolean;
     initialFloor?: string | number;
     enableInteractions?: boolean;
     customSprite?: string;
@@ -543,6 +557,14 @@ declare class MinuteMaps {
         animate?: boolean;
         duration?: number;
     }): void;
+    /**
+     * Update the bounds padding (camera insets) used by route + floor fits.
+     * Consumers measure their on-screen chrome (panels, rails) and pass the
+     * insets so a fit frames the path in the visible, unobscured area rather
+     * than under the UI. Stored; the next fit / `refit()` uses it (clamped so
+     * a fit always lands — see `clampPadding`).
+     */
+    setBoundsPadding(p: BoundsPadding): void;
     private fitToBounds;
     set3dEnabled(enabled: boolean): void;
     toggle3d(): void;
@@ -841,5 +863,42 @@ declare class MinuteMaps {
 }
 declare function createMinuteMapsSDK(config: SDKConfig): MinuteMaps;
 
-export { MinuteMaps, createMinuteMapsSDK };
-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 };
+type TransitionStep = Extract<WayfindStep, {
+    type: 'transition';
+}>;
+type RouteFloorSection = {
+    /** Floor (JACS `mapId`) this section is on. `null` only for a degenerate
+     *  floorless route (straight-line fallback with no `mapId`). */
+    floorId: number | null;
+    /** This floor's steps, each with its index into the original flat array
+     *  so the consumer can call `setActiveStep` / highlight by index. */
+    steps: Array<{
+        step: WayfindStep;
+        index: number;
+    }>;
+    /** Index of this section's first step in the original array — the target
+     *  for `setActiveStep` when advancing INTO this section. */
+    firstStepIndex: number;
+    /** The transition step that leaves this floor for the next section, if
+     *  any. Absent on the final section. Its `text` ("Take the elevator to
+     *  Basement") makes a good "continue" button label. */
+    exit?: {
+        step: TransitionStep;
+        index: number;
+    };
+};
+/**
+ * Group steps into per-floor sections. Single-floor routes return one
+ * section (so a consumer can keep its whole-route view for that case).
+ */
+declare function groupStepsIntoFloorSections(steps: WayfindStep[]): RouteFloorSection[];
+/**
+ * Which section is "active" given the active step index — the last section
+ * whose `firstStepIndex` is at or before `activeStepIndex`. Returns 0 when
+ * nothing matches (e.g. index points at the leading transition, which
+ * shouldn't happen since routes start with a depart step).
+ */
+declare function activeSectionIndex(sections: RouteFloorSection[], activeStepIndex: number): number;
+
+export { MinuteMaps, activeSectionIndex, createMinuteMapsSDK, groupStepsIntoFloorSections };
+export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, Destination, DestinationChipStyle, EventCallback, Floor, FloorMetadata, JMapAuth, JMapConfig, JacsAuth, JacsConfig, MapEvent, POI, POISearchResult, RouteFloorSection, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, ThemeName, TransitionStep, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint };