bruce-models 7.1.99 → 7.1.101

package/dist/bruce-models.es5.js

@@ -364,6 +364,10 @@ var AccountConcept;
         EConcept["UI_SLIDE"] = "pvs";
         EConcept["UI_SLIDE_GROUP"] = "sg";
         EConcept["UI_TABLE_VIEW"] = "tv";
+        EConcept["WORKFLOW_ITEM"] = "wi";
+        EConcept["WORKFLOW_ITEM_STATUS"] = "wis";
+        EConcept["WORKFLOW_ITEM_TYPE"] = "wit";
+        EConcept["WORKFLOW_QUEUE"] = "wq";
     })(EConcept = AccountConcept.EConcept || (AccountConcept.EConcept = {}));
     let EAction;
     (function (EAction) {
@@ -584,14 +588,17 @@ var RecordChangeFeed;
         };
     };
     /**
-     * Returns true if the given Entity internal ID falls within the reported range string.
+     * Returns true if the given internal ID falls within the reported range string.
+     *
+     * Every concept whose records carry a numeric identity reports them this way, as runs rather than
+     * as one ID per record, so that a change touching thousands of rows is still a short message.
      *
      * @example
-     * isEntityInternalIdInRangeString("100-200,305,400-450", 150) // true
-     * isEntityInternalIdInRangeString("100-200,305,400-450", 301) // false
+     * isInternalIdInRangeString("100-200,305,400-450", 150) // true
+     * isInternalIdInRangeString("100-200,305,400-450", 301) // false
      */
-    RecordChangeFeed.isEntityInternalIdInRangeString = (rangeString, entityInternalId) => {
-        if (!rangeString || !Number.isInteger(entityInternalId)) {
+    RecordChangeFeed.isInternalIdInRangeString = (rangeString, internalId) => {
+        if (!rangeString || !Number.isInteger(internalId)) {
             return false;
         }
         for (const part of rangeString.split(",")) {
@@ -607,12 +614,20 @@ var RecordChangeFeed;
             }
             const min = Math.min(start, end);
             const max = Math.max(start, end);
-            if (entityInternalId >= min && entityInternalId <= max) {
+            if (internalId >= min && internalId <= max) {
                 return true;
             }
         }
         return false;
     };
+    /**
+     * Returns true if the given Entity internal ID falls within the reported range string.
+     *
+     * The Entity-named form of {@link isInternalIdInRangeString}, kept because it is what the Entity
+     * callers already read as. Ranges are not an Entity idea: a Workflow Item reports its own IDs the
+     * same way.
+     */
+    RecordChangeFeed.isEntityInternalIdInRangeString = (rangeString, entityInternalId) => RecordChangeFeed.isInternalIdInRangeString(rangeString, entityInternalId);
     /**
      * Returns true if the given record ID appears in a comma-separated list string.
      *
@@ -820,8 +835,23 @@ var RecordChangeFeed;
             }
             const isEntityConcept = event.concept === ENTITY_CONCEPT;
             if (!isEntityConcept && params.recordId !== undefined) {
-                const list = typeof event.data === "string" ? event.data : "";
-                if (!RecordChangeFeed.isRecordIdInListString(list, params.recordId)) {
+                const data = typeof event.data === "string" ? event.data : "";
+                const numericId = Number(params.recordId);
+                const isNumericIdentity = Number.isInteger(numericId)
+                    && String(params.recordId).trim() === String(numericId);
+                /*
+                 * A NUMERIC identity is reported as runs, so it is matched against the runs: a Workflow
+                 * Item asking about ID 7 has to see itself in "5-9" and not only in a list that spells
+                 * out every ID. Matching runs still finds a plain numeric ID, since one ID is a run of
+                 * one, so this is what every numeric concept wants.
+                 *
+                 * A STRING identity (a Bookmark, a Project View) has no runs to fall inside and arrives
+                 * as a plain list, which is matched as one.
+                 */
+                const matched = isNumericIdentity
+                    ? RecordChangeFeed.isInternalIdInRangeString(data, numericId)
+                    : RecordChangeFeed.isRecordIdInListString(data, params.recordId);
+                if (!matched) {
                     return false;
                 }
             }
@@ -1047,7 +1077,7 @@ function parseResult(data) {
         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);
             }
@@ -17599,14 +17629,101 @@ var ExportNsx;
      */
     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 = ENVIRONMENT.Api().GetBruceApi();
             }
-            return api.POST("export/nsx/accountBackup", {}, Api.PrepReqParams(reqParams));
+            return api.POST("export/nsx/accountBackup", backup !== null && backup !== void 0 ? backup : {}, 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            return api.GET("account/restoreList", 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            return api.GET(`account/backup/nsx/${encodeURIComponent(fileName)}`, 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            return api.DELETE(`account/backup/nsx/${encodeURIComponent(fileName)}`, 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;
+    }
 })(ExportNsx || (ExportNsx = {}));
 
 var ExportUsd;
@@ -21929,6 +22046,13 @@ var PendingAction;
         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.
      */
@@ -21946,14 +22070,20 @@ var PendingAction;
      */
     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 = ENVIRONMENT.Api().GetBruceApi();
             }
-            const data = yield api.GET(`pendingAction/${actionId}`, 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, Api.PrepReqParams(reqParams));
             return {
                 action: data
             };
@@ -22100,7 +22230,7 @@ var PendingAction;
      */
     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.");
             }
@@ -22153,6 +22283,7 @@ var PendingAction;
                         const { action } = yield Get({
                             api,
                             actionId,
+                            result,
                             req: reqParams
                         });
                         if (action.Status !== EStatus.InProgress) {
@@ -23968,7 +24099,7 @@ function getFirstWrappedArray(data, wrapperKeys) {
 }
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.99";
+const VERSION = "7.1.101";
 
 export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, ClientFileValueMap, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportNsx, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportTif, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, WorkflowType, WorkflowItemType };
 //# sourceMappingURL=bruce-models.es5.js.map