bruce-models 3.5.1 → 3.5.3

package/dist/bruce-models.umd.js

@@ -39,6 +39,7 @@
         let ECacheKey;
         (function (ECacheKey) {
             ECacheKey["Id"] = ":";
+            ECacheKey["ListId"] = "::";
             ECacheKey["Entity"] = "entity";
             ECacheKey["EntityType"] = "entitytype";
             ECacheKey["ProjectView"] = "projectview";
@@ -797,51 +798,6 @@
     // Some accounts may not be "dead" but instead purposely don't have a NextspaceAPI database so we'll avoid them too.
     const ACCOUNT_EXCLUSIONS = ["hyperportal", "hypeportal", "bviewer"];
     (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 exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Id + accountId + exports.Api.ECacheKey + appSettingsId;
-            }
-            return exports.Api.ECacheKey.Account + exports.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 exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Session + exports.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 exports.Api.ECacheKey.DatabaseRegion;
-        }
-        Account.GetDbRegionListCacheKey = GetDbRegionListCacheKey;
         /**
          * Known Nextspace applications we store settings for.
          */
@@ -1072,6 +1028,51 @@
             });
         }
         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 exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Id + accountId + exports.Api.ECacheKey + appSettingsId;
+            }
+            return exports.Api.ECacheKey.Account + exports.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 exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Session + exports.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 exports.Api.ECacheKey.DatabaseRegion;
+        }
+        Account.GetDbRegionListCacheKey = GetDbRegionListCacheKey;
     })(exports.Account || (exports.Account = {}));
 
     (function (HostingLocation) {
@@ -1918,34 +1919,6 @@
     })(exports.ENVIRONMENT || (exports.ENVIRONMENT = {}));
 
     (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 `${exports.Api.ECacheKey.AnnDocument}${exports.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 exports.Api.ECacheKey.AnnDocument + type;
-        }
-        AnnDocument.GetListCacheKey = GetListCacheKey;
         /**
          * The types of supported annotated documents.
          */
@@ -2031,11 +2004,8 @@
             });
         }
         AnnDocument.GetList = GetList;
-    })(exports.AnnDocument || (exports.AnnDocument = {}));
-
-    (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);
@@ -2045,26 +2015,26 @@
          * @returns
          */
         function GetCacheKey(id) {
-            return exports.Api.ECacheKey.CustomForm + exports.Api.ECacheKey.Id + id;
+            return `${exports.Api.ECacheKey.AnnDocument}${exports.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 exports.Api.ECacheKey.CustomForm + exports.Api.ECacheKey.EntityType + exports.Api.ECacheKey.Id + typeId;
-            }
-            return exports.Api.ECacheKey.CustomForm;
+        function GetListCacheKey(type) {
+            return exports.Api.ECacheKey.AnnDocument + type;
         }
-        CustomForm.GetListCacheKey = GetListCacheKey;
+        AnnDocument.GetListCacheKey = GetListCacheKey;
+    })(exports.AnnDocument || (exports.AnnDocument = {}));
+
+    (function (CustomForm) {
         /**
          * Types of custom forms available.
          */
@@ -2185,6 +2155,37 @@
             });
         }
         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 exports.Api.ECacheKey.CustomForm + exports.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 exports.Api.ECacheKey.CustomForm + exports.Api.ECacheKey.EntityType + exports.Api.ECacheKey.Id + typeId;
