@in.pulse-crm/sdk 1.2.3 → 1.3.1

package/dist/index.d.ts

@@ -4,4 +4,6 @@ import InstanceSDK from "./instance";
 import UserSDK, { CreateUserDTO, UpdateUserDTO, User, UserRole } from "./user";
 import { DataResponse, ErrorResponse, PaginatedResponse, QueryResponse } from "./response";
 import ReportSDK, { ChatReport, ChatReportFileFormat, GenerateChatReportOptions } from "./report";
-export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatReport, ChatReportFileFormat, GenerateChatReportOptions };
+import SocketClientSDK, { JoinChatFunction, JoinRoomFunction, ListenEventFunction } from "./socket-client";
+import SocketServerSDK, { EmitFunction, InstanceName, SocketAdminRoom, SocketChatReportsRoom, SocketChatRoom, SocketEventType, SocketMonitorRoom, SocketRoomType } from "./socket-server";
+export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatReport, ChatReportFileFormat, GenerateChatReportOptions, SocketClientSDK, JoinChatFunction, JoinRoomFunction, ListenEventFunction, SocketServerSDK, EmitFunction, InstanceName, SocketAdminRoom, SocketChatReportsRoom, SocketChatRoom, SocketEventType, SocketMonitorRoom, SocketRoomType };

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.ChatReportFileFormat = exports.ReportSDK = exports.UserRole = exports.UserSDK = exports.InstanceSDK = exports.FileDirType = exports.FileSDK = exports.AuthSDK = void 0;
+exports.SocketEventType = exports.SocketServerSDK = exports.SocketClientSDK = exports.ChatReportFileFormat = 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"));
@@ -50,3 +50,8 @@ Object.defineProperty(exports, "UserRole", { enumerable: true, get: function ()
 const report_1 = __importStar(require("./report"));
 exports.ReportSDK = report_1.default;
 Object.defineProperty(exports, "ChatReportFileFormat", { enumerable: true, get: function () { return report_1.ChatReportFileFormat; } });
+const socket_client_1 = __importDefault(require("./socket-client"));
+exports.SocketClientSDK = socket_client_1.default;
+const socket_server_1 = __importStar(require("./socket-server"));
+exports.SocketServerSDK = socket_server_1.default;
+Object.defineProperty(exports, "SocketEventType", { enumerable: true, get: function () { return socket_server_1.SocketEventType; } });

package/dist/socket-client.d.ts

@@ -0,0 +1,91 @@
+import { Socket } from "socket.io-client";
+import { PhoneNumber } from "@in.pulse-crm/utils";
+import { ChatId, NotImplemented, QRCode, 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;
+};
+/**
+ * Classe para consumo dos eventos de socket.
+ */
+export default class SocketClientSDK {
+    private readonly io;
+    constructor(io: Socket);
+    /**
+     * 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.
+     */
+    on: ListenEventFunction;
+    /**
+     * Entra em uma sala de socket.
+     *
+     * @param room - O tipo de sala a ser ingressada.
+     */
+    joinRoom: JoinRoomFunction;
+    /**
+     * Entra em um chat de socket.
+     *
+     * @param phone - O número de telefone do chat a ser ingressado.
+     */
+    joinChat: JoinChatFunction;
+    /**
+     * Define o token de autenticação para o socket.
+     *
+     * @param token - O token de autenticação.
+     */
+    setAuth(token: string): void;
+}

package/dist/socket-client.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const socket_server_1 = require("./socket-server");
+/**
+ * Classe para consumo dos eventos de socket.
+ */
+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.
+     *
+     * @param event - O tipo de evento a ser escutado.
+     * @param listener - A função a ser chamada quando o evento ocorrer.
+     */
+    on = (event, listener) => {
+        this.io.on(event, listener);
+    };
+    /**
+     * Entra em uma sala de socket.
+     *
+     * @param room - O tipo de sala a ser ingressada.
+     */
+    joinRoom = (room) => {
+        this.io.emit("join", `${room}`);
+    };
+    /**
+     * Entra em um chat de socket.
+     *
+     * @param phone - O número de telefone do chat a ser ingressado.
+     */
+    joinChat = (phone) => {
+        this.io.emit("join", `chat:${phone}`);
+    };
+    /**
+     * Define o token de autenticação para o socket.
+     *
+     * @param token - O token de autenticação.
+     */
+    setAuth(token) {
+        this.io.auth = { token: token ? `Bearer ${token}` : null };
+    }
+}
+exports.default = SocketClientSDK;

package/dist/socket-server.d.ts

@@ -0,0 +1,78 @@
+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"
+}
+/**
+ * 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 de chat, recebe eventos de relatórios de chat de um setor específico.
+ */
+export type SocketChatReportsRoom = `sector:${SectorId}:chat_reports`;
+/**
+ * Tipo de sala de socket.
+ */
+export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketChatReportsRoom | SocketMonitorRoom;
+/**
+ * Ainda não implementado.
+ */
+export type NotImplemented = unknown;
+/**
+ * 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;
+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;
+};
+/**
+ * Classe para manipulação de eventos de socket.
+ */
+export default class SocketServerSDK {
+    private readonly httpClient;
+    constructor(httpClient: AxiosInstance);
+    /**
+     * Emite um evento de socket.
+     * @param instanceName - O nome da instância.
+     * @param room - A sala de destino.
+     * @param event - O tipo do evento.
+     * @param value - O valor do evento.
+     */
+    emit: EmitFunction;
+}

