@voltagent/core 2.5.0 → 2.6.0

package/dist/index.d.mts

@@ -10050,6 +10050,26 @@ interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA
      * Abort the workflow execution
      */
     abort: () => void;
+    /**
+     * Subscribe to run-level stream events without consuming the main async iterator.
+     * Returns an unsubscribe function.
+     */
+    watch: (cb: (event: WorkflowStreamEvent) => void | Promise<void>) => () => void;
+    /**
+     * Async variant of watch() for compatibility with observer-based integrations.
+     */
+    watchAsync: (cb: (event: WorkflowStreamEvent) => void | Promise<void>) => Promise<() => void>;
+    /**
+     * Create a ReadableStream view over workflow events.
+     */
+    observeStream: () => ReadableStream<WorkflowStreamEvent>;
+    /**
+     * Compatibility surface for legacy stream consumers.
+     */
+    streamLegacy: () => {
+        stream: ReadableStream<WorkflowStreamEvent>;
+        getWorkflowState: () => ReturnType<Memory["getWorkflowState"]>;
+    };
 }
 /**
  * Result returned when a workflow execution is started asynchronously
@@ -10721,11 +10741,15 @@ type InternalBaseWorkflowInputSchema = z.ZodTypeAny | BaseMessage | BaseMessage[
  * Context object for new execute API with helper functions
  * @private - INTERNAL USE ONLY
  */
-interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
+interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> {
     data: DATA;
     state: WorkflowStepState<INPUT>;
     getStepData: (stepId: string) => WorkflowStepData | undefined;
+    getStepResult: <T = unknown>(stepId: string) => T | null;
+    getInitData: <T = InternalExtractWorkflowInputData<INPUT>>() => T;
     suspend: (reason?: string, suspendData?: SUSPEND_DATA) => Promise<never>;
+    bail: (result?: WORKFLOW_RESULT) => never;
+    abort: () => never;
     resumeData?: RESUME_DATA;
     retryCount?: number;
     workflowState: WorkflowStateStore;
@@ -10746,7 +10770,7 @@ interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
  * Uses context-based API with data, state, and helper functions
  * @private - INTERNAL USE ONLY
  */
-type InternalWorkflowFunc<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> = (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA>) => Promise<RESULT>;
+type InternalWorkflowFunc<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> = (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>) => Promise<RESULT>;
 type InternalWorkflowStepConfig<T extends PlainObject = PlainObject> = {
     /**
      * Unique identifier for the step
@@ -10770,7 +10794,7 @@ type InternalWorkflowStepConfig<T extends PlainObject = PlainObject> = {
  * Base step interface for building new steps
  * @private - INTERNAL USE ONLY
  */
-interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> {
+interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> {
     /**
      * Unique identifier for the step
      */
@@ -10812,13 +10836,13 @@ interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DAT
      * @param context - The execution context containing data, state, and helpers
      * @returns The result of the step
      */
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>) => Promise<RESULT>;
 }
 /**
  * Any step that can be accepted by the workflow
  * @private - INTERNAL USE ONLY
  */
-type InternalAnyWorkflowStep<INPUT = DangerouslyAllowAny, DATA = DangerouslyAllowAny, RESULT = DangerouslyAllowAny, SUSPEND_DATA = DangerouslyAllowAny, RESUME_DATA = DangerouslyAllowAny> = InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> | Omit<InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA>, "type">;
+type InternalAnyWorkflowStep<INPUT = DangerouslyAllowAny, DATA = DangerouslyAllowAny, RESULT = DangerouslyAllowAny, SUSPEND_DATA = DangerouslyAllowAny, RESUME_DATA = DangerouslyAllowAny, WORKFLOW_RESULT = unknown> = InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT> | Omit<InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>, "type">;
 /**
  * Infer the result type from a list of steps
  * @private - INTERNAL USE ONLY
@@ -10868,7 +10892,7 @@ declare function andAgent<INPUT, DATA, SCHEMA extends AgentOutputSchema, RESULT
     name: string;
     purpose: string | null;
     agent: Agent;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
 };
 
 interface WorkflowStepAgent<INPUT, DATA, RESULT> extends InternalBaseWorkflowStep<INPUT, DATA, RESULT, any, any> {
@@ -11160,7 +11184,7 @@ declare function andWhen<INPUT, DATA, RESULT>({ condition, step, inputSchema, ou
 declare function andAll<INPUT, DATA, RESULT, STEPS extends ReadonlyArray<InternalAnyWorkflowStep<INPUT, DATA, RESULT>> | WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT>>({ steps: inputSteps, ...config }: WorkflowStepParallelAllConfig<INPUT, DATA, RESULT, STEPS>): {
     type: "parallel-all";
     steps: InternalAnyWorkflowStep<INPUT, DATA, STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>;
     id: string;
     name: string;
     purpose: string;
@@ -11217,7 +11241,7 @@ declare function andRace<INPUT, DATA, RESULT, STEPS extends ReadonlyArray<Intern
 }>): {
     type: "parallel-race";
     steps: InternalAnyWorkflowStep<INPUT, DATA, InternalInferWorkflowStepsResult<STEPS>[number]>[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<InternalInferWorkflowStepsResult<STEPS>[number]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<InternalInferWorkflowStepsResult<STEPS>[number]>;
     id: string;
     name: string;
     purpose: string;
@@ -11328,7 +11352,7 @@ declare function andForEach<INPUT, DATA, ITEM, RESULT, MAP_DATA = ITEM>({ step,
     concurrency: number;
     items: WorkflowStepForEachItemsFunc<INPUT, DATA, ITEM> | undefined;
     map: WorkflowStepForEachMapFunc<INPUT, DATA, ITEM, MAP_DATA> | undefined;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT[]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT[]>;
     id: string;
     name: string;
     purpose: string;
@@ -11344,7 +11368,7 @@ declare function andBranch<INPUT, DATA, RESULT>({ branches, ...config }: Workflo
         condition: InternalWorkflowFunc<INPUT, DATA, boolean, any, any>;
         step: InternalAnyWorkflowStep<INPUT, DATA, RESULT>;
     }[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<(RESULT | undefined)[]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<(RESULT | undefined)[]>;
     id: string;
     name: string;
     purpose: string;
@@ -11361,7 +11385,7 @@ declare function andDoWhile<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
     step: InternalAnyWorkflowStep<INPUT, DATA, RESULT> | InternalAnyWorkflowStep<INPUT, DATA, any>;
     steps: WorkflowStepLoopSteps<INPUT, DATA, RESULT>;
     condition: InternalWorkflowFunc<INPUT, RESULT, boolean, any, any>;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
     id: string;
     name: string;
     purpose: string;
@@ -11376,7 +11400,7 @@ declare function andDoUntil<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
     step: InternalAnyWorkflowStep<INPUT, DATA, RESULT> | InternalAnyWorkflowStep<INPUT, DATA, any>;
     steps: WorkflowStepLoopSteps<INPUT, DATA, RESULT>;
     condition: InternalWorkflowFunc<INPUT, RESULT, boolean, any, any>;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
     id: string;
     name: string;
     purpose: string;
@@ -11389,7 +11413,7 @@ declare function andDoUntil<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
 declare function andMap<INPUT, DATA, MAP extends Record<string, WorkflowStepMapEntry<INPUT, DATA>>>({ map, ...config }: WorkflowStepMapConfig<INPUT, DATA, MAP>): {
     type: "map";
     map: MAP;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<WorkflowStepMapResult<MAP>>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<WorkflowStepMapResult<MAP>>;
     id: string;
     name: string;
     purpose: string;

package/dist/index.d.ts

@@ -10050,6 +10050,26 @@ interface WorkflowStreamResult<RESULT_SCHEMA extends z.ZodTypeAny, RESUME_SCHEMA
      * Abort the workflow execution
      */
     abort: () => void;
+    /**
+     * Subscribe to run-level stream events without consuming the main async iterator.
+     * Returns an unsubscribe function.
+     */
+    watch: (cb: (event: WorkflowStreamEvent) => void | Promise<void>) => () => void;
+    /**
+     * Async variant of watch() for compatibility with observer-based integrations.
+     */
+    watchAsync: (cb: (event: WorkflowStreamEvent) => void | Promise<void>) => Promise<() => void>;
+    /**
+     * Create a ReadableStream view over workflow events.
+     */
+    observeStream: () => ReadableStream<WorkflowStreamEvent>;
+    /**
+     * Compatibility surface for legacy stream consumers.
+     */
+    streamLegacy: () => {
+        stream: ReadableStream<WorkflowStreamEvent>;
+        getWorkflowState: () => ReturnType<Memory["getWorkflowState"]>;
+    };
 }
 /**
  * Result returned when a workflow execution is started asynchronously
@@ -10721,11 +10741,15 @@ type InternalBaseWorkflowInputSchema = z.ZodTypeAny | BaseMessage | BaseMessage[
  * Context object for new execute API with helper functions
  * @private - INTERNAL USE ONLY
  */
-interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
+interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> {
     data: DATA;
     state: WorkflowStepState<INPUT>;
     getStepData: (stepId: string) => WorkflowStepData | undefined;
+    getStepResult: <T = unknown>(stepId: string) => T | null;
+    getInitData: <T = InternalExtractWorkflowInputData<INPUT>>() => T;
     suspend: (reason?: string, suspendData?: SUSPEND_DATA) => Promise<never>;
+    bail: (result?: WORKFLOW_RESULT) => never;
+    abort: () => never;
     resumeData?: RESUME_DATA;
     retryCount?: number;
     workflowState: WorkflowStateStore;
@@ -10746,7 +10770,7 @@ interface WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA> {
  * Uses context-based API with data, state, and helper functions
  * @private - INTERNAL USE ONLY
  */
-type InternalWorkflowFunc<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> = (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA>) => Promise<RESULT>;
+type InternalWorkflowFunc<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> = (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>) => Promise<RESULT>;
 type InternalWorkflowStepConfig<T extends PlainObject = PlainObject> = {
     /**
      * Unique identifier for the step
@@ -10770,7 +10794,7 @@ type InternalWorkflowStepConfig<T extends PlainObject = PlainObject> = {
  * Base step interface for building new steps
  * @private - INTERNAL USE ONLY
  */
-interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> {
+interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT = unknown> {
     /**
      * Unique identifier for the step
      */
@@ -10812,13 +10836,13 @@ interface InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DAT
      * @param context - The execution context containing data, state, and helpers
      * @returns The result of the step
      */
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>) => Promise<RESULT>;
 }
 /**
  * Any step that can be accepted by the workflow
  * @private - INTERNAL USE ONLY
  */
-type InternalAnyWorkflowStep<INPUT = DangerouslyAllowAny, DATA = DangerouslyAllowAny, RESULT = DangerouslyAllowAny, SUSPEND_DATA = DangerouslyAllowAny, RESUME_DATA = DangerouslyAllowAny> = InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA> | Omit<InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA>, "type">;
+type InternalAnyWorkflowStep<INPUT = DangerouslyAllowAny, DATA = DangerouslyAllowAny, RESULT = DangerouslyAllowAny, SUSPEND_DATA = DangerouslyAllowAny, RESUME_DATA = DangerouslyAllowAny, WORKFLOW_RESULT = unknown> = InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT> | Omit<InternalBaseWorkflowStep<INPUT, DATA, RESULT, SUSPEND_DATA, RESUME_DATA, WORKFLOW_RESULT>, "type">;
 /**
  * Infer the result type from a list of steps
  * @private - INTERNAL USE ONLY
@@ -10868,7 +10892,7 @@ declare function andAgent<INPUT, DATA, SCHEMA extends AgentOutputSchema, RESULT
     name: string;
     purpose: string | null;
     agent: Agent;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
 };
 
 interface WorkflowStepAgent<INPUT, DATA, RESULT> extends InternalBaseWorkflowStep<INPUT, DATA, RESULT, any, any> {
@@ -11160,7 +11184,7 @@ declare function andWhen<INPUT, DATA, RESULT>({ condition, step, inputSchema, ou
 declare function andAll<INPUT, DATA, RESULT, STEPS extends ReadonlyArray<InternalAnyWorkflowStep<INPUT, DATA, RESULT>> | WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT>>({ steps: inputSteps, ...config }: WorkflowStepParallelAllConfig<INPUT, DATA, RESULT, STEPS>): {
     type: "parallel-all";
     steps: InternalAnyWorkflowStep<INPUT, DATA, STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<STEPS extends readonly InternalAnyWorkflowStep<INPUT, DATA, RESULT>[] ? InternalInferWorkflowStepsResult<STEPS> : STEPS extends WorkflowStepParallelDynamicStepsFunc<INPUT, DATA, RESULT> ? InternalInferWorkflowStepsResult<Awaited<ReturnType<STEPS>>> : never>;
     id: string;
     name: string;
     purpose: string;
@@ -11217,7 +11241,7 @@ declare function andRace<INPUT, DATA, RESULT, STEPS extends ReadonlyArray<Intern
 }>): {
     type: "parallel-race";
     steps: InternalAnyWorkflowStep<INPUT, DATA, InternalInferWorkflowStepsResult<STEPS>[number]>[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<InternalInferWorkflowStepsResult<STEPS>[number]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<InternalInferWorkflowStepsResult<STEPS>[number]>;
     id: string;
     name: string;
     purpose: string;
@@ -11328,7 +11352,7 @@ declare function andForEach<INPUT, DATA, ITEM, RESULT, MAP_DATA = ITEM>({ step,
     concurrency: number;
     items: WorkflowStepForEachItemsFunc<INPUT, DATA, ITEM> | undefined;
     map: WorkflowStepForEachMapFunc<INPUT, DATA, ITEM, MAP_DATA> | undefined;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT[]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT[]>;
     id: string;
     name: string;
     purpose: string;
@@ -11344,7 +11368,7 @@ declare function andBranch<INPUT, DATA, RESULT>({ branches, ...config }: Workflo
         condition: InternalWorkflowFunc<INPUT, DATA, boolean, any, any>;
         step: InternalAnyWorkflowStep<INPUT, DATA, RESULT>;
     }[];
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<(RESULT | undefined)[]>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<(RESULT | undefined)[]>;
     id: string;
     name: string;
     purpose: string;
@@ -11361,7 +11385,7 @@ declare function andDoWhile<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
     step: InternalAnyWorkflowStep<INPUT, DATA, RESULT> | InternalAnyWorkflowStep<INPUT, DATA, any>;
     steps: WorkflowStepLoopSteps<INPUT, DATA, RESULT>;
     condition: InternalWorkflowFunc<INPUT, RESULT, boolean, any, any>;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
     id: string;
     name: string;
     purpose: string;
@@ -11376,7 +11400,7 @@ declare function andDoUntil<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
     step: InternalAnyWorkflowStep<INPUT, DATA, RESULT> | InternalAnyWorkflowStep<INPUT, DATA, any>;
     steps: WorkflowStepLoopSteps<INPUT, DATA, RESULT>;
     condition: InternalWorkflowFunc<INPUT, RESULT, boolean, any, any>;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<RESULT>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<RESULT>;
     id: string;
     name: string;
     purpose: string;
@@ -11389,7 +11413,7 @@ declare function andDoUntil<INPUT, DATA, RESULT>(config: WorkflowStepLoopConfig<
 declare function andMap<INPUT, DATA, MAP extends Record<string, WorkflowStepMapEntry<INPUT, DATA>>>({ map, ...config }: WorkflowStepMapConfig<INPUT, DATA, MAP>): {
     type: "map";
     map: MAP;
-    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any>) => Promise<WorkflowStepMapResult<MAP>>;
+    execute: (context: WorkflowExecuteContext<INPUT, DATA, any, any, unknown>) => Promise<WorkflowStepMapResult<MAP>>;
     id: string;
     name: string;
     purpose: string;