Merge pull request #82 from openai/add-on-ready

[feature] Add on ready

Author: weedon-openai

.changeset/brave-dancers-add.md

@@ -0,0 +1,5 @@
+---
+'@openai/chatkit': patch
+---
+
+Added missing types for `chatkit.ready` event

.changeset/brown-hairs-reply.md

@@ -0,0 +1,5 @@
+---
+'@openai/chatkit-react': minor
+---
+
+Add `onReady` to `UseChatKitOptions`

packages/chatkit-react/src/ChatKit.tsx

@@ -69,6 +69,7 @@ export const ChatKit = React.forwardRef<OpenAIChatKit, ChatKitProps>(
             'chatkit.thread.change': 'onThreadChange',
             'chatkit.thread.load.start': 'onThreadLoadStart',
             'chatkit.thread.load.end': 'onThreadLoadEnd',
+            'chatkit.ready': 'onReady',
           };
 
           const eventNames = Object.keys(events) as (keyof ChatKitEvents)[];

packages/chatkit/types/index.d.ts

@@ -914,6 +914,9 @@ export interface OpenAIChatKit extends HTMLElement {
  * DOM events emitted by the `openai-chatkit` custom element.
  */
 export type ChatKitEvents = {
+  /** Emitted when the ChatKit frame has loaded. */
+  'chatkit.ready': CustomEvent<void>;
+
   /** Emitted when an error occurs. You should log these for monitoring and debugging. */
   'chatkit.error': CustomEvent<{ error: Error }>;