apacuana-sdk-core 0.6.2 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apacuana-sdk-core",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Core SDK para interacciones con las APIs de Apacuana.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/api/certs.js

@@ -7,6 +7,7 @@ import { INTEGRATION_TYPE } from "../utils/constant";
 /**
  * @typedef {object} GenerateCertResponse
  * @property {string} cert - El certificado generado en formato string.
+ * @property {string} certifiedid - El ID del certificado generado.
  * @property {boolean} success - Indica si la operación fue exitosa.
  */
 
@@ -16,7 +17,15 @@ import { INTEGRATION_TYPE } from "../utils/constant";
  * @property {boolean} success - Indica si la operación fue exitosa.
  */
 
-const generateCertOnBoarding = async (encryptedCSR = undefined) => {
+/**
+ * @typedef {object} EncryptedCSRObject
+ * @property {string} csr - The encrypted Certificate Signing Request.
+ */
+
+/**
+ * @param {EncryptedCSRObject} encryptedCSR
+ */
+const generateCertOnBoarding = async (encryptedCSR) => {
   try {
     const response = await httpRequest(
       "services/api/register/certificate",
@@ -52,12 +61,12 @@ const generateCertOnPremise = async () => {
 
 /**
  * Generates a digital certificate.
- * @param {string} [csr] - Certificate Signing Request (CSR).
+ * @param {EncryptedCSRObject} encryptedCSR - Certificate Signing Request (CSR) object.
  * @returns {Promise<GenerateCertResponse>} Object with the generated certificate and a success indicator.
  * @throws {ApacuanaAPIError} If the CSR is invalid, if the API response does not contain the certificate, or if the integration type is not supported.
  * @throws {Error} If certificate generation fails for another reason.
  */
-export const generateCert = async (encryptedCSR = undefined) => {
+export const generateCert = async (encryptedCSR) => {
   const { integrationType } = getConfig();
   helpers.validateCsr(encryptedCSR);
   if (integrationType === INTEGRATION_TYPE.ONBOARDING) {

package/src/api/revocations.js

@@ -12,37 +12,72 @@ import { ApacuanaAPIError } from "../errors/index";
  * @param {string} reasonCode - Código o descripción del motivo de la revocación.
  * @returns {Promise<RequestRevocationResponse>} Objeto con el estado de la solicitud de revocación.
  */
-const requestRevocation = async (reasonCode) => {
-  console.log("-> Función 'requestRevocation' ejecutada.");
-  console.log("Parámetros recibidos para solicitud de revocación:", {
-    reasonCode,
-  });
+/**
+ * @typedef {object} RevocationResponse
+ * @property {boolean} success - Indicates if the revocation request was successful.
+ * @property {string} [message] - A message providing details about the outcome.
+ */
+
+/**
+ * @typedef {object} RevocationReason
+ * @property {string} code - The code for the revocation reason.
+ * @property {string} description - The description of the revocation reason.
+ */
+
+/**
+ * @typedef {object} RevocationReasonsResponse
+ * @property {boolean} success - Indicates if the request was successful.
+ * @property {RevocationReason[]} reasons - A list of revocation reasons.
+ */
 
+/**
+ * Requests the revocation of a certificate.
+ * @param {number} reasonCode - Código o descripción del motivo de la revocación.
+ * @returns {Promise<RevocationResponse>} An object indicating the success of the request.
+ * @throws {ApacuanaAPIError} If the revocation request fails.
+ */
+export const requestRevocation = async (reasonCode) => {
   if (!reasonCode) {
-    throw new Error(
-      "ID de certificado y motivo son requeridos para requestRevocation."
-    );
+    throw new Error("Código de motivo es requerido para requestRevocation.");
   }
 
   try {
     const response = await httpRequest(
-      "users/api/customers/requestcert",
+      "services/api/onboardingclient/requestcert",
       { reason: reasonCode },
       "POST"
     );
-    console.log("Respuesta del servidor", response);
-    if (!response.success) {
-      throw new ApacuanaAPIError(
-        response.message || "Error desconocido al solicitar revocación."
-      );
-    }
-    return {
-      revocationStatus: response.status || "pending",
-      requestId: response.id,
-    };
+
+    return response;
   } catch (error) {
     throw new Error(`Fallo en la solicitud de revocación: ${error.message}`);
   }
 };
 
-export default requestRevocation;
+/**
+ * Retrieves the available reasons for certificate revocation.
+ * @returns {Promise<RevocationReasonsResponse>} An object containing the list of revocation reasons.
+ * @throws {ApacuanaAPIError} If fetching the reasons fails.
+ */
+export const getRevocationReasons = async () => {
+  try {
+    const response = await httpRequest(
+      "config/api/revocation/reasonsonboarding",
+      {},
+      "GET"
+    );
+
+    if (!response.records) {
+      throw new ApacuanaAPIError("Failed to fetch revocation reasons.");
+    }
+
+    return response.records;
+  } catch (error) {
+    if (error instanceof ApacuanaAPIError) {
+      throw error;
+    }
+    throw new Error(
+      "Failed to get revocation reasons. Please try again later."
+    );
+  }
+};

package/src/api/signatures.js

@@ -21,7 +21,6 @@ import { INTEGRATION_TYPE } from "../utils/constant";
  * Define la estructura de datos para añadir un firmante.
  * @typedef {object} SignerData
  * @property {string} docId - Identificador único del documento.
- * @property {Signer} signer - Objeto con la información del firmante.
  */
 
 /**
@@ -280,6 +279,31 @@ export const getDigest = async (signData) => {
  * @returns {Promise<AddSignerResponse>} Una promesa que resuelve a un objeto con el resultado de la operación.
  * @throws {ApacuanaAPIError} Si los datos del firmante son inválidos, la llamada a la API falla, o el tipo de integración no es soportado.
  */
+/**
+ * @typedef {object} SignaturePosition
+ * @property {number} page - The page number for the signature.
+ * @property {number} x - The x-coordinate for the signature's position (from 0 to 1).
+ * @property {number} y - The y-coordinate for the signature's position (from 0 to 1).
+ */
+
+/**
+ * @typedef {object} OnboardingSignerData
+ * @property {string} name - The name of the document.
+ * @property {string} reference - An external reference for the document.
+ * @property {string} typedoc - The type of document of the signer (e.g., "V", "E", "J").
+ * @property {string} doc - The document number of the signer.
+ * @property {SignaturePosition[]} signature - An array of signature positions.
+ */
+
+/**
+ * Adds a new signer to the signature process.
+ * This function acts as a dispatcher, delegating to the appropriate implementation
+ * based on the configured integration type.
+ *
+ * @param {OnboardingSignerData | object} signerData - The signer's data. The structure depends on the integration type.
+ * @returns {Promise<object>} The result from the API.
+ * @throws {ApacuanaAPIError} If signerData is invalid or if the integration type is not supported.
+ */
 export const addSigner = async (signerData) => {
   if (
     !signerData ||

package/src/config/index.js

@@ -1,7 +1,19 @@
 // src/config/index.js
-import { INTEGRATION_TYPE } from '../utils/constant';
+import { INTEGRATION_TYPE } from "../utils/constant";
 
-let config = {
+/**
+ * @typedef {object} SDKConfig
+ * @property {string} apiUrl
+ * @property {string} secretKey
+ * @property {string} apiKey
+ * @property {string} verificationId
+ * @property {string} customerId
+ * @property {string} integrationType
+ * @property {object} [userData]
+ * @property {string} [token]
+ */
+
+const defaultConfig = {
   apiUrl: "",
   secretKey: "",
   apiKey: "",
@@ -12,8 +24,12 @@ let config = {
   token: undefined,
 };
 
+/** @type {SDKConfig} */
+let config = { ...defaultConfig };
+
 export const setConfig = (newConfig) => {
-  const { apiUrl, secretKey, apiKey, verificationId, integrationType } = newConfig;
+  const { apiUrl, secretKey, apiKey, verificationId, integrationType } =
+    newConfig;
 
   if (!apiUrl || !secretKey || !apiKey || !verificationId || !integrationType) {
     throw new Error(
@@ -26,16 +42,17 @@ export const setConfig = (newConfig) => {
   if (!Object.values(INTEGRATION_TYPE).includes(integrationType)) {
     throw new Error(
       `Apacuana SDK: El valor de integrationType ('${integrationType}') no es válido. ` +
-      `Valores permitidos: ${Object.values(INTEGRATION_TYPE).join(', ')}`
+        `Valores permitidos: ${Object.values(INTEGRATION_TYPE).join(", ")}`
     );
   }
 
   config = { ...config, ...newConfig };
   // eslint-disable-next-line no-console
-  console.log("[Config] SDK Configuración actualizada (desde config):", {
-    ...config,
-    secretKey: "********",
-  });
 };
 
 export const getConfig = () => ({ ...config });
+
+export const cleanConfig = () => {
+  config = { ...defaultConfig };
+  console.log("Apacuana SDK: Configuración limpiada.");
+};

package/src/index.js

@@ -1,7 +1,7 @@
-import { setConfig, getConfig } from "./config/index";
+import { setConfig, getConfig, cleanConfig } from "./config/index";
 import { initHttpClient, setAuthToken } from "./utils/httpClient";
 import getCustomer from "./api/users";
-import requestRevocation from "./api/revocations";
+import { requestRevocation, getRevocationReasons } from "./api/revocations";
 import { generateCert, getCertStatus } from "./api/certs";
 import { addSigner, getDigest, getDocs, signDocument } from "./api/signatures";
 
@@ -19,19 +19,9 @@ const apacuana = {
    * @returns {Promise<object>} retorna los detalles del usuario si la inicialización es exitosa.
    */
   init: async (config) => {
-    // eslint-disable-next-line no-console
-    console.log(
-      "-> apacuana-sdk: Iniciando configuración y validando usuario..."
-    );
-
     try {
-      // 1. Guardar la configuración inicial
       setConfig(config);
-
-      // 2. Inicializar el cliente HTTP con la configuración guardada
       initHttpClient();
-
-      // 3. Opcional: Validar que la configuración se guardó correctamente
       const currentConfig = getConfig();
       if (!currentConfig.customerId) {
         throw new Error(
@@ -39,19 +29,9 @@ const apacuana = {
             " correctamente."
         );
       }
-
-      // 4. Obtener los detalles del usuario como parte de la inicialización
       const { token, userData } = await getCustomer();
-
-      // Opcional: Guardar los detalles del usuario en la configuración
-      // para acceso futuro si fuera necesario
       setConfig({ ...currentConfig, token, userData });
       setAuthToken(token);
-      // eslint-disable-next-line no-console
-      console.log(
-        "-> apacuana-sdk: Inicialización completa. Usuario validado:",
-        token
-      );
       return true;
     } catch (error) {
       // eslint-disable-next-line no-console
@@ -59,6 +39,7 @@ const apacuana = {
       throw error;
     }
   },
+  close: () => cleanConfig(),
   getConfig,
   requestRevocation,
   getCertStatus,
@@ -68,6 +49,7 @@ const apacuana = {
   generateCert,
   signDocument,
   getDigest,
+  getRevocationReasons,
 };
 
 export default apacuana;