apacuana-sdk-core 0.5.0 → 0.6.0

package/dist/index.js

@@ -285,8 +285,8 @@ var VERIFICATION_STATUS = {
   APPROVED: 1
 };
 var INTEGRATION_TYPE = {
-  ONBOARDING: 'onboarding',
-  ONPREMISE: 'onpremise'
+  ONBOARDING: "ONBOARDING",
+  ONPREMISE: "ONPREMISE"
 };
 
 var config = {
@@ -517,12 +517,19 @@ var httpRequest = /*#__PURE__*/function () {
   };
 }();
 
+/**
+ * @typedef {object} GetCustomerResponse
+ * @property {string} token - El token de sesión del usuario.
+ * @property {object} userData - Los datos del usuario obtenidos.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
 /**
  * Obtiene el token de un usuario a través de una petición POST.
  * Este método es útil para endpoints que requieren datos en el cuerpo de la petición
  * para buscar un usuario, como un ID de sesión o un token de acceso.
  *
- * @returns {Promise<{token: string, userData: object, success: boolean}>} Objeto con el token de sesión, los datos del usuario y un indicador de éxito.
+ * @returns {Promise<GetCustomerResponse>} Objeto con el token de sesión, los datos del usuario y un indicador de éxito.
  * @throws {Error} Si los parámetros de entrada son inválidos.
  * @throws {ApacuanaAPIError} Si ocurre un error en la API de Apacuana.
  */
@@ -579,10 +586,16 @@ var getCustomer = /*#__PURE__*/function () {
   };
 }();
 
+/**
+ * @typedef {object} RequestRevocationResponse
+ * @property {string} revocationStatus - El estado de la solicitud de revocación (e.g., "pending").
+ * @property {string|number} requestId - El ID de la solicitud de revocación.
+ */
+
 /**
  * Simula la solicitud de revocación de un certificado.
  * @param {string} reasonCode - Código o descripción del motivo de la revocación.
- * @returns {Promise<object>} Objeto con el estado de la solicitud de revocación.
+ * @returns {Promise<RequestRevocationResponse>} Objeto con el estado de la solicitud de revocación.
  */
 var requestRevocation = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(reasonCode) {
@@ -32760,6 +32773,26 @@ var validateGetDigestData = function validateGetDigestData(signData) {
     throw new ApacuanaAPIError("Los parámetros 'cert' y 'signatureId' son requeridos y deben ser cadenas de texto.", 400, "INVALID_PARAMETER");
   }
 };