+            }
+            return exports.Api.ECacheKey.CustomForm;
+        }
+        CustomForm.GetListCacheKey = GetListCacheKey;
     })(exports.CustomForm || (exports.CustomForm = {}));
 
     /**
@@ -4416,34 +4417,6 @@
     }
 
     (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 exports.Api.ECacheKey.AttachmentType + exports.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 exports.Api.ECacheKey.AttachmentType;
-        }
-        EntityAttachmentType.GetListCacheKey = GetListCacheKey;
         // Known attachment types.
         let EType;
         (function (EType) {
@@ -4528,11 +4501,8 @@
             });
         }
         EntityAttachmentType.GetList = GetList;
-    })(exports.EntityAttachmentType || (exports.EntityAttachmentType = {}));
-
-    (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");
@@ -4542,23 +4512,26 @@
          * @returns
          */
         function GetCacheKey(id) {
-            return exports.Api.ECacheKey.Attachment + exports.Api.ECacheKey.Id + id;
+            return exports.Api.ECacheKey.AttachmentType + exports.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 exports.Api.ECacheKey.Attachment + exports.Api.ECacheKey.Entity + exports.Api.ECacheKey.Id + entityId;
+        function GetListCacheKey() {
+            return exports.Api.ECacheKey.AttachmentType;
         }
-        EntityAttachment.GetListCacheKey = GetListCacheKey;
+        EntityAttachmentType.GetListCacheKey = GetListCacheKey;
+    })(exports.EntityAttachmentType || (exports.EntityAttachmentType = {}));
+
+    (function (EntityAttachment) {
         /**
          * Updates one or many attachment records.
          * @param params
@@ -4699,6 +4672,34 @@
             });
         }
         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 exports.Api.ECacheKey.Attachment + exports.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 exports.Api.ECacheKey.Attachment + exports.Api.ECacheKey.Entity + exports.Api.ECacheKey.Id + entityId;
+        }
+        EntityAttachment.GetListCacheKey = GetListCacheKey;
     })(exports.EntityAttachment || (exports.EntityAttachment = {}));
 
     (function (EntityComment) {
@@ -5935,9 +5936,24 @@
                 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);
@@ -6474,20 +6490,6 @@
     })(exports.Uploader || (exports.Uploader = {}));
 
     (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 `${exports.Api.ECacheKey.ClientFile}${exports.Api.ECacheKey.Id}${fileId}`;
-        }
-        ClientFile.GetCacheKey = GetCacheKey;
         let EPurpose;
         (function (EPurpose) {
             // Use this purpose for uploading bookmark thumbnail images.
@@ -6809,6 +6811,20 @@
             }
             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 `${exports.Api.ECacheKey.ClientFile}${exports.Api.ECacheKey.Id}${fileId}`;
+        }
+        ClientFile.GetCacheKey = GetCacheKey;
     })(exports.ClientFile || (exports.ClientFile = {}));
 
     (function (ProgramKey) {
@@ -7917,36 +7933,15 @@
     })(exports.ProjectViewBookmark || (exports.ProjectViewBookmark = {}));
 
     (function (ProjectView) {
-        /**
-         * Returns cache identifier for a project view.
-         * Example: {
-         *     const api: BruceApi.Api = ...;
-         *     const key = GetCacheKey("abc");
-         *     api.Cache.Remove(key);
-         * }
-         * @param viewId
-         * @returns
-         */
-        function GetCacheKey(viewId) {
-            return `${exports.Api.ECacheKey.ProjectView}${exports.Api.ECacheKey.Id}${viewId}`;
-        }
-        ProjectView.GetCacheKey = GetCacheKey;
-        /**
-         * Returns cache identifier for a list of project views.
-         * Example: {
-         *     const api: BruceApi.Api = ...;
-         *     const key = GetListCacheKey();
-         *     api.Cache.Remove(key);
-         * }
-         * @returns
-         */
-        function GetListCacheKey() {
-            return exports.Api.ECacheKey.ProjectView;
-        }
-        ProjectView.GetListCacheKey = GetListCacheKey;
         // This is the expected default version for the DataVersion value.
         // This value should NOT be changed without looking at our API and seeing what the default value is.
         ProjectView.DEFAULT_DATA_VERSION = 2;
+        // Our Cesium web navigator.
+        ProjectView.TYPE_WEB_3D_NAVIGATOR = "WEB_3D_NAVIGATOR";
+        // Our (currently WIP) 2D web navigator.
+        ProjectView.TYPE_WEB_2D_NAVIGATOR = "WEB_2D_NAVIGATOR";
+        // Defaulting to 3D navigator for backwards compatibility.
+        ProjectView.DEFAULT_TYPE = ProjectView.TYPE_WEB_3D_NAVIGATOR;
         /**
          * Gets a project view record.
          * @param params
@@ -7993,11 +7988,11 @@
          */
         function GetList(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, req: reqParams } = params;
+                let { api, req: reqParams, type } = params;
                 if (!api) {
                     api = exports.ENVIRONMENT.Api().GetBruceApi();
                 }
-                const cache = yield api.GetCacheItem(GetListCacheKey(), reqParams);
+                const cache = yield api.GetCacheItem(GetListCacheKey(type), reqParams);
                 if (cache === null || cache === void 0 ? void 0 : cache.found) {
                     return cache.data;
                 }
@@ -8013,7 +8008,7 @@
                     }
                 }));
                 yield api.SetCacheItem({
-                    key: GetListCacheKey(),
+                    key: GetListCacheKey(type),
                     value: prom,
                     req: reqParams
                 });
