apacuana-sdk-core 0.11.0 → 0.13.0

package/src/types/signatures.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import('../success').ApacuanaSuccess} ApacuanaSuccess
+ */
+
 /**
  * Define la estructura de un objeto Firmante.
  * @typedef {object} Signer
@@ -7,30 +11,54 @@
  */
 
 /**
- * Define la estructura de datos para añadir un firmante.
- * @typedef {object} SignerData
- * @property {string} docId - Identificador único del documento.
+ * @typedef {object} AddSignerData
+ * @property {string} signer - Identificador de confirmación del firmante añadido.
  */
 
 /**
  * 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.
+ * @property {true} success
+ * @property {AddSignerData} data
  */
 
 /**
  * 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.
+ * @property {string} signatureId - Identificador único de la firma.
+ * @property {File} [document] - Documento a firmar en formato de archivo. Este campo es opcional.
+ */
+
+/**
+ * @typedef {object} SignaturePlacement
+ * @property {number} page - Página donde se estampará la firma.
+ * @property {number} x - Coordenada X de la firma.
+ * @property {number} y - Coordenada Y de la firma.
+ */
+
+/**
+ * Define la estructura de datos para añadir un firmante.
+ * @typedef {object} SignerData
+ * @property {string} name - Nombre del firmante.
+ * @property {string} typedoc - Tipo de documento de identidad del firmante.
+ * @property {string} doc - Número de documento de identidad del firmante.
+ * @property {Array<SignaturePlacement>} signature - Array con las coordenadas donde se estampará la firma.
+ * @property {string} [reference] - Referencia a un documento pre-cargado. Se debe proporcionar 'reference' o 'file', pero no ambos.
+ * @property {File} [file] - Archivo del documento a firmar. Se debe proporcionar 'reference' o 'file', pero no ambos.
+ */
+
+/**
+ * Define la estructura de datos para la respuesta de la creación de una firma.
+ * @typedef {object} GetDigestResponseData
+ * @property {string} digest - El digest del documento que se va a firmar.
  */
 
 /**
  * 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.
+ * @property {true} success
+ * @property {GetDigestResponseData} data
  */
 
 /**
@@ -42,11 +70,16 @@
  */
 
 /**
- * Define la estructura de la respuesta al obtener documentos.
- * @typedef {object} GetDocsResponse
+ * @typedef {object} GetDocsResponseData
  * @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.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ * @typedef {object} GetDocsResponse
+ * @property {true} success
+ * @property {GetDocsResponseData} data
  */
 
 /**
@@ -56,22 +89,8 @@
  * @property {Array<object>} signature.positions - Posiciones de la firma.
  * @property {string} cert - Certificado en base64.
  * @property {string} signedDigest - Digest firmado.
+ * @property {File} [document] - Documento a firmar en formato de archivo. Este campo es opcional.
+ 
  */
 
-/**
- * @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.
- */
-
-export {};
+export {};

package/src/utils/helpers.js

@@ -65,8 +65,31 @@ const encryptedCsr = (csr, encryptKey = KEY_HEX) => {
   return body;
 };
 
