bruce-models 3.2.0 → 3.2.2

package/dist/lib/entity/entity-attachment-type.js

@@ -13,24 +13,50 @@ exports.EntityAttachmentType = void 0;
 const api_1 = require("../api/api");
 const environment_1 = require("../environment");
 /**
- * Describes the "Entity Attachment Type" concept within Bruce.
+ * Describes the "Entity Attachment Type" concept within Nextspace.
  * It is a record that describes the purpose of an attachment.
  */
 var EntityAttachmentType;
 (function (EntityAttachmentType) {
+    /**
+     * Returns cache identifier for an attachment type by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id) {
         return api_1.Api.ECacheKey.AttachmentType + api_1.Api.ECacheKey.Id + id;
     }
     EntityAttachmentType.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of attachment types.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
     function GetListCacheKey() {
         return api_1.Api.ECacheKey.AttachmentType;
     }
     EntityAttachmentType.GetListCacheKey = GetListCacheKey;
+    // Known attachment types.
     let EType;
     (function (EType) {
+        // Attachments with this type will appear in the media tab within the entity details.
         EType["Photo"] = "photo";
         EType["Document"] = "document";
     })(EType = EntityAttachmentType.EType || (EntityAttachmentType.EType = {}));
+    /**
+     * Deletes an attachment type.
+     * @param params
+     */
     function Delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, attachmentTypeId: id, req: reqParams } = params;
@@ -46,6 +72,11 @@ var EntityAttachmentType;
         });
     }
     EntityAttachmentType.Delete = Delete;
+    /**
+     * Creates or updates an attachment type.
+     * @param params
+     * @returns
+     */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, attachmentType: data, req: reqParams } = params;
@@ -64,6 +95,11 @@ var EntityAttachmentType;
         });
     }
     EntityAttachmentType.Update = Update;
+    /**
+     * Gets a list of all attachment types.
+     * @param params
+     * @returns
+     */
     function GetList(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, reqParams } = params;

