@cored-im/openapi-sdk 0.28.102

package/dist/index.d.ts

@@ -0,0 +1,387 @@
+/** 64-bit integer represented as string to avoid precision loss */
+type Int64 = string;
+interface ApiRequest {
+    method: string;
+    path: string;
+    pathParams?: Record<string, string>;
+    queryParams?: Record<string, string>;
+    headerParams?: Record<string, string>;
+    body?: unknown;
+    stream?: ReadableStream<Uint8Array> | null;
+    withAppAccessToken?: boolean;
+    withWebSocket?: boolean;
+}
+interface ApiResponse {
+    json(): Promise<unknown>;
+    body(): Promise<Uint8Array>;
+}
+interface ApiError {
+    code: number;
+    msg: string;
+    log_id: string;
+    data?: unknown;
+}
+interface ApiClient {
+    preheat(): Promise<void>;
+    request(req: ApiRequest): Promise<ApiResponse>;
+    onEvent(eventType: string, handler: WrappedEventHandler): void;
+    offEvent(eventType: string, handler: WrappedEventHandler): void;
+    close(): Promise<void>;
+}
+interface EventHeader {
+    event_id: string;
+    event_type: string;
+    event_created_at: Int64;
+}
+type WrappedEventHandler = (header: EventHeader, body: Uint8Array | string) => void;
+type Marshaller = (v: unknown) => string;
+type Unmarshaller = (data: string) => unknown;
+interface HttpClient {
+    fetch(url: string, init: RequestInit): Promise<Response>;
+}
+interface Logger {
+    debug(msg: string, ...args: unknown[]): void;
+    info(msg: string, ...args: unknown[]): void;
+    warn(msg: string, ...args: unknown[]): void;
+    error(msg: string, ...args: unknown[]): void;
+}
+declare enum LoggerLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}
+interface TimeManager {
+    getSystemTimestamp(): number;
+    getServerTimestamp(): number;
+    syncServerTimestamp(timestamp: number): void;
+}
+
+interface Config {
+    appId: string;
+    appSecret: string;
+    backendUrl: string;
+    httpClient: HttpClient;
+    apiClient: ApiClient;
+    enableEncryption: boolean;
+    requestTimeout: number;
+    timeManager: TimeManager;
+    logger: Logger;
+    jsonMarshal: Marshaller;
+    jsonUnmarshal: Unmarshaller;
+}
+
+/** Set typing status (Request) */
+interface CreateTypingReq {
+    chat_id?: string;
+}
+/** Set typing status (Response) */
+interface CreateTypingResp {
+}
+/** Clear typing status (Request) */
+interface DeleteTypingReq {
+    chat_id?: string;
+}
+/** Clear typing status (Response) */
+interface DeleteTypingResp {
+}
+
+declare class Chat {
+    private readonly config;
+    constructor(config: Config);
+    /**
+     * Set typing status
+     *
+     * Set the typing status, lasts only 5 seconds, direct messages only
+     */
+    createTyping(req: CreateTypingReq): Promise<CreateTypingResp>;
+    /**
+     * Clear typing status
+     *
+     * Direct messages only
+     */
+    deleteTyping(req: DeleteTypingReq): Promise<DeleteTypingResp>;
+}
+
+/** Send a message (Request) */
+interface SendMessageReq {
+    message_type?: string;
+    message_content?: MessageContent;
+    chat_id?: string;
+    reply_message_id?: string;
+}
+/** Send a message (Response) */
+interface SendMessageResp {
+    message_id?: string;
+}
+/** Get a message (Request) */
+interface GetMessageReq {
+    message_id?: string;
+}
+/** Get a message (Response) */
+interface GetMessageResp {
+    message?: Message$1;
+}
+/** Recall a message (Request) */
+interface RecallMessageReq {
+    message_id?: string;
+}
+/** Recall a message (Response) */
+interface RecallMessageResp {
+}
+/** Mark message as read (Request) */
+interface ReadMessageReq {
+    message_id?: string;
+}
+/** Mark message as read (Response) */
+interface ReadMessageResp {
+}
+/** Message content */
+interface MessageContent {
+    text?: MessageText;
+    image?: MessageImage;
+    sticker?: MessageSticker;
+    video?: MessageVideo;
+    audio?: MessageAudio;
+    file?: MessageFile;
+    user_card?: MessageUserCard;
+    group_card?: MessageGroupCard;
+    group_announcement?: MessageGroupAnnouncement;
+    card?: MessageCard;
+}
+/** Text message */
+interface MessageText {
+    content?: string;
+    attachment_list?: MessageTextAttachment[];
+    mention_user_list?: MessageTextMentionUser[];
+    emoji_list?: MessageTextEmoji[];
+}
+/** Attachment */
+interface MessageTextAttachment {
+    attachment_id?: string;
+    attachment_type?: string;
+    attachment_content?: MessageTextAttachmentContent;
+}
+/** Attachment content */
+interface MessageTextAttachmentContent {
+    image?: FileImage;
+}
+/** Image file */
+interface FileImage {
+    image?: File;
+    image_width?: Int64;
+    image_height?: Int64;
+    image_origin?: File;
+    image_origin_width?: Int64;
+    image_origin_height?: Int64;
+    image_thumb_bytes?: Uint8Array;
+    image_thumb_mime?: string;
+    image_dominant_color?: string;
+}
+/** File */
+interface File {
+    file_id?: string;
+    file_mime?: string;
+    file_size?: Int64;
+    file_encryption?: Encryption;
+}
+/** Encryption */
+interface Encryption {
+    encryption_algorithm?: string;
+    encryption_key?: Uint8Array;
+    encrypted_size?: Int64;
+}
+/** Mentioned user */
+interface MessageTextMentionUser {
+    user_id?: UserId;
+    user_name?: string;
+    is_in_chat?: boolean;
+}
+/** User ID */
+interface UserId {
+    user_id?: string;
+    union_user_id?: string;
+    open_user_id?: string;
+}
+interface MessageTextEmoji {
+    emoji_id?: string;
+    emoji_name?: string;
+}
+/** Image message */
+interface MessageImage {
+    image?: FileImage;
+}
+/** Sticker message */
+interface MessageSticker {
+    sticker?: Sticker;
+}
+/** Sticker */
+interface Sticker {
+    sticker_id?: string;
+    sticker_name?: string;
+    sticker_name_i18n?: Record<string, string>;
+    sticker_image?: FileImage;
+}
+/** Video message */
+interface MessageVideo {
+    video?: FileVideo;
+}
+/** Video file */
+interface FileVideo {
+    video?: File;
+    video_width?: Int64;
+    video_height?: Int64;
+    video_duration?: number;
+    video_preview?: FileImage;
+}
+/** Audio message */
+interface MessageAudio {
+    audio?: FileAudio;
+}
+/** Audio file */
+interface FileAudio {
+    audio?: File;
+    audio_duration?: number;
+}
+/** File message */
+interface MessageFile {
+    file?: File;
+    filename?: string;
+}
+/** User card message */
+interface MessageUserCard {
+    user_id?: UserId;
+}
+/** Group card message */
+interface MessageGroupCard {
+    chat_id?: string;
+}
+/** Group announcement */
+interface MessageGroupAnnouncement {
+    message_text?: MessageText;
+}
+/** Card message */
+interface MessageCard {
+    schema?: string;
+    v1?: MessageCardV1;
+}
+/** V1 */
+interface MessageCardV1 {
+    header?: MessageCardV1Header;
+    body?: MessageCardV1Body;
+    footer?: MessageCardV1Footer;
+}
+/** Card header */
+interface MessageCardV1Header {
+    title?: string;
+    title_i18n?: Record<string, string>;
+    template?: string;
+}
+/** Card body */
+interface MessageCardV1Body {
+    message_text?: MessageText;
+    message_text_i18n?: Record<string, MessageText>;
+}
+/** Card footer */
+interface MessageCardV1Footer {
+    button_list?: MessageCardV1Button[];
+    button_align?: string;
+}
+/** Card button */
+interface MessageCardV1Button {
+    button_text?: string;
+    button_text_i18n?: Record<string, string>;
+    template?: string;
+    link?: MessageCardV1ButtonLink;
+}
+/** Link */
+interface MessageCardV1ButtonLink {
+    url?: string;
+    android_url?: string;
+    ios_url?: string;
+    pc_url?: string;
+}
+/** Message */
+interface Message$1 {
+    message_id?: string;
+    message_type?: string;
+    message_status?: string;
+    message_content?: MessageContent;
+    message_created_at?: Int64;
+    chat_id?: string;
+    chat_seq_id?: Int64;
+    sender_id?: UserId;
+    reply?: MessagePropReply;
+}
+/** Message reply properties */
+interface MessagePropReply {
+    reply_message_id?: string;
+}
+/** Message received */
+interface EventMessageReceiveBody {
+    message?: Message$1;
+}
+
+/** Message received */
+interface EventMessageReceive {
+    header: EventHeader;
+    body: EventMessageReceiveBody;
+}
+declare class MessageEvent {
+    private readonly config;
+    private readonly handlerMap;
+    constructor(config: Config);
+    /** Message received */
+    onMessageReceive(handler: (event: EventMessageReceive) => void): void;
+    offMessageReceive(handler: (event: EventMessageReceive) => void): void;
+}
+
+declare class Message {
+    private readonly config;
+    readonly Event: MessageEvent;
+    constructor(config: Config);
+    /** Send a message */
+    sendMessage(req: SendMessageReq): Promise<SendMessageResp>;
+    /** Get a message */
+    getMessage(req: GetMessageReq): Promise<GetMessageResp>;
+    /** Recall a message */
+    recallMessage(req: RecallMessageReq): Promise<RecallMessageResp>;
+    /** Mark message as read */
+    readMessage(req: ReadMessageReq): Promise<ReadMessageResp>;
+}
+
+declare class V1 {
+    readonly Chat: Chat;
+    readonly Message: Message;
+    constructor(config: Config);
+}
+
+declare class Service {
+    readonly v1: V1;
+    constructor(config: Config);
+}
+
+interface CoredClientOptions {
+    httpClient?: HttpClient;
+    requestTimeout?: number;
+    enableEncryption?: boolean;
+    logLevel?: LoggerLevel;
+    logger?: Logger;
+    timeManager?: TimeManager;
+    jsonMarshal?: Marshaller;
+    jsonUnmarshal?: Unmarshaller;
+}
+declare class CoredClient {
+    readonly config: Config;
+    readonly apiClient: ApiClient;
+    readonly Im: Service;
+    private constructor();
+    static create(backendUrl: string, appId: string, appSecret: string, options?: CoredClientOptions): Promise<CoredClient>;
+    preheat(): Promise<void>;
+    close(): Promise<void>;
+}
+
+declare const VERSION = "0.28.102";
+declare const USER_AGENT = "cored-openapi-sdk-js/0.28.102";
+
+export { type ApiClient, type ApiError, type ApiRequest, type ApiResponse, type Config, CoredClient, type CoredClientOptions, type EventHeader, type HttpClient, type Int64, type Logger, LoggerLevel, type TimeManager, USER_AGENT, VERSION };