proximiio-js-library 1.9.39 → 1.9.41

package/README.md

@@ -187,6 +187,10 @@ const map = new Proximiio.Map({
    hiddenAmenities: string[], // you can define array of amenity id's to hide poi labels and icons while polygons remains functional
    useTimerangeData: false, // if set to true only features inside defined time range in metadata.dateStart and metadata.dateEnd will be shown, default: false
    sendAnalytics: true, // if enabled we automatically send analytics from routing to our API, default: true
+   defaultFilter?: {
+      key: string; // if defaultFilter is defined it will look for this key in feature object
+      value: string; // if the previous key exists in the feature object, it's value will be compared to this value and filtering will be processed in a way that only features with same value or features with missing property will be visible
+   };
 });
 ```
 
@@ -642,6 +646,20 @@ map.getMapReadyListener().subscribe(ready => {
 
 ##### Map Features Filtering
 
+###### Setting new global filter
+
+With this method you can filter features with any of it's properties, if the property key doesn't exists in the feature properties or it's value is the same as defined in options they will pass the filtering and will be visible on map.
+
+```
+// param options { key: string; value: string } | null, define property key and value to filter features, optional, if null filtering will be disabled.
+
+const map = new Proximiio.Map();
+map.getMapReadyListener().subscribe(ready => {
+   console.log('map ready', ready);
+   map.setFiltering({ key: 'properties.metadata.exhibition', value: 'food'});
+});
+```
+
 ###### Setting new feature filter
 
 With this method you set only defined poi feature to be visible, calling this method multiple times will set another feature to be visible without hiding the previous one, with inverted set to true defined feature will hide instead.

package/lib/common.d.ts

@@ -5,3 +5,4 @@ export declare const kebabize: (data: any) => any;
 export declare const getImageFromBase64: (encoded: string) => Promise<HTMLImageElement>;
 export declare const getBase64FromImage: (file: File) => Promise<string>;
 export declare const uuidv4: () => any;
+export declare const getNestedObjectValue: (nestedObject: any, dynamicKey: any) => any;

package/lib/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uuidv4 = exports.getBase64FromImage = exports.getImageFromBase64 = exports.kebabize = exports.kebabToCamel = exports.camelToKebab = exports.axios = void 0;
+exports.getNestedObjectValue = exports.uuidv4 = exports.getBase64FromImage = exports.getImageFromBase64 = exports.kebabize = exports.kebabToCamel = exports.camelToKebab = exports.axios = void 0;
 var axios_1 = require("axios");
 exports.axios = axios_1.default.create({
     baseURL: 'https://api.proximi.fi',
@@ -47,3 +47,25 @@ var uuidv4 = function () {
     });
 };
 exports.uuidv4 = uuidv4;
+var getNestedObjectValue = function (nestedObject, dynamicKey) {
+    // If the dynamic key is empty, return undefined.
+    if (dynamicKey === '') {
+        return undefined;
+    }
+    // Split the dynamic key into two parts: the first key and the remaining keys.
+    var firstKey = dynamicKey.split('.')[0];
+    var remainingKeys = dynamicKey.slice(firstKey.length + 1);
+    // Get the value of the first key in the nested object.
+    var value = nestedObject[firstKey];
+    // If the value is undefined, return undefined.
+    if (value === undefined) {
+        return undefined;
+    }
+    // If the remaining keys are empty, return the value.
+    if (remainingKeys === '') {
+        return value;
+    }
+    // Get the value of the remaining keys in the nested object.
+    return exports.getNestedObjectValue(value, remainingKeys);
+};
+exports.getNestedObjectValue = getNestedObjectValue;

package/lib/components/map/main.d.ts

@@ -7,7 +7,7 @@ import { AmenityModel } from '../../models/amenity';
 import { MapboxOptions } from '../../models/mapbox-options';
 import PersonModel from '../../models/person';
 import { WayfindingConfigModel } from '../../models/wayfinding';
-interface State {
+export interface State {
     readonly initializing: boolean;
     readonly floor: FloorModel;
     readonly floors: FloorModel[];
@@ -28,7 +28,7 @@ interface State {
     readonly persons: PersonModel[];
     readonly user: any;
 }
-interface Options {
+export interface Options {
     selector?: string;
     allowNewFeatureModal?: boolean;
     newFeatureModalEvent?: string;
@@ -99,8 +99,12 @@ interface Options {
     hiddenAmenities?: string[];
     useTimerangeData?: boolean;
     sendAnalytics?: boolean;
+    defaultFilter?: {
+        key: string;
+        value: string;
+    };
 }
-interface PaddingOptions {
+export interface PaddingOptions {
     bottom: number;
     left: number;
     right: number;
@@ -222,6 +226,15 @@ export declare class Map {
      *  map.getMapboxInstance();
      */
     getMapboxInstance(): maplibregl.Map;
+    /**
+     *  @memberof Map
+     *  @name getMapState
+     *  @returns returns map state
+     *  @example
+     *  const map = new Proximiio.Map();
+     *  map.getMapState();
+     */
+    getMapState(): any;
     /**
      *  @memberof Map
      *  @name getMapReadyListener
@@ -662,6 +675,22 @@ export declare class Map {
      *  });
      */
     setBoundsPadding(padding: number | PaddingOptions): void;
+    /**
+     * With this method you can filter features with any of it's properties, if the property key doesn't exists in the feature properties or it's value is the same as defined in options they will pass the filtering and will be visible on map.
+     *  @memberof Map
+     *  @name setFiltering
+     *  @param options { key: string; value: string } | null, define property key and value to filter features, optional, if null filtering will be disabled.
+     *  @example
+     *  const map = new Proximiio.Map();
+     *  map.getMapReadyListener().subscribe(ready => {
+     *    console.log('map ready', ready);
+     *    map.setFiltering({ key: 'properties.metadata.exhibition', value: 'food'});
+     *  });
+     */
+    setFiltering(options: {
+        key: string;
+        value: string;
+    } | null): void;
     /**
      * With this method you can show only defined features, you can send both id or title, with inverted set to true defined feature will hide instead.
      *  @memberof Map
@@ -917,4 +946,3 @@ export declare class Map {
      */
     refetch(): void;
 }
-export {};

package/lib/components/map/main.js

@@ -285,6 +285,7 @@ var Map = /** @class */ (function () {
                                 amenityIdProperty: this.defaultOptions.amenityIdProperty,
                                 hiddenAmenities: this.defaultOptions.hiddenAmenities,
                                 useTimerangeData: this.defaultOptions.useTimerangeData,
+                                filter: this.defaultOptions.defaultFilter,
                             })];
                     case 1:
                         _d = _e.sent(), places = _d.places, style = _d.style, styles = _d.styles, features = _d.features, amenities = _d.amenities;
@@ -499,6 +500,7 @@ var Map = /** @class */ (function () {
                                 amenityIdProperty: this.defaultOptions.amenityIdProperty,
                                 hiddenAmenities: this.defaultOptions.hiddenAmenities,
                                 useTimerangeData: this.defaultOptions.useTimerangeData,
+                                filter: this.defaultOptions.defaultFilter,
                             })];
                     case 1:
                         features = (_a.sent()).features;
@@ -2185,6 +2187,17 @@ var Map = /** @class */ (function () {
     Map.prototype.getMapboxInstance = function () {
         return this.map;
     };
+    /**
+     *  @memberof Map
+     *  @name getMapState
+     *  @returns returns map state
+     *  @example
+     *  const map = new Proximiio.Map();
+     *  map.getMapState();
+     */
+    Map.prototype.getMapState = function () {
+        return this.state;
+    };
     /**
      *  @memberof Map
      *  @name getMapReadyListener
@@ -2821,6 +2834,27 @@ var Map = /** @class */ (function () {
     Map.prototype.setBoundsPadding = function (padding) {
         this.defaultOptions.fitBoundsPadding = padding;
     };
+    /**
+     * With this method you can filter features with any of it's properties, if the property key doesn't exists in the feature properties or it's value is the same as defined in options they will pass the filtering and will be visible on map.
+     *  @memberof Map
+     *  @name setFiltering
+     *  @param options { key: string; value: string } | null, define property key and value to filter features, optional, if null filtering will be disabled.
+     *  @example
+     *  const map = new Proximiio.Map();
+     *  map.getMapReadyListener().subscribe(ready => {
+     *    console.log('map ready', ready);
+     *    map.setFiltering({ key: 'properties.metadata.exhibition', value: 'food'});
+     *  });
+     */
+    Map.prototype.setFiltering = function (options) {
+        if (options) {
+            this.defaultOptions.defaultFilter = options;
+        }
+        else {
+            delete this.defaultOptions.defaultFilter;
+        }
+        this.onRefetch();
+    };
     /**
      * With this method you can show only defined features, you can send both id or title, with inverted set to true defined feature will hide instead.
      *  @memberof Map

package/lib/controllers/geo.d.ts

@@ -1,10 +1,14 @@
 import Feature, { FeatureCollection } from '../models/feature';
 import { FeatureCollection as FCModel, Feature as FModel } from '@turf/helpers';
-export declare const getFeatures: ({ initPolygons, autoLabelLines, hiddenAmenities, useTimerangeData, }: {
+export declare const getFeatures: ({ initPolygons, autoLabelLines, hiddenAmenities, useTimerangeData, filter, }: {
     initPolygons?: boolean;
     autoLabelLines?: boolean;
     hiddenAmenities?: string[];
     useTimerangeData?: boolean;
+    filter?: {
+        key: string;
+        value: string;
+    };
 }) => Promise<FeatureCollection>;
 export declare const getAmenities: (amenityIdProperty?: string) => Promise<any>;
 export declare const getPois: () => Promise<Feature[]>;
@@ -12,11 +16,15 @@ export declare const addFeatures: (featureCollection: FCModel) => Promise<void>;
 export declare const updateFeature: (featureData: FModel, featureId: string) => Promise<void>;
 export declare const deleteFeatures: (featureCollection: FCModel) => Promise<void>;
 declare const _default: {
-    getFeatures: ({ initPolygons, autoLabelLines, hiddenAmenities, useTimerangeData, }: {
+    getFeatures: ({ initPolygons, autoLabelLines, hiddenAmenities, useTimerangeData, filter, }: {
         initPolygons?: boolean;
         autoLabelLines?: boolean;
         hiddenAmenities?: string[];
         useTimerangeData?: boolean;
+        filter?: {
+            key: string;
+            value: string;
+        };
     }) => Promise<FeatureCollection>;
     addFeatures: (featureCollection: FCModel<import("@turf/helpers").Geometry | import("@turf/helpers").GeometryCollection, {
         [name: string]: any;

package/lib/controllers/geo.js

@@ -59,7 +59,7 @@ var amenity_1 = require("../models/amenity");
 var main_1 = require("../components/map/main");
 var turf_1 = require("@turf/turf");
 var getFeatures = function (_a) {
-    var initPolygons = _a.initPolygons, autoLabelLines = _a.autoLabelLines, hiddenAmenities = _a.hiddenAmenities, useTimerangeData = _a.useTimerangeData;
+    var initPolygons = _a.initPolygons, autoLabelLines = _a.autoLabelLines, hiddenAmenities = _a.hiddenAmenities, useTimerangeData = _a.useTimerangeData, filter = _a.filter;
     return __awaiter(void 0, void 0, void 0, function () {
         var url, res, featuresToAdd_1, shopPolygons_1, labelLineFeatures_1;
         return __generator(this, function (_b) {
@@ -76,16 +76,42 @@ var getFeatures = function (_a) {
                         if (useTimerangeData) {
                             res.data.features = res.data.features
                                 .map(function (feature) {
-                                if (feature.properties && feature.properties.type === 'poi') {
-                                    if (feature.properties.metadata &&
-                                        feature.properties.metadata.dateStart &&
-                                        feature.properties.metadata.dateEnd &&
-                                        feature.properties.metadata.dateStart <= Date.now() &&
+                                var _a, _b;
+                                if (feature.properties && ((_a = feature.properties.metadata) === null || _a === void 0 ? void 0 : _a.dateStart) && ((_b = feature.properties.metadata) === null || _b === void 0 ? void 0 : _b.dateEnd)) {
+                                    // if feature have dateStart and dateEnd check the range and filter
+                                    if (feature.properties.metadata.dateStart <= Date.now() &&
                                         feature.properties.metadata.dateEnd >= Date.now()) {
+                                        // if feature is in range return feature
                                         return feature;
                                     }
+                                    else {
+                                        // if feature is outside of range return undefined
+                                        return undefined;
+                                    }
+                                }
+                                else {
+                                    // if feature dont have dateStart and dateEnd return feature
+                                    return feature;
+                                }
+                            })
+                                .filter(function (feature) { return feature !== undefined; });
+                        }
+                        if (filter && filter.key && filter.value) {
+                            res.data.features = res.data.features
+                                .map(function (feature) {
+                                if (common_1.getNestedObjectValue(feature, filter.key)) {
+                                    // if feature filter property exists
+                                    if (common_1.getNestedObjectValue(feature, filter.key) === filter.value) {
+                                        // if feature property value is same as filter value
+                                        return feature;
+                                    }
+                                    else {
+                                        // if they are not same
+                                        return undefined;
+                                    }
                                 }
                                 else {
+                                    // if feature filter property does not exists
                                     return feature;
                                 }
                             })

package/lib/controllers/repository.d.ts

@@ -3,12 +3,16 @@ import { FloorModel } from '../models/floor';
 import StyleModel from '../models/style';
 import { FeatureCollection } from '../models/feature';
 import { AmenityModel } from '../models/amenity';
-export declare const getPackage: ({ initPolygons, autoLabelLines, amenityIdProperty, hiddenAmenities, useTimerangeData, }: {
+export declare const getPackage: ({ initPolygons, autoLabelLines, amenityIdProperty, hiddenAmenities, useTimerangeData, filter, }: {
     initPolygons?: boolean;
     autoLabelLines?: boolean;
     amenityIdProperty?: string;
     hiddenAmenities?: string[];
     useTimerangeData?: boolean;
+    filter?: {
+        key: string;
+        value: string;
+    };
 }) => Promise<{
     places: PlaceModel[];
     floors: FloorModel[];
@@ -18,12 +22,16 @@ export declare const getPackage: ({ initPolygons, autoLabelLines, amenityIdPrope
     amenities: AmenityModel[];
 }>;
 declare const _default: {
-    getPackage: ({ initPolygons, autoLabelLines, amenityIdProperty, hiddenAmenities, useTimerangeData, }: {
+    getPackage: ({ initPolygons, autoLabelLines, amenityIdProperty, hiddenAmenities, useTimerangeData, filter, }: {
         initPolygons?: boolean;
         autoLabelLines?: boolean;
         amenityIdProperty?: string;
         hiddenAmenities?: string[];
         useTimerangeData?: boolean;
+        filter?: {
+            key: string;
+            value: string;
+        };
     }) => Promise<{
         places: PlaceModel[];
         floors: FloorModel[];

package/lib/controllers/repository.js

@@ -42,7 +42,7 @@ var floors_1 = require("./floors");
 var style_1 = require("./style");
 var geo_1 = require("./geo");
 var getPackage = function (_a) {
-    var initPolygons = _a.initPolygons, autoLabelLines = _a.autoLabelLines, amenityIdProperty = _a.amenityIdProperty, hiddenAmenities = _a.hiddenAmenities, useTimerangeData = _a.useTimerangeData;
+    var initPolygons = _a.initPolygons, autoLabelLines = _a.autoLabelLines, amenityIdProperty = _a.amenityIdProperty, hiddenAmenities = _a.hiddenAmenities, useTimerangeData = _a.useTimerangeData, filter = _a.filter;
     return __awaiter(void 0, void 0, void 0, function () {
         var result, promises;
         return __generator(this, function (_b) {
@@ -54,7 +54,7 @@ var getPackage = function (_a) {
                         floors_1.getFloors().then(function (floors) { return (result.floors = floors.data); }),
                         style_1.getStyle().then(function (style) { return (result.style = style); }),
                         style_1.getStyles().then(function (styles) { return (result.styles = styles); }),
-                        geo_1.getFeatures({ initPolygons: initPolygons, autoLabelLines: autoLabelLines, hiddenAmenities: hiddenAmenities, useTimerangeData: useTimerangeData }).then(function (features) { return (result.features = features); }),
+                        geo_1.getFeatures({ initPolygons: initPolygons, autoLabelLines: autoLabelLines, hiddenAmenities: hiddenAmenities, useTimerangeData: useTimerangeData, filter: filter }).then(function (features) { return (result.features = features); }),
                         geo_1.getAmenities(amenityIdProperty).then(function (amenities) { return (result.amenities = amenities); }),
                     ];
                     return [4 /*yield*/, Promise.all(promises)];

package/lib/models/floor.d.ts

@@ -25,7 +25,9 @@ export declare class FloorModel extends BaseModel {
     editor?: FloorEditorModel;
     geopoint?: [number, number];
     remoteId?: string;
-    metadata?: object;
+    metadata?: {
+        [key: string]: string | undefined;
+    };
     constructor(data: any);
     get hasFloorplan(): boolean;
 }

package/lib/models/place.d.ts

@@ -9,6 +9,9 @@ export declare class PlaceModel extends BaseModel {
     };
     tags?: string[];
     remoteId?: string;
+    metadata?: {
+        [key: string]: string | undefined;
+    };
     constructor(data: any);
     get hasLocation(): boolean;
 }