bruce-models 3.8.4 → 3.8.5

package/dist/bruce-models.es5.js

@@ -72,6 +72,7 @@ var Api;
         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;
@@ -2864,6 +2865,53 @@ var EntityType;
         });
     }
     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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const urlParams = new URLSearchParams();
+            if (params.dataTransformId) {
+                urlParams.append("dataTransformID", String(params.dataTransformId));
+            }
+            const url = `entitytype/${typeId}/reindex?${urlParams.toString()}`;
+            req = 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const url = `entityType/${entityTypeId}/entitiesCount`;
+            const { TotalEntities } = yield api.GET(url, Api.PrepReqParams(req));
+            return TotalEntities;
+        });
+    }
+    EntityType.Count = Count;
     /**
      * Returns cache identifier for an entity type.
      * Example: {
@@ -3003,7 +3051,7 @@ var Entity;
      */
     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.");
             }
@@ -3014,7 +3062,10 @@ var Entity;
                 entityId,
                 entityTypeId,
                 expandLocation,
-                expandRelations
+                expandRelations,
+                historicFrom,
+                historicKey,
+                historicTo
             });
             const cache = api.GetCacheItem(key, reqParams);
             if (cache === null || cache === void 0 ? void 0 : cache.found) {
@@ -3057,7 +3108,7 @@ var Entity;
      */
     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.");
             }
@@ -3096,7 +3147,15 @@ var Entity;
                 const req = api.POST("entities", reqData, 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;
@@ -3377,7 +3436,7 @@ var Entity;
     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 = ENVIRONMENT.Api().GetBruceApi();
             }
@@ -3478,7 +3537,12 @@ var Entity;
                         api.SetCacheItem({
                             key: GetCacheKey({
                                 entityId: id,
-                                expandRelations
+                                expandRelations,
+                                expandLocation: false,
+                                entityTypeId: filter.entityTypeId,
+                                historicFrom: historicFrom,
+                                historicKey: historicKey,
+                                historicTo: historicTo
                             }),
                             value: {
                                 entity: entity
@@ -3626,11 +3690,23 @@ var Entity;
      * @returns
      */
     function GetCacheKey(params) {
-        let { entityId, entityTypeId, expandLocation, expandRelations } = params;
+        let { entityId, entityTypeId, expandLocation, expandRelations, historicFrom, historicKey, historicTo } = params;
         if (!entityTypeId) {
             entityTypeId = "";
         }
-        return `${Api.ECacheKey.Entity}${Api.ECacheKey.Id}${entityId}${String(entityTypeId)}${String(Boolean(expandLocation))}${String(Boolean(expandRelations))}`;
+        if (!historicKey) {
+            historicKey = "";
+        }
+        if (!historicFrom) {
+            historicFrom = "";
+        }
+        if (!historicTo) {
+            historicTo = "";
+        }
+        let key = `${Api.ECacheKey.Entity}${Api.ECacheKey.Id}${entityId}${String(entityTypeId)}`;
+        key += `${String(Boolean(expandLocation))}${String(Boolean(expandRelations))}`;
+        key += `${Api.ECacheKey.EntityHistoricData}${Api.ECacheKey.Id}${historicKey}${historicFrom}${historicTo}`;
+        return key;
     }
     Entity.GetCacheKey = GetCacheKey;
     /**
@@ -3647,6 +3723,18 @@ var Entity;
         return `${Api.ECacheKey.Entity}${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 `${Api.ECacheKey.EntityHistoricData}${Api.ECacheKey.Id}${attrKey}`;
+    }
+    Entity.GetHistoricContainsKey = GetHistoricContainsKey;
 })(Entity || (Entity = {}));
 
 /**
@@ -6677,6 +6765,131 @@ 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.
  */
@@ -10052,6 +10265,8 @@ var AccountFeatures;
         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 = {}));
     /**
@@ -11166,7 +11381,7 @@ var DataSource;
 })(DataSource || (DataSource = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "3.8.4";
+const VERSION = "3.8.5";
 
-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, 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 };
+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