bruce-models 7.1.67 → 7.1.69

package/dist/bruce-models.umd.js

@@ -84,6 +84,7 @@
             ECacheKey["DatabaseRegion"] = "databaseregion";
             ECacheKey["CustomForm"] = "customform";
             ECacheKey["ImportedFile"] = "importedfile";
+            ECacheKey["UIMarkup"] = "uimarkup";
             ECacheKey["Plugin"] = "plugin";
             ECacheKey["PluginIndexFile"] = "pluginindexfile";
             ECacheKey["EntityHistoricData"] = "entityhistoricdata";
@@ -353,6 +354,7 @@
             EConcept["TILESET"] = "ts";
             EConcept["UI_DASHBOARD_VIEW"] = "dbv";
             EConcept["UI_ENTITY_DISPLAY_SETTING"] = "s";
+            EConcept["UI_MARKUP"] = "um";
             EConcept["UI_PLUGIN"] = "pg";
             EConcept["UI_SLIDE"] = "pvs";
             EConcept["UI_SLIDE_GROUP"] = "sg";
@@ -418,6 +420,7 @@
             { concept: EConcept.TILESET, label: "Tileset", description: undefined },
             { concept: EConcept.UI_DASHBOARD_VIEW, label: "Dashboard View", description: undefined },
             { concept: EConcept.UI_ENTITY_DISPLAY_SETTING, label: "Style", description: undefined },
+            { concept: EConcept.UI_MARKUP, label: "Markup", description: undefined },
             { concept: EConcept.UI_PLUGIN, label: "Plugin", description: undefined },
             { concept: EConcept.UI_SLIDE, label: "Bookmark", description: undefined },
             { concept: EConcept.UI_SLIDE_GROUP, label: "Bookmark Group", description: undefined },
@@ -655,6 +658,8 @@
                     return [exports.Api.ECacheKey.Tileset, exports.Api.ECacheKey.PublishTileset, exports.Api.ECacheKey.TilesetAccess];
                 case exports.AccountConcept.EConcept.UI_ENTITY_DISPLAY_SETTING:
                     return [exports.Api.ECacheKey.Style];
+                case exports.AccountConcept.EConcept.UI_MARKUP:
+                    return [exports.Api.ECacheKey.UIMarkup];
                 case exports.AccountConcept.EConcept.UI_PLUGIN:
                     return [exports.Api.ECacheKey.Plugin, exports.Api.ECacheKey.PluginIndexFile];
                 case exports.AccountConcept.EConcept.UI_SLIDE:
@@ -10672,6 +10677,30 @@
             });
         }
         DataSource.Analyze = Analyze;
+        /**
+         * Retrieves the available datasets from an ERDDAP instance.
+         * This calls: GET sources/erddap/getCapabilities?url={erddapUrl}
+         * @param params
+         */
+        function GetERDDAPCapabilities(params) {
+            var _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                let { url, api, req: reqParams } = params;
+                if (!url) {
+                    throw ("ERDDAP URL is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const query = new URLSearchParams();
+                query.append("url", url);
+                const res = yield api.GET(`sources/erddap/getCapabilities?${query.toString()}`, exports.Api.PrepReqParams(reqParams));
+                return {
+                    datasets: (_a = res === null || res === void 0 ? void 0 : res.Datasets) !== null && _a !== void 0 ? _a : []
+                };
+            });
+        }
+        DataSource.GetERDDAPCapabilities = GetERDDAPCapabilities;
         /**
          * Makes a diagnostic sample request to a registered data source.
          * This calls: POST source/{source_id}/requestSample
@@ -14505,6 +14534,148 @@
         })(Circle = Markup.Circle || (Markup.Circle = {}));
     })(exports.Markup || (exports.Markup = {}));
 
+    (function (UIMarkup) {
+        /**
+         * Returns a UI.Markup record.
+         * @param params
+         */
+        function Get(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, markupId, req: reqParams } = params;
+                if (markupId == null || markupId <= 0) {
+                    throw ("Markup ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const key = GetCacheKey(markupId);
+                const cache = api.GetCacheItem(key, reqParams);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const data = yield api.GET(`ui.markup/${markupId}`, exports.Api.PrepReqParams(reqParams));
+                        res({
+                            markup: data
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        UIMarkup.Get = Get;
+        /**
+         * Returns the list of UI.Markup records.
+         * @param params
+         */
+        function GetList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!params) {
+                    params = {};
+                }
+                let { api, req: reqParams } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const key = GetListCacheKey();
+                const cache = api.GetCacheItem(key, reqParams);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                    var _a;
+                    try {
+                        const data = yield api.GET("ui.markups", exports.Api.PrepReqParams(reqParams));
+                        res({
+                            markups: (_a = data === null || data === void 0 ? void 0 : data.Items) !== null && _a !== void 0 ? _a : []
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        UIMarkup.GetList = GetList;
+        /**
+         * Creates or updates a UI.Markup record.
+         * @param params
+         */
+        function Update(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { markup, api, req: reqParams } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                if (!markup) {
+                    markup = {};
+                }
+                const markupId = markup.ID && markup.ID > 0 ? markup.ID : 0;
+                const res = yield api.POST(`ui.markup/${markupId}`, markup, exports.Api.PrepReqParams(reqParams));
+                if (markup.ID && markup.ID > 0) {
+                    api.Cache.Remove(GetCacheKey(markup.ID));
+                }
+                if ((res === null || res === void 0 ? void 0 : res.ID) && res.ID > 0) {
+                    api.Cache.Remove(GetCacheKey(res.ID));
+                }
+                api.Cache.RemoveByStartsWith(GetListCacheKey());
+                return {
+                    markup: res
+                };
+            });
+        }
+        UIMarkup.Update = Update;
+        /**
+         * Deletes a UI.Markup record.
+         * @param params
+         */
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { markupId, api, req: reqParams } = params;
+                if (markupId == null || markupId <= 0) {
+                    throw ("Markup ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                yield api.DELETE(`ui.markup/${markupId}`, exports.Api.PrepReqParams(reqParams));
+                api.Cache.Remove(GetCacheKey(markupId));
+                api.Cache.RemoveByStartsWith(GetListCacheKey());
+            });
+        }
+        UIMarkup.Delete = Delete;
+        /**
+         * Returns cache identifier for a UI.Markup record.
+         * @param id
+         */
+        function GetCacheKey(id) {
+            return `${exports.Api.ECacheKey.UIMarkup}${exports.Api.ECacheKey.Id}${id}`;
+        }
+        UIMarkup.GetCacheKey = GetCacheKey;
+        /**
+         * Returns cache identifier for the UI.Markup list.
+         */
+        function GetListCacheKey() {
+            return exports.Api.ECacheKey.UIMarkup;
+        }
+        UIMarkup.GetListCacheKey = GetListCacheKey;
+    })(exports.UIMarkup || (exports.UIMarkup = {}));
+
     const DEFAULT_JOB_POLL_INTERVAL_MS = 1000;
     const DEFAULT_JOB_POLL_TIMEOUT_MS = 10 * 60 * 1000; // match server timeout (10 minutes)
     const NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED = "entity_highlight_applied";
@@ -19234,7 +19405,7 @@
     })(exports.UrlUtils || (exports.UrlUtils = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.67";
+    const VERSION = "7.1.69";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;