bruce-models 3.9.1 → 3.9.3

package/dist/bruce-models.es5.js

@@ -73,6 +73,8 @@ var Api;
         ECacheKey["Plugin"] = "plugin";
         ECacheKey["PluginIndexFile"] = "pluginindexfile";
         ECacheKey["EntityHistoricData"] = "entityhistoricdata";
+        ECacheKey["EntityHistoricDataRec"] = "entityhistoricdatarec";
+        ECacheKey["EntityHistoricDataStats"] = "entityhistoricdatastats";
     })(ECacheKey = Api.ECacheKey || (Api.ECacheKey = {}));
     // 1 minute.
     Api.DEFAULT_CACHE_DURATION = 60 * 1000;
@@ -239,6 +241,13 @@ class CacheControl {
     RemoveByContains(text) {
         this.RemoveBy(key => String(key).includes(String(text)));
     }
+    /**
+     * Removes items based on a callback's response.
+     * @param callback
+     */
+    RemoveByCallback(callback) {
+        this.RemoveBy(callback);
+    }
 }
 
 // TODO: Currently checks for CSV vs json specifically,
@@ -3041,6 +3050,198 @@ var ZoomControl;
     })(EDisplayType = ZoomControl.EDisplayType || (ZoomControl.EDisplayType = {}));
 })(ZoomControl || (ZoomControl = {}));
 
