@botiverse/raft-sdk 0.10.0 → 0.11.0

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.
package/README.md CHANGED
@@ -201,8 +201,11 @@ if (!created.ok && created.error.retryable) {
201
201
  Unlike `send`, the SDK never retries these by itself: the guarantee needs a
202
202
  Server with keyed task create / action prepare. Older Servers ignore the key,
203
203
  and a repeat there creates the tasks (or posts the card) again.
204
- - `raft.mentions.pending / execute / deliveries` — @mentions you sent that
205
- reached nobody, the notify/add recovery, and per-target delivery outcomes.
204
+ - `raft.mentions.pending / notify / add / delivery` — @mentions you sent that
205
+ reached nobody, the notify/add recovery (`notify({ resolutionIds })`,
206
+ `add({ resolutionIds })`), and per-target delivery outcomes
207
+ (`delivery({ messageId })`). `execute` and `deliveries` are deprecated
208
+ aliases, removed in 0.12.0.
206
209
  - `raft.manual.get / search` — the Raft Manual for Agents; both need a short
207
210
  `intent` and `reason` (never prompts, credentials, or message payloads).
208
211
  - `raft.wake.webhook.register({ url, secret })` / `status()` / `unregister()`.
@@ -10735,11 +10735,8 @@ const RAFT_HINTS = {
10735
10735
  action,
10736
10736
  resolutionId
10737
10737
  ], {
10738
- name: "mentions.execute",
10739
- args: {
10740
- action,
10741
- resolutionIds: [resolutionId]
10742
- }
10738
+ name: action === "notify" ? "mentions.notify" : "mentions.add",
10739
+ args: { resolutionIds: [resolutionId] }
10743
10740
  }),
