@in.pulse-crm/sdk 1.0.7 → 1.2.0

package/dist/user.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserRole = void 0;
+/**
+ * Enum que representa os diferentes papéis de usuário dentro do sistema.
+ *
+ * @enum {string}
+ * @property {string} ADMIN - Representa um papel de administrador.
+ * @property {string} ACTIVE - Representa um papel de usuário ativo.
+ * @property {string} RECEPTIONIST - Representa um papel de recepcionista.
+ * @property {string} BOTH - Representa um papel que combina tanto recepcionista quanto usuário ativo.
+ */
+var UserRole;
+(function (UserRole) {
+    UserRole["ADMIN"] = "ADMIN";
+    UserRole["ACTIVE"] = "ATIVO";
+    UserRole["RECEPTIONIST"] = "RECEP";
+    UserRole["BOTH"] = "AMBOS";
+})(UserRole || (exports.UserRole = UserRole = {}));
+/**
+ * SDK para operações de usuários.
+ */
+class UserSDK {
+    httpClient;
+    /**
+     * Cria uma instância do SDK de usuários.
+     * @param httpClient - A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Obtém a lista de usuários.
+     * @param instance - O nome da instância.
+     * @returns Uma resposta paginada contendo os usuários.
+     */
+    async getUsers(instance) {
+        const response = await this.httpClient.get(`/${instance}/users`);
+        return response.data;
+    }
+    /**
+     * Obtém um usuário pelo ID.
+     * @param instance - O nome da instância.
+     * @param userId - O ID do usuário.
+     * @returns Uma resposta contendo os dados do usuário.
+     */
+    async getUserById(instance, userId) {
+        const response = await this.httpClient.get(`/${instance}/users/${userId}`);
+        return response.data;
+    }
+    /**
+     * Cria um novo usuário.
+     * @param instance - O nome da instância.
+     * @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.
+     */
+    async createUser(instance, data) {
+        try {
+            const response = await this.httpClient.post(`/${instance}/users`, data);
+            return response.data;
+        }
+        catch (error) {
+            throw new Error("Failed to create user", { cause: error });
+        }
+    }
+    /**
+     * Atualiza um usuário existente.
+     * @param instance - O nome da instância.
+     * @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.
+     */
+    async updateUser(instance, userId, data) {
+        try {
+            const response = await this.httpClient.patch(`/${instance}/users/${userId}`, data);
+            return response.data;
+        }
+        catch (error) {
+            throw new Error("Failed to update user", { cause: error });
+        }
+    }
+}
+exports.default = UserSDK;

package/package.json

@@ -1,8 +1,16 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "1.0.7",
+	"version": "1.2.0",
 	"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 .",
@@ -16,11 +24,10 @@
 	"license": "ISC",
 	"dependencies": {
 		"@in.pulse-crm/utils": "^1.0.0",
-		"axios": "^1.8.1"
+		"axios": "^1.8.3"
 	},
 	"devDependencies": {
-		"@in.pulse-crm/types": "^1.0.3",
-		"@types/node": "^22.13.8",
+		"@types/node": "^22.13.10",
 		"prettier": "^3.5.3",
 		"typescript": "^5.8.2"
 	}

package/src/auth.ts

