bruce-models 5.9.2 → 5.9.3

package/dist/bruce-models.es5.js

@@ -35,6 +35,7 @@ var Api;
     (function (ECacheKey) {
         ECacheKey["Id"] = ":";
         ECacheKey["ListId"] = "::";
+        ECacheKey["Assembly"] = "assembly";
         ECacheKey["Entity"] = "entity";
         ECacheKey["EntityType"] = "entitytype";
         ECacheKey["ProjectView"] = "projectview";
@@ -1741,6 +1742,198 @@ var ENVIRONMENT;
     ENVIRONMENT.Reset = Reset;
 })(ENVIRONMENT || (ENVIRONMENT = {}));
 
+/**
+ * Represents the assembly concept in Nextspace.
+ * An assembly is a record of an Entity hierarchy, typically derived from a set Root Entity.
+ * These are auto-generated from assembly imports (eg: IFC).
+ */
+var Assembly;
+(function (Assembly) {
+    /**
+     * Returns an assembly record by ID.
+     * @param params
+     * @returns
+     */
+    function Get(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, assemblyId, req: reqParams } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!assemblyId) {
+                throw ("Assembly ID is required.");
+            }
+            const key = GetCacheKey(assemblyId);
+            const cache = api.GetCacheItem(key, reqParams);
+            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(`v3/assembly/${assemblyId}`, Api.PrepReqParams(reqParams));
+                    res({
+                        assembly: data
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            api.SetCacheItem({
+                key,
+                value: prom,
+                req: reqParams
+            });
+            return prom;
+        });
+    }
+    Assembly.Get = Get;
+    /**
+     * Gets a list of assembly records.
+     * @param params
+     * @returns
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, req: reqParams } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    let url = "v3/assemblies";
+                    const urlParams = new URLSearchParams();
+                    if (params.pageSize != null) {
+                        urlParams.append("PageSize", String(params.pageSize));
+                    }
+                    if (params.pageIndex != null) {
+                        urlParams.append("PageIndex", String(params.pageIndex));
+                    }
+                    if (params.parentId) {
+                        urlParams.append("ParentID", String(params.parentId));
+                    }
+                    url += "?" + urlParams.toString();
+                    const data = yield api.GET(url, Api.PrepReqParams(reqParams));
+                    const result = {};
+                    result.assemblies = data.Items ? data.Items : [];
+                    if (data.TotalCount != null) {
+                        result.totalCount = data.TotalCount;
+                    }
+                    if (data.NextPage != null) {
+                        result.nextPage = data.NextPage;
+                    }
+                    if (data.NextPageURL != null) {
+                        result.nextPageUrl = data.NextPageURL;
+                    }
+                    res(result);
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            return req;
+        });
+    }
+    Assembly.GetList = GetList;
+    /**
+     * Creates or updates an assembly record.
+     * @param params
+     * @returns
+     */
+    function Update(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, assembly: data, req: reqParams } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!data.ID) {
+                data.ID = 0;
+            }
+            const url = `v3/assembly/${data.ID}`;
+            const res = yield api.POST(url, data, Api.PrepReqParams(reqParams));
+            api.Cache.Remove(GetCacheKey(data.ID));
+            return {
+                assembly: res
+            };
+        });
+    }
+    Assembly.Update = Update;
+    /**
+     * Deletes an assembly record.
+     * @param params
+     */
+    function Delete(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, assemblyId, req: reqParams } = params;
+            if (!assemblyId) {
+                throw ("Assembly ID is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.DELETE(`v3/assembly/${assemblyId}`, Api.PrepReqParams(reqParams));
+            api.Cache.Remove(GetCacheKey(assemblyId));
+        });
+    }
+    Assembly.Delete = Delete;
+    /**
+     * Deletes a list of assembly records based on specified conditions.
+     * @param params
+     */
+    function DeleteList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, req: reqParams } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            let url = "v3/assemblies";
+            const urlParams = new URLSearchParams();
+            if (params.invalidRootIds) {
+                urlParams.append("InvalidRootEntityID", "true");
+            }
+            url += "?" + urlParams.toString();
+            yield api.DELETE(url, Api.PrepReqParams(reqParams));
+            api.Cache.RemoveByStartsWith(Api.ECacheKey.Assembly);
+        });
+    }
+    Assembly.DeleteList = DeleteList;
+    /**
+     * Runs a job to locate existing assemblies by searching for root Entity IDs.
+     * Each unregistered root Entity ID will be used to create a new assembly.
+     *
+     * WARNING: on completion, you should kill cache.
+     * Eg: api.Cache.RemoveByStartsWith(Api.ECacheKey.Assembly);
+     * @param params
+     */
+    function SyncWithRootEntityIDs(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!params) {
+                params = {};
+            }
+            let { api, req: reqParams } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            return yield api.POST("v3/assembly/resyncrootentitiestoassemblies", {}, Api.PrepReqParams(reqParams));
+        });
+    }
+    Assembly.SyncWithRootEntityIDs = SyncWithRootEntityIDs;
+    /**
+     * Returns cache identifier for an assembly by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(5);
+     *     api.Cache.Remove(key);
+     * }
+     * @param assemblyId
+     * @returns
+     */
+    function GetCacheKey(assemblyId) {
+        return `${Api.ECacheKey.Assembly}${Api.ECacheKey.Id}${assemblyId}`;
+    }
+    Assembly.GetCacheKey = GetCacheKey;
+})(Assembly || (Assembly = {}));
+
 /**
  * Describes communication with the "Annotated Document" concept in Bruce.
  * Annotated documents are files with hotspots that can link to Entity records.
@@ -15417,7 +15610,7 @@ var Scenario;
 })(Scenario || (Scenario = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "5.9.2";
+const VERSION = "5.9.3";
 
-export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, GeoJson, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityAttribute, EntityHistoricData, EntityTableView, Comment, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewBookmarkGroup, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, AccountLimits, AccountTemplate, AccountType, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, DataLabGroup, ImportAssembly, ImportCad, ImportCsv, ImportJson, ImportGeoJson, ImportKml, ImportedFile, ExportBrz, ExportUsd, Markup, Uploader, Plugin, ENVIRONMENT, DataSource, Scenario };
+export { VERSION, Assembly, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, GeoJson, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityAttribute, EntityHistoricData, EntityTableView, Comment, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewBookmarkGroup, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, AccountLimits, AccountTemplate, AccountType, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, DataLabGroup, ImportAssembly, ImportCad, ImportCsv, ImportJson, ImportGeoJson, ImportKml, ImportedFile, ExportBrz, ExportUsd, Markup, Uploader, Plugin, ENVIRONMENT, DataSource, Scenario };
 //# sourceMappingURL=bruce-models.es5.js.map