@minmaps-dev/mm-web-sdk 1.0.0-rc.42 → 1.0.0-rc.44

package/dist/index.d.ts

@@ -499,6 +499,13 @@ interface SDKOptions {
      * max-bounds clamping.
      */
     maxBounds?: Bounds | number | false;
+    /**
+     * Whether the venue's kiosk anchors a "You are here" marker, and the opening
+     * view / default route origin. Defaults to `true`. Set `false` for non-kiosk
+     * consumers (e.g. a browser map): no device is resolved, even via the
+     * "first placed device" fallback, so the marker is never drawn.
+     */
+    kiosk?: boolean;
     /**
      * Pitch (deg) for the opening view, applied centred on the kiosk ("You
      * are here"). Omit for top-down.
@@ -1633,6 +1640,15 @@ declare class MinuteMaps {
         animate?: boolean;
         duration?: number;
     }): void;
+    /**
+     * Find the POI placed on a given waypoint, searching every floor. A
+     * waypoint is a single placement, so this resolves the exact amenity
+     * instance or destination a kiosk routed to — unlike an amenity id, which
+     * is shared by all of its instances. The kiosk's own "You are here" POI is
+     * skipped. Returns `null` when nothing is placed on that waypoint (stale id,
+     * or a floor whose geometry hasn't loaded).
+     */
+    getPOIByWaypointId(waypointId: string | number): POI | null;
     searchPOIs(query: string, floor?: Floor): POI[];
     /**
      * Search POIs across every floor in the venue. Returns raw matches —
@@ -1659,6 +1675,37 @@ declare class MinuteMaps {
     navigateFromKioskToPOI(poi: POI, options?: {
         avoidStairs?: boolean;
     }): Promise<any>;
+    /**
+     * Route between two arbitrary POIs — the browser/mobile counterpart of
+     * `navigateFromKioskToPOI`, for visitors who aren't standing at a kiosk
+     * and pick their own starting point. Same events (`routeReady` /
+     * `routeFailed`) and the same `centerMode: 'route'` framing. Switches to
+     * the origin's floor first, because the route starts there.
+     *
+     * Emits `routeFailed` with `origin_unavailable` / `destination_unavailable`
+     * when either POI has no waypoint, `no_route` when no path connects them.
+     */
+    navigateBetweenPOIs(from: POI, to: POI, options?: {
+        avoidStairs?: boolean;
+    }): Promise<any>;
+    /**
+     * Distance + walking time between two arbitrary POIs over the path graph —
+     * `getWalkTimeFromKiosk` with a caller-chosen origin. `null` when either POI
+     * has no waypoint on the graph or no path resolves.
+     */
+    getWalkTimeBetween(from: POI, target: Parameters<MinuteMaps['getWalkTimeFromKiosk']>[0], opts?: {
+        walkingSpeedFps?: number;
+        avoidStairs?: boolean;
+    }): {
+        feet: number;
+        seconds: number;
+        effortSeconds: number;
+        pathNodeCount: number;
+    } | null;
+    /** Shared tail of the route entry points: path, camera fit, steps, events.
+     *  `originPoi` is the start a visitor picked (`navigateBetweenPOIs`), which
+     *  gets a start pin; a kiosk route passes none — "You are here" marks it. */
+    private routeToPoi;
     /** Build the landmark / floor-name context the directions module needs.
      *  Pulled out so `setLocale()` or `setActiveStep()` can rebuild it on
      *  demand if we ever surface a locale-aware variant. */
@@ -1697,7 +1744,8 @@ declare class MinuteMaps {
     private clearActiveStepHighlight;
     clearRoute(): void;
     /**
-     * Put the end-of-route marker on `poi`, or take it down (`null`).
+     * Put the end-of-route marker on `poi`, or take it down (`null`). With
+     * `start`, the route's start also gets the sprite's `marker-start` pin.
      *
      * A destination gets a flag in place of its dot; an amenity instance gets an
      * enlarged copy of its own icon (`map/routeEnd.ts`). Both are drawn from a
@@ -2061,6 +2109,253 @@ declare class MinuteMaps {
 }
 declare function createMinuteMapsSDK(config: SDKConfig): MinuteMaps;
 
+type JacsProviderConfig = {
+    mode: 'proxy';
+    proxyBaseUrl?: string;
+    fetchImpl?: typeof fetch;
+} | {
+    mode: 'direct';
+    host: string;
+    clientId: string;
+    username: string;
+    password: string;
+    fetchImpl?: typeof fetch;
+};
+type GetBuildingsArgs = {
+    customerId: number | string;
+    venueId: number | string;
+};
+type GetFloorsArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    buildingId: number | string;
+    /** BCP-47 code (`es`, `en-US`). When set, JACS resolves floor `name` /
+     *  `description` to that locale instead of the customer's default. */
+    locale?: string;
+};
+type GetDestinationsArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    /** See {@link GetFloorsArgs.locale}. */
+    locale?: string;
+};
+type GetAmenitiesArgs = {
+    customerId: number | string;
+    /** See {@link GetFloorsArgs.locale}. */
+    locale?: string;
+};
+type GetZonesArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    /** See {@link GetFloorsArgs.locale}. */
+    locale?: string;
+};
+type GetMapLabelsArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    /** See {@link GetFloorsArgs.locale}. */
+    locale?: string;
+};
+type GetVenueArgs = {
+    customerId: number | string;
+    venueId: number | string;
+};
+type JacsVenue = Record<string, any>;
+type GetBuildingFullArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    buildingId: number | string;
+    mapProfile?: string;
+    geojson?: boolean;
+};
+type JacsBuildingFull = Record<string, any>;
+type JacsVenueAll = Record<string, any>;
+type GetStylesheet3dArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    buildingId: number | string;
+};
+type GetFloorMapGeoJsonArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    buildingId: number | string;
+    floorId: number | string;
+};
+type GetPolygonLayersArgs = {
+    customerId: number | string;
+};
+type GetFloorMapTemplate3dArgs = {
+    customerId: number | string;
+    venueId: number | string;
+    buildingId: number | string;
+    floorId: number | string;
+};
+type JacsBuilding = {
+    id?: number | string;
+    buildingId?: number | string;
+    name?: string;
+    isDefault?: boolean;
+    default?: boolean;
+    [key: string]: any;
+};
+type JacsFloor = Record<string, any>;
+type JacsDestination = Record<string, any>;
+type JacsAmenity = Record<string, any>;
+type JacsZone = Record<string, any>;
+type JacsMapLabel = Record<string, any>;
+type JacsPolygonLayer = Record<string, any>;
+/**
+ * This matches the “map-template/3d” shape you pasted earlier:
+ * rows keyed by layerName with paint-ish properties like fill, line-color, etc.
+ */
+type JacsMapTemplate3dRow = {
+    layerName: string;
+    fill?: string | null;
+    'fill-opacity'?: number | null;
+    fillAntialias?: boolean | null;
+    'fill-pattern'?: string | null;
+    'line-color'?: string | null;
+    'line-width'?: number | null;
+    lineOpacity?: number | null;
+    strokeWidth?: number | null;
+    strokeOpacity?: number | null;
+    'fill-extrusion-color'?: string | null;
+    'fill-extrusion-height'?: number | null;
+    'fill-extrusion-opacity'?: number | null;
+    'fill-extrusion-base'?: number | null;
+    'fill-extrusion-pattern'?: string | null;
+    [key: string]: any;
+};
+declare class JacsProvider {
+    private mode;
+    private proxyBaseUrl;
+    private direct;
+    private fetchImpl;
+    private tokenCache;
+    constructor(config: JacsProviderConfig);
+    /** `/customer/all` — every customer with its venues, for a venue picker. Each
+     *  entry is `{ customer, venues[] }`. Not venue-scoped. */
+    getCustomersAll(): Promise<Record<string, any>[]>;
+    getPolygonLayers(args: GetPolygonLayersArgs): Promise<JacsPolygonLayer[]>;
+    getFloorMapTemplate3d(args: GetFloorMapTemplate3dArgs): Promise<JacsMapTemplate3dRow[]>;
+    getFloors(args: GetFloorsArgs): Promise<JacsFloor[]>;
+    /**
+     * Hits the JEM venue full-call aggregator at /customer/{cid}/venue/{vid}/all.
+     * Unlike /building/{bid}/full this endpoint does NOT go through Redis — JACS
+     * assembles the response server-side from many controllers on every call, so
+     * SDK consumers always see fresh data regardless of cache invalidation state.
+     *
+     * Response shape: { customer, venue, buildings: [{ floors }], waypoints[],
+     * destinations[], amenities[], paths[], mapLabels[], devices[], zones[],
+     * pathTypes[], mapProfiles[] }. Floor geojson is NOT included — the SDK
+     * lazy-loads it via ensureFloorGeojson.
+     */
+    getVenueAll(args: GetVenueArgs): Promise<JacsVenueAll>;
+    getVenue(args: GetVenueArgs): Promise<JacsVenue>;
+    getFloorMapGeojson(args: GetFloorMapGeoJsonArgs): Promise<GeoJSON.FeatureCollection>;
+    getBuildingFull(args: GetBuildingFullArgs): Promise<JacsBuildingFull>;
+    getDestinations(args: GetDestinationsArgs): Promise<JacsDestination[]>;
+    /** Zones (department groupings). `name` / `description` are localized. */
+    getZones(args: GetZonesArgs): Promise<JacsZone[]>;
+    /**
+     * CMS-authored map labels (street / area / wing names). The endpoint is
+     * `/label`, not `/map-label` — the latter 404s. The localized `name` is on
+     * the label template; each `instances[]` placement carries its own internal
+     * `name` ("Parking Lot E - Instance 1") which is authoring metadata and is
+     * never displayed.
+     */
+    getMapLabels(args: GetMapLabelsArgs): Promise<JacsMapLabel[]>;
+    /**
+     * Amenities are **customer-scoped**, not venue-scoped. A
+     * `/customer/{id}/venue/{id}/amenity` path also exists and returns the same
+     * records, but it silently ignores `?locale=` — it answers with the base
+     * (en-US) names for every locale, which reads as "translations aren't
+     * working" rather than as a wrong URL. Only `/customer/{id}/amenity`
+     * resolves the locale. Don't reintroduce the venue segment.
+     */
+    getAmenities(args: GetAmenitiesArgs): Promise<JacsAmenity[]>;
+    getBuildings(args: GetBuildingsArgs): Promise<JacsBuilding[]>;
+    getStylesheet3d(args: GetStylesheet3dArgs): Promise<StyleSpecification>;
+    invalidateToken(): void;
+    getJson<T>(path: string): Promise<T>;
+    private extractArray;
+    private getJwtToken;
+    private normalizeHost;
+    private joinUrl;
+    private safeReadText;
+}
+
+/** The slice of `/customer/all`'s `customer` object a client acts on. Audit
+ *  fields, quotas and SSO config are dropped on purpose. */
+type Customer = {
+    id: number | string;
+    name: string;
+    /** `null` when JACS has no localized name; use {@link customerDisplayName}. */
+    localizedName: string | null;
+    /** Environment/partition the customer lives in; test customers carry a
+     *  different one, which is what the `tenantId` filter keys on. */
+    tenantId: number | null;
+    uuid: string | null;
+    /** BCP-47 code of `defaultLocale.locale`. */
+    defaultLocale: string | null;
+};
+/** A venue as listed under a customer — a summary, not the loaded venue model. */
+type VenueSummary = {
+    id: number | string;
+    customerId: number | string;
+    name: string;
+    /** South-west corner (`bottomLng`, `bottomLat`); `null` if JACS omitted coordinates. */
+    southWest: [number, number] | null;
+    /** North-east corner (`topLng`, `topLat`). */
+    northEast: [number, number] | null;
+    /** JACS's `status` flag. Not filtered here — a picker decides whether to hide
+     *  `false` (unpublished) venues. */
+    status: boolean;
+    locked: boolean;
+    uuid: string | null;
+    /** JACS's `externalId`; `null` when the venue has none. */
+    externalId: string | null;
+    /** JACS `extensors` — free-form per-venue key/values (`GO_LIVE`, `MOBILE_APP`,
+     *  `KIOSK_LOCATIONS`, analytics ids, …). Values are the raw strings JACS sends
+     *  (`KIOSK_LOCATIONS` is a JSON-encoded string); non-scalar values are dropped. */
+    extensors: Record<string, string>;
+    /** UUID of the venue's default map template; `null` when not set. */
+    defaultMapTemplateId: string | null;
+    /** JACS `labelType` enum value; `null` if omitted. */
+    labelType: number | null;
+    /** Whether the venue's map uses marker clustering. */
+    clustering: boolean;
+    /** Whether JACS publishes the venue's edits automatically. */
+    autoPublish: boolean;
+};
+/** One entry of `/customer/all`: a customer and the venues it owns. Hand a
+ *  venue's `customerId` and `id` to the SDK's `jacs`/`venue` config to load it. */
+type CustomerVenues = {
+    customer: Customer;
+    venues: VenueSummary[];
+};
+type ListCustomerVenuesOptions = {
+    /** Keep only customers with this `tenantId`, so test customers living in
+     *  other tenants are left out. A customer with no `tenantId` never matches.
+     *  Omit to return every customer the proxy exposes. */
+    tenantId?: number;
+};
+/** `customer.localizedName` when non-blank, else `customer.name`. */
+declare function customerDisplayName(customer: Customer): string;
+/**
+ * Lists the customers and venues a user can pick from — the data behind a
+ * "select your hospital" screen. Unlike the `MinuteMaps` class this isn't
+ * bound to a venue: it runs *before* one is chosen.
+ *
+ * Accepts either JACS config (proxy or direct) or an existing `JacsProvider`.
+ */
+declare class VenueDirectory {
+    private jacs;
+    constructor(config: JacsProviderConfig | JacsProvider);
+    /** `/customer/all`, optionally narrowed to one `tenantId`. */
+    listCustomerVenues(options?: ListCustomerVenuesOptions): Promise<CustomerVenues[]>;
+}
+
 type TransitionStep = Extract<WayfindStep, {
     type: 'transition';
 }>;
@@ -2169,5 +2464,5 @@ type ResolvedIconSource = {
  */
 declare function resolveAmenityIconSource(amenity: AmenityLike, preferredLocale?: string): ResolvedIconSource | null;
 
-export { BUILDING_NAME_EXTENSOR_KEY, DAY_KEYS, IMAGE_ALT_EXTENSOR_KEY, MinuteMaps, OPEN_HOURS_EXTENSOR_KEY, OPEN_HOURS_VERSION, PHONE_EXTENSOR_KEY, POINT_OF_INTEREST_EXTENSOR_KEY, RESERVED_EXTENSOR_PREFIX, activeSectionIndex, createMinuteMapsSDK, getOpenStatus, groupStepsIntoFloorSections, isConnectorAmenity, parseBuildingName, parseImageAlt, parseOpenHours, parsePhone, parsePointOfInterest, resolveAmenityIconSource };
-export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, DayKey, Destination, DestinationPhone, EventCallback, Floor, FloorMetadata, HoursRange, JMapAuth, JMapConfig, JacsAuth, JacsConfig, MapEvent, OpenHours, OpenHoursTransition, OpenStatus, OpenStatusOptions, POI, POISearchResult, ResolvedIconSource, RouteFloorSection, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, ThemeName, TransitionStep, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint, Zone };
+export { BUILDING_NAME_EXTENSOR_KEY, DAY_KEYS, IMAGE_ALT_EXTENSOR_KEY, MinuteMaps, OPEN_HOURS_EXTENSOR_KEY, OPEN_HOURS_VERSION, PHONE_EXTENSOR_KEY, POINT_OF_INTEREST_EXTENSOR_KEY, RESERVED_EXTENSOR_PREFIX, VenueDirectory, activeSectionIndex, createMinuteMapsSDK, customerDisplayName, getOpenStatus, groupStepsIntoFloorSections, isConnectorAmenity, parseBuildingName, parseImageAlt, parseOpenHours, parsePhone, parsePointOfInterest, resolveAmenityIconSource };
+export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, Customer, CustomerVenues, DayKey, Destination, DestinationPhone, EventCallback, Floor, FloorMetadata, HoursRange, JMapAuth, JMapConfig, JacsAuth, JacsConfig, JacsProviderConfig, ListCustomerVenuesOptions, MapEvent, OpenHours, OpenHoursTransition, OpenStatus, OpenStatusOptions, POI, POISearchResult, ResolvedIconSource, RouteFloorSection, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, ThemeName, TransitionStep, VenueSummary, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint, Zone };