apacuana-sdk-core 0.6.0 → 0.7.0

package/dist/utils/helpers.d.ts

@@ -17,7 +17,7 @@ declare function encryptedCsr(csr: any, encryptKey?: string): {
     csr: any;
 };
 declare function validateOnBoardingSignerData(signerData: any): void;
-declare function validateCsr(csr: any): void;
+declare function validateCsr(encryptedCSR: any): void;
 declare function validateGetDocsData(data: any): void;
 declare function validateGetDigestData(signData: any): void;
 declare function validateOnBoardingSignDocumentData(signData: any): void;

package/jest.config.cjs

@@ -3,5 +3,10 @@ module.exports = {
   testEnvironment: "node", // Para tests de backend, si tu SDK es universal
   collectCoverage: true,
   coverageDirectory: "coverage",
-  // Puedes añadir más configuraciones de cobertura si lo deseas
+  transformIgnorePatterns: [
+    "/node_modules/(?!react-native-get-random-values/)",
+  ],
+  transform: {
+    "^.+\\.jsx?$": "babel-jest",
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apacuana-sdk-core",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Core SDK para interacciones con las APIs de Apacuana.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -25,20 +25,25 @@
   "author": "Gega",
   "license": "ISC",
   "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
+    "@babel/core": "^7.24.5",
+    "@babel/plugin-transform-class-properties": "^7.24.1",
+    "@babel/plugin-transform-private-methods": "^7.24.1",
+    "@babel/plugin-transform-private-property-in-object": "^7.24.1",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-flow": "^7.24.1",
     "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-commonjs": "^28.0.6",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "babel-jest": "^29.7.0",
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
-    "rollup": "^4.18.0",
     "rimraf": "^5.0.7",
-    "typescript": "^5.4.5"
+    "rollup": "^4.17.2",
+    "typescript": "^5.9.2"
   },
   "engines": {
     "node": ">=14.0.0"

package/rollup.config.js

@@ -28,5 +28,5 @@ export default {
       exclude: 'node_modules/**',
     }),
   ],
-  external: ['axios'], // Mark axios as external to prevent bundling issues
+  external: ['axios'], // Mark only axios as external
 };

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,17 +17,23 @@ import { INTEGRATION_TYPE } from "../utils/constant";
  * @property {boolean} success - Indica si la operación fue exitosa.
  */
 