+var validateOnBoardingSignDocumentData = function validateOnBoardingSignDocumentData(signData) {
+  if (!signData || _typeof(signData) !== "object") {
+    throw new ApacuanaAPIError("Sign data is required and must be an object.", 400, "INVALID_PARAMETER");
+  }
+  var signature = signData.signature,
+    cert = signData.cert,
+    signedDigest = signData.signedDigest;
+  if (!signature || _typeof(signature) !== "object" || !signature.id) {
+    throw new ApacuanaAPIError("Signature object with an 'id' property is required.", 400, "INVALID_PARAMETER");
+  }
+  if (!Array.isArray(signature.positions)) {
+    throw new ApacuanaAPIError("Signature 'positions' must be an array.", 400, "INVALID_PARAMETER");
+  }
+  if (!cert || typeof cert !== "string") {
+    throw new ApacuanaAPIError("Certificate 'cert' is required and must be a string.", 400, "INVALID_PARAMETER");
+  }
+  if (!signedDigest || typeof signedDigest !== "string") {
+    throw new ApacuanaAPIError("Signed digest 'signedDigest' is required and must be a string.", 400, "INVALID_PARAMETER");
+  }
+};
 var helpers = {
   getCertificateStatus: getCertificateStatus,
   exportPrivateKey: exportPrivateKey,
@@ -32768,9 +32801,22 @@ var helpers = {
   validateOnBoardingSignerData: validateOnBoardingSignerData,
   validateCsr: validateCsr,
   validateGetDocsData: validateGetDocsData,
-  validateGetDigestData: validateGetDigestData
+  validateGetDigestData: validateGetDigestData,
+  validateOnBoardingSignDocumentData: validateOnBoardingSignDocumentData
 };
 
+/**
+ * @typedef {object} GenerateCertResponse
+ * @property {string} cert - El certificado generado en formato string.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * @typedef {object} GetCertStatusResponse
+ * @property {string} status - El estado actual del certificado del usuario.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
 var generateCertOnBoarding = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
     var csr,
@@ -32838,7 +32884,7 @@ var generateCertOnPremise = /*#__PURE__*/function () {
 /**
  * Generates a digital certificate.
  * @param {string} [csr] - Certificate Signing Request (CSR).
- * @returns {Promise<{cert: string, success: boolean}>} Object with the generated certificate and a success indicator.
+ * @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.
  */
@@ -32880,7 +32926,7 @@ var generateCert = /*#__PURE__*/function () {
 /**
  * Gets the user's certificate status.
  * @param {boolean} [isCertificateInDevice=false] - Indicates if the certificate is already on the device.
- * @returns {{status: string, success: boolean}} Object with the certificate status and a success indicator.
+ * @returns {GetCertStatusResponse} Object with the certificate status and a success indicator.
  */
 var getCertStatus = function getCertStatus() {
   var isCertificateInDevice = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
@@ -32892,9 +32938,196 @@ var getCertStatus = function getCertStatus() {
   };
 };
 
+// =================================================================
+// Type Definitions
+// =================================================================
+
+/**
+ * Define la estructura de un objeto Firmante.
+ * @typedef {object} Signer
+ * @property {string} name - Nombre completo del firmante.
+ * @property {string} email - Correo electrónico del firmante.
+ * @property {string} document - Documento de identidad del firmante.
+ */
+
+/**
+ * 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.
+ */
+
+/**
+ * Define la estructura de la respuesta al añadir un firmante.
+ * @typedef {object} AddSignerResponse
+ * @property {string} signer - Identificador de confirmación del firmante añadido.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * Define la estructura de datos para obtener el digest de un documento.
+ * @typedef {object} GetDigestData
+ * @property {string} cert - Certificado del firmante en formato base64.
+ * @property {string} signatureId - Identificador único del proceso de firma.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener el digest.
+ * @typedef {object} GetDigestResponse
+ * @property {string} digest - El digest del documento que se va a firmar.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * Define la estructura de los parámetros para obtener documentos.
+ * @typedef {object} GetDocsParams
+ * @property {number} page - Número de página para la paginación.
+ * @property {number} size - Cantidad de registros por página.
+ * @property {string} [status] - (Opcional) Estado para filtrar los documentos.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ * @typedef {object} GetDocsResponse
+ * @property {number} totalRecords - El número total de registros encontrados.
+ * @property {Array<object>} records - Un arreglo con los registros de los documentos.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * @typedef {object} SignDocumentData
+ * @property {object} signature - Objeto con información de la firma.
+ * @property {string} signature.id - ID de la firma.
+ * @property {Array<object>} signature.positions - Posiciones de la firma.
+ * @property {string} cert - Certificado en base64.
+ * @property {string} signedDigest - Digest firmado.
+ */
+
+// =================================================================
+// Internal Functions
+// =================================================================
+
+var signDocumentOnBoarding = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(signData) {
+    var signature, cert, signedDigest, signBody, response, _t;
+    return _regenerator().w(function (_context) {
+      while (1) switch (_context.p = _context.n) {
+        case 0:
+          helpers.validateOnBoardingSignDocumentData(signData);
+          signature = signData.signature, cert = signData.cert, signedDigest = signData.signedDigest;
+          _context.p = 1;
+          signBody = {
+            positions: JSON.stringify(signature.positions.map(function (p) {
+              return {
+                x: p.x,
+                y: p.y,
+                page: p.page,
+                status: 1
+              };
+            })),
+            publickey: cert,
+            signeddigest: signedDigest
+          };
+          _context.n = 2;
+          return httpRequest("services/api/documents/sign/".concat(signature.id), signBody, "PUT");
+        case 2:
+          response = _context.v;
+          return _context.a(2, response);
+        case 3:
+          _context.p = 3;
+          _t = _context.v;
+          if (!(_t instanceof ApacuanaAPIError)) {
+            _context.n = 4;
+            break;
+          }
+          throw _t;
+        case 4:
+          throw new ApacuanaAPIError("Failed to sign document: ".concat(_t.message || "Unknown error"));
+        case 5:
+          return _context.a(2);
+      }
+    }, _callee, null, [[1, 3]]);
+  }));
+  return function signDocumentOnBoarding(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+var signDocumentOnPremise = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
+    return _regenerator().w(function (_context2) {
+      while (1) switch (_context2.n) {
+        case 0:
+          throw new ApacuanaAPIError("Document signing is not supported for integration type: ONPREMISE", 501, "NOT_IMPLEMENTED");
+        case 1:
+          return _context2.a(2);
+      }
+    }, _callee2);
+  }));
+  return function signDocumentOnPremise() {
+    return _ref2.apply(this, arguments);
+  };
+}();
+var getDigestToSignOnBoarding = /*#__PURE__*/function () {
+  var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(signData) {
+    var _response$data, response, digest, _t2;
+    return _regenerator().w(function (_context3) {
+      while (1) switch (_context3.p = _context3.n) {
+        case 0:
+          _context3.p = 0;
+          _context3.n = 1;
+          return httpRequest("services/api/documents/getdigest/".concat(signData.signatureId), {
+            publickey: signData.cert
+          }, "POST");
+        case 1:
+          response = _context3.v;
+          digest = ((_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.digest) || response.digest;
+          if (digest) {
+            _context3.n = 2;
+            break;
+          }
+          throw new ApacuanaAPIError("Signature generation failed: digest not found in the response.", 500, "API_RESPONSE_ERROR");
+        case 2:
+          return _context3.a(2, {
+            digest: digest,
+            success: true
+          });
+        case 3:
+          _context3.p = 3;
+          _t2 = _context3.v;
+          if (!(_t2.name === "ApacuanaAPIError")) {
+            _context3.n = 4;
+            break;
+          }
+          throw _t2;
+        case 4:
+          throw new ApacuanaAPIError("Failed to sign document (on-boarding): ".concat(_t2.message));
+        case 5:
+          return _context3.a(2);
+      }
+    }, _callee3, null, [[0, 3]]);
+  }));
+  return function getDigestToSignOnBoarding(_x2) {
+    return _ref3.apply(this, arguments);
+  };
+}();
+var getDigestToSignOnPremise = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4() {
+    return _regenerator().w(function (_context4) {
+      while (1) switch (_context4.n) {
+        case 0:
+          throw new ApacuanaAPIError("Digest retrieval is not supported for integration type: ONPREMISE", 501, "NOT_IMPLEMENTED");
+        case 1:
+          return _context4.a(2);
+      }
+    }, _callee4);
+  }));
+  return function getDigestToSignOnPremise() {
+    return _ref4.apply(this, arguments);
+  };
+}();
 var addSignerOnBoarding = /*#__PURE__*/function () {
   var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(signerData) {
-    var _t2;
+    var _t3;
     return _regenerator().w(function (_context5) {
       while (1) switch (_context5.p = _context5.n) {
         case 0:
@@ -32909,20 +33142,20 @@ var addSignerOnBoarding = /*#__PURE__*/function () {
           });
         case 3:
           _context5.p = 3;
-          _t2 = _context5.v;
-          if (!(_t2 instanceof ApacuanaAPIError)) {
+          _t3 = _context5.v;
+          if (!(_t3 instanceof ApacuanaAPIError)) {
             _context5.n = 4;
             break;
           }
-          throw _t2;
+          throw _t3;
         case 4:
-          throw new Error("Failed to add signer in On-Boarding: ".concat(_t2.message));
+          throw new Error("Failed to add signer in On-Boarding: ".concat(_t3.message));
         case 5:
           return _context5.a(2);
       }
     }, _callee5, null, [[1, 3]]);
   }));