+var EntityHistoricData;
+(function (EntityHistoricData) {
+    /**
+     * Returns historic data for an array of Entity IDs.
+     * A maximum number of records will be returned per Entity ID, this information is returned in the response.
+     * @param params
+     * @returns
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { entityIds, attrKey, dateTimeFrom, dateTimeTo, api, req } = params;
+            // Save time and just return a none response if no entity IDs are provided.
+            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+                return {
+                    limitPerEntity: 0,
+                    recordsByIds: {}
+                };
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (typeof attrKey != "string") {
+                attrKey = PathUtils.Wrap(attrKey);
+            }
+            const cacheKey = GetListCacheKey(entityIds, attrKey, dateTimeFrom, dateTimeTo);
+            const cached = api.GetCacheItem(cacheKey, req);
+            if (cached === null || cached === void 0 ? void 0 : cached.found) {
+                return cached.data;
+            }
+            const urlParams = new URLSearchParams();
+            for (const entityId of entityIds) {
+                urlParams.append("entityId", entityId);
+            }
+            urlParams.append("attrKey", attrKey);
+            urlParams.append("dateTimeFrom", dateTimeFrom);
+            urlParams.append("dateTimeTo", dateTimeTo);
+            const prom = api.GET(`v1/entity/historicData?${urlParams.toString()}`, Api.PrepReqParams(req));
+            api.SetCacheItem({
+                key: cacheKey,
+                value: prom,
+                req: req,
+                // Short cache. 30 seconds.
+                duration: 30000
+            });
+            return prom;
+        });
+    }
+    EntityHistoricData.GetList = GetList;
+    /**
+     * Returns historic data statistics for an array of Entity IDs.
+     * @param params
+     * @returns
+     */
+    function GetStats(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { entityIds, api, req } = params;
+            // Save time and just return a none response if no entity IDs are provided.
+            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+                return {
+                    stats: []
+                };
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            req = Api.PrepReqParams(req);
+            const cacheKey = GetStatsCacheKey(entityIds);
+            const cached = api.GetCacheItem(cacheKey, req);
+            if (cached === null || cached === void 0 ? void 0 : cached.found) {
+                return cached.data;
+            }
+            const prom = yield api.POST("v1/entity/historicData/stats", {
+                entityIds: entityIds
+            }, req);
+            api.SetCacheItem({
+                key: cacheKey,
+                value: prom,
+                req: req,
+                // Short cache. 60 seconds.
+                duration: 60000
+            });
+            return prom;
+        });
+    }
+    EntityHistoricData.GetStats = GetStats;
+    /**
+     * Creates or updates historic data records.
+     * Please note that the expected input/output does not include internal fields found inside the "Bruce" attribute.
+     * @param params
+     * @returns
+     */
+    function Update(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let { records, api, req } = params;
+            // Save time and just return a none response if no records are provided.
+            if (!(records === null || records === void 0 ? void 0 : records.length)) {
+                return {
+                    records: []
+                };
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const res = yield api.POST("v1/entity/historicData", {
+                records: records
+            }, Api.PrepReqParams(req));
+            // Kill cache for every unique attrKey.
+            let attrKeys = records.map(r => r.attrKey);
+            attrKeys = attrKeys.filter((v, i) => attrKeys.indexOf(v) === i);
+            for (const attrKey of attrKeys) {
+                api.Cache.RemoveByContains(Entity.GetHistoricContainsKey(attrKey));
+            }
+            // Kill any stats cache that includes any of the Entity IDs.
+            if ((_a = res.records) === null || _a === void 0 ? void 0 : _a.length) {
+                const entityIds = res.records.map(r => r.entityId).filter((v, i) => v && res.records.indexOf(v) === i);
+                ClearCacheByEntityIds(api, entityIds);
+            }
+            return res;
+        });
+    }
+    EntityHistoricData.Update = Update;
+    /**
+     * Deletes historic data records for an array of Entity IDs.
+     * This deletes all records within a provided key + range.
+     * @param params
+     * @returns
+     */
+    function Delete(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { entityIds, attrKey, dateTimeFrom, dateTimeTo, api, req } = params;
+            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+                return;
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!attrKey || !dateTimeFrom || !dateTimeTo) {
+                throw new Error("Invalid parameters provided.");
+            }
+            if (typeof attrKey != "string") {
+                attrKey = PathUtils.Wrap(attrKey);
+            }
+            const urlParams = new URLSearchParams();
+            for (const entityId of entityIds) {
+                urlParams.append("entityId", entityId);
+            }
+            urlParams.append("attrKey", attrKey);
+            urlParams.append("dateTimeFrom", dateTimeFrom);
+            urlParams.append("dateTimeTo", dateTimeTo);
+            yield api.DELETE(`v1/entity/historicData?${urlParams.toString()}`, Api.PrepReqParams(req));
+            // Kill cache for all Entity cached Entity records related to the attrKey.
+            api.Cache.RemoveByContains(Entity.GetHistoricContainsKey(attrKey));
+            // Kill any stats cache that includes any of the Entity IDs.
+            ClearCacheByEntityIds(api, entityIds);
+        });
+    }
+    EntityHistoricData.Delete = Delete;
+    function GetListCacheKey(entityIds, attrKey, dateTimeFrom, dateTimeTo) {
+        return Api.ECacheKey.EntityHistoricDataRec + Api.ECacheKey.Id + entityIds.join(",") + Api.ECacheKey.Id + attrKey + Api.ECacheKey.Id + dateTimeFrom + Api.ECacheKey.Id + dateTimeTo;
+    }
+    EntityHistoricData.GetListCacheKey = GetListCacheKey;
+    function GetStatsCacheKey(entityIds) {
+        return Api.ECacheKey.EntityHistoricDataStats + Api.ECacheKey.Id + entityIds.join(",");
+    }
+    EntityHistoricData.GetStatsCacheKey = GetStatsCacheKey;
+    function ClearCacheByEntityIds(api, entityIds) {
+        if (!api || !(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+            return;
+        }
+        const REC_KEY_PREFIX = Api.ECacheKey.EntityHistoricDataRec + Api.ECacheKey.Id;
+        const STATS_KEY_PREFIX = Api.ECacheKey.EntityHistoricDataStats + Api.ECacheKey.Id;
+        api.Cache.RemoveByCallback((key) => {
+            let keyStr = String(key);
+            if (!keyStr.startsWith(STATS_KEY_PREFIX) && !keyStr.startsWith(REC_KEY_PREFIX)) {
+                return false;
+            }
+            // Shorten to speed up the next step.
+            keyStr = keyStr.replace(STATS_KEY_PREFIX, "").replace(REC_KEY_PREFIX, "");
+            // Look for any matching Entity IDs.
+            for (let i = 0; i < entityIds.length; i++) {
+                const entityId = entityIds[i];
+                if (keyStr.includes(entityId)) {
+                    return true;
+                }
+            }
+            return false;
+        });
+    }
+    EntityHistoricData.ClearCacheByEntityIds = ClearCacheByEntityIds;
+})(EntityHistoricData || (EntityHistoricData = {}));
+
 /**
  * Describes the "Entity" concept within Nextspace.
  * An entity is a JSON blob containing both internal data and user-defined data.
@@ -3125,7 +3326,7 @@ var Entity;
      */
     function GetListByIds(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, entityIds, req: reqParams, expandRelations, expandLocation, historicFrom, historicKey, historicTo } = params;