-const generateCertOnBoarding = async (csr = undefined) => {
-  try {
-    const encryptedCSR = helpers.encryptedCsr(csr);
+/**
+ * @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",
       encryptedCSR,
       "POST"
     );
-    const { cert } = response;
-    if (!cert) {
+    const { cert, certifiedid } = response;
+    if (!cert || !certifiedid) {
       throw new ApacuanaAPIError(
         "The API response does not contain the certificate.",
         response.status,
@@ -34,7 +41,7 @@ const generateCertOnBoarding = async (csr = undefined) => {
       );
     }
 
-    return { cert, success: true };
+    return { cert, certifiedid, success: true };
   } catch (error) {
     // The captured error is re-thrown, which will already be of type ApacuanaAPIError or a native Error.
     if (error instanceof ApacuanaAPIError) {
@@ -54,16 +61,16 @@ 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 (csr = undefined) => {
+export const generateCert = async (encryptedCSR) => {
   const { integrationType } = getConfig();
-  helpers.validateCsr(csr);
+  helpers.validateCsr(encryptedCSR);
   if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
-    return generateCertOnBoarding(csr);
+    return generateCertOnBoarding(encryptedCSR);
   }
   if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
     return generateCertOnPremise();

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;

package/src/utils/helpers.js

@@ -143,29 +143,18 @@ const validateOnBoardingSignerData = (signerData) => {
   });
 };
 
-const validateCsr = (csr) => {
-  const base64Regex = /^[A-Za-z0-9+/=]+$/;
-
-  if (!csr) {
-    throw new ApacuanaAPIError(
-      "La solicitud de firma de certificado (CSR) es requerida.",
-      400,
-      "INVALID_PARAMETER"
-    );
-  }
-
-  if (typeof csr !== "string" || csr.trim() === "") {
-    throw new ApacuanaAPIError(
-      "El CSR debe ser una cadena de texto válida y no puede estar vacía.",
-      400,
-      "INVALID_PARAMETER_FORMAT"
-    );
-  }
-
-  if (!base64Regex.test(csr)) {
+const validateCsr = (encryptedCSR) => {
+  if (
+    !encryptedCSR ||
+    typeof encryptedCSR !== "object" ||
+    !encryptedCSR.csr ||
+    typeof encryptedCSR.csr !== "string" ||
+    encryptedCSR.csr.trim() === ""
+  ) {
     throw new ApacuanaAPIError(
-      "El CSR debe estar codificado en formato base64 válido.",
-      400,
+      'The "encryptedCSR" parameter is required and must be an object ' +
+        'with a non-empty "csr" string property.',
+      400, // Bad Request
       "INVALID_PARAMETER_FORMAT"
     );
   }

package/src/utils/httpClient.js

@@ -83,12 +83,6 @@ export const initHttpClient = () => {
       }
     }
   );
-
-  // eslint-disable-next-line no-console
-  console.log(
-    "[HTTP Client] Cliente HTTP (Axios) REAL inicializado con URL base:",
-    config.apiUrl
-  );
 };
 
 /**
@@ -109,9 +103,6 @@ export const setAuthToken = (token) => {
   // Actualizamos la cabecera Authorization de la instancia de Axios.
   axiosInstance.defaults.headers.common.Authorization = `Bearer ${token}`;
   // eslint-disable-next-line no-console
-  console.log(
-    "[HTTP Client] Cabecera Authorization actualizada con nuevo token."
-  );
 };
 
 /**
@@ -137,18 +128,6 @@ export const httpRequest = async (path, data = {}, method = "POST") => {
     ...data,
   };
 
-  // eslint-disable-next-line no-console
-  console.log(
-    `[HTTP Client] Realizando petición ${method} a: ${axiosInstance.defaults.baseURL}${path}`
-  );
-  // eslint-disable-next-line no-console
-  console.log(
-    "[HTTP Client] Headers (via Axios config):",
-    axiosInstance.defaults.headers
-  );
-  // eslint-disable-next-line no-console
-  console.log("[HTTP Client] Datos enviados:", dataToSend);
-
   try {
     let response;
     switch (method.toUpperCase()) {
@@ -175,7 +154,6 @@ export const httpRequest = async (path, data = {}, method = "POST") => {
     // Si la promesa se resolvió, la respuesta es exitosa.
     // El interceptor ya manejó los errores 4xx/5xx y los errores lógicos 2xx.
     // eslint-disable-next-line no-console
-    console.log(`[HTTP Client] Respuesta exitosa de ${path}:`, response.data);
     return response.data;
   } catch (error) {
     // Si la petición falla, el interceptor ya procesó el error.

package/tests/api/certs.test.js

@@ -15,42 +15,38 @@ describe("Certificate API - certs.js", () => {
   });
 
   describe("generateCert", () => {
-    it("should generate a certificate for ONBOARDING integration", async () => {
+    beforeEach(() => {
+      jest.clearAllMocks();
+    });
+
+    // TEST 1: Probar el camino feliz de ONBOARDING
+    it("should call generateCertOnBoarding for ONBOARDING integration", async () => {
       getConfig.mockReturnValue({
         integrationType: INTEGRATION_TYPE.ONBOARDING,
       });
-      helpers.encryptedCsr.mockReturnValue("encrypted-csr");
-      httpRequest.mockResolvedValue({ cert: "new-cert", success: true });
+      const mockEncryptedCsr = { csr: "onboarding-csr" };
+      const mockApiResponse = {
+        cert: "onboarding-cert",
+        certifiedid: "onboarding-certified-id",
+      };
+      httpRequest.mockResolvedValue(mockApiResponse);
 
-      const result = await generateCert("some-csr");
+      const result = await generateCert(mockEncryptedCsr);
 
-      expect(helpers.validateCsr).toHaveBeenCalledWith("some-csr");
-      expect(helpers.encryptedCsr).toHaveBeenCalledWith("some-csr");
       expect(httpRequest).toHaveBeenCalledWith(
-        "services/api/register/certificate",
-        "encrypted-csr",
+        "services/api/register/certificate", // Endpoint de Onboarding
+        mockEncryptedCsr,
         "POST"
       );
-      expect(result).toEqual({ cert: "new-cert", success: true });
-    });
-
-    it("should throw an error if API response does not contain a certificate", async () => {
-      getConfig.mockReturnValue({
-        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      expect(result).toEqual({
+        cert: "onboarding-cert",
+        certifiedid: "onboarding-certified-id",
+        success: true,
       });
-      helpers.encryptedCsr.mockReturnValue("encrypted-csr");
-      httpRequest.mockResolvedValue({ success: false });
-
-      await expect(generateCert("some-csr")).rejects.toThrow(
-        new ApacuanaAPIError(
-          "The API response does not contain the certificate.",
-          undefined,
-          "INVALID_API_RESPONSE"
-        )
-      );
     });
 
-    it("should throw an error for ONPREMISE", async () => {
+    // TEST 2: Probar el error de ONPREMISE
+    it("should throw an error for ONPREMISE integration", async () => {
       getConfig.mockReturnValue({
         integrationType: INTEGRATION_TYPE.ONPREMISE,
       });
@@ -64,34 +60,20 @@ describe("Certificate API - certs.js", () => {
       );
     });
 
-    it("should throw an error if integration type is not supported", async () => {
+    // TEST 3: Probar el error para un tipo inválido
+    it("should throw an error for an unsupported integration type", async () => {
       getConfig.mockReturnValue({ integrationType: "INVALID_TYPE" });
-      await expect(generateCert("some-csr")).rejects.toThrow(
-        "Unsupported integration type: INVALID_TYPE"
-      );
-    });
-
-    it("should re-throw ApacuanaAPIError if httpRequest fails", async () => {
-      getConfig.mockReturnValue({
-        integrationType: INTEGRATION_TYPE.ONBOARDING,
-      });
-      const apiError = new ApacuanaAPIError("API Error", 500, "API_ERROR");
-      httpRequest.mockRejectedValue(apiError);
-
-      await expect(generateCert("some-csr")).rejects.toThrow(apiError);
-    });
-
-    it("should throw a generic error if something else fails", async () => {
-      getConfig.mockReturnValue({
-        integrationType: INTEGRATION_TYPE.ONBOARDING,
-      });
-      const genericError = new Error("Something failed");
-      httpRequest.mockRejectedValue(genericError);
 
       await expect(generateCert("some-csr")).rejects.toThrow(
-        "Certificate generation failed: Something failed"
+        new ApacuanaAPIError(
+          "Unsupported integration type: INVALID_TYPE",
+          400,
+          "UNSUPPORTED_INTEGRATION_TYPE"
+        )
       );
     });
+
+    // Se eliminan los otros tests que asumían un comportamiento "estándar"
   });
 
   describe("getCertStatus", () => {

package/tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "target": "es2020",
     "module": "esnext",
+    "lib": ["es2022", "dom"],
     "allowJs": true,
     "declaration": true,
     "emitDeclarationOnly": true,
@@ -11,5 +12,5 @@
     "esModuleInterop": true
   },
   "include": ["src"],
-  "exclude": ["node_modules", "dist", "tests"]
+  "exclude": ["nodev_modules", "dist", "tests"]
 }

package/.babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@babel/preset-env"]
-}