@mappedin/mappedin-js 5.0.0-beta.3 → 5.0.0-beta.4

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

@@ -28,6 +28,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
     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 } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
     /** 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/get-venue/Mappedin.API.types';
     export type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
@@ -1224,7 +1225,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Offli
         *
         * @class Mappedin.OfflineSearch
         */
-    export type TOfflineSearchOptions = Partial<{
+    type TOfflineSearchAllOptions = {
             /**
                 * Array of stopwords to ignore when searching, default: english stopwords
                 */
@@ -1257,6 +1258,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Offli
                 * Use the location polygons' rank in weighing results
                 */
             useLocationRank?: boolean;
+            /**
+                * Emit Analytics events when doing search
+                * @default true when running in production
+                */
+            emitAnalyticsEvents?: boolean;
             /**
                 * Fine tune search constants
                 */
@@ -1307,8 +1313,8 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Offli
                         */
                     PRIMARY_INDEX_TAGS_NAME_WEIGHT: number;
                     /**
-                        * Default rank when one isn't available in the data, default = 0.1
-                        * @default 0.1
+                        * Default rank when one isn't available in the data, default = 1
+                        * @default 1
                         */
                     LOCATION_DEFAULT_RANK: number;
                     /**
@@ -1322,31 +1328,72 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Offli
                         */
                     RATIO_OF_PREFIX_TO_EXACT: number;
             };
-    }>;
+    };
+    export type TMappedinOfflineAllSearchMatch = {
+            /**
+                * The term that was found
+                */
+            term: string;
+            /**
+                * Term's weight
+                */
+            weight: number;
+            /**
+                * What field the search matched on
+                */
+            matchesOn: string;
+            /**
+                * The value of that field
+                */
+            value?: string;
+    };
+    export type TMappedinOfflineSearchOptions = Partial<TOfflineSearchAllOptions>;
     export type TMappedinOfflineSearchResult = {
-            type: 'MappedinLocation' | 'MappedinCategory' | string;
-            matches: {
-                    term: string;
-                    weight: number;
-                    matchesOn: string;
-                    value?: string;
-            }[];
+            /**
+                * Type describing the object
+                */
+            type: 'MappedinLocation' | 'MappedinCategory' | 'Custom';
+            /**
+                * Details on why the result was returned
+                */
+            matches: TMappedinOfflineAllSearchMatch[];
+            /**
+                * Found object
+                */
             object: MappedinLocation | MappedinCategory | Record<string, unknown>;
+            /**
+                * Total score of the result
+                */
             score: number;
     };
     export type TMappedinOfflineSearchSuggestions = {
+            /**
+                * Total number of suggestions generated
+                */
             total: number;
+            /**
+                * List of suggestions
+                */
             hits: {
+                    /**
+                        * Suggestion text
+                        */
                     text: string;
             }[];
     };
+    /**
+        * A {@link OfflineSearch} is an offline search module. It can be initialized at any time by passing the {@link Mappedin} object and a set of {@link TMappedinOfflineAllSearchOptions} options.
+        *
+        *
+        * @class Mappedin.OfflineSearch
+        */
     export class OfflineSearch {
             #private;
             constructor(
             /**
                 * Mappedin Venue Object, typically returned by `getVenue`/`showVenue`
                 */
-            mappedin: Mappedin, options?: TOfflineSearchOptions);
+            mappedin: Mappedin, options?: TMappedinOfflineSearchOptions);
             /**
                 * Get Suggestions for term
                 */
@@ -1373,10 +1420,9 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Offli
                 */
             addQuery(params: {
                     /**
-                        * Query to match for this object, accepts a string, or
-                        * a list of strings (for extra tags for example)
+                        * Query string to match for this object
                         */
-                    query: string | string[];
+                    query: string;
                     /**
                         * Object that is returned when query matches
                         */
@@ -1981,6 +2027,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
     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 } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.OfflineSearch';
     /** 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/get-venue/Mappedin.API.types';
     export type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';