bruce-models 3.9.1 → 3.9.3

package/dist/bruce-models.umd.js

@@ -78,6 +78,8 @@
             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;
@@ -244,6 +246,13 @@
         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,
@@ -2994,6 +3003,197 @@
         })(EDisplayType = ZoomControl.EDisplayType || (ZoomControl.EDisplayType = {}));
     })(exports.ZoomControl || (exports.ZoomControl = {}));
 
+    (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 = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                if (typeof attrKey != "string") {
+                    attrKey = exports.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()}`, exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                req = exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const res = yield api.POST("v1/entity/historicData", {
+                    records: records
+                }, exports.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(exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                if (!attrKey || !dateTimeFrom || !dateTimeTo) {
+                    throw new Error("Invalid parameters provided.");
+                }
+                if (typeof attrKey != "string") {
+                    attrKey = exports.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()}`, exports.Api.PrepReqParams(req));
+                // Kill cache for all Entity cached Entity records related to the attrKey.
+                api.Cache.RemoveByContains(exports.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 exports.Api.ECacheKey.EntityHistoricDataRec + exports.Api.ECacheKey.Id + entityIds.join(",") + exports.Api.ECacheKey.Id + attrKey + exports.Api.ECacheKey.Id + dateTimeFrom + exports.Api.ECacheKey.Id + dateTimeTo;
+        }
+        EntityHistoricData.GetListCacheKey = GetListCacheKey;
+        function GetStatsCacheKey(entityIds) {
+            return exports.Api.ECacheKey.EntityHistoricDataStats + exports.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 = exports.Api.ECacheKey.EntityHistoricDataRec + exports.Api.ECacheKey.Id;
+            const STATS_KEY_PREFIX = exports.Api.ECacheKey.EntityHistoricDataStats + exports.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;
+    })(exports.EntityHistoricData || (exports.EntityHistoricData = {}));
+
     (function (Entity) {
         /**
          * Returns an entity record for the given entity id.
@@ -3072,7 +3272,7 @@
          */
         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.");
                 }
@@ -3106,6 +3306,18 @@
                 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, exports.Api.PrepReqParams(reqParams));
@@ -3118,7 +3330,8 @@
                             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 {
@@ -3176,6 +3389,7 @@
                 }
                 yield api.DELETE(`entity/${entityId}`, exports.Api.PrepReqParams(reqParams));
                 api.Cache.RemoveByContains(GetContainsKey(entityId));
+                exports.EntityHistoricData.ClearCacheByEntityIds(api, [entityId]);
             });
         }
         Entity.Delete = Delete;
@@ -3199,6 +3413,7 @@
                     const entityId = entityIds[i];
                     api.Cache.RemoveByContains(GetContainsKey(entityId));
                 }
+                exports.EntityHistoricData.ClearCacheByEntityIds(api, entityIds);
             });
         }
         Entity.DeleteList = DeleteList;
@@ -3223,6 +3438,7 @@
                 const reqUrl = `entity/${data.Bruce.ID}/?dataoverride=${override}&BruceEntityType=${data.Bruce["EntityType.ID"]}`;
                 const res = yield api.POST(reqUrl, data, exports.Api.PrepReqParams(reqParams));
                 api.Cache.RemoveByContains(GetContainsKey(data.Bruce.ID));
+                exports.EntityHistoricData.ClearCacheByEntityIds(api, [data.Bruce.ID]);
                 return {
                     entity: res
                 };
@@ -6664,130 +6880,6 @@
         EntityAttribute.AddAttribute = AddAttribute;
     })(exports.EntityAttribute || (exports.EntityAttribute = {}));
 
-    (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 = exports.ENVIRONMENT.Api().GetBruceApi();
-                }
-                if (typeof attrKey != "string") {
-                    attrKey = exports.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()}`, exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
-                }
-                return yield api.POST("v1/entity/historicData/stats", {
-                    entityIds: entityIds
-                }, exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
-                }
-                const res = yield api.POST("v1/entity/historicData", {
-                    records: records
-                }, exports.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(exports.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 = exports.ENVIRONMENT.Api().GetBruceApi();
-                }
-                if (!attrKey || !dateTimeFrom || !dateTimeTo) {
-                    throw new Error("Invalid parameters provided.");
-                }
-                if (typeof attrKey != "string") {
-                    attrKey = exports.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()}`, exports.Api.PrepReqParams(req));
-                // Kill cache for all Entity cached Entity records related to the attrKey.
-                api.Cache.RemoveByContains(exports.Entity.GetHistoricContainsKey(attrKey));
-            });
-        }
-        EntityHistoricData.Delete = Delete;
-    })(exports.EntityHistoricData || (exports.EntityHistoricData = {}));
-
     (function (Uploader) {
         Uploader.MIN_LARGE_FILE_SIZE = 100000000; // 100MB.
         /**
@@ -11158,7 +11250,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "3.9.1";
+    const VERSION = "3.9.3";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;