bruce-models 3.8.4 → 3.8.6

package/dist/bruce-models.umd.js

@@ -77,6 +77,7 @@
             ECacheKey["ImportedFile"] = "importedfile";
             ECacheKey["Plugin"] = "plugin";
             ECacheKey["PluginIndexFile"] = "pluginindexfile";
+            ECacheKey["EntityHistoricData"] = "entityhistoricdata";
         })(ECacheKey = Api.ECacheKey || (Api.ECacheKey = {}));
         // 1 minute.
         Api.DEFAULT_CACHE_DURATION = 60 * 1000;
@@ -2819,6 +2820,53 @@
             });
         }
         EntityType.Update = Update;
+        /**
+         * Starts a re-index background action on a specified Entity Type.
+         * This will ensure searchable data follows the current schema version.
+         * This will also perform certain data cleanup so that the data is consistent.
+         * @param params
+         * @returns
+         */
+        function ReIndex(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, entityTypeId: typeId, req } = params;
+                if (!typeId) {
+                    throw ("Type ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const urlParams = new URLSearchParams();
+                if (params.dataTransformId) {
+                    urlParams.append("dataTransformID", String(params.dataTransformId));
+                }
+                const url = `entitytype/${typeId}/reindex?${urlParams.toString()}`;
+                req = exports.Api.PrepReqParams(req);
+                const pa = yield api.POST(url, {}, req);
+                return pa;
+            });
+        }
+        EntityType.ReIndex = ReIndex;
+        /**
+         * Counts the total number of Entities in an Entity Type.
+         * @param params
+         * @returns
+         */
+        function Count(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { entityTypeId, api, req } = params;
+                if (!entityTypeId) {
+                    throw ("Type ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const url = `entityType/${entityTypeId}/entitiesCount`;
+                const { TotalEntities } = yield api.GET(url, exports.Api.PrepReqParams(req));
+                return TotalEntities;
+            });
+        }
+        EntityType.Count = Count;
         /**
          * Returns cache identifier for an entity type.
          * Example: {
@@ -2950,7 +2998,7 @@
          */
         function Get(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, entityId, req: reqParams, expandLocation, expandRelations, entityTypeId } = params;
+                let { api, entityId, req: reqParams, expandLocation, expandRelations, entityTypeId, historicFrom, historicKey, historicTo } = params;
                 if (!entityId) {
                     throw ("Entity ID is required.");
                 }
@@ -2961,7 +3009,10 @@
                     entityId,
                     entityTypeId,
                     expandLocation,
-                    expandRelations
+                    expandRelations,
+                    historicFrom,
+                    historicKey,
+                    historicTo
                 });
                 const cache = api.GetCacheItem(key, reqParams);
                 if (cache === null || cache === void 0 ? void 0 : cache.found) {
@@ -3004,7 +3055,7 @@
          */
         function GetListByIds(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, entityIds, req: reqParams, expandRelations, expandLocation } = params;
+                let { api, entityIds, req: reqParams, expandRelations, expandLocation, historicFrom, historicKey, historicTo } = params;
                 if (!entityIds.length) {
                     throw ("Entity IDs are required.");
                 }
@@ -3043,7 +3094,15 @@
                     const req = api.POST("entities", reqData, exports.Api.PrepReqParams(reqParams));
                     for (let i = 0; i < reqIds.length; i++) {
                         const entityId = reqIds[i];
-                        const key = GetCacheKey({ entityId, expandLocation, expandRelations });
+                        const key = GetCacheKey({
+                            entityId,
+                            expandLocation,
+                            expandRelations,
+                            entityTypeId: null,
+                            historicFrom: historicFrom,
+                            historicKey: historicKey,
+                            historicTo: historicTo
+                        });
                         const prom = new Promise((res) => __awaiter(this, void 0, void 0, function* () {
                             try {
                                 const data = yield req;
@@ -3324,7 +3383,7 @@
         function GetList(params) {
             var _a;
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, filter, req: reqParams, viaCdn, viaCdnCacheToken, analysis, expandRelations } = params;
+                let { api, filter, req: reqParams, viaCdn, viaCdnCacheToken, analysis, expandRelations, historicFrom, historicKey, historicTo } = params;
                 if (!api) {
                     api = exports.ENVIRONMENT.Api().GetBruceApi();
                 }
@@ -3425,7 +3484,12 @@
                             api.SetCacheItem({
                                 key: GetCacheKey({
                                     entityId: id,
-                                    expandRelations
+                                    expandRelations,
+                                    expandLocation: false,
+                                    entityTypeId: filter.entityTypeId,
+                                    historicFrom: historicFrom,
+                                    historicKey: historicKey,
+                                    historicTo: historicTo
                                 }),
                                 value: {
                                     entity: entity
@@ -3573,11 +3637,23 @@
          * @returns
          */
         function GetCacheKey(params) {
-            let { entityId, entityTypeId, expandLocation, expandRelations } = params;
+            let { entityId, entityTypeId, expandLocation, expandRelations, historicFrom, historicKey, historicTo } = params;
             if (!entityTypeId) {
                 entityTypeId = "";
             }
-            return `${exports.Api.ECacheKey.Entity}${exports.Api.ECacheKey.Id}${entityId}${String(entityTypeId)}${String(Boolean(expandLocation))}${String(Boolean(expandRelations))}`;
+            if (!historicKey) {
+                historicKey = "";
+            }
+            if (!historicFrom) {
+                historicFrom = "";
+            }
+            if (!historicTo) {
+                historicTo = "";
+            }
+            let key = `${exports.Api.ECacheKey.Entity}${exports.Api.ECacheKey.Id}${entityId}${String(entityTypeId)}`;
+            key += `${String(Boolean(expandLocation))}${String(Boolean(expandRelations))}`;
+            key += `${exports.Api.ECacheKey.EntityHistoricData}${exports.Api.ECacheKey.Id}${historicKey}${historicFrom}${historicTo}`;
+            return key;
         }
         Entity.GetCacheKey = GetCacheKey;
         /**
@@ -3594,6 +3670,18 @@
             return `${exports.Api.ECacheKey.Entity}${exports.Api.ECacheKey.Id}${entityId}`;
         }
         Entity.GetContainsKey = GetContainsKey;
+        /**
+         * Returns cache identifier for entity records that have historic data.
+         * @param attrKey
+         * @returns
+         */
+        function GetHistoricContainsKey(attrKey) {
+            if (!attrKey) {
+                attrKey = "";
+            }
+            return `${exports.Api.ECacheKey.EntityHistoricData}${exports.Api.ECacheKey.Id}${attrKey}`;
+        }
+        Entity.GetHistoricContainsKey = GetHistoricContainsKey;
     })(exports.Entity || (exports.Entity = {}));
 
     /**
@@ -6540,6 +6628,130 @@
         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.
         /**
@@ -9818,6 +10030,8 @@
             EFeature["EntityJsonData"] = "Feature_Entity_JSONData";
             // Flag to enable a text search against JSON data values.
             // 'EntityJsonData' must also be enabled.
+            // @WARNING: Please re-index all Entities first before enabling this feature.
+            // Without this the raw 2D geometry will be indexed which will make it much slower, and may cause the update of the flag to fail.
             EFeature["EntityLexicalSearch"] = "Feature_Entity_Lexical_Search";
         })(EFeature = AccountFeatures.EFeature || (AccountFeatures.EFeature = {}));
         /**
@@ -10908,7 +11122,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "3.8.4";
+    const VERSION = "3.8.6";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;