bruce-models 3.5.1 → 3.5.2

package/README.md

@@ -0,0 +1,31 @@
+# bruce-models
+
+This is a library which defines data-models for the Nextspace API and provides functions for communicating with the endpoints.
+
+<br>
+
+### Local build
+
+- `npm i`
+
+- `npm run build`
+
+<br>
+
+### Running tests
+
+- `npm i` (ignore if already run)
+
+- `npm run test` (running all tests)
+
+- `npx run jest ./test/unit/util` (example for testing just one test folder)
+
+<br>
+
+### Publishing new versions
+
+- Increase version inside `package.json` and push the change.
+
+- Bitbucket will run a build and test step.
+
+- Manually click `NPM Release` in Bitbucket Pipelines.

package/dist/bruce-models.es5.js

@@ -806,51 +806,6 @@ const ACCOUNT_EXCLUSIONS = ["hyperportal", "hypeportal", "bviewer"];
  */
 var Account;
 (function (Account) {
-    /**
-     * Returns cache identifier for an account by ID.
-     * Example: {
-     *    const api: BruceApi.Api = ...;
-     *    const key = GetCacheKey(1);
-     *    api.Cache.Remove(key);
-     * }
-     * @param accountId
-     * @param appSettingsId
-     * @returns
-     */
-    function GetCacheKey(accountId, appSettingsId) {
-        if (appSettingsId) {
-            return Api.ECacheKey.Account + Api.ECacheKey.Id + accountId + Api.ECacheKey + appSettingsId;
-        }
-        return Api.ECacheKey.Account + Api.ECacheKey.Id + accountId;
-    }
-    Account.GetCacheKey = GetCacheKey;
-    /**
-     * Returns cache identifier for a list of accounts by session ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey(api.GetSessionId());
-     *     api.Cache.Remove(key);
-     * }
-     * @param ssid
-     * @returns
-     */
-    function GetListCacheKey(ssid) {
-        return Api.ECacheKey.Account + Api.ECacheKey.Session + Api.ECacheKey.Id + ssid;
-    }
-    Account.GetListCacheKey = GetListCacheKey;
-    /**
-     * Returns cache identifier for a list of database regions.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetDbRegionListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetDbRegionListCacheKey() {
-        return Api.ECacheKey.DatabaseRegion;
-    }
-    Account.GetDbRegionListCacheKey = GetDbRegionListCacheKey;
     /**
      * Known Nextspace applications we store settings for.
      */
@@ -1081,6 +1036,51 @@ var Account;
         });
     }
     Account.Create = Create;
+    /**
+     * Returns cache identifier for an account by ID.
+     * Example: {
+     *    const api: BruceApi.Api = ...;
+     *    const key = GetCacheKey(1);
+     *    api.Cache.Remove(key);
+     * }
+     * @param accountId
+     * @param appSettingsId
+     * @returns
+     */
+    function GetCacheKey(accountId, appSettingsId) {
+        if (appSettingsId) {
+            return Api.ECacheKey.Account + Api.ECacheKey.Id + accountId + Api.ECacheKey + appSettingsId;
+        }
+        return Api.ECacheKey.Account + Api.ECacheKey.Id + accountId;
+    }
+    Account.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of accounts by session ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey(api.GetSessionId());
+     *     api.Cache.Remove(key);
+     * }
+     * @param ssid
+     * @returns
+     */
+    function GetListCacheKey(ssid) {
+        return Api.ECacheKey.Account + Api.ECacheKey.Session + Api.ECacheKey.Id + ssid;
+    }
+    Account.GetListCacheKey = GetListCacheKey;
+    /**
+     * Returns cache identifier for a list of database regions.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetDbRegionListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetDbRegionListCacheKey() {
+        return Api.ECacheKey.DatabaseRegion;
+    }
+    Account.GetDbRegionListCacheKey = GetDbRegionListCacheKey;
 })(Account || (Account = {}));
 
 /**
@@ -1949,34 +1949,6 @@ var ENVIRONMENT;
  */
 var AnnDocument;
 (function (AnnDocument) {
-    /**
-     * Returns cache identifier for an annotated document by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id) {
-        return `${Api.ECacheKey.AnnDocument}${Api.ECacheKey.Id}${id}`;
-    }
-    AnnDocument.GetCacheKey = GetCacheKey;
-    /**
-     * Returns cache identifier for a list of annotated documents by type.
-     * Example: {
-     *    const api: BruceApi.Api = ...;
-     *    const key = GetListCacheKey("SVG");
-     *    api.Cache.Remove(key);
-     * }
-     * @param type
-     * @returns
-     */
-    function GetListCacheKey(type) {
-        return Api.ECacheKey.AnnDocument + type;
-    }
-    AnnDocument.GetListCacheKey = GetListCacheKey;
     /**
      * The types of supported annotated documents.
      */
@@ -2062,16 +2034,8 @@ var AnnDocument;
         });
     }
     AnnDocument.GetList = GetList;
