k2-im 0.1.43 → 0.1.44

package/dist/browser.js

@@ -1 +1 @@
-export{Ta as canCopyImageToClipboard,Ua as copyImageToClipboard,B as createLazyBrowserApiProtocolClient}from'./chunk-6FH2DBQE.js';import'./chunk-6WAB2ZRF.js';import'./chunk-WOT6VMZA.js';
+export{Ua as canCopyImageToClipboard,Va as copyImageToClipboard,B as createLazyBrowserApiProtocolClient}from'./chunk-SVYZRVHS.js';import'./chunk-XNBJ3NXF.js';import'./chunk-WOT6VMZA.js';

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

@@ -42,8 +42,8 @@ interface ConversationDraft$1 {
     attachments: readonly [];
     updatedAt: number;
 }
-/** 消息内容类型。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' | 'filesAlbum' | '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）；liveRoom=直播间分享（contentType=30）；未知 wire 正文统一归一为 unknown。 */
+type MessageContentType = 'text' | 'system' | 'image' | 'video' | 'voice' | 'file' | 'sticker' | 'contact' | 'miniProgram' | 'game' | 'transfer' | 'gift' | 'call' | 'redPacket' | 'mediaAlbum' | 'filesAlbum' | 'robot' | 'liveRoom' | 'unknown';
 /**
  * 发送态（客户端态）：消息从本地创建到服务端确认的生命周期。
  * `uploading` 仅媒体消息使用：文件上传阶段（uploading→pending→sending→sent）；
@@ -114,6 +114,8 @@ type LastMessageSummary = {
     kind: 'transfer';
 } | {
     kind: 'gift';
+} | {
+    kind: 'liveRoom';
 } | {
     kind: 'call';
     callKind: ImCallKind;
@@ -612,6 +614,40 @@ interface ImMediaAlbumBody {
     /** 媒体项，顺序即用户选择顺序（决定宫格 index 与首项朝向）。 */
     items: readonly ImMediaAlbumItem[];
 }
