zego-zim-web - npm Package Compare versions

Comparing version 2.8.1 to 2.9.0

index.d.ts

@@ -20,2 +20,4 @@ export interface ZIMError {
     CommonModuleUnactivatedIMServer = 6000014,
+    CommonModuleExceedDAULimit = 6000015,
+    CommonModuleExceedMAULimit = 6000016,
     NetworkModuleCommonError = 6000101,
@@ -33,2 +35,3 @@ NetworkModuleServerError = 6000102,
     ConversationModuleConversationDoesNotExist = 6000603,
+    ConversationModuleTheNumberOfPinnedConversationsHasReachedLimit = 6000604,
     MessageModuleCommonError = 6000201,
@@ -45,2 +48,3 @@ MessageModuleServerError = 6000202,
     MessageModuleAuditFailed = 6000222,
+    MessageModuleAuditCustomSentRejected = 6000230,
     MessageModuleCallError = 6000270,
@@ -115,5 +119,2 @@ MessageModuleCancelCallError = 6000271,
     conversationTotalUnreadMessageCountUpdated: (zim: ZIM, data: ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult) => void;
-    receivePeerMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
-    receiveGroupMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
-    receiveRoomMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
     conversationMessageReceiptChanged: (zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult) => void;
@@ -123,2 +124,5 @@ messageReceiptChanged: (zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult) => void;
     messageSentStatusChanged: (zim: ZIM, data: ZIMEventOfMessageSentStatusChangedResult) => void;
+    receivePeerMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
+    receiveGroupMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
+    receiveRoomMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;
     roomStateChanged: (zim: ZIM, data: ZIMEventOfRoomStateChangedResult) => void;
@@ -140,4 +144,15 @@ roomMemberJoined: (zim: ZIM, data: ZIMEventOfRoomMemberChangedResult) => void;
     callInvitationTimeout: (zim: ZIM, data: ZIMEventOfCallInvitationTimeoutResult) => void;
+    callInvitationEnded: (zim: ZIM, data: ZIMEventOfCallInvitationEndedResult) => void;
+    callUserStateChanged: (zim: ZIM, data: ZIMEventOfCallUserStateChangedResult) => void;
+    /**
+     * @deprecated Replaced with callUserStateChanged.
+     */
     callInvitationAccepted: (zim: ZIM, data: ZIMEventOfCallInvitationAcceptedResult) => void;
+    /**
+     * @deprecated Replaced with callUserStateChanged.
+     */
     callInvitationRejected: (zim: ZIM, data: ZIMEventOfCallInvitationRejectedResult) => void;
+    /**
+     * @deprecated Replaced with callUserStateChanged.
+     */
     callInviteesAnsweredTimeout: (zim: ZIM, data: ZIMEventOfCallInviteesAnsweredTimeoutResult) => void;
@@ -159,6 +174,2 @@ }
 }
-export interface ZIMEventOfReceiveConversationMessageResult {
-    messageList: ZIMMessage[];
-    fromConversationID: string;
-}
 export interface ZIMEventOfMessageReceiptChangedResult {
@@ -173,2 +184,6 @@ infos: ZIMMessageReceiptInfo[];
 }
+export interface ZIMEventOfReceiveConversationMessageResult {
+    messageList: ZIMMessage[];
+    fromConversationID: string;
+}
 export interface ZIMEventOfRoomStateChangedResult {
@@ -233,8 +248,13 @@ roomID: string;
     callID: string;
+    mode: ZIMCallInvitationMode;
+    caller: string;
     inviter: string;
     extendedData: string;
     timeout: number;
+    createTime: number;
+    callUserList: ZIMCallUserInfo[];
 }
 export interface ZIMEventOfCallInvitationCancelledResult {
     callID: string;
+    mode: ZIMCallInvitationMode;
     inviter: string;
@@ -245,3 +265,16 @@ extendedData: string;
     callID: string;
+    mode: ZIMCallInvitationMode;
 }
+export interface ZIMEventOfCallInvitationEndedResult {
+    callID: string;
+    mode: ZIMCallInvitationMode;
+    caller: string;
+    operatedUserID: string;
+    extendedData: string;
+    endTime: number;
+}
+export interface ZIMEventOfCallUserStateChangedResult {
+    callID: string;
+    callUserList: ZIMCallUserInfo[];
+}
 export interface ZIMEventOfCallInvitationAcceptedResult {
@@ -261,2 +294,200 @@ callID: string;
 }