package/dist/lib/entity/entity-attachment-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-attachment-type.js","sourceRoot":"","sources":["../../../src/entity/entity-attachment-type.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAEjC,gDAA6C;AAI7C;;;GAGG;AACH,IAAiB,oBAAoB,CA8FpC;AA9FD,WAAiB,oBAAoB;IACjC,SAAgB,WAAW,CAAC,EAAQ;QAChC,OAAO,SAAG,CAAC,SAAS,CAAC,cAAc,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAChE,CAAC;IAFe,gCAAW,cAE1B,CAAA;IAED,SAAgB,eAAe;QAC3B,OAAO,SAAG,CAAC,SAAS,CAAC,cAAc,CAAC;IACxC,CAAC;IAFe,oCAAe,kBAE9B,CAAA;IAQD,IAAY,KAGX;IAHD,WAAY,KAAK;QACb,wBAAe,CAAA;QACf,8BAAqB,CAAA;IACzB,CAAC,EAHW,KAAK,GAAL,0BAAK,KAAL,0BAAK,QAGhB;IAED,SAAsB,MAAM,CAAC,MAI5B;;YACG,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC3D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,EAAE,EAAE;gBACL,MAAK,CAAC,sBAAsB,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,CAAC,MAAM,CAAC,wBAAwB,EAAE,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC7E,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;YAClC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QACxC,CAAC;KAAA;IAhBqB,2BAAM,SAgB3B,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC3D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAA,EAAE;gBACX,MAAK,CAAC,sBAAsB,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,wBAAwB,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAClG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;YACpC,OAAO;gBACH,cAAc,EAAE,GAAG;aACtB,CAAC;QACN,CAAC;KAAA;IArBqB,2BAAM,SAqB3B,CAAA;IAED,SAAsB,OAAO,CAAC,MAG7B;;YAGG,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,EAAE,EAAE,SAAS,CAAC,CAAC;YACnE,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAClF,GAAG,CAAC;wBACA,eAAe,EAAE,IAAI,CAAC,KAAK;qBAC9B,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,EAAE;gBACtB,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAhCqB,4BAAO,UAgC5B,CAAA;AACL,CAAC,EA9FgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA8FpC"}
+{"version":3,"file":"entity-attachment-type.js","sourceRoot":"","sources":["../../../src/entity/entity-attachment-type.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAEjC,gDAA6C;AAI7C;;;GAGG;AACH,IAAiB,oBAAoB,CA2IpC;AA3ID,WAAiB,oBAAoB;IACjC;;;;;;;;;OASG;IACH,SAAgB,WAAW,CAAC,EAAQ;QAChC,OAAO,SAAG,CAAC,SAAS,CAAC,cAAc,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAChE,CAAC;IAFe,gCAAW,cAE1B,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,eAAe;QAC3B,OAAO,SAAG,CAAC,SAAS,CAAC,cAAc,CAAC;IACxC,CAAC;IAFe,oCAAe,kBAE9B,CAAA;IAcD,0BAA0B;IAC1B,IAAY,KAIX;IAJD,WAAY,KAAK;QACb,qFAAqF;QACrF,wBAAe,CAAA;QACf,8BAAqB,CAAA;IACzB,CAAC,EAJW,KAAK,GAAL,0BAAK,KAAL,0BAAK,QAIhB;IAED;;;OAGG;IACH,SAAsB,MAAM,CAAC,MAK5B;;YACG,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC3D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,EAAE,EAAE;gBACL,MAAK,CAAC,sBAAsB,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,CAAC,MAAM,CAAC,wBAAwB,EAAE,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC7E,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;YAClC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QACxC,CAAC;KAAA;IAjBqB,2BAAM,SAiB3B,CAAA;IAED;;;;OAIG;IACH,SAAsB,MAAM,CAAC,MAK5B;;YAGG,IAAI,EAAE,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC3D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAA,EAAE;gBACX,MAAK,CAAC,sBAAsB,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,wBAAwB,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAClG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;YACpC,OAAO;gBACH,cAAc,EAAE,GAAG;aACtB,CAAC;QACN,CAAC;KAAA;IAtBqB,2BAAM,SAsB3B,CAAA;IAED;;;;OAIG;IACH,SAAsB,OAAO,CAAC,MAG7B;;YAIG,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,EAAE,EAAE,SAAS,CAAC,CAAC;YACnE,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAClF,GAAG,CAAC;wBACA,eAAe,EAAE,IAAI,CAAC,KAAK;qBAC9B,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,EAAE;gBACtB,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAjCqB,4BAAO,UAiC5B,CAAA;AACL,CAAC,EA3IgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA2IpC"}

package/dist/lib/entity/entity-attachment.js

@@ -13,30 +13,55 @@ exports.EntityAttachment = void 0;
 const api_1 = require("../api/api");
 const environment_1 = require("../environment");
 /**
- * Describes the "Entity Attachment" concept within Bruce.
+ * Describes the "Entity Attachment" concept within Nextspace.
  * An entity attachment is an arbitrary file record that is linked to an entity record.
  * The same file can be attached to multiple entities.
  */
 var EntityAttachment;
 (function (EntityAttachment) {
+    /**
+     * Returns cache identifier for an attachment by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id) {
         return api_1.Api.ECacheKey.Attachment + api_1.Api.ECacheKey.Id + id;
     }
     EntityAttachment.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of attachments for an entity.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
     function GetListCacheKey(entityId) {
         return api_1.Api.ECacheKey.Attachment + api_1.Api.ECacheKey.Entity + api_1.Api.ECacheKey.Id + entityId;
     }
     EntityAttachment.GetListCacheKey = GetListCacheKey;
+    /**
+     * Updates one or many attachment records.
+     * @param params
+     * @returns
+     */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, attachments, req, entityId } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!(attachments === null || attachments === void 0 ? void 0 : attachments.length)) {
-                return {
+                return Promise.resolve({
                     attachments: []
-                };
+                });
+            }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
             }
             const res = yield api.POST(`entity/${entityId}/attachments`, {
                 attachments
@@ -53,15 +78,22 @@ var EntityAttachment;
         });
     }
     EntityAttachment.Update = Update;
+    /**
+     * Updates the display order of attachments.
+     * @param params
+     */
     function UpdateOrder(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, attachmentTypeId: typeId, attachments, req: reqParams } = params;
+            if (!entityId || !typeId) {
+                throw ("Entity ID and Type ID are required.");
+            }
+            if (!(attachments === null || attachments === void 0 ? void 0 : attachments.length)) {
+                return Promise.resolve();
+            }
             if (!api) {
                 api = environment_1.ENVIRONMENT.Api().GetBruceApi();
             }
-            if (!entityId || !typeId || !(attachments === null || attachments === void 0 ? void 0 : attachments.length)) {
-                throw ("Entity ID, Type ID, and Attachments are required.");
-            }
             const reqData = {
                 "DisplayOrder.Start": 0,
                 "ClientFile.ID": attachments.map(x => x["ClientFile.ID"])
@@ -74,30 +106,39 @@ var EntityAttachment;
         });
     }
     EntityAttachment.UpdateOrder = UpdateOrder;
+    /**
+     * Deletes an attachment record.
+     * @param params
+     */
     function Delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, attachmentId, entityId, req } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!attachmentId || !entityId) {
                 throw ("Entity id and attachment id.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             yield api.DELETE(`entity/${entityId}/attachments/${attachmentId}`, api_1.Api.PrepReqParams(req));
             yield api.Cache.Remove(GetCacheKey(attachmentId));
             yield api.Cache.Remove(GetListCacheKey(params.entityId));
         });
     }
     EntityAttachment.Delete = Delete;
