@xpert-ai/chatkit-types 0.0.5 → 0.0.7

package/dist/index.d.ts

@@ -231,6 +231,10 @@ export declare interface ChatkitMessage {
 }
 
 export declare type ChatKitOptions = {
+    /**
+     * ChatKit iframe URL for web component integrations.
+     */
+    frameUrl?: string;
     api: CustomApiConfig | HostedApiConfig;
     /**
      * Locale override for ChatKit UI. If not provided, the browser's locale
@@ -658,22 +662,22 @@ export declare type FileUploadStrategy = {
 };
 
 /**
- * 从 Playground 复制的配置中过滤出允许的配置项
+ * Filter out only the allowed options from a Playground config
  *
- * @param options - 从 playground 复制的完整配置
- * @returns 只包含白名单配置项的对象
+ * @param options - Full config copied from the playground
+ * @returns An object containing only whitelisted options
  *
  * @example
  * ```ts
- * // 从 playground 复制的配置
+ * // Config copied from the playground
  * const playgroundConfig = {
  *   theme: { colorScheme: 'light', radius: 'pill' },
- *   threadItemActions: { feedback: true }, // 会被过滤掉
+ *   threadItemActions: { feedback: true }, // will be filtered out
  *   startScreen: { greeting: 'Hello!' },
  * };
  *
  * const filtered = filterPlaygroundOptions(playgroundConfig);
- * // 结果: { theme: { colorScheme: 'light', radius: 'pill' }, startScreen: { greeting: 'Hello!' } }
+ * // Result: { theme: { colorScheme: 'light', radius: 'pill' }, startScreen: { greeting: 'Hello!' } }
  * ```
  */
 export declare function filterPlaygroundOptions<T extends Partial<ChatKitOptions>>(options: T): PlaygroundAllowedOptions;
@@ -850,28 +854,28 @@ export declare type Markdown = {
 };
 
 /**
- * 合并 Playground 配置与本地配置
- * Playground 配置会覆盖本地配置中的对应项（只限白名单内的配置）
+ * Merge Playground config with local config
+ * Playground config overrides matching items in local config (whitelist only)
  *
- * @param localOptions - 本地项目中的基础配置（可包含 onClientTool, header 等）
- * @param playgroundOptions - 从 playground 复制的配置
- * @returns 合并后的配置
+ * @param localOptions - Base config in the local project (can include onClientTool, header, etc.)
+ * @param playgroundOptions - Config copied from the playground
+ * @returns Merged config
  *
  * @example
  * ```ts
  * const localConfig = {
  *   api: { getClientSecret: async () => '...' },
- *   onClientTool: async () => { ... },  // 保留
- *   header: { enabled: true },           // 保留
+ *   onClientTool: async () => { ... },  // kept
+ *   header: { enabled: true },          // kept
  * };
  *
  * const playgroundConfig = {
  *   theme: { colorScheme: 'dark' },
- *   threadItemActions: { feedback: true }, // 被过滤
+ *   threadItemActions: { feedback: true }, // filtered out
  * };
  *
  * const merged = mergeWithPlaygroundOptions(localConfig, playgroundConfig);
- * // 结果: { api, onClientTool, header, theme }
+ * // Result: { api, onClientTool, header, theme }
  * ```
  */
 export declare function mergeWithPlaygroundOptions<T extends Partial<ChatKitOptions>>(localOptions: T, playgroundOptions: Partial<ChatKitOptions>): T & PlaygroundAllowedOptions;
@@ -903,11 +907,11 @@ export declare type ModelOption = {
 };
 
 /**
- * Playground 配置白名单 - 只允许这些配置项从 playground 复制过来生效
- * 过滤掉: locale, initialThread, header, history, threadItemActions, disclaimer, entities, widgets, onClientTool
+ * Playground configuration whitelist - only allow these options to take effect when copied from the playground
+ * Filters out: locale, initialThread, header, history, threadItemActions, disclaimer, entities, widgets, onClientTool
  */
 /**
- * 允许从 Playground 配置的选项类型
+ * Options allowed to be configured from Playground
  */
 export declare type PlaygroundAllowedOptions = {
     api?: ChatKitOptions['api'];