bruce-models 7.1.80 → 7.1.82

package/dist/bruce-models.es5.js

@@ -39,6 +39,7 @@ var Api;
         ECacheKey["Assembly"] = "assembly";
         ECacheKey["Entity"] = "entity";
         ECacheKey["EntityType"] = "entitytype";
+        ECacheKey["EntityTypeRelation"] = "entitytyperelation";
         ECacheKey["Ontology"] = "ontology";
         ECacheKey["EntityTypeTrigger"] = "entitytypetrigger";
         ECacheKey["DataFeed"] = "datafeed";
@@ -11003,6 +11004,26 @@ var DataLab;
         });
     }
     DataLab.Run = Run;
+    /**
+     * Runs one or more DataLab actions.
+     * This calls: POST v3/datalab/runAction
+     */
+    function RunAction(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, body, req } = params;
+            if (!body) {
+                throw new Error("body is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const res = yield api.POST("v3/datalab/runAction", body, Api.PrepReqParams(req));
+            return {
+                action: res
+            };
+        });
+    }
+    DataLab.RunAction = RunAction;
 })(DataLab || (DataLab = {}));
 
 var DataLabGroup;
@@ -14260,6 +14281,172 @@ var EntityTag;
     EntityTag.GetListCacheKey = GetListCacheKey;
 })(EntityTag || (EntityTag = {}));
 
