ai 6.0.39 → 6.0.40

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 (21) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/index.d.mts +4 -0
  3. package/dist/index.d.ts +4 -0
  4. package/dist/index.js +349 -322
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +349 -322
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/internal/index.js +20 -1
  9. package/dist/internal/index.js.map +1 -1
  10. package/dist/internal/index.mjs +20 -1
  11. package/dist/internal/index.mjs.map +1 -1
  12. package/docs/07-reference/02-ai-sdk-ui/01-use-chat.mdx +7 -0
  13. package/package.json +1 -1
  14. package/src/agent/create-agent-ui-stream-response.test.ts +1 -1
  15. package/src/generate-text/__snapshots__/stream-text.test.ts.snap +52 -4
  16. package/src/generate-text/stream-text.test.ts +407 -7
  17. package/src/generate-text/stream-text.ts +1 -0
  18. package/src/types/usage.ts +24 -0
  19. package/src/ui/chat.ts +6 -0
  20. package/src/ui/process-ui-message-stream.ts +5 -0
  21. package/src/ui-message-stream/ui-message-chunks.ts +3 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # ai
2
2
 
3
+ ## 6.0.40
4
+
5
+ ### Patch Changes
6
+
7
+ - ab57783: Add usage information to onFinish callback in useChat
8
+
3
9
  ## 6.0.39
4
10
 
5
11
  ### Patch Changes
package/dist/index.d.mts CHANGED
@@ -1749,6 +1749,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1749
1749
  } | {
1750
1750
  type: "finish";
1751
1751
  finishReason?: "length" | "error" | "stop" | "content-filter" | "tool-calls" | "other" | undefined;
1752
+ usage?: LanguageModelUsage | undefined;
1752
1753
  messageMetadata?: unknown;
1753
1754
  } | {
1754
1755
  type: "abort";
@@ -1874,6 +1875,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
1874
1875
  } | {
1875
1876
  type: 'finish';
1876
1877
  finishReason?: FinishReason;
1878
+ usage?: LanguageModelUsage;
1877
1879
  messageMetadata?: METADATA;
1878
1880
  } | {
1879
1881
  type: 'abort';
@@ -3217,6 +3219,7 @@ type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<In
3217
3219
  * @param isDisconnect Indicates whether the request has been ended by a network error.
3218
3220
  * @param isError Indicates whether the request has been ended by an error.
3219
3221
  * @param finishReason The reason why the generation finished.
3222
+ * @param usage Token usage information for the response.
3220
3223
  */
3221
3224
  type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
3222
3225
  message: UI_MESSAGE;
@@ -3225,6 +3228,7 @@ type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
3225
3228
  isDisconnect: boolean;
3226
3229
  isError: boolean;
3227
3230
  finishReason?: FinishReason;
3231
+ usage?: LanguageModelUsage;
3228
3232
  }) => void;
3229
3233
  interface ChatInit<UI_MESSAGE extends UIMessage> {
3230
3234
  /**
package/dist/index.d.ts CHANGED
@@ -1749,6 +1749,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1749
1749
  } | {
1750
1750
  type: "finish";
1751
1751
  finishReason?: "length" | "error" | "stop" | "content-filter" | "tool-calls" | "other" | undefined;
1752
+ usage?: LanguageModelUsage | undefined;
1752
1753
  messageMetadata?: unknown;
1753
1754
  } | {
1754
1755
  type: "abort";
@@ -1874,6 +1875,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
1874
1875
  } | {
1875
1876
  type: 'finish';
1876
1877
  finishReason?: FinishReason;
1878
+ usage?: LanguageModelUsage;
1877
1879
  messageMetadata?: METADATA;
1878
1880
  } | {
1879
1881
  type: 'abort';
@@ -3217,6 +3219,7 @@ type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<In
3217
3219
  * @param isDisconnect Indicates whether the request has been ended by a network error.
3218
3220
  * @param isError Indicates whether the request has been ended by an error.
3219
3221
  * @param finishReason The reason why the generation finished.
3222
+ * @param usage Token usage information for the response.
3220
3223
  */
3221
3224
  type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
3222
3225
  message: UI_MESSAGE;
@@ -3225,6 +3228,7 @@ type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
3225
3228
  isDisconnect: boolean;
3226
3229
  isError: boolean;
3227
3230
  finishReason?: FinishReason;
3231
+ usage?: LanguageModelUsage;
3228
3232
  }) => void;
3229
3233
  interface ChatInit<UI_MESSAGE extends UIMessage> {
3230
3234
  /**