sim-sdk-web 1.0.2 → 1.0.6

package/lib/types/entity.d.ts

@@ -0,0 +1,400 @@
+import { RequestApi } from '../constant/api';
+import type { AllowType, ApplicationHandleResult, GroupJoinSource, GroupMemberRole, GroupStatus, GroupType, GroupVerificationType, MessageReceiveOptType, MessageType, OnlineState, Platform, Relationship, SessionType } from './enum';
+import { HttpMethod } from '../utils/request';
+export interface WsRequest {
+    url: RequestApi;
+    username?: string;
+    data: Record<string, any> | undefined;
+    method: HttpMethod;
+}
+export interface SseResponse<T = unknown> {
+    type?: MessageType;
+    code: number;
+    msg: string;
+    data: T;
+    timestamp?: number;
+}
+export interface PromiseMap {
+    resolve: (response: SseResponse) => void;
+    reject: (response: SseResponse) => void;
+}
+export type Pagination = {
+    offset: number;
+    count: number;
+};
+export type MessageEntity = {
+    type: string;
+    offset: number;
+    length: number;
+    url?: string;
+    info?: string;
+};
+export type PicBaseInfo = {
+    uuid: string;
+    type: string;
+    size: number;
+    width: number;
+    height: number;
+    url: string;
+};
+export type AtUsersInfoItem = {
+    atUserID: string;
+    groupNickname: string;
+};
+export type GroupApplicationItem = {
+    createTime: number;
+    creatorUserID: string;
+    ex: string;
+    groupFaceURL: string;
+    groupID: string;
+    groupName: string;
+    groupType: GroupType;
+    handleResult: ApplicationHandleResult;
+    handleUserID: string;
+    handledMsg: string;
+    handledTime: number;
+    introduction: string;
+    memberCount: number;
+    nickname: string;
+    notification: string;
+    ownerUserID: string;
+    reqMsg: string;
+    reqTime: number;
+    joinSource: GroupJoinSource;
+    status: GroupStatus;
+    userFaceURL: string;
+    userId: string;
+};
+export type FriendApplicationItem = {
+    createTime: number;
+    ex: string;
+    fromFaceURL: string;
+    fromNickname: string;
+    fromUserID: string;
+    handleMsg: string;
+    handleResult: ApplicationHandleResult;
+    handleTime: number;
+    handlerUserID: string;
+    reqMsg: string;
+    toFaceURL: string;
+    toNickname: string;
+    toUserID: string;
+};
+export type FullUserItem = {
+    blackInfo: BlackUserItem | null;
+    friendInfo: FriendUserItem | null;
+    publicInfo: PublicUserItem | null;
+};
+export type FullUserItemWithCache = {
+    blackInfo: BlackUserItem | null;
+    friendInfo: FriendUserItem | null;
+    publicInfo: PublicUserItem | null;
+    groupMemberInfo: GroupMemberItem | null;
+};
+export type PublicUserItem = {
+    nickname: string;
+    userId: string;
+    faceURL: string;
+    ex: string;
+};
+export type SelfUserInfo = {
+    createTime: number;
+    ex: string;
+    faceURL: string;
+    nickname: string;
+    userId: string;
+    globalRecvMsgOpt: MessageReceiveOptType;
+};
+export type PartialUserInfo = {
+    userId: string;
+} & Partial<Omit<SelfUserInfo, 'userId'>>;
+export type FriendUserItem = {
+    addSource: number;
+    createTime: number;
+    ex: string;
+    faceURL: string;
+    userId: string;
+    nickname: string;
+    operatorUserID: string;
+    ownerUserID: string;
+    remark: string;
+    attachedInfo: string;
+};
+export type SearchedFriendsInfo = FriendUserItem & {
+    relationship: Relationship;
+};
+export type FriendshipInfo = {
+    result: number;
+    userId: string;
+};
+export type BlackUserItem = {
+    addSource: number;
+    userId: string;
+    createTime: number;
+    ex: string;
+    faceURL: string;
+    nickname: string;
+    operatorUserID: string;
+    ownerUserID: string;
+};
+export type GroupItem = {
+    groupID: string;
+    groupName: string;
+    notification: string;
+    notificationUserID: string;
+    notificationUpdateTime: number;
+    introduction: string;
+    faceURL: string;
+    ownerUserID: string;
+    createTime: number;
+    memberCount: number;
+    status: GroupStatus;
+    creatorUserID: string;
+    groupType: GroupType;
+    needVerification: GroupVerificationType;
+    ex: string;
+    applyMemberFriend: AllowType;
+    lookMemberInfo: AllowType;
+};
+export type GroupMemberItem = {
+    groupID: string;
+    userId: string;
+    nickname: string;
+    faceURL: string;
+    roleLevel: GroupMemberRole;
+    muteEndTime: number;
+    joinTime: number;
+    joinSource: GroupJoinSource;
+    inviterUserID: string;
+    operatorUserID: string;
+    ex: string;
+};
+export type ConversationItem = {
+    id: number;
+    name: string;
+    groupType: number;
+    avatar: string;
+    status: number;
+    latest: MessageItem;
+};
+export type MessageItem = {
+    id: number;
+    msgId: string;
+    groupType: number;
+    groupId: number;
+    replyMsgId: number;
+    clientMsgId: string;
+    userId: number;
+    send: number;
+    to: number;
+    msgType: number;
+    text?: string;
+    link?: string;
+    snapshot?: string;
+    createTime: Date;
+    updateTime?: Date;
+    status: number;
+};
+export type TextElem = {
+    content: string;
+};
+export type CardElem = {
+    userId: string;
+    nickname: string;
+    faceURL: string;
+    ex: string;
+};
+export type AtTextElem = {
+    text: string;
+    atUserList: string[];
+    atUsersInfo?: AtUsersInfoItem[];
+    quoteMessage?: MessageItem;
+    isAtSelf?: boolean;
+};
+export type NotificationElem = {
+    detail: string;
+};
+export type AdvancedTextElem = {
+    text: string;
+    messageEntityList: MessageEntity[];
+};
+export type TypingElem = {
+    msgTips: string;
+};
+export type CustomElem = {
+    data: string;
+    description: string;
+    extension: string;
+};
+export type FileElem = {
+    filePath: string;
+    uuid: string;
+    sourceUrl: string;
+    fileName: string;
+    fileSize: number;
+};
+export type FaceElem = {
+    index: number;
+    data: string;
+};
+export type LocationElem = {
+    description: string;
+    longitude: number;
+    latitude: number;
+};
+export type MergeElem = {
+    title: string;
+    abstractList: string[];
+    multiMessage: MessageItem[];
+    messageEntityList: MessageEntity[];
+};
+export type OfflinePush = {
+    title: string;
+    desc: string;
+    ex: string;
+    iOSPushSound: string;
+    iOSBadgeCount: boolean;
+};
+export type PictureElem = {
+    sourcePath: string;
+    sourcePicture: Picture;
+    bigPicture: Picture;
+    snapshotPicture: Picture;
+};
+export type AttachedInfoElem = {
+    groupHasReadInfo: GroupHasReadInfo;
+    isPrivateChat: boolean;
+    isEncryption: boolean;
+    inEncryptStatus: boolean;
+    burnDuration: number;
+    hasReadTime: number;
+    notSenderNotificationPush: boolean;
+    messageEntityList: MessageEntity[];
+    uploadProgress: UploadProgress;
+};
+export type UploadProgress = {
+    total: number;
+    save: number;
+    current: number;
+};
+export type GroupHasReadInfo = {
+    hasReadCount: number;
+    unreadCount: number;
+    hasReadUserIDList: string[];
+    groupMemberCount: number;
+};
+export type Picture = {
+    uuid: string;
+    type: string;
+    size: number;
+    width: number;
+    height: number;
+    url: string;
+};
+export type QuoteElem = {
+    text: string;
+    quoteMessage: MessageItem;
+};
+export type SoundElem = {
+    uuid: string;
+    soundPath: string;
+    sourceUrl: string;
+    dataSize: number;
+    duration: number;
+};
+export type VideoElem = {
+    videoPath: string;
+    videoUUID: string;
+    videoUrl: string;
+    videoType: string;
+    videoSize: number;
+    duration: number;
+    snapshotPath: string;
+    snapshotUUID: string;
+    snapshotSize: number;
+    snapshotUrl: string;
+    snapshotWidth: number;
+    snapshotHeight: number;
+};
+export type AdvancedRevokeContent = {
+    clientMsgID: string;
+    revokeTime: number;
+    revokerID: string;
+    revokerNickname: string;
+    revokerRole: number;
+    seq: number;
+    sessionType: SessionType;
+    sourceMessageSendID: string;
+    sourceMessageSendTime: number;
+    sourceMessageSenderNickname: string;
+};
+export type RevokedInfo = {
+    revokerID: string;
+    revokerRole: number;
+    clientMsgID: string;
+    revokerNickname: string;
+    revokeTime: number;
+    sourceMessageSendTime: number;
+    sourceMessageSendID: string;
+    sourceMessageSenderNickname: string;
+    sessionType: number;
+    seq: number;
+    ex: string;
+};
+export type ReceiptInfo = {
+    userId: string;
+    groupID: string;
+    msgIDList: string[];
+    readTime: number;
+    msgFrom: number;
+    contentType: MessageType;
+    sessionType: SessionType;
+};
+export type SearchMessageResult = {
+    totalCount: number;
+    searchResultItems?: SearchMessageResultItem[];
+    findResultItems?: SearchMessageResultItem[];
+};
+export type SearchMessageResultItem = {
+    conversationID: string;
+    messageCount: number;
+    conversationType: SessionType;
+    showName: string;
+    faceURL: string;
+    messageList: MessageItem[];
+};
+export type AdvancedGetMessageResult = {
+    isEnd: boolean;
+    lastMinSeq: number;
+    errCode: number;
+    errMsg: string;
+    messageList: MessageItem[];
+};
+export type RtcInvite = {
+    inviterUserID: string;
+    inviteeUserIDList: string[];
+    customData?: string;
+    groupID: string;
+    roomID: string;
+    timeout: number;
+    mediaType: string;
+    sessionType: number;
+    platformID: number;
+    initiateTime?: number;
+    busyLineUserIDList?: string[];
+};
+export type UserOnlineState = {
+    platformIDs?: Platform[];
+    status: OnlineState;
+    userId: string;
+};
+export type GroupMessageReceiptInfo = {
+    conversationID: string;
+    groupMessageReadInfo: GroupMessageReadInfo[];
+};
+export type GroupMessageReadInfo = {
+    clientMsgID: string;
+    hasReadCount: number;
+    unreadCount: number;
+    readMembers: GroupMemberItem[];
+};

