@brandboostinggmbh/observable-workflows 0.22.1 → 0.23.0

package/CHANGELOG.md

@@ -22,6 +22,15 @@ Changes that will be included in the next release will be documented here.
 
 ---
 
+## [v0.23.0] - 2026-03-16
+
+### ✨ Features
+
+- `call()` and `retry()` now return a `WorkflowCallResult<O>` instead of `void`, containing `instanceId`, `workflowType`, `tenantId`, `result`, `workflowStatus`, `startTime`, `endTime`, `parentInstanceId`, and `triggerId`
+- New exported type `WorkflowCallResult<O, TYPE>` built via `Pick` from `TypedWorkflowRun` with narrowed `workflowStatus: 'completed'` and non-null `result: O` / `endTime: number`
+
+---
+
 ## [v0.22.1] - 2026-02-19
 
 ### 📚 Documentation

package/dist/index.d.ts

@@ -671,8 +671,8 @@ type WorkflowContextOptions = {
 };
 type InternalWorkflowContextOptions = WorkflowContextOptions & Required<Pick<WorkflowContextOptions, 'serializer' | 'idFactory'>>;
 type WorkflowContextInstance = {
-  call: <I, O>(args: WorkflowCallParams<I, O>) => Promise<void>;
-  retry: <I, O>(params: RetryWorkflowParams<I, O>) => Promise<void>;
+  call: <I, O>(args: WorkflowCallParams<I, O>) => Promise<WorkflowCallResult<O>>;
+  retry: <I, O>(params: RetryWorkflowParams<I, O>) => Promise<WorkflowCallResult<O>>;
 };
 type QueueWorkflowContextOptions = {
   QUEUE: Queue<WorkflowQueueMessage>;
@@ -778,6 +778,11 @@ type WorkflowCallParams<I, O> = {
   /** Optional: Provide an existing workflow instance ID. When provided, this workflow will update the existing instance. This is used when you have an workflow that is marked as waiting or scheduled and want to execute it. */
   scheduledInstanceId?: string | undefined;
 };
+type WorkflowCallResult<O, TYPE extends string = string> = Pick<TypedWorkflowRun<never, O, TYPE>, 'instanceId' | 'workflowType' | 'tenantId' | 'parentInstanceId' | 'triggerId' | 'startTime'> & {
+  result: O;
+  workflowStatus: 'completed';
+  endTime: number;
+};
 type ScheduledWorkflowExecutionStub<O, TYPE extends string = string> = {
   instanceId: string;
   workflowType: TYPE;
@@ -983,4 +988,4 @@ type R2ExternalBlobStorageOptions = {
  */
 declare function createR2ExternalBlobStorage(options: R2ExternalBlobStorageOptions): ExternalBlobStorage;
 //#endregion
-export { ConsoleWrapper, DateRangeFilter, ExternalBlobStorage, HandleWorkflowQueueMessageParams, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, PropertyFilter, QueueWorkflowContextOptions, R2ExternalBlobStorageOptions, RetryConfig, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, StringFilter, ValueTypeMap, WorkflowContext, WorkflowContextInstance, WorkflowContextOptions, WorkflowEnqueueBatchItem, WorkflowFilter, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, WorkflowStatus, createCleanupManager, createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, createWorkflowDependencies, createWorkflowDependency, defaultIdFactory, defaultSerializer, defineWorkflow, deleteWorkflowDependency, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, retryD1Operation, serializeWithExternalStorage, tryDeserializeObj, updateWorkflow, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };
+export { ConsoleWrapper, DateRangeFilter, ExternalBlobStorage, HandleWorkflowQueueMessageParams, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, PropertyFilter, QueueWorkflowContextOptions, R2ExternalBlobStorageOptions, RetryConfig, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, StringFilter, ValueTypeMap, WorkflowCallResult, WorkflowContext, WorkflowContextInstance, WorkflowContextOptions, WorkflowEnqueueBatchItem, WorkflowFilter, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, WorkflowStatus, createCleanupManager, createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, createWorkflowDependencies, createWorkflowDependency, defaultIdFactory, defaultSerializer, defineWorkflow, deleteWorkflowDependency, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, retryD1Operation, serializeWithExternalStorage, tryDeserializeObj, updateWorkflow, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };

package/dist/index.js

@@ -2320,6 +2320,17 @@ function createWorkflowContext(options) {
 				result
 			});
 			await logBatcher.destroy();
+			return {
+				instanceId,
+				workflowType: workflow.workflowType,
+				tenantId,
+				parentInstanceId: parentInstanceId ?? null,
+				triggerId: triggerId ?? null,
+				startTime,
+				result,
+				workflowStatus,
+				endTime
+			};
 		} catch (error) {
 			const endTime = Date.now();
 			const workflowStatus = "failed";
@@ -2345,7 +2356,7 @@ function createWorkflowContext(options) {
 		const encodedInput = oldRun?.input;
 		if (inputRef === void 0 || encodedInput === void 0) throw new Error(`No input found for instanceId ${retryInstanceId}`);
 		const input = await deserializeWithExternalStorage(encodedInput, inputRef, internalContext.serializer, options.externalBlobStorage);
-		await call({
+		return await call({
 			workflow,
 			input,
 			workflowName: oldWorkflowName ?? "unknown",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brandboostinggmbh/observable-workflows",
-  "version": "0.22.1",
+  "version": "0.23.0",
   "description": "My awesome typescript library",
   "type": "module",
   "license": "MIT",