trompot 1.0.0

package/lib/bot/IBot.d.ts

@@ -0,0 +1,292 @@
+import ReactionMessage from "../messages/ReactionMessage";
+import { Media } from "../messages/MediaMessage";
+import ChatStatus from "../modules/chat/ChatStatus";
+import Message from "../messages/Message";
+import { BotStatus } from "./BotStatus";
+import IAuth from "../client/IAuth";
+import BotEvents from "./BotEvents";
+import User from "../modules/user/User";
+import Chat from "../modules/chat/Chat";
+import Call from "../models/Call";
+/** Interface do bot */
+export default interface IBot extends BotEvents {
+    /** ID do bot */
+    id: string;
+    /** Status do Client */
+    status: BotStatus;
+    /** Número do bot */
+    phoneNumber: string;
+    /** Nome do bot */
+    name: string;
+    /**  URL da imagem de perfil do bot */
+    profileUrl: string;
+    /** Conectar bot
+     * @param auth Autenticação do bot
+     */
+    connect(auth: IAuth | string): Promise<void>;
+    /** Reconectar bot
+     * @param alert Alerta que está reconectando
+     */
+    reconnect(alert?: boolean): Promise<void>;
+    /** Parar bot
+     * @param reason Razão por parar o bot
+     */
+    stop(reason?: any): Promise<void>;
+    /**
+     * Desconecta o bot
+     */
+    logout(): Promise<void>;
+    /** Marca uma mensagem como visualizada
+     * @param message Mensagem que será visualizada
+     */
+    readMessage(message: Message): Promise<void>;
+    /** Adiciona uma reação na mensagem
+     * @param message Mensagem
+     * @param reaction Reação
+     */
+    addReaction(message: ReactionMessage): Promise<void>;
+    /** Remove a reação da mensagem
+     * @param Mensagem que terá sua reação removida
+     */
+    removeReaction(message: ReactionMessage): Promise<void>;
+    /** Edita o texto de uma mensagem enviada
+     * @param message Mensagem com o texto editado
+     */
+    editMessage(message: Message): Promise<void>;
+    /** Enviar mensagem
+     * @param message Mensagem que será enviada
+     */
+    send(message: Message): Promise<Message>;
+    /** Remover mensagem
+     * @param message Mensagem que será removida da sala de bate-papo
+     */
+    removeMessage(message: Message): Promise<void>;
+    /** Deletar mensagem
+     * @param message Mensagem que será deletada da sala de bate-papos
+     */
+    deleteMessage(message: Message): Promise<void>;
+    /** Retorna a stream da mídia
+     * @param message Mídia que será baixada
+     * @returns Stream da mídia
+     */
+    downloadStreamMessage(media: Media): Promise<Buffer>;
+    /** @returns Retorna o nome do bot */
+    getBotName(): Promise<string>;
+    /** Define o nome do bot
+     * @param name Nome do bot
+     */
+    setBotName(name: string): Promise<void>;
+    /** @returns Retorna a descrição do bot */
+    getBotDescription(): Promise<string>;
+    /** Define a descrição do bot
+     * @param description Descrição do bot
+     */
+    setBotDescription(description: string): Promise<void>;
+    /** @returns Retorna foto de perfil do bot */
+    getBotProfile(lowQuality?: boolean): Promise<Buffer>;
+    /**
+     * Obter URL da imagem de perfil do bot.
+     * @returns URL da imagem de perfil do bot.
+     */
+    getBotProfileUrl(lowQuality?: boolean): Promise<string>;
+    /** Define foto de perfil do bot
+     * @param image Foto de perfil do bot
+     */
+    setBotProfile(image: Buffer): Promise<void>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna uma sala de bate-papo
+     */
+    getChat(chat: Chat): Promise<Chat | null>;
+    /**
+     * Atualiza os dados de um chat.
+     * @param chat - Dados do chat que será atualizado.
+     */
+    updateChat(chat: {
+        id: string;
+    } & Partial<Chat>): Promise<void>;
+    /** Remove uma sala de bate-papo
+     * @param chat Sala de bate-papo
+     */
+    removeChat(chat: Chat): Promise<void>;
+    /** Adiciona um novo usuário a uma sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param user Usuário
+     */
+    addUserInChat(chat: Chat, user: User): Promise<void>;
+    /** Adiciona um novo usuário a uma sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param user Usuário
+     */
+    removeUserInChat(chat: Chat, user: User): Promise<void>;
+    /** Promove há administrador um usuário da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param user Usuário
+     */
+    promoteUserInChat(chat: Chat, user: User): Promise<void>;
+    /** Remove a administração um usuário da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param user Usuário
+     */
+    demoteUserInChat(chat: Chat, user: User): Promise<void>;
+    /** Altera o status da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param status Status da sala de bate-papo
+     */
+    changeChatStatus(chat: Chat, status: ChatStatus): Promise<void>;
+    /** Cria uma sala de bate-papo
+     * @param chat Sala de bate-papo
+     */
+    createChat(chat: Chat): Promise<void>;
+    /** Sai de uma sala de bate-papo
+     * @param chat Sala de bate-papo
+     */
+    leaveChat(chat: Chat): Promise<void>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna o nome da sala de bate-papo
+     */
+    getChatName(chat: Chat): Promise<string>;
+    /** Define o nome da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param name Nome da sala de bate-papo
+     */
+    setChatName(chat: Chat, name: string): Promise<void>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna a descrição da sala de bate-papo
+     */
+    getChatDescription(chat: Chat): Promise<string>;
+    /** Define a descrição da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param description Descrição da sala de bate-papo
+     */
+    setChatDescription(chat: Chat, description: string): Promise<void>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna a imagem de perfil da sala de bate-papo
+     */
+    getChatProfile(chat: Chat, lowQuality?: boolean): Promise<Buffer>;
+    /**
+     * Obter URL da imagem de perfil do chat.
+     * @param chat - Chat que será obtido a URL da imagem de perfil.
+     * @returns URL da imagem de perfil do chat.
+     */
+    getChatProfileUrl(chat: Chat, lowQuality?: boolean): Promise<string>;
+    /** Define a imagem de perfil da sala de bate-papo
+     * @param chat Sala de bate-papo
+     * @param profile Imagem de perfil da sala de bate-papo
+     */
+    setChatProfile(chat: Chat, profile: Buffer): Promise<void>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna os usuários de uma sala de bate-papo
+     */
+    getChatUsers(chat: Chat): Promise<string[]>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna os administradores de uma sala de bate-papo
+     */
+    getChatAdmins(chat: Chat): Promise<string[]>;
+    /**
+     * @param chat Sala de bate-papo
+     * @returns Retorna o lider da sala de bate-papo
+     */
+    getChatLeader(chat: Chat): Promise<string>;
+    /**
+     * @returns Retorna as sala de bate-papo que o bot está
+     */
+    getChats(): Promise<string[]>;
+    /** Define as salas de bate-papo que o bot está
+     * @param chats Salas de bate-papo
+     */
+    setChats(chats: Chat[]): Promise<void>;
+    /**
+     * Entra no chat pelo código de convite.
+     * @param code - Código de convite do chat.
+     */
+    joinChat(code: string): Promise<void>;
+    /**
+     * Obtem o código de convite do chat.
+     * @param chat - Chat que será obtido o código de convite.
+     * @returns O código de convite do chat.
+     */
+    getChatInvite(chat: Chat): Promise<string>;
+    /**
+     * Revoga o código de convite do chat.
+     * @param chat - Chat que terá seu código de convite revogado.
+     * @returns O novo código de convite do chat.
+     */
+    revokeChatInvite(chat: Chat): Promise<string>;
+    /**
+     * Rejeita uma chamada.
+     * @param call - A chamada que será rejeitada.
+     */
+    rejectCall(call: Call): Promise<void>;
+    /**
+     * @param user Usuário
+     * @returns Retorna um usuário
+     */
+    getUser(user: User): Promise<User | null>;
+    /**
+     * Atualiza os dados de um usuário.
+     * @param user - Dados do usuário que será atualizado.
+     */
+    updateUser(user: {
+        id: string;
+    } & Partial<User>): Promise<void>;
+    /** Remove um usuário
+     * @param user Usuário
+     */
+    removeUser(user: User): Promise<void>;
+    /**
+     * @param user Usuário
+     * @returns Retorna o nome do usuário
+     */
+    getUserName(user: User): Promise<string>;
+    /** Define o nome do usuário
+     * @param user Usuário
+     * @param name Nome do usuário
+     */
+    setUserName(user: User, name: string): Promise<void>;
+    /**
+     * @param user Usuário
+     * @returns Retorna a descrição do usuário
+     */
+    getUserDescription(user: User): Promise<string>;
+    /** Define a descrição do usuário
+     * @param user Usuário
+     * @param description Descrição do usuário
+     */
+    setUserDescription(user: User, description: string): Promise<void>;
+    /**
+     * @param user Usuário
+     * @returns Retorna a foto de perfil do usuário
+     */
+    getUserProfile(user: User, lowQuality?: boolean): Promise<Buffer>;
+    /**
+     * Obter URL da imagem de perfil do user.
+     * @param user - Usuário que será obtido a URL da imagem de perfil.
+     * @returns URL da imagem de perfil do usuário.
+     */
+    getUserProfileUrl(user: User, lowQuality?: boolean): Promise<string>;
+    /** Define a foto de perfil do usuário
+     * @param user Usuário
+     * @param profile Imagem de perfil do usuário
+     */
+    setUserProfile(user: User, profile: Buffer): Promise<void>;
+    /** Desbloqueia um usuário
+     * @param user Usuário
+     */
+    unblockUser(user: User): Promise<void>;
+    /** Bloqueia um usuário
+     * @param user Usuário
+     */
+    blockUser(user: User): Promise<void>;
+    /** @returns Retorna a lista de usuários do bot */
+    getUsers(): Promise<string[]>;
+    /** Define a lista de usuários do bot
+     * @param users Usuários
+     */
+    setUsers(users: User[]): Promise<void>;
+}

