bruce-models 7.1.98 → 7.1.100

package/dist/bruce-models.umd.js

@@ -95,6 +95,7 @@
             ECacheKey["EntityHistoricDataAnalysis"] = "entityhistoricdataanalysis";
             ECacheKey["EntityHistoricDataPage"] = "entityhistoricdatapage";
             ECacheKey["AccountLimits"] = "accountlimits";
+            ECacheKey["WorkflowType"] = "workflowtype";
         })(ECacheKey = Api.ECacheKey || (Api.ECacheKey = {}));
         // 1 minute.
         Api.DEFAULT_CACHE_DURATION = 60 * 1000;
@@ -1041,7 +1042,7 @@
             else if (encoding === "iso-8859-1") {
                 encoding = "utf-8";
             }
-            if (type == "application/octet-stream" || type == "model/gltf-binary") {
+            if (type == "application/octet-stream" || type == "model/gltf-binary" || type == "application/nsx") {
                 if (encoding !== "utf-8") {
                     console.warn("Binary data is being returned with an unexpected encoding:", encoding);
                 }
@@ -17349,14 +17350,101 @@
          */
         function AccountBackup(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, req: reqParams } = params !== null && params !== void 0 ? params : {};
+                let { api, backup, req: reqParams } = params !== null && params !== void 0 ? params : {};
                 if (!api) {
                     api = exports.ENVIRONMENT.Api().GetBruceApi();
                 }
-                return api.POST("export/nsx/accountBackup", {}, exports.Api.PrepReqParams(reqParams));
+                return api.POST("export/nsx/accountBackup", backup !== null && backup !== void 0 ? backup : {}, exports.Api.PrepReqParams(reqParams));
             });
         }
         ExportNsx.AccountBackup = AccountBackup;
+        /**
+         * Returns available account backup files, including whole-account NSX backups.
+         */
+        function GetAccountBackupList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, req: reqParams } = params !== null && params !== void 0 ? params : {};
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                return api.GET("account/restoreList", exports.Api.PrepReqParams(reqParams));
+            });
+        }
+        ExportNsx.GetAccountBackupList = GetAccountBackupList;
+        /**
+         * Downloads a saved whole-account NSX backup file.
+         */
+        function DownloadAccountBackup(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, fileName, req: reqParams } = params;
+                if (!fileName) {
+                    throw ("fileName is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                return api.GET(`account/backup/nsx/${encodeURIComponent(fileName)}`, exports.Api.PrepReqParams(reqParams));
+            });
+        }
+        ExportNsx.DownloadAccountBackup = DownloadAccountBackup;
+        /**
+         * Deletes a saved whole-account NSX backup file.
+         */
+        function DeleteAccountBackup(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, fileName, req: reqParams } = params;
+                if (!fileName) {
+                    throw ("fileName is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                return api.DELETE(`account/backup/nsx/${encodeURIComponent(fileName)}`, exports.Api.PrepReqParams(reqParams));
+            });
+        }
+        ExportNsx.DeleteAccountBackup = DeleteAccountBackup;
+        /**
+         * Parses the completed Pending Action result from running AccountBackup.
+         */
+        function ParseAccountBackupResult(paResult) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const parsed = parseObject(paResult);
+            if (!parsed) {
+                return {
+                    raw: null
+                };
+            }
+            const resultSource = (parsed === null || parsed === void 0 ? void 0 : parsed.Result) != null ? parsed.Result : parsed;
+            const rawResult = (_a = parseObject(resultSource)) !== null && _a !== void 0 ? _a : (typeof resultSource == "object" ? resultSource : null);
+            const report = rawResult === null || rawResult === void 0 ? void 0 : rawResult.Report;
+            return {
+                accountId: (_b = rawResult === null || rawResult === void 0 ? void 0 : rawResult["Account.ID"]) !== null && _b !== void 0 ? _b : report === null || report === void 0 ? void 0 : report["Account.ID"],
+                createdUtc: (_c = rawResult === null || rawResult === void 0 ? void 0 : rawResult["Created.UTC"]) !== null && _c !== void 0 ? _c : report === null || report === void 0 ? void 0 : report["Created.UTC"],
+                fileName: (_d = rawResult === null || rawResult === void 0 ? void 0 : rawResult.FileName) !== null && _d !== void 0 ? _d : report === null || report === void 0 ? void 0 : report.FileName,
+                storePath: (_e = rawResult === null || rawResult === void 0 ? void 0 : rawResult.StorePath) !== null && _e !== void 0 ? _e : report === null || report === void 0 ? void 0 : report.StorePath,
+                sizeBytes: (_f = rawResult === null || rawResult === void 0 ? void 0 : rawResult["Size.Bytes"]) !== null && _f !== void 0 ? _f : report === null || report === void 0 ? void 0 : report["Size.Bytes"],
+                downloadUrl: (_g = rawResult === null || rawResult === void 0 ? void 0 : rawResult["Download.URL"]) !== null && _g !== void 0 ? _g : report === null || report === void 0 ? void 0 : report["Download.URL"],
+                message: (_h = rawResult === null || rawResult === void 0 ? void 0 : rawResult.Message) !== null && _h !== void 0 ? _h : report === null || report === void 0 ? void 0 : report.Message,
+                report: report,
+                stats: rawResult === null || rawResult === void 0 ? void 0 : rawResult.Stats,
+                raw: rawResult
+            };
+        }
+        ExportNsx.ParseAccountBackupResult = ParseAccountBackupResult;
+        function parseObject(data) {
+            if (data == null || data == undefined) {
+                return null;
+            }
+            if (typeof data == "string") {
+                try {
+                    return JSON.parse(data);
+                }
+                catch (_a) {
+                    return null;
+                }
+            }
+            return data;
+        }
     })(exports.ExportNsx || (exports.ExportNsx = {}));
 
     (function (ExportUsd) {
@@ -21577,6 +21665,13 @@
             EStatus["Complete"] = "COMPLETE";
             EStatus["Failed"] = "FAILED";
         })(EStatus = PendingAction.EStatus || (PendingAction.EStatus = {}));
