k2-im 0.1.30 → 0.1.32

package/dist/browser.js

@@ -1 +1 @@
-export{B as createLazyBrowserApiProtocolClient}from'./chunk-GHZUH7RB.js';import'./chunk-4KPJTXQN.js';import'./chunk-WOT6VMZA.js';
+export{B as createLazyBrowserApiProtocolClient}from'./chunk-GAAHNTJM.js';import'./chunk-QQ23QYWK.js';import'./chunk-WOT6VMZA.js';

package/dist/chat-kit-pinia.d.ts

@@ -4,8 +4,8 @@ import { Pinia, Store } from 'pinia';
 /** 媒体业务类型：实现据此选对象存储逻辑桶；sticker 对应 app-sticker。 */
 type MediaKind = 'image' | 'video' | 'voice' | 'file' | 'sticker';
 
-/** 会话类型。P0 只用 direct / group。 */
-type ConversationType = 'direct' | 'group' | 'channel' | 'supergroup';
+/** 会话类型。P0 只用 direct / group；`robot` 是独立私聊 sibling，不得并入 direct。 */
+type ConversationType = 'direct' | 'group' | 'channel' | 'supergroup' | 'robot';
 /**
  * 会话复合身份；`conversationId` 只在对应 `conversationType` 的领域内唯一。
  *
@@ -42,8 +42,8 @@ interface ConversationDraft$1 {
     attachments: readonly [];
     updatedAt: number;
 }
-/** 消息内容类型。sticker=表情/贴图（BMessage contentType=7）；call=单聊通话记录（contentType=10）；transfer=转账（contentType=16）；robot=机器人卡片（contentType=18）；miniProgram=小程序分享卡（contentType=22）；redPacket=红包卡（contentType=25）；game=小游戏（contentType=27）；未知 wire 正文统一归一为 unknown。 */
-type MessageContentType = 'text' | 'system' | 'image' | 'video' | 'voice' | 'file' | 'sticker' | 'contact' | 'miniProgram' | 'game' | 'transfer' | 'call' | 'redPacket' | 'mediaAlbum' | 'robot' | 'unknown';
+/** 消息内容类型。sticker=表情/贴图（BMessage contentType=7）；call=单聊通话记录（contentType=10）；transfer=转账（contentType=16）；gift=礼品/刮刮卡（contentType=17）；robot=机器人卡片（contentType=18）；miniProgram=小程序分享卡（contentType=22）；redPacket=红包卡（contentType=25）；game=小游戏（contentType=27）；未知 wire 正文统一归一为 unknown。 */
+type MessageContentType = 'text' | 'system' | 'image' | 'video' | 'voice' | 'file' | 'sticker' | 'contact' | 'miniProgram' | 'game' | 'transfer' | 'gift' | 'call' | 'redPacket' | 'mediaAlbum' | 'robot' | 'unknown';
 /**
  * 发送态（客户端态）：消息从本地创建到服务端确认的生命周期。
  * `uploading` 仅媒体消息使用：文件上传阶段（uploading→pending→sending→sent）；
@@ -112,6 +112,8 @@ type LastMessageSummary = {
     gameType: ImGameType;
 } | {
     kind: 'transfer';
+} | {
+    kind: 'gift';
 } | {
     kind: 'call';
     callKind: ImCallKind;
@@ -311,13 +313,14 @@ type ImGameBody = {
  * - `default`：0，普通可点卡片
  * - `board-game`：1，棋牌样式且不可点
  * - `board-game-link`：2，棋牌样式且可点
+ * - `game-preview`：3，气泡内嵌游戏预览 WebView
  * - `unknown`：必须同时保留 `rawShowType`，不得猜成可点/不可点
  */
