@in.pulse-crm/sdk 2.0.4 → 2.0.5

package/dist/reports.client.d.ts

@@ -1,9 +1,39 @@
 import ApiClient from "./api-client";
 import { ChatsReport, GenerateChatsReportOptions } from "./types/reports.types";
 import { DataResponse, MessageResponse } from "./types/response.types";
+/**
+ * ReportsClient class to handle reports related API calls.
+ *
+ * This class extends the ApiClient class and provides methods to interact with the reports API.
+ * It includes methods to get, generate, and delete chat reports.
+ */
 export default class ReportsClient extends ApiClient {
+    /**
+     * Retrieves chat reports from the server.
+     *
+     * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+     */
     getChatsReports(): Promise<DataResponse<ChatsReport[]>>;
+    /**
+     * Generates a report for chat interactions based on the provided options.
+     *
+     * @param body - The options for generating the chats report, including filters and parameters.
+     * @returns A promise that resolves to the data of the generated chats report.
+     */
     generateChatsReport(body: GenerateChatsReportOptions): Promise<DataResponse<ChatsReport>>;
+    /**
+     * Deletes a chat report by its unique identifier.
+     *
+     * @param chatsReportId - The unique identifier of the chat report to be deleted.
+     * @returns A promise that resolves to a `MessageResponse` object containing the result of the deletion operation.
+     */
     deleteChatsReport(chatsReportId: number): Promise<MessageResponse>;
+    /**
+     * Sets the authorization token for the HTTP client.
+     *
+     * @param token - The Bearer token to be used for authentication.
+     *                This token will be included in the `Authorization` header
+     *                of all HTTP requests made by the client.
+     */
     setAuth(token: string): void;
 }

package/dist/reports.client.js

@@ -4,24 +4,55 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const api_client_1 = __importDefault(require("./api-client"));
+/**
+ * ReportsClient class to handle reports related API calls.
+ *
+ * This class extends the ApiClient class and provides methods to interact with the reports API.
+ * It includes methods to get, generate, and delete chat reports.
+ */
 class ReportsClient extends api_client_1.default {
+    /**
+     * Retrieves chat reports from the server.
+     *
+     * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+     */
     async getChatsReports() {
         const url = `/api/reports/chats`;
         const response = await this.httpClient.get(url);
         return response.data;
     }
+    /**
+     * Generates a report for chat interactions based on the provided options.
+     *
+     * @param body - The options for generating the chats report, including filters and parameters.
+     * @returns A promise that resolves to the data of the generated chats report.
+     */
     async generateChatsReport(body) {
         const url = `/api/reports/chats`;
         const response = await this.httpClient.post(url, body);
         return response.data;
     }
+    /**
+     * Deletes a chat report by its unique identifier.
+     *
+     * @param chatsReportId - The unique identifier of the chat report to be deleted.
+     * @returns A promise that resolves to a `MessageResponse` object containing the result of the deletion operation.
+     */
     async deleteChatsReport(chatsReportId) {
         const url = `/api/reports/chats/${chatsReportId}`;
         const response = await this.httpClient.delete(url);
         return response.data;
     }
+    /**
+     * Sets the authorization token for the HTTP client.
+     *
+     * @param token - The Bearer token to be used for authentication.
+     *                This token will be included in the `Authorization` header
+     *                of all HTTP requests made by the client.
+     */
     setAuth(token) {
-        this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+        this.httpClient.defaults.headers.common["Authorization"] =
+            `Bearer ${token}`;
     }
 }
 exports.default = ReportsClient;

package/dist/socket.client.d.ts

@@ -1,4 +1,5 @@
 import { ListenSocketEventFn, UnlistenSocketEventFn } from "./types/socket-events.types";
+import { JoinRoomFn } from "./types";
 /**
  * A client for interacting with a WebSocket server.
  * This class provides methods to connect to the server, listen for events,
@@ -46,4 +47,5 @@ export default class SocketClient {
      * @param callback - The callback function that was previously registered for the event.
      */
     off: UnlistenSocketEventFn;
+    joinRoom: JoinRoomFn;
 }

package/dist/socket.client.js