+        /**
+         * Available server-side Pending Action result encodings.
+         */
+        let EResultFormat;
+        (function (EResultFormat) {
+            EResultFormat["JSON"] = "JSON";
+        })(EResultFormat = PendingAction.EResultFormat || (PendingAction.EResultFormat = {}));
         /**
          * Available message types.
          */
@@ -21594,14 +21689,20 @@
          */
         function Get(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, actionId, req: reqParams } = params;
+                let { api, actionId, result, req: reqParams } = params;
                 if (!actionId) {
                     throw ("Action ID is required.");
                 }
                 if (!api) {
                     api = exports.ENVIRONMENT.Api().GetBruceApi();
                 }
-                const data = yield api.GET(`pendingAction/${actionId}`, exports.Api.PrepReqParams(reqParams));
+                let url = `pendingAction/${actionId}`;
+                if (result) {
+                    const urlParams = new URLSearchParams();
+                    urlParams.append("Result", result);
+                    url += `?${urlParams.toString()}`;
+                }
+                const data = yield api.GET(url, exports.Api.PrepReqParams(reqParams));
                 return {
                     action: data
                 };
@@ -21748,7 +21849,7 @@
          */
         function OnCompletion(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, actionId, req: reqParams, interval: intMs, isDisposed, onMessage } = params;
+                let { api, actionId, req: reqParams, interval: intMs, isDisposed, onMessage, result } = params;
                 if (!actionId) {
                     throw ("Action ID is required.");
                 }
@@ -21801,6 +21902,7 @@
                             const { action } = yield Get({
                                 api,
                                 actionId,
+                                result,
                                 req: reqParams
                             });
                             if (action.Status !== EStatus.InProgress) {
@@ -23277,8 +23379,313 @@
         UrlUtils.ConstructUrl = ConstructUrl;
     })(exports.UrlUtils || (exports.UrlUtils = {}));
 