+const createPayloadGetDigest = (signData) => {
+  const formData = new FormData();
+
+  // Iterate over the object's own properties
+  Object.keys(signData).forEach((key) => {
+    // Conditionally handle the 'document' field
+
+    if (key === "document" && signData[key] instanceof File) {
+      // Append the file directly
+      formData.append(key, signData[key]);
+    } else if (key === "cert") {
+      formData.append("publickey", signData[key]);
+    }
+  });
+  return formData;
+};
+
 const validateOnBoardingSignerData = (signerData) => {
-  if (!signerData.name || typeof signerData.name !== "string") {
+  // Create a copy of the original object to avoid modifying the function parameter
+  const validatedSignerData = { ...signerData };
+
+  if (
+    !validatedSignerData.name ||
+    typeof validatedSignerData.name !== "string"
+  ) {
     throw new ApacuanaAPIError(
       'El campo "name" es requerido y debe ser una cadena de texto.',
       400,
@@ -74,16 +97,46 @@ const validateOnBoardingSignerData = (signerData) => {
     );
   }
 
-  if (!signerData.reference || typeof signerData.reference !== "string") {
+  // Limpia 'reference' si es inválido o está vacío.
+  if (
+    !validatedSignerData.reference ||
+    typeof validatedSignerData.reference !== "string" ||
+    validatedSignerData.reference.trim() === ""
+  ) {
+    delete validatedSignerData.reference;
+  }
+
+  // Limpia 'file' si no es una instancia de File.
+  if (
+    typeof File === "undefined" ||
+    !validatedSignerData.file ||
+    !(validatedSignerData.file instanceof File)
+  ) {
+    delete validatedSignerData.file;
+  }
+
+  // Valida que solo uno de los dos campos exista después de la limpieza.
+  if (validatedSignerData.reference && validatedSignerData.file) {
+    throw new ApacuanaAPIError(
+      "No se pueden proporcionar 'reference' y 'file' simultáneamente.",
+      400,
+      "INVALID_PARAMETER_FORMAT"
+    );
+  }
+
+  if (!validatedSignerData.reference && !validatedSignerData.file) {
     throw new ApacuanaAPIError(
-      'El campo "reference" es requerido y debe ser una cadena de texto.',
+      "Se debe proporcionar un campo 'reference' o 'file' válido.",
       400,
       "INVALID_PARAMETER_FORMAT"
     );
   }
 
   const validDocTypes = ["V", "P", "E"];
-  if (!signerData.typedoc || !validDocTypes.includes(signerData.typedoc)) {
+  if (
+    !validatedSignerData.typedoc ||
+    !validDocTypes.includes(validatedSignerData.typedoc)
+  ) {
     throw new ApacuanaAPIError(
       'El campo "typedoc" es requerido y debe ser uno de los siguientes valores: V, P, E.',
       400,
@@ -91,7 +144,7 @@ const validateOnBoardingSignerData = (signerData) => {
     );
   }
 
-  if (!signerData.doc || typeof signerData.doc !== "string") {
+  if (!validatedSignerData.doc || typeof validatedSignerData.doc !== "string") {
     throw new ApacuanaAPIError(
       'El campo "doc" es requerido y debe ser una cadena de texto.',
       400,
@@ -100,8 +153,8 @@ const validateOnBoardingSignerData = (signerData) => {
   }
 
   if (
-    !Array.isArray(signerData.signature) ||
-    signerData.signature.length === 0
+    !Array.isArray(validatedSignerData.signature) ||
+    validatedSignerData.signature.length === 0
   ) {
     throw new ApacuanaAPIError(
       'El campo "signature" es requerido y debe ser un array no vacío.',
@@ -110,7 +163,7 @@ const validateOnBoardingSignerData = (signerData) => {
     );
   }
 
-  signerData.signature.forEach((sig, index) => {
+  validatedSignerData.signature.forEach((sig, index) => {
     if (!Number.isInteger(sig.page) || sig.page < 1) {
       throw new ApacuanaAPIError(
         `La página de la firma ${
@@ -141,6 +194,19 @@ const validateOnBoardingSignerData = (signerData) => {
       );
     }
   });
+
+  const formData = new FormData();
+  Object.keys(validatedSignerData).forEach((key) => {
+    if (key === "signature") {
+      formData.append(key, JSON.stringify(validatedSignerData[key]));
+    } else if (key === "file") {
+      formData.append("document", validatedSignerData[key]);
+    } else if (validatedSignerData[key] !== undefined) {
+      formData.append(key, validatedSignerData[key]);
+    }
+  });
+
+  return formData;
 };
 
 const validateCsr = (encryptedCSR) => {
@@ -243,6 +309,26 @@ const validateOnBoardingSignDocumentData = (signData) => {
       "INVALID_PARAMETER"
     );
   }
+
+  const formData = new FormData();
+  formData.append(
+    "positions",
+    JSON.stringify(
+      signature.positions.map((p) => ({
+        x: p.x,
+        y: p.y,
+        page: p.page,
+        status: 1,
+      }))
+    )
+  );
+  formData.append("publickey", cert);
+  formData.append("signeddigest", signedDigest);
+  if (signData.document && signData.document instanceof File) {
+    formData.append("document", signData.document);
+  }
+
+  return formData;
 };
 
 export default {
@@ -255,4 +341,5 @@ export default {
   validateGetDocsData,
   validateGetDigestData,
   validateOnBoardingSignDocumentData,
+  createPayloadGetDigest,
 };

package/src/utils/httpClient.js

@@ -129,18 +129,23 @@ export const httpRequest = async (path, data = {}, method = "POST") => {
   let dataToSend;
   const requestConfig = {};
 
-  const hasFile = Object.values(data).some(
-    (value) => typeof File !== "undefined" && value instanceof File
-  );
-  if (hasFile) {
-    const formData = new FormData();
-    Object.keys(data).forEach((key) => {
-      formData.append(key, data[key]);
-    });
-    dataToSend = formData;
+  if (typeof FormData !== "undefined" && data instanceof FormData) {
+    dataToSend = data;
   } else {
-    dataToSend = { ...data };
+    const hasFile = Object.values(data).some(
+      (value) => typeof File !== "undefined" && value instanceof File
+    );
+    if (hasFile) {
+      const formData = new FormData();
+      Object.keys(data).forEach((key) => {
+        formData.append(key, data[key]);
+      });
+      dataToSend = formData;
+    } else {
+      dataToSend = { ...data };
+    }
   }
+
   try {
     let response;
     switch (method.toUpperCase()) {

package/tests/api/faceLiveness.test.js

@@ -1,8 +1,11 @@
-import * as faceLiveness from "../../src/api/faceLiveness";
+import {
+  createFaceLivenessSession,
+  validateFaceLiveness,
+} from "../../src/api/faceLiveness";
 import { httpRequest } from "../../src/utils/httpClient";
-import { getConfig } from "../../src/config";
-import { ApacuanaAPIError } from "../../src/errors";
 import ApacuanaSuccess from "../../src/success";
+import { setConfig, getConfig } from "../../src/config";
+import { ApacuanaAPIError } from "../../src/errors";
 import { INTEGRATION_TYPE } from "../../src/utils/constant";
 
 jest.mock("../../src/utils/httpClient", () => ({
@@ -11,6 +14,7 @@ jest.mock("../../src/utils/httpClient", () => ({
 
 jest.mock("../../src/config", () => ({
   getConfig: jest.fn(),
+  setConfig: jest.fn(),
 }));
 
 describe("FaceLiveness API", () => {
@@ -21,23 +25,25 @@ describe("FaceLiveness API", () => {
 
   describe("createFaceLivenessSession", () => {
     it("should create a session for ONBOARDING integration", async () => {
-      httpRequest.mockResolvedValue({ sessionId: "test-session-id" });
+      const mockSessionId = "session-onboarding-123";
+      httpRequest.mockResolvedValue({ sessionid: mockSessionId });
+      setConfig({ onboardingId: "some-onboarding-id" });
 
-      const result = await faceLiveness.createFaceLivenessSession();
+      const result = await createFaceLivenessSession();
 
-      expect(result).toBeInstanceOf(ApacuanaSuccess);
-      expect(result.data).toEqual({ sessionId: "test-session-id" });
       expect(httpRequest).toHaveBeenCalledWith(
         "services/api/faceliveness/create",
         {},
         "POST"
       );
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual({ sessionId: mockSessionId });
     });
 
-    it("should throw an error if API response does not contain sessionId for ONBOARDING", async () => {
+    it("should throw an error if session ID is missing for ONBOARDING", async () => {
       httpRequest.mockResolvedValue({}); // No sessionId
 
-      await expect(faceLiveness.createFaceLivenessSession()).rejects.toThrow(
+      await expect(createFaceLivenessSession()).rejects.toThrow(
         new ApacuanaAPIError(
           "The API response does not contain the session ID.",
           undefined,
@@ -51,7 +57,7 @@ describe("FaceLiveness API", () => {
         integrationType: INTEGRATION_TYPE.ONPREMISE,
       });
 
-      await expect(faceLiveness.createFaceLivenessSession()).rejects.toThrow(
+      await expect(createFaceLivenessSession()).rejects.toThrow(
         new ApacuanaAPIError(
           "Creating a Face Liveness session is not supported for integration type: ONPREMISE",
           501,
@@ -63,7 +69,7 @@ describe("FaceLiveness API", () => {
     it("should throw an UNSUPPORTED_INTEGRATION_TYPE error for unsupported integration types", async () => {
       getConfig.mockReturnValue({ integrationType: "unsupported-type" });
 
-      await expect(faceLiveness.createFaceLivenessSession()).rejects.toThrow(
+      await expect(createFaceLivenessSession()).rejects.toThrow(
         new ApacuanaAPIError(
           "Unsupported integration type: unsupported-type",
           400,
@@ -76,16 +82,14 @@ describe("FaceLiveness API", () => {
       const apiError = new ApacuanaAPIError("API Error", 500, "API_ERROR");
       httpRequest.mockRejectedValue(apiError);
 
-      await expect(faceLiveness.createFaceLivenessSession()).rejects.toThrow(
-        apiError
-      );
+      await expect(createFaceLivenessSession()).rejects.toThrow(apiError);
     });
 
     it("should throw a generic error for other failures during session creation", async () => {
       const genericError = new Error("Network Error");
       httpRequest.mockRejectedValue(genericError);
 
-      await expect(faceLiveness.createFaceLivenessSession()).rejects.toThrow(
+      await expect(createFaceLivenessSession()).rejects.toThrow(
         `Failed to create Face Liveness session: ${genericError.message}`
       );
     });
@@ -95,7 +99,7 @@ describe("FaceLiveness API", () => {
     const sessionId = "test-session-id";
 
     it("should throw an error if sessionId is not provided", async () => {
-      await expect(faceLiveness.validateFaceLiveness({})).rejects.toThrow(
+      await expect(validateFaceLiveness({})).rejects.toThrow(
         new ApacuanaAPIError(
           "sessionId is a required parameter.",
           400,
@@ -107,7 +111,7 @@ describe("FaceLiveness API", () => {
     it("should return 'verified' on status 200", async () => {
       httpRequest.mockResolvedValue({ someData: "data" });
 
-      const result = await faceLiveness.validateFaceLiveness({ sessionId });
+      const result = await validateFaceLiveness({ sessionId });
 
       expect(result).toBeInstanceOf(ApacuanaSuccess);
       expect(result.data).toEqual({ status: "verified", someData: "data" });
@@ -126,14 +130,10 @@ describe("FaceLiveness API", () => {
     ])(
       "should return status '%s' for statusCode %i",
       async (statusCode, status) => {
-        const apiError = new ApacuanaAPIError(
-          "Error",
-          statusCode,
-          "API_ERROR"
-        );
+        const apiError = new ApacuanaAPIError("Error", statusCode, "API_ERROR");
         httpRequest.mockRejectedValue(apiError);
 
-        const result = await faceLiveness.validateFaceLiveness({ sessionId });
+        const result = await validateFaceLiveness({ sessionId });
 
         expect(result).toBeInstanceOf(ApacuanaSuccess);
         expect(result.data).toEqual({ status });
@@ -148,9 +148,9 @@ describe("FaceLiveness API", () => {
       );
       httpRequest.mockRejectedValue(apiError);
 
-      await expect(
-        faceLiveness.validateFaceLiveness({ sessionId })
-      ).rejects.toThrow(apiError);
+      await expect(validateFaceLiveness({ sessionId })).rejects.toThrow(
+        apiError
+      );
     });
 
     it("should throw a NOT_IMPLEMENTED error for ONPREMISE integration", async () => {
@@ -158,9 +158,7 @@ describe("FaceLiveness API", () => {
         integrationType: INTEGRATION_TYPE.ONPREMISE,
       });
 
-      await expect(
-        faceLiveness.validateFaceLiveness({ sessionId })
-      ).rejects.toThrow(
+      await expect(validateFaceLiveness({ sessionId })).rejects.toThrow(
         new ApacuanaAPIError(
           "Validating a Face Liveness session is not supported for integration type: ONPREMISE",
           501,
@@ -169,4 +167,4 @@ describe("FaceLiveness API", () => {
       );
     });
   });
-});
+});

package/tests/api/revocations.test.js

@@ -35,7 +35,7 @@ describe("Revocations API", () => {
       const result = await requestRevocation(params);
 
       expect(httpRequest).toHaveBeenCalledWith(
-        "services/api/certificate/revocation",
+        "services/api/onboardingclient/requestcert",
         params,
         "POST"
       );
@@ -64,18 +64,18 @@ describe("Revocations API", () => {
 
   describe("getRevocationReasons", () => {
     it("should make a GET request and return the reasons for ONBOARDING", async () => {
-      const mockReasons = [{ code: 1, reason: "Test Reason" }];
+      const mockReasons = [{ code: "01", description: "Test Reason" }];
       httpRequest.mockResolvedValue({ records: mockReasons });
 
       const result = await getRevocationReasons();
 
       expect(httpRequest).toHaveBeenCalledWith(
-        "services/api/certificate/revocation-reasons",
+        "config/api/revocation/reasonsonboarding",
         {},
         "GET"
       );
       expect(result).toBeInstanceOf(ApacuanaSuccess);
-      expect(result.data).toEqual(mockReasons);
+      expect(result.data).toEqual({ reasons: mockReasons });
     });
 
     it("should throw an error if the API response does not contain 'records'", async () => {

package/tests/api/signatures.test.js

@@ -24,9 +24,32 @@ jest.mock("../../src/utils/helpers", () => ({
   validateGetDocsData: jest.fn(),
   validateGetDigestData: jest.fn(),
   validateOnBoardingSignDocumentData: jest.fn(),
+  createPayloadGetDigest: jest.fn(),
 }));
 
 describe("API - Signatures", () => {
+  beforeAll(() => {
+    // FormData no existe en el entorno de Node.js de Jest.
+    // Creamos una simulación (mock) que incluye los métodos 'append' y 'forEach'.
+    global.FormData = class FormData {
+      constructor() {
+        this.data = new Map();
+      }
+      append(key, value) {
+        this.data.set(key, value);
+      }
+      forEach(callback) {
+        // Delegamos la llamada forEach al Map interno.
+        this.data.forEach((value, key) => callback(value, key));
+      }
+    };
+  });
+
+  afterAll(() => {
+    // Limpiamos la simulación global después de las pruebas.
+    delete global.FormData;
+  });
+
   afterEach(() => {
     jest.resetAllMocks();
   });
@@ -37,6 +60,12 @@ describe("API - Signatures", () => {
         integrationType: INTEGRATION_TYPE.ONBOARDING,
       });
       const signerData = { typedoc: "V", doc: "12345678" };
+
+      const formData = new FormData();
+      formData.append("typedoc", "V");
+      formData.append("doc", "12345678");
+
+      helpers.validateOnBoardingSignerData.mockReturnValue(formData);
       httpRequest.mockResolvedValue({ success: true });
 
       await addSigner(signerData);
@@ -45,8 +74,8 @@ describe("API - Signatures", () => {
         signerData
       );
       expect(httpRequest).toHaveBeenCalledWith(
-        "services/api/documents/signing",
-        signerData,
+        "services/api/documents/signingsdk",
+        formData,
         "POST"
       );
     });
@@ -177,12 +206,17 @@ describe("API - Signatures", () => {
       const mockResponse = { data: { digest: "test-digest" } };
       httpRequest.mockResolvedValue(mockResponse);
 
+      const expectedFormData = new FormData();
+      expectedFormData.append("publickey", "test-cert");
+      helpers.createPayloadGetDigest.mockReturnValue(expectedFormData);
+
       const result = await getDigest(signData);
 
       expect(helpers.validateGetDigestData).toHaveBeenCalledWith(signData);
+      expect(helpers.createPayloadGetDigest).toHaveBeenCalledWith(signData);
       expect(httpRequest).toHaveBeenCalledWith(
         `services/api/documents/getdigest/${signData.signatureId}`,
-        { publickey: signData.cert },
+        expectedFormData,
         "POST"
       );
       expect(result).toBeInstanceOf(ApacuanaSuccess);
@@ -243,20 +277,33 @@ describe("API - Signatures", () => {
       const mockResponse = { success: true };
       httpRequest.mockResolvedValue(mockResponse);
 
+      const expectedFormData = new FormData();
+      expectedFormData.append(
+        "positions",
+        JSON.stringify(
+          signData.signature.positions.map((p) => ({
+            x: p.x,
+            y: p.y,
+            page: p.page,
+            status: 1,
+          }))
+        )
+      );
+      expectedFormData.append("publickey", signData.cert);
+      expectedFormData.append("signeddigest", signData.signedDigest);
+
+      helpers.validateOnBoardingSignDocumentData.mockReturnValue(
+        expectedFormData
+      );
+
       const result = await signDocument(signData);
 
-      expect(
-        helpers.validateOnBoardingSignDocumentData
-      ).toHaveBeenCalledWith(signData);
+      expect(helpers.validateOnBoardingSignDocumentData).toHaveBeenCalledWith(
+        signData
+      );
       expect(httpRequest).toHaveBeenCalledWith(
         `services/api/documents/sign/${signData.signature.id}`,
-        {
-          positions: JSON.stringify([
-            { x: 0.1, y: 0.2, page: 1, status: 1 },
-          ]),
-          publickey: signData.cert,
-          signeddigest: signData.signedDigest,
-        },
+        expectedFormData,
         "PUT"
       );
       expect(result).toBeInstanceOf(ApacuanaSuccess);
@@ -306,10 +353,18 @@ describe("API - Signatures", () => {
 
     it("should throw an error if data or data.file is not provided", async () => {
       await expect(uploadSignatureVariant(null)).rejects.toThrow(
-        new ApacuanaAPIError("El parámetro 'file' es requerido.", 400, "INVALID_PARAMETER")
+        new ApacuanaAPIError(
+          "El parámetro 'file' es requerido.",
+          400,
+          "INVALID_PARAMETER"
+        )
       );
       await expect(uploadSignatureVariant({})).rejects.toThrow(
-        new ApacuanaAPIError("El parámetro 'file' es requerido.", 400, "INVALID_PARAMETER")
+        new ApacuanaAPIError(
+          "El parámetro 'file' es requerido.",
+          400,
+          "INVALID_PARAMETER"
+        )
       );
     });
 
@@ -325,7 +380,9 @@ describe("API - Signatures", () => {
 
     it("should throw an error if file is not a PNG", async () => {
       const invalidFile = new File([], "test.txt", { type: "text/plain" });
-      await expect(uploadSignatureVariant({ file: invalidFile })).rejects.toThrow(
+      await expect(
+        uploadSignatureVariant({ file: invalidFile })
+      ).rejects.toThrow(
         new ApacuanaAPIError(
           "El archivo debe ser de tipo PNG (image/png).",
           400,