@zhin.js/adapter-icqq 1.0.71 → 1.1.0

package/lib/protocol.d.ts

@@ -0,0 +1,276 @@
+import type { Sendable } from '@icqqjs/icqq';
+import type { ConversationRef } from '@zhin.js/im-contract';
+import type { MessageSegment } from "zhin.js";
+export type ActionResult = {
+    id: string;
+    ok: boolean;
+    data?: unknown;
+    error?: string;
+};
+export type { IcqqMessageEvent } from "./icqq-inbound.js";
+export { resolveIcqqInboundMessageId } from "./icqq-inbound.js";
+export interface GuildMessageEventData {
+    type: "guild";
+    guild_id: string;
+    guild_name: string;
+    channel_id: string;
+    channel_name: string;
+    nickname: string;
+    tiny_id: string;
+    raw_message: string;
+    time: number;
+    seq: number;
+}
+/**
+ * 所有操作常量（@icqqjs/icqq）
+ */
+export declare const Actions: {
+    readonly PING: "ping";
+    readonly LOGOUT: "logout";
+    readonly LIST_FRIENDS: "list_friends";
+    readonly LIST_GROUPS: "list_groups";
+    readonly LIST_GROUP_MEMBERS: "list_group_members";
+    readonly LIST_BLACKLIST: "list_blacklist";
+    readonly LIST_FRIEND_CLASSES: "list_friend_classes";
+    readonly GET_FRIEND_INFO: "get_friend_info";
+    readonly GET_GROUP_INFO: "get_group_info";
+    readonly GET_GROUP_MEMBER_INFO: "get_group_member_info";
+    readonly GET_STRANGER_INFO: "get_stranger_info";
+    readonly LIST_STRANGERS: "list_strangers";
+    readonly GET_PROFILE: "get_profile";
+    readonly GET_STATUS: "get_status";
+    readonly GET_ONLINE_STATUS: "get_online_status";
+    readonly GET_SELF_PROFILE: "get_self_profile";
+    readonly SEND_PRIVATE_MSG: "send_private_msg";
+    readonly SEND_GROUP_MSG: "send_group_msg";
+    readonly RECALL_MSG: "recall_msg";
+    readonly GET_MSG: "get_msg";
+    readonly HISTORY_PRIVATE: "history_private";
+    readonly HISTORY_GROUP: "history_group";
+    readonly HISTORY_BY_MSG_ID: "history_by_msg_id";
+    readonly SEND_LONG_MSG: "send_long_msg";
+    readonly MARK_READ: "mark_read";
+    readonly DELETE_MSG: "delete_msg";
+    readonly SET_NICKNAME: "set_nickname";
+    readonly SET_GENDER: "set_gender";
+    readonly SET_BIRTHDAY: "set_birthday";
+    readonly SET_SIGNATURE: "set_signature";
+    readonly SET_DESCRIPTION: "set_description";
+    readonly SET_AVATAR: "set_avatar";
+    readonly SET_ONLINE_STATUS: "set_online_status";
+    readonly SET_GROUP_NAME: "set_group_name";
+    readonly SET_GROUP_AVATAR: "set_group_avatar";
+    readonly SET_GROUP_CARD: "set_group_card";
+    readonly SET_GROUP_TITLE: "set_group_title";
+    readonly SET_GROUP_ADMIN: "set_group_admin";
+    readonly SET_GROUP_REMARK: "set_group_remark";
+    readonly GROUP_MUTE: "group_mute";
+    readonly GROUP_MUTE_ALL: "group_mute_all";
+    readonly GROUP_KICK: "group_kick";
+    readonly GROUP_QUIT: "group_quit";
+    readonly GROUP_INVITE: "group_invite";
+    readonly GROUP_POKE: "group_poke";
+    readonly GROUP_ANNOUNCE: "group_announce";
+    readonly GROUP_SIGN: "group_sign";
+    readonly GROUP_ESSENCE_ADD: "group_essence_add";
+    readonly GROUP_ESSENCE_REMOVE: "group_essence_remove";
+    readonly GROUP_ALLOW_ANONY: "group_allow_anony";
+    readonly GROUP_MUTED_LIST: "group_muted_list";
+    readonly GROUP_AT_ALL_REMAIN: "group_at_all_remain";
+    readonly FRIEND_POKE: "friend_poke";
+    readonly FRIEND_LIKE: "friend_like";
+    readonly FRIEND_DELETE: "friend_delete";
+    readonly FRIEND_REMARK: "friend_remark";
+    readonly FRIEND_CLASS: "friend_class";
+    readonly GET_SYSTEM_MSG: "get_system_msg";
+    readonly HANDLE_FRIEND_REQUEST: "handle_friend_request";
+    readonly HANDLE_GROUP_REQUEST: "handle_group_request";
+    readonly ADD_FRIEND_CLASS: "add_friend_class";
+    readonly DELETE_FRIEND_CLASS: "delete_friend_class";
+    readonly RENAME_FRIEND_CLASS: "rename_friend_class";
+    readonly GFS_LIST: "gfs_list";
+    readonly GFS_INFO: "gfs_info";
+    readonly GFS_MKDIR: "gfs_mkdir";
+    readonly GFS_DELETE: "gfs_delete";
+    readonly GFS_RENAME: "gfs_rename";
+    readonly GFS_STAT: "gfs_stat";
+    readonly GFS_MOVE: "gfs_move";
+    readonly GFS_DOWNLOAD: "gfs_download";
+    readonly IMAGE_OCR: "image_ocr";
+    readonly RELOAD_FRIEND_LIST: "reload_friend_list";
+    readonly RELOAD_GROUP_LIST: "reload_group_list";
+    readonly CLEAN_CACHE: "clean_cache";
+    readonly GET_GROUP_SHARE: "get_group_share";
+    readonly GROUP_SET_JOIN_TYPE: "group_set_join_type";
+    readonly GROUP_SET_RATE_LIMIT: "group_set_rate_limit";
+    readonly GROUP_MUTE_ANONY: "group_mute_anony";
+    readonly GROUP_ANON_INFO: "group_anon_info";
+    readonly ADD_FRIEND: "add_friend";
+    readonly SEND_TEMP_MSG: "send_temp_msg";
+    readonly GET_ROAMING_STAMP: "get_roaming_stamp";
+    readonly DELETE_STAMP: "delete_stamp";
+    readonly SEND_PRIVATE_FILE: "send_private_file";
+    readonly SEND_GROUP_FILE: "send_group_file";
+    readonly FRIEND_RECALL_FILE: "friend_recall_file";
+    readonly FRIEND_FORWARD_FILE: "friend_forward_file";
+    readonly SEARCH_SAME_GROUP: "search_same_group";
+    readonly SEND_CONTACT_SHARE: "send_contact_share";
+    readonly GFS_UPLOAD: "gfs_upload";
+    readonly GROUP_SET_REACTION: "group_set_reaction";
+    readonly GROUP_DEL_REACTION: "group_del_reaction";
+    readonly GET_FORWARD_MSG: "get_forward_msg";
+    readonly MAKE_FORWARD_MSG: "make_forward_msg";
+    readonly GUILD_LIST: "guild_list";
+    readonly GUILD_INFO: "guild_info";
+    readonly GUILD_CHANNELS: "guild_channels";
+    readonly GET_CHANNEL_INFO: "get_channel_info";
+    readonly GUILD_MEMBERS: "guild_members";
+    readonly GUILD_SEND_MSG: "guild_send_msg";
+    readonly GUILD_RECALL_MSG: "guild_recall_msg";
+    readonly GET_FILE_INFO: "get_file_info";
+    readonly GET_FILE_URL: "get_file_url";
+    readonly GET_AVATAR_URL: "get_avatar_url";
+    readonly GET_GROUP_AVATAR_URL: "get_group_avatar_url";
+    readonly SET_SCREEN_MEMBER_MSG: "set_screen_member_msg";
+    readonly GFS_FORWARD: "gfs_forward";
+    readonly GFS_FORWARD_OFFLINE: "gfs_forward_offline";
+    readonly RELOAD_BLACKLIST: "reload_blacklist";
+    readonly RELOAD_STRANGER_LIST: "reload_stranger_list";
+    readonly RELOAD_GUILDS: "reload_guilds";
+    readonly GET_STATUS_INFO: "get_status_info";
+    readonly GET_CLIENT_KEY: "get_client_key";
+    readonly GET_PSKEY: "get_pskey";
+    readonly UID2UIN: "uid2uin";
+    readonly UID2UINS: "uid2uins";
+    readonly UIN2UID: "uin2uid";
+    readonly UIN2UIDS: "uin2uids";
+    readonly GET_COOKIES: "get_cookies";
+    readonly GET_CSRF_TOKEN: "get_csrf_token";
+    readonly REFRESH_NT_PIC_RKEY: "refresh_nt_pic_rkey";
+    readonly SEND_DISCUSS_MSG: "send_discuss_msg";
+    readonly GET_VIDEO_URL: "get_video_url";
+    readonly GET_ADD_FRIEND_SETTING: "get_add_friend_setting";
+    readonly GET_FORUM_URL: "get_forum_url";
+    readonly GUILD_CHANNEL_SHARE: "guild_channel_share";
+    readonly GET_PIC_URL: "get_pic_url";
+    readonly GET_PTT_URL: "get_ptt_url";
+    readonly SUBSCRIBE: "subscribe";
+    readonly UNSUBSCRIBE: "unsubscribe";
+    readonly SET_WEBHOOK: "set_webhook";
+    readonly GET_WEBHOOK: "get_webhook";
+    readonly SET_NOTIFY: "set_notify";
+    readonly GET_NOTIFY: "get_notify";
+};
+/** Plugin Runtime owner config (`plugins.<instanceKey>` / schema.json). */
+export interface IcqqAdapterConfig {
+    readonly id?: string;
+    readonly autoReconnect?: boolean;
+    readonly outboundMedia?: 'file' | 'base64';
+    readonly password?: string;
+    readonly platform?: number;
+    readonly ver?: string;
+    readonly dataDir?: string;
+    readonly signApiAddr?: string;
+    readonly ignoreSelf?: boolean;
+    readonly resend?: boolean;
+    readonly cacheGroupMember?: boolean;
+    readonly autoServer?: boolean;
+    readonly qqnt?: boolean;
+    readonly ntLogin?: boolean;
+    /** Transitional: legacy root `endpoints[]` with `context: icqq`. */
+    readonly endpoints?: ReadonlyArray<{
+        readonly context?: string;
+        readonly id?: string;
+        readonly autoReconnect?: boolean;
+        readonly outboundMedia?: 'file' | 'base64';
+        readonly password?: string;
+        readonly platform?: number;
+        readonly ver?: string;
+        readonly dataDir?: string;
+        readonly signApiAddr?: string;
+        readonly ignoreSelf?: boolean;
+        readonly resend?: boolean;
+        readonly cacheGroupMember?: boolean;
+        readonly autoServer?: boolean;
+        readonly qqnt?: boolean;
+        readonly ntLogin?: boolean;
+    }>;
+}
+export interface ResolvedIcqqConfig {
+    readonly context: 'icqq';
+    readonly id: string;
+    readonly autoReconnect: boolean;
+    readonly outboundMedia?: 'file' | 'base64';
+    readonly password?: string;
+    readonly platform?: number;
+    readonly ver?: string;
+    readonly dataDir?: string;
+    readonly signApiAddr?: string;
+    readonly ignoreSelf?: boolean;
+    readonly resend?: boolean;
+    readonly cacheGroupMember?: boolean;
+    readonly autoServer?: boolean;
+    readonly qqnt?: boolean;
+    readonly ntLogin?: boolean;
+}
+export interface IcqqWireSegment {
+    readonly type: string;
+    readonly data?: Record<string, unknown>;
+}
+export interface IcqqInboundMessage {
+    readonly id: string;
+    readonly conversation: ConversationRef;
+    readonly content: string;
+    /**
+     * 结构化段视图（canonical Segment，经 toCanonicalSegments 归一）。
+     * 与 content（CQ 原文纯文本视图）同源，随 gateway.receive 上送。
+     */
+    readonly segments?: readonly MessageSegment[];
+    readonly sender: {
+        readonly id: string;
+        readonly name?: string;
+    };
+    readonly channelType: 'private' | 'group' | 'channel';
+    readonly metadata?: Record<string, unknown>;
+    readonly replyTo?: {
+        readonly id: string;
+    };
+}
+export type ParsedIcqqSendTarget = {
+    readonly kind: 'private';
+    readonly userId: number;
+} | {
+    readonly kind: 'group';
+    readonly groupId: number;
+} | {
+    readonly kind: 'temp';
+    readonly groupId: number;
+    readonly userId: number;
+} | {
+    readonly kind: 'channel';
+    readonly guildId: string;
+    readonly channelId: string;
+};
+export declare function resolveIcqqConfig(config?: IcqqAdapterConfig): ResolvedIcqqConfig;
+/**
+ * 入站归一化 → ConversationRef：群临时会话（temp）映射为群容器内的 private
+ * 会话（parent kind 'group'）；频道消息的所属 guild 进 `parent`（kind 'channel'）。
+ */
+export declare function icqqInboundConversation(endpointKey: string, input: {
+    readonly channelType: 'private' | 'group' | 'channel';
+    readonly channelId: string;
+    readonly channelParentGroupId?: string;
+    readonly guildId?: string;
+}): ConversationRef;
+/**
+ * 出站：从 ConversationRef 派生 action 路由。
+ * 群容器（parent kind 'group'）内的 private 会话即 ICQQ 群临时会话（temp）。
+ */
+export declare function icqqOutboundTarget(conversation: ConversationRef): ParsedIcqqSendTarget;
+/**
+ * Project canonical Zhin segments directly into the native ICQQ Sendable
+ * algebra. ICQQ's direct client does not parse Zhin's historical `[image:x]`
+ * notation; passing that notation would send it as literal text.
+ */
+export declare function formatOutboundBody(payload: unknown): Sendable;
+export declare function formatInboundContent(rawMessage: string): string;