@@ -8036,7 +8031,7 @@
                 }
                 yield api.DELETE(`ui.view/${viewId}`, exports.Api.PrepReqParams(reqParams));
                 api.Cache.Remove(GetCacheKey(viewId));
-                api.Cache.Remove(GetListCacheKey());
+                api.Cache.RemoveByStartsWith(GetListCacheKey());
             });
         }
         ProjectView.Delete = Delete;
@@ -8073,13 +8068,44 @@
                     data = yield api.PUT(`ui.view/${data.ID}`, data, exports.Api.PrepReqParams(reqParams));
                 }
                 api.Cache.Remove(GetCacheKey(data.ID));
-                api.Cache.Remove(GetListCacheKey());
+                api.Cache.RemoveByStartsWith(GetListCacheKey());
                 return {
                     view: data
                 };
             });
         }
         ProjectView.Update = Update;
+        /**
+         * Returns cache identifier for a project view.
+         * Example: {
+         *     const api: BruceApi.Api = ...;
+         *     const key = GetCacheKey("abc");
+         *     api.Cache.Remove(key);
+         * }
+         * @param viewId
+         * @returns
+         */
+        function GetCacheKey(viewId) {
+            return `${exports.Api.ECacheKey.ProjectView}${exports.Api.ECacheKey.Id}${viewId}`;
+        }
+        ProjectView.GetCacheKey = GetCacheKey;
+        /**
+         * Returns cache identifier for a list of project views.
+         * Example: {
+         *     const api: BruceApi.Api = ...;
+         *     const key = GetListCacheKey();
+         *     api.Cache.Remove(key);
+         * }
+         * @param type optional filter for the type of project view.
+         * @returns
+         */
+        function GetListCacheKey(type) {
+            if (type) {
+                return `${exports.Api.ECacheKey.ProjectView}${exports.Api.ECacheKey.ListId}${type}`;
+            }
+            return `${exports.Api.ECacheKey.ProjectView}${exports.Api.ECacheKey.ListId}`;
+        }
+        ProjectView.GetListCacheKey = GetListCacheKey;
     })(exports.ProjectView || (exports.ProjectView = {}));
 
     function getTemplateSettings(apiGetter, reqParams) {
@@ -10365,40 +10391,40 @@
                 window[paramsId] = pluginParams ? pluginParams : {};
                 const disposeId = exports.ObjectUtils.UId();
                 const elementId = exports.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 {
@@ -10426,33 +10452,6 @@
     })(exports.Plugin || (exports.Plugin = {}));
 
     (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 exports.Api.ECacheKey.DataSource + exports.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 exports.Api.ECacheKey.DataSource;
-        }
-        DataSource.GetListCacheKey = GetListCacheKey;
         // Known data source types.
         let EType;
         (function (EType) {
@@ -10569,9 +10568,37 @@
             });
         }
         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 exports.Api.ECacheKey.DataSource + exports.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 exports.Api.ECacheKey.DataSource;
+        }
+        DataSource.GetListCacheKey = GetListCacheKey;
     })(exports.DataSource || (exports.DataSource = {}));
 
-    const VERSION = "3.5.1";
+    // This is updated with the package.json version on build.
+    const VERSION = "3.5.3";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;