+export declare enum ZIMConnectionState {
+    Disconnected = 0,
+    Connecting = 1,
+    Connected = 2,
+    Reconnecting = 3
+}
+export declare enum ZIMConnectionEvent {
+    Success = 0,
+    ActiveLogin = 1,
+    LoginTimeout = 2,
+    LoginInterrupted = 3,
+    KickedOut = 4
+}
+export declare enum ZIMMessagePriority {
+    Low = 1,
+    Medium = 2,
+    High = 3
+}
+export interface ZIMAppConfig {
+    appID: number;
+}
+export interface ZIMLogConfig {
+    logLevel: string;
+}
+export interface ZIMPushConfig {
+    title: string;
+    content: string;
+    payload: string;
+    resourcesID?: string;
+}
+export interface ZIMMessageSendConfig {
+    priority: ZIMMessagePriority;
+    hasReceipt?: boolean;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMMessageRevokeConfig {
+    revokeExtendedData?: string;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMUsersInfoQueryConfig {
+    isQueryFromServer: boolean;
+}
+export interface ZIMUserInfo {
+    userID: string;
+    userName: string;
+}
+export interface ZIMUserFullInfo {
+    baseInfo: ZIMUserInfo;
+    userAvatarUrl: string;
+    extendedData: string;
+}
+export interface ZIMErrorUserInfo {
+    userID: string;
+    reason: number;
+}
+export declare type ZIMRoomMemberInfo = ZIMUserInfo;
+export interface ZIMGroupMemberInfo extends ZIMUserInfo {
+    memberAvatarUrl: string;
+    memberNickname: string;
+    memberRole: number;
+}
+export interface ZIMTokenRenewedResult {
+    token: string;
+}
+export interface ZIMUsersInfoQueriedResult {
+    userList: ZIMUserFullInfo[];
+    errorUserList: ZIMErrorUserInfo[];
+}
+export interface ZIMUserNameUpdatedResult {
+    userName: string;
+}
+export interface ZIMUserExtendedDataUpdatedResult {
+    extendedData: string;
+}
+export interface ZIMUserAvatarUrlUpdatedResult {
+    userAvatarUrl: string;
+}
+export interface ZIMRoomMemberQueriedResult {
+    roomID: string;
+    memberList: ZIMUserInfo[];
+    nextFlag: string;
+}
+export interface ZIMRoomMembersQueriedResult {
+    roomID: string;
+    memberList: ZIMRoomMemberInfo[];
+    errorUserList: ZIMErrorUserInfo[];
+}
+export interface ZIMGroupMessageReceiptMemberListQueriedResult {
+    groupID: string;
+    userList: ZIMGroupMemberInfo[];
+    nextFlag: number;
+}
+export declare enum ZIMCallInvitationMode {
+    Unknown = -1,
+    General = 0,
+    Advanced = 1
+}
+export declare enum ZIMCallState {
+    Unknown = -1,
+    Started = 1,
+    Ended = 2
+}
+export declare enum ZIMCallUserState {
+    Unknown = -1,
+    Inviting = 0,
+    Accepted = 1,
+    Rejected = 2,
+    Cancelled = 3,
+    Offline = 4,
+    Received = 5,
+    Timeout = 6,
+    Quit = 7
+}
+export interface ZIMCallUserInfo {
+    userID: string;
+    state: ZIMCallUserState;
+    extendedData: string;
+}
+export interface ZIMCallInfo {
+    callID: string;
+    caller: string;
+    mode: ZIMCallInvitationMode;
+    state: ZIMCallState;
+    extendedData: string;
+    createTime: number;
+    endTime: number;
+    callUserList: ZIMCallUserInfo[];
+}
+export interface ZIMCallInviteConfig {
+    mode: ZIMCallInvitationMode;
+    timeout: number;
+    extendedData: string;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMCallCancelConfig {
+    extendedData: string;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMCallAcceptConfig {
+    extendedData: string;
+}
+export interface ZIMCallRejectConfig {
+    extendedData: string;
+}
+export interface ZIMCallingInviteConfig {
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMCallQuitConfig {
+    extendedData: string;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMCallEndConfig {
+    extendedData: string;
+    pushConfig?: ZIMPushConfig;
+}
+export interface ZIMCallInvitationQueryConfig {
+    count: number;
+    nextFlag?: number;
+}
+export interface ZIMCallInvitationSentResult {
+    callID: string;
+    timeout: number;
+    errorUserList: ZIMErrorUserInfo[];
+    /**
+     * @deprecated
+     */
+    errorInvitees: ZIMCallUserInfo[];
+}
+export interface ZIMCallCancelSentResult {
+    callID: string;
+    errorInvitees: string[];
+}
+export interface ZIMCallAcceptanceSentResult {
+    callID: string;
+}
+export interface ZIMCallRejectionSentResult {
+    callID: string;
+}
+export interface ZIMCallingInvitationSentResult {
+    callID: string;
+    errorUserList: ZIMErrorUserInfo[];
+}
+export interface ZIMCallQuitSentResult {
+    callID: string;
+    createTime: number;
+    acceptTime: number;
+    quitTime: number;
+}
+export interface ZIMCallEndSentResult {
+    callID: string;
+    createTime: number;
+    acceptTime: number;
+    endTime: number;
+}
+export interface ZIMCallInvitationListQueriedResult {
+    callList: ZIMCallInfo[];
+    nextFlag: number;
+}
 export declare enum ZIMConversationType {
@@ -298,2 +529,6 @@ Peer = 0,
 }
+export declare enum ZIMMessageOrder {
+    Descending = 0,
+    Ascending = 1
+}
 export declare enum ZIMMessageReceiptStatus {
@@ -337,2 +572,3 @@ None = 0,
     extendedData?: string;
+    localExtendedData?: string;
 }
@@ -342,2 +578,3 @@ export interface ZIMMediaMessageBase {
     extendedData?: string;
+    localExtendedData?: string;
     /**
@@ -396,2 +633,3 @@ * Required when sending local file media message.
     type: ZIMMessageType.Revoke;
+    subType: number;
     message: string;
@@ -405,3 +643,2 @@ revokeType: ZIMRevokeType;
     originalTextMessageContent: string;
-    subType: number;
 }
@@ -448,5 +685,12 @@ export interface ZIMCustomMessage extends ZIMMessage {
 export interface ZIMMessageSentStatusChangeInfo {
+    status: ZIMMessageSentStatus;
+    reason?: string;
     message: ZIMMessage;
-    status: ZIMMessageSentStatus;
 }
+export interface ZIMConversationSearchInfo {
+    conversationID: string;
+    conversationType: ZIMConversationType;
+    totalMessageCount: number;
+    messageList: ZIMMessage[];
+}
 export interface ZIMMessageSendNotification {
@@ -478,2 +722,24 @@ onMessageAttached: (message: ZIMMessage) => void;
 }
+export interface ZIMConversationSearchConfig {
+    keywords: string[];
+    senderUserIDs: string[];
+    messageTypes: ZIMMessageType[];
+    subMessageTypes: number[];
+    startTime: number;
+    endTime: number;
+    totalConversationCount: number;
+    conversationMessageCount: number;
+    nextFlag?: number;
+}
+export interface ZIMMessageSearchConfig {
+    keywords: string[];
+    senderUserIDs: string[];
+    messageTypes: ZIMMessageType[];
+    subMessageTypes: number[];
+    startTime: number;
+    endTime: number;
+    order: ZIMMessageOrder;
+    count: number;
+    nextMessage?: ZIMMessage;
+}
 export interface ZIMConversationListQueriedResult {
@@ -510,2 +776,5 @@ conversationList: ZIMConversation[];
 }
+export interface ZIMMessageLocalExtendedDataUpdatedResult {
+    message: ZIMMessage;
+}
 export interface ZIMMessageQueriedResult {
@@ -539,135 +808,16 @@ conversationID: string;
 }
-export declare enum ZIMConnectionState {
-    Disconnected = 0,
-    Connecting = 1,
-    Connected = 2,
-    Reconnecting = 3
+export interface ZIMConversationsSearchedResult {
+    conversationSearchInfoList: ZIMConversationSearchInfo[];
+    nextFlag?: number;
 }
-export declare enum ZIMConnectionEvent {
-    Success = 0,
-    ActiveLogin = 1,
-    LoginTimeout = 2,
-    LoginInterrupted = 3,
-    KickedOut = 4
+export interface ZIMMessagesGlobalSearchedResult {
+    messageList: ZIMMessage[];
+    nextMessage?: ZIMMessage;
 }
-export declare enum ZIMMessagePriority {
-    Low = 1,
-    Medium = 2,
-    High = 3
+export interface ZIMMessagesSearchedResult {
+    conversationID: string;
+    conversationType: ZIMConversationType;
+    messageList: ZIMMessage[];
+    nextMessage?: ZIMMessage;
 }
-export interface ZIMAppConfig {
-    appID: number;
-}
-export interface ZIMLogConfig {
-    logLevel: string;
-}
-export interface ZIMPushConfig {
-    title: string;
-    content: string;
-    payload: string;
-    resourcesID?: string;
-}
-export interface ZIMCallInviteConfig {
-    timeout: number;
-    extendedData: string;
-    pushConfig?: ZIMPushConfig;
-}
-export interface ZIMMessageSendConfig {
-    priority: ZIMMessagePriority;
-    hasReceipt?: boolean;
-    pushConfig?: ZIMPushConfig;
-}
-export interface ZIMMessageRevokeConfig {
-    revokeExtendedData?: string;
-    pushConfig?: ZIMPushConfig;
-}
-export interface ZIMUsersInfoQueryConfig {
-    isQueryFromServer: boolean;
-}
-export interface ZIMUserInfo {
-    userID: string;
-    userName: string;
-}
-export interface ZIMUserFullInfo {
-    baseInfo: ZIMUserInfo;
-    userAvatarUrl: string;
-    extendedData: string;
-}
-export interface ZIMErrorUserInfo {
-    userID: string;
-    reason: number;
-}
-export declare type ZIMRoomMemberInfo = ZIMUserInfo;
-export interface ZIMGroupMemberInfo extends ZIMUserInfo {
-    memberAvatarUrl: string;
-    memberNickname: string;
-    memberRole: number;
-}
-export interface ZIMTokenRenewedResult {
-    token: string;
-}
-export interface ZIMUsersInfoQueriedResult {
-    userList: ZIMUserFullInfo[];
-    errorUserList: ZIMErrorUserInfo[];
-}
-export interface ZIMUserNameUpdatedResult {
-    userName: string;
-}
-export interface ZIMUserExtendedDataUpdatedResult {
-    extendedData: string;
-}
-export interface ZIMUserAvatarUrlUpdatedResult {
-    userAvatarUrl: string;
-}
-export interface ZIMRoomMemberQueriedResult {
-    roomID: string;
-    memberList: ZIMUserInfo[];
-    nextFlag: string;
-}
-export interface ZIMRoomMembersQueriedResult {
-    roomID: string;
-    memberList: ZIMRoomMemberInfo[];
-    errorUserList: ZIMErrorUserInfo[];
-}
-export interface ZIMGroupMessageReceiptMemberListQueriedResult {
-    groupID: string;
-    userList: ZIMGroupMemberInfo[];
-    nextFlag: number;
-}
-export declare enum ZIMCallUserState {
-    Inviting = 0,
-    Accepted = 1,
-    Rejected = 2,
-    Cancelled = 3,
-    Offline = 4,
-    Received = 5
-}
-export interface ZIMCallUserInfo {
-    userID: string;
-    state: ZIMCallUserState;
-}
-export interface ZIMCallCancelConfig {
-    extendedData: string;
-}
-export interface ZIMCallAcceptConfig {
-    extendedData: string;
-}
-export interface ZIMCallRejectConfig {
-    extendedData: string;
-}
-export interface ZIMCallAcceptanceSentResult {
-    callID: string;
-}
-export interface ZIMCallRejectionSentResult {
-    callID: string;
-}
-export interface ZIMCallInvitationSentResult {
-    callID: string;
-    timeout: number;
-    errorInvitees: ZIMCallUserInfo[];
-}
-export interface ZIMCallCancelSentResult {
-    callID: string;
-    errorInvitees: string[];
-}
 export declare enum ZIMGroupMessageNotificationStatus {
@@ -719,2 +869,6 @@ Notify = 1,
 export interface ZIMGroupOperatedInfo {
+    userID: string;
+    userName: string;
+    memberNickname: string;
+    memberRole: number;
     /**
@@ -724,6 +878,2 @@ * @deprecated Use tiled properties.
     operatedUserInfo: ZIMGroupMemberInfo;
-    userID: string;
-    userName: string;
-    memberNickname: string;
-    memberRole: number;
 }
@@ -734,2 +884,6 @@ export interface ZIMGroupAttributesUpdateInfo {
 }
+export interface ZIMGroupSearchInfo {
+    groupInfo: ZIMGroupInfo;
+    userList: ZIMGroupMemberInfo[];
+}
 export interface ZIMGroupAdvancedConfig {
@@ -743,2 +897,15 @@ groupNotice: string;
 }
+export interface ZIMGroupSearchConfig {
+    keywords: string[];
+    isAlsoMatchGroupMemberUserName: boolean;
+    isAlsoMatchGroupMemberNickname: boolean;
+    count: number;
+    nextFlag: number;
+}
+export interface ZIMGroupMemberSearchConfig {
+    keywords: string[];
+    isAlsoMatchGroupMemberNickname: boolean;
+    count: number;
+    nextFlag: number;
+}
 export interface ZIMGroupLeftResult {
@@ -821,2 +988,11 @@ groupID: string;
 }
+export interface ZIMGroupsSearchedResult {
+    groupSearchInfoList: ZIMGroupSearchInfo[];
+    nextFlag: number;
+}
+export interface ZIMGroupMembersSearchedResult {
+    groupID: string;
+    userList: ZIMGroupMemberInfo[];
+    nextFlag: number;
+}
 export declare enum ZIMRoomState {
@@ -939,2 +1115,4 @@ Disconnected = 0,
     static getVersion(): string;
+    static getInstance(): ZIM;
+    static setAdvancedConfig(key: string, value: string): void;
     /**
@@ -945,4 +1123,2 @@ * @deprecated Use overloaded methods.
     static create(appConfig: ZIMAppConfig): ZIM | null;
-    static getInstance(): ZIM;
-    static setAdvancedConfig(key: string, value: string): void;
     destroy(): void;
@@ -985,2 +1161,3 @@ setLogConfig(config: ZIMLogConfig): void;
     insertMessageToLocalDB(message: ZIMMessageBase | ZIMMediaMessageBase, conversationID: string, conversationType: ZIMConversationType, senderUserID: string): Promise<ZIMMessageInsertedResult>;
+    updateMessageLocalExtendedData(localExtendedData: string, message: ZIMMessage): Promise<ZIMMessageLocalExtendedDataUpdatedResult>;
     sendConversationMessageReceiptRead(conversationID: string, conversationType: ZIMConversationType): Promise<ZIMConversationMessageReceiptReadSentResult>;
@@ -1032,3 +1209,12 @@ sendMessageReceiptsRead(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): Promise<ZIMMessageReceiptsReadSentResult>;
     callReject(callID: string, config: ZIMCallRejectConfig): Promise<ZIMCallRejectionSentResult>;
+    callQuit(callID: string, config: ZIMCallQuitConfig): Promise<ZIMCallQuitSentResult>;
+    callEnd(callID: string, config: ZIMCallEndConfig): Promise<ZIMCallEndSentResult>;
+    callingInvite(invitees: string[], callID: string, config: ZIMCallingInviteConfig): Promise<ZIMCallingInvitationSentResult>;
+    queryCallInvitationList(config: ZIMCallInvitationQueryConfig): Promise<ZIMCallInvitationListQueriedResult>;
+    searchLocalConversations(config: ZIMConversationSearchConfig): Promise<ZIMConversationsSearchedResult>;
+    searchGlobalLocalMessages(config: ZIMMessageSearchConfig): Promise<ZIMMessagesGlobalSearchedResult>;
+    searchLocalMessages(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSearchConfig): Promise<ZIMMessagesSearchedResult>;
+    searchLocalGroups(config: ZIMGroupSearchConfig): Promise<ZIMGroupsSearchedResult>;
+    searchLocalGroupMembers(groupID: string, config: ZIMGroupMemberSearchConfig): Promise<ZIMGroupMembersSearchedResult>;
 }
 export { ZIM };

package.json

 {
   "name": "zego-zim-web",
-  "version": "2.8.1",
+  "version": "2.9.0",
   "description": "ZEGO ZIM SDK for Web",
@@ -5,0 +5,0 @@ "main": "index.js",

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

843184

increased by7.17%

Lines of code

1191

increased by18.51%

Number of high maintenance alerts

0

decreased by-100%

No dependency changes