@in.pulse-crm/sdk 1.3.4 → 1.3.6

package/dist/index.d.ts

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

package/dist/index.js

@@ -49,7 +49,7 @@ exports.UserSDK = user_1.default;
 Object.defineProperty(exports, "UserRole", { enumerable: true, get: function () { return user_1.UserRole; } });
 const report_1 = __importStar(require("./report"));
 exports.ReportSDK = report_1.default;
-Object.defineProperty(exports, "ChatReportFileFormat", { enumerable: true, get: function () { return report_1.ChatReportFileFormat; } });
+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"));

package/dist/report.d.ts

@@ -1,6 +1,11 @@
 import { AxiosInstance } from "axios";
 import { DataResponse, MessageResponse } from "./response";
-export interface ChatReport {
+export declare enum ChatsReportStatus {
+    PENDING = "PENDING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
+export interface ChatsReport {
     id: number;
     userId: string;
     fileId: number;
@@ -9,15 +14,18 @@ export interface ChatReport {
     startDate: string;
     endDate: string;
     exportDate: string;
+    chats: number;
+    messages: number;
+    status: ChatsReportStatus;
 }
-export interface GenerateChatReportOptions {
+export interface GenerateChatsReportOptions {
     instance: string;
     userId: string;
-    format: ChatReportFileFormat;
+    format: ChatsReportFileFormat;
     startDate: string;
     endDate: string;
 }
-export declare enum ChatReportFileFormat {
+export declare enum ChatsReportFileFormat {
     TXT = "txt",
     CSV = "csv",
     PDF = "pdf"
@@ -25,7 +33,7 @@ export declare enum ChatReportFileFormat {
 export default class ReportSDK {
     private readonly httpClient;
     constructor(httpClient: AxiosInstance);
-    getChatsReports(instanceName: string): Promise<DataResponse<ChatReport[]>>;
-    generateChatReport({ instance, ...body }: GenerateChatReportOptions): Promise<DataResponse<ChatReport>>;
-    deleteReport(instanceName: string, reportId: number): Promise<MessageResponse>;
+    getChatsReports(instanceName: string): Promise<DataResponse<ChatsReport[]>>;
+    generateChatsReport({ instance, ...body }: GenerateChatsReportOptions): Promise<DataResponse<ChatsReport>>;
+    deleteChatsReport(instanceName: string, chatsReportId: number): Promise<MessageResponse>;
 }

package/dist/report.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatReportFileFormat = void 0;
-var ChatReportFileFormat;
-(function (ChatReportFileFormat) {
-    ChatReportFileFormat["TXT"] = "txt";
-    ChatReportFileFormat["CSV"] = "csv";
-    ChatReportFileFormat["PDF"] = "pdf";
-})(ChatReportFileFormat || (exports.ChatReportFileFormat = ChatReportFileFormat = {}));
+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) {
@@ -17,13 +23,13 @@ class ReportSDK {
         const response = await this.httpClient.get(url);
         return response.data;
     }
-    async generateChatReport({ instance, ...body }) {
+    async generateChatsReport({ instance, ...body }) {
         const url = `/${instance}/reports/chats`;
         const response = await this.httpClient.post(url, body);
         return response.data;
     }
-    async deleteReport(instanceName, reportId) {
-        const url = `/${instanceName}/reports/chats/${reportId}`;
+    async deleteChatsReport(instanceName, chatsReportId) {
+        const url = `/${instanceName}/reports/chats/${chatsReportId}`;
         const response = await this.httpClient.delete(url);
         return response.data;
     }

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, ReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
+import { ChatId, NotImplemented, QRCode, ChatsReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
 /**
  * Função para entrar em uma sala de socket.
  */
@@ -61,7 +61,7 @@ export type ListenEventFunction = {
      * @trigger Quando o status de um relatório é atualizado
      * @target Sala de relatórios
      */
-    (event: SocketEventType.REPORT_STATUS, listener: (data: ReportStatusData) => void): void;
+    (event: SocketEventType.REPORT_STATUS, listener: (data: ChatsReportStatusData) => void): void;
 };
 /**
  * Classe para consumo dos eventos de socket.

package/dist/socket-server.d.ts

@@ -38,18 +38,25 @@ export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketReportsRoo
  */
 export type NotImplemented = unknown;
 /**
- * Dados de status de um relatório.
+ * Dados de status de um relatório de conversas.
  */
-export type ReportStatusData = {
+export type ChatsReportStatusData = {
     id: number;
-    type: string;
+    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: string;
+    type: "chats-report";
     isCompleted: false;
     isFailed: true;
     error: string;
@@ -141,7 +148,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;
+    (instanceName: string, room: SocketReportsRoom, event: SocketEventType.REPORT_STATUS, value: ChatsReportStatusData): void;
 };
 /**
  * Classe para manipulação de eventos de socket.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "1.3.4",
+	"version": "1.3.6",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package/src/file.ts

@@ -35,7 +35,6 @@ export enum FileDirType {
     MODELS = "models",
 }
 
-
 /**
  * Representa um arquivo no sistema.
  */

package/src/index.ts

@@ -3,7 +3,7 @@ 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 ReportSDK, { ChatsReport, ChatsReportFileFormat, GenerateChatsReportOptions } from "./report";
 import SocketClientSDK, { JoinChatFunction, JoinRoomFunction, ListenEventFunction } from "./socket-client";
 import
 SocketServerSDK,
@@ -36,9 +36,9 @@ export {
     PaginatedResponse,
     QueryResponse,
     ReportSDK,
-    ChatReport,
-    ChatReportFileFormat,
-    GenerateChatReportOptions,
+    ChatsReport as ChatReport,
+    ChatsReportFileFormat as ChatReportFileFormat,
+    GenerateChatsReportOptions as GenerateChatReportOptions,
     SocketClientSDK,
     JoinChatFunction,
     JoinRoomFunction,

package/src/report.ts

@@ -1,7 +1,13 @@
 import { AxiosInstance } from "axios";
 import { DataResponse, MessageResponse } from "./response";
 
-export interface ChatReport {
+export enum ChatsReportStatus {
+	PENDING = "PENDING",
+	COMPLETED = "COMPLETED",
+	FAILED = "FAILED",
+}
+
+export interface ChatsReport {
 	id: number;
 	userId: string;
 	fileId: number;
@@ -10,17 +16,20 @@ export interface ChatReport {
 	startDate: string;
 	endDate: string;
 	exportDate: string;
+	chats: number;
+	messages: number;
+	status: ChatsReportStatus;
 }
 
-export interface GenerateChatReportOptions {
+export interface GenerateChatsReportOptions {
 	instance: string;
 	userId: string;
-	format: ChatReportFileFormat;
+	format: ChatsReportFileFormat;
 	startDate: string;
 	endDate: string;
 }
 
-export enum ChatReportFileFormat {
+export enum ChatsReportFileFormat {
 	TXT = "txt",
 	CSV = "csv",
 	PDF = "pdf",
@@ -32,17 +41,17 @@ export default class ReportSDK {
 	public async getChatsReports(instanceName: string) {
 		const url = `/${instanceName}/reports/chats`;
 		const response =
-			await this.httpClient.get<DataResponse<Array<ChatReport>>>(url);
+			await this.httpClient.get<DataResponse<Array<ChatsReport>>>(url);
 
 		return response.data;
 	}
 
-	public async generateChatReport({
+	public async generateChatsReport({
 		instance,
 		...body
-	}: GenerateChatReportOptions) {
+	}: GenerateChatsReportOptions) {
 		const url = `/${instance}/reports/chats`;
-		const response = await this.httpClient.post<DataResponse<ChatReport>>(
+		const response = await this.httpClient.post<DataResponse<ChatsReport>>(
 			url,
 			body,
 		);
@@ -50,8 +59,8 @@ export default class ReportSDK {
 		return response.data;
 	}
 
-	public async deleteReport(instanceName: string, reportId: number) {
-		const url = `/${instanceName}/reports/chats/${reportId}`;
+	public async deleteChatsReport(instanceName: string, chatsReportId: number) {
+		const url = `/${instanceName}/reports/chats/${chatsReportId}`;
 		const response = await this.httpClient.delete<MessageResponse>(url);
 
 		return response.data;

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, ReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
+import { ChatId, NotImplemented, QRCode, ChatsReportStatusData, SocketEventType, SocketRoomType } from "./socket-server";
 
 /**
  * Função para entrar em uma sala de socket.
@@ -71,7 +71,7 @@ export type ListenEventFunction = {
      * @trigger Quando o status de um relatório é atualizado
      * @target Sala de relatórios
      */
-    (event: SocketEventType.REPORT_STATUS, listener: (data: ReportStatusData) => void): void;
+    (event: SocketEventType.REPORT_STATUS, listener: (data: ChatsReportStatusData) => void): void;
 }
 
 /**

package/src/socket-server.ts

@@ -46,18 +46,25 @@ export type SocketRoomType = SocketChatRoom | SocketAdminRoom | SocketReportsRoo
 export type NotImplemented = unknown;
 
 /**
- * Dados de status de um relatório.
+ * Dados de status de um relatório de conversas.
  */
-export type ReportStatusData = {
+export type ChatsReportStatusData = {
     id: number;
-    type: string;
+    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: string;
+    type: "chats-report";
     isCompleted: false;
     isFailed: true;
     error: string;
@@ -193,7 +200,7 @@ export type EmitFunction = {
         instanceName: string,
         room: SocketReportsRoom,
         event: SocketEventType.REPORT_STATUS,
-        value: ReportStatusData
+        value: ChatsReportStatusData
     ): void;
 };