@in.pulse-crm/sdk 1.3.1 → 1.3.3

package/dist/index.d.ts

@@ -5,5 +5,5 @@ 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, 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 };
+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, ChatReport, ChatReportFileFormat, GenerateChatReportOptions, SocketClientSDK, JoinChatFunction, JoinRoomFunction, ListenEventFunction, SocketServerSDK, EmitFunction, InstanceName, SocketAdminRoom, SocketReportsRoom, SocketChatRoom, SocketEventType, SocketMonitorRoom, SocketRoomType };

package/dist/socket-client.d.ts

@@ -1,6 +1,6 @@
 import { Socket } from "socket.io-client";
 import { PhoneNumber } from "@in.pulse-crm/utils";
-import { ChatId, NotImplemented, QRCode, SocketEventType, SocketRoomType } from "./socket-server";
+import { ChatId, NotImplemented, QRCode, ReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
 /**
  * Função para entrar em uma sala de socket.
  */
@@ -56,6 +56,12 @@ export type ListenEventFunction = {
      * @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: ReportStatusData) => void): void;
 };
 /**
  * Classe para consumo dos eventos de socket.

package/dist/socket-server.d.ts

@@ -10,7 +10,8 @@ export declare enum SocketEventType {
     NEW_CHAT = "new_chat",
     CHAT_FINISHED = "chat_finished",
     NOTIFICATION = "notification",
-    QR_CODE = "qr_code"
+    QR_CODE = "qr_code",
+    REPORT_STATUS = "report_status"
 }
 /**
  * Sala de chat, recebe todos eventos de um chat específico.
@@ -25,17 +26,28 @@ export type SocketAdminRoom = `sector:${SectorId}:admin`;
  */
 export type SocketMonitorRoom = `sector:${SectorId}:monitor`;
 /**
- * Sala de relatórios de chat, recebe eventos de relatórios de chat de um setor específico.
+ * Sala de relatórios, recebe eventos de um tipo relatório específico de um setor específico.
  */
-export type SocketChatReportsRoom = `sector:${SectorId}:chat_reports`;
+export type SocketReportsRoom = `sector:${number}:reports:${string}`;
 /**
  * Tipo de sala de socket.
  */
-export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketChatReportsRoom | SocketMonitorRoom;
+export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketReportsRoom | SocketMonitorRoom;
 /**
  * Ainda não implementado.
  */
 export type NotImplemented = unknown;
+/**
+ * Dados de status de um relatório.
+ */
+export type ReportStatusData = {
+    id: number;
+    type: string;
+    progress: number;
+    isCompleted: boolean;
+    isFailed: boolean;
+    error?: string;
+};
 /**
  * String representando um QR Code.
  */
