bruce-models 7.1.99 → 7.1.101

package/dist/types/server/pending-action.d.ts

@@ -9,14 +9,14 @@ export declare namespace PendingAction {
     /**
      * Describes a pending action record.
      */
-    interface IAction {
+    interface IAction<TResult = string> {
         ID: number;
         "CreatedBy.Application": string;
         "Created"?: string;
         "Updated"?: string;
         "Completed"?: string;
         "CreatedByUser.ID": string;
-        Result: string;
+        Result: TResult;
         Progress: number;
         Description: string;
         Status: EStatus;
@@ -30,6 +30,12 @@ export declare namespace PendingAction {
         Complete = "COMPLETE",
         Failed = "FAILED"
     }
+    /**
+     * Available server-side Pending Action result encodings.
+     */
+    enum EResultFormat {
+        JSON = "JSON"
+    }
     /**
      * Describes a pending action message record.
      */
@@ -55,12 +61,13 @@ export declare namespace PendingAction {
      * @param params
      * @returns
      */
-    function Get(params: {
+    function Get<TResult = string>(params: {
         api?: BruceApi.Api;
         actionId: number;
+        result?: EResultFormat;
         req?: Api.IReqParams;
     }): Promise<{
-        action: IAction;
+        action: IAction<TResult>;
     }>;
     /**
      * Returns a list of pending action records by their IDs.
@@ -134,15 +141,16 @@ export declare namespace PendingAction {
      * });
      * // Action will resolve as null if it was disposed early.
      */
-    function OnCompletion(params: {
+    function OnCompletion<TResult = string>(params: {
         api?: BruceApi.Api;
         actionId: number;
         interval?: number;
         isDisposed?: () => boolean;
         onMessage?: (message: IMessage) => void;
+        result?: EResultFormat;
         req?: Api.IReqParams;
     }): Promise<{
-        action: IAction | null;
+        action: IAction<TResult> | null;
         messages: IMessage[];
     }>;
 }

package/dist/types/server/record-change-feed.d.ts

@@ -35,11 +35,22 @@ export declare namespace RecordChangeFeed {
      */
     const parseEvent: (message: MessageBroker.IMessage) => IEvent | null;
     /**
-     * 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
+     */
+    const isInternalIdInRangeString: (rangeString: string | null | undefined, internalId: number) => boolean;
+    /**
+     * 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.
      */
     const isEntityInternalIdInRangeString: (rangeString: string | null | undefined, entityInternalId: number) => boolean;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.99",
+    "version": "7.1.101",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",