@@ -0,0 +1,139 @@
+import { AxiosInstance } from "axios";
+import { User } from "./user";
+import { sanitizeErrorMessage } from "@in.pulse-crm/utils";
+import { DataResponse } from "./response";
+
+export interface LoginData {
+    /**
+     * Token de autenticação.
+     */
+    token: string;
+    /**
+     * Dados do usuário.
+     */
+    user: User;
+}
+
+export interface SessionData {
+    /**
+     * ID do usuário.
+     */
+    userId: number;
+    /**
+     * Papel do usuário.
+     */
+    role: string;
+    /**
+     * Nome da instância.
+     */
+    instance: string;
+}
+
+/**
+ * Classe AuthSDK para interagir com a API de autenticação.
+ */
+export default class AuthSDK {
+
+    /**
+     * Cria uma instância do SDK de autenticação.
+     * @param {AxiosInstance} httpClient A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(private readonly httpClient: AxiosInstance) {
+
+    }
+
+    /**
+     * Realiza o login do usuário.
+     * @param {string} instanceName Nome da instância do Inpulse.
+     * @param {string} username Nome de usuário.
+     * @param {string} password Senha do usuário.
+     * @returns {Promise<DataResponse<LoginData>>} Dados de login.
+     */
+    public async login(instanceName: string, username: string, password: string): Promise<DataResponse<LoginData>> {
+        const response = await this.httpClient.post<DataResponse<LoginData>>(
+            `${instanceName}/login`,
+            { LOGIN: username, SENHA: password },
+        );
+
+        return response.data;
+    }
+
+    /**
+     * Busca os dados da sessão.
+     * @param {string} instanceName Nome da instância do Inpulse.
+     * @param {string} authToken Token de autenticação.
+     * @returns {Promise<DataResponse<AuthTypes.SessionData>>} Dados da sessão.
+     */
+    public async fetchSessionData(instanceName: string, authToken: string): Promise<DataResponse<SessionData>> {
+        const response = await this.httpClient
+            .get<DataResponse<SessionData>>(`/${instanceName}/auth`, {
+                headers: {
+                    authorization: authToken,
+                },
+            })
+            .catch((error) => {
+                const message = sanitizeErrorMessage(error);
+                throw new Error("Failed to fetch session data! " + message);
+            });
+
+        return response.data;
+    }
+
+    /**
+     * Busca os dados do usuário da sessão.
+     * @param {string} instanceName Nome da instância do Inpulse.
+     * @param {string} authToken Token de autenticação.
+     * @returns {Promise<DataResponse<AuthTypes.User>>} Dados do usuário.
+     */
+    public async fetchSessionUser(instanceName: string, authToken: string): Promise<DataResponse<User>> {
+        const response = await this.httpClient
+            .get<DataResponse<User>>(`/${instanceName}/auth/user`, {
+                headers: {
+                    authorization: authToken,
+                },
+            })
+            .catch((error) => {
+                const message = sanitizeErrorMessage(error);
+                throw new Error("Failed to fetch session user! " + message);
+            });
+
+        return response.data;
+    }
+
+    /**
+     * Verifica se o usuário está autenticado.
+     * @param {string} instanceName Nome da instância do Inpulse.
+     * @param {string} authToken Token de autenticação.
+     * @returns {Promise<boolean>} Verdadeiro se o usuário estiver autenticado, falso caso contrário.
+     */
+    public async isAuthenticated(instanceName: string, authToken: string): Promise<boolean> {
+        try {
+            const { data } = await this.fetchSessionData(instanceName, authToken);
+
+            return !!data.userId;
+        } catch {
+            return false;
+        }
+    }
+
+    /**
+     * Verifica se o usuário está autorizado.
+     * @param {string} instanceName Nome da instância do Inpulse.
+     * @param {string} authToken Token de autenticação.
+     * @param {string[]} authorizedRoles Lista de papéis autorizados.
+     * @returns {Promise<boolean>} Verdadeiro se o usuário estiver autorizado, falso caso contrário.
+     */
+    public async isAuthorized(
+        instanceName: string,
+        authToken: string,
+        authorizedRoles: string[],
+    ): Promise<boolean> {
+        try {
+            const { data } = await this.fetchSessionData(instanceName, authToken);
+
+            return authorizedRoles.includes(data.role);
+        } catch {
+            return false;
+        }
+    }
+}

package/src/file.ts

@@ -0,0 +1,137 @@
+import { AxiosInstance } from "axios";
+import { DataResponse } from "./response";
+
+interface UploadFileOptions {
+    /**
+     * Nome da instância onde o arquivo está armazenado.
+     */
+    instance: string;
+
+    /**
+     * Tipo de diretório onde o arquivo está armazenado.
+     */
+    dirType: FileDirType;
+
+    /**
+     * Nome do arquivo.
+     */
+    fileName: string;
+
+    /**
+     * Buffer com o conteúdo do arquivo.
+     */
+    buffer: Buffer;
+}
+
+/**
+ * Enum que representa os tipos de diretórios de arquivos.
+ * 
+ * @enum {string}
+ * @property {string} PUBLIC - Representa o diretório público.
+ * @property {string} MODELS - Representa o diretório de modelos.
+ */
+export enum FileDirType {
+    PUBLIC = "public",
+    MODELS = "models",
+}
+
+
+/**
+ * Representa um arquivo no sistema.
+ */
+export interface File {
+    /**
+     * Identificador único para o arquivo.
+     */
+    id: number;
+
+    /**
+     * Identificador único para o arquivo no armazenamento.
+     */
+    id_storage: string;
+
+    /**
+     * Identificador único para o armazenamento.
+     */
+    storage_id: number;
+
+    /**
+     * Nome do arquivo.
+     */
+    name: string;
+
+    /**
+     * Tipo MIME do arquivo.
+     */
+    mime_type: string;
+
+    /**
+     * Tamanho do arquivo em bytes.
+     */
+    size: number;
+
+    /**
+     * Tipo de diretório onde o arquivo está armazenado.
+     */
+    dir_type: FileDirType;
+
+    /**
+     * Data e hora em que o arquivo foi criado.
+     */
+    created_at: Date;
+}
+
+
+/**
+ * SDK para operações de arquivos.
+ */
+class FileSDK {
+    /**
+     * Cria uma instância do SDK de arquivos.
+     * @param httpClient A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(private readonly httpClient: AxiosInstance) { }
+
+    /**
+     * Busca um arquivo pelo ID.
+     * @param {number} id - ID do arquivo.
+     * @returns {Promise<Buffer>} Um buffer contendo os dados do arquivo.
+     */
+    public async fetchFile(id: number): Promise<Buffer> {
+        const response = await this.httpClient.get(`/files/${id}`, {
+            responseType: "arraybuffer"
+        });
+        const buffer = Buffer.from(response.data, "binary");
+
+        return buffer;
+    }
+
+    /**
+     * Faz o upload de um arquivo.
+     * @param {UploadFileOptions} props - Opções para o upload do arquivo.
+     * @returns {Promise<File>} Os dados do arquivo enviado.
+     */
+    public async uploadFile(props: UploadFileOptions): Promise<File> {
+        const form = new FormData();
+        form.append("instance", props.instance);
+        form.append("dirType", props.dirType);
+        form.append("file", new Blob([props.buffer]), props.fileName);
+
+        const response = await this.httpClient.post<DataResponse<File>>("/files", form, {
+            headers: { "Content-Type": "multipart/form-data" }
+        });
+
+        return response.data.data;
+    }
+
+    /**
+     * Deleta um arquivo pelo ID.
+     * @param {number} id - ID do arquivo.
+     * @returns {Promise<void>}
+     */
+    public async deleteFile(id: number): Promise<void> {
+        await this.httpClient.delete(`/files/${id}`);
+    }
+}
+
+export default FileSDK;