@@ -52,6 +64,69 @@ 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;
@@ -60,6 +135,7 @@ export type EmitFunction = {
     (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: ReportStatusData): void;
 };
 /**
  * Classe para manipulação de eventos de socket.

package/dist/socket-server.js

@@ -13,6 +13,7 @@ var SocketEventType;
     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/package.json

@@ -1,35 +1,35 @@
-{
-	"name": "@in.pulse-crm/sdk",
-	"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",
-	"module": "./dist/index.js",
-	"exports": {
-		".": {
-			"import": "./dist/index.js",
-			"require": "./dist/index.js"
-		}
-	},
-	"scripts": {
-		"build": "tsc",
-		"prettier": "prettier --write .",
-		"prettier:check": "prettier --check ."
-	},
-	"repository": {
-		"type": "git",
-		"url": "in.pulse-crm"
-	},
-	"author": "Renan G. Dutra <r.granatodutra@gmail.com>",
-	"license": "ISC",
-	"dependencies": {
-		"@in.pulse-crm/utils": "^1.3.0",
-		"axios": "^1.8.3",
-		"socket.io-client": "^4.8.1"
-	},
-	"devDependencies": {
-		"@types/node": "^22.13.10",
-		"prettier": "^3.5.3",
-		"typescript": "^5.8.2"
-	}
-}
+{
+	"name": "@in.pulse-crm/sdk",
+	"version": "1.3.3",
+	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"module": "./dist/index.js",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"build": "tsc",
+		"prettier": "prettier --write .",
+		"prettier:check": "prettier --check ."
+	},
+	"repository": {
+		"type": "git",
+		"url": "in.pulse-crm"
+	},
+	"author": "Renan G. Dutra <r.granatodutra@gmail.com>",
+	"license": "ISC",
+	"dependencies": {
+		"@in.pulse-crm/utils": "^1.3.0",
+		"axios": "^1.8.3",
+		"socket.io-client": "^4.8.1"
+	},
+	"devDependencies": {
+		"@types/node": "^22.13.10",
+		"prettier": "^3.5.3",
+		"typescript": "^5.8.2"
+	}
+}

package/src/index.ts

@@ -1,55 +1,55 @@
-import AuthSDK, { LoginData, SessionData } from "./auth";
-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, { 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,
-    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
-};
+import AuthSDK, { LoginData, SessionData } from "./auth";
+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, { ChatReport, ChatReportFileFormat, GenerateChatReportOptions } 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,
+    ChatReport,
+    ChatReportFileFormat,
+    GenerateChatReportOptions,
+    SocketClientSDK,
+    JoinChatFunction,
+    JoinRoomFunction,
+    ListenEventFunction,
+    SocketServerSDK,
+    EmitFunction,
+    InstanceName,
+    SocketAdminRoom,
+    SocketReportsRoom,
+    SocketChatRoom,
+    SocketEventType,
+    SocketMonitorRoom,
+    SocketRoomType
+};

package/src/socket-client.ts

@@ -1,6 +1,6 @@
 import { Socket } from "socket.io-client";
 import { PhoneNumber } from "@in.pulse-crm/utils";
-import { ChatId, NotImplemented, QRCode, SocketEventType, SocketRoomType } from "./socket-server";
+import { ChatId, NotImplemented, QRCode, ReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
 
 /**
  * Função para entrar em uma sala de socket.
@@ -65,6 +65,13 @@ export type ListenEventFunction = {
      * @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: ReportStatusData) => void): void;
 }
 
 /**

package/src/socket-server.ts

@@ -11,7 +11,8 @@ export enum SocketEventType {
     NEW_CHAT = "new_chat",
     CHAT_FINISHED = "chat_finished",
     NOTIFICATION = "notification",
-    QR_CODE = "qr_code"
+    QR_CODE = "qr_code",
+    REPORT_STATUS = "report_status"
 }
 
 /**
@@ -30,20 +31,32 @@ export type SocketAdminRoom = `sector:${SectorId}:admin`;
 export type SocketMonitorRoom = `sector:${SectorId}:monitor`;
 
 /**
- * Sala de relatórios de chat, recebe eventos de relatórios de chat de um setor específico.
+ * Sala de relatórios, recebe eventos de um tipo relatório específico de um setor específico.
  */
-export type SocketChatReportsRoom = `sector:${SectorId}:chat_reports`;
+export type SocketReportsRoom = `sector:${number}:reports:${string}`;
 
 /**
  * Tipo de sala de socket.
  */
-export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketChatReportsRoom | SocketMonitorRoom;
+export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketReportsRoom | SocketMonitorRoom;
 
 /**
  * Ainda não implementado.
  */
 export type NotImplemented = unknown;
 
+/**
+ * Dados de status de um relatório.
+ */
+export type ReportStatusData = {
+    id: number;
+    type: string;
+    progress: number;
+    isCompleted: boolean;
+    isFailed: boolean;
+    error?: string;
+};
+
 /**
  * String representando um QR Code.
  */
@@ -64,6 +77,69 @@ export type SectorId = number;
  */
 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,
@@ -107,6 +183,12 @@ export type EmitFunction = {
         event: SocketEventType.MESSAGE_STATUS,
         value: NotImplemented
     ): void;
+    (
+        instanceName: string,
+        room: SocketReportsRoom,
+        event: SocketEventType.REPORT_STATUS,
+        value: ReportStatusData
+    ): void;
 };
 
 /**