-})(AnnDocument || (AnnDocument = {}));
-
-/**
- * Describes the "Custom Form" concept within Nextspace.
- * Custom forms are dynamic dialogs that get populated with Entity data.
- */
-var CustomForm;
-(function (CustomForm) {
     /**
-     * Returns cache identifier for a Custom Form by ID.
+     * Returns cache identifier for an annotated document by ID.
      * Example: {
      *     const api: BruceApi.Api = ...;
      *     const key = GetCacheKey(1);
@@ -2081,26 +2045,31 @@ var CustomForm;
      * @returns
      */
     function GetCacheKey(id) {
-        return Api.ECacheKey.CustomForm + Api.ECacheKey.Id + id;
+        return `${Api.ECacheKey.AnnDocument}${Api.ECacheKey.Id}${id}`;
     }
-    CustomForm.GetCacheKey = GetCacheKey;
+    AnnDocument.GetCacheKey = GetCacheKey;
     /**
-     * Returns cache identifier for a list of Custom Forms by Entity Type ID.
+     * Returns cache identifier for a list of annotated documents by type.
      * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("123");
-     *     api.Cache.Remove(key);
+     *    const api: BruceApi.Api = ...;
+     *    const key = GetListCacheKey("SVG");
+     *    api.Cache.Remove(key);
      * }
-     * @param typeId
+     * @param type
      * @returns
      */
-    function GetListCacheKey(typeId) {
-        if (typeId) {
-            return Api.ECacheKey.CustomForm + Api.ECacheKey.EntityType + Api.ECacheKey.Id + typeId;
-        }
-        return Api.ECacheKey.CustomForm;
+    function GetListCacheKey(type) {
+        return Api.ECacheKey.AnnDocument + type;
     }
-    CustomForm.GetListCacheKey = GetListCacheKey;
+    AnnDocument.GetListCacheKey = GetListCacheKey;
+})(AnnDocument || (AnnDocument = {}));
+
+/**
+ * Describes the "Custom Form" concept within Nextspace.
+ * Custom forms are dynamic dialogs that get populated with Entity data.
+ */
+var CustomForm;
+(function (CustomForm) {
     /**
      * Types of custom forms available.
      */
@@ -2221,6 +2190,37 @@ var CustomForm;
         });
     }
     CustomForm.Update = Update;
+    /**
+     * Returns cache identifier for a Custom Form by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id) {
+        return Api.ECacheKey.CustomForm + Api.ECacheKey.Id + id;
+    }
+    CustomForm.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of Custom Forms by Entity Type ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
+    function GetListCacheKey(typeId) {
+        if (typeId) {
+            return Api.ECacheKey.CustomForm + Api.ECacheKey.EntityType + Api.ECacheKey.Id + typeId;
+        }
+        return Api.ECacheKey.CustomForm;
+    }
+    CustomForm.GetListCacheKey = GetListCacheKey;
 })(CustomForm || (CustomForm = {}));
 
 /**
@@ -4491,34 +4491,6 @@ class LRUCache {
  */
 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.ECacheKey.AttachmentType + 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.ECacheKey.AttachmentType;
