@xpert-ai/chatkit-types 0.0.14 → 0.0.16

package/dist/index.d.ts

@@ -179,6 +179,13 @@ export declare interface ChatEventEnvelope<T = unknown> {
     data: T;
 }
 
+export declare type ChatKitClientSecretObject = {
+    secret: string;
+    organizationId?: string;
+};
+
+export declare type ChatKitClientSecretResult = string | ChatKitClientSecretObject;
+
 export declare interface ChatKitElementEventMap {
     'chatkit.error': CustomEvent<{
         error: Error;
@@ -431,16 +438,36 @@ export declare type ChatKitOptions = {
     };
 };
 
-export declare type ChatKitRequestOptions = {
+export declare type ChatKitRequestContext = {
+    /**
+     * Request-scoped runtime env overrides.
+     * ChatKit forwards this field to LangGraph as `context.env`.
+     */
+    env?: Record<string, string>;
+    [key: string]: unknown;
+};
+
+export declare type ChatKitRequestOptions<TState = Record<string, any>, TContext extends ChatKitRequestContext = ChatKitRequestContext, TConfig extends Record<string, unknown> = Record<string, unknown>> = {
     /**
      * Custom graph state merged into every submitted message request.
      * The active user input is always written into `state.human.input`.
      */
-    state?: Record<string, any>;
+    state?: TState;
     /**
      * Additional stream context merged into every submitted message request.
+     *
+     * Request-scoped runtime env overrides should be placed in `context.env`.
+     * Extend `TContext` with any other request-scoped context fields you need.
+     */
+    context?: TContext;
+    /**
+     * Additional LangGraph run config merged into every submitted message request.
+     *
+     * This is forwarded to the hosted `runs.stream` request as `config`.
+     * Use this for LangGraph runtime controls such as tags or configurable values,
+     * not request-scoped env overrides.
      */
-    context?: Record<string, unknown>;
+    config?: TConfig;
 };
 
 export declare type ChatKitTheme = {
@@ -722,8 +749,10 @@ export declare type HeaderIcon = 'sidebar-left' | 'sidebar-right' | 'sidebar-ope
 declare type HostedApiConfig = {
     /**
      * Function to get a client token or refresh if the current token is expired.
+     * Returning an object also allows ChatKit to send the active organization id
+     * as the `organization-id` header on hosted API requests.
      */
-    getClientSecret: (currentClientSecret: string | null) => Promise<string>;
+    getClientSecret: (currentClientSecret: string | null) => Promise<ChatKitClientSecretResult>;
     /**
      * The base URL for the XpertAI platform hosted API. Used for accessing xpert agents
      * and other platform features.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpert-ai/chatkit-types",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "Type definitions for the ChatKit.",
   "sideEffects": false,
   "type": "module",