ai 7.0.85 → 7.0.87

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 (19) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/index.d.ts +11 -0
  3. package/dist/index.js +15 -5
  4. package/dist/index.js.map +1 -1
  5. package/dist/internal/index.d.ts +17 -1
  6. package/dist/internal/index.js +99 -84
  7. package/dist/internal/index.js.map +1 -1
  8. package/docs/03-agents/06-tool-approvals.mdx +6 -3
  9. package/docs/03-agents/07-workflow-agent.mdx +43 -0
  10. package/docs/03-ai-sdk-harnesses/02-harness-agent.mdx +4 -0
  11. package/docs/04-ai-sdk-ui/03-chatbot-tool-usage.mdx +7 -0
  12. package/docs/04-ai-sdk-ui/50-stream-protocol.mdx +6 -2
  13. package/docs/07-reference/01-ai-sdk-core/31-ui-message.mdx +35 -0
  14. package/docs/07-reference/04-ai-sdk-workflow/01-workflow-agent.mdx +25 -0
  15. package/package.json +5 -5
  16. package/src/ui/process-ui-message-stream.ts +4 -7
  17. package/src/ui/ui-messages.ts +10 -0
  18. package/src/ui/validate-ui-messages.ts +10 -0
  19. package/src/ui-message-stream/ui-message-chunks.ts +2 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # ai
2
2
 
3
+ ## 7.0.87
4
+
5
+ ### Patch Changes
6
+
7
+ - 850d863: fix(ai): preserve approval descriptors in UI message streams
8
+
9
+ ## 7.0.86
10
+
11
+ ### Patch Changes
12
+
13
+ - 11109ae: feat(ai): support signed tool approvals in WorkflowAgent
14
+ - Updated dependencies [1329d5a]
15
+ - @ai-sdk/gateway@4.0.70
16
+
3
17
  ## 7.0.85
4
18
 
