@mappedin/mappedin-js 5.29.4 → 5.30.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 { TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata } 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';
@@ -52,7 +52,10 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     import { MAP_RENDER_MODE } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
     import { ParsedMVF } from '@mappedin/mvf';
     export { MAP_RENDER_MODE, GET_VENUE_EVENT };
-    export function parseOptions(options: TGetVenueOptions): TGetVenueOptionsInternal & TGetVenueOptions;
+    /**
+        * @internal
+        */
+    export function parseOptions<T extends TAllGetVenueOptions>(options: T): TGetVenueOptionsInternal<T>;
     /**
         * @internal
         */
@@ -154,7 +157,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
         * Download a bundle and return a Mappedin instance
         * @internal
         */
-    export function downloadBundle(userOptions: any, { url, updated_at }: {
+    export function downloadBundle(userOptions: TGetVenueBundleOptions, { url, updated_at }: {
             url: any;
             updated_at: any;
     }): Promise<Mappedin>;
@@ -205,6 +208,14 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types' {
+    import type { TGetVenueMVFOptions, TGetVenueMakerOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/';
+    import type { DefaultThings } from '@mappedin/mappedin-js/lib/esm/get-venue/default-things';
+    export type MergedThings = {
+            [key in keyof DefaultThings]: string[];
+    } & {
+            [k: string]: string[];
+    };
+    export type ThingsOption = Partial<MergedThings>;
     export type TGetVenueOptions = {
             accessToken?: string;
             clientId?: string;
@@ -218,22 +229,44 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types' {
                     [key in string]: string;
             };
             venue: string;
-            things?: any;
+            /**
+                * An object specifying additional properties to fetch for each data item.
+                * Each key represents a data item (e.g., 'locations', 'nodes'), and the value is an array of strings indicating extra properties to be included.
+                * @example
+                * For example:
+                * ```
+                * getVenue({
+                *   venue: 'some-venue',
+                *   things: { vortexes: [ 'material' ]
+                * }})
+                * ```
+                */
+            things?: ThingsOption;
             useDraftData?: boolean;
             platformString?: string;
             emitAnalyticsEvents?: boolean;
             secure?: boolean;
             preloadMapGeometry?: boolean;
     };
-    export type TGetVenueOptionsInternal = {
+    export type TProcessedMVFOptions = TGetVenueMakerOptions & {
+            emitAnalyticsEvents: boolean;
+            clientId: string;
+            clientSecret: string;
+            venue: string;
+    };
+    export type TAllGetVenueOptions = TGetVenueOptions | TGetVenueMVFOptions | (TProcessedMVFOptions & {
+            perspective?: string;
+    });
+    export type TGetVenueOptionsInternal<T extends TAllGetVenueOptions> = Omit<T & {
             baseUrl?: string;
             supplementaryUrl?: string;
             noAuth?: boolean;
             includeHidden?: boolean;
             apiGateway?: string;
             authorization?: string;
-            things?: any;
             headers?: any;
+    }, 'things'> & {
+            things?: MergedThings;
     };
     export type TVenueMetadata = {
             languages: {
@@ -256,14 +289,14 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types' {
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin' {
     import { Navigator } from '@mappedin/mappedin-js/lib/esm/get-venue/--/navigator';
-    import type { TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
     import type { MappedinNode, MappedinPolygon, MappedinLocation, MappedinCategory, MappedinVortex, MappedinVenue, MappedinTheme, MappedinRankings, MappedinLocationRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinMapGroup, GET_VENUE_PAYLOAD } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import { TAccessors, GET_VENUE_EVENT } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import { IAnalytics } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.CustomerAnalytics';
     import { ParsedMVF } from '@mappedin/mvf';
     import { ParsedMVFv1 } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.MVF.types';
     import { PubSub } from '@mappedin/mappedin-js/lib/esm/get-venue/pub-sub.typed';
-    export const defaultOptions: TGetVenueOptionsInternal & TGetVenueOptions;
+    export const defaultOptions: TGetVenueOptionsInternal<TGetVenueOptions>;
     export class Mappedin extends PubSub<GET_VENUE_PAYLOAD, GET_VENUE_EVENT> {
             #private;
             perspective: any;
@@ -495,7 +528,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin' {
             /**
                 * @deprecated Use {@link hydrateVenue} instead
                 */
-            constructor(options: TGetVenueOptionsInternal & TGetVenueOptions);
+            constructor(options: TGetVenueOptionsInternal<TAllGetVenueOptions>);
             analytics: IAnalytics;
             /**
                 * @hidden
@@ -525,6 +558,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/default-things' {
         themes: string[];
         rankings: string[];
     };
+    export type DefaultThings = typeof defaultThings;
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/internal' {
@@ -864,6 +898,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation' {
             siblingGroups?: TSiblingGroup[] | undefined;
             gallery?: TGalleryImage[] | undefined;
             amenity?: string | undefined;
+            filterFlags?: string[];
             constructor(mappedin: Mappedin, data: any);
             /**
                 * Polygons this Location is attached to.
@@ -1425,6 +1460,209 @@ 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 { 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';
+    /**
+        * 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.
+        *
+        * @example
+        * ```js
+        * const { getVenue } = require("@mappedin/mappedin-js/lib/node/index");
+        * setFetchFn(require("node-fetch-commonjs"));
+        * ```
+        *
+        */
+    export function setFetchFn(fetchFn: any): void;
+    /** Classes */
+    export { MappedinCollectionType, MappedinNavigatable, MappedinNode, MappedinLocation, MappedinPolygon, MappedinCategory, MappedinDirections, MappedinDestinationSet, MappedinVortex, MappedinVenue, MappedinRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinCoordinate, MappedinMapGroup, Mappedin, } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    /**
+        * @internal
+        * @hidden
+        *
+        * Export this only so our internal pre-built products can use it. We don't want to document it for external developers.
+        */
+    export { default as CustomerAnalytics } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.CustomerAnalytics';
+    export type { TMappedinDirective } from '@mappedin/mappedin-js/lib/esm/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/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 { 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 };
+    /** API data types */
+    export type { TLocationType, TNode, TImage, TLogo, TGalleryImage, TPhone, TSocial, TColor, TVortex, TPicture, TOpeningHours, TSiblingGroup, TState, TCategory, TEvent, TGeoReference, TMap, TMapGroup, TBuilding, TLocation, TPolygon, TPolygonRanking, TVenue, TMappedinAPI, } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.API.types';
+    export type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import { MAP_RENDER_MODE } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import { ParsedMVF } from '@mappedin/mvf';
+    export { MAP_RENDER_MODE, GET_VENUE_EVENT };
+    /**
+        * @internal
+        */
+    export function parseOptions<T extends TAllGetVenueOptions>(options: T): TGetVenueOptionsInternal<T>;
+    /**
+        * @internal
+        */
+    export function getVenueMVF(userOptions: TGetVenueMVFOptions): Promise<Mappedin>;
+    /**
+        * @experimental
+        * Get venue data for a map created in Mappedin Maker.
+        * @param userOptions
+        * @example
+        * ```ts
+        * const mappedin = await getVenueMaker({
+        * 	key: '<Your Maker Key>',
+        * 	secret: '<Your Maker Secret>',
+        * 	mapId: '<Your Maker Map ID>',
+        * });
+        * ```
+        * @returns {@link Mappedin} object with data from the Maker map.
+        */
+    export function getVenueMaker(userOptions: TGetVenueMakerOptions): Promise<Mappedin>;
+    /**
+        * Get Venue Data for a Mappedin Venue
+        */
+    export function getVenue(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    export function getVenueMetadata(userOptions: TGetVenueOptions): Promise<TVenueMetadata>;
+    /**
+        * @internal
+        */
+    export function __setGetVenueMock(fn: any): void;
+    export type TGetVenueBundleOptions = TGetVenueOptions & {
+            bundleBaseUri?: string;
+            version?: string;
+            /**
+                * Parse bundle and convert images to blobs. Disabled in React Native
+                * @private
+                */
+            shouldPopulateBundledImagesAsBlobs?: boolean;
+    };
+    /** @internal */
+    export type TGetVenueMVFOptions = TGetVenueBundleOptions & {
+            onMVFParsed?: (mvf: ParsedMVF) => void;
+            /**
+                * Override initial MVF data
+                */
+            override?: Partial<Pick<ParsedMVF, 'styles.json'>>;
+    };
+    /**
+        * @experimental
+        * Options for {@link getVenueMaker}.
+        */
+    export type TGetVenueMakerOptions = {
+            /**
+                * Maker auth key.
+                */
+            key: string;
+            /**
+                * Maker auth secret.
+                */
+            secret: string;
+            /**
+                * Maker map ID.
+                */
+            mapId: string;
+            /**
+                * Optionally provide a custom base URL for the Maker map API request.
+                */
+            bundleBaseUri?: string;
+            /**
+                * Optionally provide a custom base URL for the Maker auth token request.
+                */
+            authBaseUri?: string;
+            /**
+                * Whether or not to emit analytics events.
+                * @default true
+                */
+            emitAnalyticsEvents?: boolean;
+            /**
+                * Callback for when the Maker map data has been fetched and parsed as Mappedin Venue Format (MVF) data. This occurs before the {@link Mappedin} object is hydrated.
+                * @param mvf Parsed MVF data.
+                */
+            onMVFParsed?: (mvf: ParsedMVF) => void;
+    };
+    /**
+        * @deprecated
+        * Fetching an offline Venue bundle
+        * It is possible to download the venue bundle with all assets built in, which allows for caching/offline solutions.
+        * Note 1: This requires enabling from Mappedin's Customer Solutions team.
+        * Note 2: This may behave a lot slower for large venues, especially those with many images. We are actively working on improving load times.
+        */
+    export function getVenueBundle(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
+    /**
+        * Get the bundle URL and updated_at time.
+        * @internal
+        */
+    export function getVenueBundleURL(userOptions: TGetVenueBundleOptions): Promise<{
+            url: string;
+            updated_at: string;
+    }>;
+    /**
+        * Download a bundle and return a Mappedin instance
+        * @internal
+        */
+    export function downloadBundle(userOptions: TGetVenueBundleOptions, { url, updated_at }: {
+            url: any;
+            updated_at: any;
+    }): Promise<Mappedin>;
+    /**
+        * Get the bundle URL and updated_at time.
+        * @internal
+        */
+    export function getVenueMVFURL(userOptions: TGetVenueBundleOptions): Promise<{
+            url: string;
+            updated_at: string;
+    }>;
+    /**
+        * @internal
+        */
+    export function downloadVenueBundleMVF(options: TGetVenueBundleOptions): Promise<Uint8Array>;
+    /**
+        * Represents the options for getting an access token.
+        *
+        * @internal
+        */
+    export type TGetAccessTokenOptions = Pick<TGetVenueMakerOptions, 'authBaseUri' | 'key' | 'secret'>;
+    /**
+        * Get an access token.
+        *
+        * @param userOptions
+        */
+    export function getMakerAccessToken(userOptions: TGetAccessTokenOptions): Promise<{
+            access_token: string;
+            expires_in: number;
+    }>;
+    export function getMakerBundleURL(userOptions: TGetVenueMakerOptions, token: string): Promise<{
+            url: string;
+            updated_at: string;
+    }>;
+    export function downloadMVF(userOptions: TGetVenueMakerOptions, accessToken: string): Promise<Uint8Array>;
+    /**
+        * Returns a {@link Mappedin} object hydrated with JSON data.
+        * @param {string|Object} mappedinSerializableData A JSON string or object representing a venue.
+        * @param {boolean} shouldPopulateBundledImagesAsBlobs
+        * @returns {Mappedin} A new Mappedin object with data from the mappedinSerializableData parameter.
+        */
+    export function hydrateVenue(mappedinSerializableData: any, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<Mappedin>;
+    /**
+        * @internal
+        * Returns a {@link Mappedin} object hydrated with MVF data.
+        */
+    export function hydrateVenueMVF(mvfData: ParsedMVF): Promise<Mappedin>;
+}
+
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.MVF.types' {
     import { MapId, ObstructionCollection, EntranceCollection, SpaceCollection, Style } from '@mappedin/mvf';
     import { FeatureCollection, MultiPolygon, Point, Polygon } from 'geojson';
@@ -2069,6 +2307,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinVortex' {
             weight?: number;
             multiplier?: number;
             nodes?: string[];
+            filterFlags?: string[];
             constructor(data: any);
             static hydrate(vortexes: any): MappedinVortex[];
             static fetch(mappedin: Mappedin): Promise<MappedinVortex[]>;
@@ -2401,12 +2640,12 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinMapGroup' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/utils' {
-    import type { TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
+    import type { MergedThings, TGetVenueOptions, TGetVenueOptionsInternal, ThingsOption } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types';
     import type { MappedinMap } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import { Mappedin, MappedinNavigatable, MappedinNode, MappedinPolygon, MappedinLocation, MappedinCoordinate } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     export function isGatewayKey(key: string): boolean;
     export function stringifyQuery(query: any, gateway?: boolean): string;
-    export function buildUrl(options: TGetVenueOptionsInternal & TGetVenueOptions, pathname: string, query: any, supplementary?: boolean): string;
+    export function buildUrl(options: TGetVenueOptionsInternal<TGetVenueOptions>, pathname: string, query: any, supplementary?: boolean): string;
     /**
         * Make a network request to the Mappedin API to fetch an array of objects.
         * @param options options from getVenue- baseUrl and supplementaryUrl are used
@@ -2415,7 +2654,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/utils' {
         * @param supplementary whether to use the supplementaryUrl when sending the request
         * @returns the result json
         */
-    export function getArray(options: TGetVenueOptionsInternal & TGetVenueOptions, pathname: string, query: any, supplementary?: boolean): Promise<any>;
+    export function getArray(options: TGetVenueOptionsInternal<TGetVenueOptions>, pathname: string, query: any, supplementary?: boolean): Promise<any>;
     /**
         * Make a network request to the Mappedin API to fetch an object.
         * @param options options from getVenue- baseUrl and supplementaryUrl are used
@@ -2425,21 +2664,21 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/utils' {
         * @param isExpectingArray whether the endpoint returns an array
         * @returns the result json
         */
-    export function getObject(options: TGetVenueOptionsInternal & TGetVenueOptions, pathname: string, query: any, supplementary?: boolean, isExpectingArray?: boolean): Promise<any>;
+    export function getObject(options: TGetVenueOptionsInternal<TGetVenueOptions>, pathname: string, query: any, supplementary?: boolean, isExpectingArray?: boolean): Promise<any>;
     /**
         * Prepares the request and URL fields to pass into generateAPIRequest
         * @param options options from getVenue- baseUrl and supplementaryUrl are used
         * @param url string describing the url corresponding to the client's request
         * @param supplementary whether to use the supplementaryUrl when sending the request
         */
-    export function constructParamsForRequest(options: TGetVenueOptionsInternal & TGetVenueOptions, url: string, supplementary?: boolean): {
+    export function constructParamsForRequest(options: TGetVenueOptionsInternal<TGetVenueOptions>, url: string, supplementary?: boolean): {
             req: {
                     method: string;
                     headers: any;
             };
             url: string;
     };
-    export function generateAPIRequest(options: TGetVenueOptionsInternal & TGetVenueOptions, url: string, supplementary?: boolean): Promise<any>;
+    export function generateAPIRequest(options: TGetVenueOptionsInternal<TGetVenueOptions>, url: string, supplementary?: boolean): Promise<any>;
     export function addToSet(array: any, value: any): void;
     export function getDistanceBetweenLatLon([lat1, lon1]: [number, number], [lat2, lon2]: [number, number]): any;
     export function getMapScale(map: MappedinMap): any;
@@ -2473,6 +2712,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/utils' {
         * @return {MappedinLocation}
         */
     export const getPrimaryLocationForPolygon: (polygon: MappedinPolygon | string | undefined, venue: Mappedin) => MappedinLocation | null;
+    export function mergeThings(thingsOption: ThingsOption | undefined): MergedThings;
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.cache' {