+    /**
+     * Gets a list of attachments for an entity.
+     * @param params
+     * @returns
+     */
     function GetListByEntityId(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!entityId) {
                 throw ("Entity ID is required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const cache = yield api.GetCacheItem(GetListCacheKey(entityId), reqParams);
             if (cache === null || cache === void 0 ? void 0 : cache.found) {
                 return cache.data;
@@ -122,15 +163,21 @@ var EntityAttachment;
         });
     }
     EntityAttachment.GetListByEntityId = GetListByEntityId;
+    /**
+     * Uploads a file as an attachment to an entity.
+     * This will create a client file record for the file.
+     * @param params
+     * @returns
+     */
     function Upload(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, file, entityId, attachmentTypeId: typeId, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!entityId || !typeId || !file) {
                 throw ("Entity ID, Type ID, and File are required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const url = `entity/${entityId}/attachment/${typeId}`;
             const res = yield api.UPLOAD(url, file, api_1.Api.PrepReqParams(reqParams));
             api.Cache.Remove(GetListCacheKey(entityId));

package/dist/lib/entity/entity-attachment.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-attachment.js","sourceRoot":"","sources":["../../../src/entity/entity-attachment.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAK7C;;;;GAIG;AACH,IAAiB,gBAAgB,CA8JhC;AA9JD,WAAiB,gBAAgB;IAC7B,SAAgB,WAAW,CAAC,EAAU;QAClC,OAAO,SAAG,CAAC,SAAS,CAAC,UAAU,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAC5D,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,SAAgB,eAAe,CAAC,QAAgB;QAC5C,OAAO,SAAG,CAAC,SAAS,CAAC,UAAU,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IACzF,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAYD,SAAsB,MAAM,CAAC,MAK5B;;YAGG,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBACtB,OAAO;oBACH,WAAW,EAAE,EAAE;iBAClB,CAAC;aACL;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,cAAc,EAAE;gBACzD,WAAW;aACd,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnB,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;iBACpD;aACJ;YACD,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YAClD,OAAO;gBACH,WAAW,EAAE,GAAG,CAAC,WAAW;aAC/B,CAAC;QACN,CAAC;KAAA;IA9BqB,uBAAM,SA8B3B,CAAA;IAED,SAAsB,WAAW,CAAC,MAMjC;;YACG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACtF,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBAC9C,MAAK,CAAC,mDAAmD,CAAC,CAAC;aAC9D;YACD,MAAM,OAAO,GAAG;gBACf,oBAAoB,EAAE,CAAC;gBACvB,eAAe,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;aACzD,CAAC;YACF,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,gBAAgB,MAAM,WAAW,EAAE,OAAO,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACpD;YACD,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClE,CAAC;KAAA;IAxBqB,4BAAW,cAwBhC,CAAA;IAED,SAAsB,MAAM,CAAC,MAK5B;;YACG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE;gBAC5B,MAAK,CAAC,8BAA8B,CAAC,CAAC;aACzC;YACD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,gBAAgB,YAAY,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3F,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC7D,CAAC;KAAA;IAjBqB,uBAAM,SAiB3B,CAAA;IAED,SAAsB,iBAAiB,CAAC,MAIvC;;YAGG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/C,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAK,CAAC,wBAAwB,CAAC,CAAC;aACnC;YACD,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC3E,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,cAAc,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC3F,GAAG,CAAC;wBACA,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;qBAClE,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,CAAC,QAAQ,CAAC;gBAC9B,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IApCqB,kCAAiB,oBAoCtC,CAAA;IAED,SAAsB,MAAM,CAAC,MAM5B;;YAGG,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/E,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE;gBAC/B,MAAK,CAAC,4CAA4C,CAAC,CAAC;aACvD;YACD,MAAM,GAAG,GAAG,UAAU,QAAQ,eAAe,MAAM,EAAE,CAAC;YACtD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACtE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5C,OAAO;gBACH,UAAU,EAAE,GAAG;aAClB,CAAC;QACN,CAAC;KAAA;IAvBqB,uBAAM,SAuB3B,CAAA;AACL,CAAC,EA9JgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QA8JhC"}
+{"version":3,"file":"entity-attachment.js","sourceRoot":"","sources":["../../../src/entity/entity-attachment.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAK7C;;;;GAIG;AACH,IAAiB,gBAAgB,CAkOhC;AAlOD,WAAiB,gBAAgB;IAC7B;;;;;;;;;OASG;IACH,SAAgB,WAAW,CAAC,EAAU;QAClC,OAAO,SAAG,CAAC,SAAS,CAAC,UAAU,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAC5D,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,eAAe,CAAC,QAAgB;QAC5C,OAAO,SAAG,CAAC,SAAS,CAAC,UAAU,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IACzF,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAsBD;;;;OAIG;IACH,SAAsB,MAAM,CAAC,MAO5B;;YAGG,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBACtB,OAAO,OAAO,CAAC,OAAO,CAAC;oBACnB,WAAW,EAAE,EAAE;iBAClB,CAAC,CAAC;aACN;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,cAAc,EAAE;gBACzD,WAAW;aACd,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnB,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;iBACpD;aACJ;YACD,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YAClD,OAAO;gBACH,WAAW,EAAE,GAAG,CAAC,WAAW;aAC/B,CAAC;QACN,CAAC;KAAA;IAhCqB,uBAAM,SAgC3B,CAAA;IAED;;;OAGG;IACH,SAAsB,WAAW,CAAC,MASjC;;YACG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACtF,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE;gBACtB,MAAK,CAAC,qCAAqC,CAAC,CAAC;aAChD;YACD,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBACtB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAC5B;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,OAAO,GAAG;gBACf,oBAAoB,EAAE,CAAC;gBACvB,eAAe,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;aACzD,CAAC;YACF,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,gBAAgB,MAAM,WAAW,EAAE,OAAO,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACpD;YACD,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClE,CAAC;KAAA;IA9BqB,4BAAW,cA8BhC,CAAA;IAED;;;OAGG;IACH,SAAsB,MAAM,CAAC,MAK5B;;YACG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClD,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE;gBAC5B,MAAK,CAAC,8BAA8B,CAAC,CAAC;aACzC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,gBAAgB,YAAY,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3F,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC7D,CAAC;KAAA;IAjBqB,uBAAM,SAiB3B,CAAA;IAED;;;;OAIG;IACH,SAAsB,iBAAiB,CAAC,MAKvC;;YAIG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/C,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAK,CAAC,wBAAwB,CAAC,CAAC;aACnC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC3E,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,cAAc,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC3F,GAAG,CAAC;wBACA,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;qBAClE,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,CAAC,QAAQ,CAAC;gBAC9B,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAtCqB,kCAAiB,oBAsCtC,CAAA;IAED;;;;;OAKG;IACH,SAAsB,MAAM,CAAC,MAS5B;;YAIG,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/E,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE;gBAC/B,MAAK,CAAC,4CAA4C,CAAC,CAAC;aACvD;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,UAAU,QAAQ,eAAe,MAAM,EAAE,CAAC;YACtD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACtE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5C,OAAO;gBACH,UAAU,EAAE,GAAG;aAClB,CAAC;QACN,CAAC;KAAA;IA3BqB,uBAAM,SA2B3B,CAAA;AACL,CAAC,EAlOgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAkOhC"}

package/dist/lib/entity/entity-attribute.js

@@ -1,19 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityAttribute = void 0;
+/**
+ * Describes an entity type schema attribute.
+ */
 var EntityAttribute;
 (function (EntityAttribute) {
     let EType;
     (function (EType) {
+        // Arbitrary text attribute.
         EType["String"] = "String";
+        // Floating point number attribute.
         EType["Double"] = "Double";
+        // Whole number attribute.
         EType["Integer"] = "Integer";
+        // iso8601 date time string.
         EType["Datetime"] = "Datetime";
+        // Group of attributes.
         EType["Structure"] = "Structure";
+        // Nextspace vector geometry.
         EType["Geometry"] = "Geometry";
-        EType["Dictionary"] = "Dictionary";
+        // True/false attribute.
         EType["Boolean"] = "Boolean";
     })(EType = EntityAttribute.EType || (EntityAttribute.EType = {}));
+    /**
+     * Returns an attribute from a provided hierarchy of attributes.
+     * Eg: Use the path: ["Bruce", "ID"] to find the "ID" attribute.
+     * @param items
+     * @param path
+     * @returns
+     */
     function GetAttribute(items, path) {
         if (!items || !path || !path.length) {
             return null;

package/dist/lib/entity/entity-attribute.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-attribute.js","sourceRoot":"","sources":["../../../src/entity/entity-attribute.ts"],"names":[],"mappings":";;;AAAA,IAAiB,eAAe,CAsD/B;AAtDD,WAAiB,eAAe;IAC5B,IAAY,KASX;IATD,WAAY,KAAK;QACb,0BAAiB,CAAA;QACjB,0BAAiB,CAAA;QACjB,4BAAmB,CAAA;QACnB,8BAAqB,CAAA;QACrB,gCAAuB,CAAA;QACvB,8BAAqB,CAAA;QACrB,kCAAyB,CAAA;QACzB,4BAAmB,CAAA;IACvB,CAAC,EATW,KAAK,GAAL,qBAAK,KAAL,qBAAK,QAShB;IAiCD,SAAgB,YAAY,CAAC,KAAmB,EAAE,IAAc;QAC5D,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACjC,OAAO,IAAI,CAAC;SACf;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAC1C,OAAO,IAAI,CAAC;SACf;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAVe,4BAAY,eAU3B,CAAA;AACL,CAAC,EAtDgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAsD/B"}
+{"version":3,"file":"entity-attribute.js","sourceRoot":"","sources":["../../../src/entity/entity-attribute.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAiB,eAAe,CA2G/B;AA3GD,WAAiB,eAAe;IAC5B,IAAY,KAeX;IAfD,WAAY,KAAK;QACb,4BAA4B;QAC5B,0BAAiB,CAAA;QACjB,mCAAmC;QACnC,0BAAiB,CAAA;QACjB,0BAA0B;QAC1B,4BAAmB,CAAA;QACnB,4BAA4B;QAC5B,8BAAqB,CAAA;QACrB,uBAAuB;QACvB,gCAAuB,CAAA;QACvB,6BAA6B;QAC7B,8BAAqB,CAAA;QACrB,wBAAwB;QACxB,4BAAmB,CAAA;IACvB,CAAC,EAfW,KAAK,GAAL,qBAAK,KAAL,qBAAK,QAehB;IAyED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,KAAmB,EAAE,IAAc;QAC5D,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACjC,OAAO,IAAI,CAAC;SACf;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAC1C,OAAO,IAAI,CAAC;SACf;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAVe,4BAAY,eAU3B,CAAA;AACL,CAAC,EA3GgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA2G/B"}

package/dist/lib/entity/entity-comment.js

@@ -13,28 +13,56 @@ exports.EntityComment = void 0;
 const api_1 = require("../api/api");
 const environment_1 = require("../environment");
 /**
- * Describes the "Entity Comment" concept within Bruce.
+ * Describes the "Entity Comment" concept within Nextspace.
  * An entity comment is a user written message that is linked to an entity record.
+ *
+ * @deprecated: The Navigator now uses Entity records directly.
+ * a utility is being made to manage those records.
  */
 var EntityComment;
 (function (EntityComment) {
+    /**
+     * Returns cache identifier for a comment by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id) {
         return api_1.Api.ECacheKey.Comment + api_1.Api.ECacheKey.Id + id;
     }
     EntityComment.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of comments for an entity.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
     function GetListCacheKey(entityId) {
         return api_1.Api.ECacheKey.Comment + api_1.Api.ECacheKey.Entity + api_1.Api.ECacheKey.Id + entityId;
     }
     EntityComment.GetListCacheKey = GetListCacheKey;
+    /**
+     * Creates or updates a comment.
+     * @param params
+     * @returns
+     */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, comment: data, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!(data === null || data === void 0 ? void 0 : data["TargetObject.ID"])) {
                 throw ("TargetObject.ID (entity id) is required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const url = `entity/${data["TargetObject.ID"]}/comment` + (data.ID == null ? "" : "/" + data.ID);
             const res = yield api.POST(url, data, api_1.Api.PrepReqParams(reqParams));
             api.Cache.Remove(GetCacheKey(data.ID));
@@ -45,6 +73,10 @@ var EntityComment;
         });
     }
     EntityComment.Update = Update;
+    /**
+     * Deletes a comment.
+     * @param params
+     */
     function Delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, commentId, req: reqParams } = params;
@@ -60,15 +92,20 @@ var EntityComment;
         });
     }
     EntityComment.Delete = Delete;
+    /**
+     * Gets a list of comments for an entity.
+     * @param params
+     * @returns
+     */
     function GetListByEntityId(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!entityId) {
                 throw ("Entity ID is required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const cache = yield api.GetCacheItem(GetListCacheKey(entityId), reqParams);
             if (cache === null || cache === void 0 ? void 0 : cache.found) {
                 return cache.data;

package/dist/lib/entity/entity-comment.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-comment.js","sourceRoot":"","sources":["../../../src/entity/entity-comment.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAE7C;;;GAGG;AACH,IAAiB,aAAa,CAoG7B;AApGD,WAAiB,aAAa;IAC1B,SAAgB,WAAW,CAAC,EAAU;QAClC,OAAO,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IACzD,CAAC;IAFe,yBAAW,cAE1B,CAAA;IAED,SAAgB,eAAe,CAAC,QAAgB;QAC5C,OAAO,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IACtF,CAAC;IAFe,6BAAe,kBAE9B,CAAA;IAaD,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACpD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,iBAAiB,CAAC,CAAA,EAAE;gBAC5B,MAAK,CAAC,0CAA0C,CAAC,CAAC;aACrD;YACD,MAAM,GAAG,GAAG,UAAU,IAAI,CAAC,iBAAiB,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;YACjG,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACpE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACjF,OAAO;gBACH,OAAO,EAAE,GAAG;aACf,CAAC;QACN,CAAC;KAAA;IAtBqB,oBAAM,SAsB3B,CAAA;IAED,SAAsB,MAAM,CAAC,MAK5B;;YACG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC1D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,SAAS,EAAE;gBACZ,MAAK,CAAC,yBAAyB,CAAC,CAAC;aACpC;YACD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,YAAY,SAAS,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1F,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACrF,CAAC;KAAA;IAjBqB,oBAAM,SAiB3B,CAAA;IAED,SAAsB,iBAAiB,CAAC,MAIvC;;YAGG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/C,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAK,CAAC,wBAAwB,CAAC,CAAC;aACnC;YACD,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC3E,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,WAAW,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBACxF,GAAG,CAAC;wBACA,QAAQ,EAAE,IAAI,CAAC,KAAK;qBACvB,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,CAAC,QAAQ,CAAC;gBAC9B,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IApCqB,+BAAiB,oBAoCtC,CAAA;AACL,CAAC,EApGgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAoG7B"}
+{"version":3,"file":"entity-comment.js","sourceRoot":"","sources":["../../../src/entity/entity-comment.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAE7C;;;;;;GAMG;AACH,IAAiB,aAAa,CAyJ7B;AAzJD,WAAiB,aAAa;IAC1B;;;;;;;;;OASG;IACH,SAAgB,WAAW,CAAC,EAAU;QAClC,OAAO,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IACzD,CAAC;IAFe,yBAAW,cAE1B,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,eAAe,CAAC,QAAgB;QAC5C,OAAO,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IACtF,CAAC;IAFe,6BAAe,kBAE9B,CAAA;IAyBD;;;;OAIG;IACH,SAAsB,MAAM,CAAC,MAK5B;;YAIG,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACpD,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,iBAAiB,CAAC,CAAA,EAAE;gBAC5B,MAAK,CAAC,0CAA0C,CAAC,CAAC;aACrD;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,UAAU,IAAI,CAAC,iBAAiB,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;YACjG,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACpE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAEjF,OAAO;gBACH,OAAO,EAAE,GAAG;aACf,CAAC;QACN,CAAC;KAAA;IAzBqB,oBAAM,SAyB3B,CAAA;IAED;;;OAGG;IACH,SAAsB,MAAM,CAAC,MAO5B;;YACG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC1D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,SAAS,EAAE;gBACZ,MAAK,CAAC,yBAAyB,CAAC,CAAC;aACpC;YACD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,YAAY,SAAS,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1F,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,MAAM,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,SAAG,CAAC,SAAS,CAAC,OAAO,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACrF,CAAC;KAAA;IAnBqB,oBAAM,SAmB3B,CAAA;IAED;;;;OAIG;IACH,SAAsB,iBAAiB,CAAC,MAKvC;;YAIG,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC/C,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAK,CAAC,wBAAwB,CAAC,CAAC;aACnC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC3E,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,WAAW,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBACxF,GAAG,CAAC;wBACA,QAAQ,EAAE,IAAI,CAAC,KAAK;qBACvB,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,eAAe,CAAC,QAAQ,CAAC;gBAC9B,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAtCqB,+BAAiB,oBAsCtC,CAAA;AACL,CAAC,EAzJgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAyJ7B"}

package/dist/lib/entity/entity-coords.js

@@ -13,13 +13,31 @@ exports.EntityCoords = void 0;
 const api_1 = require("../api/api");
 const environment_1 = require("../environment");
 const math_utils_1 = require("../util/math-utils");
+/**
+ * This is a utility to help calculate and manage UCS coordinates for entities.
+ */
 var EntityCoords;
 (function (EntityCoords) {
     EntityCoords.UCS_ENTITY_TYPE_ID = "Bruce_UCS_Type";
+    /**
+     * Returns cache identifier for a UCS by entity id.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
     function GetCacheKey(entityId) {
         return api_1.Api.ECacheKey.EntityCoords + api_1.Api.ECacheKey.Entity + api_1.Api.ECacheKey.Id + entityId;
     }
     EntityCoords.GetCacheKey = GetCacheKey;
+    /**
+     * Returns an entity's location with expanded UCS information.
+     * @param params
+     * @returns
+     */
     function GetEntityCoords(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, rootEntityId: entityId, req: reqParams } = params;
@@ -50,6 +68,11 @@ var EntityCoords;
         });
     }
     EntityCoords.GetEntityCoords = GetEntityCoords;
+    /**
+     * Returns coordinates for an entity when relative to a point.
+     * @param params
+     * @returns
+     */
     function EntityRelativeToPoint(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, rootEntityId: entityId, req: reqParams } = params;
@@ -89,6 +112,11 @@ var EntityCoords;
         });
     }
     EntityCoords.EntityRelativeToPoint = EntityRelativeToPoint;
+    /**
+     * Returns coordinates for an entity when relative to an EPSG.
+     * @param params
+     * @returns
+     */
     function EntityRelativeToEpsg(params) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -127,6 +155,11 @@ var EntityCoords;
         });
     }
     EntityCoords.EntityRelativeToEpsg = EntityRelativeToEpsg;
+    /**
+     * Returns coordinates for an entity when relative to a UCS.
+     * @param params
+     * @returns
+     */
     function EntityRelativeToUcs(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, rootEntityId: entityId, req: reqParams } = params;
@@ -156,6 +189,11 @@ var EntityCoords;
         });
     }
     EntityCoords.EntityRelativeToUcs = EntityRelativeToUcs;
