@onyx-p/imlib-web 1.2.3 → 1.2.4

package/{types → dist/types}/types.d.ts

@@ -1,8 +1,7 @@
 import { BaseMessage, IExtraData, IUserInfo } from './model/baseMessage';
 import IReceivedMessage from './model/iReceivedMessage';
-import { ConnectionStatus, ConversationType, ErrorCode, IUserProfile, MessageDirection, NotificationLevel, NotificationStatus } from './model/statusTypes';
+import { ConnectionStatus, ConversationType, ErrorCode, MessageDirection, NotificationLevel, NotificationStatus } from './model/statusTypes';
 import IReceivedConversation from './model/iReceivedConversation';
-import Long from 'long';
 export declare enum LogLevel {
     DEBUG = 0,
     INFO = 1,
@@ -22,11 +21,14 @@ export type IInitOption = {
      */
     logStdout?: (logLevel: LogLevel, content: string) => void;
     serverInfo?: string;
+    uploader?: IUploader;
+    deviceCode: string;
+    deviceType: number;
 };
 export interface ProfileInfo {
-    deviceId: Long;
-    sessionId: Long;
-    uid: Long;
+    deviceId: string;
+    sessionId: string;
+    uid: string;
 }
 export declare enum Events {
     CONNECTING = "CONNECTING",
@@ -35,7 +37,25 @@ export declare enum Events {
     SUSPEND = "SUSPEND",
     MESSAGES = "MESSAGES",
     PULL_OFFLINE_MESSAGE_FINISHED = "PULL_OFFLINE_MESSAGE_FINISHED",
-    CONVERSATION = "CONVERSATION"
+    CONVERSATION = "CONVERSATION",
+    PUSH = "PUSH",
+    RECALL = "RECALL",
+    ARRIVAL_RECEIPT_RECEIVED = "ARRIVAL_RECEIPT_RECEIVED",
+    READ_RECEIPT_RECEIVED = "READ_RECEIPT_RECEIVED"
+}
+/**
+ * 收到已读/已发送回执数据结构
+ * @category Interface
+ */
+export interface IReceiptReceivedEvent {
+    /**
+     * 会话信息，包含会话属性
+     */
+    conversation: IConversationOption;
+    /**
+     * 消息的id列表
+     */
+    messageUIdList: string[];
 }
 export type EventListeners = {
     [Events.CONNECTING]: () => void;
@@ -49,11 +69,17 @@ export type EventListeners = {
     [Events.CONVERSATION]: (event: {
         conversations: IUpdatedConversation[];
     }) => void;
+    [Events.PUSH]: (event: {
+        cmdId: number;
+        body: Uint8Array;
+    }) => void;
+    [Events.RECALL]: (messageUId: string) => void;
+    [Events.ARRIVAL_RECEIPT_RECEIVED]: (event: IReceiptReceivedEvent) => void;
+    [Events.READ_RECEIPT_RECEIVED]: (event: IReceiptReceivedEvent) => void;
 };
 export interface IBaseConversationInfo {
     conversationType: ConversationType;
     targetId: string;
-    channelId?: string;
 }
 export interface IConversationState extends IBaseConversationInfo {
     unreadCount: number;
@@ -61,12 +87,15 @@ export interface IConversationState extends IBaseConversationInfo {
     notificationLevel: NotificationLevel;
     notificationStatus: NotificationStatus;
     isTop: boolean;
+    dialogTitle: string | null | undefined;
+    smallAvatarUrl: string | null | undefined;
+    updateTime: number | null | undefined;
 }
 /**
  * 会话信息
  */
 export type IConversationOption = IBaseConversationInfo;
-export type IUpdatedConversationItemKeys = Extract<keyof IReceivedConversation, 'isTop' | 'notificationStatus' | 'notificationLevel' | 'unreadMessageCount' | 'hasMentioned' | 'unreadMentionedCount' | 'latestMessage'>;
+export type IUpdatedConversationItemKeys = Extract<keyof IReceivedConversation, 'isTop' | 'notificationStatus' | 'notificationLevel' | 'unreadMessageCount' | 'hasMentioned' | 'unreadMentionedCount' | 'dialogTitle' | 'smallAvatarUrl' | 'latestMessage' | 'burnAfterReadingFlag' | 'burnAfterReadingTime'>;
 export type IUpdatedConversationItem = Partial<Record<IUpdatedConversationItemKeys, {
     time: number;
     val: any;
@@ -105,10 +134,6 @@ export type IPushConfig = {
  * 发送消息时的可选项信息
  */
 export interface ISendMessageOptions {
-    /**
-     * 用于发送群定向消息，只当 conversationType 值为 `ConversationType.GROUP` 时有效
-     */
-    directionalUserIdList?: string[];
     /**
      * 消息发送之前的回调
      */
@@ -118,7 +143,7 @@ export interface ISendMessageOptions {
      * 当要重发消息时所有参数需与原始消息参数一致，messageId 必须存在。
      * 正常发消息时无需传该参数。
      */
-    messageId?: number;
+    messageId?: string;
     /**
      * 推送配置，用于配置移动端远程推送的推送栏显示内容
      */
@@ -141,9 +166,20 @@ export interface IUploadHooks {
     /**
      * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
      */
-    onComplete?: (fileInfo: {
-        url: string;
-    }) => void | BaseMessage;
+    onComplete?: (fileInfo: IUploadCompletedResult) => void | BaseMessage;
+}
+export type IUploadCompletedResult = {
+    urls: string[];
+    encryptedKey?: string;
+};
+export type IUploadCallback = {
+    onProgress?: (progress: number) => void;
+    onCompleted?: (result: IUploadCompletedResult) => void;
+    onError?: (reason: string) => void;
+};
+export interface IUploader {
+    upload(files: Blob[], callback: IUploadCallback): void;
+    cancel(): void;
 }
 /**
  * 文件消息配置
@@ -170,31 +206,9 @@ export interface IThumbnailConfig {
  */
 export interface IRecallMessageOptions {
     /**
-     * 消息的唯一id，客户端依赖此属性查找要撤回的消息
+     * 消息的唯一id，服务端依赖此属性删除要撤回的消息
      */
     messageUId: string;
-    /**
-     * 消息发送时间，服务端依赖此属性查找要撤回的消息
-     */
-    sentTime: number;
-    /**
-     * 撤回消息携带用户信息
-     */
-    user?: IUserProfile;
-    /**
-     * 是否发送静默消息
-     * @description
-     * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
-     */
-    disableNotification?: boolean;
-    /**
-     * 撤回消息携带扩展信息
-     */
-    extra?: string;
-    /**
-     * 是否删除原始消息(在移动端会使用到)，为 true 时移动端会不显示小灰条提示
-     */
-    isDelete?: boolean;
 }
 /**
  * 获取远程消息 option 参数
@@ -203,7 +217,7 @@ export type GetHistoryMessageOption = {
     /**
      * 获取此时间之前的消息，0 为从当前时间拉取
      */
-    timestamp?: number;
+    timestamp?: string;
     /**
      * 获取消息的数量，范围: 1-20
      */

package/package.json

@@ -1,18 +1,70 @@
 {
   "name": "@onyx-p/imlib-web",
-  "version": "1.2.3",
-  "main": "index.umd.js",
-  "module": "index.esm.js",
-  "types": "types/index.d.ts",
+  "version": "1.2.4",
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "clean:dist": "rimraf dist",
+    "build:types": "npm run clean:dist && tsc -b ./tsconfig.types.json",
+    "build": "npm run build:types && rollup -c --bundleConfigAsCjs && node scripts/prepare-publish.js",
+    "dev": "npm run clean:dist && rollup -c --bundleConfigAsCjs",
+    "test": "node test/test.js"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.26.0",
+    "@babel/plugin-transform-runtime": "^7.25.9",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/runtime-corejs3": "^7.26.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@types/crypto-js": "^4.2.2",
+    "@types/node": "^22.10.2",
+    "electron": "^30.0.0",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "prettier": "^3.4.2",
+    "rollup": "^3.28.0",
+    "rollup-plugin-bundle-size": "^1.0.3",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "rollup-plugin-re": "^1.0.7",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "rollup-plugin-visualizer": "^5.12.0",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2"
+  },
   "files": [
-    "index.umd.js",
-    "index.esm.js",
-    "types/index.d.ts",
-    "types/types.d.ts",
-    "types/model",
+    "dist/index.umd.js",
+    "dist/index.esm.js",
+    "dist/types/index.d.ts",
+    "dist/types/types.d.ts",
+    "dist/types/model",
     "README.md"
   ],
-  "keywords": ["im"],
-  "author": "zimu",
-  "license": "MIT"
-} 
+  "dependencies": {
+    "crypto-js": "^4.2.0",
+    "electron-store": "^10.0.1",
+    "long": "^5.2.3",
+    "protobufjs": "^7.4.0"
+  },
+  "peerDependencies": {
+    "electron": ">=10.0.0"
+  },
+  "description": "",
+  "directories": {
+    "example": "examples",
+    "lib": "lib",
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "keywords": [
+    "im"
+  ],
+  "author": "zimu"
+}

package/types/model/messages/commandMessage.d.ts

@@ -1,20 +0,0 @@
-import { BaseMessage, IExtraData, IUserInfo, MessageCodingData } from '../baseMessage';
-/**
- * 命令消息
- */
-export interface ICommandMessageBody extends IUserInfo, IExtraData {
-    /**
-     * 命令名称
-     */
-    name: string;
-    /**
-     * 命令的扩展数据，可以为任意字符串，如存放您定义的json数据。
-     */
-    data: string;
-}
-export default class CommandMessage extends BaseMessage<ICommandMessageBody> {
-    constructor(content: ICommandMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<ICommandMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/custMessage.d.ts

@@ -1,34 +0,0 @@
-import { BaseMessage, IBaseMessageBody, MessageCodingData } from '../baseMessage';
-declare class CustBaseMessage extends BaseMessage {
-    static decode(aDecoder: MessageCodingData): BaseMessage<IBaseMessageBody>;
-    encode(): MessageCodingData;
-}
-/**
- * 自定义命令消息(不存储，不计数)
- */
-export declare class CustCommandMessage<T> extends CustBaseMessage {
-    constructor(messageType: string, content: T);
-    static getObjectId(): number;
-}
-/**
- * 自定义存储消息(存储，不计数)
- */
-export declare class CustStorageMessage<T> extends CustBaseMessage {
-    constructor(messageType: string, content: T);
-    static getObjectId(): number;
-}
-/**
- * 自定义普通消息(存储，且计数)
- */
-export declare class CustNormalMessage<T> extends CustBaseMessage {
-    constructor(messageType: string, content: T);
-    static getObjectId(): number;
-}
-/**
- * 自定义状态消息
- */
-export declare class CustStatusMessage<T> extends CustBaseMessage {
-    constructor(messageType: string, content: T);
-    static getObjectId(): number;
-}
-export {};

package/types/model/messages/fileMessage.d.ts

@@ -1,25 +0,0 @@
-import { BaseMessage, IExtraData, IMentionedInfo, IUserInfo, MessageCodingData } from '../baseMessage';
-export interface IFileMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
-    /**
-     * 文件名称
-     */
-    name: string;
-    /**
-     * 文件尺寸，单位: Byte
-     */
-    size: number;
-    /**
-     * 文件类型
-     */
-    type: string;
-    /**
-     * 远程文件资源地址
-     */
-    fileUrl: string;
-}
-export default class FileMessage extends BaseMessage<IFileMessageBody> {
-    constructor(content: IFileMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<IFileMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/gifMessage.d.ts

@@ -1,28 +0,0 @@
-import { IUserInfo, IExtraData, BaseMessage, MessageCodingData } from '../baseMessage';
-/**
- * GIF 消息
- */
-export interface IGIFMessageBody extends IExtraData, IUserInfo {
-    /**
-     * GIF 图片文件大小，单位为 KB
-     */
-    gifDataSize: number;
-    /**
-     * GIF 图片资源 url 地址
-     */
-    remoteUrl: string;
-    /**
-     * 图片宽度
-     */
-    width: number;
-    /**
-     * 图片高度
-     */
-    height: number;
-}
-export default class GIFMessage extends BaseMessage<IGIFMessageBody> {
-    constructor(content: IGIFMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<IGIFMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/imageMessage.d.ts

@@ -1,32 +0,0 @@
-import { IUserInfo, IExtraData, IMentionedInfo, BaseMessage, MessageCodingData } from '../baseMessage';
-/**
- * 图片消息
- */
-export interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
-    /**
-     * 图片的略缩图
-     * @description
-     * 1. 必须是 base64 字符串, 图片类型为 JPG
-     * 2. base64 字符串大小不可超过 80 KB
-     * 3. 字符串前无媒体类型前缀
-     */
-    content: string;
-    /**
-     * 原图远程地址
-     */
-    imageUri: string;
-    /**
-     * 图片的宽
-     */
-    width?: number;
-    /**
-     * 图片的高
-     */
-    height?: number;
-}
-export default class ImageMessage extends BaseMessage<IImageMessageBody> {
-    constructor(content: IImageMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<IImageMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/index.d.ts

@@ -1,10 +0,0 @@
-import TextMessage, { ITextMessageBody } from './textMessage';
-import ImageMessage, { IImageMessageBody } from './imageMessage';
-import GIFMessage, { IGIFMessageBody } from './gifMessage';
-import HQVoiceMessage, { IHQVoiceMessageBody } from './voiceMessage';
-import FileMessage, { IFileMessageBody } from './fileMessage';
-import RecallCommandMessage, { IRecallCommandMessageBody } from './recallCommandMessage';
-import CommandMessage, { ICommandMessageBody } from './commandMessage';
-import { CustCommandMessage, CustNormalMessage, CustStorageMessage, CustStatusMessage } from './custMessage';
-export { TextMessage, ImageMessage, GIFMessage, HQVoiceMessage, FileMessage, CustCommandMessage, CustNormalMessage, CustStorageMessage, CustStatusMessage, RecallCommandMessage, CommandMessage };
-export type { ITextMessageBody, IImageMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IFileMessageBody, IRecallCommandMessageBody, ICommandMessageBody };

package/types/model/messages/recallCommandMessage.d.ts

@@ -1,18 +0,0 @@
-import { BaseMessage, IBaseMessageBody, MessageCodingData } from '../baseMessage';
-import { ConversationType } from '../statusTypes';
-/**
- *  撤回通知消息（被撤回消息摘要）
- */
-export interface IRecallCommandMessageBody extends IBaseMessageBody {
-    sentTime: number;
-    messageUId: string;
-    conversationType: ConversationType;
-    targetId: string;
-    channelId?: string;
-}
-export default class RecallCommandMessage extends BaseMessage<IRecallCommandMessageBody> {
-    constructor(content: IRecallCommandMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<IRecallCommandMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/textMessage.d.ts

@@ -1,16 +0,0 @@
-import { BaseMessage, IExtraData, IMentionedInfo, IUserInfo, MessageCodingData } from '../baseMessage';
-/**
- * 文本消息
- */
-export interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
-    /**
-     * 文本消息内容
-     */
-    content: string;
-}
-export default class TextMessage extends BaseMessage<ITextMessageBody> {
-    constructor(content: ITextMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<ITextMessageBody>;
-    encode(): MessageCodingData;
-}

package/types/model/messages/voiceMessage.d.ts

@@ -1,21 +0,0 @@
-import { BaseMessage, IExtraData, IMentionedInfo, IUserInfo, MessageCodingData } from '../baseMessage';
-export interface IHQVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
-    /**
-     * 远程媒体资源地址
-     */
-    remoteUrl: string;
-    /**
-     * 语音消息的时长，最大值为 60 （单位：秒）
-     */
-    duration: number;
-    /**
-     * 编解码类型，默认为 aac 音频
-     */
-    type?: string;
-}
-export default class HQVoiceMessage extends BaseMessage<IHQVoiceMessageBody> {
-    constructor(content: IHQVoiceMessageBody);
-    static getObjectId(): number;
-    static decode(aDecoder: MessageCodingData): BaseMessage<IHQVoiceMessageBody>;
-    encode(): MessageCodingData;
-}