@rowger_go/chatu 0.1.3

package/dist/sdk/adapters/webhub.d.ts

@@ -0,0 +1,336 @@
+/******************************************************************
+ * Channel SDK - WebHub Adapter with Performance Degradation
+ *
+ * 支持从高性能到低性能的优雅退化:
+ * 1. WebSocket (最高性能) - 实时双向通信
+ * 2. Server-Sent Events (SSE) - 单向推送
+ * 3. HTTP Polling (最低性能) - 简单轮询
+ *
+ * URL 从 config.webhubUrl 配置中获取
+ *
+ * @see https://github.com/chatu-ai/openclaw-web-hub-channel
+ ******************************************************************/
+import { InboundMessage, OutboundMessage, SendResult, ConnectionConfig, ConnectionStatus, ChannelStats, MessageType, TargetType } from '../types/channel';
+import type { ConnectionAdapter, MessageCallback, StatusCallback, AdapterFactory } from '../types/adapters';
+/**
+ * 将 WebHub API 原始消息 JSON 映射为 Channel SDK InboundMessage 格式。
+ *
+ * 这是跨层映射的唯一位置 (SC-003):
+ *   - WebHub sender.name     → InboundMessage.sender.displayName
+ *   - WebHub sender.avatar   → InboundMessage.sender.avatarUrl
+ *   - WebHub authorDisplayName (旧字段兼容) → InboundMessage.sender.displayName
+ *   - WebHub authorId        (旧字段兼容) → InboundMessage.sender.id
+ *   - WebHub replyTo.id      → InboundMessage.replyTo.messageId
+ *   - WebHub replyTo.quoteText → InboundMessage.replyTo.quotedText
+ *   - WebHub content (string 或 {text}) → InboundMessage.content.text
+ *   - WebHub createdAt (string) → InboundMessage.timestamp (ms)
+ */
+export declare function mapRawToInboundMessage(raw: unknown): InboundMessage;
+/**
+ * 将 Channel SDK Media 对象映射为 WebHub API 可接受的媒体格式。
+ *
+ * Channel SDK Media 字段名称（thumbnailUrl / width / height）已与 WebHub 对齐；
+ * 此函数负责补充 WebHub 要求但 SDK 未提供的 filename 字段（从 url 推断），
+ * 是全局唯一的媒体映射位置（SC-003）。
+ *
+ * @param media - Channel SDK Media 对象
+ * @returns WebHub 媒体对象
+ */
+export declare function mapChannelSdkMedia(media: {
+    type: MessageType;
+    url: string;
+    mimeType?: string;
+    size?: number;
+    width?: number;
+    height?: number;
+    duration?: number;
+    thumbnailUrl?: string;
+}): {
+    type: MessageType;
+    url: string;
+    mimeType?: string;
+    size?: number;
+    width?: number;
+    height?: number;
+    duration?: number;
+    thumbnailUrl?: string;
+    filename?: string;
+};
+/**
+ * 性能模式
+ */
+export type PerformanceMode = 'websocket' | 'sse' | 'polling';
+/**
+ * WebHub 适配器配置 (继承 ConnectionConfig)
+ */
+export interface WebHubAdapterConfig extends ConnectionConfig {
+    /** 首选性能模式 (默认: websocket) */
+    preferredMode?: PerformanceMode;
+    /** SSE URL 路径 */
+    ssePath?: string;
+    /** 轮询间隔 (毫秒) */
+    pollInterval?: number;
+}
+/**
+ * WebHub 适配器
+ *
+ * 支持三种模式的优雅退化:
+ * - WebSocket: 实时双向通信
+ * - SSE: 单向推送 + HTTP 发送
+ * - Polling: HTTP 轮询
+ *
+ * URL 从 config.webhubUrl 配置中获取
+ *
+ * @example
+ * ```typescript
+ * // 配置时设置 webhubUrl
+ * const channel = new Channel({
+ *   config: {
+ *     channelId: 'wh_ch_xxx',
+ *     accessToken: 'token_xxx',
+ *     webhubUrl: 'http://localhost:3000',  // 从配置获取
+ *   }
+ * });
+ * ```
+ */
+export declare class WebHubAdapter implements ConnectionAdapter {
+    /** 配置 [Channel SDK 标准] */
+    config: WebHubAdapterConfig;
+    /** 当前状态 [Channel SDK 标准] */
+    private _status;
+    /** 实际使用的性能模式 */
+    private currentMode;
+    /** WebHub URL (从配置获取) */
+    private get webhubUrl();
+    /** 消息回调 [Channel SDK 标准] */
+    private messageCallbacks;
+    /** 状态回调 [Channel SDK 标准] */
+    private statusCallbacks;
+    /** 待确认消息 */
+    private pendingMessages;
+    /** 最后心跳时间 */
+    private lastHeartbeat;
+    /** 心跳定时器 */
+    private heartbeatTimer;
+    /** 轮询定时器 */
+    private pollTimer;
+    /** SSE EventSource */
+    private eventSource;
+    /** WebSocket 实例 */
+    private ws;
+    /** 统计 [Channel SDK 标准] */
+    private stats;
+    /**
+     * 创建 WebHub 适配器
+     */
+    constructor(config: WebHubAdapterConfig);
+    /**
+     * 获取当前状态 [Channel SDK 标准]
+     */
+    get status(): ConnectionStatus;
+    /**
+     * 获取实际使用的性能模式
+     */
+    get mode(): PerformanceMode;
+    /**
+     * 连接到 WebHub [Channel SDK 标准]
+     */
+    connect(): Promise<void>;
+    /**
+     * 获取完整的 WebHub URL
+     */
+    private getUrl;
+    /**
+     * 尝试 WebSocket 连接
+     */
+    private tryWebSocket;
+    /**
+     * 尝试 SSE 连接
+     */
+    private trySSE;
+    /**
+     * 清理 WebSocket
+     */
+    private cleanupWebSocket;
+    /**
+     * 清理 SSE
+     */
+    private cleanupSSE;
+    /**
+     * 注册频道
+     */
+    private register;
+    /**
+     * 连接到 Hub
+     */
+    private connectToHub;
+    /**
+     * 断开连接 [Channel SDK 标准]
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 发送消息 [Channel SDK 标准]
+     */
+    send(message: OutboundMessage): Promise<SendResult>;
+    /**
+     * US3 Cross-Channel Relay: forward a message from another OpenClaw channel
+     * to this ChatU WebHub channel so it appears in the frontend with a special
+     * source-channel badge.
+     *
+     * Calls POST /api/channel/cross-channel-messages authenticated via
+     * X-Access-Token (same token used for polling / outbound delivery).
+     *
+     * @param payload - Cross-channel message payload
+     * @returns Resolves with the stored message id, channelId and createdAt from the service
+     */
+    postCrossChannelMessage(payload: {
+        /** Originating channel id (lowercase, max 64 chars, /^[a-z0-9_-]{1,64}$/) */
+        sourceChannel: string;
+        /** 'inbound' = AI reply, 'outbound' = user message */
+        direction: 'inbound' | 'outbound';
+        /** Sender object — id is optional, name is required */
+        sender: {
+            id?: string;
+            name: string;
+        };
+        /** Text content of the message */
+        content: string;
+        /** Session key from the originating channel */
+        sessionKey: string;
+        /** Optional extra metadata forwarded as-is */
+        metadata?: Record<string, unknown>;
+    }): Promise<{
+        id: string;
+        channelId: string;
+        createdAt: string;
+    }>;
+    /**
+     * 订阅消息 [Channel SDK 标准]
+     */
+    onMessage(callback: MessageCallback): void;
+    /**
+     * 订阅状态变化 [Channel SDK 标准]
+     */
+    onStatusChange(callback: StatusCallback): void;
+    /**
+     * 获取统计 [Channel SDK 标准]
+     */
+    getStats(): Promise<ChannelStats>;
+    /**
+     * 发起 HTTP 请求
+     */
+    private request;
+    /**
+     * 启动轮询接收消息
+     */
+    private startPolling;
+    /**
+     * 停止轮询
+     */
+    private stopPolling;
+    /**
+     * 启动心跳
+     */
+    private startHeartbeat;
+    /**
+     * 停止心跳
+     */
+    private stopHeartbeat;
+    /**
+     * 通知消息
+     */
+    private notifyMessage;
+    /**
+     * 通知状态变化
+     */
+    private notifyStatus;
+}
+/**
+ * 性能模式配置
+ */
+export interface PerformanceModeConfig {
+    /** 首选模式 */
+    preferred: PerformanceMode;
+    /** WebSocket 配置 */
+    websocket?: {
+        /** 重试次数 */
+        maxRetries?: number;
+        /** 重试间隔 (毫秒) */
+        retryInterval?: number;
+    };
+    /** SSE 配置 */
+    sse?: {
+        /** 重试次数 */
+        maxRetries?: number;
+    };
+    /** Polling 配置 */
+    polling?: {
+        /** 轮询间隔 (毫秒) */
+        interval?: number;
+    };
+}
+/**
+ * WebHub 适配器工厂
+ */
+export declare class WebHubAdapterFactory implements AdapterFactory {
+    /** 性能模式配置 */
+    private modeConfig;
+    constructor(modeConfig?: PerformanceModeConfig);
+    /**
+     * 创建 WebHub 适配器 (从 config.webhubUrl 获取 URL)
+     */
+    createConnectionAdapter(config: ConnectionConfig): ConnectionAdapter;
+    /**
+     * 创建消息适配器
+     */
+    createMessageAdapter(): {
+        parseInbound: typeof mapRawToInboundMessage;
+        formatOutbound: (message: OutboundMessage) => unknown;
+        validate: (message: unknown) => boolean;
+        sanitize: (text: string) => string;
+    };
+    /**
+     * 创建心跳适配器
+     */
+    createHeartbeatAdapter(): {
+        send: () => Promise<boolean>;
+        handleResponse: () => void;
+        isTimeout: () => boolean;
+        getNextHeartbeatTime: () => number;
+    };
+    /**
+     * 创建认证适配器
+     */
+    createAuthAdapter(): {
+        getAuthHeaders: () => Record<string, string>;
+        validateResponse: (response: unknown) => boolean;
+        refreshToken: () => Promise<boolean>;
+    };
+    /**
+     * 创建能力适配器
+     */
+    createCapabilitiesAdapter(): {
+        getCapabilities: () => Promise<{
+            messageTypes: MessageType[];
+            targetTypes: TargetType[];
+            richFormats: ("markdown" | "html")[];
+            attachments: boolean;
+            reply: boolean;
+        }>;
+        hasCapability: () => boolean;
+    };
+    /**
+     * 创建日志适配器
+     */
+    createLoggerAdapter(): {
+        debug: (message: string, data?: unknown) => void;
+        info: (message: string, data?: unknown) => void;
+        warn: (message: string, data?: unknown) => void;
+        error: (message: string, error?: Error) => void;
+    };
+}
+/**
+ * 创建 WebHub 适配器工厂
+ */
+export declare function createWebHubFactory(modeConfig?: PerformanceModeConfig): WebHubAdapterFactory;
+//# sourceMappingURL=webhub.d.ts.map

