@in.pulse-crm/sdk 1.6.2 → 2.0.0

package/src/users.client.ts

@@ -0,0 +1,74 @@
+import { DataResponse, PaginatedResponse } from "./types/response.types";
+import { CreateUserDTO, UpdateUserDTO, User } from "./types/user.types";
+import ApiClient from "./api-client";
+
+/**
+ * SDK para operações de usuários.
+ */
+export default class UsersClient extends ApiClient {
+    /**
+     * Obtém a lista de usuários.
+     * @returns Uma resposta paginada contendo os usuários.
+     */
+    public async getUsers() {
+        const response = await this.httpClient.get<PaginatedResponse<User>>(`/users`);
+
+        return response.data;
+    }
+
+    /**
+     * Obtém um usuário pelo ID.
+     * @param userId - O ID do usuário.
+     * @returns Uma resposta contendo os dados do usuário.
+     */
+    public async getUserById(userId: number) {
+        const response = await this.httpClient.get<DataResponse<User>>(`/users/${userId}`);
+
+        return response.data;
+    }
+
+    /**
+     * Cria um novo usuário.
+     * @param data - Os dados para criação do usuário.
+     * @returns Uma resposta contendo os dados do usuário criado.
+     * @throws Um erro se a criação do usuário falhar.
+     */
+    public async createUser(data: CreateUserDTO) {
+        try {
+            const response = await this.httpClient.post<DataResponse<User>>(`/users`, data);
+
+            return response.data;
+        } catch (error) {
+            throw new Error("Failed to create user", { cause: error });
+        }
+    }
+
+    /**
+     * Atualiza um usuário existente.
+     * @param userId - O ID do usuário.
+     * @param data - Os dados para atualização do usuário.
+     * @returns Uma resposta contendo os dados do usuário atualizado.
+     * @throws Um erro se a atualização do usuário falhar.
+     */
+    public async updateUser(userId: string, data: UpdateUserDTO) {
+        try {
+            const response = await this.httpClient.patch<DataResponse<User>>(
+                `/users/${userId}`,
+                data,
+            );
+
+            return response.data;
+        } catch (error) {
+            throw new Error("Failed to update user", { cause: error });
+        }
+    }
+
+    /**
+     * Sets the authorization token for HTTP requests.
+     *
+     * @param token - The authentication token to be used in the `Authorization` header.
+     */
+    public setAuth(token: string) {
+        this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+    }
+}

package/dist/auth.sdk.d.ts

@@ -1,15 +0,0 @@
-import { CreateAxiosDefaults } from "axios";
-import { DataResponse, LoginData, SessionData, User } from "@in.pulse-crm/types";
-interface AuthSDKOptions {
-    axiosConfig: CreateAxiosDefaults;
-}
-declare class AuthSDK {
-    private readonly _api;
-    constructor(props: AuthSDKOptions);
-    login(instance: string, login: string, password: string): Promise<DataResponse<LoginData>>;
-    fetchSessionData(instance: string, token: string): Promise<DataResponse<SessionData>>;
-    fetchSessionUser(instance: string, token: string): Promise<DataResponse<User>>;
-    isAuthenticated(instance: string, token: string): Promise<boolean>;
-    isAuthorized(instance: string, token: string, authorizedRoles: string[]): Promise<boolean>;
-}
-export default AuthSDK;

package/dist/auth.sdk.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const utils_1 = require("@in.pulse-crm/utils");
-class AuthSDK {
-    _api;
-    constructor(props) {
-        this._api = axios_1.default.create(props.axiosConfig);
-    }
-    async login(instance, login, password) {
-        const response = await this._api.post(`${instance}/login`, { LOGIN: login, SENHA: password });
-        return response.data;
-    }
-    async fetchSessionData(instance, token) {
-        const response = await this._api
-            .get(`/${instance}/auth`, {
-            headers: {
-                authorization: token,
-            },
-        })
-            .catch((error) => {
-            const message = (0, utils_1.sanitizeErrorMessage)(error);
-            throw new Error("Failed to fetch session data! " + message);
-        });
-        return response.data;
-    }
-    async fetchSessionUser(instance, token) {
-        const response = await this._api
-            .get(`/${instance}/auth/user`, {
-            headers: {
-                authorization: token,
-            },
-        })
-            .catch((error) => {
-            const message = (0, utils_1.sanitizeErrorMessage)(error);
-            throw new Error("Failed to fetch session user! " + message);
-        });
-        return response.data;
-    }
-    async isAuthenticated(instance, token) {
-        try {
-            const { data } = await this.fetchSessionData(instance, token);
-            return !!data.userId;
-        }
-        catch {
-            return false;
-        }
-    }
-    async isAuthorized(instance, token, authorizedRoles) {
-        try {
-            const { data } = await this.fetchSessionData(instance, token);
-            return authorizedRoles.includes(data.role);
-        }
-        catch {
-            return false;
-        }
-    }
-}
-exports.default = AuthSDK;

package/dist/instance.sdk.d.ts

@@ -1,10 +0,0 @@
-import { CreateAxiosDefaults } from "axios";
-interface InstanceSDKOptions {
-    axiosConfig: CreateAxiosDefaults;
-}
-declare class InstanceSDK {
-    private readonly _api;
-    constructor(props: InstanceSDKOptions);
-    executeQuery<T>(instance: string, query: string, parameters: Array<any>): Promise<T>;
-}
-export default InstanceSDK;

package/dist/instance.sdk.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-class InstanceSDK {
-    _api;
-    constructor(props) {
-        this._api = axios_1.default.create(props.axiosConfig);
-    }
-    async executeQuery(instance, query, parameters) {
-        const response = await this._api
-            .post(`/${instance}/query`, { query, parameters })
-            .catch((error) => {
-            if (error.response?.data?.message) {
-                throw new Error(error.response.data.message);
-            }
-            if (error.response?.status) {
-                throw new Error(`Failed to execute query, status: ${error.response.status}`);
-            }
-            throw new Error(error.message);
-        });
-        return response.data.result;
-    }
-}
-exports.default = InstanceSDK;