+    /**
+     * Unlinks UCS coordinates from an entity.
+     * @param params
+     * @returns
+     */
     function UnlinkCoords(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, rootEntityId: entityId, req: reqParams } = params;

package/dist/lib/entity/entity-coords.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-coords.js","sourceRoot":"","sources":["../../../src/entity/entity-coords.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAIjC,gDAA6C;AAC7C,mDAA+C;AAG/C,IAAiB,YAAY,CA0M5B;AA1MD,WAAiB,YAAY;IACZ,+BAAkB,GAAG,gBAAgB,CAAC;IAEnD,SAAgB,WAAW,CAAC,QAAgB;QACxC,OAAO,SAAG,CAAC,SAAS,CAAC,YAAY,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IAC3F,CAAC;IAFe,wBAAW,cAE1B,CAAA;IA+BD,SAAsB,eAAe,CAAC,MAIrC;;YAGG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YACvE,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,IAAI,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACtD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,MAAM,EAAE,SAAS,CAAC,CAAC;oBAChE,GAAG,CAAC;wBACA,MAAM,EAAE,IAAI;qBACf,CAAC,CAAC;iBACN;gBAAC,OAAO,CAAC,EAAE;oBACR,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC;gBAC1B,KAAK,EAAE,IAAI;gBACX,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAhCqB,4BAAe,kBAgCpC,CAAA;IAED,SAAsB,qBAAqB,CAAC,MAIvB;;YAGjB,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC5G,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,IAAI;oBACjB,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE;wBACR,UAAU,EAAE,KAAK,CAAC,QAAQ;wBAC1B,WAAW,EAAE,KAAK,CAAC,SAAS;wBAC5B,UAAU,EAAE,KAAK,CAAC,QAAQ;wBAC1B,aAAa,EAAE;4BACX,WAAW,EAAE,QAAQ;yBACxB;qBACJ;iBACJ;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;QACN,CAAC;KAAA;IA1CqB,kCAAqB,wBA0C1C,CAAA;IAED,SAAsB,oBAAoB,CAAC,MAIvB;;;YAGhB,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACzB,MAAM,IAAI,GAAG,MAAA,MAAM,CAAC,IAAI,mCAAI,QAAQ,GAAG,IAAI,CAAC;YAC5C,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,IAAI;oBACjB,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE;wBACR,aAAa,EAAE;4BACX,MAAM,EAAE,OAAO,GAAG,IAAI;4BACtB,WAAW,EAAE,QAAQ;yBACxB;qBACJ;iBACJ;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;;KACL;IAxCqB,iCAAoB,uBAwCzC,CAAA;IAED,SAAsB,mBAAmB,CAAC,MAIvB;;YAGf,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,KAAK;iBACrB;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;QACN,CAAC;KAAA;IAhCqB,gCAAmB,sBAgCxC,CAAA;IAED,SAAsB,YAAY,CAAC,MAIlC;;YACG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,MAAM,EAAE,SAAS,CAAC,CAAC;QAC3D,CAAC;KAAA;IAXqB,yBAAY,eAWjC,CAAA;AACL,CAAC,EA1MgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA0M5B"}
+{"version":3,"file":"entity-coords.js","sourceRoot":"","sources":["../../../src/entity/entity-coords.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAIjC,gDAA6C;AAC7C,mDAA+C;AAG/C;;GAEG;AACH,IAAiB,YAAY,CAkR5B;AAlRD,WAAiB,YAAY;IACZ,+BAAkB,GAAG,gBAAgB,CAAC;IAEnD;;;;;;;;;OASG;IACH,SAAgB,WAAW,CAAC,QAAgB;QACxC,OAAO,SAAG,CAAC,SAAS,CAAC,YAAY,GAAG,SAAG,CAAC,SAAS,CAAC,MAAM,GAAG,SAAG,CAAC,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC;IAC3F,CAAC;IAFe,wBAAW,cAE1B,CAAA;IA2DD;;;;OAIG;IACH,SAAsB,eAAe,CAAC,MAKrC;;YAIG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YACvE,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,MAAM,IAAI,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACtD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,QAAQ,MAAM,EAAE,SAAS,CAAC,CAAC;oBAChE,GAAG,CAAC;wBACA,MAAM,EAAE,IAAI;qBACf,CAAC,CAAC;iBACN;gBAAC,OAAO,CAAC,EAAE;oBACR,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,YAAY,CAAC;gBACnB,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC;gBAC1B,KAAK,EAAE,IAAI;gBACX,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAlCqB,4BAAe,kBAkCpC,CAAA;IAED;;;;OAIG;IACH,SAAsB,qBAAqB,CAAC,MAKvB;;YAIjB,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC5G,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,IAAI;oBACjB,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE;wBACR,UAAU,EAAE,KAAK,CAAC,QAAQ;wBAC1B,WAAW,EAAE,KAAK,CAAC,SAAS;wBAC5B,UAAU,EAAE,KAAK,CAAC,QAAQ;wBAC1B,aAAa,EAAE;4BACX,WAAW,EAAE,QAAQ;yBACxB;qBACJ;iBACJ;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;QACN,CAAC;KAAA;IA5CqB,kCAAqB,wBA4C1C,CAAA;IAED;;;;OAIG;IACH,SAAsB,oBAAoB,CAAC,MAKvB;;;YAIhB,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACzB,MAAM,IAAI,GAAG,MAAA,MAAM,CAAC,IAAI,mCAAI,QAAQ,GAAG,IAAI,CAAC;YAC5C,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,IAAI;oBACjB,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE;wBACR,aAAa,EAAE;4BACX,MAAM,EAAE,OAAO,GAAG,IAAI;4BACtB,WAAW,EAAE,QAAQ;yBACxB;qBACJ;iBACJ;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;;KACL;IA1CqB,iCAAoB,uBA0CzC,CAAA;IAED;;;;OAIG;IACH,SAAsB,mBAAmB,CAAC,MAKvB;;YAIf,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,MAAM,YAAY,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,QAAQ;oBACtB,GAAG,EAAE,SAAS;iBACjB,CAAC,CAAC;aACN;YACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,MAAM,EAAE;gBACjD,KAAK,EAAE;oBACH,WAAW,EAAE,KAAK;iBACrB;gBACD,MAAM,EAAE,MAAM,CAAC,IAAI;aACtB,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO;gBACH,MAAM,EAAE,GAAG;aACd,CAAC;QACN,CAAC;KAAA;IAlCqB,gCAAmB,sBAkCxC,CAAA;IAED;;;;OAIG;IACH,SAAsB,YAAY,CAAC,MAKlC;;YACG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,QAAQ,MAAM,EAAE,SAAS,CAAC,CAAC;QAC3D,CAAC;KAAA;IAZqB,yBAAY,eAYjC,CAAA;AACL,CAAC,EAlRgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAkR5B"}

package/dist/lib/entity/entity-link.js

@@ -13,28 +13,53 @@ exports.EntityLink = void 0;
 const api_1 = require("../api/api");
 const environment_1 = require("../environment");
 /**
- * Describes the "Entity Link" concept within Bruce.
- * An entity link is a URL linked to an entity record.
+ * Describes the "Entity Link" concept within Nextspace.
+ * An entity link is an external URL linked to an entity record.
  */
 var EntityLink;
 (function (EntityLink) {
+    /**
+     * Returns cache identifier for a link record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id) {
         return api_1.Api.ECacheKey.Link + api_1.Api.ECacheKey.Id + id;
     }
     EntityLink.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of links for an entity.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
     function GetListCacheKey(entityId) {
         return api_1.Api.ECacheKey.Link + api_1.Api.ECacheKey.Entity + api_1.Api.ECacheKey.Id + entityId;
     }
     EntityLink.GetListCacheKey = GetListCacheKey;
+    /**
+     * Creates or updates a link record.
+     * @param params
+     * @returns
+     */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, link: data, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!(data === null || data === void 0 ? void 0 : data["Entity.ID"])) {
                 throw ("Entity ID is required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const url = `entity/${data["Entity.ID"]}/link` + (data.ID == null ? "" : "/" + data.ID);
             const res = yield api.POST(url, data, api_1.Api.PrepReqParams(reqParams));
             api.Cache.Remove(GetCacheKey(data.ID));
@@ -45,30 +70,39 @@ var EntityLink;
         });
     }
     EntityLink.Update = Update;
+    /**
+     * Deletes a link record.
+     * @param params
+     */
     function Delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, linkId, req: reqParams } = params;
+            if (!linkId || !entityId) {
+                throw ("Link ID and Entity ID are required.");
+            }
             if (!api) {
                 api = environment_1.ENVIRONMENT.Api().GetBruceApi();
             }
-            if (!linkId) {
-                throw ("Link ID is required.");
-            }
             yield api.DELETE(`entity/${entityId}/link/${linkId}`, api_1.Api.PrepReqParams(reqParams));
             api.Cache.Remove(GetCacheKey(linkId));
             yield api.Cache.RemoveByStartsWith(api_1.Api.ECacheKey.Link + api_1.Api.ECacheKey.Entity);
         });
     }
     EntityLink.Delete = Delete;
+    /**
+     * Returns a list of links for an entity.
+     * @param params
+     * @returns
+     */
     function GetListByEntityId(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, entityId, req: reqParams } = params;
-            if (!api) {
-                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
-            }
             if (!entityId) {
                 throw ("Entity ID is required.");
             }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
             const cache = yield api.GetCacheItem(GetListCacheKey(entityId), reqParams);
             if (cache === null || cache === void 0 ? void 0 : cache.found) {
                 return cache.data;