+            let { api, entityIds, req: reqParams, expandRelations, expandLocation, historicFrom, historicKey, historicTo, historicPoint } = params;
             if (!entityIds.length) {
                 throw ("Entity IDs are required.");
             }
@@ -3159,6 +3360,18 @@ var Entity;
             else if (expandLocation) {
                 reqData["Expand"] = "location";
             }
+            if (historicKey) {
+                reqData["historicKey"] = historicKey;
+            }
+            if (historicFrom) {
+                reqData["historicFrom"] = historicFrom;
+            }
+            if (historicTo) {
+                reqData["historicTo"] = historicTo;
+            }
+            if (historicPoint) {
+                reqData["historicPoint"] = historicPoint;
+            }
             const reqs = [];
             if (reqIds.length > 0) {
                 const req = api.POST("entities", reqData, Api.PrepReqParams(reqParams));
@@ -3171,7 +3384,8 @@ var Entity;
                         entityTypeId: null,
                         historicFrom: historicFrom,
                         historicKey: historicKey,
-                        historicTo: historicTo
+                        historicTo: historicTo,
+                        historicPoint: historicPoint
                     });
                     const prom = new Promise((res) => __awaiter(this, void 0, void 0, function* () {
                         try {
@@ -3229,6 +3443,7 @@ var Entity;
             }
             yield api.DELETE(`entity/${entityId}`, Api.PrepReqParams(reqParams));
             api.Cache.RemoveByContains(GetContainsKey(entityId));
+            EntityHistoricData.ClearCacheByEntityIds(api, [entityId]);
         });
     }
     Entity.Delete = Delete;
@@ -3252,6 +3467,7 @@ var Entity;
                 const entityId = entityIds[i];
                 api.Cache.RemoveByContains(GetContainsKey(entityId));
             }
+            EntityHistoricData.ClearCacheByEntityIds(api, entityIds);
         });
     }
     Entity.DeleteList = DeleteList;
@@ -3276,6 +3492,7 @@ var Entity;
             const reqUrl = `entity/${data.Bruce.ID}/?dataoverride=${override}&BruceEntityType=${data.Bruce["EntityType.ID"]}`;
             const res = yield api.POST(reqUrl, data, Api.PrepReqParams(reqParams));
             api.Cache.RemoveByContains(GetContainsKey(data.Bruce.ID));
+            EntityHistoricData.ClearCacheByEntityIds(api, [data.Bruce.ID]);
             return {
                 entity: res
             };
@@ -6801,131 +7018,6 @@ var EntityAttribute;
     EntityAttribute.AddAttribute = AddAttribute;
 })(EntityAttribute || (EntityAttribute = {}));
 