-  return function addSignerOnBoarding(_x2) {
+  return function addSignerOnBoarding(_x3) {
     return _ref5.apply(this, arguments);
   };
 }();
@@ -32958,7 +33191,7 @@ var getDocsOnPremise = /*#__PURE__*/function () {
 }();
 var getDocsOnBoarding = /*#__PURE__*/function () {
   var _ref8 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee8(data) {
-    var _getConfig, customerId, params, apiUrl, response, _t3;
+    var _getConfig, customerId, params, apiUrl, response, _t4;
     return _regenerator().w(function (_context8) {
       while (1) switch (_context8.p = _context8.n) {
         case 0:
@@ -32990,24 +33223,102 @@ var getDocsOnBoarding = /*#__PURE__*/function () {
           });
         case 3:
           _context8.p = 3;
-          _t3 = _context8.v;
-          if (!(_t3.name === "ApacuanaAPIError")) {
+          _t4 = _context8.v;
+          if (!(_t4.name === "ApacuanaAPIError")) {
             _context8.n = 4;
             break;
           }
-          throw _t3;
+          throw _t4;
         case 4:
-          throw new ApacuanaAPIError("Failed to get document list (on-boarding): ".concat(_t3.message));
+          throw new ApacuanaAPIError("Failed to get document list (on-boarding): ".concat(_t4.message));
         case 5:
           return _context8.a(2);
       }
     }, _callee8, null, [[1, 3]]);
   }));
