@in.pulse-crm/sdk 1.3.9 → 1.3.11

package/dist/index.d.ts

@@ -3,7 +3,9 @@ import FileSDK, { File, FileDirType } from "./file";
 import InstanceSDK from "./instance";
 import UserSDK, { CreateUserDTO, UpdateUserDTO, User, UserRole } from "./user";
 import { DataResponse, ErrorResponse, PaginatedResponse, QueryResponse } from "./response";
-import ReportSDK, { ChatsReport, ChatsReportFileFormat, GenerateChatsReportOptions } from "./report";
-import SocketClientSDK, { JoinChatFunction, JoinRoomFunction, ListenEventFunction } from "./socket-client";
-import SocketServerSDK, { EmitFunction, InstanceName, SocketAdminRoom, SocketChatRoom, SocketMonitorRoom, SocketReportsRoom, SocketRoomType, SocketEventType } from "./socket-server";
-export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatsReport as ChatReport, ChatsReportFileFormat as ChatReportFileFormat, GenerateChatsReportOptions as GenerateChatReportOptions, SocketClientSDK, JoinChatFunction, JoinRoomFunction, ListenEventFunction, SocketServerSDK, EmitFunction, InstanceName, SocketAdminRoom, SocketReportsRoom, SocketChatRoom, SocketEventType, SocketMonitorRoom, SocketRoomType };
+import ReportSDK, { ChatsReport, ChatsReportFormat, GenerateChatsReportOptions } from "./report";
+import SocketClientSDK from "./socket-client";
+import SocketServerSDK from "./socket-server";
+import { ChatsReportStatusData, SocketServerAdminRoom, SocketServerMonitorRoom, SocketServerReportsRoom, SocketServerRoom, ChatId, QRCode, SocketEventType } from "./types/socket-server.types";
+import { SocketChatRoom, SocketClientAdminRoom, SocketClientMonitorRoom, SocketClientReportsRoom, SocketClientRoom } from "./types/socket-client.types";
+export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatsReport, ChatsReportFormat as ChatsReportFileFormat, GenerateChatsReportOptions, SocketClientSDK, SocketChatRoom, SocketClientAdminRoom, SocketClientMonitorRoom, SocketClientReportsRoom, SocketClientRoom, SocketServerSDK, SocketEventType, ChatsReportStatusData, SocketServerAdminRoom, SocketServerMonitorRoom, SocketServerReportsRoom, SocketServerRoom, ChatId, QRCode, };

package/dist/index.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketEventType = exports.SocketServerSDK = exports.SocketClientSDK = exports.ChatReportFileFormat = exports.ReportSDK = exports.UserRole = exports.UserSDK = exports.InstanceSDK = exports.FileDirType = exports.FileSDK = exports.AuthSDK = void 0;
+exports.SocketServerSDK = exports.SocketClientSDK = exports.ReportSDK = exports.UserRole = exports.UserSDK = exports.InstanceSDK = exports.FileDirType = exports.FileSDK = exports.AuthSDK = void 0;
 const auth_1 = __importDefault(require("./auth"));
 exports.AuthSDK = auth_1.default;
 const file_1 = __importStar(require("./file"));
@@ -47,11 +47,9 @@ exports.InstanceSDK = instance_1.default;
 const user_1 = __importStar(require("./user"));
 exports.UserSDK = user_1.default;
 Object.defineProperty(exports, "UserRole", { enumerable: true, get: function () { return user_1.UserRole; } });
-const report_1 = __importStar(require("./report"));
+const report_1 = __importDefault(require("./report"));
 exports.ReportSDK = report_1.default;
-Object.defineProperty(exports, "ChatReportFileFormat", { enumerable: true, get: function () { return report_1.ChatsReportFileFormat; } });
 const socket_client_1 = __importDefault(require("./socket-client"));
 exports.SocketClientSDK = socket_client_1.default;