10744
10741
  mentionPending: () => hint(["mention", "pending"], {
10745
10742
  name: "mentions.pending",
@@ -14724,6 +14721,8 @@ function formatAgentSenderMentionDeliveries(messageId, deliveries) {
14724
14721
  //#endregion
14725
14722
  //#region ../shared/src/agentOps/mentions.ts
14726
14723
  const pendingMentionActionsRequestSchema = requestSchema()(object({ limit: number$1().int().positive().optional().describe("Maximum pending mentions to list.") }));
14724
+ const mentionResolutionIdsRequestSchema = requestSchema()(object({ resolutionIds: array(string()).describe("resolutionId values from mentions.pending.") }));
14725
+ /** @deprecated The request of the deprecated `mentions.execute`; use `mentionResolutionIdsRequestSchema` (`mentions.notify` / `mentions.add`). */
14727
14726
  const executeMentionActionRequestSchema = requestSchema()(object({
14728
14727
  action: _enum(["notify", "add"]).describe("notify: tell the mentioned target about the message; add: add them to the conversation."),
14729
14728
  resolutionIds: array(string()).describe("resolutionId values from mentions.pending.")
@@ -14758,13 +14757,31 @@ async function pendingMentionActions(client, request = {}, options = {}) {
14758
14757
  })
14759
14758
  };
14760
14759
  }
14760
+ /** Tell the targets of unreached @mentions about the message (`raft mention notify`). */
14761
+ async function notifyMentions(client, request) {
14762
+ const invalid = validateOpRequest(mentionResolutionIdsRequestSchema, request);
14763
+ if (invalid) return invalid;
14764
+ return runMentionAction(client, "notify", request.resolutionIds);
14765
+ }
14766
+ /** Add the targets of unreached @mentions to the conversation (`raft mention add`). */
14767
+ async function addMentions(client, request) {
14768
+ const invalid = validateOpRequest(mentionResolutionIdsRequestSchema, request);
14769
+ if (invalid) return invalid;
14770
+ return runMentionAction(client, "add", request.resolutionIds);
14771
+ }
14772
+ /** @deprecated Backs the deprecated `mentions.execute`; use `notifyMentions` / `addMentions`. */
14761
14773
  async function executeMentionAction(client, request) {
14762
14774
  const invalid = validateOpRequest(executeMentionActionRequestSchema, request);
14763
14775
  if (invalid) return invalid;
14764
- const ids = (request.resolutionIds ?? []).map((id) => id.trim()).filter(Boolean);
14765
- if (ids.length === 0 || request.action !== "notify" && request.action !== "add") return failureOutcome(opError("INVALID_REQUEST", { message: "Pass an action (notify | add) and at least one resolution id." }));
14776
+ const missing = "Pass an action (notify | add) and at least one resolution id.";
14777
+ if (request.action !== "notify" && request.action !== "add") return failureOutcome(opError("INVALID_REQUEST", { message: missing }));
14778
+ return runMentionAction(client, request.action, request.resolutionIds, missing);
14779
+ }
14780
+ async function runMentionAction(client, action, resolutionIds, missingIdsMessage = "Pass at least one resolution id.") {
14781
+ const ids = (resolutionIds ?? []).map((id) => id.trim()).filter(Boolean);
14782
+ if (ids.length === 0) return failureOutcome(opError("INVALID_REQUEST", { message: missingIdsMessage }));
14766
14783
  const result = await client.mentions.executeAction({
14767
- action: request.action,
14784
+ action,
14768
14785
  resolutionIds: ids
14769
14786
  });
14770
14787
  if (!result.ok) return failureFromClientResult(result);
@@ -14773,11 +14790,11 @@ async function executeMentionAction(client, request) {
14773
14790
  ok: true,
14774
14791
  state: "executed",
14775
14792
  data: {
14776
- action: request.action,
14793
+ action,
14777
14794
  results
14778
14795
  },
14779
14796
  next: null,
14780
- text: formatAgentMentionActionResults(request.action, results)
14797
+ text: formatAgentMentionActionResults(action, results)
14781
14798
  };
14782
14799
  }
14783
14800
  async function senderMentionDeliveries(client, request) {
@@ -15549,21 +15566,47 @@ const OPERATION_DEFS = [
15549
15566
  }
15550
15567
  },
15551
15568
  {
15552
- name: "mentions.execute",
15553
- description: "Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
15554
- schema: executeMentionActionRequestSchema,
15569
+ name: "mentions.notify",
15570
+ description: "Deliver unreached @mentions by notifying each mentioned target about the message, without adding them to the conversation. Takes resolutionId values from mentions.pending.",
15571
+ schema: mentionResolutionIdsRequestSchema,
15555
15572
  routes: ["mentionActionsExecute"],
15556
15573
  consumes: nothing,
15557
15574
  output: small
15558
15575
  },
15559
15576
  {
15560
- name: "mentions.deliveries",
15577
+ name: "mentions.add",
15578
+ description: "Deliver unreached @mentions by adding each mentioned target to the conversation, so they see the message and what follows. Takes resolutionId values from mentions.pending.",
15579
+ schema: mentionResolutionIdsRequestSchema,
15580
+ routes: ["mentionActionsExecute"],
15581
+ consumes: nothing,
15582
+ output: small
15583
+ },
15584
+ {
15585
+ name: "mentions.delivery",
15561
15586
  description: "Whether each @mention in a message you sent reached its target.",
15562
15587
  schema: senderMentionDeliveriesRequestSchema,
15563
15588
  routes: ["senderMentionDeliveries"],
15564
15589
  consumes: nothing,
15565
15590
  output: small
15566
15591
  },
15592
+ {
15593
+ name: "mentions.execute",
15594
+ description: "Deprecated: use mentions.notify / mentions.add. Removed in the next minor release. Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
15595
+ schema: executeMentionActionRequestSchema,
15596
+ routes: ["mentionActionsExecute"],
15597
+ consumes: nothing,
15598
+ output: small,
15599
+ deprecated: true
15600
+ },
15601
+ {
15602
+ name: "mentions.deliveries",
15603
+ description: "Deprecated: use mentions.delivery. Removed in the next minor release. Whether each @mention in a message you sent reached its target.",
15604
+ schema: senderMentionDeliveriesRequestSchema,
15605
+ routes: ["senderMentionDeliveries"],
15606
+ consumes: nothing,
15607
+ output: small,
15608
+ deprecated: true
15609
+ },
15567
15610
  {
15568
15611
  name: "actions.prepare",
15569
15612
  description: "Post an action card (create a channel, add members, create an agent, or an integration step) for a human to confirm; the human who clicks it carries it out as themselves. When it is executed (or fails), the outcome arrives as a reply that @mentions you in the card's thread (or in the thread the card was posted in).",
@@ -16035,6 +16078,9 @@ function createRaft(options) {
16035
16078
  },
16036
16079
  mentions: {
16037
16080
  pending: (request) => pendingMentionActions(api, request, style).then(styled),
16081
+ notify: (request) => notifyMentions(api, request).then(styled),
16082
+ add: (request) => addMentions(api, request).then(styled),
16083
+ delivery: (request) => senderMentionDeliveries(api, request).then(styled),
16038
16084
  execute: (request) => executeMentionAction(api, request).then(styled),
16039
16085
  deliveries: (request) => senderMentionDeliveries(api, request).then(styled)
16040
16086
  },
@@ -16125,6 +16171,9 @@ function createRaft(options) {
16125
16171
  "attachments.downloadUrl": (args) => raft.attachments.downloadUrl(args),
16126
16172
  "attachments.comments": (args) => raft.attachments.comments(args),
16127
16173
  "mentions.pending": (args) => raft.mentions.pending(args),
16174
+ "mentions.notify": (args) => raft.mentions.notify(args),
16175
+ "mentions.add": (args) => raft.mentions.add(args),
16176
+ "mentions.delivery": (args) => raft.mentions.delivery(args),
16128
16177
  "mentions.execute": (args) => raft.mentions.execute(args),
16129
16178
  "mentions.deliveries": (args) => raft.mentions.deliveries(args),
16130
16179
  "actions.prepare": (args) => raft.actions.prepare(args),
@@ -16239,6 +16288,7 @@ exports.listInboxRequestSchema = listInboxRequestSchema;
16239
16288
  exports.listRaftRoutes = listRaftRoutes;
16240
16289
  exports.listTasksRequestSchema = listTasksRequestSchema;
16241
16290
  exports.listThreadsRequestSchema = listThreadsRequestSchema;
16291
+ exports.mentionResolutionIdsRequestSchema = mentionResolutionIdsRequestSchema;
16242
16292
  exports.parseRaftRegularChannelTarget = parseRaftRegularChannelTarget;
16243
16293
  exports.parseRaftState = parseRaftState;
16244
16294
  exports.pendingMentionActionsRequestSchema = pendingMentionActionsRequestSchema;
package/dist/esm/index.js CHANGED
@@ -10734,11 +10734,8 @@ const RAFT_HINTS = {
10734
10734
  action,
10735
10735
  resolutionId
10736
10736
  ], {
10737
- name: "mentions.execute",
10738
- args: {
10739
- action,
10740
- resolutionIds: [resolutionId]
10741
- }
10737
+ name: action === "notify" ? "mentions.notify" : "mentions.add",
10738
+ args: { resolutionIds: [resolutionId] }
10742
10739
  }),
10743
10740
  mentionPending: () => hint(["mention", "pending"], {
10744
10741
  name: "mentions.pending",
@@ -14723,6 +14720,8 @@ function formatAgentSenderMentionDeliveries(messageId, deliveries) {
14723
14720
  //#endregion
14724
14721
  //#region ../shared/src/agentOps/mentions.ts
14725
14722
  const pendingMentionActionsRequestSchema = requestSchema()(object({ limit: number$1().int().positive().optional().describe("Maximum pending mentions to list.") }));
14723
+ const mentionResolutionIdsRequestSchema = requestSchema()(object({ resolutionIds: array(string()).describe("resolutionId values from mentions.pending.") }));
14724
+ /** @deprecated The request of the deprecated `mentions.execute`; use `mentionResolutionIdsRequestSchema` (`mentions.notify` / `mentions.add`). */
14726
14725
  const executeMentionActionRequestSchema = requestSchema()(object({
14727
14726
  action: _enum(["notify", "add"]).describe("notify: tell the mentioned target about the message; add: add them to the conversation."),
14728
14727
  resolutionIds: array(string()).describe("resolutionId values from mentions.pending.")
@@ -14757,13 +14756,31 @@ async function pendingMentionActions(client, request = {}, options = {}) {
14757
14756
  })
14758
14757
  };
14759
14758
  }
14759
+ /** Tell the targets of unreached @mentions about the message (`raft mention notify`). */
14760
+ async function notifyMentions(client, request) {
14761
+ const invalid = validateOpRequest(mentionResolutionIdsRequestSchema, request);
14762
+ if (invalid) return invalid;
14763
+ return runMentionAction(client, "notify", request.resolutionIds);
14764
+ }
14765
+ /** Add the targets of unreached @mentions to the conversation (`raft mention add`). */
14766
+ async function addMentions(client, request) {
14767
+ const invalid = validateOpRequest(mentionResolutionIdsRequestSchema, request);
14768
+ if (invalid) return invalid;
14769
+ return runMentionAction(client, "add", request.resolutionIds);
14770
+ }
14771
+ /** @deprecated Backs the deprecated `mentions.execute`; use `notifyMentions` / `addMentions`. */
14760
14772
  async function executeMentionAction(client, request) {
14761
14773
  const invalid = validateOpRequest(executeMentionActionRequestSchema, request);
14762
14774
  if (invalid) return invalid;
14763
- const ids = (request.resolutionIds ?? []).map((id) => id.trim()).filter(Boolean);
14764
- if (ids.length === 0 || request.action !== "notify" && request.action !== "add") return failureOutcome(opError("INVALID_REQUEST", { message: "Pass an action (notify | add) and at least one resolution id." }));
14775
+ const missing = "Pass an action (notify | add) and at least one resolution id.";
14776
+ if (request.action !== "notify" && request.action !== "add") return failureOutcome(opError("INVALID_REQUEST", { message: missing }));
14777
+ return runMentionAction(client, request.action, request.resolutionIds, missing);
14778
+ }
14779
+ async function runMentionAction(client, action, resolutionIds, missingIdsMessage = "Pass at least one resolution id.") {
14780
+ const ids = (resolutionIds ?? []).map((id) => id.trim()).filter(Boolean);
14781
+ if (ids.length === 0) return failureOutcome(opError("INVALID_REQUEST", { message: missingIdsMessage }));
14765
14782
  const result = await client.mentions.executeAction({
14766
- action: request.action,
14783
+ action,
14767
14784
  resolutionIds: ids
14768
14785
  });
14769
14786
  if (!result.ok) return failureFromClientResult(result);
@@ -14772,11 +14789,11 @@ async function executeMentionAction(client, request) {
14772
14789
  ok: true,
14773
14790
  state: "executed",
14774
14791
  data: {
14775
- action: request.action,
14792
+ action,
14776
14793
  results
14777
14794
  },
14778
14795
  next: null,
14779
- text: formatAgentMentionActionResults(request.action, results)
14796
+ text: formatAgentMentionActionResults(action, results)
14780
14797
  };
14781
14798
  }
14782
14799
  async function senderMentionDeliveries(client, request) {
@@ -15548,21 +15565,47 @@ const OPERATION_DEFS = [
15548
15565
  }
15549
15566
  },
15550
15567
  {
15551
- name: "mentions.execute",
15552
- description: "Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
15553
- schema: executeMentionActionRequestSchema,
15568
+ name: "mentions.notify",
15569
+ description: "Deliver unreached @mentions by notifying each mentioned target about the message, without adding them to the conversation. Takes resolutionId values from mentions.pending.",
15570
+ schema: mentionResolutionIdsRequestSchema,
15554
15571
  routes: ["mentionActionsExecute"],
15555
15572
  consumes: nothing,
15556
15573
  output: small
15557
15574
  },
15558
15575
  {
15559
- name: "mentions.deliveries",
15576
+ name: "mentions.add",
15577
+ description: "Deliver unreached @mentions by adding each mentioned target to the conversation, so they see the message and what follows. Takes resolutionId values from mentions.pending.",
15578
+ schema: mentionResolutionIdsRequestSchema,
15579
+ routes: ["mentionActionsExecute"],
15580
+ consumes: nothing,
15581
+ output: small
15582
+ },
15583
+ {
15584
+ name: "mentions.delivery",
15560
15585
  description: "Whether each @mention in a message you sent reached its target.",
15561
15586
  schema: senderMentionDeliveriesRequestSchema,
15562
15587
  routes: ["senderMentionDeliveries"],
15563
15588
  consumes: nothing,
15564
15589
  output: small
15565
15590
  },
15591
+ {
15592
+ name: "mentions.execute",
15593
+ description: "Deprecated: use mentions.notify / mentions.add. Removed in the next minor release. Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
15594
+ schema: executeMentionActionRequestSchema,
15595
+ routes: ["mentionActionsExecute"],
15596
+ consumes: nothing,
15597
+ output: small,
15598
+ deprecated: true
15599
+ },
15600
+ {
15601
+ name: "mentions.deliveries",
15602
+ description: "Deprecated: use mentions.delivery. Removed in the next minor release. Whether each @mention in a message you sent reached its target.",
15603
+ schema: senderMentionDeliveriesRequestSchema,
15604
+ routes: ["senderMentionDeliveries"],
15605
+ consumes: nothing,
15606
+ output: small,
15607
+ deprecated: true
15608
+ },
15566
15609
  {
15567
15610
  name: "actions.prepare",
15568
15611
  description: "Post an action card (create a channel, add members, create an agent, or an integration step) for a human to confirm; the human who clicks it carries it out as themselves. When it is executed (or fails), the outcome arrives as a reply that @mentions you in the card's thread (or in the thread the card was posted in).",
@@ -16034,6 +16077,9 @@ function createRaft(options) {
16034
16077
  },
16035
16078
  mentions: {
16036
16079
  pending: (request) => pendingMentionActions(api, request, style).then(styled),
16080
+ notify: (request) => notifyMentions(api, request).then(styled),
16081
+ add: (request) => addMentions(api, request).then(styled),
16082
+ delivery: (request) => senderMentionDeliveries(api, request).then(styled),
16037
16083
  execute: (request) => executeMentionAction(api, request).then(styled),
16038
16084
  deliveries: (request) => senderMentionDeliveries(api, request).then(styled)
16039
16085
  },
@@ -16124,6 +16170,9 @@ function createRaft(options) {
16124
16170
  "attachments.downloadUrl": (args) => raft.attachments.downloadUrl(args),
16125
16171
  "attachments.comments": (args) => raft.attachments.comments(args),
16126
16172
  "mentions.pending": (args) => raft.mentions.pending(args),
16173
+ "mentions.notify": (args) => raft.mentions.notify(args),
16174
+ "mentions.add": (args) => raft.mentions.add(args),
16175
+ "mentions.delivery": (args) => raft.mentions.delivery(args),
16127
16176
  "mentions.execute": (args) => raft.mentions.execute(args),
16128
16177
  "mentions.deliveries": (args) => raft.mentions.deliveries(args),
16129
16178
  "actions.prepare": (args) => raft.actions.prepare(args),
@@ -16194,4 +16243,4 @@ function whoamiOutcome(result) {
16194
16243
  };
16195
16244
  }
16196
16245
  //#endregion
16197
- export { RAFT_INBOX_NOTICE_SCHEMA, RAFT_JSON_SCHEMA_KEYWORDS, RAFT_NOTICE_DELIVERY_ID_HEADER, RAFT_NOTICE_SIGNATURE_HEADER, RAFT_OPERATIONS, RAFT_OPERATIONS_SCHEMA, RAFT_OPERATIONS_VERSION, RAFT_STATE_CONTINUATIONS_PER_TARGET, RAFT_STATE_CONTINUATIONS_TOTAL, RAFT_STATE_SCHEMA, RaftCredentialError, RaftSdkConfigurationError, SeenFrontier, amendTaskRequestSchema, assignTaskRequestSchema, attachmentCommentsRequestSchema, bootstrapRaftCredential, channelInfoRequestSchema, channelMembersRequestSchema, channelTargetRequestSchema, checkInboxRequestSchema, claimTasksRequestSchema, commitInboxRequestSchema, convertMessageToTaskRequestSchema, createFileCredentialStore, createRaft, createRaftClient, createRaftClientFromStore, createRaftRoutes, createTasksRequestSchema, describeRaftRoute, downloadAttachmentUrlRequestSchema, drainInboxRequestSchema, executeMentionActionRequestSchema, getManualTopicRequestSchema, hasAgentMessageIdentity, hashRaftSendContent, inferAttachmentMimeType, isInterrupted, joinRaftChannelByTarget, listInboxRequestSchema, listRaftRoutes, listTasksRequestSchema, listThreadsRequestSchema, parseRaftRegularChannelTarget, parseRaftState, pendingMentionActionsRequestSchema, prepareActionCardRequestSchema, projectRaftMessage, projectRaftMessages, raftToolNameFor, reactRequestSchema, readHistoryRequestSchema, readLatestReadThread, replyToRequestSchema, resolveMessageRequestSchema, searchManualRequestSchema, searchMessagesRequestSchema, sendMessageRequestSchema, senderMentionDeliveriesRequestSchema, serverInfoRequestSchema, showProfileRequestSchema, taskRefSchema, unfollowThreadRequestSchema, updateProfileRequestSchema, updateTaskStatusRequestSchema, userInfoRequestSchema, verifyInboxNotice, whoamiRequestSchema };
16246
+ export { RAFT_INBOX_NOTICE_SCHEMA, RAFT_JSON_SCHEMA_KEYWORDS, RAFT_NOTICE_DELIVERY_ID_HEADER, RAFT_NOTICE_SIGNATURE_HEADER, RAFT_OPERATIONS, RAFT_OPERATIONS_SCHEMA, RAFT_OPERATIONS_VERSION, RAFT_STATE_CONTINUATIONS_PER_TARGET, RAFT_STATE_CONTINUATIONS_TOTAL, RAFT_STATE_SCHEMA, RaftCredentialError, RaftSdkConfigurationError, SeenFrontier, amendTaskRequestSchema, assignTaskRequestSchema, attachmentCommentsRequestSchema, bootstrapRaftCredential, channelInfoRequestSchema, channelMembersRequestSchema, channelTargetRequestSchema, checkInboxRequestSchema, claimTasksRequestSchema, commitInboxRequestSchema, convertMessageToTaskRequestSchema, createFileCredentialStore, createRaft, createRaftClient, createRaftClientFromStore, createRaftRoutes, createTasksRequestSchema, describeRaftRoute, downloadAttachmentUrlRequestSchema, drainInboxRequestSchema, executeMentionActionRequestSchema, getManualTopicRequestSchema, hasAgentMessageIdentity, hashRaftSendContent, inferAttachmentMimeType, isInterrupted, joinRaftChannelByTarget, listInboxRequestSchema, listRaftRoutes, listTasksRequestSchema, listThreadsRequestSchema, mentionResolutionIdsRequestSchema, parseRaftRegularChannelTarget, parseRaftState, pendingMentionActionsRequestSchema, prepareActionCardRequestSchema, projectRaftMessage, projectRaftMessages, raftToolNameFor, reactRequestSchema, readHistoryRequestSchema, readLatestReadThread, replyToRequestSchema, resolveMessageRequestSchema, searchManualRequestSchema, searchMessagesRequestSchema, sendMessageRequestSchema, senderMentionDeliveriesRequestSchema, serverInfoRequestSchema, showProfileRequestSchema, taskRefSchema, unfollowThreadRequestSchema, updateProfileRequestSchema, updateTaskStatusRequestSchema, userInfoRequestSchema, verifyInboxNotice, whoamiRequestSchema };
package/dist/index.d.ts CHANGED
@@ -1295,6 +1295,10 @@ interface AgentMentionActionResult {
1295
1295
  export declare const pendingMentionActionsRequestSchema: z.ZodObject<{
1296
1296
  limit: z.ZodOptional<z.ZodNumber>;
1297
1297
  }, z.core.$strip>;
1298
+ export declare const mentionResolutionIdsRequestSchema: z.ZodObject<{
1299
+ resolutionIds: z.ZodArray<z.ZodString>;
1300
+ }, z.core.$strip>;
1301
+ /** @deprecated The request of the deprecated `mentions.execute`; use `mentionResolutionIdsRequestSchema` (`mentions.notify` / `mentions.add`). */
1298
1302
  export declare const executeMentionActionRequestSchema: z.ZodObject<{
1299
1303
  action: z.ZodEnum<{
1300
1304
  notify: "notify";
@@ -1311,6 +1315,14 @@ interface RaftPendingMentions {
1311
1315
  hasMore: boolean | null;
1312
1316
  limit: number | undefined;
1313
1317
  }
1318
+ interface MentionResolutionIdsRequest {
1319
+ resolutionIds: string[];
1320
+ }
1321
+ type RaftMentionActionOutcome = RaftOutcome<{
1322
+ action: AgentMentionActionKind;
1323
+ results: AgentMentionActionResult[];
1324
+ }, "executed">;
1325
+ /** @deprecated The request of the deprecated `mentions.execute`; use `MentionResolutionIdsRequest`. */
1314
1326
  interface ExecuteMentionActionRequest {
1315
1327
  action: AgentMentionActionKind;
1316
1328
  resolutionIds: string[];
@@ -9916,9 +9928,54 @@ declare const OPERATION_DEFS: readonly [{
9916
9928
  readonly mayBeLarge: true;
9917
9929
  readonly boundBy: ["limit"];
9918
9930
  };
9931
+ }, {
9932
+ readonly name: "mentions.notify";
9933
+ readonly description: "Deliver unreached @mentions by notifying each mentioned target about the message, without adding them to the conversation. Takes resolutionId values from mentions.pending.";
9934
+ readonly schema: z.ZodObject<{
9935
+ resolutionIds: z.ZodArray<z.ZodString>;
9936
+ }, z.core.$strip>;
9937
+ readonly routes: readonly ["mentionActionsExecute"];
9938
+ readonly consumes: {
9939
+ model: never[];
9940
+ code: never[];
9941
+ };
9942
+ readonly output: {
9943
+ mayBeLarge: false;
9944
+ boundBy: never[];
9945
+ };
9946
+ }, {
9947
+ readonly name: "mentions.add";
9948
+ readonly description: "Deliver unreached @mentions by adding each mentioned target to the conversation, so they see the message and what follows. Takes resolutionId values from mentions.pending.";
9949
+ readonly schema: z.ZodObject<{
9950
+ resolutionIds: z.ZodArray<z.ZodString>;
9951
+ }, z.core.$strip>;
9952
+ readonly routes: readonly ["mentionActionsExecute"];
9953
+ readonly consumes: {
9954
+ model: never[];
9955
+ code: never[];
9956
+ };
9957
+ readonly output: {
9958
+ mayBeLarge: false;
9959
+ boundBy: never[];
9960
+ };
9961
+ }, {
9962
+ readonly name: "mentions.delivery";
9963
+ readonly description: "Whether each @mention in a message you sent reached its target.";
9964
+ readonly schema: z.ZodObject<{
9965
+ messageId: z.ZodString;
9966
+ }, z.core.$strip>;
9967
+ readonly routes: readonly ["senderMentionDeliveries"];
9968
+ readonly consumes: {
9969
+ model: never[];
9970
+ code: never[];
9971
+ };
9972
+ readonly output: {
9973
+ mayBeLarge: false;
9974
+ boundBy: never[];
9975
+ };
9919
9976
  }, {
9920
9977
  readonly name: "mentions.execute";
9921
- readonly description: "Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.";
9978
+ readonly description: "Deprecated: use mentions.notify / mentions.add. Removed in the next minor release. Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.";
9922
9979
  readonly schema: z.ZodObject<{
9923
9980
  action: z.ZodEnum<{
9924
9981
  notify: "notify";
@@ -9935,9 +9992,10 @@ declare const OPERATION_DEFS: readonly [{
9935
9992
  mayBeLarge: false;
9936
9993
  boundBy: never[];
9937
9994
  };
9995
+ readonly deprecated: true;
9938
9996
  }, {
9939
9997
  readonly name: "mentions.deliveries";
9940
- readonly description: "Whether each @mention in a message you sent reached its target.";
9998
+ readonly description: "Deprecated: use mentions.delivery. Removed in the next minor release. Whether each @mention in a message you sent reached its target.";
9941
9999
  readonly schema: z.ZodObject<{
9942
10000
  messageId: z.ZodString;
9943
10001
  }, z.core.$strip>;
@@ -9950,6 +10008,7 @@ declare const OPERATION_DEFS: readonly [{
9950
10008
  mayBeLarge: false;
9951
10009
  boundBy: never[];
9952
10010
  };
10011
+ readonly deprecated: true;
9953
10012
  }, {
9954
10013
  readonly name: "actions.prepare";
9955
10014
  readonly description: "Post an action card (create a channel, add members, create an agent, or an integration step) for a human to confirm; the human who clicks it carries it out as themselves. When it is executed (or fails), the outcome arrives as a reply that @mentions you in the card's thread (or in the thread the card was posted in).";
@@ -10686,12 +10745,17 @@ interface Raft {
10686
10745
  pending(request?: {
10687
10746
  limit?: number;
10688
10747
  }): Promise<RaftOutcome<RaftPendingMentions, "pending" | "empty">>;
10689
- /** `notify` the target of an unreached mention, or `add` them to the conversation. */
10690
- execute(request: ExecuteMentionActionRequest): Promise<RaftOutcome<{
10691
- action: AgentMentionActionKind;
10692
- results: AgentMentionActionResult[];
10693
- }, "executed">>;
10694
- /** Per-target delivery outcome for a message you sent. */
10748
+ /** Notify the targets of unreached mentions about the message (`raft mention notify`). */
10749
+ notify(request: MentionResolutionIdsRequest): Promise<RaftMentionActionOutcome>;
10750
+ /** Add the targets of unreached mentions to the conversation (`raft mention add`). */
10751
+ add(request: MentionResolutionIdsRequest): Promise<RaftMentionActionOutcome>;
10752
+ /** Per-target delivery outcome for a message you sent (`raft mention delivery`). */
10753
+ delivery(request: {
10754
+ messageId: string;
10755
+ }): Promise<RaftOutcome<AgentApiSenderMentionDeliveriesResponse, "deliveries" | "empty">>;
10756
+ /** @deprecated Use `mentions.notify` / `mentions.add`; removed in 0.12.0. */
10757
+ execute(request: ExecuteMentionActionRequest): Promise<RaftMentionActionOutcome>;
10758
+ /** @deprecated Use `mentions.delivery`; removed in 0.12.0. */
10695
10759
  deliveries(request: {
10696
10760
  messageId: string;
10697
10761
  }): Promise<RaftOutcome<AgentApiSenderMentionDeliveriesResponse, "deliveries" | "empty">>;
@@ -10829,4 +10893,4 @@ export declare const commitInboxRequestSchema: z.ZodObject<{
10829
10893
  cursor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
10830
10894
  }, z.core.$strip>;
10831
10895
  //#endregion
10832
- export type { AmendTaskOutcome, AmendTaskRequest, AssignTaskRequest, BootstrapRaftCredentialOptions, CheckInboxOutcome, CheckInboxRequest, ClaimTasksOutcome, ClaimTasksRequest, ConvertMessageToTaskRequest, CreateRaftClientFromStoreOptions, CreateRaftClientOptions, CreateRaftOptions, CreateRaftRoutesOptions, CreateTasksRequest, DrainInboxRequest, ExecuteMentionActionRequest, ListInboxRequest, ListTasksRequest, ManualContext, PrepareActionCardRequest, Raft, RaftAckMode, RaftActionPrepareRequest, RaftActionPrepared, RaftApiError, RaftApiResult, RaftAppConfig, RaftAppConfigPatch, RaftAttachmentBytes, RaftAttachmentDownloadUrl, RaftAttachmentUploaded, RaftAvatarUpload, RaftChannelInfo, RaftChannelJoinClient, RaftChannelJoinClientResult, RaftChannelJoinError, RaftChannelJoinFailure, RaftChannelJoinOperation, RaftChannelJoinRequest, RaftChannelJoinResult, RaftChannelJoinSuccess, RaftChannelJoinTransportError, RaftChannelMuteState, RaftChannelRef, RaftClaimResult, RaftClaimRow, RaftClaimRowState, RaftClient, RaftClientError, RaftClientFailure, RaftClientResult, RaftClientSuccess, RaftClientThrottleOptions, RaftClientTransportRequest, RaftConsumption, RaftContextAgent, RaftContextData, RaftContextError, RaftContextResult, RaftContextServer, RaftCredentialErrorCode, RaftCredentialIdentity, RaftCredentialStore, RaftEvent, RaftEventAttachment, RaftEventExternalMessage, RaftEventsReceiveData, RaftEventsReceiveError, RaftEventsReceiveRequest, RaftEventsReceiveResult, RaftFailure, RaftHintStyle, RaftHistoryPage, RaftInboxBatch, RaftInboxCommitResult, RaftInboxConversation, RaftInboxDrainSummary, RaftInboxDrained, RaftInboxListing, RaftInboxNotice, RaftInterrupt, RaftInterruptCancel, RaftInterruptReason, RaftInterruptResume, RaftInterrupted, RaftInvokeCaller, RaftInvokeResult, RaftJsonSchema, RaftJsonSchemaType, RaftLatestReadThread, RaftManageClient, RaftMessage, RaftMessageAttachment, RaftMessageTask, RaftNextOperation, RaftNextStep, RaftNoticeFlag, RaftNoticeTarget, RaftOpError, RaftOpErrorCode, RaftOperationIdempotency, RaftOperationName, RaftOperationSpec, RaftOperationsDocument, RaftOutcome, RaftPendingMentions, RaftPreparedCard, RaftProfile, RaftProfileUpdate, RaftRouteAnnotations, RaftRouteInfo, RaftRouteKey, RaftRouteMeta, RaftRouteResult, RaftRouteRetryPolicy, RaftRoutes, RaftSdkConfigurationErrorCode, RaftSearchPage, RaftSenderType, RaftSent, RaftServerInfo, RaftServerProfile, RaftServerUpdate, RaftState, RaftStateContinuation, RaftStateSaveErrorHandler, RaftStateStore, RaftTaskBoard, RaftTaskStatus, RaftTasksCreated, RaftUserInfo, RaftUserRef, RaftWebhookStatus, ReactRequest, ReadHistoryRequest, ReadLatestReadThreadOptions, ReplyToRequest, SearchMessagesRequest, SeenAttestation, SeenFrontierSnapshot, SendMessageOutcome, SendMessageRequest, ServerInfoRequest, ServerInfoSection, StoredRaftCredential, TaskRef, UpdateTaskStatusOutcome, UpdateTaskStatusRequest, UploadAttachmentRequest, UserInfoRequest, VerifyNoticeInput, VerifyNoticeRejection, VerifyNoticeResult };
10896
+ export type { AmendTaskOutcome, AmendTaskRequest, AssignTaskRequest, BootstrapRaftCredentialOptions, CheckInboxOutcome, CheckInboxRequest, ClaimTasksOutcome, ClaimTasksRequest, ConvertMessageToTaskRequest, CreateRaftClientFromStoreOptions, CreateRaftClientOptions, CreateRaftOptions, CreateRaftRoutesOptions, CreateTasksRequest, DrainInboxRequest, ExecuteMentionActionRequest, ListInboxRequest, ListTasksRequest, ManualContext, MentionResolutionIdsRequest, PrepareActionCardRequest, Raft, RaftAckMode, RaftActionPrepareRequest, RaftActionPrepared, RaftApiError, RaftApiResult, RaftAppConfig, RaftAppConfigPatch, RaftAttachmentBytes, RaftAttachmentDownloadUrl, RaftAttachmentUploaded, RaftAvatarUpload, RaftChannelInfo, RaftChannelJoinClient, RaftChannelJoinClientResult, RaftChannelJoinError, RaftChannelJoinFailure, RaftChannelJoinOperation, RaftChannelJoinRequest, RaftChannelJoinResult, RaftChannelJoinSuccess, RaftChannelJoinTransportError, RaftChannelMuteState, RaftChannelRef, RaftClaimResult, RaftClaimRow, RaftClaimRowState, RaftClient, RaftClientError, RaftClientFailure, RaftClientResult, RaftClientSuccess, RaftClientThrottleOptions, RaftClientTransportRequest, RaftConsumption, RaftContextAgent, RaftContextData, RaftContextError, RaftContextResult, RaftContextServer, RaftCredentialErrorCode, RaftCredentialIdentity, RaftCredentialStore, RaftEvent, RaftEventAttachment, RaftEventExternalMessage, RaftEventsReceiveData, RaftEventsReceiveError, RaftEventsReceiveRequest, RaftEventsReceiveResult, RaftFailure, RaftHintStyle, RaftHistoryPage, RaftInboxBatch, RaftInboxCommitResult, RaftInboxConversation, RaftInboxDrainSummary, RaftInboxDrained, RaftInboxListing, RaftInboxNotice, RaftInterrupt, RaftInterruptCancel, RaftInterruptReason, RaftInterruptResume, RaftInterrupted, RaftInvokeCaller, RaftInvokeResult, RaftJsonSchema, RaftJsonSchemaType, RaftLatestReadThread, RaftManageClient, RaftMentionActionOutcome, RaftMessage, RaftMessageAttachment, RaftMessageTask, RaftNextOperation, RaftNextStep, RaftNoticeFlag, RaftNoticeTarget, RaftOpError, RaftOpErrorCode, RaftOperationIdempotency, RaftOperationName, RaftOperationSpec, RaftOperationsDocument, RaftOutcome, RaftPendingMentions, RaftPreparedCard, RaftProfile, RaftProfileUpdate, RaftRouteAnnotations, RaftRouteInfo, RaftRouteKey, RaftRouteMeta, RaftRouteResult, RaftRouteRetryPolicy, RaftRoutes, RaftSdkConfigurationErrorCode, RaftSearchPage, RaftSenderType, RaftSent, RaftServerInfo, RaftServerProfile, RaftServerUpdate, RaftState, RaftStateContinuation, RaftStateSaveErrorHandler, RaftStateStore, RaftTaskBoard, RaftTaskStatus, RaftTasksCreated, RaftUserInfo, RaftUserRef, RaftWebhookStatus, ReactRequest, ReadHistoryRequest, ReadLatestReadThreadOptions, ReplyToRequest, SearchMessagesRequest, SeenAttestation, SeenFrontierSnapshot, SendMessageOutcome, SendMessageRequest, ServerInfoRequest, ServerInfoSection, StoredRaftCredential, TaskRef, UpdateTaskStatusOutcome, UpdateTaskStatusRequest, UploadAttachmentRequest, UserInfoRequest, VerifyNoticeInput, VerifyNoticeRejection, VerifyNoticeResult };
package/operations.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "schema": "raft-sdk-operations.v1",
3
- "version": "4e70c891e417cd51",
3
+ "version": "16c7523f47f8b204",
4
4
  "operations": [
5
5
  {
6
6
  "name": "identity.whoami",
@@ -729,10 +729,118 @@
729
729
  ]
730
730
  }
731
731
  },
732
+ {
733
+ "name": "mentions.notify",
734
+ "toolName": "mentions_notify",
735
+ "description": "Deliver unreached @mentions by notifying each mentioned target about the message, without adding them to the conversation. Takes resolutionId values from mentions.pending.",
736
+ "inputSchema": {
737
+ "type": "object",
738
+ "properties": {
739
+ "resolutionIds": {
740
+ "type": "array",
741
+ "description": "resolutionId values from mentions.pending.",
742
+ "items": {
743
+ "type": "string"
744
+ }
745
+ }
746
+ },
747
+ "required": [
748
+ "resolutionIds"
749
+ ]
750
+ },
751
+ "sideEffect": "write",
752
+ "idempotency": {
753
+ "kind": "none"
754
+ },
755
+ "capability": [
756
+ "mentions"
757
+ ],
758
+ "modelOnly": false,
759
+ "mayInterrupt": false,
760
+ "consumes": {
761
+ "model": [],
762
+ "code": []
763
+ },
764
+ "output": {
765
+ "mayBeLarge": false,
766
+ "boundBy": []
767
+ }
768
+ },
769
+ {
770
+ "name": "mentions.add",
771
+ "toolName": "mentions_add",
772
+ "description": "Deliver unreached @mentions by adding each mentioned target to the conversation, so they see the message and what follows. Takes resolutionId values from mentions.pending.",
773
+ "inputSchema": {
774
+ "type": "object",
775
+ "properties": {
776
+ "resolutionIds": {
777
+ "type": "array",
778
+ "description": "resolutionId values from mentions.pending.",
779
+ "items": {
780
+ "type": "string"
781
+ }
782
+ }
783
+ },
784
+ "required": [
785
+ "resolutionIds"
786
+ ]
787
+ },
788
+ "sideEffect": "write",
789
+ "idempotency": {
790
+ "kind": "none"
791
+ },
792
+ "capability": [
793
+ "mentions"
794
+ ],
795
+ "modelOnly": false,
796
+ "mayInterrupt": false,
797
+ "consumes": {
798
+ "model": [],
799
+ "code": []
800
+ },
801
+ "output": {
802
+ "mayBeLarge": false,
803
+ "boundBy": []
804
+ }
805
+ },
806
+ {
807
+ "name": "mentions.delivery",
808
+ "toolName": "mentions_delivery",
809
+ "description": "Whether each @mention in a message you sent reached its target.",
810
+ "inputSchema": {
811
+ "type": "object",
812
+ "properties": {
813
+ "messageId": {
814
+ "type": "string",
815
+ "description": "Id of a message you sent."
816
+ }
817
+ },
818
+ "required": [
819
+ "messageId"
820
+ ]
821
+ },
822
+ "sideEffect": "read",
823
+ "idempotency": {
824
+ "kind": "natural"
825
+ },
826
+ "capability": [
827
+ "mentions"
828
+ ],
829
+ "modelOnly": false,
830
+ "mayInterrupt": false,
831
+ "consumes": {
832
+ "model": [],
833
+ "code": []
834
+ },
835
+ "output": {
836
+ "mayBeLarge": false,
837
+ "boundBy": []
838
+ }
839
+ },
732
840
  {
733
841
  "name": "mentions.execute",
734
842
  "toolName": "mentions_execute",
735
- "description": "Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
843
+ "description": "Deprecated: use mentions.notify / mentions.add. Removed in the next minor release. Deliver unreached @mentions: notify the mentioned target, or add them to the conversation.",
736
844
  "inputSchema": {
737
845
  "type": "object",
738
846
  "properties": {
@@ -773,12 +881,13 @@
773
881
  "output": {
774
882
  "mayBeLarge": false,
775
883
  "boundBy": []
776
- }
884
+ },
885
+ "deprecated": true
777
886
  },
778
887
  {
779
888
  "name": "mentions.deliveries",
780
889
  "toolName": "mentions_deliveries",
781
- "description": "Whether each @mention in a message you sent reached its target.",
890
+ "description": "Deprecated: use mentions.delivery. Removed in the next minor release. Whether each @mention in a message you sent reached its target.",
782
891
  "inputSchema": {
783
892
  "type": "object",
784
893
  "properties": {
@@ -807,7 +916,8 @@
807
916
  "output": {
808
917
  "mayBeLarge": false,
809
918
  "boundBy": []
810
- }
919
+ },
920
+ "deprecated": true
811
921
  },
812
922
  {
813
923
  "name": "actions.prepare",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botiverse/raft-sdk",
3
- "version": "0.10.0",
3
+ "version": "0.11.0",
4
4
  "license": "FSL-1.1-ALv2",
5
5
  "description": "Typed Raft Agent API client for external agents and bots.",
6
6
  "type": "module",