@wandox/sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,295 @@
+/**
+ * SDK 类型定义
+ */
+
+export interface WandoxConfig {
+  token: string
+  domain: string
+  companyCode?: string
+  theme?: 'light' | 'dark'
+  apiBase?: string
+  /** 初始化时写入 localStorage.sso_username */
+  username?: string
+  /** 初始化时写入 localStorage.sso_user_id */
+  userId?: string
+  /** userId 的 snake_case 别名，方便直接对接后端字段 */
+  user_id?: string
+}
+
+/**
+ * 剧本触发参数
+ */
+export interface PlaybookTriggerOptions {
+  playbookId?: string
+  playbook_id?: string
+  playbookParams?: Record<string, unknown>
+  playbook_params?: Record<string, unknown>
+  message?: string
+  agentId?: string
+  agent_id?: string
+  enableCustomerService?: boolean
+  enable_customer_service?: boolean
+}
+
+export interface MountAssistantAgent {
+  agent_id?: string
+  agent_code?: string
+  name?: string
+  children?: MountAssistantAgent[]
+  [key: string]: unknown
+}
+
+/**
+ * 挂载完整 Assistant 页面。
+ * - 无 agentId/agent_id：打开首页
+ * - 有 agentId/agent_id：进入指定智能体
+ * - 有 agentId/agent_id + playbookId/playbook_id + playbookParams/playbook_params：进入智能体并触发剧本
+ */
+export interface MountAssistantOptions {
+  agents?: MountAssistantAgent[]
+  agentId?: string
+  agent_id?: string
+  playbookId?: string
+  playbook_id?: string
+  playbookParams?: Record<string, unknown>
+  playbook_params?: Record<string, unknown>
+}
+
+/**
+ * SDK 独立剧本执行面板参数
+ * - playbookId: 要执行的剧本 ID
+ * - agentId: 执行剧本的智能体 ID，未传时取第一个可用智能体
+ * - playbookParams: 剧本所需的完整参数
+ */
+export interface PlaybookExecutionOptions {
+  playbookId?: string
+  playbook_id?: string
+  params?: Record<string, unknown>
+  playbookParams?: Record<string, unknown>
+  playbook_params?: Record<string, unknown>
+  message?: string
+  agentId?: string
+  agent_id?: string
+  sessionId?: string
+  session_id?: string
+  dataParams?: PlaybookParamsConfig
+  data_params?: PlaybookParamsConfig
+  executionParams?: string[]
+  execution_params?: string[]
+  defaultParams?: Record<string, unknown>
+  default_params?: Record<string, unknown>
+  paramSchema?: Record<string, PlaybookParamSchemaItem>
+  param_schema?: Record<string, PlaybookParamSchemaItem>
+  sdkConfig?: PlaybookActionSdkConfig
+  sdk_config?: PlaybookActionSdkConfig
+}
+
+export interface PlaybookParamSchemaItem {
+  type?: string
+  label?: string
+  description?: string
+  required?: boolean
+  source?: 'runtime' | 'default' | string
+  placeholder?: string
+  default?: unknown
+  defaultValue?: unknown
+  options?: Array<string | number | boolean | { label?: string; value?: unknown }>
+  file_templates?: Array<{ name?: string; path?: string }>
+  [key: string]: unknown
+}
+
+export interface PlaybookActionSdkConfig {
+  container?: string | HTMLElement
+  popup?: PlaybookExecutionPopupConfig
+}
+
+export interface PlaybookParamsConfig {
+  executionParams?: string[]
+  execution_params?: string[]
+  defaultParams?: Record<string, unknown>
+  default_params?: Record<string, unknown>
+  paramSchema?: Record<string, PlaybookParamSchemaItem>
+  param_schema?: Record<string, PlaybookParamSchemaItem>
+  sdkConfig?: PlaybookActionSdkConfig
+  sdk_config?: PlaybookActionSdkConfig
+}
+
+export type PlaybookExecutionPopupPlacement =
+  | 'bottomRight'
+  | 'bottomLeft'
+  | 'topRight'
+  | 'topLeft'
+  | 'center'
+  | 'bottom-right'
+  | 'bottom-left'
+  | 'top-right'
+  | 'top-left'
+
+export interface PlaybookExecutionPopupConfig {
+  placement?: PlaybookExecutionPopupPlacement
+  mask?: boolean
+  maskClosable?: boolean
+  minimizable?: boolean
+  width?: number | string
+  height?: number | string
+  zIndex?: number
+}
+
+export interface PlaybookExecutionHandle {
+  element: HTMLElement
+  abort: () => void
+  rerun: () => void
+  minimize: () => void
+  restore: () => void
+  destroy: () => void
+}
+
+export interface PlaybookActionBindOptions {
+  popup?: PlaybookExecutionPopupConfig
+}
+
+export interface PlaybookActionBindHandle {
+  root: Document | HTMLElement
+  destroy: () => void
+}
+
+export interface PageComponentRunOptions {
+  componentId?: string
+  component_id?: string
+  defaultParams?: Record<string, unknown>
+  default_params?: Record<string, unknown>
+  params?: Record<string, unknown>
+  message?: string
+  agentId?: string
+  agent_id?: string
+  playbookId?: string
+  playbook_id?: string
+  sdkConfig?: PlaybookActionSdkConfig
+  sdk_config?: PlaybookActionSdkConfig
+}
+
+/**
+ * 悬浮球注册配置
+ * - agentId: 固定智能体 ID，不填则默认选中列表第一个
+ * - playbookId: 剧本 ID，与 message 二选一，有其一则打开后自动触发
+ * - playbookParams: 默认额外携带参数（第三方使用）
+ * - message: 消息，与 playbookId 二选一，有其一则打开后自动触发
+ */
+export interface FloatingBallConfig {
+  agentId?: string
+  agent_id?: string
+  playbookId?: string
+  playbook_id?: string
+  playbookParams?: Record<string, unknown>
+  playbook_params?: Record<string, unknown>
+  message?: string
+}
+
+export interface DrawerOpenOptions {
+  playbookId?: string
+  playbook_id?: string
+  playbookParams?: Record<string, unknown>
+  playbook_params?: Record<string, unknown>
+  message?: string
+  agentId?: string
+  agent_id?: string
+  enableCustomerService?: boolean
+  enable_customer_service?: boolean
+}
+
+export interface Message {
+  id: string
+  role: 'user' | 'assistant'
+  content: string
+  timestamp: string
+  ui_payload?: unknown
+  outputs?: unknown[] | unknown
+  actions?: Array<{
+    action_id?: string
+    playbook_id?: string
+    display_name?: string
+    display_icon?: string | null
+    params?: Record<string, unknown>
+  }>
+}
+
+export interface SdkPlaybookInputField {
+  name: string
+  type: string
+  label: string
+  required?: boolean
+  file_type?: string
+  [key: string]: unknown
+}
+
+export interface SdkPlaybook {
+  playbook_id: string
+  name: string
+  description?: string
+  category_name?: string
+  type?: string
+  input_fields?: SdkPlaybookInputField[]
+  [key: string]: unknown
+}
+
+export interface SdkPlaybookGroup {
+  category_name: string
+  playbooks: SdkPlaybook[]
+  [key: string]: unknown
+}
+
+export interface SdkAgentDetail {
+  agent_id?: string
+  agent_code?: string
+  name?: string
+  playbooks?: SdkPlaybook[]
+  playbook_groups?: SdkPlaybookGroup[]
+  children?: Array<{ agent_id: string; name: string; [key: string]: unknown }>
+  [key: string]: unknown
+}
+
+export interface SdkAgent {
+  agent_id?: string
+  agent_code?: string
+  name?: string
+  description?: string
+  questions?: string[]
+  children?: SdkAgent[]
+  [key: string]: unknown
+}
+
+export interface SdkAgentListOptions {
+  page?: number
+  pageSize?: number
+  page_size?: number
+  status?: string
+  isAuth?: boolean
+  is_auth?: boolean
+}
+
+export interface WandoxInstance {
+  config: WandoxConfig
+  mountAssistant: (container: string | HTMLElement, options?: MountAssistantOptions | MountAssistantAgent[]) => HTMLElement
+  getAgents: (options?: SdkAgentListOptions) => Promise<SdkAgent[]>
+  getAgentDetail: (agentId: string) => Promise<SdkAgentDetail>
+  getAgentPlaybookGroups: (agentId: string) => Promise<SdkPlaybookGroup[]>
+  enableFloatingBall: () => void
+  registerFloatingBall: (config: FloatingBallConfig) => void
+  setFloatingBallConfig: (config: Partial<FloatingBallConfig>) => void
+  clearMessages: () => void
+  getMessages: () => Message[]
+  openDrawer: (options?: DrawerOpenOptions) => void
+  openDrawerOnly: (options?: DrawerOpenOptions) => void
+  openDrawerWithPlaybook: (options: PlaybookTriggerOptions) => void
+  mountPlaybookExecution: (container: string | HTMLElement, options?: PlaybookExecutionOptions) => PlaybookExecutionHandle
+  openPlaybookExecution: (options?: PlaybookExecutionOptions, config?: PlaybookExecutionPopupConfig) => PlaybookExecutionHandle
+  mountPlaybookRun: (container: string | HTMLElement, options?: PlaybookExecutionOptions) => PlaybookExecutionHandle
+  openPlaybookRun: (options?: PlaybookExecutionOptions, config?: PlaybookExecutionPopupConfig) => PlaybookExecutionHandle
+  mountPageComponentRun: (container: string | HTMLElement, options?: PageComponentRunOptions) => Promise<PlaybookExecutionHandle>
+  openPageComponentRun: (options?: PageComponentRunOptions, config?: PlaybookExecutionPopupConfig) => Promise<PlaybookExecutionHandle>
+  mountPlaybookActions: (container?: string | HTMLElement | Document, options?: PlaybookActionBindOptions) => PlaybookActionBindHandle
+  bindPlaybookActions: (container?: string | HTMLElement | Document, options?: PlaybookActionBindOptions) => PlaybookActionBindHandle
+  closeDrawer: () => void
+  showInspectionResults: (robotName?: string) => void
+  destroy: () => void
+}