@mappedin/mappedin-js 5.30.1 → 5.32.0

package/lib/esm/get-venue/index.d.ts

@@ -5,7 +5,7 @@
 //   ../../../cms/geojson
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
-    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata, ThingsOption } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin';
     import { defaultThings } from '@mappedin/mappedin-js/lib/esm/get-venue/default-things';
     import { GET_VENUE_EVENT } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
@@ -43,6 +43,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation';
     export type { TMappedinCoordinateOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/MappedinCoordinate';
     export type { TDirectionToOptions, TTHINGS, TAccessors } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    export type { ThingsOption };
     export { OfflineSearch } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.OfflineSearch';
     export type { TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions, } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.OfflineSearch';
     export { defaultThings };
@@ -520,11 +521,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin' {
                 * @param mappedinSerializableData Mappedin data that was serialized or exported as JSON
                 * @param shouldPopulateBundledImagesAsBlobs Takes the scenes and images from a bundle and maps them as blobs to where they exist as URLs in the bundle. False by default
                 */
-            hydrate(mappedinSerializableData: string | Record<string, unknown>, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<undefined>;
+            hydrate(mappedinSerializableData: string | Record<string, unknown>, shouldPopulateBundledImagesAsBlobs?: boolean, updateInPlace?: boolean): Promise<undefined>;
             images: any;
             imageBinaries?: Map<string, Uint8Array>;
             scenes: any;
-            fetch(): Promise<void>;
+            fetch(updateInPlace?: boolean): Promise<void>;
             /**
                 * @deprecated Use {@link hydrateVenue} instead
                 */
@@ -935,6 +936,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation' {
             clone(): MappedinLocation;
             get nodeOperationHours(): TOperationHoursMap;
             static hydrate(locations: any, mappedin: Mappedin): MappedinLocation[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             static fetch(mappedin: Mappedin): Promise<MappedinLocation[]>;
             /**
                 *
@@ -1461,7 +1463,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.API.types' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/' {
-    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata, ThingsOption } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin';
     import { defaultThings } from '@mappedin/mappedin-js/lib/esm/get-venue/default-things';
     import { GET_VENUE_EVENT } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
@@ -1499,6 +1501,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/' {
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation';
     export type { TMappedinCoordinateOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/MappedinCoordinate';
     export type { TDirectionToOptions, TTHINGS, TAccessors } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    export type { ThingsOption };
     export { OfflineSearch } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.OfflineSearch';
     export type { TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions, } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.OfflineSearch';
     export { defaultThings };
@@ -2271,6 +2274,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinCategory' {
                 */
             get children(): MappedinCategory[];
             static hydrate(categories: any, mappedin: Mappedin): MappedinCategory[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             static fetch(mappedin: Mappedin): Promise<MappedinCategory[]>;
             toJSON(): any;
     }
@@ -2319,60 +2323,73 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinVenue' {
     import type { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import type { TLogo, TOpeningHours } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.API.types';
     /**
-      * A {@link MappedinVenue} is a specific place (like a mall) with one or more Maps (typically representing different floors) and Locations (stores, washrooms, elevators, etc).
-      *
-      * A Venue can have more properties such as 'name' and 'slug'. The {@link Mappedin} 'things' object is where you would specify what properties you want to download for Venues. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.
-      *
-      * See below for an example a 'things' object with available Venue properties specified:
-      *
-      *	things: {
-      *		venue: ['slug', 'name', 'language', 'address', 'city', 'state', 'postal', 'telephone', 'latitude', 'longitude', 'website', 'operationHours'],
-      *		locations: [],
-      *		categories: [],
-      *		maps: []
-      * 	}
-      *
-      *
-      * @class MappedinVenue
-      */
+        * A {@link MappedinVenue} is a specific place (like a mall) with one or more Maps (typically representing different floors) and Locations (stores, washrooms, elevators, etc).
+        *
+        * A Venue can have more properties such as 'name' and 'slug'. The {@link Mappedin} 'things' object is where you would specify what properties you want to download for Venues. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.
+        *
+        * See below for an example a 'things' object with available Venue properties specified:
+        *
+        *	things: {
+        *		venue: ['slug', 'name', 'language', 'address', 'city', 'state', 'postal', 'telephone', 'latitude', 'longitude', 'website', 'operationHours'],
+        *		locations: [],
+        *		categories: [],
+        *		maps: []
+        * 	}
+        *
+        *
+        * @class MappedinVenue
+        */
     export class MappedinVenue {
-        #private;
-        defaultMap: string;
-        address: string;
-        city: string;
-        countrycode: string;
-        externalId: string;
-        id: string;
-        latitude?: number;
-        logo?: TLogo;
-        longitude?: number;
-        name: string;
-        operationHours?: TOpeningHours[];
-        postal: string;
-        slug: string;
-        state: string;
-        telephone: string;
-        tzid: string;
-        tzidOverride: string;
-        utcOffset: string;
-        website: string;
-        secureContentStorage: boolean;
-        defaultLanguage: {
-            code: string;
-            name: string;
-        };
-        languages: {
+            #private;
+            defaultMap: string;
+            address: string;
+            city: string;
+            countrycode: string;
+            externalId: string;
+            id: string;
+            latitude?: number;
+            logo?: TLogo;
+            longitude?: number;
             name: string;
-            code: string;
-        }[];
-        topLocations?: string[];
-        constructor(mappedin: Mappedin, data: any);
-        get metadata(): any;
-        set metadata(value: any);
-        static hydrate(data: any, mappedin: Mappedin): MappedinVenue;
-        static fetch(mappedin: Mappedin): Promise<MappedinVenue>;
-        get isMultiBuilding(): any;
-        toJSON(): any;
+            operationHours?: TOpeningHours[];
+            postal: string;
+            slug: string;
+            state: string;
+            telephone: string;
+            tzid: string;
+            tzidOverride: string;
+            utcOffset: string;
+            website: string;
+            secureContentStorage: boolean;
+            defaultLanguage: {
+                    code: string;
+                    name: string;
+            };
+            languages: {
+                    name: string;
+                    code: string;
+            }[];
+            topLocations?: string[];
+            /**
+                * Venue render options provided by the server.
+                */
+            renderOptions: {
+                    /**
+                        * Whether the venue should use perspectives to render the map or {@link Mappedin.polygons}.
+                        */
+                    useLivePolygons: boolean;
+                    /**
+                        * Whether the venue should automatically apply {@link TDirectionToOptions} `simplify: { enabled: true }` to all directions.
+                        */
+                    simplifyDirections: boolean;
+            };
+            constructor(mappedin: Mappedin, data: any);
+            get metadata(): any;
+            set metadata(value: any);
+            static hydrate(data: any, mappedin: Mappedin): MappedinVenue;
+            static fetch(mappedin: Mappedin): Promise<MappedinVenue>;
+            get isMultiBuilding(): any;
+            toJSON(): any;
     }
 }
 
@@ -2492,6 +2509,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinEvent' {
                 * @internal
                 */
             static hydrate(events: any, mappedin: Mappedin): MappedinEvent[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             /**
                 * @internal
                 */
@@ -2516,6 +2534,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocationState' {
                 * @internal
                 */
             static hydrate(locationStates: any): MappedinLocationState[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             id: string;
             name: string;
             value: string;
@@ -2609,6 +2628,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinMap' {
                 */
             getNorth(): any;
             static hydrate(maps: any, mappedin: Mappedin): MappedinMap[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             static fetch(mappedin: Mappedin): Promise<MappedinMap[]>;
             get center(): any;
             toJSON(): any;
@@ -2634,6 +2654,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinMapGroup' {
                 */
             get maps(): MappedinMap[];
             static hydrate(mapGroups: any, mappedin: Mappedin): MappedinMapGroup[];
+            static updateInPlace(mappedin: Mappedin, hydrateData?: any): Promise<void>;
             static fetch(mappedin: Mappedin): Promise<MappedinMapGroup[]>;
             toJSON(): any;
     }