feat: allow runtimes to signal support for attachments (#769)

Yonom · Sep 7, 2024 · bdd3084 · bdd3084
1 parent a81b18f
commit bdd3084
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/happy-eagles-attend.md b/.changeset/happy-eagles-attend.md
@@ -0,0 +1,7 @@
+---
+"@assistant-ui/react-playground": patch
+"@assistant-ui/react-ai-sdk": patch
+"@assistant-ui/react": patch
+---
+
+feat: allow runtimes to signal support for attachments
diff --git a/apps/docs/components/docs/parameters/runtime.tsx b/apps/docs/components/docs/parameters/runtime.tsx
@@ -51,6 +51,20 @@ export const AssistantRuntimeProviderProps = () => {
                           description:
                             "Whether the runtime supports copying messages.",
                         },
+                        {
+                          name: "speak",
+                          type: "boolean",
+                          required: true,
+                          description:
+                            "Whether the runtime supports speaking messages.",
+                        },
+                        {
+                          name: "attachments",
+                          type: "boolean",
+                          required: true,
+                          description:
+                            "Whether the runtime supports attachments.",
+                        },
                       ],
                     },
                   ],

diff --git a/packages/react-playground/src/lib/playground-runtime.ts b/packages/react-playground/src/lib/playground-runtime.ts
@@ -91,6 +91,7 @@ const CAPABILITIES = Object.freeze({
   cancel: true,
   unstable_copy: false,
   speak: false,
+  attachments: false,
 });
 
 const EMPTY_BRANCHES: readonly string[] = Object.freeze([]);

diff --git a/packages/react/src/context/stores/Thread.ts b/packages/react/src/context/stores/Thread.ts
@@ -16,6 +16,7 @@ export type RuntimeCapabilities = {
   cancel: boolean;
   unstable_copy: boolean;
   speak: boolean;
+  attachments: boolean;
 };
 
 export const getThreadStateFromRuntime = (

diff --git a/packages/react/src/runtimes/external-store/ExternalStoreThreadRuntime.tsx b/packages/react/src/runtimes/external-store/ExternalStoreThreadRuntime.tsx
@@ -34,6 +34,7 @@ export class ExternalStoreThreadRuntime implements ReactThreadRuntime {
     cancel: false,
     unstable_copy: false,
     speak: false,
+    attachments: false,
   };
 
   public get capabilities() {
@@ -75,6 +76,7 @@ export class ExternalStoreThreadRuntime implements ReactThreadRuntime {
       cancel: this._store.onCancel !== undefined,
       unstable_copy: this._store.unstable_capabilities?.copy !== null,
       speak: this._store.onSpeak !== undefined,
+      attachments: false,
     };
 
     if (oldStore) {

diff --git a/packages/react/src/runtimes/local/LocalThreadRuntime.tsx b/packages/react/src/runtimes/local/LocalThreadRuntime.tsx
@@ -32,6 +32,7 @@ export class LocalThreadRuntime implements ThreadRuntime {
     cancel: true,
     unstable_copy: true,
     speak: false,
+    attachments: false,
   };
 
   public readonly threadId: string;