Merge pull request #110 from openai/add-client-side-effect-handler

client effect event

Author: jiwon-oai

packages/chatkit-react/src/ChatKit.tsx

@@ -28,6 +28,7 @@ const EVENT_HANDLER_MAP: {
   'chatkit.thread.load.start': 'onThreadLoadStart',
   'chatkit.thread.load.end': 'onThreadLoadEnd',
   'chatkit.ready': 'onReady',
+  'chatkit.effect': 'onEffect',
 };
 
 const EVENT_NAMES = Object.keys(EVENT_HANDLER_MAP) as (keyof ChatKitEvents)[];

packages/chatkit/types/index.d.ts

@@ -928,6 +928,12 @@ export type ChatKitEvents = {
   /** Emitted when an error occurs. You should log these for monitoring and debugging. */
   'chatkit.error': CustomEvent<{ error: Error }>;
 
+  /** Emitted when a fire-and-forget client effect is triggered. */
+  'chatkit.effect': CustomEvent<{
+    name: string;
+    data?: Record<string, unknown>;
+  }>;
+
   /** Emitted when the assistant begins sending a response. */
   'chatkit.response.start': CustomEvent<void>;