-var EntityHistoricData;
-(function (EntityHistoricData) {
-    /**
-     * Returns historic data for an array of Entity IDs.
-     * A maximum number of records will be returned per Entity ID, this information is returned in the response.
-     * @param params
-     * @returns
-     */
-    function GetList(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let { entityIds, attrKey, dateTimeFrom, dateTimeTo, api, req } = params;
-            // Save time and just return a none response if no entity IDs are provided.
-            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
-                return {
-                    limitPerEntity: 0,
-                    recordsByIds: {}
-                };
-            }
-            if (!api) {
-                api = ENVIRONMENT.Api().GetBruceApi();
-            }
-            if (typeof attrKey != "string") {
-                attrKey = PathUtils.Wrap(attrKey);
-            }
-            const urlParams = new URLSearchParams();
-            for (const entityId of entityIds) {
-                urlParams.append("entityId", entityId);
-            }
-            urlParams.append("attrKey", attrKey);
-            urlParams.append("dateTimeFrom", dateTimeFrom);
-            urlParams.append("dateTimeTo", dateTimeTo);
-            return yield api.GET(`v1/entity/historicData?${urlParams.toString()}`, Api.PrepReqParams(req));
-        });
-    }
-    EntityHistoricData.GetList = GetList;
-    /**
-     * Returns historic data statistics for an array of Entity IDs.
-     * @param params
-     * @returns
-     */
-    function GetStats(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let { entityIds, api, req } = params;
-            // Save time and just return a none response if no entity IDs are provided.
-            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
-                return {
-                    stats: []
-                };
-            }
-            if (!api) {
-                api = ENVIRONMENT.Api().GetBruceApi();
-            }
-            return yield api.POST("v1/entity/historicData/stats", {
-                entityIds: entityIds
-            }, Api.PrepReqParams(req));
-        });
-    }
-    EntityHistoricData.GetStats = GetStats;
-    /**
-     * Creates or updates historic data records.
-     * Please note that the expected input/output does not include internal fields found inside the "Bruce" attribute.
-     * @param params
-     * @returns
-     */
-    function Update(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let { records, api, req } = params;
-            // Save time and just return a none response if no records are provided.
-            if (!(records === null || records === void 0 ? void 0 : records.length)) {
-                return {
-                    records: []
-                };
-            }
-            if (!api) {
-                api = ENVIRONMENT.Api().GetBruceApi();
-            }
-            const res = yield api.POST("v1/entity/historicData", {
-                records: records
-            }, Api.PrepReqParams(req));
-            // Kill cache for every unique attrKey.
-            let attrKeys = records.map(r => r.attrKey);
-            attrKeys = attrKeys.filter((v, i) => attrKeys.indexOf(v) === i);
-            for (const attrKey of attrKeys) {
-                api.Cache.RemoveByContains(Entity.GetHistoricContainsKey(attrKey));
-            }
-            return res;
-        });
-    }
-    EntityHistoricData.Update = Update;
-    /**
-     * Deletes historic data records for an array of Entity IDs.
-     * This deletes all records within a provided key + range.
-     * @param params
-     * @returns
-     */
-    function Delete(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let { entityIds, attrKey, dateTimeFrom, dateTimeTo, api, req } = params;
-            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
-                return;
-            }
-            if (!api) {
-                api = ENVIRONMENT.Api().GetBruceApi();
-            }
-            if (!attrKey || !dateTimeFrom || !dateTimeTo) {
-                throw new Error("Invalid parameters provided.");
-            }
-            if (typeof attrKey != "string") {
-                attrKey = PathUtils.Wrap(attrKey);
-            }
-            const urlParams = new URLSearchParams();
-            for (const entityId of entityIds) {
-                urlParams.append("entityId", entityId);
-            }
-            urlParams.append("attrKey", attrKey);
-            urlParams.append("dateTimeFrom", dateTimeFrom);
-            urlParams.append("dateTimeTo", dateTimeTo);
-            yield api.DELETE(`v1/entity/historicData?${urlParams.toString()}`, Api.PrepReqParams(req));
-            // Kill cache for all Entity cached Entity records related to the attrKey.
-            api.Cache.RemoveByContains(Entity.GetHistoricContainsKey(attrKey));
-        });
-    }
-    EntityHistoricData.Delete = Delete;
-})(EntityHistoricData || (EntityHistoricData = {}));
-
 /**
  * Utility for uploading files.
  */
@@ -11417,7 +11509,7 @@ var DataSource;
 })(DataSource || (DataSource = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "3.9.1";
+const VERSION = "3.9.3";
 
 export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityTypeVisualSettings, EntityAttribute, EntityHistoricData, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, ImportCad, ImportCsv, ImportJson, ImportKml, ImportedFile, Markup, Uploader, Plugin, ENVIRONMENT, DataSource };
 //# sourceMappingURL=bruce-models.es5.js.map