wowok 1.8.2 → 2.1.9

package/dist/cjs/w/messenger/messenger-api.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Messenger API
+ *
+ * 提供简单的接口用于管理 inbox 账号和发送消息
+ */
+import type { ConversationInfo, Message, MessageFilter, SendMessageResult, WtsFileResult, WtsGenerationParams, WtsToHtmlOptions, WtsVerificationResult, ListOperationResponse } from "./types.js";
+import { MessengerManager } from "./messenger-manager.js";
+import type { ENTRYPOINT } from "../../client/network.js";
+import type { AccountOrMark_Address, ManyAccountOrMark_Address } from "../local/index.js";
+/**
+ * 获取 MessengerManager 实例（单例）
+ * 首次调用时会自动启动后台服务
+ */
+export declare function getMessengerManager(): MessengerManager;
+export declare function watch_conversations(account?: string | undefined | null): Promise<ConversationInfo[]>;
+/**
+ * 发送消息
+ *
+ * @param from 发送者地址
+ * @param to 接收者地址
+ * @param content 消息内容
+ * @param options 可选配置
+ * @returns SendMessageResult
+ */
+export declare function send_message(from: string | undefined | null, to: AccountOrMark_Address, content: string, options?: {
+    guardAddress?: string;
+    passportAddress?: string;
+    force?: boolean;
+    new_messenger_name?: string;
+}): Promise<SendMessageResult>;
+/**
+ * 发送文件（ZIP 格式）
+ *
+ * 支持发送本地文件，经过 ZIP 压缩后发送给对方
+ * 支持 Guard 验证，如果提供 guardAddress 和 passportAddress，消息将进入 Guard 验证流程
+ *
+ * @param from 发送者账号或地址
+ * @param to 接收者地址
+ * @param filePath 本地文件路径
+ * @param options 可选配置
+ * @returns SendMessageResult
+ */
+export declare function send_file(from: string | undefined | null, to: AccountOrMark_Address, filePath: string, options?: {
+    fileName?: string;
+    contentType?: "wts" | "wip" | "zip";
+    guardAddress?: string;
+    passportAddress?: string;
+    force?: boolean;
+    new_messenger_name?: string;
+}): Promise<SendMessageResult>;
+/**
+ * 查询消息
+ *
+ * @param filter 过滤条件
+ * @returns Message 数组
+ */
+export declare function watch_messages(filter?: MessageFilter & {
+    account?: string;
+}): Promise<Message[]>;
+/**
+ * 批量解压多个 ZIP 消息到指定目录
+ *
+ * @param messages 包含 ZIP 数据的消息数组，或消息 ID 数组
+ * @param outputDir 输出目录路径
+ * @param userAddress 用户地址（当传入消息ID数组时需要）
+ * @returns 解压后的文件路径数组
+ */
+export declare function extract_zip_messages(account: string | undefined | null, messages: (Message | string)[], outputDir: string): Promise<string[]>;
+export declare function generate_wts(params: WtsGenerationParams): Promise<WtsFileResult>;
+/**
+ * 验证 WTS 文件
+ *
+ * 验证内容包括：
+ * 1. 文件结构完整性
+ * 2. Merkle 链连续性
+ * 3. 消息哈希格式
+ * 4. Payload 哈希匹配
+ * 5. 数字签名（如果存在）
+ *
+ * @param wtsFilePath WTS 文件路径（本地或网络文件）
+ * @returns 验证结果
+ */
+export declare function verify_wts(wtsFilePath: string): Promise<WtsVerificationResult>;
+/**
+ * 使用账号签名 WTS 文件
+ *
+ * 此函数会自动加载 WTS 文件、验证格式、签名并保存。
+ *
+ * @param wtsFilePath WTS 文件路径（本地或网络文件）
+ * @param account 签名账号
+ * @param outputPath 输出文件路径（可选，默认覆盖原文件）
+ * @returns 签名后的 WTS 文件路径
+ */
+export declare function sign_wts(wtsFilePath: string, account: string | undefined | null, outputPath?: string): Promise<string>;
+/**
+ * 将 WTS 文件或文件夹转换为 HTML
+ *
+ * @param wtsPath WTS 文件路径或文件夹路径（本地或网络文件）
+ * @param options 转换选项
+ * @returns HTML 字符串、保存的文件路径，或转换的文件路径数组
+ */
+export declare function wts2html(wtsPath: string, options: WtsToHtmlOptions & {
+    outputPath: string;
+}): Promise<string>;
+export declare function wts2html(wtsPath: string, options?: WtsToHtmlOptions): Promise<string | string[]>;
+/**
+ * 提交消息链上证明
+ *
+ * 将消息的 Merkle 证明提交到链上，创建不可篡改的证明记录。
+ * 此函数会先验证消息的完整性和合法性。
+ *
+ * @param account 账号名称或地址
+ * @param messageId 消息ID
+ * @param env 调用环境（包含网络、签名账号等）
+ * @returns 证明对象地址
+ */
+export declare function proof_message(account: string | undefined | null, messageId: string, network: ENTRYPOINT): Promise<{
+    proofAddress: string;
+}>;
+export type BlacklistRequest = {
+    op: "add" | "remove";
+    account: string | undefined | null;
+    users: ManyAccountOrMark_Address;
+} | {
+    op: "clear";
+    account: string | undefined | null;
+} | {
+    op: "get";
+    account: string | undefined | null;
+} | {
+    op: "exist";
+    account: string | undefined | null;
+    users: ManyAccountOrMark_Address;
+};
+export type BlacklistResponse = {
+    op: "add";
+    result: ListOperationResponse;
+} | {
+    op: "remove";
+    result: ListOperationResponse;
+} | {
+    op: "clear";
+    result: ListOperationResponse;
+} | {
+    op: "get";
+    result: string[];
+} | {
+    op: "exist";
+    result: ListOperationResponse;
+};
+/**
+ * 黑名单管理 - 统一入口
+ * @param request 操作请求
+ * @returns 操作结果
+ */
+export declare function blacklist(request: BlacklistRequest): Promise<BlacklistResponse>;
+export type FriendslistRequest = {
+    op: "add" | "remove";
+    account: string | undefined | null;
+    users: ManyAccountOrMark_Address;
+} | {
+    op: "clear";
+    account: string | undefined | null;
+} | {
+    op: "get";
+    account: string | undefined | null;
+} | {
+    op: "exist";
+    account: string | undefined | null;
+    users: ManyAccountOrMark_Address;
+};
+export type FriendslistResponse = {
+    op: "add";
+    result: ListOperationResponse;
+} | {
+    op: "remove";
+    result: ListOperationResponse;
+} | {
+    op: "clear";
+    result: ListOperationResponse;
+} | {
+    op: "get";
+    result: string[];
+} | {
+    op: "exist";
+    result: ListOperationResponse;
+};
+/**
+ * 好友列表管理 - 统一入口
+ * @param request 操作请求
+ * @returns 操作结果
+ */
+export declare function friendslist(request: FriendslistRequest): Promise<FriendslistResponse>;
+export interface GuardParam {
+    guard: string;
+    passportValiditySeconds: number;
+}
+export type GuardlistRequest = {
+    op: "add";
+    account: string | undefined | null;
+    guards: GuardParam[];
+} | {
+    op: "remove";
+    account: string | undefined | null;
+    guards: string[];
+} | {
+    op: "get";
+    account: string | undefined | null;
+};
+export type GuardlistResponse = {
+    op: "add";
+    result: ListOperationResponse;
+} | {
+    op: "remove";
+    result: ListOperationResponse;
+} | {
+    op: "get";
+    result: ListOperationResponse;
+};
+/**
+ * Guard 列表管理 - 统一入口
+ * @param request 操作请求
+ * @returns 操作结果
+ */
+export declare function guardlist(request: GuardlistRequest): Promise<GuardlistResponse>;