+/** 直播间分享的直播类型。wire `liveType`：1 视频、2 语音、3 双手机、4 单手机录屏、5 语聊房。 */
+type ImLiveRoomType = 'video' | 'voice' | 'dual-phone' | 'screen-record' | 'voice-chat';
+/** 直播间分享的房间状态。wire `liveRoomStatus`：1 预告、2 直播中、3 已结束。 */
+type ImLiveRoomStatus = 'preview' | 'live' | 'ended';
+/**
+ * 直播间分享卡片正文（contentType==='liveRoom'，协议 BMessage.contentType=30，fields 98-112）。
+ *
+ * @remarks 调用方先拿到直播间快照再写入本结构。Core 不请求直播接口，也不把缺省枚举猜成某一种直播。
+ * `uid` 是声网 SDK 初始化用的 UID，不是 IM 用户 id。
+ */
+interface ImLiveRoomBody {
+    /** 直播间 ID（BMessage.liveRoomId）。 */
+    liveRoomId: string;
+    liveType: ImLiveRoomType;
+    liveRoomStatus: ImLiveRoomStatus;
+    /** 当前账号是否已关注主播。协议 bool 无法区分未设置，false 也是有效状态。 */
+    isFocus: boolean;
+    /** 当前账号是否已预约这场直播。 */
+    isReservation: boolean;
+    liveRecordId?: string;
+    /** 画面比例原文，例如 `16:9`。 */
+    screenRatio?: string;
+    broadcasterUserId?: string;
+    broadcasterUserName?: string;
+    /** 声网 SDK 初始化 UID（BMessage.uid）。 */
+    uid?: string;
+    liveCover?: string;
+    liveRoomName?: string;
+    /** 预告时间，秒级时间戳的十进制字符串。 */
+    livePreviewTime?: string;
+    livePreviewId?: string;
+    /** 直播间人数字符串，保持协议原文，不在 Core 换算。 */
+    liveRoomViewers?: string;
+}
 interface ImMessageBody {
     /** P0 文本内容（明文，解密后的结果）。 */
     text?: string;
@@ -647,6 +683,8 @@ interface ImMessageBody {
     filesAlbum?: ImFilesAlbumBody;
     /** contentType==='robot' 时的机器人卡片。 */
     robot?: ImRobotBody;
+    /** contentType==='liveRoom' 时的直播间分享卡片。 */
+    liveRoom?: ImLiveRoomBody;
     /** contentType==='unknown' 时的稳定未知正文，不含原始 wire type。 */
     unknown?: UnknownMessageBody;
 }
@@ -2647,9 +2685,9 @@ interface ImGroupCallMeetingSnapshot {
     readonly createdAt: number;
 }
 
-type EditFailReason = 'not-found' | 'not-own' | 'not-sent' | 'recalled' | 'deleted' | 'expired' | 'unsupported' | 'empty' | 'restricted' | 'unsupported-content' | 'no-key' | 'encrypt-failed' | 'timeout' | 'failed' | 'disconnected';
+type EditFailReason = 'not-found' | 'not-own' | 'pinned' | 'not-sent' | 'recalled' | 'deleted' | 'expired' | 'unsupported' | 'empty' | 'restricted' | 'unsupported-content' | 'no-key' | 'encrypt-failed' | 'timeout' | 'failed' | 'disconnected';
 
-type RecallFailReason = 'not-found' | 'not-own' | 'not-sent' | 'expired' | 'unsupported' | 'timeout' | 'server-expired' | 'failed' | 'disconnected';
+type RecallFailReason = 'not-found' | 'not-own' | 'pinned' | 'not-sent' | 'expired' | 'unsupported' | 'timeout' | 'server-expired' | 'failed' | 'disconnected';
 
 /** 浏览器 PushSubscription.toJSON() 的可移植数据；不依赖 DOM 或浏览器全局。 */
 interface ImWebPushSubscription {
@@ -3202,6 +3240,10 @@ interface TransferMessageOptions {
 interface GiftMessageOptions {
     replyToMessageId?: string;
 }
+/** 直播间分享卡发送选项；正文由调用方提供，Core 不补默认直播类型。 */
+interface LiveRoomMessageOptions {
+    replyToMessageId?: string;
+}
 /**
  * 媒体合集里的一项：一张图片或一个视频。
  *
@@ -3415,6 +3457,36 @@ interface ImDirectorySearchApi {
     search: (keyword: string) => Promise<ImDirectorySearchResult>;
 }
 
+/** 回源失败的原因与能否重试。 */
+interface MessagesByIdFailure {
+    /**
+     * 能否稍后重试。
+     *
+     * 服务端错误、网络异常和登录过期都算可以重试；无权限（已退群或已退出频道）和参数错误是终态，
+     * 再试多少次结果都一样，调用方应该停下来而不是反复打接口。
+     */
+    retryable: boolean;
+    /** 原始错误，供诊断与上报。 */
+    error: unknown;
+}
+/** 回源的汇总结果。三组 id 互不重叠，合起来覆盖调用方传入的全部有效 id。 */
+interface ImMessagesByIdResult<TMessage> {
+    /** 成功取回的消息。已经进了本地历史，后续本地查询就能命中。 */
+    readonly messages: readonly TMessage[];
+    /**
+     * 服务端确认没有这些消息：已被删除、超出保留期被清理，或对当前用户不可见。
+     * 这是终态，调用方应记下来并停止重试。
+     */
+    readonly missingMessageIds: readonly string[];
+    /**
+     * 这次没取到、但不代表不存在的消息 id（请求失败了）。
+     * 是否值得再试看 `failure.retryable`。
+     */
+    readonly unresolvedMessageIds: readonly string[];
+    /** `unresolvedMessageIds` 非空时的失败原因；全部取到或全部确认缺失时不存在。 */
+    readonly failure?: MessagesByIdFailure;
+}
+
 /**
  * SDK 内部 CHANNEL sibling：装配资料、成员、申请、置顶、历史限制与通知修复能力。
  *
@@ -3567,6 +3639,15 @@ interface ImContactSearchResult {
     age?: number;
     relationship: ImContactRelationship;
 }
+/** 当前账号黑名单中的一名用户；不暴露关系记录 id、status 等后端字段。 */
+interface ImBlockedContact {
+    userId: string;
+    /** 优先当前账号设置的备注，没有备注时为对方昵称。 */
+    displayName: string;
+    nickname: string;
+    remark?: string;
+    avatarUrl?: string;
+}
 /** 好友申请提交结果；调用成功不等于一定需要对端审核。 */
 interface ImFriendshipRequestResult {
     status: 'sent' | 'added' | 'already-friend';
@@ -3606,6 +3687,15 @@ interface ImContactApi extends ImDirectoryApi<'individual'> {
     }) => Promise<ImFriendshipRequestResult>;
     /** 远端确认后加入黑名单，并清理该用户的本机 direct 会话和聊天数据。 */
     blockUser: (userId: string) => Promise<void>;
+    /** 读取当前账号的黑名单；结果直接来自服务端，空数组表示名单为空。 */
+    listBlocked: () => Promise<readonly ImBlockedContact[]>;
+    /**
+     * 远端确认后把用户移出黑名单。
+     *
+     * @remarks 移出后双方是否恢复为好友由服务端决定，SDK 不猜：本地关系先改为 `unknown`，
+     * 再强制查询服务端关系并刷新资料。拉黑时已删除的 direct 会话和聊天记录不会恢复。
+     */
+    unblockUser: (userId: string) => Promise<void>;
     /** 提交联系人举报；该操作不修改好友关系、会话或本地资料。 */
     reportUser: (userId: string, problem: string) => Promise<void>;
     /**
@@ -4320,6 +4410,8 @@ type ConversationLastMessageSummary = {
     kind: 'transfer';
 } | {
     kind: 'gift';
+} | {
+    kind: 'liveRoom';
 } | {
     kind: 'redPacket';
 } | {
@@ -4706,36 +4798,6 @@ interface ImExpressionsApi {
     };
 }
 
-/** 回源失败的原因与能否重试。 */
-interface MessagesByIdFailure {
-    /**
-     * 能否稍后重试。
-     *
-     * 服务端错误、网络异常和登录过期都算可以重试；无权限（已退群或已退出频道）和参数错误是终态，
-     * 再试多少次结果都一样，调用方应该停下来而不是反复打接口。
-     */
-    retryable: boolean;
-    /** 原始错误，供诊断与上报。 */
-    error: unknown;
-}
-/** 回源的汇总结果。三组 id 互不重叠，合起来覆盖调用方传入的全部有效 id。 */
-interface ImMessagesByIdResult<TMessage> {
-    /** 成功取回的消息。已经进了本地历史，后续本地查询就能命中。 */
-    readonly messages: readonly TMessage[];
-    /**
-     * 服务端确认没有这些消息：已被删除、超出保留期被清理，或对当前用户不可见。
-     * 这是终态，调用方应记下来并停止重试。
-     */
-    readonly missingMessageIds: readonly string[];
-    /**
-     * 这次没取到、但不代表不存在的消息 id（请求失败了）。
-     * 是否值得再试看 `failure.retryable`。
-     */
-    readonly unresolvedMessageIds: readonly string[];
-    /** `unresolvedMessageIds` 非空时的失败原因；全部取到或全部确认缺失时不存在。 */
-    readonly failure?: MessagesByIdFailure;
-}
-
 /**
  * 绑定单个精确会话的产品句柄与独立连续消息窗口。
  * 句柄提供历史、消息、草稿、已读和免打扰动作；SDK/DomainState 仍拥有消息真相，关闭只释放窗口和订阅。
@@ -4893,6 +4955,12 @@ interface ConversationMessageApi {
      * @remarks CHANNEL 当前产品入口不发送礼物，会返回 unsupported。消息固定明文。
      */
     sendGift: (gift: ImGiftBody, options?: GiftMessageOptions) => Promise<SendMessageResult>;
+    /**
+     * 分享直播间卡片。调用方必须先拿到直播间快照。
+     *
+     * @remarks Core 不请求直播接口，也不补默认直播类型或房间状态。群和频道按会话加密发送。
+     */
+    sendLiveRoom: (liveRoom: ImLiveRoomBody, options?: LiveRoomMessageOptions) => Promise<SendMessageResult>;
     /** 当前用户已选相同 emoji 时移除，否则添加或替换。emoji 必须是协议 token，例如 `[Great]`。 */
     toggleReaction: (messageId: string, emoji: string) => Promise<ImReactionChangeResult>;
     /** 显式添加/替换或移除，供参与者详情等不能用 toggle 猜动作的产品交互。 */
@@ -4920,7 +4988,7 @@ interface ConversationMessageApi {
      */
     replaceInterruptedFile: (messageId: string, file: File | Blob, options?: FileMessageOptions) => Promise<SendMessageResult>;
     /**
-     * 编辑当前会话的一条文本消息；所有权、正文类型、时间窗、加密与 CHANNEL 权限由对应 core sibling 校验。
+     * 编辑当前会话的一条非置顶文本消息；所有权、正文类型、时间窗、加密与 CHANNEL 权限由对应 core sibling 校验。
      * @throws 消息不属于当前 handle，或 core 返回稳定业务失败时抛出 `ImSdkErrorShape`；不暴露协议 errcode。
      * @example
      * ```ts
@@ -4931,10 +4999,10 @@ interface ConversationMessageApi {
      * ```
      */
     editText: (messageId: string, text: string, options?: EditTextOptions) => Promise<ImProductMessage>;
-    /** 撤回当前会话消息；成功后由同一 DomainState 更新窗口，失败抛稳定产品错误。 */
+    /** 撤回当前会话非置顶消息；成功后由同一 DomainState 更新窗口，失败抛稳定产品错误。 */
     recall: (messageId: string) => Promise<void>;
     /**
-     * 仅从当前账号本机删除一条已落地消息。
+     * 仅从当前账号本机删除一条已落地且未置顶的消息。
      *
      * @remarks 不清理已读、置顶、草稿、宿主下载文件、独立媒体缓存或远端历史。仍由 Outbox 持有或正在上传的消息会被拒绝；
      * queued 消息只有在 `client.outbox.cancel` 成功移除账本后，才能删除其本地失败气泡，避免把删除气泡误当作取消发送。
@@ -5056,7 +5124,7 @@ interface ChannelConversationMessageApi extends ConversationMessageApi {
      *
      * @remarks 不受本人撤回时间窗限制；权限由 CHANNEL profile 预检并由服务端最终校验。成功后消息进入
      * `deletedForEveryone` 终态；Chat Kit 时间线仅向社群群主和管理员显示删除提示，普通成员隐藏该项。
-     * 该方法不用于本机删除，也不适用于普通群。
+     * 置顶原消息即使由管理员或群主操作也会拒绝；该方法不用于本机删除，也不适用于普通群。
      * @example
      * ```ts
      * const channel = await client.openConversation({ conversationType: 'channel', conversationId: '9001' })
@@ -6279,6 +6347,25 @@ interface ImContactsApi extends ImDirectoryApi<'individual'> {
      * ```
      */
     blockUser: (userId: string) => Promise<void>;
+    /**
+     * 读取当前账号的黑名单；每次都查询服务端，空数组表示名单为空。
+     *
+     * @example
+     * ```ts
+     * const blocked = await client.contacts.listBlocked()
+     * ```
+     */
+    listBlocked: () => Promise<readonly ImBlockedContact[]>;
+    /**
+     * 把用户移出黑名单。
+     *
+     * @remarks 远端成功后 SDK 重新向服务端查询双方关系，不假设恢复为好友；拉黑时已删除的会话和聊天记录不会恢复。
+     * @example
+     * ```ts
+     * await client.contacts.unblockUser('user-7')
+     * ```
+     */
+    unblockUser: (userId: string) => Promise<void>;
     /**
      * 举报联系人；成功只表示服务端已接收，不改变好友关系或本地会话。
      *
@@ -6411,6 +6498,8 @@ interface AdvancedContactsApi extends ImDirectoryApi<'individual'> {
     searchUser: ImContactApi['searchUser'];
     requestFriendship: ImContactApi['requestFriendship'];
     blockUser: ImContactApi['blockUser'];
+    listBlocked: ImContactApi['listBlocked'];
+    unblockUser: ImContactApi['unblockUser'];
     reportUser: ImContactApi['reportUser'];
     deleteFriendship: ImContactApi['deleteFriendship'];
 }
@@ -6699,7 +6788,7 @@ declare function useImApplicationsStore(pinia?: Pinia): ImApplicationsStore;
  * 二期收敛：kit 框架无关层不再直接产中文，改产本联合里的码 + 参数（如 {reason}/{label}/{size}），由宿主经 im-i18n 渲染。
  * 动态原始报错（error.message）作为 `{reason}` 参数拼接，不入 catalog（属诊断，不翻译）。
  */
-type ImServiceTextKey = 'common.notConnected' | 'common.selectOrOpenConversation' | 'common.conversationTypeNotReady' | 'common.conversationNotReady' | `recall.${RecallFailReason}` | `edit.${EditFailReason}` | 'localDelete.done' | 'localDelete.notFound' | 'localDelete.inFlight' | 'localDelete.failed' | 'channelDelete.notFound' | 'channelDelete.unsupported' | 'channelDelete.notSent' | 'channelDelete.unavailable' | 'channelDelete.forbidden' | 'channelDelete.timeout' | 'channelDelete.failed' | 'channelDelete.disconnected' | 'directBlock.contactRequired' | 'groupBlock.left' | 'groupBlock.removed' | 'groupBlock.dismissed' | 'groupBlock.unknownRestricted' | 'channelBlock.guest' | 'channelBlock.left' | 'channelBlock.removed' | 'channelBlock.dismissed' | 'channelBlock.muted' | 'channelBlock.allMembersMuted' | 'channelBlock.currentUserMuted' | 'channelBlock.blacklisted' | 'channelBlock.unknownRestricted' | 'channelProfile.loadFailed' | 'channelProfile.notFound' | 'channelProfile.retryAction' | 'channelMembers.title' | 'channelMembers.searchPlaceholder' | 'channelMembers.loading' | 'channelMembers.loadFailed' | 'channelMembers.retryAction' | 'channelMembers.empty' | 'channelMembers.loadingMore' | 'channelMembers.loadMoreFailed' | 'channelMembers.exhausted' | 'channelMembers.loadMoreAction' | 'label.image' | 'label.video' | 'label.file' | 'label.sticker' | 'send.failed' | 'send.retryFailed' | 'send.cancelFailed' | 'send.mediaFailed' | 'send.mediaEmpty' | 'send.mediaCancelled' | 'send.mediaCountLimit' | 'send.mediaTooLarge' | 'send.mediaFormatMismatch' | 'send.imageFormatUnsupported' | 'send.videoTooLong' | 'send.videoDurationUnavailable' | 'send.voiceEmpty' | 'send.voiceStorageNotConfigured' | 'send.voiceCancelled' | 'send.voiceFailed' | 'media.uploadWaiting' | 'media.voiceNotReady' | 'media.voiceLoadEmpty' | 'media.voiceLoadFailed' | 'media.videoOpenEmpty' | 'media.videoLoadFailed' | 'media.imageInvalid' | 'media.imageLoadFailed' | 'media.fileDownloadEmpty' | 'media.fileDownloadFailed' | 'conversation.muteEnableFailed' | 'conversation.muteDisableFailed' | 'conversation.backgroundLoadFailed' | 'read.markReadFailed' | 'storage.failed' | 'sync.failed' | 'draft.saveFailed' | 'history.returnLatestFailed' | 'pinned.forbidden' | 'pinned.network' | 'pinned.contract' | 'pinned.unsupported' | 'pinned.failed' | 'pinned.previewUnavailable' | 'pinned.locateFailed' | 'pinned.recalled' | 'pinned.deleted' | 'pinned.protected' | 'pinned.pinAction' | 'pinned.unpinAction' | 'pinned.unpinConfirm' | 'pinned.cancelAction' | 'lifecycle.missingLoginState' | 'lifecycle.prepareFailed' | 'lifecycle.missingConnectParams' | 'lifecycle.connectFailed' | 'lifecycle.disposed' | 'lifecycle.connectionOccupied' | 'lifecycle.connectionCoordinationUnavailable' | 'forward.emptyInput' | 'forward.allSkipped' | 'forward.partialSkipped' | 'forward.done' | 'forward.failed';
+type ImServiceTextKey = 'common.notConnected' | 'common.selectOrOpenConversation' | 'common.conversationTypeNotReady' | 'common.conversationNotReady' | `recall.${RecallFailReason}` | `edit.${EditFailReason}` | 'localDelete.done' | 'localDelete.notFound' | 'localDelete.inFlight' | 'localDelete.failed' | 'channelDelete.notFound' | 'channelDelete.unsupported' | 'channelDelete.notSent' | 'channelDelete.unavailable' | 'channelDelete.forbidden' | 'channelDelete.timeout' | 'channelDelete.failed' | 'channelDelete.disconnected' | 'directBlock.contactRequired' | 'groupBlock.left' | 'groupBlock.removed' | 'groupBlock.dismissed' | 'groupBlock.unknownRestricted' | 'channelBlock.guest' | 'channelBlock.left' | 'channelBlock.removed' | 'channelBlock.dismissed' | 'channelBlock.muted' | 'channelBlock.allMembersMuted' | 'channelBlock.currentUserMuted' | 'channelBlock.blacklisted' | 'channelBlock.unknownRestricted' | 'channelProfile.loadFailed' | 'channelProfile.notFound' | 'channelProfile.retryAction' | 'channelMembers.title' | 'channelMembers.searchPlaceholder' | 'channelMembers.loading' | 'channelMembers.loadFailed' | 'channelMembers.retryAction' | 'channelMembers.empty' | 'channelMembers.loadingMore' | 'channelMembers.loadMoreFailed' | 'channelMembers.exhausted' | 'channelMembers.loadMoreAction' | 'label.image' | 'label.video' | 'label.file' | 'label.sticker' | 'send.failed' | 'send.retryFailed' | 'send.cancelFailed' | 'send.mediaFailed' | 'send.mediaEmpty' | 'send.mediaCancelled' | 'send.mediaCountLimit' | 'send.mediaTooLarge' | 'send.mediaFormatMismatch' | 'send.imageFormatUnsupported' | 'send.videoTooLong' | 'send.videoDurationUnavailable' | 'send.voiceEmpty' | 'send.voiceStorageNotConfigured' | 'send.voiceCancelled' | 'send.voiceFailed' | 'media.uploadWaiting' | 'media.voiceNotReady' | 'media.voiceLoadEmpty' | 'media.voiceLoadFailed' | 'media.videoOpenEmpty' | 'media.videoLoadFailed' | 'media.imageInvalid' | 'media.imageLoadFailed' | 'media.fileDownloadEmpty' | 'media.fileDownloadFailed' | 'conversation.muteEnableFailed' | 'conversation.muteDisableFailed' | 'conversation.backgroundLoadFailed' | 'read.markReadFailed' | 'storage.failed' | 'sync.failed' | 'draft.saveFailed' | 'history.returnLatestFailed' | 'pinned.forbidden' | 'pinned.network' | 'pinned.contract' | 'pinned.unsupported' | 'pinned.failed' | 'pinned.previewUnavailable' | 'pinned.locateFailed' | 'pinned.messageNotFound' | 'pinned.recalled' | 'pinned.deleted' | 'pinned.protected' | 'pinned.pinAction' | 'pinned.unpinAction' | 'pinned.unpinConfirm' | 'pinned.cancelAction' | 'lifecycle.missingLoginState' | 'lifecycle.prepareFailed' | 'lifecycle.missingConnectParams' | 'lifecycle.connectFailed' | 'lifecycle.disposed' | 'lifecycle.connectionOccupied' | 'lifecycle.connectionCoordinationUnavailable' | 'forward.emptyInput' | 'forward.allSkipped' | 'forward.partialSkipped' | 'forward.done' | 'forward.failed';
 
 /**
  * 本文件管理图片和视频本地预览地址的完整生命周期。