package/dist/socket-server.js

@@ -0,0 +1,36 @@
+"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 || (exports.SocketEventType = SocketEventType = {}));
+/**
+ * Classe para manipulação de eventos de socket.
+ */
+class SocketServerSDK {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Emite um evento de socket.
+     * @param instanceName - O nome da instância.
+     * @param room - A sala de destino.
+     * @param event - O tipo do evento.
+     * @param value - O valor do evento.
+     */
+    emit = async (instanceName, room, event, value) => {
+        await this.httpClient.post(`/emit/${instanceName}/${room}/${event}`, value);
+    };
+}
+exports.default = SocketServerSDK;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "1.2.3",
+	"version": "1.3.1",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -23,8 +23,9 @@
 	"author": "Renan G. Dutra <r.granatodutra@gmail.com>",
 	"license": "ISC",
 	"dependencies": {
-		"@in.pulse-crm/utils": "^1.0.0",
-		"axios": "^1.8.3"
+		"@in.pulse-crm/utils": "^1.3.0",
+		"axios": "^1.8.3",
+		"socket.io-client": "^4.8.1"
 	},
 	"devDependencies": {
 		"@types/node": "^22.13.10",

package/src/index.ts

@@ -4,6 +4,19 @@ import InstanceSDK from "./instance";
 import UserSDK, { CreateUserDTO, UpdateUserDTO, User, UserRole } from "./user";
 import { DataResponse, ErrorResponse, PaginatedResponse, QueryResponse } from "./response";
 import ReportSDK, { ChatReport, ChatReportFileFormat, GenerateChatReportOptions } from "./report";
+import SocketClientSDK, { JoinChatFunction, JoinRoomFunction, ListenEventFunction } from "./socket-client";
+import
+SocketServerSDK,
+{
+    EmitFunction,
+    InstanceName,
+    SocketAdminRoom,
+    SocketChatReportsRoom,
+    SocketChatRoom,
+    SocketEventType,
+    SocketMonitorRoom,
+    SocketRoomType
+} from "./socket-server";
 
 export {
     AuthSDK,
@@ -25,5 +38,18 @@ export {
     ReportSDK,
     ChatReport,
     ChatReportFileFormat,
-    GenerateChatReportOptions
+    GenerateChatReportOptions,
+    SocketClientSDK,
+    JoinChatFunction,
+    JoinRoomFunction,
+    ListenEventFunction,
+    SocketServerSDK,
+    EmitFunction,
+    InstanceName,
+    SocketAdminRoom,
+    SocketChatReportsRoom,
+    SocketChatRoom,
+    SocketEventType,
+    SocketMonitorRoom,
+    SocketRoomType
 };

package/src/socket-client.ts

@@ -0,0 +1,117 @@
+import { Socket } from "socket.io-client";
+import { PhoneNumber } from "@in.pulse-crm/utils";
+import { ChatId, NotImplemented, QRCode, 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;
+}
+
+/**
+ * Classe para consumo dos eventos de socket.
+ */
+export default class SocketClientSDK {
+    constructor(private readonly io: Socket) {
+
+        this.on(SocketEventType.CHAT_FINISHED, (chatId) => {
+            console.log(`Chat ${chatId} finalizado.`);
+        });
+    }
+
+    /**
+     * 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.
+     */
+    public on: ListenEventFunction = (event, listener) => {
+        this.io.on(event, listener);
+    }
+
+    /**
+     * Entra em uma sala de socket.
+     * 
+     * @param room - O tipo de sala a ser ingressada.
+     */
+    public joinRoom: JoinRoomFunction = (room) => {
+        this.io.emit("join", `${room}`);
+    }
+
+    /**
+     * Entra em um chat de socket.
+     * 
+     * @param phone - O número de telefone do chat a ser ingressado.
+     */
+    public joinChat: JoinChatFunction = (phone) => {
+        this.io.emit("join", `chat:${phone}`);
+    }
+
+    /**
+     * Define o token de autenticação para o socket.
+     * 
+     * @param token - O token de autenticação.
+     */
+    public setAuth(token: string) {
+        this.io.auth = { token: token ? `Bearer ${token}` : null };
+    }
+}

package/src/socket-server.ts

@@ -0,0 +1,129 @@
+import { PhoneNumber } from "@in.pulse-crm/utils";
+import { AxiosInstance } from "axios";
+
+/**
+ * Tipos de eventos de socket.
+ */
+export 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"
+}
+
+/**
+ * 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 de chat, recebe eventos de relatórios de chat de um setor específico.
+ */
+export type SocketChatReportsRoom = `sector:${SectorId}:chat_reports`;
+
+/**
+ * Tipo de sala de socket.
+ */
+export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketChatReportsRoom | SocketMonitorRoom;
+
+/**
+ * Ainda não implementado.
+ */
+export type NotImplemented = unknown;
+
+/**
+ * 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;
+
+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;
+};
+
+/**
+ * Classe para manipulação de eventos de socket.
+ */
+export default class SocketServerSDK {
+
+    constructor(private readonly httpClient: AxiosInstance) { }
+
+    /**
+     * Emite um evento de socket.
+     * @param instanceName - O nome da instância.
+     * @param room - A sala de destino.
+     * @param event - O tipo do evento.
+     * @param value - O valor do evento.
+     */
+    public emit: EmitFunction = async (instanceName, room, event, value) => {
+        await this.httpClient.post(`/emit/${instanceName}/${room}/${event}`, value);
+    }
+}