+    (function (WorkflowType) {
+        /**
+         * Gets a workflow type by ID.
+         * @param params
+         */
+        function Get(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowTypeId, req: reqParams } = params;
+                if (isInvalidId(workflowTypeId)) {
+                    throw ("Workflow Type ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const key = GetCacheKey(workflowTypeId);
+                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(`workflow/type/${workflowTypeId}`, exports.Api.PrepReqParams(reqParams));
+                        res({
+                            workflowType: ParseResponse(data)
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        WorkflowType.Get = Get;
+        /**
+         * Gets all workflow types.
+         * @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* () {
+                    try {
+                        const data = yield api.GET("workflow/types", exports.Api.PrepReqParams(reqParams));
+                        res({
+                            workflowTypes: ParseListResponse(data)
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        WorkflowType.GetList = GetList;
+        /**
+         * Creates or updates a workflow type.
+         * This calls: POST workflow/type/{workflow_type_id} where 0 creates new.
+         * @param params
+         */
+        function Update(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowType: data, req: reqParams } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                if (!data) {
+                    data = {};
+                }
+                const id = data.ID && data.ID > 0 ? data.ID : 0;
+                const res = yield api.POST(`workflow/type/${id}`, data, exports.Api.PrepReqParams(reqParams));
+                const parsed = ParseResponse(res);
+                api.Cache.Remove(GetListCacheKey());
+                if (id > 0) {
+                    api.Cache.Remove(GetCacheKey(id));
+                }
+                if (parsed === null || parsed === void 0 ? void 0 : parsed.ID) {
+                    api.Cache.Remove(GetCacheKey(parsed.ID));
+                }
+                return {
+                    workflowType: parsed
+                };
+            });
+        }
+        WorkflowType.Update = Update;
+        /**
+         * Deletes a workflow type by ID.
+         * @param params
+         */
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowTypeId, req: reqParams } = params;
+                if (isInvalidId(workflowTypeId)) {
+                    throw ("Workflow Type ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                yield api.DELETE(`workflow/type/${workflowTypeId}`, exports.Api.PrepReqParams(reqParams));
+                api.Cache.Remove(GetCacheKey(workflowTypeId));
+                api.Cache.Remove(GetListCacheKey());
+                api.Cache.RemoveByStartsWith(GetStatusesCacheKey(workflowTypeId));
+            });
+        }
+        WorkflowType.Delete = Delete;
+        /**
+         * Gets the workflow statuses enabled for a workflow type.
+         * @param params
+         */
+        function GetStatuses(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowTypeId, req: reqParams } = params;
+                if (isInvalidId(workflowTypeId)) {
+                    throw ("Workflow Type ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const key = GetStatusesCacheKey(workflowTypeId);
+                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(`workflow/type/${workflowTypeId}/statuses`, exports.Api.PrepReqParams(reqParams));
+                        res({
+                            statuses: ParseStatusListResponse(data)
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        WorkflowType.GetStatuses = GetStatuses;
+        /**
+         * Adds statuses to the list enabled for a workflow type.
+         * @param params
+         */
+        function AddStatuses(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowTypeId, workflowStatusIds, req: reqParams } = params;
+                if (isInvalidId(workflowTypeId)) {
+                    throw ("Workflow Type ID is required.");
+                }
+                if (!(workflowStatusIds === null || workflowStatusIds === void 0 ? void 0 : workflowStatusIds.length)) {
+                    throw ("Workflow Status ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                yield api.POST(`workflow/type/${workflowTypeId}/status/add`, {
+                    "WorkflowStatus.ID": workflowStatusIds
+                }, exports.Api.PrepReqParams(reqParams));
+                api.Cache.Remove(GetCacheKey(workflowTypeId));
+                api.Cache.Remove(GetStatusesCacheKey(workflowTypeId));
+            });
+        }
+        WorkflowType.AddStatuses = AddStatuses;
+        /**
+         * Removes statuses from the list enabled for a workflow type.
+         * @param params
+         */
+        function RemoveStatuses(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, workflowTypeId, workflowStatusIds, req: reqParams } = params;
+                if (isInvalidId(workflowTypeId)) {
+                    throw ("Workflow Type ID is required.");
+                }
+                if (!(workflowStatusIds === null || workflowStatusIds === void 0 ? void 0 : workflowStatusIds.length)) {
+                    throw ("Workflow Status ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                yield api.POST(`workflow/type/${workflowTypeId}/status/remove`, {
+                    "WorkflowStatus.ID": workflowStatusIds
+                }, exports.Api.PrepReqParams(reqParams));
+                api.Cache.Remove(GetCacheKey(workflowTypeId));
+                api.Cache.Remove(GetStatusesCacheKey(workflowTypeId));
+            });
+        }
+        WorkflowType.RemoveStatuses = RemoveStatuses;
+        /**
+         * Normalizes response from workflow type get/update endpoints.
+         */
+        function ParseResponse(response) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const parsed = parseObject$6(response);
+            const parsedResult = (_a = parseObject$6(parsed === null || parsed === void 0 ? void 0 : parsed.Result)) !== null && _a !== void 0 ? _a : parsed === null || parsed === void 0 ? void 0 : parsed.Result;
+            return (_h = (_g = (_f = (_e = (_d = (_c = (_b = parsed === null || parsed === void 0 ? void 0 : parsed.WorkflowType) !== null && _b !== void 0 ? _b : parsed === null || parsed === void 0 ? void 0 : parsed.WorkflowItemType) !== null && _c !== void 0 ? _c : parsed === null || parsed === void 0 ? void 0 : parsed.BruceWorkflowItemType) !== null && _d !== void 0 ? _d : parsedResult === null || parsedResult === void 0 ? void 0 : parsedResult.WorkflowType) !== null && _e !== void 0 ? _e : parsedResult === null || parsedResult === void 0 ? void 0 : parsedResult.WorkflowItemType) !== null && _f !== void 0 ? _f : parsedResult === null || parsedResult === void 0 ? void 0 : parsedResult.BruceWorkflowItemType) !== null && _g !== void 0 ? _g : parsedResult) !== null && _h !== void 0 ? _h : parsed;
+        }
+        WorkflowType.ParseResponse = ParseResponse;
+        /**
+         * Normalizes response from workflow type list endpoints.
+         */
+        function ParseListResponse(response) {
+            return parseList(response, ["WorkflowTypes", "WorkflowItemTypes", "BruceWorkflowItemTypes"]);
+        }
+        WorkflowType.ParseListResponse = ParseListResponse;
+        /**
+         * Normalizes response from workflow type status list endpoints.
+         */
+        function ParseStatusListResponse(response) {
+            return parseList(response, ["Statuses", "WorkflowStatuses", "WorkflowItemStatuses", "BruceWorkflowItemStatuses"]);
+        }
+        WorkflowType.ParseStatusListResponse = ParseStatusListResponse;
+        /**
+         * Returns cache identifier for a workflow type by ID.
+         * @param id
+         * @returns
+         */
+        function GetCacheKey(id) {
+            return `${exports.Api.ECacheKey.WorkflowType}${exports.Api.ECacheKey.Id}${id}`;
+        }
+        WorkflowType.GetCacheKey = GetCacheKey;
+        /**
+         * Returns cache identifier for the workflow type list.
+         * @returns
+         */
+        function GetListCacheKey() {
+            return exports.Api.ECacheKey.WorkflowType;
+        }
+        WorkflowType.GetListCacheKey = GetListCacheKey;
+        /**
+         * Returns cache identifier for the statuses enabled for a workflow type.
+         * @param workflowTypeId
+         * @returns
+         */
+        function GetStatusesCacheKey(workflowTypeId) {
+            return `${exports.Api.ECacheKey.WorkflowType}${exports.Api.ECacheKey.Id}${workflowTypeId}${exports.Api.ECacheKey.ListId}statuses`;
+        }
+        WorkflowType.GetStatusesCacheKey = GetStatusesCacheKey;
+    })(exports.WorkflowType || (exports.WorkflowType = {}));
+    // Alias that mirrors the API route/model wording.
+    var WorkflowItemType = exports.WorkflowType;
+    function parseObject$6(data) {
+        if (data == null || data == undefined) {
+            return null;
+        }
+        if (typeof data == "string") {
+            try {
+                return JSON.parse(data);
+            }
+            catch (_a) {
+                return null;
+            }
+        }
+        return data;
+    }
+    function isInvalidId(id) {
+        return id == null || id === "" || !isFinite(Number(id)) || Number(id) <= 0;
+    }
+    function parseList(response, wrapperKeys) {
+        var _a, _b, _c, _d, _e, _f;
+        const parsed = parseObject$6(response);
+        const parsedResult = (_a = parseObject$6(parsed === null || parsed === void 0 ? void 0 : parsed.Result)) !== null && _a !== void 0 ? _a : parsed === null || parsed === void 0 ? void 0 : parsed.Result;
+        const list = (_f = (_e = (_d = (_c = (_b = parsed === null || parsed === void 0 ? void 0 : parsed.Items) !== null && _b !== void 0 ? _b : parsedResult === null || parsedResult === void 0 ? void 0 : parsedResult.Items) !== null && _c !== void 0 ? _c : getFirstWrappedArray(parsed, wrapperKeys)) !== null && _d !== void 0 ? _d : getFirstWrappedArray(parsedResult, wrapperKeys)) !== null && _e !== void 0 ? _e : parsedResult) !== null && _f !== void 0 ? _f : parsed;
+        if (Array.isArray(list)) {
+            return list;
+        }
+        return [];
+    }
+    function getFirstWrappedArray(data, wrapperKeys) {
+        if (!data) {
+            return null;
+        }
+        for (const key of wrapperKeys) {
+            if (Array.isArray(data[key])) {
+                return data[key];
+            }
+        }
+        return null;
+    }
+
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.98";
+    const VERSION = "7.1.100";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;
@@ -23291,6 +23698,7 @@
     exports.NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED = NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED;
     exports.NavigatorChatClient = NavigatorChatClient;
     exports.NavigatorMcpWebSocketClient = NavigatorMcpWebSocketClient;
+    exports.WorkflowItemType = WorkflowItemType;
 
     Object.defineProperty(exports, '__esModule', { value: true });