bruce-models 7.1.115 → 7.1.116

package/README.md

@@ -2,6 +2,50 @@
 
 This is a library which defines data-models for the Nextspace API and provides functions for communicating with the endpoints.
 
+### Workflow Item priority and parent
+
+`WorkflowItem.IItem` and `WorkflowItem.ICreateItem` represent `Priority` as an optional
+`number | null` (signed int32) and `"Parent.Item.ID"` as an optional `number | null`
+(the API's int64 parent reference). Use parent IDs that JavaScript can represent
+as safe integers. Priority accepts zero and negative values; the API defines no
+fixed priority scale.
+
+`Create` and `Update` accept both fields. On update, omit a field to preserve it or
+send `null` to clear it. The API checks that the parent exists and prevents circular
+parent chains. The focused helpers update existing items through
+`POST workflow/item/{id}` and invalidate Workflow Item caches after success.
+
+```ts
+import { WorkflowItem } from "bruce-models";
+
+// Update one attribute while preserving other item fields.
+await WorkflowItem.UpdatePriority({ api, workflowItemId: 9, priority: 3 });
+await WorkflowItem.UpdateParent({ api, workflowItemId: 9, parentItemId: 5 });
+
+// Clear priority or detach from the parent.
+await WorkflowItem.UpdatePriority({ api, workflowItemId: 9, priority: null });
+await WorkflowItem.UpdateParent({ api, workflowItemId: 9, parentItemId: null });
+
+// Change both attributes in one request.
+await WorkflowItem.Update({
+    api,
+    workflowItem: { ID: 9, Priority: 0, "Parent.Item.ID": 5 }
+});
+
+// List direct children, filtered and sorted by priority.
+const { items } = await WorkflowItem.GetList({
+    api,
+    parentItemId: 5,
+    priority: [-2, 0, 3],
+    orderBy: WorkflowItem.EOrderBy.PRIORITY,
+    sortOrder: "DESC"
+});
+```
+
+`GetList` uses `GET workflow/itemsquery` with `Priority` and `ParentItemID` query
+parameters. Both filters accept a single value or an array. Use
+`WorkflowItem.EOrderBy.PARENT_ITEM_ID` to sort by parent instead.
+
 <br>
 
 ### Local build
@@ -28,4 +72,4 @@ This is a library which defines data-models for the Nextspace API and provides f
 
 - Bitbucket will run a build and test step.
 
-- Manually click `NPM Release` in Bitbucket Pipelines.
+- Manually click `NPM Release` in Bitbucket Pipelines.

package/dist/bruce-models.es5.js

@@ -24465,6 +24465,26 @@ var UrlUtils;
 
 var WorkflowItem;
 (function (WorkflowItem) {
+    /** Sort fields supported by workflow/itemsquery. */
+    let EOrderBy;
+    (function (EOrderBy) {
+        EOrderBy["ID"] = "ID";
+        EOrderBy["ENTITY_ID"] = "EntityID";
+        EOrderBy["CREATED"] = "Created";
+        EOrderBy["UPDATED"] = "Updated";
+        EOrderBy["DUE_DATE"] = "DueDate";
+        EOrderBy["CREATED_BY_USER_ID"] = "CreatedByUserID";
+        EOrderBy["ITEM_TYPE_ID"] = "ItemTypeID";
+        EOrderBy["ITEM_STATUS_ID"] = "ItemStatusID";
+        EOrderBy["QUEUE_ID"] = "QueueID";
+        EOrderBy["WORKFLOW_SCHEDULE_ID"] = "WorkflowScheduleID";
+        EOrderBy["PRIORITY"] = "Priority";
+        EOrderBy["PARENT_ITEM_ID"] = "ParentItemID";
+        EOrderBy["DESCRIPTION"] = "Description";
+        EOrderBy["UI_SLIDE_ID"] = "UISlideID";
+        EOrderBy["THUMBNAIL_CLIENT_FILE_ID"] = "ThumbnailClientFileID";
+        EOrderBy["RANDOM"] = "RANDOM";
+    })(EOrderBy = WorkflowItem.EOrderBy || (WorkflowItem.EOrderBy = {}));
     function Get(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, workflowItemId, req } = params;
@@ -24555,6 +24575,7 @@ var WorkflowItem;
         });
     }
     WorkflowItem.GetStatistics = GetStatistics;
+    /** Creates an item, including its optional Priority and Parent.Item.ID. */
     function Create(params) {
         var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function* () {
@@ -24581,6 +24602,10 @@ var WorkflowItem;
         });
     }
     WorkflowItem.Create = Create;
+    /**
+     * Saves item changes. Omitted fields are preserved; null clears Priority or Parent.Item.ID.
+     * The API validates that the parent exists and that its parent chain is not circular.
+     */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, workflowItem, req } = params;
@@ -24600,6 +24625,45 @@ var WorkflowItem;
         });
     }
     WorkflowItem.Update = Update;
+    /** Updates only the priority of an existing item. Pass null to clear it. */
+    function UpdatePriority(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, workflowItemId, priority, req } = params;
+            if (isInvalidId(workflowItemId) || !Number.isSafeInteger(Number(workflowItemId))) {
+                throw ("Workflow Item ID is required.");
+            }
+            if (priority !== null && (!Number.isInteger(priority) || priority < -2147483648 || priority > 2147483647)) {
+                throw ("Workflow Item priority must be a signed 32-bit integer or null.");
+            }
+            return Update({
+                api,
+                workflowItem: { ID: Number(workflowItemId), Priority: priority },
+                req
+            });
+        });
+    }
+    WorkflowItem.UpdatePriority = UpdatePriority;
+    /**
+     * Updates only the parent of an existing item. Pass null to detach it.
+     * The API validates parent existence and rejects circular parent chains.
+     */
+    function UpdateParent(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, workflowItemId, parentItemId, req } = params;
+            if (isInvalidId(workflowItemId) || !Number.isSafeInteger(Number(workflowItemId))) {
+                throw ("Workflow Item ID is required.");
+            }
+            if (parentItemId !== null && (!Number.isSafeInteger(parentItemId) || parentItemId <= 0)) {
+                throw ("Parent Workflow Item ID must be a positive safe integer or null.");
+            }
+            return Update({
+                api,
+                workflowItem: { ID: Number(workflowItemId), "Parent.Item.ID": parentItemId },
+                req
+            });
+        });
+    }
+    WorkflowItem.UpdateParent = UpdateParent;
     function Delete(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let { api, workflowItemId, req } = params;
@@ -25235,7 +25299,7 @@ function getFirstWrappedArray(data, wrapperKeys) {
 }
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.115";
+const VERSION = "7.1.116";
 
 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, RequestLane, 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, EntityTypeSource, 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, WorkflowItem, WorkflowSchedule, WorkflowType, WorkflowItemType };
 //# sourceMappingURL=bruce-models.es5.js.map