apacuana-sdk-core 0.6.2 → 0.7.0

package/dist/index.d.ts

@@ -8,6 +8,7 @@ declare namespace apacuana {
         customerId: string;
         integrationType: string;
     }): Promise<object>;
+    export function close(): void;
     export { getConfig };
     export { requestRevocation };
     export { getCertStatus };
@@ -17,9 +18,10 @@ declare namespace apacuana {
     export { generateCert };
     export { signDocument };
     export { getDigest };
+    export { getRevocationReasons };
 }
 import { getConfig } from "./config/index";
-import requestRevocation from "./api/revocations";
+import { requestRevocation } from "./api/revocations";
 import { getCertStatus } from "./api/certs";
 import getCustomer from "./api/users";
 import { addSigner } from "./api/signatures";
@@ -27,3 +29,4 @@ import { getDocs } from "./api/signatures";
 import { generateCert } from "./api/certs";
 import { signDocument } from "./api/signatures";
 import { getDigest } from "./api/signatures";
+import { getRevocationReasons } from "./api/revocations";

package/dist/index.js

@@ -289,7 +289,19 @@ var INTEGRATION_TYPE = {
   ONPREMISE: "ONPREMISE"
 };
 
-var 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]
+ */
+
+var defaultConfig = {
   apiUrl: "",
   secretKey: "",
   apiKey: "",
@@ -299,6 +311,9 @@ var config = {
   userData: undefined,
   token: undefined
 };
+
+/** @type {SDKConfig} */
+var config = _objectSpread2({}, defaultConfig);
 var setConfig = function setConfig(newConfig) {
   var apiUrl = newConfig.apiUrl,
     secretKey = newConfig.secretKey,
@@ -311,17 +326,18 @@ var setConfig = function setConfig(newConfig) {
 
   // Nueva validación para el valor de integrationType
   if (!Object.values(INTEGRATION_TYPE).includes(integrationType)) {
-    throw new Error("Apacuana SDK: El valor de integrationType ('".concat(integrationType, "') no es v\xE1lido. ") + "Valores permitidos: ".concat(Object.values(INTEGRATION_TYPE).join(', ')));
+    throw new Error("Apacuana SDK: El valor de integrationType ('".concat(integrationType, "') no es v\xE1lido. ") + "Valores permitidos: ".concat(Object.values(INTEGRATION_TYPE).join(", ")));
   }
   config = _objectSpread2(_objectSpread2({}, config), newConfig);
   // eslint-disable-next-line no-console
-  console.log("[Config] SDK Configuración actualizada (desde config):", _objectSpread2(_objectSpread2({}, config), {}, {
-    secretKey: "********"
-  }));
 };
 var getConfig = function getConfig() {
   return _objectSpread2({}, config);
 };
+var cleanConfig = function cleanConfig() {
+  config = _objectSpread2({}, defaultConfig);
+  console.log("Apacuana SDK: Configuración limpiada.");
+};
 
 // src/errors/index.js
 
@@ -584,54 +600,107 @@ var getCustomer = /*#__PURE__*/function () {
  * @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.
  */
+/**
+ * @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.
+ */
 var requestRevocation = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(reasonCode) {
     var response, _t;
     return _regenerator().w(function (_context) {
       while (1) switch (_context.p = _context.n) {
         case 0:
-          console.log("-> Función 'requestRevocation' ejecutada.");
-          console.log("Parámetros recibidos para solicitud de revocación:", {
-            reasonCode: reasonCode
-          });
           if (reasonCode) {
             _context.n = 1;
             break;
           }
-          throw new Error("ID de certificado y motivo son requeridos para requestRevocation.");
+          throw new Error("Código de motivo es requerido para requestRevocation.");
         case 1:
           _context.p = 1;
           _context.n = 2;
-          return httpRequest("users/api/customers/requestcert", {
+          return httpRequest("services/api/onboardingclient/requestcert", {
             reason: reasonCode
           }, "POST");
         case 2:
           response = _context.v;
-          console.log("Respuesta del servidor", response);
-          if (response.success) {
-            _context.n = 3;
-            break;
-          }
-          throw new ApacuanaAPIError(response.message || "Error desconocido al solicitar revocación.");
+          return _context.a(2, response);
         case 3:
-          return _context.a(2, {
-            revocationStatus: response.status || "pending",
-            requestId: response.id
-          });
-        case 4:
-          _context.p = 4;
+          _context.p = 3;
           _t = _context.v;
           throw new Error("Fallo en la solicitud de revocaci\xF3n: ".concat(_t.message));
-        case 5:
+        case 4:
           return _context.a(2);
       }
-    }, _callee, null, [[1, 4]]);
+    }, _callee, null, [[1, 3]]);
   }));
   return function requestRevocation(_x) {
     return _ref.apply(this, arguments);
   };
 }();
 
