@mapvx/web-js 1.5.0 → 1.6.0-dev.2

package/dist/umd/index.js

@@ -6814,7 +6814,7 @@ var rollbar_umd_min_default = /*#__PURE__*/__webpack_require__.n(rollbar_umd_min
 // version placeholder is replaced with the package version by
 // scripts/inject-build-defines.js. The access token falls back to the MapVX
 // SDK-web Rollbar project token when none is injected at build time.
-var SDK_VERSION =  true ? "1.5.0" : 0;
+var SDK_VERSION =  true ? "1.6.0-dev.2" : 0;
 var ACCESS_TOKEN =  false ? 0 : "28279d52df43411ebd138c2bee0ab1df";
 var _rollbarConfig = {
   accessToken: ACCESS_TOKEN,
@@ -6861,7 +6861,7 @@ function logger_toPrimitive(t, r) { if ("object" != logger_typeof(t) || !t) retu
 // by scripts/inject-build-defines.js. The Countly key falls back to the
 // MapVX key when none is injected at build time.
 var IS_DEBUG =  true ? false : 0;
-var logger_SDK_VERSION =  true ? "1.5.0" : 0;
+var logger_SDK_VERSION =  true ? "1.6.0-dev.2" : 0;
 var COUNTLY_API_KEY =  false ? 0 : "f0c8d3b96d336e857a8628f49dd1baf7d7add0e9";
 var logger_countly = {
   apiKey: COUNTLY_API_KEY,
@@ -10755,6 +10755,30 @@ function place_toPrimitive(t, r) { if ("object" != place_typeof(t) || !t) return
 
 
 
+/**
+ * Query used to look up a single place.
+ *
+ * The {@link PlaceQuery.id} can be an internal alias defined by the integrator.
+ * Because aliases are not guaranteed to be globally unique (the same alias may be
+ * reused across different buildings/venues, e.g. the same store alias present in
+ * several shopping malls), provide {@link PlaceQuery.buildingId} —and optionally
+ * {@link PlaceQuery.floorId}— to disambiguate which place the alias refers to.
+ *
+ * This mirrors the disambiguation already available for routes via `IdLocation`.
+ *
+ * @example
+ * ```typescript
+ * // Resolve an alias reused across several malls by pinning the building.
+ * const query: PlaceQuery = {
+ *   id: "store-204",            // integrator alias, may repeat across buildings
+ *   buildingId: "mall-santiago",
+ *   floorId: "level-2",         // optional; takes precedence over `level`
+ * }
+ * ```
+ *
+ * @group Places & Locations
+ */
+
 /**
  * MapVX place object, is a custom object containing data of a specific real place.
  * Represents a physical location with all its associated metadata and properties.
@@ -11625,16 +11649,23 @@ var Requester = /*#__PURE__*/function () {
       return fetchPlacesFromAnyInstitution;
     }()
     /**
-     * Obtain info about specific place. Use mainly to obtain innerFloors
-     * @param placeId
+     * Obtain info about specific place. Use mainly to obtain innerFloors.
+     *
+     * When `placeId` is an internal alias that may be reused across buildings, pass
+     * `buildingId` (and optionally `floorId`/`level`) to disambiguate which venue the
+     * alias refers to. `floorId` takes precedence over the numeric `level`.
      * @param token
+     * @param placeId
+     * @param buildingId (Optional) Parent building/venue that contains the place.
+     * @param floorId (Optional) Floor ID within the building.
+     * @param level (Optional) Numeric floor level; used only when `floorId` is absent.
      * @returns
      */
     )
   }, {
     key: "fetchPlaceDetail",
     value: (function () {
-      var _fetchPlaceDetail = requester_asyncToGenerator(/*#__PURE__*/requester_regenerator().m(function _callee8(token, placeId) {
+      var _fetchPlaceDetail = requester_asyncToGenerator(/*#__PURE__*/requester_regenerator().m(function _callee8(token, placeId, buildingId, floorId, level) {
         var options, params;
         return requester_regenerator().w(function (_context8) {
           while (1) switch (_context8.n) {
@@ -11650,11 +11681,19 @@ var Requester = /*#__PURE__*/function () {
                 place_id: placeId,
                 lang: this.lang
               };
+              if (buildingId !== undefined) {
+                params.building = buildingId;
+              }
+              if (floorId !== undefined) {
+                params.floor = floorId;
+              } else if (level !== undefined) {
+                params.floor = level;
+              }
               return _context8.a(2, this.fetchFromUrl(this.baseUrl + "place", params, options));
           }
         }, _callee8, this);
       }));
-      function fetchPlaceDetail(_x14, _x15) {
+      function fetchPlaceDetail(_x14, _x15, _x16, _x17, _x18) {
         return _fetchPlaceDetail.apply(this, arguments);
       }
       return fetchPlaceDetail;
@@ -11664,8 +11703,15 @@ var Requester = /*#__PURE__*/function () {
      * Can be used to obtain any place detail, without the limitation of the ApiKey.
      * Therefore, does not make use of an ApiKey but rather an authentication token.
      *
-     * @param token - The authentication token used for authorization in the request header.
+     * When `placeId` is an internal alias that may be reused across buildings, pass
+     * `buildingId` (and optionally `floorId`/`level`) to disambiguate which venue the
+     * alias refers to. `floorId` takes precedence over the numeric `level`.
+     *
+     * @param authToken - The authentication token used for authorization in the request header.
      * @param placeId - The unique identifier of the place to retrieve details for.
+     * @param buildingId - (Optional) Parent building/venue that contains the place.
+     * @param floorId - (Optional) Floor ID within the building.
+     * @param level - (Optional) Numeric floor level; used only when `floorId` is absent.
      * @returns A promise that resolves to the HTTP response containing the place details.
      *
      */
@@ -11673,7 +11719,7 @@ var Requester = /*#__PURE__*/function () {
   }, {
     key: "fetchAnyPlaceDetail",
     value: (function () {
-      var _fetchAnyPlaceDetail = requester_asyncToGenerator(/*#__PURE__*/requester_regenerator().m(function _callee9(authToken, placeId) {
+      var _fetchAnyPlaceDetail = requester_asyncToGenerator(/*#__PURE__*/requester_regenerator().m(function _callee9(authToken, placeId, buildingId, floorId, level) {
         var options, params;
         return requester_regenerator().w(function (_context9) {
           while (1) switch (_context9.n) {
@@ -11689,11 +11735,19 @@ var Requester = /*#__PURE__*/function () {
                 place_id: placeId,
                 lang: this.lang
               };
+              if (buildingId !== undefined) {
+                params.building = buildingId;
+              }
+              if (floorId !== undefined) {
+                params.floor = floorId;
+              } else if (level !== undefined) {
+                params.floor = level;
+              }
               return _context9.a(2, this.fetchFromUrl(this.baseUrlPortal + "place", params, options));
           }
         }, _callee9, this);
       }));
-      function fetchAnyPlaceDetail(_x16, _x17) {
+      function fetchAnyPlaceDetail(_x19, _x20, _x21, _x22, _x23) {
         return _fetchAnyPlaceDetail.apply(this, arguments);
       }
       return fetchAnyPlaceDetail;
@@ -11728,7 +11782,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee0, this);
       }));
-      function fetchSubPlaces(_x18, _x19) {
+      function fetchSubPlaces(_x24, _x25) {
         return _fetchSubPlaces.apply(this, arguments);
       }
       return fetchSubPlaces;
@@ -11769,7 +11823,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee1, this);
       }));
-      function fetchAnySubPlaces(_x20, _x21) {
+      function fetchAnySubPlaces(_x26, _x27) {
         return _fetchAnySubPlaces.apply(this, arguments);
       }
       return fetchAnySubPlaces;
@@ -11890,7 +11944,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee10, this);
       }));
-      function fetchRoute(_x22, _x23) {
+      function fetchRoute(_x28, _x29) {
         return _fetchRoute.apply(this, arguments);
       }
       return fetchRoute;
@@ -11921,7 +11975,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee11, this);
       }));
-      function fetchRouteV2(_x24, _x25) {
+      function fetchRouteV2(_x30, _x31) {
         return _fetchRouteV.apply(this, arguments);
       }
       return fetchRouteV2;
@@ -11956,7 +12010,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee12, this);
       }));
-      function fetchInstitutions(_x26) {
+      function fetchInstitutions(_x32) {
         return _fetchInstitutions.apply(this, arguments);
       }
       return fetchInstitutions;
@@ -12013,7 +12067,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee13, this);
       }));