package/src/index.ts

@@ -1,5 +1,24 @@
-import AuthSDK from "./auth.sdk";
-import UserSDK from "./user.sdk";
-import InstanceSDK from "./instance.sdk";
+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";
 
-export { AuthSDK, UserSDK, InstanceSDK };
+export {
+    AuthSDK,
+    LoginData,
+    SessionData,
+    FileSDK,
+    File,
+    FileDirType,
+    InstanceSDK,
+    UserSDK,
+    CreateUserDTO,
+    UpdateUserDTO,
+    User,
+    UserRole,
+    DataResponse,
+    ErrorResponse,
+    PaginatedResponse,
+    QueryResponse,
+};

package/src/instance.ts

@@ -0,0 +1,44 @@
+import { AxiosInstance } from "axios";
+import { QueryResponse } from "./response";
+
+/**
+ * Classe InstanceSDK para interagir com a API de instâncias.
+ */
+class InstanceSDK {
+	/**
+	 * Cria uma instância do SDK de instância.
+	 * @param {AxiosInstance} httpClient A instância do cliente HTTP a ser usada para fazer requisições à API.
+	 */
+	constructor(private readonly httpClient: AxiosInstance) { }
+
+	/**
+	 * Executa uma consulta na instância especificada.
+	 * @param {string} instanceName Nome da instância do Inpulse.
+	 * @param {string} query Consulta a ser executada.
+	 * @param {any[]} parameters Parâmetros da consulta.
+	 * @returns {Promise<T>} Resultado da consulta.
+	 */
+	public async executeQuery<T>(
+		instanceName: string,
+		query: string,
+		parameters: any[],
+	): Promise<T> {
+		const response = await this.httpClient
+			.post<QueryResponse<T>>(`/${instanceName}/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;
+	}
+}
+
+export default InstanceSDK;

package/src/reports.ts

@@ -0,0 +1,59 @@
+import { AxiosInstance } from "axios";
+import { DataResponse, MessageResponse } from "./response";
+
+export interface ChatReport {
+	id: number;
+	userId: string;
+	fileId: number;
+	instance: string;
+	format: string;
+	startDate: string;
+	endDate: string;
+	exportDate: string;
+}
+
+export interface GenerateChatReportOptions {
+	instance: string;
+	userId: string;
+	format: ChatReportFileFormat;
+	startDate: string;
+	endDate: string;
+}
+
+export enum ChatReportFileFormat {
+	TXT = "txt",
+	CSV = "csv",
+	PDF = "pdf",
+}
+
+export default class ReportsSDK {
+	constructor(private readonly httpClient: AxiosInstance) {}
+
+	public async getChatsReports(instanceName: string) {
+		const url = `/${instanceName}/reports/chats`;
+		const response =
+			await this.httpClient.get<DataResponse<Array<ChatReport>>>(url);
+
+		return response.data;
+	}
+
+	public async generateChatReport({
+		instance,
+		...body
+	}: GenerateChatReportOptions) {
+		const url = `/${instance}/reports/chats`;
+		const response = await this.httpClient.post<DataResponse<ChatReport>>(
+			url,
+			body,
+		);
+
+		return response.data;
+	}
+
+    public async deleteReport(instanceName: string, reportId: number) {
+        const url = `/${instanceName}/reports/chats/${reportId}`;
+        const response = await this.httpClient.delete<MessageResponse>(url);
+
+        return response.data;
+    }
+}

package/src/response.ts

@@ -0,0 +1,26 @@
+export interface DataResponse<T> {
+    message: string;
+    data: T;
+}
+
+export interface MessageResponse {
+	message: string;
+}
+
+export interface ErrorResponse {
+    message: string;
+    cause?: any;
+}
+
+export interface PaginatedResponse<T> {
+    message: string;
+    data: Array<T>;
+    page: {
+        current: number;
+        next: boolean;
+    }
+}
+
+export interface QueryResponse<T> {
+    result: T;
+}