+/**
+ * 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.
+ */
+var getRevocationReasons = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
+    var response, _t2;
+    return _regenerator().w(function (_context2) {
+      while (1) switch (_context2.p = _context2.n) {
+        case 0:
+          _context2.p = 0;
+          _context2.n = 1;
+          return httpRequest("config/api/revocation/reasonsonboarding", {}, "GET");
+        case 1:
+          response = _context2.v;
+          if (response.records) {
+            _context2.n = 2;
+            break;
+          }
+          throw new ApacuanaAPIError("Failed to fetch revocation reasons.");
+        case 2:
+          return _context2.a(2, response.records);
+        case 3:
+          _context2.p = 3;
+          _t2 = _context2.v;
+          if (!(_t2 instanceof ApacuanaAPIError)) {
+            _context2.n = 4;
+            break;
+          }
+          throw _t2;
+        case 4:
+          throw new Error("Failed to get revocation reasons. Please try again later.");
+        case 5:
+          return _context2.a(2);
+      }
+    }, _callee2, null, [[0, 3]]);
+  }));
+  return function getRevocationReasons() {
+    return _ref2.apply(this, arguments);
+  };
+}();
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -32869,6 +32938,7 @@ var helpers = {
 /**
  * @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.
  */
 
@@ -32878,51 +32948,53 @@ var helpers = {
  * @property {boolean} success - Indica si la operación fue exitosa.
  */
 
+/**
+ * @typedef {object} EncryptedCSRObject
+ * @property {string} csr - The encrypted Certificate Signing Request.
+ */
+
+/**
+ * @param {EncryptedCSRObject} encryptedCSR
+ */
 var generateCertOnBoarding = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
-    var encryptedCSR,
-      response,
-      cert,
-      certifiedid,
-      _args = arguments,
-      _t;
+  var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(encryptedCSR) {
+    var response, cert, certifiedid, _t;
     return _regenerator().w(function (_context) {
       while (1) switch (_context.p = _context.n) {
         case 0:
-          encryptedCSR = _args.length > 0 && _args[0] !== undefined ? _args[0] : undefined;
-          _context.p = 1;
-          _context.n = 2;
+          _context.p = 0;
+          _context.n = 1;
           return httpRequest("services/api/register/certificate", encryptedCSR, "POST");
-        case 2:
+        case 1:
           response = _context.v;
           cert = response.cert, certifiedid = response.certifiedid;
           if (!(!cert || !certifiedid)) {
-            _context.n = 3;
+            _context.n = 2;
             break;
           }
           throw new ApacuanaAPIError("The API response does not contain the certificate.", response.status, "INVALID_API_RESPONSE");
-        case 3:
+        case 2:
           return _context.a(2, {
             cert: cert,
             certifiedid: certifiedid,
             success: true
           });
-        case 4:
-          _context.p = 4;
+        case 3:
+          _context.p = 3;
           _t = _context.v;
           if (!(_t instanceof ApacuanaAPIError)) {
-            _context.n = 5;
+            _context.n = 4;
             break;
           }
           throw _t;
-        case 5:
+        case 4:
           throw new Error("Certificate generation failed: ".concat(_t.message));
-        case 6:
+        case 5:
           return _context.a(2);
       }
-    }, _callee, null, [[1, 4]]);
+    }, _callee, null, [[0, 3]]);
   }));