-type ImMiniProgramShowType = 'default' | 'board-game' | 'board-game-link' | 'unknown';
+type ImMiniProgramShowType = 'default' | 'board-game' | 'board-game-link' | 'game-preview' | 'unknown';
 /**
  * 小程序分享卡片正文（contentType==='miniProgram'，协议 BMessage.contentType=22）。
  *
- * @remarks 字段来自 iOS `IMMiniProgramMessageBody` / proto 61-67、80-82、90-93。
+ * @remarks 字段来自 iOS `IMMiniProgramMessageBody` / proto 61-67、80-82、90-96。
  * `currencySource` 对应 proto field 90（无 miniProgram 前缀）：`xj` 现金公司、`xy` 信用公司。
  * `subGameName` 保持服务端 JSON 字符串，不在 Core 解析语种表。打开小程序与 X 币/信用 ID 属于宿主，不进本 DTO。
  */
@@ -341,6 +344,12 @@ interface ImMiniProgramBody {
     gamePath?: string;
     /** 多语言子游戏名 JSON 字符串，例如 `{"ch":"...","en":"..."}`。 */
     subGameName?: string;
+    /** 游戏预览页地址（BMessage.miniProgramGamePreviewUrl，showType=3）。 */
+    gamePreviewUrl?: string;
+    /** 游戏预览设计宽（BMessage.miniProgramGamePreviewWidth）。 */
+    gamePreviewWidth?: number;
+    /** 游戏预览设计高（BMessage.miniProgramGamePreviewHeight）。 */
+    gamePreviewHeight?: number;
 }
 /**
  * 机器人卡片文本模块（wire `section`）。
@@ -419,6 +428,40 @@ interface ImTransferBody {
     coinName?: string;
     coinIcon?: string;
 }
+/** 礼品类型。协议注释为刮刮卡 1 / 奖品 2；Android 当前会把 WelfareGiftType=0 写进消息，入站必须接受 0。 */
+type ImGiftType = 0 | 1 | 2;
+/** 礼品状态。0 待领取 / 1 已收款 / 2 已退还 / 3 已过期（对齐 iOS IMGiftMessageBody）。 */
+type ImGiftStatus = 0 | 1 | 2 | 3;
+/** 礼品会话类型。1 个人 / 2 群（BMessage.sessionType）。 */
+type ImGiftSessionType = 1 | 2;
+/**
+ * 礼品卡片正文（contentType==='gift'，协议 BMessage.contentType=17）。
+ *
+ * @remarks 字段来自 iOS `IMGiftMessageBody` / proto 51-59，并复用转账字段族的 fromUid/toUid/serialNumber。
+ * 赠卡 HTTP 属于宿主；本 DTO 只承载会话卡片。H5 出站刮刮卡写 giftType=1。
+ */
+interface ImGiftBody {
+    fromUid: string;
+    toUid: string;
+    fromUserName?: string;
+    toUserName?: string;
+    giftType: ImGiftType;
+    giftName: string;
+    giftIcon?: string;
+    explain?: string;
+    state: ImGiftStatus;
+    serialNumber: string;
+    sessionType: ImGiftSessionType;
+    initiateTime: number;
+    /** 单张金额的十进制字符串；0 或缺省表示未带金额。 */
+    amount?: string;
+    receiveTime?: number;
+    returnTime?: number;
+    isRead?: boolean;
+    zhangCount?: string;
+    benCount?: string;
+    fissionNumber?: string;
+}
 /** 领域通话媒体类型；已从各端 wire 0/1 对调口径归一，宿主禁止再读 raw callType。 */
 type ImCallKind = 'audio' | 'video';
 /**
@@ -577,6 +620,8 @@ interface ImMessageBody {
     game?: ImGameBody;
     /** contentType==='transfer' 时的转账卡片。 */
     transfer?: ImTransferBody;
+    /** contentType==='gift' 时的礼品/刮刮卡卡片。 */
+    gift?: ImGiftBody;
     /** contentType==='call' 时的单聊通话记录。 */
     call?: ImCallRecordBody;
     /** contentType==='redPacket' 时的红包卡片。 */
@@ -965,7 +1010,7 @@ interface OutboxMessage {
     resumePolicy?: 'automatic' | 'manual';
 }
 /** 当前 SDK 已注册发送策略、因此可作为转发目标的会话类型；supergroup 未注册，继续在编译期排除。 */