-    }
-    EntityAttachmentType.GetListCacheKey = GetListCacheKey;
     // Known attachment types.
     let EType;
     (function (EType) {
@@ -4603,17 +4575,8 @@ var EntityAttachmentType;
         });
     }
     EntityAttachmentType.GetList = GetList;
-})(EntityAttachmentType || (EntityAttachmentType = {}));
-
-/**
- * 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.
+     * Returns cache identifier for an attachment type by ID.
      * Example: {
      *     const api: BruceApi.Api = ...;
      *     const key = GetCacheKey("123");
@@ -4623,23 +4586,32 @@ var EntityAttachment;
      * @returns
      */
     function GetCacheKey(id) {
-        return Api.ECacheKey.Attachment + Api.ECacheKey.Id + id;
+        return Api.ECacheKey.AttachmentType + Api.ECacheKey.Id + id;
     }
-    EntityAttachment.GetCacheKey = GetCacheKey;
+    EntityAttachmentType.GetCacheKey = GetCacheKey;
     /**
-     * Returns cache identifier for a list of attachments for an entity.
+     * Returns cache identifier for a list of attachment types.
      * Example: {
      *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
+     *     const key = GetListCacheKey();
      *     api.Cache.Remove(key);
      * }
      * @param typeId
      * @returns
      */