package/lib/bot/IBot.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IBot.js.map

package/lib/bot/IBot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBot.js","sourceRoot":"","sources":["../../src/bot/IBot.ts"],"names":[],"mappings":""}

package/lib/bot/index.d.ts

@@ -0,0 +1,5 @@
+import { BotStatus } from "./BotStatus";
+import BotEvents from "./BotEvents";
+import BotBase from "./BotBase";
+import IBot from "./IBot";
+export { IBot, BotBase, BotEvents, BotStatus };

package/lib/bot/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotStatus = exports.BotEvents = exports.BotBase = void 0;
+const BotStatus_1 = require("./BotStatus");
+Object.defineProperty(exports, "BotStatus", { enumerable: true, get: function () { return BotStatus_1.BotStatus; } });
+const BotEvents_1 = __importDefault(require("./BotEvents"));
+exports.BotEvents = BotEvents_1.default;
+const BotBase_1 = __importDefault(require("./BotBase"));
+exports.BotBase = BotBase_1.default;
+//# sourceMappingURL=index.js.map

package/lib/bot/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/bot/index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAwC;AAKL,0FAL1B,qBAAS,OAK0B;AAJ5C,4DAAoC;AAIZ,oBAJjB,mBAAS,CAIiB;AAHjC,wDAAgC;AAGjB,kBAHR,iBAAO,CAGQ"}