-      function fetchSearchResults(_x27, _x28, _x29, _x30, _x31, _x32, _x33, _x34) {
+      function fetchSearchResults(_x33, _x34, _x35, _x36, _x37, _x38, _x39, _x40) {
         return _fetchSearchResults.apply(this, arguments);
       }
       return fetchSearchResults;
@@ -12081,7 +12135,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee14, this);
       }));
-      function fetchSearchPlacesByTags(_x35, _x36, _x37, _x38, _x39, _x40, _x41, _x42, _x43) {
+      function fetchSearchPlacesByTags(_x41, _x42, _x43, _x44, _x45, _x46, _x47, _x48, _x49) {
         return _fetchSearchPlacesByTags.apply(this, arguments);
       }
       return fetchSearchPlacesByTags;
@@ -12110,7 +12164,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee15, this);
       }));
-      function fetchConfiguration(_x44, _x45, _x46) {
+      function fetchConfiguration(_x50, _x51, _x52) {
         return _fetchConfiguration.apply(this, arguments);
       }
       return fetchConfiguration;
@@ -12138,7 +12192,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee16, this);
       }));
-      function fetchCategories(_x47, _x48) {
+      function fetchCategories(_x53, _x54) {
         return _fetchCategories.apply(this, arguments);
       }
       return fetchCategories;
@@ -12170,7 +12224,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee17, this);
       }));
