apacuana-sdk-core 0.5.0 → 0.6.0

package/dist/utils/helpers.d.ts

@@ -7,6 +7,7 @@ declare namespace _default {
     export { validateCsr };
     export { validateGetDocsData };
     export { validateGetDigestData };
+    export { validateOnBoardingSignDocumentData };
 }
 export default _default;
 declare function getCertificateStatus(userData: any, certificateInDevice: any): string;
@@ -19,3 +20,4 @@ declare function validateOnBoardingSignerData(signerData: any): void;
 declare function validateCsr(csr: any): void;
 declare function validateGetDocsData(data: any): void;
 declare function validateGetDigestData(signData: any): void;
+declare function validateOnBoardingSignDocumentData(signData: any): void;

package/package.json

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

package/src/api/certs.js

@@ -4,6 +4,18 @@ import helpers from "../utils/helpers";
 import { ApacuanaAPIError } from "../errors";
 import { INTEGRATION_TYPE } from "../utils/constant";
 
+/**
+ * @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.
+ */
+
 const generateCertOnBoarding = async (csr = undefined) => {
   try {
     const encryptedCSR = helpers.encryptedCsr(csr);
@@ -43,7 +55,7 @@ const generateCertOnPremise = async () => {
 /**
  * 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.
  */
@@ -67,7 +79,7 @@ export const generateCert = async (csr = undefined) => {
 /**
  * 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.
  */
 export const getCertStatus = (isCertificateInDevice = false) => {
   const config = getConfig();

package/src/api/revocations.js

@@ -1,10 +1,16 @@
 import { httpRequest } from "../utils/httpClient";
 import { ApacuanaAPIError } from "../errors/index";
 
+/**
+ * @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.
  */
 const requestRevocation = async (reasonCode) => {
   console.log("-> Función 'requestRevocation' ejecutada.");

package/src/api/signatures.js

@@ -61,16 +61,50 @@ import { INTEGRATION_TYPE } from "../utils/constant";
  * @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
 // =================================================================
 
-const signDocumentOnBoarding = async () => {
-  throw new ApacuanaAPIError(
-    "Document signing is not supported for integration type: ONBOARDING",
-    501,
-    "NOT_IMPLEMENTED"
-  );
+const signDocumentOnBoarding = async (signData) => {
+  helpers.validateOnBoardingSignDocumentData(signData);
+  const { signature, cert, signedDigest } = signData;
+  try {
+    const signBody = {
+      positions: JSON.stringify(
+        signature.positions.map((p) => ({
+          x: p.x,
+          y: p.y,
+          page: p.page,
+          status: 1,
+        }))
+      ),
+      publickey: cert,
+      signeddigest: signedDigest,
+    };
+
+    const response = await httpRequest(
+      `services/api/documents/sign/${signature.id}`,
+      signBody,
+      "PUT"
+    );
+    return response;
+  } catch (error) {
+    if (error instanceof ApacuanaAPIError) {
+      throw error;
+    }
+    throw new ApacuanaAPIError(
+      `Failed to sign document: ${error.message || "Unknown error"}`
+    );
+  }
 };
 
 const signDocumentOnPremise = async () => {
@@ -192,14 +226,15 @@ const getDocsOnBoarding = async (data) => {
 /**
  * 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.
  */
-export const signDocument = async () => {
+export const signDocument = async (signData) => {
   const { integrationType } = getConfig();
 
   if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
-    return signDocumentOnBoarding();
+    return signDocumentOnBoarding(signData);
   }
 
   if (integrationType === INTEGRATION_TYPE.ONPREMISE) {

package/src/api/users.js

@@ -2,12 +2,19 @@ import { httpRequest } from "../utils/httpClient";
 import { ApacuanaAPIError } from "../errors/index";
 import { getConfig } from "../config/index";
 
+/**
+ * @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.
  */

package/src/index.js

@@ -3,7 +3,7 @@ import { initHttpClient, setAuthToken } from "./utils/httpClient";
 import getCustomer from "./api/users";
 import requestRevocation from "./api/revocations";
 import { generateCert, getCertStatus } from "./api/certs";
-import { addSigner, getDocs } from "./api/signatures";
+import { addSigner, getDigest, getDocs, signDocument } from "./api/signatures";
 
 const apacuana = {
   /**
@@ -66,6 +66,8 @@ const apacuana = {
   addSigner,
   getDocs,
   generateCert,
+  signDocument,
+  getDigest,
 };
 
 export default apacuana;

package/src/utils/constant.js

@@ -15,6 +15,6 @@ export const VERIFICATION_STATUS = {
 };
 
 export const INTEGRATION_TYPE = {
-  ONBOARDING: 'onboarding',
-  ONPREMISE: 'onpremise',
+  ONBOARDING: "ONBOARDING",
+  ONPREMISE: "ONPREMISE",
 };

package/src/utils/helpers.js

@@ -212,6 +212,50 @@ const validateGetDigestData = (signData) => {
   }
 };
 
+const validateOnBoardingSignDocumentData = (signData) => {
+  if (!signData || typeof signData !== "object") {
+    throw new ApacuanaAPIError(
+      "Sign data is required and must be an object.",
+      400,
+      "INVALID_PARAMETER"
+    );
+  }
+
+  const { signature, cert, signedDigest } = signData;
+
+  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"
+    );
+  }
+};
+
 export default {
   getCertificateStatus,
   exportPrivateKey,
@@ -221,4 +265,5 @@ export default {
   validateCsr,
   validateGetDocsData,
   validateGetDigestData,
+  validateOnBoardingSignDocumentData,
 };