-    function GetListCacheKey(entityId) {
-        return Api.ECacheKey.Attachment + Api.ECacheKey.Entity + Api.ECacheKey.Id + entityId;
+    function GetListCacheKey() {
+        return Api.ECacheKey.AttachmentType;
     }
-    EntityAttachment.GetListCacheKey = GetListCacheKey;
+    EntityAttachmentType.GetListCacheKey = GetListCacheKey;
+})(EntityAttachmentType || (EntityAttachmentType = {}));
+
+/**
+ * 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) {
     /**
      * Updates one or many attachment records.
      * @param params
@@ -4780,6 +4752,34 @@ var EntityAttachment;
         });
     }
     EntityAttachment.Upload = Upload;
+    /**
+     * 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.ECacheKey.Attachment + 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.ECacheKey.Attachment + Api.ECacheKey.Entity + Api.ECacheKey.Id + entityId;
+    }
+    EntityAttachment.GetListCacheKey = GetListCacheKey;
 })(EntityAttachment || (EntityAttachment = {}));
 
 /**
@@ -6065,9 +6065,24 @@ var EntityTag;
             const reqs = [];
             for (let i = 0; i < tagIds.length; i++) {
                 const tagId = tagIds[i];
-                const cache = yield api.GetCacheItem(GetCacheKey(tagId), reqParams);
+                const cache = api.GetCacheItem(GetCacheKey(tagId), reqParams);
                 if (cache === null || cache === void 0 ? void 0 : cache.found) {
-                    reqs.push(cache.data);
+                    if (cache.data instanceof Promise) {
+                        // Request that is in progress.
+                        reqs.push(cache.data);
+                    }
+                    else if (cache.data) {
+                        // Direct tag record.
+                        if (cache.data.ID) {
+                            reqs.push({
+                                tag: cache.data
+                            });
+                        }
+                        // Resolved promise. So an object with a "tag" property that contains the record.
+                        else {
+                            reqs.push(cache.data);
+                        }
+                    }
                 }
                 else {
                     reqIds.push(tagId);
@@ -6620,20 +6635,6 @@ var Uploader;
  */
 var ClientFile;
 (function (ClientFile) {
-    /**
-     * Returns cache identifier for a client file by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param fileId
-     * @returns
-     */
-    function GetCacheKey(fileId) {
-        return `${Api.ECacheKey.ClientFile}${Api.ECacheKey.Id}${fileId}`;
-    }
-    ClientFile.GetCacheKey = GetCacheKey;
     let EPurpose;
     (function (EPurpose) {
         // Use this purpose for uploading bookmark thumbnail images.
@@ -6955,6 +6956,20 @@ var ClientFile;
         }
         Processor.ConvertFormat = ConvertFormat;
     })(Processor = ClientFile.Processor || (ClientFile.Processor = {}));
+    /**
+     * Returns cache identifier for a client file by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param fileId
+     * @returns
+     */
+    function GetCacheKey(fileId) {
+        return `${Api.ECacheKey.ClientFile}${Api.ECacheKey.Id}${fileId}`;
+    }
+    ClientFile.GetCacheKey = GetCacheKey;
 })(ClientFile || (ClientFile = {}));
 
 /**
@@ -10617,40 +10632,40 @@ var Plugin;
             window[paramsId] = pluginParams ? pluginParams : {};
             const disposeId = ObjectUtils.UId();
             const elementId = ObjectUtils.UId();
-            let script = `
-            function run() {
-                ${fileContent}
-
-                const paramsId = "${paramsId}";
-                const containerId = "${containerId}";
-                let container;
-                if (containerId) {
-                    container = document.getElementById("${containerId}");
-                }
-
-                let pluginHTML = null;
-                if (container) {
-                    pluginHTML = document.createElement("div");
-                    pluginHTML.id = "${elementId}";
-                    container.appendChild(pluginHTML);
-                }
-
-                {TEMPLATE_CODE}
-                const params = window["${paramsId}"];
-
-                window["${disposeId}"] = Run({
-                    element: pluginHTML,
-                    container: container,
-                    pluginParams: params
-                });
-            }
-            run();
+            let script = `
+            function run() {
+                ${fileContent}
+
+                const paramsId = "${paramsId}";
+                const containerId = "${containerId}";
+                let container;
+                if (containerId) {
+                    container = document.getElementById("${containerId}");
+                }
+
+                let pluginHTML = null;
+                if (container) {
+                    pluginHTML = document.createElement("div");
+                    pluginHTML.id = "${elementId}";
+                    container.appendChild(pluginHTML);
+                }
+
+                {TEMPLATE_CODE}
+                const params = window["${paramsId}"];
+
+                window["${disposeId}"] = Run({
+                    element: pluginHTML,
+                    container: container,
+                    pluginParams: params
+                });
+            }
+            run();
         `;
             if (script.includes("var template")) {
-                script = script.replace("{TEMPLATE_CODE}", `
-                if (pluginHTML && template) {
-                    pluginHTML.innerHTML = template;
-                }
+                script = script.replace("{TEMPLATE_CODE}", `
+                if (pluginHTML && template) {
+                    pluginHTML.innerHTML = template;
+                }
             `);
             }
             else {
@@ -10679,33 +10694,6 @@ var Plugin;
 
 var DataSource;
 (function (DataSource) {
-    /**
-     * Returns cache identifier for a data source by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id) {
-        return Api.ECacheKey.DataSource + Api.ECacheKey.Id + id;
-    }
-    DataSource.GetCacheKey = GetCacheKey;
-    /**
-     * Returns cache identifier for a list of data sources.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey() {
-        return Api.ECacheKey.DataSource;
-    }
-    DataSource.GetListCacheKey = GetListCacheKey;
     // Known data source types.
     let EType;
     (function (EType) {
@@ -10822,9 +10810,37 @@ var DataSource;
         });
     }
     DataSource.GetList = GetList;
+    /**
+     * Returns cache identifier for a data source by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id) {
+        return Api.ECacheKey.DataSource + Api.ECacheKey.Id + id;
+    }
+    DataSource.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for a list of data sources.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey() {
+        return Api.ECacheKey.DataSource;
+    }
+    DataSource.GetListCacheKey = GetListCacheKey;
 })(DataSource || (DataSource = {}));
 
-const VERSION = "3.5.1";
+// This is updated with the package.json version on build.
+const VERSION = "3.5.2";
 
 export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityTypeVisualSettings, EntityAttribute, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, ImportCad, ImportCsv, ImportJson, ImportKml, ImportedFile, Markup, Uploader, Plugin, ENVIRONMENT, DataSource };
 //# sourceMappingURL=bruce-models.es5.js.map