+/**
+ * Describes the "Entity Type Relation" concept within Nextspace.
+ * An Entity Type Relation registers a relationship that may exist between entities of two specified Entity Types.
+ */
+var EntityTypeRelation;
+(function (EntityTypeRelation) {
+    /**
+     * Gets a single Entity Type Relation record.
+     * This calls: GET entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Get(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, entityTypeId, entityTypeRelationId, req } = params;
+            if (!entityTypeId) {
+                throw ("Entity Type ID is required.");
+            }
+            if (!entityTypeRelationId) {
+                throw ("Entity Type Relation ID is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const key = GetCacheKey(entityTypeId, entityTypeRelationId);
+            const cache = api.GetCacheItem(key, req);
+            if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                return cache.data;
+            }
+            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const data = yield api.GET(`entityType/${entityTypeId}/relation/${entityTypeRelationId}`, Api.PrepReqParams(req));
+                    res({
+                        relation: data
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            api.SetCacheItem({
+                key,
+                value: prom,
+                req
+            });
+            return prom;
+        });
+    }
+    EntityTypeRelation.Get = Get;
+    /**
+     * Gets Entity Type Relation records for the specified Entity Type.
+     * This calls: GET entityType/{entityType_id}/relations
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, entityTypeId, req } = params;
+            if (!entityTypeId) {
+                throw ("Entity Type ID is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const key = GetListCacheKey(entityTypeId);
+            const cache = api.GetCacheItem(key, req);
+            if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                return cache.data;
+            }
+            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const data = yield api.GET(`entityType/${entityTypeId}/relations`, Api.PrepReqParams(req));
+                    res({
+                        relations: Array.isArray(data === null || data === void 0 ? void 0 : data.Items) ? data.Items : []
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            api.SetCacheItem({
+                key,
+                value: prom,
+                req
+            });
+            return prom;
+        });
+    }
+    EntityTypeRelation.GetList = GetList;
+    /**
+     * Creates or updates an Entity Type Relation record.
+     * This calls: POST entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Update(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, entityTypeId, relation: data, entityTypeRelationId, req } = params;
+            if (!entityTypeId) {
+                throw ("Entity Type ID is required.");
+            }
+            if (!data) {
+                throw ("Entity Type Relation is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const relationId = (_a = entityTypeRelationId !== null && entityTypeRelationId !== void 0 ? entityTypeRelationId : data.ID) !== null && _a !== void 0 ? _a : 0;
+            if (isCreateRoute(relationId) && (!data["A.EntityType.ID"] || !data["B.EntityType.ID"] || !data["EntityRelationType.ID"])) {
+                throw ("A.EntityType.ID, B.EntityType.ID, and EntityRelationType.ID are required.");
+            }
+            const res = yield api.POST(`entityType/${entityTypeId}/relation/${relationId}`, data, Api.PrepReqParams(req));
+            removeRelationCache(api, entityTypeId, relationId, res);
+            return {
+                relation: res
+            };
+        });
+    }
+    EntityTypeRelation.Update = Update;
+    /**
+     * Deletes an Entity Type Relation record.
+     * This calls: DELETE entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Delete(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, entityTypeId, entityTypeRelationId, req } = params;
+            if (!entityTypeId) {
+                throw ("Entity Type ID is required.");
+            }
+            if (!entityTypeRelationId) {
+                throw ("Entity Type Relation ID is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.DELETE(`entityType/${entityTypeId}/relation/${entityTypeRelationId}`, Api.PrepReqParams(req));
+            removeRelationCache(api, entityTypeId, entityTypeRelationId);
+        });
+    }
+    EntityTypeRelation.Delete = Delete;
+    /**
+     * Returns cache identifier for an Entity Type Relation record.
+     */
+    function GetCacheKey(entityTypeId, entityTypeRelationId) {
+        return Api.ECacheKey.EntityTypeRelation + Api.ECacheKey.Id + entityTypeId + Api.ECacheKey.Id + entityTypeRelationId;
+    }
+    EntityTypeRelation.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for the list of Entity Type Relation records for an Entity Type.
+     */
+    function GetListCacheKey(entityTypeId) {
+        return Api.ECacheKey.EntityTypeRelation + Api.ECacheKey.Id + entityTypeId;
+    }
+    EntityTypeRelation.GetListCacheKey = GetListCacheKey;
+    function isCreateRoute(entityTypeRelationId) {
+        return entityTypeRelationId === 0 || entityTypeRelationId === "0";
+    }
+    function removeRelationCache(api, entityTypeId, entityTypeRelationId, relation) {
+        api.Cache.RemoveByStartsWith(GetListCacheKey(entityTypeId));
+        if (!isCreateRoute(entityTypeRelationId)) {
+            api.Cache.Remove(GetCacheKey(entityTypeId, entityTypeRelationId));
+        }
+        if ((relation === null || relation === void 0 ? void 0 : relation["A.EntityType.ID"]) && relation["A.EntityType.ID"] !== entityTypeId) {
+            api.Cache.RemoveByStartsWith(GetListCacheKey(relation["A.EntityType.ID"]));
+        }
+        if ((relation === null || relation === void 0 ? void 0 : relation["B.EntityType.ID"]) && relation["B.EntityType.ID"] !== entityTypeId) {
+            api.Cache.RemoveByStartsWith(GetListCacheKey(relation["B.EntityType.ID"]));
+        }
+    }
+})(EntityTypeRelation || (EntityTypeRelation = {}));
+
 /**
  * Describes the "BruceEntityTypeTrigger" concept within Nextspace.
  * These records define trigger rules that are scoped to an Entity Type.
@@ -14787,6 +14974,71 @@ var ExportBrz;
     ExportBrz.Export = Export;
 })(ExportBrz || (ExportBrz = {}));
 
+var ExportCsv;
+(function (ExportCsv) {
+    /**
+     * Exports CSV for Entities selected by Filter.
+     * This calls: GET entities/ExportCSV
+     */
+    function Export(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, fileExport, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!(fileExport === null || fileExport === void 0 ? void 0 : fileExport.BruceEntityType)) {
+                throw ("fileExport.BruceEntityType is required.");
+            }
+            const urlParams = new URLSearchParams();
+            urlParams.append("BruceEntityType", fileExport.BruceEntityType);
+            appendStringParam(urlParams, "OrderBy", fileExport.OrderBy);
+            appendStringParam(urlParams, "SortOrder", fileExport.SortOrder);
+            appendStringParam(urlParams, "Filter", fileExport.Filter);
+            appendStringParam(urlParams, "LODType", fileExport.LODType);
+            if (fileExport.ZIP != null) {
+                urlParams.append("ZIP", String(fileExport.ZIP));
+            }
+            if (fileExport.ColumnSettings) {
+                urlParams.append("ColumnSettings", JSON.stringify(fileExport.ColumnSettings));
+            }
+            return api.GET(`entities/ExportCSV?${urlParams.toString()}`, Api.PrepReqParams(req));
+        });
+    }
+    ExportCsv.Export = Export;
+    /**
+     * Exports CSV for a provided list of Entity IDs.
+     * This calls: POST entities/ExportCSV/{entityType_ID}
+     */
+    function ExportEntities(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, entityTypeId, fileExport, zip, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!entityTypeId) {
+                throw ("entityTypeId is required.");
+            }
+            if (!((_a = fileExport === null || fileExport === void 0 ? void 0 : fileExport.EntityIDs) === null || _a === void 0 ? void 0 : _a.length)) {
+                throw ("fileExport.EntityIDs is required and must be a non-empty list.");
+            }
+            let url = `entities/ExportCSV/${Api.Encode(entityTypeId)}`;
+            if (zip != null) {
+                const urlParams = new URLSearchParams();
+                urlParams.append("ZIP", String(zip));
+                url += `?${urlParams.toString()}`;
+            }
+            return api.POST(url, fileExport, Api.PrepReqParams(req));
+        });
+    }
+    ExportCsv.ExportEntities = ExportEntities;
+    function appendStringParam(urlParams, key, value) {
+        if (value != null && value !== "") {
+            urlParams.append(key, String(value));
+        }
+    }
+})(ExportCsv || (ExportCsv = {}));
+
 var ExportUsd;
 (function (ExportUsd) {
     function Export(params) {
@@ -20450,7 +20702,7 @@ var UrlUtils;
 })(UrlUtils || (UrlUtils = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.80";
+const VERSION = "7.1.82";
 
-export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
+export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
 //# sourceMappingURL=bruce-models.es5.js.map