@@ -22,7 +22,7 @@ class SocketClient {
     constructor(baseUrl) {
         this.ws = (0, socket_io_client_1.io)(baseUrl, {
             autoConnect: false,
-            transports: ['websocket'],
+            transports: ["websocket"],
         });
     }
     /**
@@ -70,5 +70,8 @@ class SocketClient {
             return;
         this.ws.off(event, listener);
     };
+    joinRoom = (room) => {
+        this.ws.emit("join-room", room);
+    };
 }
 exports.default = SocketClient;

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

@@ -12,4 +12,7 @@ export type SocketServerMonitorRoom = SocketRoomWithSector<SocketClientMonitorRo
 export type SocketServerReportsRoom = SocketRoomWithSector<SocketClientReportsRoom>;
 export type SocketServerChatRoom = SocketRoomWithInstance<SocketClientChatRoom>;
 export type SocketServerRoom = SocketServerChatRoom | SocketServerAdminRoom | SocketServerMonitorRoom | SocketServerReportsRoom;
+export interface JoinRoomFn {
+    (room: SocketClientRoom): void;
+}
 export {};

package/package.json

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

package/src/reports.client.ts

@@ -2,7 +2,18 @@ import ApiClient from "./api-client";
 import { ChatsReport, GenerateChatsReportOptions } from "./types/reports.types";
 import { DataResponse, MessageResponse } from "./types/response.types";
 
+/**
+ * ReportsClient class to handle reports related API calls.
+ *
+ * This class extends the ApiClient class and provides methods to interact with the reports API.
+ * It includes methods to get, generate, and delete chat reports.
+ */
 export default class ReportsClient extends ApiClient {
+	/**
+	 * Retrieves chat reports from the server.
+	 *
+	 * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+	 */
 	public async getChatsReports() {
 		const url = `/api/reports/chats`;
 		const response =
@@ -11,6 +22,12 @@ export default class ReportsClient extends ApiClient {
 		return response.data;
 	}
 
+	/**
+	 * Generates a report for chat interactions based on the provided options.
+	 *
+	 * @param body - The options for generating the chats report, including filters and parameters.
+	 * @returns A promise that resolves to the data of the generated chats report.
+	 */
 	public async generateChatsReport(body: GenerateChatsReportOptions) {
 		const url = `/api/reports/chats`;
 		const response = await this.httpClient.post<DataResponse<ChatsReport>>(
@@ -21,6 +38,12 @@ export default class ReportsClient extends ApiClient {
 		return response.data;
 	}
 
+	/**
+	 * Deletes a chat report by its unique identifier.
+	 *
+	 * @param chatsReportId - The unique identifier of the chat report to be deleted.
+	 * @returns A promise that resolves to a `MessageResponse` object containing the result of the deletion operation.
+	 */
 	public async deleteChatsReport(chatsReportId: number) {
 		const url = `/api/reports/chats/${chatsReportId}`;
 		const response = await this.httpClient.delete<MessageResponse>(url);
@@ -28,7 +51,15 @@ export default class ReportsClient extends ApiClient {
 		return response.data;
 	}
 
+	/**
+	 * Sets the authorization token for the HTTP client.
+	 *
+	 * @param token - The Bearer token to be used for authentication.
+	 *                This token will be included in the `Authorization` header
+	 *                of all HTTP requests made by the client.
+	 */
 	public setAuth(token: string) {
-		this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+		this.httpClient.defaults.headers.common["Authorization"] =
+			`Bearer ${token}`;
 	}
 }

package/src/socket.client.ts

@@ -1,5 +1,10 @@
 import { io, Socket } from "socket.io-client";
-import { ListenSocketEventFn, SocketEventType, UnlistenSocketEventFn } from "./types/socket-events.types";
+import {
+	ListenSocketEventFn,
+	SocketEventType,
+	UnlistenSocketEventFn,
+} from "./types/socket-events.types";
+import { JoinRoomFn } from "./types";
 
 /**
  * A client for interacting with a WebSocket server.
@@ -7,72 +12,76 @@ import { ListenSocketEventFn, SocketEventType, UnlistenSocketEventFn } from "./t
  * and manage WebSocket connections.
  */
 export default class SocketClient {
-    private readonly ws: Socket;
-    private readonly listeners: Map<SocketEventType, any> = new Map();
+	private readonly ws: Socket;
+	private readonly listeners: Map<SocketEventType, any> = new Map();
 
-    /**
-     * Initializes a new instance of the socket client.
-     *
-     * @param baseUrl - The base URL of the WebSocket server to connect to.
-     *                  This URL is used to establish the WebSocket connection.
-     *
-     * The WebSocket client is configured with the following options:
-     * - `autoConnect`: Disabled by default to allow manual connection control.
-     * - `transports`: Uses the 'websocket' transport protocol exclusively.
-     */
-    constructor(baseUrl: string) {
-        this.ws = io(baseUrl, {
-            autoConnect: false,
-            transports: ['websocket'],
-        });
-    }
+	/**
+	 * Initializes a new instance of the socket client.
+	 *
+	 * @param baseUrl - The base URL of the WebSocket server to connect to.
+	 *                  This URL is used to establish the WebSocket connection.
+	 *
+	 * The WebSocket client is configured with the following options:
+	 * - `autoConnect`: Disabled by default to allow manual connection control.
+	 * - `transports`: Uses the 'websocket' transport protocol exclusively.
+	 */
+	constructor(baseUrl: string) {
+		this.ws = io(baseUrl, {
+			autoConnect: false,
+			transports: ["websocket"],
+		});
+	}
 
-    /**
-     * Establishes a WebSocket connection using the provided authentication token.
-     *
-     * @param token - The authentication token to be used for the WebSocket connection.
-     *                This token is sent as part of the WebSocket authentication payload.
-     */
-    public connect(token: string) {
-        this.ws.auth = { token };
-        this.ws.connect();
-    }
+	/**
+	 * Establishes a WebSocket connection using the provided authentication token.
+	 *
+	 * @param token - The authentication token to be used for the WebSocket connection.
+	 *                This token is sent as part of the WebSocket authentication payload.
+	 */
+	public connect(token: string) {
+		this.ws.auth = { token };
+		this.ws.connect();
+	}
 
-    /**
-     * Disconnects the WebSocket client from the server.
-     * This method terminates the current WebSocket connection
-     * by invoking the `disconnect` method on the WebSocket instance.
-     */
-    public disconnect() {
-        this.ws.disconnect();
-    }
+	/**
+	 * Disconnects the WebSocket client from the server.
+	 * This method terminates the current WebSocket connection
+	 * by invoking the `disconnect` method on the WebSocket instance.
+	 */
+	public disconnect() {
+		this.ws.disconnect();
+	}
 
-    /**
-     * Registers an event listener for a specified WebSocket event and provides a way to remove it.
-     *
-     * @param event - The name of the WebSocket event to listen for.
-     * @param callback - A function to be executed when the event is triggered. The function receives the event data as its argument.
-     * @returns A function that, when called, removes the event listener for the specified event.
-     */
-    public on: ListenSocketEventFn = (event, callback) => {
-        if (!this.listeners.get(event)) {
-            this.ws.on(event, (data) => {
-                callback(data);
-            });
+	/**
+	 * Registers an event listener for a specified WebSocket event and provides a way to remove it.
+	 *
+	 * @param event - The name of the WebSocket event to listen for.
+	 * @param callback - A function to be executed when the event is triggered. The function receives the event data as its argument.
+	 * @returns A function that, when called, removes the event listener for the specified event.
+	 */
+	public on: ListenSocketEventFn = (event, callback) => {
+		if (!this.listeners.get(event)) {
+			this.ws.on(event, (data) => {
+				callback(data);
+			});
 
-            this.listeners.set(event, callback);
-        }
-    }
+			this.listeners.set(event, callback);
+		}
+	};
 
-    /**
-     * Removes a previously registered event listener from the WebSocket connection.
-     *
-     * @param event - The name of the event to stop listening for.
-     * @param callback - The callback function that was previously registered for the event.
-     */
-    public off: UnlistenSocketEventFn = (event) => {
-        const listener = this.listeners.get(event);
-        if (!listener) return;
-        this.ws.off(event, listener);
-    }
-}
+	/**
+	 * Removes a previously registered event listener from the WebSocket connection.
+	 *
+	 * @param event - The name of the event to stop listening for.
+	 * @param callback - The callback function that was previously registered for the event.
+	 */
+	public off: UnlistenSocketEventFn = (event) => {
+		const listener = this.listeners.get(event);
+		if (!listener) return;
+		this.ws.off(event, listener);
+	};
+
+	public joinRoom: JoinRoomFn = (room) => {
+		this.ws.emit("join-room", room);
+	};
+}

package/src/types/socket-rooms.types.ts

@@ -10,13 +10,18 @@ export type SocketClientChatRoom = `chat:${PhoneNumber}`;
 export type SocketClientAdminRoom = "admin";
 export type SocketClientMonitorRoom = `monitor`;
 export type SocketClientReportsRoom = `reports:${ReportType}`;
-export type SocketClientRoom = SocketClientChatRoom | SocketClientAdminRoom | SocketClientReportsRoom | SocketClientMonitorRoom;
+export type SocketClientRoom =
+	| SocketClientChatRoom
+	| SocketClientAdminRoom
+	| SocketClientReportsRoom
+	| SocketClientMonitorRoom;
 
 // Interface que incluí o nome da instancia na sala de socket;
 type SocketRoomWithInstance<T extends string> = `${string}:${T}`;
 
 // Interface que incluí o nome da instancia e o id do setor na sala de socket;
-type SocketRoomWithSector<T extends string> = SocketRoomWithInstance<`${number}:${T}`>;
+type SocketRoomWithSector<T extends string> =
+	SocketRoomWithInstance<`${number}:${T}`>;
 
 /* 
     Salas de Socket do lado do servidor;
@@ -25,7 +30,17 @@ type SocketRoomWithSector<T extends string> = SocketRoomWithInstance<`${number}:
     pertence, e não as salas de outras instancias.
 */
 export type SocketServerAdminRoom = SocketRoomWithSector<SocketClientAdminRoom>;
-export type SocketServerMonitorRoom = SocketRoomWithSector<SocketClientMonitorRoom>;
-export type SocketServerReportsRoom = SocketRoomWithSector<SocketClientReportsRoom>;
+export type SocketServerMonitorRoom =
+	SocketRoomWithSector<SocketClientMonitorRoom>;
+export type SocketServerReportsRoom =
+	SocketRoomWithSector<SocketClientReportsRoom>;
 export type SocketServerChatRoom = SocketRoomWithInstance<SocketClientChatRoom>;
-export type SocketServerRoom = SocketServerChatRoom | SocketServerAdminRoom | SocketServerMonitorRoom | SocketServerReportsRoom;
+export type SocketServerRoom =
+	| SocketServerChatRoom
+	| SocketServerAdminRoom
+	| SocketServerMonitorRoom
+	| SocketServerReportsRoom;
+
+export interface JoinRoomFn {
+	(room: SocketClientRoom): void;
+}