package/lib/client/Client.d.ts

@@ -0,0 +1,120 @@
+import { Buffer } from 'buffer';
+import ConnectionConfig from '../configs/ConnectionConfig';
+import Message from '../messages/Message';
+import MediaMessage from '../messages/MediaMessage';
+import QuickResponseController from '../modules/quickResponse/QuickResponseController';
+import ChatStatus from '../modules/chat/ChatStatus';
+import Chat from '../modules/chat/Chat';
+import User from '../modules/user/User';
+import Command from '../modules/command/Command';
+import CommandController from '../modules/command/CommandController';
+import ClientEvents, { ClientEventsMap } from './ClientEvents';
+import IAuth from './IAuth';
+import IClient from './IClient';
+import IBot from '../bot/IBot';
+import MessageHandler, { MessageHandlerConfig } from '../utils/MessageHandler';
+import { QuickResponseOptions, QuickResponsePattern, QuickResponseReply } from '../modules/quickResponse';
+import QuickResponse from '../modules/quickResponse/QuickResponse';
+import AdvancedCommandController from '../modules/command/advanced/AdvancedCommandController';
+import AdvancedCommand from '../modules/command/advanced/AdvancedCommand';
+import Call from '../models/Call';
+export default class Client<Bot extends IBot = IBot> extends ClientEvents implements IClient {
+    funcHandler: any;
+    commandController: CommandController;
+    advancedCommandController: AdvancedCommandController;
+    quickResponseController: QuickResponseController;
+    messageHandler: MessageHandler;
+    reconnectTimes: number;
+    config: ConnectionConfig;
+    bot: Bot;
+    id: string;
+    constructor(bot: Bot, config?: Partial<ConnectionConfig>);
+    configEvents(): void;
+    connect(auth: IAuth | string): Promise<void>;
+    reconnect(alert?: boolean): Promise<void>;
+    stop(reason?: any): Promise<void>;
+    logout(): Promise<void>;
+    awaitEvent<T extends keyof ClientEventsMap>(eventName: T, maxTimeout?: number): Promise<ClientEventsMap[T]>;
+    awaitConnectionOpen(): Promise<void>;
+    getCommandController(): CommandController;
+    setCommandController(controller: CommandController): void;
+    setCommands(commands: Command[]): void;
+    getCommands(): Command[];
+    addCommand(command: Command): void;
+    removeCommand(command: Command): boolean;
+    searchCommand(text: string): Command | null;
+    runCommand(command: Command, message: Message, type?: string): Promise<any>;
+    setAdvancedCommandController(advancedCommandController: AdvancedCommandController): void;
+    getAdvancedCommandController(): AdvancedCommandController;
+    setAdvancedCommands(commands: AdvancedCommand[]): void;
+    getAdvancedCommands(): AdvancedCommand<object>[];
+    createAdvancedCommand<T extends object>(id: string, context: T): AdvancedCommand<T>;
+    addAdvancedCommand(command: AdvancedCommand): void;
+    removeAdvancedCommand(command: AdvancedCommand): boolean;
+    execAdvancedCommand(command: AdvancedCommand | string, message: Message): Promise<void>;
+    addQuickResponse(pattern: QuickResponse): QuickResponse;
+    addQuickResponse(pattern: QuickResponsePattern, reply: QuickResponseReply, options?: Partial<QuickResponseOptions>): QuickResponse;
+    addQuickResponse(pattern: QuickResponsePattern[], reply: QuickResponseReply, options?: Partial<QuickResponseOptions>): QuickResponse;
+    removeQuickResponse(quickResponse: QuickResponse | string): void;
+    deleteMessage(message: Message): Promise<void>;
+    removeMessage(message: Message): Promise<void>;
+    readMessage(message: Message): Promise<void>;
+    editMessage(message: Message, text: string): Promise<void>;
+    addReaction(message: Message, reaction: string): Promise<void>;
+    removeReaction(message: Message): Promise<void>;
+    addAnimatedReaction(message: Message, reactions: string[], interval?: number, maxTimeout?: number): (reactionStop?: string) => Promise<void>;
+    send(message: Message): Promise<Message>;
+    sendMessage(chat: Chat | string, message: string | Message, mention?: Message): Promise<Message>;
+    awaitMessage(chat: Chat | string, config?: Partial<MessageHandlerConfig>): Promise<Message>;
+    downloadStreamMessage(message: MediaMessage): Promise<Buffer>;
+    getBotName(): Promise<string>;
+    setBotName(name: string): any;
+    getBotDescription(): any;
+    setBotDescription(description: string): any;
+    getBotProfile(lowQuality?: boolean): any;
+    setBotProfile(profile: Buffer): any;
+    getChat(chat: Chat | string): Promise<Chat | null>;
+    updateChat(id: string, chat: Partial<Chat>): Promise<void>;
+    getChats(): Promise<Chat[]>;
+    setChats(chats: Chat[]): Promise<void>;
+    removeChat(chat: string | Chat): Promise<void>;
+    createChat(chat: Chat): any;
+    leaveChat(chat: Chat | string): any;
+    getChatName(chat: Chat | string): any;
+    setChatName(chat: Chat | string, name: string): any;
+    getChatDescription(chat: Chat | string): any;
+    setChatDescription(chat: Chat | string, description: string): any;
+    getChatProfile(chat: Chat | string, lowQuality?: boolean): any;
+    setChatProfile(chat: Chat | string, profile: Buffer): any;
+    getChatLeader(chat: Chat | string): Promise<User>;
+    getChatUsers(chat: Chat | string): Promise<string[]>;
+    getChatAdmins(chat: Chat | string): Promise<string[]>;
+    addUserInChat(chat: Chat | string, user: User | string): any;
+    removeUserInChat(chat: Chat | string, user: User | string): any;
+    promoteUserInChat(chat: Chat | string, user: User | string): any;
+    demoteUserInChat(chat: Chat | string, user: User | string): any;
+    changeChatStatus(chat: Chat | string, status: ChatStatus): Promise<void>;
+    joinChat(code: string): Promise<void>;
+    getChatInvite(chat: Chat | string): Promise<string>;
+    revokeChatInvite(chat: Chat | string): Promise<string>;
+    rejectCall(call: Call | string): Promise<void>;
+    getUsers(): Promise<User[]>;
+    getSavedUsers(): Promise<User[]>;
+    setUsers(users: User[]): any;
+    getUser(user: User | string): Promise<User | null>;
+    updateUser(id: string, user: Partial<User>): Promise<void>;
+    removeUser(user: User | string): any;
+    getUserName(user: User | string): any;
+    setUserName(user: User | string, name: string): any;
+    getUserDescription(user: User | string): any;
+    setUserDescription(user: User | string, description: string): any;
+    getUserProfile(user: User | string, lowQuality?: boolean): any;
+    setUserProfile(user: User | string, profile: Buffer): any;
+    unblockUser(user: User | string): any;
+    blockUser(user: User | string): any;
+    static getClients(): Record<string, Client<IBot>>;
+    static saveClients(clients: Record<string, Client<IBot>>): void;
+    static getClient(id: string): Client<IBot>;
+    static saveClient(client: Client<IBot>): void;
+    static generateId(): string;
+}