bruce-models 7.1.98 → 7.1.99

package/dist/bruce-models.es5.js

@@ -90,6 +90,7 @@ var Api;
         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;
@@ -23656,8 +23657,318 @@ var UrlUtils;
     UrlUtils.ConstructUrl = ConstructUrl;
 })(UrlUtils || (UrlUtils = {}));
 
+/**
+ * Describes the "Workflow Type" concept within Nextspace.
+ * The API names this record Workflow Item Type.
+ */
+var WorkflowType;
+(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 = 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}`, 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 = 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", 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 = 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, 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.DELETE(`workflow/type/${workflowTypeId}`, 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 = 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`, 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.POST(`workflow/type/${workflowTypeId}/status/add`, {
+                "WorkflowStatus.ID": workflowStatusIds
+            }, 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 = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.POST(`workflow/type/${workflowTypeId}/status/remove`, {
+                "WorkflowStatus.ID": workflowStatusIds
+            }, 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 `${Api.ECacheKey.WorkflowType}${Api.ECacheKey.Id}${id}`;
+    }
+    WorkflowType.GetCacheKey = GetCacheKey;
+    /**
+     * Returns cache identifier for the workflow type list.
+     * @returns
+     */
+    function GetListCacheKey() {
+        return Api.ECacheKey.WorkflowType;
+    }
+    WorkflowType.GetListCacheKey = GetListCacheKey;
+    /**
+     * Returns cache identifier for the statuses enabled for a workflow type.
+     * @param workflowTypeId
+     * @returns
+     */
+    function GetStatusesCacheKey(workflowTypeId) {
+        return `${Api.ECacheKey.WorkflowType}${Api.ECacheKey.Id}${workflowTypeId}${Api.ECacheKey.ListId}statuses`;
+    }
+    WorkflowType.GetStatusesCacheKey = GetStatusesCacheKey;
+})(WorkflowType || (WorkflowType = {}));
+// Alias that mirrors the API route/model wording.
+var WorkflowItemType = 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.99";
 
-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 };
+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