@vellumai/plugin-api 0.9.0-dev.202606181513.fd39213 → 0.9.0-dev.202606181735.ae6e1d8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +78 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -4802,6 +4802,13 @@ export declare interface WebSearchToolResultContent {
4802
4802
  declare interface WorkflowCompleted {
4803
4803
  type: "workflow_completed";
4804
4804
  runId: string;
4805
+ /**
4806
+ * Originating conversation id, when launched from one; lets `broadcastMessage`
4807
+ * auto-scope + seq-stamp the event to that conversation's SSE stream. Omitted
4808
+ * for a conversationless run (e.g. a scheduled workflow), which broadcasts
4809
+ * unscoped for raw SSE listeners and the DB record.
4810
+ */
4811
+ conversationId?: string;
4805
4812
  status: WorkflowRunStatus;
4806
4813
  agentsSpawned: number;
4807
4814
  inputTokens: number;
@@ -4810,6 +4817,49 @@ declare interface WorkflowCompleted {
4810
4817
  summary?: string;
4811
4818
  }
4812
4819
 
4820
+ /**
4821
+ * A leaf agent within a workflow run has finished. `seq` matches the
4822
+ * corresponding `workflow_leaf_started` event.
4823
+ */
4824
+ declare interface WorkflowLeafFinished {
4825
+ type: "workflow_leaf_finished";
4826
+ runId: string;
4827
+ /**
4828
+ * Originating conversation id; lets `broadcastMessage` auto-scope +
4829
+ * seq-stamp the event to the conversation's SSE stream.
4830
+ */
4831
+ conversationId: string;
4832
+ seq: number;
4833
+ status: "completed" | "failed";
4834
+ /** Leaf label, for client display. */
4835
+ label?: string;
4836
+ inputTokens?: number;
4837
+ outputTokens?: number;
4838
+ /** Short summary of the leaf's result, for client display. */
4839
+ resultSummary?: string;
4840
+ }
4841
+
4842
+ /**
4843
+ * A leaf agent within a workflow run has started. `seq` orders leaves within
4844
+ * the run for stable client-side tree placement.
4845
+ */
4846
+ declare interface WorkflowLeafStarted {
4847
+ type: "workflow_leaf_started";
4848
+ runId: string;
4849
+ /**
4850
+ * Originating conversation id; lets `broadcastMessage` auto-scope +
4851
+ * seq-stamp the event to the conversation's SSE stream.
4852
+ */
4853
+ conversationId: string;
4854
+ seq: number;
4855
+ /** Leaf label, for client display. */
4856
+ label?: string;
4857
+ /** Phase the leaf belongs to, when the workflow declares phases. */
4858
+ phase?: string;
4859
+ /** Short summary of the leaf's prompt, for client display. */
4860
+ promptSummary?: string;
4861
+ }
4862
+
4813
4863
  /**
4814
4864
  * Progress push for an in-flight workflow run. Maps the engine's
4815
4865
  * `onProgress` (`phase`/`log`) callback plus the current usage snapshot into a
@@ -4819,6 +4869,13 @@ declare interface WorkflowCompleted {
4819
4869
  declare interface WorkflowProgress {
4820
4870
  type: "workflow_progress";
4821
4871
  runId: string;
4872
+ /**
4873
+ * Originating conversation id, when launched from one; lets `broadcastMessage`
4874
+ * auto-scope + seq-stamp the event to that conversation's SSE stream. Omitted
4875
+ * for a conversationless run (e.g. a scheduled workflow), which broadcasts
4876
+ * unscoped for raw SSE listeners and the DB record.
4877
+ */
4878
+ conversationId?: string;
4822
4879
  /** Latest phase title, when this emission came from a `phase(...)` call. */
4823
4880
  phase?: string;
4824
4881
  /** Run label (the workflow's `meta.name`), for client display. */
@@ -4846,7 +4903,27 @@ declare interface WorkflowProgress {
4846
4903
  */
4847
4904
  declare type WorkflowRunStatus = "running" | "completed" | "failed" | "aborted" | "cap_exceeded" | "interrupted";
4848
4905
 
4849
- declare type _WorkflowsServerMessages = WorkflowProgress | WorkflowCompleted;
4906
+ declare type _WorkflowsServerMessages = WorkflowProgress | WorkflowCompleted | WorkflowStarted | WorkflowLeafStarted | WorkflowLeafFinished;
4907
+
4908
+ /**
4909
+ * A workflow run has started. Emitted once at launch, before any leaf events.
4910
+ */
4911
+ declare interface WorkflowStarted {
4912
+ type: "workflow_started";
4913
+ runId: string;
4914
+ /**
4915
+ * Originating conversation id; lets `broadcastMessage` auto-scope +
4916
+ * seq-stamp the event to the conversation's SSE stream.
4917
+ */
4918
+ conversationId: string;
4919
+ /**
4920
+ * Tool-use id of the `skill_execute` block that launched this run, for
4921
+ * anchoring the inline workflow card to the exact spawn tool call.
4922
+ */
4923
+ toolUseId?: string;
4924
+ /** Run label (the workflow's `meta.name`), for client display. */
4925
+ label?: string;
4926
+ }
4850
4927
 
4851
4928
  declare interface WorkItemApprovePermissionsResponse {
4852
4929
  type: "work_item_approve_permissions_response";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vellumai/plugin-api",
3
- "version": "0.9.0-dev.202606181513.fd39213",
3
+ "version": "0.9.0-dev.202606181735.ae6e1d8",
4
4
  "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
5
5
  "license": "MIT",
6
6
  "type": "module",