@orkestrel/workflow 0.0.14 → 0.0.15

package/dist/src/core/index.d.cts

@@ -2340,6 +2340,7 @@ export declare interface TaskActivity {
  * One complete replacement of a running task's observable activity.
  *
  * @remarks
+ * `note` describes the frame while `progress.message` describes the progress value.
  * Omitted `operations` or `constraints` mean an empty list. Omitted `progress` clears the
  * previous aggregate progress. Use {@link TaskInterface.report} to commit the replacement.
  */
@@ -2867,13 +2868,14 @@ export declare interface TaskOptions {
  * The aggregate progress most recently reported by a running task.
  *
  * @remarks
- * `current` and an optional `total` are finite non-negative numbers; when `total` is present
- * it is at least `current`. `unit` is optional observer-facing text.
+ * `progress` and an optional `total` are finite non-negative numbers; when `total` is present
+ * it is at least `progress`. `message` is optional observer-facing text describing the reported
+ * state.
  */
 export declare interface TaskProgress {
-    readonly current: number;
+    readonly progress: number;
     readonly total?: number;
-    readonly unit?: string;
+    readonly message?: string;
 }
 
 export declare interface TaskResult {

package/dist/src/core/index.d.ts

@@ -2340,6 +2340,7 @@ export declare interface TaskActivity {
  * One complete replacement of a running task's observable activity.
  *
  * @remarks
+ * `note` describes the frame while `progress.message` describes the progress value.
  * Omitted `operations` or `constraints` mean an empty list. Omitted `progress` clears the
  * previous aggregate progress. Use {@link TaskInterface.report} to commit the replacement.
  */
@@ -2867,13 +2868,14 @@ export declare interface TaskOptions {
  * The aggregate progress most recently reported by a running task.
  *
  * @remarks
- * `current` and an optional `total` are finite non-negative numbers; when `total` is present
- * it is at least `current`. `unit` is optional observer-facing text.
+ * `progress` and an optional `total` are finite non-negative numbers; when `total` is present
+ * it is at least `progress`. `message` is optional observer-facing text describing the reported
+ * state.
  */
 export declare interface TaskProgress {
-    readonly current: number;
+    readonly progress: number;
     readonly total?: number;
-    readonly unit?: string;
+    readonly message?: string;
 }
 
 export declare interface TaskResult {

package/dist/src/core/index.js

@@ -243,11 +243,11 @@ function isTaskActivityInput(value) {
 		if (progress !== void 0) {
 			if (!isRecord(progress)) return false;
 			const progressPrototype = Object.getPrototypeOf(progress);
-			if (progressPrototype !== Object.prototype && progressPrototype !== null || !Object.keys(progress).every((key) => key === "current" || key === "total" || key === "unit")) return false;
-			const current = progress.current;
+			if (progressPrototype !== Object.prototype && progressPrototype !== null || !Object.keys(progress).every((key) => key === "progress" || key === "total" || key === "message")) return false;
+			const reported = progress.progress;
 			const total = progress.total;
-			const unit = progress.unit;
-			if (!isFiniteNumber(current) || current < 0 || total !== void 0 && (!isFiniteNumber(total) || total < current) || unit !== void 0 && !isNonEmptyString(unit)) return false;
+			const message = progress.message;
+			if (!isFiniteNumber(reported) || reported < 0 || total !== void 0 && (!isFiniteNumber(total) || total < reported) || message !== void 0 && !isNonEmptyString(message)) return false;
 		}
 		if (operations !== void 0) {
 			if (!isArray(operations)) return false;
@@ -1141,14 +1141,14 @@ function cloneTaskActivity(input, updated) {
 		if (progressInput !== void 0) {
 			if (!isRecord(progressInput)) throw new WorkflowError("MUTATION", "task activity contains invalid progress");
 			const progressPrototype = Object.getPrototypeOf(progressInput);
-			if (progressPrototype !== Object.prototype && progressPrototype !== null || !Object.keys(progressInput).every((key) => key === "current" || key === "total" || key === "unit")) throw new WorkflowError("MUTATION", "task activity contains invalid progress");
-			const current = progressInput.current;
+			if (progressPrototype !== Object.prototype && progressPrototype !== null || !Object.keys(progressInput).every((key) => key === "progress" || key === "total" || key === "message")) throw new WorkflowError("MUTATION", "task activity contains invalid progress");
+			const reported = progressInput.progress;
 			const total = progressInput.total;
-			const unit = progressInput.unit;
+			const message = progressInput.message;
 			progress = Object.freeze({
-				current,
+				progress: reported,
 				...total === void 0 ? {} : { total },
-				...unit === void 0 ? {} : { unit }
+				...message === void 0 ? {} : { message }
 			});
 		}
 		const constraintInputs = constraintsInput === void 0 ? [] : isArray(constraintsInput) ? [...constraintsInput] : void 0;