bruce-models 1.9.8 → 2.0.0

package/dist/lib/entity/entity.js

@@ -1,320 +1,332 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Entity = void 0;
-const api_1 = require("../api/api");
-const object_utils_1 = require("../util/object-utils");
-const path_utils_1 = require("../util/path-utils");
-/**
- * Describes the "Entity" concept within Bruce.
- * An entity is a JSON blob containing both internal data and user-defined data.
- * Entity records have many thinks linked to them through their UIDs such as links, files and relationships.
- */
-var Entity;
-(function (Entity) {
-    function GetCacheKey(entityId) {
-        return `${api_1.Api.ECacheKey.Entity}${api_1.Api.ECacheKey.Id}${entityId}`;
-    }
-    Entity.GetCacheKey = GetCacheKey;
-    function Get(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, entityId, req: reqParams } = params;
-            if (!entityId) {
-                throw ("Entity ID is required.");
-            }
-            const key = GetCacheKey(entityId);
-            const cacheData = api.GetCacheItem(key, reqParams);
-            if (cacheData) {
-                return cacheData;
-            }
-            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const data = yield api.GET(`entity/${entityId}`, api_1.Api.PrepReqParams(reqParams));
-                    res({
-                        entity: data
-                    });
-                }
-                catch (e) {
-                    rej(e);
-                }
-            }));
-            api.Cache.Set(key, prom, api_1.Api.DEFAULT_CACHE_DURATION);
-            return prom;
-        });
-    }
-    Entity.Get = Get;
-    function GetListByIds(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, entityIds, req: reqParams } = params;
-            if (!entityIds.length) {
-                throw ("Entity IDs are required.");
-            }
-            const reqs = [];
-            const reqIds = [];
-            for (let i = 0; i < entityIds.length; i++) {
-                const entityId = entityIds[i];
-                const key = GetCacheKey(entityId);
-                const cacheData = api.GetCacheItem(key, reqParams);
-                if (cacheData) {
-                    reqs.push(cacheData);
-                }
-                else {
-                    reqIds.push(entityId);
-                }
-            }
-            const reqData = {
-                Filter: {
-                    ID: {
-                        in: reqIds
-                    }
-                },
-                PageSize: reqIds.length
-            };
-            if (reqIds.length > 0) {
-                const req = api.POST("entities", reqData, api_1.Api.PrepReqParams(reqParams));
-                for (let i = 0; i < reqIds.length; i++) {
-                    const entityId = reqIds[i];
-                    const key = GetCacheKey(entityId);
-                    const prom = new Promise((res) => __awaiter(this, void 0, void 0, function* () {
-                        try {
-                            const data = yield req;
-                            const item = data.Items.find(x => x.Bruce.ID == entityId);
-                            res({
-                                entity: item
-                            });
-                        }
-                        catch (e) {
-                            // No showing error as we don't want to see it 2000 times.
-                        }
-                        res(null);
-                    }));
-                    api.Cache.Set(key, prom, api_1.Api.DEFAULT_CACHE_DURATION);
-                    reqs.push(prom);
-                }
-            }
-            return {
-                entities: (yield Promise.all(reqs)).map(x => x === null || x === void 0 ? void 0 : x.entity).filter(x => !!x)
-            };
-        });
-    }
-    Entity.GetListByIds = GetListByIds;
-    function Delete(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, entityId, req: reqParams } = params;
-            if (!entityId) {
-                throw ("Entity ID is required.");
-            }
-            yield api.DELETE(`entity/${entityId}`, api_1.Api.PrepReqParams(reqParams));
-            api.Cache.Remove(GetCacheKey(entityId));
-        });
-    }
-    Entity.Delete = Delete;
-    function DeleteList(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, entityIds, req: reqParams } = params;
-            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
-                throw ("Entity IDs are required.");
-            }
-            yield api.POST("deleteEntities", {
-                Items: entityIds
-            }, api_1.Api.PrepReqParams(reqParams));
-            for (let i = 0; i < entityIds.length; i++) {
-                const entityId = entityIds[i];
-                api.Cache.Remove(GetCacheKey(entityId));
-            }
-        });
-    }
-    Entity.DeleteList = DeleteList;
-    function Update(params) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, entity: data, override, req: reqParams } = params;
-            if (!((_a = data === null || data === void 0 ? void 0 : data.Bruce) === null || _a === void 0 ? void 0 : _a["EntityType.ID"])) {
-                throw ("Entity Type ID is required.");
-            }
-            if (!((_b = data === null || data === void 0 ? void 0 : data.Bruce) === null || _b === void 0 ? void 0 : _b.ID)) {
-                data.Bruce = Object.assign(Object.assign({}, data.Bruce), { ID: object_utils_1.ObjectUtils.UId() });
-            }
-            const reqUrl = `entity/${data.Bruce.ID}/?dataoverride=${override}&BruceEntityType=${data.Bruce["EntityType.ID"]}`;
-            const res = yield api.POST(reqUrl, data, api_1.Api.PrepReqParams(reqParams));
-            api.Cache.Remove(GetCacheKey(data.Bruce.ID));
-            return {
-                entity: res
-            };
-        });
-    }
-    Entity.Update = Update;
-    function RemoveTag(params) {
-        var _a;
-        const { entity: data, tagId } = params;
-        const tags = (_a = data.Bruce["Layer.ID"]) !== null && _a !== void 0 ? _a : [];
-        const index = tags.indexOf(tagId);
-        if (index >= 0) {
-            tags.splice(index, 1);
-            data.Bruce["Layer.ID"] = tags;
-        }
-    }
-    Entity.RemoveTag = RemoveTag;
-    function AddTag(params) {
-        var _a;
-        const { entity: data, tagId } = params;
-        const tags = (_a = data.Bruce["Layer.ID"]) !== null && _a !== void 0 ? _a : [];
-        if (!tags.includes(tagId)) {
-            tags.push(tagId);
-            data.Bruce["Layer.ID"] = tags;
-        }
-    }
-    Entity.AddTag = AddTag;
-    function SetValue(params) {
-        const { entity: data, path, value } = params;
-        let curData = data;
-        for (let i = 0; i < path.length; i++) {
-            const step = path[i];
-            if (!curData[step] || typeof curData[step] != "object") {
-                curData[step] = {};
-            }
-            if (i >= path.length - 1) {
-                curData[step] = value;
-                break;
-            }
-            curData = curData[step];
-        }
-    }
-    Entity.SetValue = SetValue;
-    function GetValue(params) {
-        var _a;
-        const { entity: data, path } = params;
-        // Backwards compatibility.
-        if (path.length == 1 && path[0] == "ID") {
-            return (_a = data.Bruce) === null || _a === void 0 ? void 0 : _a.ID;
-        }
-        let curData = data;
-        for (let i = 0; i < path.length; i++) {
-            const step = path[i];
-            if (!curData[step]) {
-                return null;
-            }
-            if (i >= path.length - 1) {
-                return curData[step];
-            }
-            curData = curData[step];
-        }
-        return null;
-    }
-    Entity.GetValue = GetValue;
-    /**
-     * Calculates an entity's name based on attribute priority set in the type.
-     * @param params
-     * If true, will return the entity ID if no name can be calculated.
-     * Otherwise it returns null.
-     * @returns
-     */
-    function CalculateName(params) {
-        const { entity, type, defaultToId = true } = params;
-        const attrStr = type.DisplayNameAttributePath;
-        if (attrStr) {
-            const attrPaths = attrStr.split(",");
-            for (let i = 0; i < attrPaths.length; i++) {
-                const pathStr = attrPaths[i];
-                const path = path_utils_1.PathUtils.Parse(pathStr);
-                const name = Entity.GetValue({
-                    entity: entity,
-                    path
-                });
-                if (name && typeof name != "object") {
-                    return name;
-                }
-            }
-        }
-        return defaultToId ? entity.Bruce.ID : null;
-    }
-    Entity.CalculateName = CalculateName;
-    function GetList(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { api, filter, req: reqParams, viaCdn, viaCdnCacheToken } = params;
-            let requestFilter = {};
-            if (filter.entityTypeConditions) {
-                requestFilter = Object.assign({}, filter.entityTypeConditions);
-            }
-            if (filter.layerIds != null && filter.layerIds.length > 0) {
-                requestFilter["Bruce.Layer.ID"] = {
-                    equals: filter.layerIds
-                };
-            }
-            if (filter.bounds) {
-                requestFilter["geometry"] = {
-                    "intersects": [
-                        filter.bounds.south,
-                        filter.bounds.north,
-                        filter.bounds.west,
-                        filter.bounds.east
-                    ]
-                };
-            }
-            const body = {
-                SortOrder: filter.sortOrder == api_1.Api.ESortOrder.Asc ? "ASC" : "DESC",
-                OrderBy: filter.orderBy,
-                Filter: requestFilter,
-                LODType: filter.lodCategoryId,
-                BruceEntityType: filter.entityTypeId,
-                PageIndex: filter.pageIndex,
-                PageSize: filter.pageSize
-            };
-            let entities = [];
-            if (viaCdn && api.EntityCdnUrl) {
-                const url = new URL(api.EntityCdnUrl);
-                const urlParams = new URLSearchParams(url.search);
-                urlParams.set("cacheToken", String(viaCdnCacheToken ? viaCdnCacheToken : 0));
-                if (body.SortOrder) {
-                    urlParams.set("SortOrder", body.SortOrder);
-                }
-                if (body.OrderBy) {
-                    urlParams.set("OrderBy", body.OrderBy);
-                }
-                if (body.Filter) {
-                    urlParams.set("Filter", JSON.stringify(body.Filter));
-                }
-                if (body.LODType) {
-                    urlParams.set("LODType", body.LODType);
-                }
-                if (body.BruceEntityType) {
-                    urlParams.set("BruceEntityType", body.BruceEntityType);
-                }
-                if (body.PageIndex) {
-                    urlParams.set("PageIndex", String(body.PageIndex));
-                }
-                if (body.PageSize) {
-                    urlParams.set("PageSize", String(body.PageSize));
-                }
-                const urlStr = url.toString() + "?" + urlParams.toString();
-                const data = yield api.get(urlStr, api_1.Api.PrepReqParams(reqParams));
-                entities = data.Items;
-            }
-            else {
-                const data = yield api.POST("entities", body, api_1.Api.PrepReqParams(reqParams));
-                entities = data.Items;
-                // Only caching when non-CDN.
-                for (let i = 0; i < entities.length; i++) {
-                    const entity = entities[i];
-                    const id = entity.Bruce.ID;
-                    api.Cache.Set(GetCacheKey(id), {
-                        entity: entity
-                    }, api_1.Api.DEFAULT_CACHE_DURATION);
-                }
-            }
-            return {
-                entities
-            };
-        });
-    }
-    Entity.GetList = GetList;
-})(Entity = exports.Entity || (exports.Entity = {}));
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entity = void 0;
+const api_1 = require("../api/api");
+const object_utils_1 = require("../util/object-utils");
+const path_utils_1 = require("../util/path-utils");
+/**
+ * Describes the "Entity" concept within Bruce.
+ * An entity is a JSON blob containing both internal data and user-defined data.
+ * Entity records have many thinks linked to them through their UIDs such as links, files and relationships.
+ */
+var Entity;
+(function (Entity) {
+    function GetCacheKey(entityId) {
+        return `${api_1.Api.ECacheKey.Entity}${api_1.Api.ECacheKey.Id}${entityId}`;
+    }
+    Entity.GetCacheKey = GetCacheKey;
+    function Get(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, entityId, req: reqParams } = params;
+            if (!entityId) {
+                throw ("Entity ID is required.");
+            }
+            const key = GetCacheKey(entityId);
+            const cacheData = api.GetCacheItem(key, reqParams);
+            if (cacheData) {
+                return cacheData;
+            }
+            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const data = yield api.GET(`entity/${entityId}`, api_1.Api.PrepReqParams(reqParams));
+                    res({
+                        entity: data
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            api.SetCacheItem({
+                key,
+                value: prom,
+                req: reqParams
+            });
+            return prom;
+        });
+    }
+    Entity.Get = Get;
+    function GetListByIds(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, entityIds, req: reqParams } = params;
+            if (!entityIds.length) {
+                throw ("Entity IDs are required.");
+            }
+            const reqs = [];
+            const reqIds = [];
+            for (let i = 0; i < entityIds.length; i++) {
+                const entityId = entityIds[i];
+                const key = GetCacheKey(entityId);
+                const cacheData = api.GetCacheItem(key, reqParams);
+                if (cacheData) {
+                    reqs.push(cacheData);
+                }
+                else {
+                    reqIds.push(entityId);
+                }
+            }
+            const reqData = {
+                Filter: {
+                    ID: {
+                        in: reqIds
+                    }
+                },
+                PageSize: reqIds.length
+            };
+            if (reqIds.length > 0) {
+                const req = api.POST("entities", reqData, api_1.Api.PrepReqParams(reqParams));
+                for (let i = 0; i < reqIds.length; i++) {
+                    const entityId = reqIds[i];
+                    const key = GetCacheKey(entityId);
+                    const prom = new Promise((res) => __awaiter(this, void 0, void 0, function* () {
+                        try {
+                            const data = yield req;
+                            const item = data.Items.find(x => x.Bruce.ID == entityId);
+                            res({
+                                entity: item
+                            });
+                        }
+                        catch (e) {
+                            // No showing error as we don't want to see it 2000 times.
+                        }
+                        res(null);
+                    }));
+                    api.SetCacheItem({
+                        key,
+                        value: prom,
+                        req: reqParams
+                    });
+                    reqs.push(prom);
+                }
+            }
+            return {
+                entities: (yield Promise.all(reqs)).map(x => x === null || x === void 0 ? void 0 : x.entity).filter(x => !!x)
+            };
+        });
+    }
+    Entity.GetListByIds = GetListByIds;
+    function Delete(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, entityId, req: reqParams } = params;
+            if (!entityId) {
+                throw ("Entity ID is required.");
+            }
+            yield api.DELETE(`entity/${entityId}`, api_1.Api.PrepReqParams(reqParams));
+            api.Cache.Remove(GetCacheKey(entityId));
+        });
+    }
+    Entity.Delete = Delete;
+    function DeleteList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, entityIds, req: reqParams } = params;
+            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+                throw ("Entity IDs are required.");
+            }
+            yield api.POST("deleteEntities", {
+                Items: entityIds
+            }, api_1.Api.PrepReqParams(reqParams));
+            for (let i = 0; i < entityIds.length; i++) {
+                const entityId = entityIds[i];
+                api.Cache.Remove(GetCacheKey(entityId));
+            }
+        });
+    }
+    Entity.DeleteList = DeleteList;
+    function Update(params) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, entity: data, override, req: reqParams } = params;
+            if (!((_a = data === null || data === void 0 ? void 0 : data.Bruce) === null || _a === void 0 ? void 0 : _a["EntityType.ID"])) {
+                throw ("Entity Type ID is required.");
+            }
+            if (!((_b = data === null || data === void 0 ? void 0 : data.Bruce) === null || _b === void 0 ? void 0 : _b.ID)) {
+                data.Bruce = Object.assign(Object.assign({}, data.Bruce), { ID: object_utils_1.ObjectUtils.UId() });
+            }
+            const reqUrl = `entity/${data.Bruce.ID}/?dataoverride=${override}&BruceEntityType=${data.Bruce["EntityType.ID"]}`;
+            const res = yield api.POST(reqUrl, data, api_1.Api.PrepReqParams(reqParams));
+            api.Cache.Remove(GetCacheKey(data.Bruce.ID));
+            return {
+                entity: res
+            };
+        });
+    }
+    Entity.Update = Update;
+    function RemoveTag(params) {
+        var _a;
+        const { entity: data, tagId } = params;
+        const tags = (_a = data.Bruce["Layer.ID"]) !== null && _a !== void 0 ? _a : [];
+        const index = tags.indexOf(tagId);
+        if (index >= 0) {
+            tags.splice(index, 1);
+            data.Bruce["Layer.ID"] = tags;
+        }
+    }
+    Entity.RemoveTag = RemoveTag;
+    function AddTag(params) {
+        var _a;
+        const { entity: data, tagId } = params;
+        const tags = (_a = data.Bruce["Layer.ID"]) !== null && _a !== void 0 ? _a : [];
+        if (!tags.includes(tagId)) {
+            tags.push(tagId);
+            data.Bruce["Layer.ID"] = tags;
+        }
+    }
+    Entity.AddTag = AddTag;
+    function SetValue(params) {
+        const { entity: data, path, value } = params;
+        let curData = data;
+        for (let i = 0; i < path.length; i++) {
+            const step = path[i];
+            if (!curData[step] || typeof curData[step] != "object") {
+                curData[step] = {};
+            }
+            if (i >= path.length - 1) {
+                curData[step] = value;
+                break;
+            }
+            curData = curData[step];
+        }
+    }
+    Entity.SetValue = SetValue;
+    function GetValue(params) {
+        var _a;
+        const { entity: data, path } = params;
+        // Backwards compatibility.
+        if (path.length == 1 && path[0] == "ID") {
+            return (_a = data.Bruce) === null || _a === void 0 ? void 0 : _a.ID;
+        }
+        let curData = data;
+        for (let i = 0; i < path.length; i++) {
+            const step = path[i];
+            if (!curData[step]) {
+                return null;
+            }
+            if (i >= path.length - 1) {
+                return curData[step];
+            }
+            curData = curData[step];
+        }
+        return null;
+    }
+    Entity.GetValue = GetValue;
+    /**
+     * Calculates an entity's name based on attribute priority set in the type.
+     * @param params
+     * If true, will return the entity ID if no name can be calculated.
+     * Otherwise it returns null.
+     * @returns
+     */
+    function CalculateName(params) {
+        const { entity, type, defaultToId = true } = params;
+        const attrStr = type.DisplayNameAttributePath;
+        if (attrStr) {
+            const attrPaths = attrStr.split(",");
+            for (let i = 0; i < attrPaths.length; i++) {
+                const pathStr = attrPaths[i];
+                const path = path_utils_1.PathUtils.Parse(pathStr);
+                const name = Entity.GetValue({
+                    entity: entity,
+                    path
+                });
+                if (name && typeof name != "object") {
+                    return name;
+                }
+            }
+        }
+        return defaultToId ? entity.Bruce.ID : null;
+    }
+    Entity.CalculateName = CalculateName;
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, filter, req: reqParams, viaCdn, viaCdnCacheToken } = params;
+            let requestFilter = {};
+            if (filter.entityTypeConditions) {
+                requestFilter = Object.assign({}, filter.entityTypeConditions);
+            }
+            if (filter.layerIds != null && filter.layerIds.length > 0) {
+                requestFilter["Bruce.Layer.ID"] = {
+                    equals: filter.layerIds
+                };
+            }
+            if (filter.bounds) {
+                requestFilter["geometry"] = {
+                    "intersects": [
+                        filter.bounds.south,
+                        filter.bounds.north,
+                        filter.bounds.west,
+                        filter.bounds.east
+                    ]
+                };
+            }
+            const body = {
+                SortOrder: filter.sortOrder == api_1.Api.ESortOrder.Asc ? "ASC" : "DESC",
+                OrderBy: filter.orderBy,
+                Filter: requestFilter,
+                LODType: filter.lodCategoryId,
+                BruceEntityType: filter.entityTypeId,
+                PageIndex: filter.pageIndex,
+                PageSize: filter.pageSize
+            };
+            let entities = [];
+            if (viaCdn && api.EntityCdnUrl) {
+                const url = new URL(api.EntityCdnUrl);
+                const urlParams = new URLSearchParams(url.search);
+                urlParams.set("cacheToken", String(viaCdnCacheToken ? viaCdnCacheToken : 0));
+                if (body.SortOrder) {
+                    urlParams.set("SortOrder", body.SortOrder);
+                }
+                if (body.OrderBy) {
+                    urlParams.set("OrderBy", body.OrderBy);
+                }
+                if (body.Filter) {
+                    urlParams.set("Filter", JSON.stringify(body.Filter));
+                }
+                if (body.LODType) {
+                    urlParams.set("LODType", body.LODType);
+                }
+                if (body.BruceEntityType) {
+                    urlParams.set("BruceEntityType", body.BruceEntityType);
+                }
+                if (body.PageIndex) {
+                    urlParams.set("PageIndex", String(body.PageIndex));
+                }
+                if (body.PageSize) {
+                    urlParams.set("PageSize", String(body.PageSize));
+                }
+                const urlStr = url.toString() + "?" + urlParams.toString();
+                const data = yield api.get(urlStr, api_1.Api.PrepReqParams(reqParams));
+                entities = data.Items;
+            }
+            else {
+                const data = yield api.POST("entities", body, api_1.Api.PrepReqParams(reqParams));
+                entities = data.Items;
+                // Only caching when non-CDN.
+                for (let i = 0; i < entities.length; i++) {
+                    const entity = entities[i];
+                    const id = entity.Bruce.ID;
+                    api.SetCacheItem({
+                        key: GetCacheKey(id),
+                        value: {
+                            entity: entity
+                        },
+                        req: reqParams
+                    });
+                }
+            }
+            return {
+                entities
+            };
+        });
+    }
+    Entity.GetList = GetList;
+})(Entity = exports.Entity || (exports.Entity = {}));
 //# sourceMappingURL=entity.js.map