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

package/dist/react.d.ts

@@ -1,14 +1,137 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+/**
+ * Padding kept clear inside the viewport when the SDK frames bounds —
+ * the initial venue/floor fit and the wayfinding route fit. A plain
+ * number pads all sides equally; the object form lets a kiosk reserve
+ * space for fixed UI overlays (header, dock, side rails) so framed
+ * content is never hidden behind them.
+ */
+type BoundsPadding = number | {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+/**
+ * Built-in theme names accepted by `MinuteMaps.setTheme()` and the
+ * `options.theme` init option. Pass a `StyleSpecification` directly for
+ * custom themes.
+ */
+type ThemeName = 'default' | 'high-contrast';
+/**
+ * Style of the disc + ring rendered behind each amenity icon. The SDK
+ * composites this into the icon bitmap at registration time, so badge +
+ * icon participate in symbol collision as one unit.
+ */
+type AmenityBadgeStyle = {
+    /** Fill colour of the badge disc. Default `'#fdb81e'`. */
+    color?: string;
+    /** Stroke colour of the ring around the disc. Default `'#FFFFFF'`. */
+    ringColor?: string;
+    /** 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;
-    theme?: 'light' | 'dark' | 'hybrid' | any;
+    /**
+     * Initial theme. `'default'` uses the bundled hybrid 3D theme.
+     * `'high-contrast'` uses the WCAG-AA tuned theme. Pass a
+     * `StyleSpecification` for fully custom styling.
+     */
+    theme?: ThemeName | any;
+    /**
+     * When true, the SDK skips animations on imperative camera calls
+     * (wayfinding fits, `setView`, idle re-frames). Consumers should
+     * 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;
     minIndoorZoom?: number;
     wallThickness?: number;
-    boundsPadding?: number;
+    boundsPadding?: BoundsPadding;
+    /**
+     * Pitch (deg) for the opening view, applied centred on the kiosk ("You
+     * are here"). Omit for top-down.
+     */
+    initialPitch?: number;
+    /**
+     * Zoom for the opening view, centred on the kiosk. Set this above the
+     * theme's unit-walls breakpoint (~16.5 in the bundled hybrid theme) so the
+     * kiosk opens on the building's interior floor plan (its contents) rather
+     * than a zoomed-out 3D massing outline. Omit to keep the post-floor-fit
+     * zoom.
+     */
+    initialZoom?: number;
+    /**
+     * Clamp zoom-out relative to the opening view. When set, the map's
+     * `minZoom` becomes `(initialZoom − this)`, so visitors can nudge out by
+     * this many zoom levels but never pull back below the interior into the
+     * massing/region. `0` locks zoom-out exactly to the opening view.
+     */
+    minZoomBelowInitialFit?: number;
+    /**
+     * Override the colour the SDK recolours every amenity SVG to before it
+     * composites the badge. `none` / `transparent` fills are preserved so
+     * cut-outs stay. When the badge is enabled (the default), this defaults
+     * to navy (`#162e51`) so icons read on gold. Set explicitly for a
+     * different look, or set `amenityBadge: false` to disable recolouring
+     * altogether and keep the CMS-uploaded colours.
+     */
+    amenityIconColor?: string;
+    /**
+     * Badge composited behind each amenity icon. Pass `false` to render the
+     * icon alone (no badge — useful for high-contrast or 2D themes where the
+     * gold disc would compete with the floor). Pass an object to tune the
+     * disc / ring style. Defaults to a VA-gold disc with a 2px white ring.
+     *
+     * The badge is baked into the icon bitmap (canvas composite) rather than
+     * drawn as a separate circle layer, so badge + icon participate in symbol
+     * collision together — overlapping amenities hide as one unit instead of
+     * the icon hiding while the disc stays painted.
+     */
+    amenityBadge?: AmenityBadgeStyle | false;
+    /**
+     * Badge for vertical-circulation connectors (elevator / stairs / escalator).
+     * These render as their own visual class — a navy disc with a white glyph —
+     * so circulation 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`, connectors are badge-less too
+     * unless this is set explicitly.
+     */
+    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.
+     */
+    destinationChip?: DestinationChipStyle | false;
     styleMode?: 'venueStyleUrl' | 'sdkTemplate';
     templateOverrideMode?: 'colorsOnly' | 'colorsAndConstants' | 'all';
 }
@@ -24,6 +147,13 @@ type SDKConfig = {
         venueId: number;
         locale?: string;
         auth?: JMapAuth;
+        /**
+         * Identifies which physical kiosk this instance is, so the SDK can pin
+         * the "You are here" marker. Matched against either the numeric device
+         * `id` or the device `uuid` from the venue's `devices`. The device's
+         * attached waypoint (`waypoint.deviceIds`) is the kiosk's location.
+         */
+        deviceId?: string | number;
     };
     jacs: {
         mode: 'proxy' | 'direct';