package/dist/socket-client.d.ts

@@ -1,57 +0,0 @@
-import { Socket } from "socket.io-client";
-import { JoinChatFunction, JoinRoomFunction, LeaveChatFunction, LeaveRoomFunction, ListenEventFunction } from "./types/socket-client.types";
-/**
- * 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;
-    /**
-     * 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.
-     *
-     * @param room - O tipo de sala a ser ingressada.
-     */
-    joinRoom: JoinRoomFunction;
-    /**
-     * 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,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Classe para consumo dos eventos de socket.
- */
-class SocketClientSDK {
-    io;
-    constructor(io) {
-        this.io = io;
-    }
-    /**
-     * 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);
-    };
-    /**
-     * 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", `${room}`);
-    };
-    /**
-     * Entra em um chat.
-     *
-     * @param phone - O número de telefone do chat a ser ingressado.
-     */
-    joinChat = (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 };
-    }
-}
-exports.default = SocketClientSDK;

package/dist/socket-server.d.ts

@@ -1,17 +0,0 @@
-import { AxiosInstance } from "axios";
-import { EmitFunction } from "./types/socket-server.types";
-/**
- * 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

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * 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/dist/src/sdks/auth.sdk.js

@@ -1,52 +0,0 @@
-"use strict";
-var __importDefault =
-	(this && this.__importDefault) ||
-	function (mod) {
-		return mod && mod.__esModule ? mod : { default: mod };
-	};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-class AuthSDK {
-	_api;
-	constructor(props) {
-		this._api = axios_1.default.create(props.axiosConfig);
-	}
-	async fetchSessionData(instance, token) {
-		const response = await this._api
-			.get(`/${instance}/auth`, {
-				headers: {
-					Authorization: `Bearer ${token}`,
-				},
-			})
-			.catch((error) => {
-				console.error(error);
-				if (error.response?.data?.message) {
-					throw new Error(error.response.data.message);
-				}
-				if (error.response?.status) {
-					throw new Error(
-						`Failed to authenticate, status: ${error.response.status}`,
-					);
-				}
-				throw new Error(error.message);
-			});
-		return response.data.data;
-	}
-	async isAuthenticated(instance, token) {
-		try {
-			await this.fetchSessionData(instance, token);
-			return true;
-		} catch {
-			return false;
-		}
-	}
-	async isAuthorized(instance, token, authorizedRoles) {
-		try {
-			const session = await this.fetchSessionData(instance, token);
-			return authorizedRoles.includes(session.role);
-		} catch {
-			return false;
-		}
-	}
-}
-exports.default = AuthSDK;

package/dist/src/sdks/index.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault =
-	(this && this.__importDefault) ||
-	function (mod) {
-		return mod && mod.__esModule ? mod : { default: mod };
-	};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstanceSDK = exports.AuthSDK = exports.UserSDK = void 0;
-const user_sdk_1 = __importDefault(require("./user.sdk"));
-exports.UserSDK = user_sdk_1.default;
-const auth_sdk_1 = __importDefault(require("./auth.sdk"));
-exports.AuthSDK = auth_sdk_1.default;
-const instance_sdk_1 = __importDefault(require("./instance.sdk"));
-exports.InstanceSDK = instance_sdk_1.default;

package/dist/src/sdks/instance.sdk.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault =
-	(this && this.__importDefault) ||
-	function (mod) {
-		return mod && mod.__esModule ? mod : { default: mod };
-	};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-class InstanceSDK {
-	_api;
-	constructor(props) {
-		this._api = axios_1.default.create(props.axiosConfig);
-	}
-	async executeQuery(instance, query, parameters) {
-		const response = await this._api
-			.post(`/${instance}/query`, { query, parameters })
-			.catch((error) => {
-				if (error.response?.data?.message) {
-					throw new Error(error.response.data.message);
-				}
-				if (error.response?.status) {
-					throw new Error(
-						`Failed to execute query, status: ${error.response.status}`,
-					);
-				}
-				throw new Error(error.message);
-			});
-		return response.data.result;
-	}
-}
-exports.default = InstanceSDK;

package/dist/src/sdks/user.sdk.js

@@ -1,42 +0,0 @@
-"use strict";
-var __importDefault =
-	(this && this.__importDefault) ||
-	function (mod) {
-		return mod && mod.__esModule ? mod : { default: mod };
-	};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-class UserSDK {
-	_api;
-	constructor(props) {
-		this._api = axios_1.default.create(props.axiosConfig);
-	}
-	async getUsers(instance) {
-		const response = await this._api.get(`/${instance}/users`);
-		return response.data;
-	}
-	async getUserById(instance, userId) {
-		const response = await this._api.get(`/${instance}/users/${userId}`);
-		return response.data;
-	}
-	async createUser(instance, data) {
-		try {
-			const response = await this._api.post(`/${instance}/users`, data);
-			return response.data;
-		} catch (error) {
-			throw new Error("Failed to create user", { cause: error });
-		}
-	}
-	async updateUser(instance, userId, data) {
-		try {
-			const response = await this._api.patch(
-				`/${instance}/users/${userId}`,
-				data,
-			);
-			return response.data;
-		} catch (error) {
-			throw new Error("Failed to update user", { cause: error });
-		}
-	}
-}
-exports.default = UserSDK;

package/dist/src/types/user.types.js

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

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

@@ -1,97 +0,0 @@
-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 SocketClientChatRoom = `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 = SocketClientChatRoom | 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

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