package/dist/sdk/adapters/webhub.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhub.d.ts","sourceRoot":"","sources":["../../../src/sdk/adapters/webhub.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;oEAWoE;AAEpE,OAAO,EACL,cAAc,EACd,eAAe,EACf,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,UAAU,EAEX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,cAAc,EACf,MAAM,mBAAmB,CAAC;AAG3B;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAwEnE;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE;IACxC,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG;IACF,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAgBA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,KAAK,GAAG,SAAS,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,6BAA6B;IAC7B,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,iBAAiB;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAcD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,aAAc,YAAW,iBAAiB;IACrD,0BAA0B;IACnB,MAAM,EAAE,mBAAmB,CAAC;IAEnC,4BAA4B;IAC5B,OAAO,CAAC,OAAO,CAAoC;IAEnD,gBAAgB;IAChB,OAAO,CAAC,WAAW,CAA8B;IAEjD,yBAAyB;IACzB,OAAO,KAAK,SAAS,GAEpB;IAED,4BAA4B;IAC5B,OAAO,CAAC,gBAAgB,CAAmC;IAE3D,4BAA4B;IAC5B,OAAO,CAAC,eAAe,CAAkC;IAEzD,YAAY;IACZ,OAAO,CAAC,eAAe,CAAiD;IAExE,aAAa;IACb,OAAO,CAAC,aAAa,CAAa;IAElC,YAAY;IACZ,OAAO,CAAC,cAAc,CAA+C;IAErE,YAAY;IACZ,OAAO,CAAC,SAAS,CAA+C;IAEhE,sBAAsB;IACtB,OAAO,CAAC,WAAW,CAA4B;IAE/C,mBAAmB;IACnB,OAAO,CAAC,EAAE,CAA0B;IAEpC,0BAA0B;IAC1B,OAAO,CAAC,KAAK,CAKX;IAEF;;OAEG;gBACS,MAAM,EAAE,mBAAmB;IAYvC;;OAEG;IACH,IAAI,MAAM,IAAI,gBAAgB,CAE7B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,eAAe,CAE1B;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkD9B;;OAEG;IACH,OAAO,CAAC,MAAM;IAMd;;OAEG;YACW,YAAY;IAmD1B;;OAEG;YACW,MAAM;IA2CpB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,UAAU;IAOlB;;OAEG;YACW,QAAQ;IAatB;;OAEG;YACW,YAAY;IAU1B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBjC;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAiDzD;;;;;;;;;;OAUG;IACG,uBAAuB,CAAC,OAAO,EAAE;QACrC,6EAA6E;QAC7E,aAAa,EAAE,MAAM,CAAC;QACtB,sDAAsD;QACtD,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;QAClC,uDAAuD;QACvD,MAAM,EAAE;YAAE,EAAE,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QACtC,kCAAkC;QAClC,OAAO,EAAE,MAAM,CAAC;QAChB,+CAA+C;QAC/C,UAAU,EAAE,MAAM,CAAC;QACnB,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAgBjE;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAI1C;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAI9C;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,YAAY,CAAC;IAOvC;;OAEG;YACW,OAAO;IAsBrB;;OAEG;IACH,OAAO,CAAC,YAAY;IAsBpB;;OAEG;IACH,OAAO,CAAC,WAAW;IAOnB;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,OAAO,CAAC,aAAa;IAOrB;;OAEG;IACH,OAAO,CAAC,aAAa;IAIrB;;OAEG;IACH,OAAO,CAAC,YAAY;CAGrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,WAAW;IACX,SAAS,EAAE,eAAe,CAAC;IAC3B,mBAAmB;IACnB,SAAS,CAAC,EAAE;QACV,WAAW;QACX,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,gBAAgB;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,aAAa;IACb,GAAG,CAAC,EAAE;QACJ,WAAW;QACX,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,iBAAiB;IACjB,OAAO,CAAC,EAAE;QACR,gBAAgB;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,cAAc;IACzD,aAAa;IACb,OAAO,CAAC,UAAU,CAAwB;gBAE9B,UAAU,CAAC,EAAE,qBAAqB;IAS9C;;OAEG;IACH,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,iBAAiB;IAIpE;;OAEG;IACH,oBAAoB;;kCAGU,eAAe,KAAG,OAAO;4BAC/B,OAAO,KAAG,OAAO;yBACpB,MAAM,KAAG,MAAM;;IAIpC;;OAEG;IACH,sBAAsB;oBAEF,OAAO,CAAC,OAAO,CAAC;8BACZ,IAAI;yBACT,OAAO;oCACI,MAAM;;IAIpC;;OAEG;IACH,iBAAiB;8BAEO,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;qCACb,OAAO,KAAG,OAAO;4BACtB,OAAO,CAAC,OAAO,CAAC;;IAI5C;;OAEG;IACH,yBAAyB;;;;yBAKU,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE;;;;6BAInC,OAAO;;IAI9B;;OAEG;IACH,mBAAmB;yBAEE,MAAM,SAAS,OAAO,KAAG,IAAI;wBAC9B,MAAM,SAAS,OAAO,KAAG,IAAI;wBAC7B,MAAM,SAAS,OAAO,KAAG,IAAI;yBAC5B,MAAM,UAAU,KAAK,KAAG,IAAI;;CAGlD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,CAAC,EAAE,qBAAqB,GAAG,oBAAoB,CAE5F"}