-const socket_server_1 = __importStar(require("./socket-server"));
+const socket_server_1 = __importDefault(require("./socket-server"));
 exports.SocketServerSDK = socket_server_1.default;
-Object.defineProperty(exports, "SocketEventType", { enumerable: true, get: function () { return socket_server_1.SocketEventType; } });

package/dist/report.d.ts

@@ -1,35 +1,28 @@
 import { AxiosInstance } from "axios";
 import { DataResponse, MessageResponse } from "./response";
-export declare enum ChatsReportStatus {
-    PENDING = "PENDING",
-    COMPLETED = "COMPLETED",
-    FAILED = "FAILED"
-}
+export type ReportType = "chats";
+export type ChatsReportFormat = "txt" | "csv" | "pdf";
+export type ChatsReportStatus = "pending" | "completed" | "failed";
 export interface ChatsReport {
     id: number;
     userId: string;
     fileId: number;
     instance: string;
-    format: string;
     startDate: string;
     endDate: string;
     exportDate: string;
     chats: number;
     messages: number;
+    format: ChatsReportFormat;
     status: ChatsReportStatus;
 }
 export interface GenerateChatsReportOptions {
     instance: string;
     userId: string;
-    format: ChatsReportFileFormat;
+    format: ChatsReportFormat;
     startDate: string;
     endDate: string;
 }
