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

package/dist/index.d.ts

@@ -1271,6 +1271,8 @@ type SnapshotProviderConfig = {
     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
@@ -2504,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. */
@@ -2642,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, SnapshotProvider, SnapshotUnavailableError, VenueDirectory, activeSectionIndex, createMinuteMapsSDK, customerDisplayName, getOpenStatus, groupStepsIntoFloorSections, isConnectorAmenity, parseBuildingName, parseImageAlt, parseOpenHours, parsePhone, parsePointOfInterest, resolveAmenityIconSource, resolveSnapshotLocale };
+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 };