-  return function getDocsOnBoarding(_x3) {
+  return function getDocsOnBoarding(_x4) {
     return _ref8.apply(this, arguments);
   };
 }();
 
+// =================================================================
+// Exported Functions
+// =================================================================
+
+/**
+ * Firma un documento PDF con un certificado digital.
+ * NOTA: Esta función no está implementada actualmente para ningún tipo de integración.
+ * @param {SignDocumentData} signData - Datos necesarios para la firma.
+ * @returns {Promise<object>}
+ * @throws {ApacuanaAPIError} Arroja un error 'NOT_IMPLEMENTED' para cualquier tipo de integración.
+ */
+var signDocument = /*#__PURE__*/function () {
+  var _ref9 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee9(signData) {
+    var _getConfig2, integrationType;
+    return _regenerator().w(function (_context9) {
+      while (1) switch (_context9.n) {
+        case 0:
+          _getConfig2 = getConfig(), integrationType = _getConfig2.integrationType;
+          if (!(integrationType === INTEGRATION_TYPE.ONBOARDING)) {
+            _context9.n = 1;
+            break;
+          }
+          return _context9.a(2, signDocumentOnBoarding(signData));
+        case 1:
+          if (!(integrationType === INTEGRATION_TYPE.ONPREMISE)) {
+            _context9.n = 2;
+            break;
+          }
+          return _context9.a(2, signDocumentOnPremise());
+        case 2:
+          throw new ApacuanaAPIError("Unsupported integration type: ".concat(integrationType), 400, "UNSUPPORTED_INTEGRATION_TYPE");
+        case 3:
+          return _context9.a(2);
+      }
+    }, _callee9);
+  }));
+  return function signDocument(_x5) {
+    return _ref9.apply(this, arguments);
+  };
+}();
+
+/**
+ * Obtiene el digest de un documento para ser firmado.
+ * @param {GetDigestData} signData - Datos requeridos para obtener el digest.
+ * @returns {Promise<GetDigestResponse>} Una promesa que resuelve a un objeto con el digest del documento.
+ * @throws {ApacuanaAPIError} Si los datos de entrada son inválidos, la llamada a la API falla, o el tipo de integración no es soportado.
+ */
+var getDigest = /*#__PURE__*/function () {
+  var _ref0 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee0(signData) {
+    var _getConfig3, integrationType;
+    return _regenerator().w(function (_context0) {
+      while (1) switch (_context0.n) {
+        case 0:
+          helpers.validateGetDigestData(signData);
+          _getConfig3 = getConfig(), integrationType = _getConfig3.integrationType;
+          if (!(integrationType === INTEGRATION_TYPE.ONBOARDING)) {
+            _context0.n = 1;
+            break;
+          }
+          return _context0.a(2, getDigestToSignOnBoarding(signData));
+        case 1:
+          if (!(integrationType === INTEGRATION_TYPE.ONPREMISE)) {
+            _context0.n = 2;
+            break;
+          }
+          return _context0.a(2, getDigestToSignOnPremise());
+        case 2:
+          throw new ApacuanaAPIError("Document retrieval is not supported for an unknown integration type: ".concat(integrationType), 501, "NOT_IMPLEMENTED");
+        case 3:
+          return _context0.a(2);
+      }
+    }, _callee0);
+  }));
+  return function getDigest(_x6) {
+    return _ref0.apply(this, arguments);
+  };
+}();
+
 /**
  * Añade un firmante a un documento.
  * @param {SignerData} signerData - Los datos del firmante que se va a añadir.
@@ -33045,7 +33356,7 @@ var addSigner = /*#__PURE__*/function () {
       }
     }, _callee1);
   }));
-  return function addSigner(_x5) {
+  return function addSigner(_x7) {
     return _ref1.apply(this, arguments);
   };
 }();
@@ -33082,7 +33393,7 @@ var getDocs = /*#__PURE__*/function () {
       }
     }, _callee10);
   }));
-  return function getDocs(_x6) {
+  return function getDocs(_x8) {
     return _ref10.apply(this, arguments);
   };
 }();
@@ -33161,7 +33472,9 @@ var apacuana = {
   getCustomer: getCustomer,
   addSigner: addSigner,
   getDocs: getDocs,
-  generateCert: generateCert
+  generateCert: generateCert,
+  signDocument: signDocument,
+  getDigest: getDigest
 };
 
 module.exports = apacuana;