-export declare enum ChatsReportFileFormat {
-    TXT = "txt",
-    CSV = "csv",
-    PDF = "pdf"
-}
 export default class ReportSDK {
     private readonly httpClient;
     constructor(httpClient: AxiosInstance);

package/dist/report.js

@@ -1,18 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatsReportFileFormat = exports.ChatsReportStatus = void 0;
-var ChatsReportStatus;
-(function (ChatsReportStatus) {
-    ChatsReportStatus["PENDING"] = "PENDING";
-    ChatsReportStatus["COMPLETED"] = "COMPLETED";
-    ChatsReportStatus["FAILED"] = "FAILED";
-})(ChatsReportStatus || (exports.ChatsReportStatus = ChatsReportStatus = {}));
-var ChatsReportFileFormat;
-(function (ChatsReportFileFormat) {
-    ChatsReportFileFormat["TXT"] = "txt";
-    ChatsReportFileFormat["CSV"] = "csv";
-    ChatsReportFileFormat["PDF"] = "pdf";
-})(ChatsReportFileFormat || (exports.ChatsReportFileFormat = ChatsReportFileFormat = {}));
 class ReportSDK {
     httpClient;
     constructor(httpClient) {

package/dist/socket-client.d.ts

@@ -1,68 +1,5 @@
 import { Socket } from "socket.io-client";
-import { PhoneNumber } from "@in.pulse-crm/utils";
-import { ChatId, NotImplemented, QRCode, ChatsReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
-/**
- * Função para entrar em uma sala de socket.
- */
-export type JoinRoomFunction = {
-    (room: SocketRoomType): void;
-};
-/**
- * Função para entrar em um chat de socket.
- */
-export type JoinChatFunction = {
-    (phone: PhoneNumber): void;
-};
-/**
- * Função para escutar eventos de socket.
- */
-export type ListenEventFunction = {
-    /**
-     * Escuta evento de mensagem
-     * Ainda não implementado.
-     */
-    (event: SocketEventType.MESSAGE, listener: (data: NotImplemented) => void): void;
-    /**
-     * Escuta evento de edição de mensagem
-     * Ainda não implementado.
-     */
-    (event: SocketEventType.MESSAGE_EDIT, listener: (data: NotImplemented) => void): void;
-    /**
-     * Escuta evento de status de mensagem
-     * Ainda não implementado.
-     */
-    (event: SocketEventType.MESSAGE_STATUS, listener: (data: NotImplemented) => void): void;
-    /**
-     * Escuta evento de novo chat
-     * Ainda não implementado.
-     */
-    (event: SocketEventType.NEW_CHAT, listener: (data: NotImplemented) => void): void;
-    /**
-     * Escuta evento de chat finalizado
-     * @trigger Quando um chat é finalizado
-     * @target Sala de monitoria e ao atendente do chat
-     * @data Um número contendo o ID do chat finalizado
-     */
-    (event: SocketEventType.CHAT_FINISHED, listener: (chatId: ChatId) => void): void;
-    /**
-     * Escuta evento de notificação
-     * @trigger Quando uma notificação é enviada
-     * @target Sala de administração do setor
-     */
-    (event: SocketEventType.NOTIFICATION, listener: (notification: NotImplemented) => void): void;
-    /**
-     * Escuta evento de QR Code
-     * @trigger Quando um QR Code é gerado
-     * @target Sala de administração do setor
-     */
-    (event: SocketEventType.QR_CODE, listener: (qr: QRCode) => void): void;
-    /**
-     * Escuta evento de status de relatório
-     * @trigger Quando o status de um relatório é atualizado
-     * @target Sala de relatórios
-     */
-    (event: SocketEventType.REPORT_STATUS, listener: (data: ChatsReportStatusData) => void): void;
-};
+import { JoinChatFunction, JoinRoomFunction, LeaveChatFunction, LeaveRoomFunction, ListenEventFunction } from "./types/socket-client.types";
 /**
  * Classe para consumo dos eventos de socket.
  */
@@ -76,6 +13,13 @@ export default class SocketClientSDK {
      * @param listener - A função a ser chamada quando o evento ocorrer.
      */
     on: ListenEventFunction;
+    /**
+     * Escuta eventos de socket.
+     *
+     * @param event - O tipo de evento a ser escutado.
+     * @param listener - A função a ser chamada quando o evento ocorrer.
+     */
+    off: ListenEventFunction;
     /**
      * Entra em uma sala de socket.
      *
@@ -83,15 +27,31 @@ export default class SocketClientSDK {
      */
     joinRoom: JoinRoomFunction;
     /**
-     * Entra em um chat de socket.
+     * Entra em um chat.
      *
      * @param phone - O número de telefone do chat a ser ingressado.
      */
     joinChat: JoinChatFunction;
+    /**
+     * Sai de uma sala de socket.
+     *
+     * @param room - O tipo de sala a ser deixada.
+     * @description Remove o cliente da sala especificada no servidor de socket.
+     */
+    leaveRoom: LeaveRoomFunction;
+    /**
+     * Sai de um chat.
+     *
+     * @param phone - O número de telefone do chat a ser deixado.
+     * @description Remove o cliente do chat especificado, utilizando o número de telefone.
+     */
+    leaveChat: LeaveChatFunction;
     /**
      * Define o token de autenticação para o socket.
      *
      * @param token - O token de autenticação.
+     * @description Configura o token de autenticação para ser enviado em todas as conexões de socket subsequentes.
+     *              Se o token for nulo ou vazio, a autenticação será removida.
      */
     setAuth(token: string): void;
 }

package/dist/socket-client.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const socket_server_1 = require("./socket-server");
 /**
  * Classe para consumo dos eventos de socket.
  */
@@ -8,9 +7,6 @@ class SocketClientSDK {
     io;
     constructor(io) {
         this.io = io;
-        this.on(socket_server_1.SocketEventType.CHAT_FINISHED, (chatId) => {
-            console.log(`Chat ${chatId} finalizado.`);
-        });
     }
     /**
      * Escuta eventos de socket.
@@ -21,26 +17,55 @@ class SocketClientSDK {
     on = (event, listener) => {
         this.io.on(event, listener);
     };
+    /**
+     * Escuta eventos de socket.
+     *
+     * @param event - O tipo de evento a ser escutado.
+     * @param listener - A função a ser chamada quando o evento ocorrer.
+     */
+    off = (event, listener) => {
+        this.io.off(event, listener);
+    };
     /**
      * Entra em uma sala de socket.
      *
      * @param room - O tipo de sala a ser ingressada.
      */
     joinRoom = (room) => {
-        this.io.emit("join", `${room}`);
+        this.io.emit("join-room", `${room}`);
     };
     /**
-     * Entra em um chat de socket.
+     * Entra em um chat.
      *
      * @param phone - O número de telefone do chat a ser ingressado.
      */
     joinChat = (phone) => {
-        this.io.emit("join", `chat:${phone}`);
+        this.joinRoom(`chat:${phone}`);
+    };
+    /**
+     * Sai de uma sala de socket.
+     *
+     * @param room - O tipo de sala a ser deixada.
+     * @description Remove o cliente da sala especificada no servidor de socket.
+     */
+    leaveRoom = (room) => {
+        this.io.emit("leave-room", `${room}`);
+    };
+    /**
+     * Sai de um chat.
+     *
+     * @param phone - O número de telefone do chat a ser deixado.
+     * @description Remove o cliente do chat especificado, utilizando o número de telefone.
+     */
+    leaveChat = (phone) => {
+        this.leaveRoom(`chat:${phone}`);
     };
     /**
      * Define o token de autenticação para o socket.
      *
      * @param token - O token de autenticação.
+     * @description Configura o token de autenticação para ser enviado em todas as conexões de socket subsequentes.
+     *              Se o token for nulo ou vazio, a autenticação será removida.
      */
     setAuth(token) {
         this.io.auth = { token: token ? `Bearer ${token}` : null };

package/dist/socket-server.d.ts

@@ -1,155 +1,5 @@
-import { PhoneNumber } from "@in.pulse-crm/utils";
 import { AxiosInstance } from "axios";
-/**
- * Tipos de eventos de socket.
- */
-export declare enum SocketEventType {
-    MESSAGE = "message",
-    MESSAGE_EDIT = "message_edit",
-    MESSAGE_STATUS = "message_status",
-    NEW_CHAT = "new_chat",
-    CHAT_FINISHED = "chat_finished",
-    NOTIFICATION = "notification",
-    QR_CODE = "qr_code",
-    REPORT_STATUS = "report_status"
-}
-/**
- * Sala de chat, recebe todos eventos de um chat específico.
- */
-export type SocketChatRoom = `chat:${PhoneNumber}`;
-/**
- * Sala de administrador, recebe eventos de adminstrador de um setor específico.
- */
-export type SocketAdminRoom = `sector:${SectorId}:admin`;
-/**
- * Sala de monitoria, recebe eventos de monitoria de um setor específico.
- */
-export type SocketMonitorRoom = `sector:${SectorId}:monitor`;
-/**
- * Sala de relatórios, recebe eventos de um tipo relatório específico de um setor específico.
- */
-export type SocketReportsRoom = `sector:${number}:reports:${string}`;
-/**
- * Tipo de sala de socket.
- */
-export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketReportsRoom | SocketMonitorRoom;
-/**
- * Ainda não implementado.
- */
-export type NotImplemented = unknown;
-/**
- * Dados de status de um relatório de conversas.
- */
-export type ChatsReportStatusData = {
-    id: number;
-    type: "chats-report";
-    isCompleted: false;
-    isFailed: false;
-    progress: number;
-} | {
-    id: number;
-    type: "chats-report";
-    isCompleted: true;
-    isFailed: false;
-    fileId: number;
-    chats: number;
-    messages: number;
-} | {
-    id: number;
-    type: "chats-report";
-    isCompleted: false;
-    isFailed: true;
-    error: string;
-};
-/**
- * String representando um QR Code.
- */
-export type QRCode = string;
-/**
- * Id de um chat.
- */
-export type ChatId = number;
-/**
- * Id de um setor.
- */
-export type SectorId = number;
-/**
- * Nome de uma instância.
- */
-export type InstanceName = string;
-/**
- * Represents a function type for emitting events to specific rooms in a socket server.
- * This function type supports multiple overloads, each corresponding to a specific
- * combination of room type, event type, and value type.
- *
- * @typedef EmitFunction
- *
- * @overload
- * Emits a `NEW_CHAT` event to a chat or monitor room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
- * @param event - The event type, `SocketEventType.NEW_CHAT`.
- * @param value - The value associated with the event (type not yet implemented).
- *
- * @overload
- * Emits a `CHAT_FINISHED` event to a chat or monitor room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
- * @param event - The event type, `SocketEventType.CHAT_FINISHED`.
- * @param value - The ID of the finished chat.
- *
- * @overload
- * Emits a `QR_CODE` event to an admin room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketAdminRoom`.
- * @param event - The event type, `SocketEventType.QR_CODE`.
- * @param value - The QR code data.
- *
- * @overload
- * Emits a `MESSAGE` event to a chat room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketChatRoom`.
- * @param event - The event type, `SocketEventType.MESSAGE`.
- * @param value - The value associated with the event (type not yet implemented).
- *
- * @overload
- * Emits a `NOTIFICATION` event to an admin room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketAdminRoom`.
- * @param event - The event type, `SocketEventType.NOTIFICATION`.
- * @param value - The value associated with the event (type not yet implemented).
- *
- * @overload
- * Emits a `MESSAGE_EDIT` event to a chat room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketChatRoom`.
- * @param event - The event type, `SocketEventType.MESSAGE_EDIT`.
- * @param value - The value associated with the event (type not yet implemented).
- *
- * @overload
- * Emits a `MESSAGE_STATUS` event to a chat room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketChatRoom`.
- * @param event - The event type, `SocketEventType.MESSAGE_STATUS`.
- * @param value - The value associated with the event (type not yet implemented).
- *
- * @overload
- * Emits a `REPORT_STATUS` event to an admin room.
- * @param instanceName - The name of the instance emitting the event.
- * @param room - The target room, a `SocketAdminRoom`.
- * @param event - The event type, `SocketEventType.REPORT_STATUS`.
- * @param value - The report status data.
- */
-export type EmitFunction = {
-    (instanceName: string, room: SocketChatRoom | SocketMonitorRoom, event: SocketEventType.NEW_CHAT, value: NotImplemented): void;
-    (instanceName: string, room: SocketChatRoom | SocketMonitorRoom, event: SocketEventType.CHAT_FINISHED, value: ChatId): void;
-    (instanceName: string, room: SocketAdminRoom, event: SocketEventType.QR_CODE, value: QRCode): void;
-    (instanceName: string, room: SocketChatRoom, event: SocketEventType.MESSAGE, value: NotImplemented): void;
-    (instanceName: string, room: SocketAdminRoom, event: SocketEventType.NOTIFICATION, value: NotImplemented): void;
-    (instanceName: string, room: SocketChatRoom, event: SocketEventType.MESSAGE_EDIT, value: NotImplemented): void;
-    (instanceName: string, room: SocketChatRoom, event: SocketEventType.MESSAGE_STATUS, value: NotImplemented): void;
-    (instanceName: string, room: SocketReportsRoom, event: SocketEventType.REPORT_STATUS, value: ChatsReportStatusData): void;
-};
+import { EmitFunction } from "./types/socket-server.types";
 /**
  * Classe para manipulação de eventos de socket.
  */

package/dist/socket-server.js

@@ -1,20 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketEventType = void 0;
-/**
- * Tipos de eventos de socket.
- */
-var SocketEventType;
-(function (SocketEventType) {
-    SocketEventType["MESSAGE"] = "message";
-    SocketEventType["MESSAGE_EDIT"] = "message_edit";
-    SocketEventType["MESSAGE_STATUS"] = "message_status";
-    SocketEventType["NEW_CHAT"] = "new_chat";
-    SocketEventType["CHAT_FINISHED"] = "chat_finished";
-    SocketEventType["NOTIFICATION"] = "notification";
-    SocketEventType["QR_CODE"] = "qr_code";
-    SocketEventType["REPORT_STATUS"] = "report_status";
-})(SocketEventType || (exports.SocketEventType = SocketEventType = {}));
 /**
  * Classe para manipulação de eventos de socket.
  */

package/dist/types/socket-client.types.d.ts

@@ -0,0 +1,97 @@
+import { PhoneNumber } from "@in.pulse-crm/utils";
+import { ReportType } from "../report";
+import type { ChatsReportStatusData, QRCode } from "./socket-server.types";
+/**
+ * Representa uma sala de chat identificada por um número de telefone.
+ */
+export type SocketChatRoom = `chat:${PhoneNumber}`;
+/**
+ * Representa a sala de administração.
+ */
+export type SocketClientAdminRoom = "admin";
+/**
+ * Representa a sala de monitoramento.
+ */
+export type SocketClientMonitorRoom = `monitor`;
+/**
+ * Representa uma sala de relatórios identificada por um tipo de relatório.
+ */
+export type SocketClientReportsRoom = `reports:${ReportType}`;
+/**
+ * Representa as salas disponíveis para clientes, incluindo chat, administração, relatórios e monitoramento.
+ */
+export type SocketClientRoom = SocketChatRoom | SocketClientAdminRoom | SocketClientReportsRoom | SocketClientMonitorRoom;
+/**
+ * Função para entrar em uma sala de socket.
+ */
+export type JoinRoomFunction = {
+    (room: SocketClientRoom): void;
+};
+/**
+ * Função para entrar em um chat de socket.
+ */
+export type JoinChatFunction = {
+    (phone: PhoneNumber): void;
+};
+/**
+ * Função para sair de uma sala de socket.
+ */
+export type LeaveRoomFunction = {
+    (room: SocketClientRoom): void;
+};
+/**
+ * Função para sair de um chat de socket.
+ */
+export type LeaveChatFunction = {
+    (phone: PhoneNumber): void;
+};
+/**
+ * Função para escutar eventos de socket.
+ */
+export type ListenEventFunction = {
+    /**
+     * Escuta evento de mensagem
+     * Ainda não implementado.
+     */
+    (event: "message", listener: (data: unknown) => void): void;
+    /**
+     * Escuta evento de edição de mensagem
+     * Ainda não implementado.
+     */
+    (event: "message_edit", listener: (data: unknown) => void): void;
+    /**
+     * Escuta evento de status de mensagem
+     * Ainda não implementado.
+     */
+    (event: "message_status", listener: (data: unknown) => void): void;
+    /**
+     * Escuta evento de novo chat
+     * Ainda não implementado.
+     */
+    (event: "new_chat", listener: (data: unknown) => void): void;
+    /**
+     * Escuta evento de chat finalizado
+     * @trigger Quando um chat é finalizado
+     * @target Sala de monitoria e ao atendente do chat
+     * @data Um número contendo o ID do chat finalizado
+     */
+    (event: "chat_finished", listener: (chatId: number) => void): void;
+    /**
+     * Escuta evento de notificação
+     * @trigger Quando uma notificação é enviada
+     * @target Sala de administração do setor
+     */
+    (event: "notification", listener: (notification: unknown) => void): void;
+    /**
+     * Escuta evento de QR Code
+     * @trigger Quando um QR Code é gerado
+     * @target Sala de administração do setor
+     */
+    (event: "qr_code", listener: (qr: QRCode) => void): void;
+    /**
+     * Escuta evento de status de relatório
+     * @trigger Quando o status de um relatório é atualizado
+     * @target Sala de relatórios
+     */
+    (event: "report_status", listener: (data: ChatsReportStatusData) => void): void;
+};

package/dist/types/socket-client.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });