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

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Map, IControl, ControlPosition, StyleSpecification } from 'maplibre-gl';
+import { Map, StyleSpecification, IControl, ControlPosition } from 'maplibre-gl';
 
 /**
  * Represents a floor in a building
@@ -637,7 +637,10 @@ type SDKConfig = {
         deviceId?: string | number;
     };
     jacs: {
-        mode: 'proxy' | 'direct';
+        /** `snapshot` reads published venue snapshots from a CDN — what clients
+         *  should use. `proxy`/`direct` read live JACS (the draft): local dev and
+         *  CMS preview. */
+        mode: 'proxy' | 'direct' | 'snapshot';
         host?: string;
         auth?: {
             clientId: string;
@@ -645,6 +648,7 @@ type SDKConfig = {
             password: string;
         };
         proxyBaseUrl?: string;
+        baseUrl?: string;
     };
     options?: SDKOptions;
 };
@@ -1083,6 +1087,323 @@ declare function parseOpenHours(raw: unknown): OpenHours | null;
  */
 declare function getOpenStatus(hours: OpenHours, now?: Date, options?: OpenStatusOptions): OpenStatus;
 
+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 JacsProvider methods the SDK's data layer reads. Both JacsProvider (live
+ *  JACS) and SnapshotProvider (published snapshots) implement them. */
+type JacsReader = Pick<JacsProvider, 'getVenueAll' | 'getFloorMapGeojson' | 'getDestinations' | 'getFloors' | 'getZones' | 'getMapLabels' | 'getAmenities' | 'getPolygonLayers' | 'getCustomersAll'>;
+type SnapshotProviderConfig = {
+    /** Root of the snapshot host, e.g. `https://snapshots.example.com`. */
+    baseUrl: string;
+    fetchImpl?: typeof fetch;
+};
+/** Highest manifest `schemaVersion` this SDK can read. */
+declare const SNAPSHOT_SCHEMA_VERSION = 1;
+/**
+ * The venue (or its customer) can't be shown from snapshots: it was never
+ * published, or it was withdrawn (unpublished, disabled or deleted). Thrown
+ * from `init()`; check `reason` to show "not published" vs "no longer
+ * available".
+ */
+declare class SnapshotUnavailableError extends Error {
+    readonly reason: 'not-published' | 'withdrawn';
+    readonly customerId: string;
+    readonly venueId: string | null;
+    constructor(reason: 'not-published' | 'withdrawn', customerId: string, venueId: string | null);
+}
+/** The customer and venue snapshot versions a load is using. */
+type SnapshotVersions = {
+    customer: number;
+    venue: number;
+};
+/**
+ * Result of `checkForUpdate`: whether what's published now differs from what
+ * this instance loaded.
+ *
+ * - `current` — nothing newer is published.
+ * - `available` — a newer customer or venue version is published; reload to
+ *   show it.
+ * - `unavailable` — the venue (or its customer) has since been withdrawn or
+ *   was never published; a reload would fail with `SnapshotUnavailableError`.
+ * - `incompatible` — a newer version is published in a schema this SDK can't
+ *   read; don't reload until the SDK is updated.
+ */
+type SnapshotUpdateCheck = {
+    status: 'current';
+    loaded: SnapshotVersions;
+} | {
+    status: 'available';
+    loaded: SnapshotVersions;
+    latest: SnapshotVersions;
+} | {
+    status: 'unavailable';
+    loaded: SnapshotVersions;
+    reason: 'not-published' | 'withdrawn';
+} | {
+    status: 'incompatible';
+    loaded: SnapshotVersions;
+    schemaVersion: number;
+};
+/**
+ * Picks the locale folder to read. Exact (case-insensitive) match first, then a
+ * same-language match (`es` → `es-US`), then `fallback` — so a locale the
+ * customer added after this venue was last published falls back to the default
+ * language until the venue is republished.
+ */
+declare function resolveSnapshotLocale(requested: string | undefined, available: string[], fallback: string): string;
+declare class SnapshotProvider implements JacsReader {
+    private baseUrl;
+    private fetchImpl;
+    private snapshots;
+    private files;
+    constructor(config: SnapshotProviderConfig);
+    /** `directory.json` — published, public customers with their venues, in
+     *  `/customer/all`'s `{ customer, venues[] }` shape. */
+    getCustomersAll(): Promise<Record<string, any>[]>;
+    /** venue.json with the customer-wide pieces put back where `/all` has them. */
+    getVenueAll(args: {
+        customerId: number | string;
+        venueId: number | string;
+    }): Promise<JacsVenueAll>;
+    getFloorMapGeojson(args: {
+        customerId: number | string;
+        venueId: number | string;
+        floorId: number | string;
+    }): Promise<GeoJSON.FeatureCollection>;
+    getDestinations(args: {
+        customerId: number | string;
+        venueId: number | string;
+        locale?: string;
+    }): Promise<JacsDestination[]>;
+    /** The snapshot holds the first building's floors only — the one the SDK reads. */
+    getFloors(args: {
+        customerId: number | string;
+        venueId: number | string;
+        locale?: string;
+    }): Promise<JacsFloor[]>;
+    getZones(args: {
+        customerId: number | string;
+        venueId: number | string;
+        locale?: string;
+    }): Promise<JacsZone[]>;
+    getMapLabels(args: {
+        customerId: number | string;
+        venueId: number | string;
+        locale?: string;
+    }): Promise<JacsMapLabel[]>;
+    getAmenities(args: {
+        customerId: number | string;
+        locale?: string;
+    }): Promise<JacsAmenity[]>;
+    getPolygonLayers(args: {
+        customerId: number | string;
+    }): Promise<JacsPolygonLayer[]>;
+    /** The manifest versions this instance is reading, once loaded. */
+    getVersions(customerId: number | string, venueId: number | string): Promise<{
+        customer: number;
+        venue: number;
+    }>;
+    /**
+     * Re-reads both manifests (without changing what this instance reads) and
+     * compares them with the versions it loaded. Rejects when a manifest can't
+     * be fetched — a network failure says nothing about what's published, so
+     * try again later.
+     */
+    checkForUpdate(customerId: number | string, venueId: number | string): Promise<SnapshotUpdateCheck>;
+    private venueLocalized;
+    private customerRef;
+    private venueRef;
+    /**
+     * Runs `read` against the pinned snapshots. The publisher keeps old versions
+     * for a while, but a long-running client (a kiosk) can outlive one: if a
+     * pinned version's file is gone, re-read that manifest and retry once on the
+     * current version. Data already loaded from the old version stays as it was;
+     * files fetched from now on come from the new one.
+     */
+    private pinned;
+    /** The current manifest, read once per instance: a loaded venue keeps
+     *  reading the version it started with (see `pinned` for when it can't). */
+    private snapshot;
+    /** Versioned files are immutable, so one fetch per file per instance. */
+    private file;
+    private list;
+    private fetchJson;
+}
+
 declare class MinuteMaps {
     private config;
     private map;
@@ -1153,6 +1474,10 @@ declare class MinuteMaps {
      *  `setLocale()` can rebuild + re-emit `routeReady` with retranslated
      *  step text without recomputing the path. Cleared on route failure. */
     private lastRouteDestinationPoi;
+    /** Waypoint ids (stringified) of the connector(s) the active transition
+     *  step rides — empty unless `setActiveStep` is on a transition. Drives
+     *  `applyRouteConnectorHighlight`. */
+    private activeTransitionWaypointIds;
     private amenityManager;
     private wayfinding;
     private highlightManager;
@@ -1415,6 +1740,18 @@ declare class MinuteMaps {
      * repeatedly; the fetch for a given code happens once.
      */
     prefetchLocale(locale: string): Promise<void>;
+    /**
+     * Whether newer data has been published since this venue loaded, for
+     * long-running displays (kiosks) that should pick up a publish. Snapshot
+     * mode only: it re-reads the venue's and customer's manifests and compares
+     * them with the versions in use; `{ status: 'unsupported' }` in live
+     * (`proxy`/`direct`) modes. A loaded venue never switches versions by
+     * itself — on `available`, reload (ideally while nobody is using the
+     * screen). Rejects when the manifests can't be fetched; try again later.
+     */
+    checkForUpdate(): Promise<SnapshotUpdateCheck | {
+        status: 'unsupported';
+    }>;
     /** Currently active locale (BCP-47), or `undefined` when no locale has
      *  been set — meaning JACS resolves names to the customer's default. */
     getActiveLocale(): string | undefined;
@@ -1732,9 +2069,10 @@ declare class MinuteMaps {
      *    theme's `route-line-active` layer paints it in gold over the
      *    muted base route.
      *
-     * Transition steps (cross-floor elevator / stair hops) clear the
-     * highlight — the overlay text carries the action, and there's no
-     * meaningful on-floor segment to paint.
+     * Transition steps (cross-floor elevator / stair hops) clear the line
+     * highlight — there's no meaningful on-floor segment to paint — and
+     * instead swap the connector(s) the step rides to their highlighted
+     * sprite badge (`CONNECTOR_HIGHLIGHTED_ICON_SUFFIX`).
      *
      * Pass `null` to clear the highlight without changing the floor or
      * tearing down the route.
@@ -1742,6 +2080,17 @@ declare class MinuteMaps {
     setActiveStep(step: WayfindStep | null): Promise<void>;
     private writeActiveStepHighlight;
     private clearActiveStepHighlight;
+    /**
+     * Point `ROUTE_CONNECTOR_LAYER_ID`'s `icon-image` at the highlighted badge
+     * for the connector(s) the active transition step rides, and back at the
+     * plain `iconId` otherwise. Imperative like the layer's filter, so it's
+     * re-run from `updateRouteFloorFilter` after a theme swap drops it.
+     *
+     * `coalesce` over `image` falls back to the plain badge when the sprite has
+     * no `-highlighted` copy of an id (a custom CMS connector icon, or a sprite
+     * that predates the variant) rather than drawing nothing.
+     */
+    private applyRouteConnectorHighlight;
     clearRoute(): void;
     /**
      * Put the end-of-route marker on `poi`, or take it down (`null`). With
@@ -2109,182 +2458,12 @@ 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;
-}
-
+/** Where a `VenueDirectory` reads from: live JACS (`proxy`/`direct`, which
+ *  reads `/customer/all`) or published snapshots (`snapshot`, which reads
+ *  `directory.json` — published venues only). */
+type VenueDirectoryConfig = JacsProviderConfig | ({
+    mode: 'snapshot';
+} & SnapshotProviderConfig);
 /** The slice of `/customer/all`'s `customer` object a client acts on. Audit
  *  fields, quotas and SSO config are dropped on purpose. */
 type Customer = {
@@ -2327,6 +2506,14 @@ type VenueSummary = {
     clustering: boolean;
     /** Whether JACS publishes the venue's edits automatically. */
     autoPublish: boolean;
+    /** The venue's street address (its first building's `address`); `null` when
+     *  blank or unknown. Only snapshot directories carry it — `/customer/all`
+     *  has no buildings — so it is always `null` in `proxy`/`direct` mode. Same
+     *  value `MinuteMaps.getVenueAddress()` returns once the venue loads. */
+    address: string | null;
+    /** The venue's description, as with `address`. Matches
+     *  `MinuteMaps.getVenueDescription()`. */
+    description: string | null;
 };
 /** 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. */
@@ -2347,11 +2534,12 @@ declare function customerDisplayName(customer: Customer): string;
  * "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`.
+ * Accepts JACS config (proxy or direct), snapshot config, or an existing
+ * `JacsProvider` / `SnapshotProvider`.
  */
 declare class VenueDirectory {
     private jacs;
-    constructor(config: JacsProviderConfig | JacsProvider);
+    constructor(config: VenueDirectoryConfig | JacsReader);
     /** `/customer/all`, optionally narrowed to one `tenantId`. */
     listCustomerVenues(options?: ListCustomerVenuesOptions): Promise<CustomerVenues[]>;
 }
@@ -2464,5 +2652,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, 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 };
+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, SNAPSHOT_SCHEMA_VERSION, SnapshotProvider, SnapshotUnavailableError, VenueDirectory, activeSectionIndex, createMinuteMapsSDK, customerDisplayName, getOpenStatus, groupStepsIntoFloorSections, isConnectorAmenity, parseBuildingName, parseImageAlt, parseOpenHours, parsePhone, parsePointOfInterest, resolveAmenityIconSource, resolveSnapshotLocale };
+export type { Amenity, AmenityBadgeStyle, AmenityWithFloor, Bounds, BoundsPadding, CameraState, Customer, CustomerVenues, DayKey, Destination, DestinationPhone, EventCallback, Floor, FloorMetadata, HoursRange, JMapAuth, JMapConfig, JacsAuth, JacsConfig, JacsProviderConfig, JacsReader, ListCustomerVenuesOptions, MapEvent, OpenHours, OpenHoursTransition, OpenStatus, OpenStatusOptions, POI, POISearchResult, ResolvedIconSource, RouteFloorSection, RoutePoint, RoutingOptions, SDKConfig, SDKOptions, SnapshotProviderConfig, SnapshotUpdateCheck, SnapshotVersions, ThemeName, TransitionStep, VenueDirectoryConfig, VenueSummary, ViewOptions, WayfindCenterMode, WayfindStep, Waypoint, Zone };