-  return function generateCertOnBoarding() {
+  return function generateCertOnBoarding(_x) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -32944,21 +33016,17 @@ var generateCertOnPremise = /*#__PURE__*/function () {
 
 /**
  * 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.
  */
 var generateCert = /*#__PURE__*/function () {
-  var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
-    var encryptedCSR,
-      _getConfig,
-      integrationType,
-      _args3 = arguments;
+  var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(encryptedCSR) {
+    var _getConfig, integrationType;
     return _regenerator().w(function (_context3) {
       while (1) switch (_context3.n) {
         case 0:
-          encryptedCSR = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : undefined;
           _getConfig = getConfig(), integrationType = _getConfig.integrationType;
           helpers.validateCsr(encryptedCSR);
           if (!(integrationType === INTEGRATION_TYPE.ONBOARDING)) {
@@ -32979,7 +33047,7 @@ var generateCert = /*#__PURE__*/function () {
       }
     }, _callee3);
   }));
-  return function generateCert() {
+  return function generateCert(_x2) {
     return _ref3.apply(this, arguments);
   };
 }();
@@ -33015,7 +33083,6 @@ var getCertStatus = function getCertStatus() {
  * 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.
  */
 
 /**
@@ -33386,6 +33453,31 @@ var getDigest = /*#__PURE__*/function () {
  * @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.
+ */
 var addSigner = /*#__PURE__*/function () {
   var _ref1 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee1(signerData) {
     var _getConfig4, integrationType;
@@ -33478,55 +33570,47 @@ var apacuana = {
       return _regenerator().w(function (_context) {
         while (1) switch (_context.p = _context.n) {
           case 0:
-            // eslint-disable-next-line no-console
-            console.log("-> apacuana-sdk: Iniciando configuración y validando usuario...");
-            _context.p = 1;
-            // 1. Guardar la configuración inicial
+            _context.p = 0;
             setConfig(config);
-
-            // 2. Inicializar el cliente HTTP con la configuración guardada
             initHttpClient();
-
-            // 3. Opcional: Validar que la configuración se guardó correctamente
             currentConfig = getConfig();
             if (currentConfig.customerId) {
-              _context.n = 2;
+              _context.n = 1;
               break;
             }
             throw new Error("Apacuana SDK: La configuración de CustomerId no se ha guardado" + " correctamente.");
-          case 2:
-            _context.n = 3;
+          case 1:
+            _context.n = 2;
             return getCustomer();
-          case 3:
+          case 2:
             _yield$getCustomer = _context.v;
             token = _yield$getCustomer.token;
             userData = _yield$getCustomer.userData;
-            // Opcional: Guardar los detalles del usuario en la configuración
-            // para acceso futuro si fuera necesario
             setConfig(_objectSpread2(_objectSpread2({}, currentConfig), {}, {
               token: token,
               userData: userData
             }));
             setAuthToken(token);
-            // eslint-disable-next-line no-console
-            console.log("-> apacuana-sdk: Inicialización completa. Usuario validado:", token);
             return _context.a(2, true);
-          case 4:
-            _context.p = 4;
+          case 3:
+            _context.p = 3;
             _t = _context.v;
             // eslint-disable-next-line no-console
             console.error("Error durante la inicialización del SDK:", _t);
             throw _t;
-          case 5:
+          case 4:
             return _context.a(2);
         }
-      }, _callee, null, [[1, 4]]);
+      }, _callee, null, [[0, 3]]);
     }));
     function init(_x) {
       return _init.apply(this, arguments);
     }
     return init;
   }(),
+  close: function close() {
+    return cleanConfig();
+  },
   getConfig: getConfig,
   requestRevocation: requestRevocation,
   getCertStatus: getCertStatus,
@@ -33535,7 +33619,8 @@ var apacuana = {
   getDocs: getDocs,
   generateCert: generateCert,
   signDocument: signDocument,
-  getDigest: getDigest
+  getDigest: getDigest,
+  getRevocationReasons: getRevocationReasons
 };
 
 module.exports = apacuana;