-type ForwardTargetConversationType = Extract<ConversationType, 'direct' | 'group' | 'channel'>;
+type ForwardTargetConversationType = Extract<ConversationType, 'direct' | 'group' | 'channel' | 'robot'>;
 /** 转发目标会话；运行时仍由 SendStrategyRegistry 复核，避免类型声明与实际装配漂移。 */
 interface ForwardTarget {
     conversationId: string;
@@ -1857,8 +1902,11 @@ interface ImSessionFavoritePort {
  * 消息、Reaction 与分页边界必须整页原子保存，只有前台实际消费时才进入正常消息流程。
  */
 interface ImRecentHistoryPage {
-    /** 缓存记录格式版本；不认识的版本不能当作有效页使用。 */
-    version: 1;
+    /**
+     * 缓存记录格式版本；不认识的版本不能当作有效页使用。
+     * v2：小程序 showType=3 / proto 94-96 进入领域正文，旧页必须重新拉网解析。
+     */
+    version: 2;
     /** 当前账号内的精确 GROUP/CHANNEL 会话；direct 没有此远端最近页能力。 */
     conversation: ConversationRef<'group' | 'channel'>;
     /** 成功获取页面的毫秒时间，用于保留期限和按获取时间淘汰。 */
@@ -2242,6 +2290,11 @@ type ImEvent = {
     type: 'session:updated';
     session: ImSession;
     conversation: ConversationRef;
+}
+/** 已打开聊天的资料或权限变化，不代表新增会话列表项。 */
+ | {
+    type: 'conversation-context:updated';
+    conversation: ConversationRef;
 } | {
     type: 'session:removed';
     conversationId: string;
@@ -3069,6 +3122,10 @@ interface MiniProgramMessageOptions {
 interface TransferMessageOptions {
     replyToMessageId?: string;
 }
+/** 礼品卡片发送选项；正文必须已含福利中心赠送后的流水号与卡面。 */
+interface GiftMessageOptions {
+    replyToMessageId?: string;
+}
 /**
  * 媒体合集里的一项：一张图片或一个视频。
  *
@@ -3489,7 +3546,7 @@ interface ConversationPrefetchOptions {
  * skipped 表示当前类型、权限、存储或预算不允许预取；失败不改变正常打开会话的行为。
  */
 interface ConversationPrefetchResult {
-    ref: ConversationRef<'direct' | 'group' | 'channel'>;
+    ref: ConversationRef<'direct' | 'group' | 'channel' | 'robot'>;
     status: 'ready' | 'skipped' | 'failed' | 'cancelled';
     reason?: 'unsupported' | 'unavailable' | 'storage-unavailable' | 'budget' | 'page-too-large' | 'decrypt-failed' | 'invalidated' | 'cancelled';
     error?: ImSdkErrorShape;
@@ -3532,7 +3589,7 @@ interface ConversationDraftApi {
     subscribe: (listener: (draft: ConversationDraft | null) => void) => () => void;
 }
 /**
- * 当前账号的跨组件草稿 API；所有动作都要求 direct/GROUP/CHANNEL 精确复合身份。
+ * 当前账号的跨组件草稿 API；所有动作都要求 direct / GROUP / CHANNEL / robot 精确复合身份。
  *
  * @example
  * ```ts
@@ -3556,11 +3613,11 @@ interface ImDraftsApi {
 
 /**
  * SDK 会话列表内部 sibling 路由与会话级写动作。
- * 置顶、免打扰、已读和本地删除都要求精确 `ConversationRef`，并按 direct/GROUP/CHANNEL 独立协议分流。
+ * 置顶、免打扰、已读和本地删除都要求精确 `ConversationRef`，并按 direct/GROUP/CHANNEL/robot 独立协议分流。
  */
 
 /** 当前兼容门面支持的精确会话 ref。 */
-type ImSupportedConversationRef = ConversationRef<'direct' | 'group' | 'channel'>;
+type ImSupportedConversationRef = ConversationRef<'direct' | 'group' | 'channel' | 'robot'>;
 /**
  * 会话 API 的迁移期入参。优先传完整 ref；旧 string 仅在当前 session 中唯一命中时可用。
  *
@@ -3959,7 +4016,7 @@ interface ImDirectCallsApi {
  * Blob 只经 storage 持久化。异步读取使用运行时代际防止切会话/切账号晚返回，宿主负责最终渲染与 URL 释放。
  */
 
-type ConversationBackgroundConversationType = 'direct' | 'group' | 'channel';
+type ConversationBackgroundConversationType = 'direct' | 'group' | 'channel' | 'robot';
 interface ConversationBackgroundPreset {
     id: string;
     url: string;
@@ -4119,7 +4176,7 @@ interface ImChannelProfile {
  */
 
 /** default 会话列表支持的精确类型；`supergroup` 继续受产品 Gate 约束。 */
-type ProductConversationListType = 'direct' | 'group' | 'channel';
+type ProductConversationListType = 'direct' | 'group' | 'channel' | 'robot';
 /** GROUP 会话限制状态；与 CHANNEL 状态保持独立 sibling。 */
 type ImGroupConversationState = GroupSessionState;
 /**
@@ -4178,6 +4235,8 @@ type ConversationLastMessageSummary = {
     kind: 'robot';
 } | {
     kind: 'transfer';
+} | {
+    kind: 'gift';
 } | {
     kind: 'redPacket';
 } | {
@@ -4333,6 +4392,12 @@ interface DirectConversationCapabilities {
     canUseMessageActions: CapabilityDecision;
     canManageRelationship: CapabilityDecision;
 }
+interface RobotConversationCapabilities {
+    canSendMessages: CapabilityDecision;
+    canOpenProfile: CapabilityDecision;
+    canUseMessageActions: CapabilityDecision;
+    canReadHistory: CapabilityDecision;
+}
 /**
  * 普通群能力快照。
  *
@@ -4399,6 +4464,8 @@ type ConversationCapabilitySnapshot = (ConversationCapabilityBase<'direct'> & {
     value: GroupConversationCapabilities;
 }) | (ConversationCapabilityBase<'channel'> & {
     value: ChannelConversationCapabilities;
+}) | (ConversationCapabilityBase<'robot'> & {
+    value: RobotConversationCapabilities;
 });
 interface ImConversationCapabilitiesApi {
     /** 只读取 SDK 当前本机真相与已刷新过的资料/关系投影，不隐式联网。 */
@@ -4565,7 +4632,7 @@ interface ImMessagesByIdResult<TMessage> {
  */
 
 /** 当前已接线的产品 handle 会话类型；三者只在无会话语义原子层复用。 */
-type ProductHandleConversationType = 'direct' | 'group' | 'channel';
+type ProductHandleConversationType = 'direct' | 'group' | 'channel' | 'robot';
 /**
  * 会话 handle 初始打开位置。
  *
@@ -4606,6 +4673,11 @@ interface ConversationOpenOptions {
  */
 interface ConversationHandleSnapshot<TType extends ProductHandleConversationType = ProductHandleConversationType> {
     ref: ConversationRef<TType>;
+    /** 已校验的聊天标题与头像；即使尚无会话列表项，宿主也可正常展示聊天头部。 */
+    display?: Readonly<{
+        title: string;
+        avatar?: string;
+    }>;
     messages: readonly ImMessageView[];
     /** 本次打开时冻结的未读入口；只用于产品 UI 分隔线，不作为 SDK 已读真相。 */
     entryUnread: ConversationEntryUnreadSnapshot;
@@ -4700,6 +4772,12 @@ interface ConversationMessageApi {
      * @remarks CHANNEL 当前产品入口不发送转账，会返回 unsupported。消息固定明文。
      */
     sendTransfer: (transfer: ImTransferBody, options?: TransferMessageOptions) => Promise<SendMessageResult>;
+    /**
+     * 发送礼品卡片。调用方必须先完成福利中心 HTTP 赠送。
+     *
+     * @remarks CHANNEL 当前产品入口不发送礼物，会返回 unsupported。消息固定明文。
+     */
+    sendGift: (gift: ImGiftBody, options?: GiftMessageOptions) => Promise<SendMessageResult>;
     /** 当前用户已选相同 emoji 时移除，否则添加或替换。emoji 必须是协议 token，例如 `[Great]`。 */
     toggleReaction: (messageId: string, emoji: string) => Promise<ImReactionChangeResult>;
     /** 显式添加/替换或移除，供参与者详情等不能用 toggle 猜动作的产品交互。 */
@@ -5539,6 +5617,57 @@ interface ImRequestError {
  */
 type ImRequestErrorHandler = (issue: ImRequestError) => void | Promise<void>;
 
+/**
+ * 机器人目录产品分页运行时。
+ * 服务端页码封装为绑定账号 runtime 与查询条件的 opaque token；伪造、跨筛选或已消费 token 显式失败。
+ */
+
+/**
+ * 机器人目录查询范围。
+ *
+ * `catalog` 对齐通讯录「查找机器人」；`conversation` 对齐群/社群资料添加与输入栏已绑定列表。
+ */
+type ImRobotDirectoryScope = {
+    kind: 'catalog';
+} | {
+    kind: 'conversation';
+    conversationType: 'group' | 'channel';
+    conversationId: string;
+    /** `bound` 对齐 iOS 输入栏 `search_type=1`。 */
+    filter?: 'bound';
+};
+/** 机器人目录项；只保留打开私聊和列表展示所需字段。 */
+interface ImRobotDirectoryItem {
+    id: string;
+    displayName: string;
+    username?: string;
+    avatarUrl?: string;
+    bound?: boolean;
+}
+/** 把机器人绑定或解绑到普通群/社群。 */
+interface ImRobotConversationBindInput {
+    robotId: string;
+    conversationType: 'group' | 'channel';
+    conversationId: string;
+}
+/** 机器人目录页；服务端页码由 SDK token 封装，UI 只能原样续页。 */
+interface ImRobotDirectoryPage {
+    items: readonly ImRobotDirectoryItem[];
+    nextPageToken?: ImPageToken;
+    exhausted: boolean;
+}
+/** 机器人目录产品分页面。 */
+interface ImRobotsApi {
+    listFirstPage: (options?: {
+        scope?: ImRobotDirectoryScope;
+        keyword?: string;
+        pageSize?: number;
+    }) => Promise<ImRobotDirectoryPage>;
+    listNextPage: (pageToken: ImPageToken) => Promise<ImRobotDirectoryPage>;
+    bindToConversation: (input: ImRobotConversationBindInput) => Promise<void>;
+    unbindFromConversation: (input: ImRobotConversationBindInput) => Promise<void>;
+}
+
 /**
  * 当前账号本地会话与消息的分场景产品搜索运行时。
  *
@@ -5601,6 +5730,8 @@ interface ImMessageSearchApi {
     inGroup: (conversation: ConversationRef<'group'>, keyword: string) => Promise<ProductMessageSearchPage<MessageContentType>>;
     /** 搜索 CHANNEL 本地历史；当前不调用未闭合的远端 CHANNEL 搜索/定位协议。 */
     inChannel: (conversation: ConversationRef<'channel'>, keyword: string) => Promise<ProductMessageSearchPage<MessageContentType>>;
+    /** 搜索 robot 本地历史；无远端历史，不得回退 direct。 */
+    inRobot: (conversation: ConversationRef<'robot'>, keyword: string) => Promise<ProductMessageSearchPage<MessageContentType>>;
     /** 只搜索文本消息；关键词必填且不能为空。 */
     texts: (conversation: ConversationRef<ProductHandleConversationType>, keyword: string) => Promise<ProductMessageSearchPage<'text'>>;
     /** 只搜索文件消息；省略或传空白关键词时按文件分类浏览。 */
@@ -6124,13 +6255,18 @@ interface AdvancedChannelsApi extends ImDirectoryApi<'channel'> {
 /** advanced 会话门面：保留兼容列表动作，同时暴露与 default 共用的背景产品能力。 */
 interface AdvancedConversationsApi extends ImConversationsApi, ImConversationBackgroundApi {
     /**
-     * 为产品 `openConversation` 完成缺失会话的本地对象/资料/访问校验并提交 DomainState 摘要。
+     * 为产品 `openConversation` 完成本地对象/资料/访问校验；打开本身不创建会话列表项。
      *
      * advanced/testing 的原始 handle 测试不得把它当成第二个宿主入口。
      *
      * @internal
      */
-    ensureOpenableConversation: (ref: ConversationRef) => Promise<ConversationRef<'direct' | 'group' | 'channel'>>;
+    ensureOpenableConversation: (ref: ConversationRef) => Promise<ConversationRef<'direct' | 'group' | 'channel' | 'robot'>>;
+    /**
+     * 读取已有会话或本次账号内已校验的目标资料；返回值不代表列表成员资格。
+     * @internal
+     */
+    getContext: (ref: ConversationRef) => ImSession | undefined;
 }
 /**
  * 普通宿主的真实 default client。
@@ -6154,6 +6290,8 @@ interface ImProductClient {
     readonly conversations: ImConversationListApi;
     /** 当前账号完整联系人、群组和社群目录的统一搜索。 */
     readonly directory: ImDirectorySearchApi;
+    /** 机器人公开目录；通讯录查找与群/社群绑定列表共用分页合同。 */
+    readonly robots: ImRobotsApi;
     readonly contacts: ImContactsApi;
     readonly groups: ImGroupsApi;
     readonly channels: ImChannelsApi;
@@ -6203,6 +6341,7 @@ interface ImClient extends Omit<ImProductClient, 'capabilities' | 'channels' | '
         (ref: ConversationRef<'direct'>, options?: ConversationOpenOptions): Promise<ConversationHandle<'direct'>>;
         (ref: ConversationRef<'group'>, options?: ConversationOpenOptions): Promise<ConversationHandle<'group'>>;
         (ref: ConversationRef<'channel'>, options?: ConversationOpenOptions): Promise<ConversationHandle<'channel'>>;
+        (ref: ConversationRef<'robot'>, options?: ConversationOpenOptions): Promise<ConversationHandle<'robot'>>;
     };
     /** 当前账号草稿产品面；按复合身份持久化，handle.draft 委托同一状态源。 */
     drafts: ImDraftsApi;
@@ -6716,7 +6855,7 @@ interface ChatRuntime {
     /** 撤销当前账号创建的全部媒体预览地址并释放 Blob 内存，切账号、退出或销毁时调用。 */
     cleanupLocalMediaBlobs: () => void;
     /** 删除会话时释放该会话绑定的本地媒体预览/播放缓存。 */
-    cleanupConversationMediaBlobs: (conversation: ConversationRef<'direct' | 'group' | 'channel'>) => void;
+    cleanupConversationMediaBlobs: (conversation: ConversationRef<'direct' | 'group' | 'channel' | 'robot'>) => void;
 }
 
 /** 当前置顶消息的稳定资料；普通群和社群各自保留明确会话身份。 */
@@ -8915,6 +9054,8 @@ type ProductConversationHandle = ConversationHandle<ProductHandleConversationTyp
 /** Thread Store 中由 Pinia 管理的当前窗口投影；句柄、订阅和租约留在闭包中。 */
 interface ImThreadStoreState {
     activeRef: ConversationRef<ProductHandleConversationType> | null;
+    /** SDK 已校验的活动聊天展示资料；不依赖该聊天是否已进入会话列表。 */
+    display: ConversationHandleSnapshot['display'] | null;
     messages: readonly ImMessageView[];
     entryUnread: ConversationEntryUnreadSnapshot;
     draft: ConversationDraft | null;