@onyx-p/imlib-web 1.2.2 → 1.2.4

package/dist/types/types.d.ts

@@ -0,0 +1,297 @@
+import { BaseMessage, IExtraData, IUserInfo } from './model/baseMessage';
+import IReceivedMessage from './model/iReceivedMessage';
+import { ConnectionStatus, ConversationType, ErrorCode, MessageDirection, NotificationLevel, NotificationStatus } from './model/statusTypes';
+import IReceivedConversation from './model/iReceivedConversation';
+export declare enum LogLevel {
+    DEBUG = 0,
+    INFO = 1,
+    WARN = 2,
+    ERROR = 3,
+    FATAL = 4,
+    NONE = 1000
+}
+export type IInitOption = {
+    appkey: string;
+    /**
+     * 修改 engine log 打印等级
+     */
+    logLevel?: LogLevel;
+    /**
+     * 修改默认的 log 输出函数
+     */
+    logStdout?: (logLevel: LogLevel, content: string) => void;
+    serverInfo?: string;
+    uploader?: IUploader;
+    deviceCode: string;
+    deviceType: number;
+};
+export interface ProfileInfo {
+    deviceId: string;
+    sessionId: string;
+    uid: string;
+}
+export declare enum Events {
+    CONNECTING = "CONNECTING",
+    CONNECTED = "CONNECTED",
+    DISCONNECT = "DISCONNECT",
+    SUSPEND = "SUSPEND",
+    MESSAGES = "MESSAGES",
+    PULL_OFFLINE_MESSAGE_FINISHED = "PULL_OFFLINE_MESSAGE_FINISHED",
+    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;
+    [Events.CONNECTED]: () => void;
+    [Events.DISCONNECT]: (status: ConnectionStatus) => void;
+    [Events.SUSPEND]: (status: ConnectionStatus | ErrorCode) => void;
+    [Events.MESSAGES]: (events: {
+        messages: IReceivedMessage[];
+    }) => void;
+    [Events.PULL_OFFLINE_MESSAGE_FINISHED]: () => void;
+    [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;
+}
+export interface IConversationState extends IBaseConversationInfo {
+    unreadCount: number;
+    unreadMentionedCount: number;
+    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' | 'dialogTitle' | 'smallAvatarUrl' | 'latestMessage' | 'burnAfterReadingFlag' | 'burnAfterReadingTime'>;
+export type IUpdatedConversationItem = Partial<Record<IUpdatedConversationItemKeys, {
+    time: number;
+    val: any;
+}>>;
+/**
+ * 会话更新内容
+ */
+export type IUpdatedConversation = {
+    conversation: IReceivedConversation;
+    updatedItems: IUpdatedConversationItem;
+};
+/**
+ * 消息的推送配置
+ */
+export type IPushConfig = {
+    /**
+     * 推送标题
+   如果没有设置，会使用下面的默认标题显示规则
+   默认标题显示规则：
+      内置消息：单聊通知标题显示为发送者名称，群聊通知标题显示为群名称。
+      自定义消息：默认不显示标题。
+     */
+    pushTitle?: string;
+    /**
+     * 推送内容 在通知栏里会显示这个字段
+     * 自定义消息，该字段必须填写，否则无法收到 push 消息.
+       SDK 中默认的消息类型(如 RC:TxtMsg, RC:VcMsg, RC:ImgMsg) 默认已经指定, 可设置为 nil
+     */
+    pushContent?: string;
+    /**
+     * 远程推送附加信息
+     */
+    pushData?: string;
+};
+/**
+ * 发送消息时的可选项信息
+ */
+export interface ISendMessageOptions {
+    /**
+     * 消息发送之前的回调
+     */
+    onSendBefore?: (message: IReceivedMessage) => void;
+    /**
+     * 重发消息时用到，重发消息的 messageId。
+     * 当要重发消息时所有参数需与原始消息参数一致，messageId 必须存在。
+     * 正常发消息时无需传该参数。
+     */
+    messageId?: string;
+    /**
+     * 推送配置，用于配置移动端远程推送的推送栏显示内容
+     */
+    pushConfig?: IPushConfig;
+}
+/**
+ * 要发送的文件信息(本地资源)
+ */
+export type ISendBody = IUserInfo & IExtraData & {
+    file: Blob;
+};
+/**
+ * 上传过程中的回调钩子
+ */
+export interface IUploadHooks {
+    /**
+     * 文件上传进度回调
+     */
+    onProgress?: (progress: number) => void;
+    /**
+     * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
+     */
+    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;
+}
+/**
+ * 文件消息配置
+ */
+export interface IUploadMessageOption extends ISendMessageOptions {
+}
+/**
+ * 图片消息配置
+ */
+export interface IImageMessageOption extends IUploadMessageOption {
+    thumbnailConfig?: IThumbnailConfig;
+}
+/**
+ * 缩略图配置
+ */
+export interface IThumbnailConfig {
+    maxHeight?: number;
+    maxWidth?: number;
+    quality?: number;
+    scale?: number;
+}
+/**
+ * 撤回消息 option 参数
+ */
+export interface IRecallMessageOptions {
+    /**
+     * 消息的唯一id，服务端依赖此属性删除要撤回的消息
+     */
+    messageUId: string;
+}
+/**
+ * 获取远程消息 option 参数
+ */
+export type GetHistoryMessageOption = {
+    /**
+     * 获取此时间之前的消息，0 为从当前时间拉取
+     */
+    timestamp?: string;
+    /**
+     * 获取消息的数量，范围: 1-20
+     */
+    count?: number;
+    /**
+     * 查询消息的方向
+     * * 0: 以 timestamp 为基准向前查询
+     * * 1: 以 timestamp 为基准向后查询
+     */
+    order?: 0 | 1;
+};
+/**
+ * 获取远程消息回调结果
+ */
+export type GetHistoryMessageResult = {
+    list: IReceivedMessage[];
+    hasMore: boolean;
+};
+export type IDeleteMessageOptions = {
+    /**
+     * 消息 id
+     */
+    messageUId: string;
+    /**
+     * 消息发送时间
+     */
+    sentTime?: number;
+    /**
+     * 消息方向
+     * * 1: 发送
+     * * 2: 接收
+     */
+    messageDirection?: MessageDirection;
+};
+export type IGetConversationListOptions = {
+    /**
+     * 会话数量
+     */
+    count?: number;
+    /**
+     * 获取起始时间
+     * 默认值: 0
+     * order 为 0 startTime 默认值为当前时间，将返回最新的会话列表
+     * order 为 1 startTime 默认值为所有会话中最早的消息时间，将返回最早的会话列表数据
+     */
+    startTime?: number;
+    /**
+     * 查询顺序
+     * 默认值: 0
+     * 0 获取 startTime 之前的
+     * 1 获取 startTime 之后的
+     */
+    order?: 0 | 1;
+};
+/**
+ * 异步任务回调
+ */
+export interface IAsyncRes<T = any> {
+    /**
+     * Promise 执行结果
+     */
+    code: ErrorCode;
+    /**
+     * 结果数据
+     */
+    data?: T;
+    /**
+     * 错误消息
+     */
+    msg?: string;
+}
+/**
+ * 异步任务结果定义
+ * @description
+ * 通过 `Promise.resolve` 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常
+ */
+export type IPromiseResult<T> = Promise<IAsyncRes<T>>;

package/package.json

@@ -1,9 +1,41 @@
 {
   "name": "@onyx-p/imlib-web",
-  "version": "1.2.2",
+  "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": [
     "dist/index.umd.js",
     "dist/index.esm.js",
@@ -12,7 +44,27 @@
     "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"
+}