Ian/abort stream

.github/workflows/node.js.yml

@@ -15,10 +15,10 @@ jobs:
           cache-dependency-path: |
             example/package.json
             package.json
-          node-version: "19.x"
+          node-version: "20.x"
           cache: "npm"
       - run: node setup.cjs
       - run: npm test
       - run: npm run typecheck
       - run: npm run lint
-      - run: npx pkg-pr-new publish
+      - run: npx pkg-pr-new publish ./ ./playground

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.1.15 alpha
+
+- You can request that `syncStreams` return aborted streamed messages,
+  if you want to show those in your UI.
+- They will have `msg.streaming === false` if they were aborted.
+- Fix: stream deletion is idempotent and cleanup is canceled if it's already deleted.
+
 ## 0.1.14
 
 - Expose delete functions for messages & threads on the Agent class
@@ -39,7 +46,7 @@
 
 ## 0.1.9
 
-- You can finish a stream asynchronously and have it abort the streaming.
+- You can abort a stream asynchronously and have it stop writing deltas smoothly.
 - The timeout for streaming deltas with no sign of life has been
   increased to 10 minutes.
 - Delete stream deltas automatically 5 min after the stream finishes.

example/convex/_generated/api.d.ts

@@ -1615,6 +1615,12 @@ export declare const components: {
       >;
     };
     streams: {
+      abort: FunctionReference<
+        "mutation",
+        "internal",
+        { reason: string; streamId: string },
+        null
+      >;
       addDelta: FunctionReference<
         "mutation",
         "internal",
@@ -1770,13 +1776,18 @@ export declare const components: {
       list: FunctionReference<
         "query",
         "internal",
-        { threadId: string },
+        {
+          startOrder?: number;
+          statuses?: Array<"streaming" | "finished" | "aborted">;
+          threadId: string;
+        },
         Array<{
           agentName?: string;
           model?: string;
           order: number;
           provider?: string;
           providerOptions?: Record<string, Record<string, any>>;
+          status: "streaming" | "finished" | "aborted";
           stepOrder: number;
           streamId: string;
           userId?: string;

examples/chat-basic/convex/_generated/api.d.ts

@@ -1589,6 +1589,12 @@ export declare const components: {
       >;
     };
     streams: {
+      abort: FunctionReference<
+        "mutation",
+        "internal",
+        { reason: string; streamId: string },
+        null
+      >;
       addDelta: FunctionReference<
         "mutation",
         "internal",
@@ -1744,13 +1750,18 @@ export declare const components: {
       list: FunctionReference<
         "query",
         "internal",
-        { threadId: string },
+        {
+          startOrder?: number;
+          statuses?: Array<"streaming" | "finished" | "aborted">;
+          threadId: string;
+        },
         Array<{
           agentName?: string;
           model?: string;
           order: number;
           provider?: string;
           providerOptions?: Record<string, Record<string, any>>;
+          status: "streaming" | "finished" | "aborted";
           stepOrder: number;
           streamId: string;
           userId?: string;

examples/chat-streaming/convex/_generated/api.d.ts

@@ -1589,6 +1589,12 @@ export declare const components: {
       >;
     };
     streams: {
+      abort: FunctionReference<
+        "mutation",
+        "internal",
+        { reason: string; streamId: string },
+        null
+      >;
       addDelta: FunctionReference<
         "mutation",
         "internal",
@@ -1744,13 +1750,18 @@ export declare const components: {
       list: FunctionReference<
         "query",
         "internal",
-        { threadId: string },
+        {
+          startOrder?: number;
+          statuses?: Array<"streaming" | "finished" | "aborted">;
+          threadId: string;
+        },
         Array<{
           agentName?: string;
           model?: string;
           order: number;
           provider?: string;
           providerOptions?: Record<string, Record<string, any>>;
+          status: "streaming" | "finished" | "aborted";
           stepOrder: number;
           streamId: string;
           userId?: string;

examples/files-images/convex/_generated/api.d.ts

@@ -1591,6 +1591,12 @@ export declare const components: {
       >;
     };
     streams: {
+      abort: FunctionReference<
+        "mutation",
+        "internal",
+        { reason: string; streamId: string },
+        null
+      >;
       addDelta: FunctionReference<
         "mutation",
         "internal",
@@ -1746,13 +1752,18 @@ export declare const components: {
       list: FunctionReference<
         "query",
         "internal",
-        { threadId: string },
+        {
+          startOrder?: number;
+          statuses?: Array<"streaming" | "finished" | "aborted">;
+          threadId: string;
+        },
         Array<{
           agentName?: string;
           model?: string;
           order: number;
           provider?: string;
           providerOptions?: Record<string, Record<string, any>>;
+          status: "streaming" | "finished" | "aborted";
           stepOrder: number;
           streamId: string;
           userId?: string;

examples/rate-limiting/convex/_generated/api.d.ts

@@ -1589,6 +1589,12 @@ export declare const components: {
       >;
     };
     streams: {
+      abort: FunctionReference<
+        "mutation",
+        "internal",
+        { reason: string; streamId: string },
+        null
+      >;
       addDelta: FunctionReference<
         "mutation",
         "internal",
@@ -1744,13 +1750,18 @@ export declare const components: {
       list: FunctionReference<
         "query",
         "internal",
-        { threadId: string },
+        {
+          startOrder?: number;
+          statuses?: Array<"streaming" | "finished" | "aborted">;
+          threadId: string;
+        },
         Array<{
           agentName?: string;
           model?: string;
           order: number;
           provider?: string;
           providerOptions?: Record<string, Record<string, any>>;
+          status: "streaming" | "finished" | "aborted";
           stepOrder: number;
           streamId: string;
           userId?: string;