package/lib/types/enum.d.ts

@@ -0,0 +1,133 @@
+export declare enum MessageReceiveOptType {
+    Nomal = 0,
+    NotReceive = 1,
+    NotNotify = 2
+}
+export declare enum AllowType {
+    Allowed = 0,
+    NotAllowed = 1
+}
+export declare enum GroupType {
+    Group = 2,
+    WorkingGroup = 2
+}
+export declare enum GroupJoinSource {
+    Invitation = 2,
+    Search = 3,
+    QrCode = 4
+}
+export declare enum GroupMemberRole {
+    Nomal = 20,
+    Admin = 60,
+    Owner = 100
+}
+export declare enum GroupVerificationType {
+    ApplyNeedInviteNot = 0,
+    AllNeed = 1,
+    AllNot = 2
+}
+export declare enum MessageStatus {
+    Sending = 1,
+    Succeed = 2,
+    Failed = 3
+}
+export declare enum Platform {
+    iOS = 1,
+    Android = 2,
+    Windows = 3,
+    MacOSX = 4,
+    Web = 5,
+    Linux = 7,
+    AndroidPad = 8,
+    iPad = 9
+}
+export declare enum LogLevel {
+    Debug = 5,
+    Info = 4,
+    Warn = 3,
+    Error = 2,
+    Fatal = 1,
+    Panic = 0
+}
+export declare enum ApplicationHandleResult {
+    Unprocessed = 0,
+    Agree = 1,
+    Reject = -1
+}
+export declare enum MessageType {
+    MESSAGE_TYPE_TEXT = 0,
+    TextMessage = 101,
+    PictureMessage = 102,
+    VoiceMessage = 103,
+    VideoMessage = 104,
+    FileMessage = 105,
+    AtTextMessage = 106,
+    MergeMessage = 107,
+    CardMessage = 108,
+    LocationMessage = 109,
+    CustomMessage = 110,
+    TypingMessage = 113,
+    QuoteMessage = 114,
+    FaceMessage = 115,
+    FriendAdded = 1201,
+    OANotification = 1400,
+    GroupCreated = 1501,
+    MemberQuit = 1504,
+    GroupOwnerTransferred = 1507,
+    MemberKicked = 1508,
+    MemberInvited = 1509,
+    MemberEnter = 1510,
+    GroupDismissed = 1511,
+    GroupMemberMuted = 1512,
+    GroupMemberCancelMuted = 1513,
+    GroupMuted = 1514,
+    GroupCancelMuted = 1515,
+    GroupAnnouncementUpdated = 1519,
+    GroupNameUpdated = 1520,
+    BurnMessageChange = 1701,
+    RevokeMessage = 2101
+}
+export declare enum SessionType {
+    Single = 1,
+    Group = 3,
+    WorkingGroup = 3,
+    Notification = 4
+}
+export declare enum GroupStatus {
+    Nomal = 0,
+    Baned = 1,
+    Dismissed = 2,
+    Muted = 3
+}
+export declare enum GroupAtType {
+    AtNormal = 0,
+    AtMe = 1,
+    AtAll = 2,
+    AtAllAtMe = 3,
+    AtGroupNotice = 4
+}
+export declare enum GroupMemberFilter {
+    All = 0,
+    Owner = 1,
+    Admin = 2,
+    Nomal = 3,
+    AdminAndNomal = 4,
+    AdminAndOwner = 5
+}
+export declare enum Relationship {
+    isBlack = 0,
+    isFriend = 1
+}
+export declare enum LoginStatus {
+    Logout = 1,
+    Logging = 2,
+    Logged = 3
+}
+export declare enum OnlineState {
+    Online = 1,
+    Offline = 0
+}
+export declare enum GroupMessageReaderFilter {
+    Readed = 0,
+    UnRead = 1
+}