-      function fetchRoutesForOrigin(_x49, _x50, _x51, _x52, _x53, _x54) {
+      function fetchRoutesForOrigin(_x55, _x56, _x57, _x58, _x59, _x60) {
         return _fetchRoutesForOrigin.apply(this, arguments);
       }
       return fetchRoutesForOrigin;
@@ -12197,7 +12251,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee18, this);
       }));
-      function fetchCacheTimestamp(_x55, _x56) {
+      function fetchCacheTimestamp(_x61, _x62) {
         return _fetchCacheTimestamp.apply(this, arguments);
       }
       return fetchCacheTimestamp;
@@ -12224,7 +12278,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee19, this);
       }));
-      function fetchCssCustomization(_x57, _x58) {
+      function fetchCssCustomization(_x63, _x64) {
         return _fetchCssCustomization.apply(this, arguments);
       }
       return fetchCssCustomization;
@@ -12257,7 +12311,7 @@ var Requester = /*#__PURE__*/function () {
           }
         }, _callee20, this);
       }));
-      function postHealth(_x59, _x60, _x61, _x62, _x63) {
+      function postHealth(_x65, _x66, _x67, _x68, _x69) {
         return _postHealth.apply(this, arguments);
       }
       return postHealth;
@@ -12529,13 +12583,15 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
   }, {
     key: "fetchAndParsePlaceDetail",
     value: function () {
-      var _fetchAndParsePlaceDetail = repository_asyncToGenerator(/*#__PURE__*/repository_regenerator().m(function _callee4(placeId) {
-        var cachedPlace, response, errorBody, responseData, place, _t4;
+      var _fetchAndParsePlaceDetail = repository_asyncToGenerator(/*#__PURE__*/repository_regenerator().m(function _callee4(query) {
+        var id, buildingId, floorId, level, cacheKey, cachedPlace, response, errorBody, responseData, place, _t4;
         return repository_regenerator().w(function (_context4) {
           while (1) switch (_context4.p = _context4.n) {
             case 0:
               _context4.p = 0;
-              cachedPlace = this.cache.getPlace(placeId, this.currentLang);
+              id = query.id, buildingId = query.buildingId, floorId = query.floorId, level = query.level;
+              cacheKey = this.placeCacheKey(id, buildingId);
+              cachedPlace = this.cache.getPlace(cacheKey, this.currentLang);
               if (!(cachedPlace != null)) {
                 _context4.n = 1;
                 break;
@@ -12546,7 +12602,7 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
               return _context4.a(2, cachedPlace);
             case 1:
               _context4.n = 2;
-              return this.requester.fetchPlaceDetail(this.token, placeId);
+              return this.requester.fetchPlaceDetail(this.token, id, buildingId, floorId, level);
             case 2:
               response = _context4.v;
               if (response.ok) {
@@ -12564,10 +12620,7 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
             case 5:
               responseData = _context4.v;
               place = new place_MVXPlace(responseData);
-              this.cache.setPlace(place.mapvxId, place, this.currentLang);
-              if (place.clientId != null) {
-                this.cache.setPlace(place.clientId, place, this.currentLang);
-              }
+              this.cachePlace(place, buildingId);
               this.logEvent("fetchAndParsePlaceDetail", {
                 cached: "false"
               });
@@ -12589,13 +12642,15 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
   }, {
     key: "fetchAndParseAnyPlaceDetail",
     value: function () {
-      var _fetchAndParseAnyPlaceDetail = repository_asyncToGenerator(/*#__PURE__*/repository_regenerator().m(function _callee5(placeId, authToken) {
-        var cachedPlace, response, errorBody, responseData, place, _t5;
+      var _fetchAndParseAnyPlaceDetail = repository_asyncToGenerator(/*#__PURE__*/repository_regenerator().m(function _callee5(query, authToken) {
+        var id, buildingId, floorId, level, cacheKey, cachedPlace, response, errorBody, responseData, place, _t5;
         return repository_regenerator().w(function (_context5) {
           while (1) switch (_context5.p = _context5.n) {
             case 0:
               _context5.p = 0;
-              cachedPlace = this.cache.getPlace(placeId, this.currentLang);
+              id = query.id, buildingId = query.buildingId, floorId = query.floorId, level = query.level;
+              cacheKey = this.placeCacheKey(id, buildingId);
+              cachedPlace = this.cache.getPlace(cacheKey, this.currentLang);
               if (!(cachedPlace != null)) {
                 _context5.n = 1;
                 break;
@@ -12606,7 +12661,7 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
               return _context5.a(2, cachedPlace);
             case 1:
               _context5.n = 2;
-              return this.requester.fetchAnyPlaceDetail(authToken, placeId);
+              return this.requester.fetchAnyPlaceDetail(authToken, id, buildingId, floorId, level);
             case 2:
               response = _context5.v;
               if (response.ok) {
@@ -12624,10 +12679,7 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
             case 5:
               responseData = _context5.v;
               place = new place_MVXPlace(responseData);
-              this.cache.setPlace(place.mapvxId, place, this.currentLang);
-              if (place.clientId != null) {
-                this.cache.setPlace(place.clientId, place, this.currentLang);
-              }
+              this.cachePlace(place, buildingId);
               this.logEvent("fetchAndParseAnyPlaceDetail", {
                 cached: "false"
               });
@@ -12646,6 +12698,30 @@ var Repository = /*#__PURE__*/function (_Loggeable) {
       }
       return fetchAndParseAnyPlaceDetail;
     }()
+    /**
+     * Build the cache key for a place lookup. The canonical `mapvxId` is globally
+     * unique, but integrator aliases (`clientId`) may be reused across buildings, so
+     * alias-based keys are namespaced by `buildingId` to prevent aliases from
+     * different venues from colliding in the cache.
+     */
+  }, {
+    key: "placeCacheKey",
+    value: function placeCacheKey(id, buildingId) {
+      return buildingId != null ? "".concat(id, "_").concat(buildingId) : id;
+    }
+
+    /**
+     * Cache a place under its globally-unique `mapvxId` and, when present, under its
+     * (possibly non-unique) `clientId` alias namespaced by `buildingId`.
+     */
+  }, {
+    key: "cachePlace",
+    value: function cachePlace(place, buildingId) {
+      this.cache.setPlace(place.mapvxId, place, this.currentLang);
+      if (place.clientId != null) {
+        this.cache.setPlace(this.placeCacheKey(place.clientId, buildingId), place, this.currentLang);
+      }
+    }
   }, {
     key: "fetchAndParseSubPlaces",
     value: function () {
@@ -14230,13 +14306,17 @@ var InternalMapVXMap = /*#__PURE__*/function (_Loggeable) {
     value: function initialPlaceDetailSetUp(parentPlaceId, withBearerToken) {
       var _this2 = this;
       if (withBearerToken) {
-        this.repository.fetchAndParseAnyPlaceDetail(parentPlaceId, withBearerToken).then(function (place) {
+        this.repository.fetchAndParseAnyPlaceDetail({
+          id: parentPlaceId
+        }, withBearerToken).then(function (place) {
           _this2.changeParentPlaceTo(place);
           _this2.potentialParentPlaces.push(place);
         })["catch"](console.error);
         return;
       }
-      this.repository.fetchAndParsePlaceDetail(parentPlaceId).then(function (place) {
+      this.repository.fetchAndParsePlaceDetail({
+        id: parentPlaceId
+      }).then(function (place) {
         _this2.changeParentPlaceTo(place);
         _this2.potentialParentPlaces.push(place);
       })["catch"](console.error);
@@ -14246,7 +14326,9 @@ var InternalMapVXMap = /*#__PURE__*/function (_Loggeable) {
     value: function loadOtherPotentialParentPlaces(ids) {
       var _this3 = this;
       Promise.all(ids.map(function (id) {
-        return _this3.repository.fetchAndParsePlaceDetail(id);
+        return _this3.repository.fetchAndParsePlaceDetail({
+          id: id
+        });
       })).then(function (places) {
         var _this3$potentialParen;
         (_this3$potentialParen = _this3.potentialParentPlaces).push.apply(_this3$potentialParen, map_toConsumableArray(places));
@@ -15662,7 +15744,9 @@ var InternalMapVXMap = /*#__PURE__*/function (_Loggeable) {
                 }
                 console.log("fetching place detail from server", ref);
                 _context2.n = 8;
-                return _this12.repository.fetchAndParsePlaceDetail(ref);
+                return _this12.repository.fetchAndParsePlaceDetail({
+                  id: ref
+                });
               case 8:
                 clickedPlace = _context2.v;
                 _context2.n = 10;
@@ -16409,6 +16493,17 @@ function sdk_toPrimitive(t, r) { if ("object" != sdk_typeof(t) || !t) return t;
  * @group Main
  */
 
+/**
+ * Normalize the argument accepted by the place-detail methods into a
+ * {@link PlaceQuery}. A plain string is treated as the place id/alias with no
+ * building/floor disambiguation, preserving backward compatibility.
+ */
+function normalizePlaceQuery(place) {
+  return typeof place === "string" ? {
+    id: place
+  } : place;
+}
+
 /**
  * Initialize the SDK.
  * @group Main
@@ -16495,20 +16590,21 @@ var InternalMapVXSDK = /*#__PURE__*/function (_Loggeable) {
   }, {
     key: "getPlaceDetail",
     value: function () {
-      var _getPlaceDetail = sdk_asyncToGenerator(/*#__PURE__*/sdk_regenerator().m(function _callee(id) {
-        var place, _t;
+      var _getPlaceDetail = sdk_asyncToGenerator(/*#__PURE__*/sdk_regenerator().m(function _callee(place) {
+        var query, result, _t;
         return sdk_regenerator().w(function (_context) {
           while (1) switch (_context.p = _context.n) {
             case 0:
               _context.p = 0;
+              query = normalizePlaceQuery(place);
               _context.n = 1;
-              return this.repository.fetchAndParsePlaceDetail(id);
+              return this.repository.fetchAndParsePlaceDetail(query);
             case 1:
-              place = _context.v;
+              result = _context.v;
               this.logEvent("getPlaceDetail", {
-                id: id
+                id: query.id
               });
-              return _context.a(2, place);
+              return _context.a(2, result);
             case 2:
               _context.p = 2;
               _t = _context.v;
@@ -16526,20 +16622,21 @@ var InternalMapVXSDK = /*#__PURE__*/function (_Loggeable) {
   }, {
     key: "getAnyPlaceDetail",
     value: function () {
-      var _getAnyPlaceDetail = sdk_asyncToGenerator(/*#__PURE__*/sdk_regenerator().m(function _callee2(id, authToken) {
-        var place, _t2;
+      var _getAnyPlaceDetail = sdk_asyncToGenerator(/*#__PURE__*/sdk_regenerator().m(function _callee2(place, authToken) {
+        var query, result, _t2;
         return sdk_regenerator().w(function (_context2) {
           while (1) switch (_context2.p = _context2.n) {
             case 0:
               _context2.p = 0;
+              query = normalizePlaceQuery(place);
               _context2.n = 1;
-              return this.repository.fetchAndParseAnyPlaceDetail(id, authToken);
+              return this.repository.fetchAndParseAnyPlaceDetail(query, authToken);
             case 1:
-              place = _context2.v;
+              result = _context2.v;
               this.logEvent("getAnyPlaceDetail", {
-                id: id
+                id: query.id
               });
-              return _context2.a(2, place);
+              return _context2.a(2, result);
             case 2:
               _context2.p = 2;
               _t2 = _context2.v;