5
19
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -2055,6 +2055,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
2055
2055
  approval: {
2056
2056
  id: string;
2057
2057
  approved?: never;
2058
+ descriptor?: unknown;
2058
2059
  requestReason?: string;
2059
2060
  reason?: never;
2060
2061
  isAutomatic?: boolean;
@@ -2069,6 +2070,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
2069
2070
  approval: {
2070
2071
  id: string;
2071
2072
  approved: boolean;
2073
+ descriptor?: unknown;
2072
2074
  requestReason?: string;
2073
2075
  reason?: string;
2074
2076
  isAutomatic?: boolean;
@@ -2085,6 +2087,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
2085
2087
  approval?: {
2086
2088
  id: string;
2087
2089
  approved: true;
2090
+ descriptor?: unknown;
2088
2091
  requestReason?: string;
2089
2092
  reason?: string;
2090
2093
  isAutomatic?: boolean;
@@ -2101,6 +2104,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
2101
2104
  approval?: {
2102
2105
  id: string;
2103
2106
  approved: true;
2107
+ descriptor?: unknown;
2104
2108
  requestReason?: string;
2105
2109
  reason?: string;
2106
2110
  isAutomatic?: boolean;
@@ -2115,6 +2119,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
2115
2119
  approval: {
2116
2120
  id: string;
2117
2121
  approved: false;
2122
+ descriptor?: unknown;
2118
2123
  requestReason?: string;
2119
2124
  reason?: string;
2120
2125
  isAutomatic?: boolean;
@@ -2165,6 +2170,7 @@ type DynamicToolUIPart = {
2165
2170
  approval: {
2166
2171
  id: string;
2167
2172
  approved?: never;
2173
+ descriptor?: unknown;
2168
2174
  requestReason?: string;
2169
2175
  reason?: never;
2170
2176
  isAutomatic?: boolean;
@@ -2179,6 +2185,7 @@ type DynamicToolUIPart = {
2179
2185
  approval: {
2180
2186
  id: string;
2181
2187
  approved: boolean;
2188
+ descriptor?: unknown;
2182
2189
  requestReason?: string;
2183
2190
  reason?: string;
2184
2191
  isAutomatic?: boolean;
@@ -2195,6 +2202,7 @@ type DynamicToolUIPart = {
2195
2202
  approval?: {
2196
2203
  id: string;
2197
2204
  approved: true;
2205
+ descriptor?: unknown;
2198
2206
  requestReason?: string;
2199
2207
  reason?: string;
2200
2208
  isAutomatic?: boolean;
@@ -2210,6 +2218,7 @@ type DynamicToolUIPart = {
2210
2218
  approval?: {
2211
2219
  id: string;
2212
2220
  approved: true;
2221
+ descriptor?: unknown;
2213
2222
  requestReason?: string;
2214
2223
  reason?: string;
2215
2224
  isAutomatic?: boolean;
@@ -2224,6 +2233,7 @@ type DynamicToolUIPart = {
2224
2233
  approval: {
2225
2234
  id: string;
2226
2235
  approved: false;
2236
+ descriptor?: unknown;
2227
2237
  requestReason?: string;
2228
2238
  reason?: string;
2229
2239
  isAutomatic?: boolean;
@@ -2367,6 +2377,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2367
2377
  type: 'tool-approval-request';
2368
2378
  approvalId: string;
2369
2379
  toolCallId: string;
2380
+ approvalDescriptor?: unknown;
2370
2381
  reason?: string;
2371
2382
  isAutomatic?: boolean;
2372
2383
  signature?: string;
package/dist/index.js CHANGED
@@ -1146,7 +1146,7 @@ import {
1146
1146
  } from "@ai-sdk/provider-utils";
1147
1147
 
1148
1148
  // src/version.ts
1149
- var VERSION = true ? "7.0.85" : "0.0.0-test";
1149
+ var VERSION = true ? "7.0.87" : "0.0.0-test";
1150
1150
 
1151
1151
  // src/util/download/download.ts
1152
1152
  var download = async ({
@@ -6653,6 +6653,7 @@ var uiMessageChunkSchema = lazySchema(
6653
6653
  type: z.literal("tool-approval-request"),
6654
6654
  approvalId: z.string(),
6655
6655
  toolCallId: z.string(),
6656
+ approvalDescriptor: z.unknown().optional(),
6656
6657
  reason: z.string().optional(),
6657
6658
  isAutomatic: z.boolean().optional(),
6658
6659
  signature: z.string().optional()
@@ -7289,6 +7290,7 @@ function processUIMessageStream({
7289
7290
  toolInvocation.state = "approval-requested";
7290
7291
  toolInvocation.approval = {
7291
7292
  id: chunk.approvalId,
7293
+ ...chunk.approvalDescriptor != null ? { descriptor: chunk.approvalDescriptor } : {},
7292
7294
  ...chunk.reason != null ? { requestReason: chunk.reason } : {},
7293
7295
  ...chunk.isAutomatic === true ? { isAutomatic: true } : {},
7294
7296
  ...chunk.signature != null ? { signature: chunk.signature } : {}
@@ -7303,12 +7305,10 @@ function processUIMessageStream({
7303
7305
  const approval = toolInvocation.approval == null ? { id: chunk.approvalId } : toolInvocation.approval;
7304
7306
  toolInvocation.state = "approval-responded";
7305
7307
  toolInvocation.approval = {
7308
+ ...approval,
7306
7309
  id: chunk.approvalId,
7307
7310
  approved: chunk.approved,
7308
- ...approval.requestReason != null ? { requestReason: approval.requestReason } : {},
7309
- ...chunk.reason != null ? { reason: chunk.reason } : {},
7310
- ...approval.isAutomatic === true ? { isAutomatic: true } : {},
7311
- ...approval.signature != null ? { signature: approval.signature } : {}
7311
+ ...chunk.reason != null ? { reason: chunk.reason } : {}
7312
7312
  };
7313
7313
  if (chunk.providerExecuted != null) {
7314
7314
  toolInvocation.providerExecuted = chunk.providerExecuted;
@@ -11556,6 +11556,7 @@ var uiMessagesSchema = lazySchema2(
11556
11556
  approval: z.object({
11557
11557
  id: z.string(),
11558
11558
  approved: z.never().optional(),
11559
+ descriptor: z.unknown().optional(),
11559
11560
  requestReason: z.string().optional(),
11560
11561
  reason: z.never().optional(),
11561
11562
  isAutomatic: z.boolean().optional(),
@@ -11576,6 +11577,7 @@ var uiMessagesSchema = lazySchema2(
11576
11577
  approval: z.object({
11577
11578
  id: z.string(),
11578
11579
  approved: z.boolean(),
11580
+ descriptor: z.unknown().optional(),
11579
11581
  requestReason: z.string().optional(),
11580
11582
  reason: z.string().optional(),
11581
11583
  isAutomatic: z.boolean().optional(),
@@ -11598,6 +11600,7 @@ var uiMessagesSchema = lazySchema2(
11598
11600
  approval: z.object({
11599
11601
  id: z.string(),
11600
11602
  approved: z.literal(true),
11603
+ descriptor: z.unknown().optional(),
11601
11604
  requestReason: z.string().optional(),
11602
11605
  reason: z.string().optional(),
11603
11606
  isAutomatic: z.boolean().optional(),
@@ -11620,6 +11623,7 @@ var uiMessagesSchema = lazySchema2(
11620
11623
  approval: z.object({
11621
11624
  id: z.string(),
11622
11625
  approved: z.literal(true),
11626
+ descriptor: z.unknown().optional(),
11623
11627
  requestReason: z.string().optional(),
11624
11628
  reason: z.string().optional(),
11625
11629
  isAutomatic: z.boolean().optional(),
@@ -11640,6 +11644,7 @@ var uiMessagesSchema = lazySchema2(
11640
11644
  approval: z.object({
11641
11645
  id: z.string(),
11642
11646
  approved: z.literal(false),
11647
+ descriptor: z.unknown().optional(),
11643
11648
  requestReason: z.string().optional(),
11644
11649
  reason: z.string().optional(),
11645
11650
  isAutomatic: z.boolean().optional(),
@@ -11683,6 +11688,7 @@ var uiMessagesSchema = lazySchema2(
11683
11688
  approval: z.object({
11684
11689
  id: z.string(),
11685
11690
  approved: z.never().optional(),
11691
+ descriptor: z.unknown().optional(),
11686
11692
  requestReason: z.string().optional(),
11687
11693
  reason: z.never().optional(),
11688
11694
  isAutomatic: z.boolean().optional(),
@@ -11702,6 +11708,7 @@ var uiMessagesSchema = lazySchema2(
11702
11708
  approval: z.object({
11703
11709
  id: z.string(),
11704
11710
  approved: z.boolean(),
11711
+ descriptor: z.unknown().optional(),
11705
11712
  requestReason: z.string().optional(),
11706
11713
  reason: z.string().optional(),
11707
11714
  isAutomatic: z.boolean().optional(),
@@ -11723,6 +11730,7 @@ var uiMessagesSchema = lazySchema2(
11723
11730
  approval: z.object({
11724
11731
  id: z.string(),
11725
11732
  approved: z.literal(true),
11733
+ descriptor: z.unknown().optional(),
11726
11734
  requestReason: z.string().optional(),
11727
11735
  reason: z.string().optional(),
11728
11736
  isAutomatic: z.boolean().optional(),
@@ -11744,6 +11752,7 @@ var uiMessagesSchema = lazySchema2(
11744
11752
  approval: z.object({
11745
11753
  id: z.string(),
11746
11754
  approved: z.literal(true),
11755
+ descriptor: z.unknown().optional(),
11747
11756
  requestReason: z.string().optional(),
11748
11757
  reason: z.string().optional(),
11749
11758
  isAutomatic: z.boolean().optional(),
@@ -11763,6 +11772,7 @@ var uiMessagesSchema = lazySchema2(
11763
11772
  approval: z.object({
11764
11773
  id: z.string(),
11765
11774
  approved: z.literal(false),
11775
+ descriptor: z.unknown().optional(),
11766
11776
  requestReason: z.string().optional(),
11767
11777
  reason: z.string().optional(),
11768
11778
  isAutomatic: z.boolean().optional(),