@meet-im/meet-bot-jssdk 1.0.0 → 1.2.0

package/dist/index.d.cts

@@ -91,6 +91,7 @@ interface MeetBotConfig {
     longPollingTimeout?: number;
     logLevel?: LogLevel;
     useV2?: boolean;
+    userAgent?: string;
 }
 interface GetUpdatesOptions {
     token: string;
@@ -216,6 +217,37 @@ interface ReceivedAttachmentInfo {
     mimeType?: string;
 }
 
+interface MeetUser {
+    userID: number;
+    nickName: string;
+    nickNamePinyin?: string;
+    aliasName?: string;
+    aliasNamePinyin?: string;
+    gender?: number;
+    birthday?: string;
+    avatar?: string;
+    avatarUrl?: string;
+    email?: string;
+    mobile?: string;
+    jobNumber?: string;
+    tag?: string;
+    tags?: string[];
+    companyId?: number;
+    status?: number;
+    statusMsg?: string[];
+    sourceType?: number;
+    employeeStatus?: number;
+    cleanStatus?: number;
+    deletedAt?: number;
+    isDepartmentAdmin?: boolean;
+    isHide?: boolean;
+    sort?: number;
+    oaUID?: number;
+    msgDelTimeStamp?: number;
+    userType?: number;
+    updatedAt?: number;
+}
+
 declare class MeetBotError extends Error {
     readonly code: ErrorCode;
     constructor(message: string, code: ErrorCode);
@@ -227,10 +259,13 @@ declare class ApiError extends MeetBotError {
 }
 declare class NetworkError extends MeetBotError {
     readonly cause?: Error;
-    constructor(message: string, cause?: Error);
+    readonly httpStatus?: number;
+    readonly responseSnippet?: string;
+    constructor(message: string, cause?: Error, httpStatus?: number, responseSnippet?: string);
 }
 declare class TimeoutError extends MeetBotError {
-    constructor(message: string);
+    readonly isLocal: boolean;
+    constructor(message: string, isLocal?: boolean);
 }
 declare class ValidationError extends MeetBotError {
     readonly field: string;
@@ -238,6 +273,28 @@ declare class ValidationError extends MeetBotError {
     constructor(message: string, field: string, value: unknown);
 }
 
+interface UserCacheOptions {
+    ttl?: number;
+}
+declare class UserCache {
+    private byId;
+    private byNickName;
+    private byAliasName;
+    private loadedAt;
+    private readonly ttl;
+    private loading;
+    constructor(options?: UserCacheOptions);
+    isExpired(): boolean;
+    load(fetchAll: () => Promise<MeetUser[]>): Promise<void>;
+    private rebuild;
+    ensureLoaded(fetchAll: () => Promise<MeetUser[]>): Promise<void>;
+    getById(userId: number): MeetUser | undefined;
+    getByIds(userIds: number[]): Map<number, MeetUser>;
+    getByName(name: string): MeetUser[];
+    searchByName(query: string): MeetUser[];
+    get size(): number;
+}
+
 type EventHandler<T = unknown> = (data: T) => void;
 interface Events {
     message: {
@@ -254,11 +311,15 @@ declare class MeetBot {
     private readonly pollingLimit;
     private readonly longPollingTimeout;
     private readonly useV2;
+    private readonly userAgent?;
     private readonly eventHandlers;
     private polling;
     private offset;
     private abortController;
-    constructor(config: MeetBotConfig);
+    private readonly userCache;
+    constructor(config: MeetBotConfig & {
+        userCacheOptions?: UserCacheOptions;
+    });
     on<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
     off<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
     private emit;
@@ -281,37 +342,54 @@ declare class MeetBot {
     getAccessURL(params: GetAccessURLParams | GetAccessURLBySessionParams): Promise<AccessURLResult>;
     uploadFile(buffer: Buffer, options: UploadFileOptions): Promise<UploadFileResult>;
     sendMedia(sessionInfo: SessionInfo, options: SendMediaOptions): Promise<SendMessageResult>;
+    refreshUserCache(): Promise<void>;
+    getUserById(userId: number): Promise<MeetUser | undefined>;
+    getUserByIds(userIds: number[]): Promise<Map<number, MeetUser>>;
+    getUserByName(name: string): Promise<MeetUser[]>;
+    searchUserByName(query: string): Promise<MeetUser[]>;
+    get userCacheSize(): number;
     private sleep;
 }
 
 interface GetUploadURLApiParams extends GetUploadURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getUploadURL(params: GetUploadURLApiParams): Promise<UploadURLResult>;
 interface GetMultiPartUploadURLApiParams extends GetMultiPartUploadURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getMultiPartUploadURL(params: GetMultiPartUploadURLApiParams): Promise<MultiPartUploadURLResult>;
 interface CompleteMultipartUploadApiParams extends CompleteMultipartUploadParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function completeMultipartUpload(params: CompleteMultipartUploadApiParams): Promise<CompleteMultipartUploadResult>;
 interface GetAccessURLApiParams extends GetAccessURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getAccessURL(params: GetAccessURLApiParams): Promise<AccessURLResult>;
 
 declare function computeMD5(buffer: Buffer): Promise<string>;
-declare function uploadFile(token: string, buffer: Buffer, options: UploadFileOptions, baseUrl?: string): Promise<UploadFileResult>;
-declare function sendMediaMessage(token: string, sessionInfo: SessionInfo, options: SendMediaOptions, baseUrl?: string): Promise<SendMessageResult>;
+declare function uploadFile(token: string, buffer: Buffer, options: UploadFileOptions, baseUrl?: string, userAgent?: string): Promise<UploadFileResult>;
+declare function sendMediaMessage(token: string, sessionInfo: SessionInfo, options: SendMediaOptions, baseUrl?: string, userAgent?: string): Promise<SendMessageResult>;
+
+declare function getUsers(params: {
+    token: string;
+    baseUrl?: string;
+    userAgent?: string;
+}): Promise<MeetUser[]>;
 
 interface GetUpdatesParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     timeout?: number;
     offset?: number;
     limit?: number;
@@ -320,6 +398,7 @@ declare function getUpdates(params: GetUpdatesParams): Promise<BotUpdate[]>;
 interface GetUpdatesV2Params {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     timeout?: number;
     limit?: number;
 }
@@ -327,6 +406,7 @@ declare function getUpdatesV2(params: GetUpdatesV2Params): Promise<GetUpdatesV2R
 interface SendMessageParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     sessionInfo: SessionInfo;
     msgContent: MsgContent;
 }
@@ -378,4 +458,4 @@ declare function getChunkNum(size: number): number;
 declare function getConvID(firstID: number, secondID: number, sessionType: number, companyID?: number): string;
 declare function getQuoteMsgKey(convID: string, seqID: number): string;
 
-export { API, type AccessURLResult, ApiError, type ApiErrorResponse, type ApiResponse, type AttachmentInfo, type BotChat, type BotFile, type BotMsg, type BotMsgUpdate, type BotUpdate, type BotUser, CHUNK_RULES, type ChatType, type CompleteMultipartUploadParams, type CompleteMultipartUploadResult, DEFAULT_BASE_URL, type ErrorCode, type ExtraInfo, type GetAccessURLBySessionParams, type GetAccessURLParams, type GetMultiPartUploadURLParams, type GetUpdatesOptions, type GetUpdatesV2Result, type GetUploadURLParams, HTTP, type LogLevel, MeetBot, type MeetBotConfig, MeetBotError, type MsgContent, type MsgType, type MultiPartUploadURLResult, NetworkError, POLLING, type PollingOptions, type QuoteMsgMap, type ReceivedAttachmentInfo, SESSION_TYPE, type SendMediaOptions, type SendMessageOptions, type SendMessageResult, type SessionInfo, type SessionType, TimeoutError, UPLOAD, type UploadFileOptions, type UploadFileResult, type UploadPart, type UploadProgress, type UploadURLResult, ValidationError, completeMultipartUpload, computeMD5, getAccessURL, getChunkNum, getConvID, getMultiPartUploadURL, getQuoteMsgKey, getUpdates, getUpdatesV2, getUploadURL, sendMediaMessage, sendMessage, uploadFile };
+export { API, type AccessURLResult, ApiError, type ApiErrorResponse, type ApiResponse, type AttachmentInfo, type BotChat, type BotFile, type BotMsg, type BotMsgUpdate, type BotUpdate, type BotUser, CHUNK_RULES, type ChatType, type CompleteMultipartUploadParams, type CompleteMultipartUploadResult, DEFAULT_BASE_URL, type ErrorCode, type ExtraInfo, type GetAccessURLBySessionParams, type GetAccessURLParams, type GetMultiPartUploadURLParams, type GetUpdatesOptions, type GetUpdatesV2Result, type GetUploadURLParams, HTTP, type LogLevel, MeetBot, type MeetBotConfig, MeetBotError, type MeetUser, type MsgContent, type MsgType, type MultiPartUploadURLResult, NetworkError, POLLING, type PollingOptions, type QuoteMsgMap, type ReceivedAttachmentInfo, SESSION_TYPE, type SendMediaOptions, type SendMessageOptions, type SendMessageResult, type SessionInfo, type SessionType, TimeoutError, UPLOAD, type UploadFileOptions, type UploadFileResult, type UploadPart, type UploadProgress, type UploadURLResult, UserCache, type UserCacheOptions, ValidationError, completeMultipartUpload, computeMD5, getAccessURL, getChunkNum, getConvID, getMultiPartUploadURL, getQuoteMsgKey, getUpdates, getUpdatesV2, getUploadURL, getUsers, sendMediaMessage, sendMessage, uploadFile };

package/dist/index.d.ts

@@ -91,6 +91,7 @@ interface MeetBotConfig {
     longPollingTimeout?: number;
     logLevel?: LogLevel;
     useV2?: boolean;
+    userAgent?: string;
 }
 interface GetUpdatesOptions {
     token: string;
@@ -216,6 +217,37 @@ interface ReceivedAttachmentInfo {
     mimeType?: string;
 }
 
+interface MeetUser {
+    userID: number;
+    nickName: string;
+    nickNamePinyin?: string;
+    aliasName?: string;
+    aliasNamePinyin?: string;
+    gender?: number;
+    birthday?: string;
+    avatar?: string;
+    avatarUrl?: string;
+    email?: string;
+    mobile?: string;
+    jobNumber?: string;
+    tag?: string;
+    tags?: string[];
+    companyId?: number;
+    status?: number;
+    statusMsg?: string[];
+    sourceType?: number;
+    employeeStatus?: number;
+    cleanStatus?: number;
+    deletedAt?: number;
+    isDepartmentAdmin?: boolean;
+    isHide?: boolean;
+    sort?: number;
+    oaUID?: number;
+    msgDelTimeStamp?: number;
+    userType?: number;
+    updatedAt?: number;
+}
+
 declare class MeetBotError extends Error {
     readonly code: ErrorCode;
     constructor(message: string, code: ErrorCode);
@@ -227,10 +259,13 @@ declare class ApiError extends MeetBotError {
 }
 declare class NetworkError extends MeetBotError {
     readonly cause?: Error;
-    constructor(message: string, cause?: Error);
+    readonly httpStatus?: number;
+    readonly responseSnippet?: string;
+    constructor(message: string, cause?: Error, httpStatus?: number, responseSnippet?: string);
 }
 declare class TimeoutError extends MeetBotError {
-    constructor(message: string);
+    readonly isLocal: boolean;
+    constructor(message: string, isLocal?: boolean);
 }
 declare class ValidationError extends MeetBotError {
     readonly field: string;
@@ -238,6 +273,28 @@ declare class ValidationError extends MeetBotError {
     constructor(message: string, field: string, value: unknown);
 }
 
+interface UserCacheOptions {
+    ttl?: number;
+}
+declare class UserCache {
+    private byId;
+    private byNickName;
+    private byAliasName;
+    private loadedAt;
+    private readonly ttl;
+    private loading;
+    constructor(options?: UserCacheOptions);
+    isExpired(): boolean;
+    load(fetchAll: () => Promise<MeetUser[]>): Promise<void>;
+    private rebuild;
+    ensureLoaded(fetchAll: () => Promise<MeetUser[]>): Promise<void>;
+    getById(userId: number): MeetUser | undefined;
+    getByIds(userIds: number[]): Map<number, MeetUser>;
+    getByName(name: string): MeetUser[];
+    searchByName(query: string): MeetUser[];
+    get size(): number;
+}
+
 type EventHandler<T = unknown> = (data: T) => void;
 interface Events {
     message: {
@@ -254,11 +311,15 @@ declare class MeetBot {
     private readonly pollingLimit;
     private readonly longPollingTimeout;
     private readonly useV2;
+    private readonly userAgent?;
     private readonly eventHandlers;
     private polling;
     private offset;
     private abortController;
-    constructor(config: MeetBotConfig);
+    private readonly userCache;
+    constructor(config: MeetBotConfig & {
+        userCacheOptions?: UserCacheOptions;
+    });
     on<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
     off<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
     private emit;
@@ -281,37 +342,54 @@ declare class MeetBot {
     getAccessURL(params: GetAccessURLParams | GetAccessURLBySessionParams): Promise<AccessURLResult>;
     uploadFile(buffer: Buffer, options: UploadFileOptions): Promise<UploadFileResult>;
     sendMedia(sessionInfo: SessionInfo, options: SendMediaOptions): Promise<SendMessageResult>;
+    refreshUserCache(): Promise<void>;
+    getUserById(userId: number): Promise<MeetUser | undefined>;
+    getUserByIds(userIds: number[]): Promise<Map<number, MeetUser>>;
+    getUserByName(name: string): Promise<MeetUser[]>;
+    searchUserByName(query: string): Promise<MeetUser[]>;
+    get userCacheSize(): number;
     private sleep;
 }
 
 interface GetUploadURLApiParams extends GetUploadURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getUploadURL(params: GetUploadURLApiParams): Promise<UploadURLResult>;
 interface GetMultiPartUploadURLApiParams extends GetMultiPartUploadURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getMultiPartUploadURL(params: GetMultiPartUploadURLApiParams): Promise<MultiPartUploadURLResult>;
 interface CompleteMultipartUploadApiParams extends CompleteMultipartUploadParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function completeMultipartUpload(params: CompleteMultipartUploadApiParams): Promise<CompleteMultipartUploadResult>;
 interface GetAccessURLApiParams extends GetAccessURLParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
 }
 declare function getAccessURL(params: GetAccessURLApiParams): Promise<AccessURLResult>;
 
 declare function computeMD5(buffer: Buffer): Promise<string>;
-declare function uploadFile(token: string, buffer: Buffer, options: UploadFileOptions, baseUrl?: string): Promise<UploadFileResult>;
-declare function sendMediaMessage(token: string, sessionInfo: SessionInfo, options: SendMediaOptions, baseUrl?: string): Promise<SendMessageResult>;
+declare function uploadFile(token: string, buffer: Buffer, options: UploadFileOptions, baseUrl?: string, userAgent?: string): Promise<UploadFileResult>;
+declare function sendMediaMessage(token: string, sessionInfo: SessionInfo, options: SendMediaOptions, baseUrl?: string, userAgent?: string): Promise<SendMessageResult>;
+
+declare function getUsers(params: {
+    token: string;
+    baseUrl?: string;
+    userAgent?: string;
+}): Promise<MeetUser[]>;
 
 interface GetUpdatesParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     timeout?: number;
     offset?: number;
     limit?: number;
@@ -320,6 +398,7 @@ declare function getUpdates(params: GetUpdatesParams): Promise<BotUpdate[]>;
 interface GetUpdatesV2Params {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     timeout?: number;
     limit?: number;
 }
@@ -327,6 +406,7 @@ declare function getUpdatesV2(params: GetUpdatesV2Params): Promise<GetUpdatesV2R
 interface SendMessageParams {
     token: string;
     baseUrl?: string;
+    userAgent?: string;
     sessionInfo: SessionInfo;
     msgContent: MsgContent;
 }
@@ -378,4 +458,4 @@ declare function getChunkNum(size: number): number;
 declare function getConvID(firstID: number, secondID: number, sessionType: number, companyID?: number): string;
 declare function getQuoteMsgKey(convID: string, seqID: number): string;
 
-export { API, type AccessURLResult, ApiError, type ApiErrorResponse, type ApiResponse, type AttachmentInfo, type BotChat, type BotFile, type BotMsg, type BotMsgUpdate, type BotUpdate, type BotUser, CHUNK_RULES, type ChatType, type CompleteMultipartUploadParams, type CompleteMultipartUploadResult, DEFAULT_BASE_URL, type ErrorCode, type ExtraInfo, type GetAccessURLBySessionParams, type GetAccessURLParams, type GetMultiPartUploadURLParams, type GetUpdatesOptions, type GetUpdatesV2Result, type GetUploadURLParams, HTTP, type LogLevel, MeetBot, type MeetBotConfig, MeetBotError, type MsgContent, type MsgType, type MultiPartUploadURLResult, NetworkError, POLLING, type PollingOptions, type QuoteMsgMap, type ReceivedAttachmentInfo, SESSION_TYPE, type SendMediaOptions, type SendMessageOptions, type SendMessageResult, type SessionInfo, type SessionType, TimeoutError, UPLOAD, type UploadFileOptions, type UploadFileResult, type UploadPart, type UploadProgress, type UploadURLResult, ValidationError, completeMultipartUpload, computeMD5, getAccessURL, getChunkNum, getConvID, getMultiPartUploadURL, getQuoteMsgKey, getUpdates, getUpdatesV2, getUploadURL, sendMediaMessage, sendMessage, uploadFile };
+export { API, type AccessURLResult, ApiError, type ApiErrorResponse, type ApiResponse, type AttachmentInfo, type BotChat, type BotFile, type BotMsg, type BotMsgUpdate, type BotUpdate, type BotUser, CHUNK_RULES, type ChatType, type CompleteMultipartUploadParams, type CompleteMultipartUploadResult, DEFAULT_BASE_URL, type ErrorCode, type ExtraInfo, type GetAccessURLBySessionParams, type GetAccessURLParams, type GetMultiPartUploadURLParams, type GetUpdatesOptions, type GetUpdatesV2Result, type GetUploadURLParams, HTTP, type LogLevel, MeetBot, type MeetBotConfig, MeetBotError, type MeetUser, type MsgContent, type MsgType, type MultiPartUploadURLResult, NetworkError, POLLING, type PollingOptions, type QuoteMsgMap, type ReceivedAttachmentInfo, SESSION_TYPE, type SendMediaOptions, type SendMessageOptions, type SendMessageResult, type SessionInfo, type SessionType, TimeoutError, UPLOAD, type UploadFileOptions, type UploadFileResult, type UploadPart, type UploadProgress, type UploadURLResult, UserCache, type UserCacheOptions, ValidationError, completeMultipartUpload, computeMD5, getAccessURL, getChunkNum, getConvID, getMultiPartUploadURL, getQuoteMsgKey, getUpdates, getUpdatesV2, getUploadURL, getUsers, sendMediaMessage, sendMessage, uploadFile };