@mappedin/mappedin-js 5.0.0-beta.6 → 5.0.0-beta.8

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

@@ -6,6 +6,19 @@
 declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     import type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
+    /**
+        * This is how we can avoid bundling in node-fetch (via isomorphic fetch),
+        * which keeps popping up in security advisories
+        * This is a pattern that most isomorphic libraries appear to use,
+        * where when running in node, you can pass your own fetch function
+        * as one is not provided by Node.js.
+        *
+        */
+    export function isomorphicFetch(): Window['fetch'];
+    /**
+        * Overwrite the internal `fetch` function with your own. Typically for use in Node.js and Jest
+        */
+    export function setFetchFn(fetchFn: any): void;
     /** Classes */
     export { Mappedin, MappedinCollectionType } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
@@ -26,6 +39,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     export type { TMappedinDirective } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirections';
     export type { IDirectionsResult } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator';
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
+    export type { TMappedinCoordinateOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate';
     export type { TDirectionToOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNavigatable';
     export { OfflineSearch } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
     export type { TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
@@ -61,11 +75,18 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
             };
     };
     export { MAP_RENDER_MODE };
+    /**
+        * @internal
+        */
     export function getVenueMVF(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
     export function getVenue(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    /**
+        * @internal
+        */
+    export function __setGetVenueMock(fn: any): void;
     export type TGetVenueBundleOptions = TGetVenueOptions & {
             bundleBaseUri?: string;
             version?: string;
@@ -134,6 +155,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types
             things?: any;
             useDraftData?: boolean;
             platformString?: string;
+            emitAnalyticsEvents?: boolean;
     };
     export type TGetVenueOptionsInternal = {
             baseUrl?: string;
@@ -142,10 +164,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types
             includeHidden?: boolean;
             apiGateway?: string;
             authorization?: string;
-            /**
-                * @deprecated 2D support will be removed in the future
-                */
-            do2D?: boolean;
             things?: any;
             headers?: any;
     };
@@ -212,7 +230,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             mapGroups: typeof MappedinMapGroup;
             themes: typeof MappedinTheme;
             locationStates: typeof MappedinLocationState;
-            locationRankings: typeof MappedinLocationRankings;
             rankings: typeof MappedinRankings;
     };
     export type TTHINGS = keyof typeof THINGS;
@@ -233,15 +250,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             mapGroups: MappedinMapGroup[];
             themes: MappedinTheme[];
             locationStates: MappedinLocationState[];
-            /**
-                * @deprecated use polygonRankings instead
-                * TODO: remove when we know that nobody is using this
-                */
-            locationRankings: MappedinLocationRankings[];
             rankings?: MappedinRankings;
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _categoriesById?: {
                     [id: string]: MappedinCategory;
@@ -249,6 +262,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationsById?: {
                     [id: string]: MappedinLocation;
@@ -256,6 +270,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _vortexesById?: {
                     [id: string]: MappedinVortex;
@@ -263,6 +278,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _mapsById?: {
                     [id: string]: MappedinMap;
@@ -270,6 +286,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _nodesById?: {
                     [id: string]: MappedinNode;
@@ -277,6 +294,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _polygonsById?: {
                     [id: string]: MappedinPolygon;
@@ -284,6 +302,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _eventsById?: {
                     [id: string]: MappedinEvent;
@@ -291,6 +310,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _mapGroupsById?: {
                     [id: string]: MappedinMapGroup;
@@ -298,6 +318,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationStatesById?: {
                     [id: string]: MappedinLocationState;
@@ -305,6 +326,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationRankingsById?: {
                     [id: string]: MappedinLocationRankings;
@@ -312,6 +334,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _rankingsById?: {
                     [id: string]: MappedinRankings;
@@ -319,6 +342,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _categoriesByExternalId?: {
                     [id: string]: MappedinCategory;
@@ -326,6 +350,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationsByExternalId?: {
                     [id: string]: MappedinLocation;
@@ -333,6 +358,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _vortexesByExternalId?: {
                     [id: string]: MappedinVortex;
@@ -340,6 +366,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _mapsByExternalId?: {
                     [id: string]: MappedinMap;
@@ -347,6 +374,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _nodesByExternalId?: {
                     [id: string]: MappedinNode;
@@ -354,6 +382,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _polygonsByExternalId?: {
                     [id: string]: MappedinPolygon;
@@ -361,6 +390,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _eventsByExternalId?: {
                     [id: string]: MappedinEvent;
@@ -368,6 +398,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _mapGroupsByExternalId?: {
                     [id: string]: MappedinMapGroup;
@@ -375,6 +406,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationStatesByExternalId?: {
                     [id: string]: MappedinLocationState;
@@ -382,6 +414,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _locationRankingsByExternalId?: {
                     [id: string]: MappedinLocationRankings;
@@ -389,6 +422,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 * @hidden
                 * @internal
+                * @deprecated Use {@link Mappedin.getCollectionItemById} instead
                 */
             _rankingsByExternalId?: {
                     [id: string]: MappedinRankings;
@@ -491,10 +525,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocati
                 */
             get polygons(): MappedinPolygon[];
             set polygons(polygons: MappedinPolygon[]);
-            /**
-                * Ranking for this location.
-                */
-            get rank(): number | null;
             /**
                 * Nodes this Location is attached to.
                 *
@@ -1082,6 +1112,21 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirect
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate' {
     import { Mappedin, MappedinNode } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue';
     import type { MappedinMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap';
+    export type TMappedinCoordinateOptions = {
+            map: MappedinMap;
+            mappedin: Mappedin;
+            x: number;
+            y: number;
+            lat?: undefined;
+            lon?: undefined;
+    } | {
+            map: MappedinMap;
+            mappedin: Mappedin;
+            x?: undefined;
+            y?: undefined;
+            lat: number;
+            lon: number;
+    };
     /**
         * A {@link MappedinCoordinate} represents a coordinate on a map, created using lat/lon.
         *
@@ -1099,21 +1144,24 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordi
                 *  X coordinate in Mappedin Units
                 * @property x {number}
                 */
-            x: number;
+            get x(): number;
             /**
                 * Y coordinate in Mappedin Units
                 * @property y {number}
                 */
-            y: number;
+            get y(): number;
             /**
                 * Latitude
                 */
-            lat: number;
+            get lat(): number;
             /**
                 * Longitude
                 */
-            lon: number;
-            constructor(lat: number, lon: number, x: number, y: number, map: MappedinMap | string, mappedin: Mappedin);
+            get lon(): number;
+            /**
+                * @internal
+                */
+            constructor(options: TMappedinCoordinateOptions);
             /**
                 *
                 * Calculate distance between a coordinate and a {@link MappedinNode} or {@link MappedinCoordinate}
@@ -1126,6 +1174,13 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordi
                 * Get Nearest Node to Coordinate, which can then be used for navigation
                 */
             get nearestNode(): MappedinNode;
+            toJSON(): {
+                    x: number;
+                    y: number;
+                    map: string;
+                    lat: number;
+                    lon: number;
+            };
     }
 }
 
@@ -1197,11 +1252,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNaviga
                 * Calculate distance between 2 nodes, polygons or locations
                 */
             distanceTo(destination: MappedinNode | MappedinLocation | MappedinPolygon, options: TDirectionToOptions): number;
-            /**
-                *
-                * @deprecated
-                */
-            directionsToCallback(destination: MappedinNode | MappedinLocation | MappedinPolygon, options: TDirectionToOptions): MappedinDirections | undefined;
     }
 }
 
@@ -1988,6 +2038,19 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Analy
             trackBlueDotEvent(blueDotEvent: any): void;
             trackSearch(searchAnalyticsObject: any): void;
             trackSearchSuggest(searchAnalyticsObject: any): void;
+            /**
+                * Sets the current global context of the Analytics class.
+                * @method setContext
+                * @param context {String} The Analytics context to be set.
+                * @hidden
+                */
+            static setContext(context: any): void;
+            /**
+                * Sets the current global context of the Analytics class to undefined.
+                * @method clearContext
+                * @hidden
+                */
+            static clearContext(): void;
             /**
                 * Enum of valid bluedot events.
                 * Pass a property of this into the {{#crossLink "Analytics/trackBlueDotEvent:method"}}{{/crossLink}} method.
@@ -2008,6 +2071,19 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Analy
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     import type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
+    /**
+        * This is how we can avoid bundling in node-fetch (via isomorphic fetch),
+        * which keeps popping up in security advisories
+        * This is a pattern that most isomorphic libraries appear to use,
+        * where when running in node, you can pass your own fetch function
+        * as one is not provided by Node.js.
+        *
+        */
+    export function isomorphicFetch(): Window['fetch'];
+    /**
+        * Overwrite the internal `fetch` function with your own. Typically for use in Node.js and Jest
+        */
+    export function setFetchFn(fetchFn: any): void;
     /** Classes */
     export { Mappedin, MappedinCollectionType } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
@@ -2028,6 +2104,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     export type { TMappedinDirective } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirections';
     export type { IDirectionsResult } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator';
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
+    export type { TMappedinCoordinateOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate';
     export type { TDirectionToOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNavigatable';
     export { OfflineSearch } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
     export type { TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
@@ -2063,11 +2140,18 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
             };
     };
     export { MAP_RENDER_MODE };
+    /**
+        * @internal
+        */
     export function getVenueMVF(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
     export function getVenue(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    /**
+        * @internal
+        */
+    export function __setGetVenueMock(fn: any): void;
     export type TGetVenueBundleOptions = TGetVenueOptions & {
             bundleBaseUri?: string;
             version?: string;