apacuana-sdk-core 0.10.0 → 0.12.0

package/src/api/users.js

@@ -1,12 +1,18 @@
 import { httpRequest } from "../utils/httpClient";
 import { ApacuanaAPIError } from "../errors/index";
 import { getConfig } from "../config/index";
+import ApacuanaSuccess from "../success";
 
 /**
- * @typedef {object} GetCustomerResponse
+ * @typedef {object} GetCustomerData
  * @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.
+ */
+
+/**
+ * @typedef {object} GetCustomerResponse
+ * @property {true} success - Indica que la operación fue exitosa.
+ * @property {GetCustomerData} data - El payload de la respuesta.
  */
 
 /**
@@ -14,7 +20,7 @@ import { getConfig } from "../config/index";
  * 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<GetCustomerResponse>} Objeto con el token de sesión, los datos del usuario y un indicador de éxito.
+ * @returns {Promise<GetCustomerResponse>} Una promesa que resuelve a un objeto con la respuesta exitosa.
  * @throws {Error} Si los parámetros de entrada son inválidos.
  * @throws {ApacuanaAPIError} Si ocurre un error en la API de Apacuana.
  */
@@ -49,19 +55,16 @@ const getCustomer = async () => {
       );
     }
 
-    return {
+    return new ApacuanaSuccess({
       token: response.sessionid,
       userData: response.entry,
-      success: true,
-    };
+    });
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
     }
     throw new ApacuanaAPIError(
-      `Unexpected failure getting token: ${
-        error.message || "Unknown error"
-      }`
+      `Unexpected failure getting token: ${error.message || "Unknown error"}`
     );
   }
 };

package/src/index.js

@@ -7,6 +7,7 @@ import {
   getCertStatus,
   getCertTypes,
   getRequerimentsByTypeUser,
+  requestCertificate,
 } from "./api/certs";
 import {
   addSigner,
@@ -17,6 +18,12 @@ import {
   signDocument,
   uploadSignatureVariant,
 } from "./api/signatures";
+import {
+  createFaceLivenessSession,
+  validateFaceLiveness,
+} from "./api/faceLiveness";
+import ApacuanaSuccess from "./success/index";
+import { ApacuanaAPIError } from "./errors/index";
 
 const apacuana = {
   /**
@@ -37,21 +44,39 @@ const apacuana = {
       initHttpClient();
       const currentConfig = getConfig();
       if (!currentConfig.customerId) {
-        throw new Error(
+        throw new ApacuanaAPIError(
           "Apacuana SDK: La configuración de CustomerId no se ha guardado" +
-            " correctamente."
+            " correctamente.",
+          400,
+          { code: "CONFIG_ERROR" }
         );
       }
-      const { token, userData } = await getCustomer();
+
+      const customer = await getCustomer();
+      const { token, userData } = customer.data;
       setConfig({ ...currentConfig, token, userData });
       setAuthToken(token);
-      return true;
+      return new ApacuanaSuccess({
+        initialized: true,
+        message: "SDK inicializado correctamente.",
+      });
     } catch (error) {
       // eslint-disable-next-line no-console
       console.error("Error durante la inicialización del SDK:", error);
-      throw error;
+      if (error instanceof ApacuanaAPIError) {
+        throw error;
+      }
+      throw new ApacuanaAPIError(
+        error.message || "Error desconocido durante la inicialización.",
+        500,
+        error
+      );
     }
   },
+
+  /**
+   * Permite obtener la configuración actual del SDK.
+   */
   close: () => close(),
   getConfig,
   requestRevocation,
@@ -68,6 +93,9 @@ const apacuana = {
   deleteSignatureVariant,
   getCertTypes,
   getRequerimentsByTypeUser,
+  createFaceLivenessSession,
+  validateFaceLiveness,
+  requestCertificate,
 };
 
 export default apacuana;

package/src/success/index.js

@@ -0,0 +1,8 @@
+export default class ApacuanaSuccess {
+  constructor(data, statusCode = 200) {
+    this.success = true;
+    this.statusCode = statusCode;
+    this.name = "ApacuanaSuccess";
+    this.data = data;
+  }
+}

package/src/types/certs.js

@@ -0,0 +1,56 @@
+/**
+ * @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.
+ */
+
+/**
+ * @typedef {object} GetCertStatusResponse
+ * @property {string} status - El estado actual del certificado del usuario.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * @typedef {object} EncryptedCSRObject
+ * @property {string} csr - The encrypted Certificate Signing Request.
+ */
+
+/**
+ * @typedef {object} CertType
+ * @property {string} id - The ID of the certificate type.
+ * @property {string} name - The name of the certificate type.
+ */
+
+/**
+ * @typedef {object} GetCertTypesResponse
+ * @property {Array<CertType>} types - A list of available certificate types.
+ * @property {boolean} success - Indicates if the operation was successful.
+ */
+
+/**
+ * @typedef {object} Requirement
+ * @property {string} id - The ID of the requirement.
+ * @property {string} description - The description of the requirement.
+ */
+
+/**
+ * @typedef {object} GetRequirementsResponse
+ * @property {Array<Requirement>} requirements - A list of requirements for the user type.
+ * @property {boolean} success - Indicates if the operation was successful.
+ */
+
+/**
+ * @typedef {object} CertificateRequestParams
+ * @property {number} type - The user type to get requirements for.
+ * @property {string} [observation] - An optional observation for the certificate request.
+ * @property {Array<{id: string, file: string}>} documents - The documents required for the certificate.
+ */
+
+/**
+ * @typedef {object} RequestCertificateResponse
+ * @property {string} message - A message confirming the request.
+ * @property {boolean} success - Indicates if the operation was successful.
+ */
+
+export {};

package/src/types/faceLiveness.js

@@ -0,0 +1,16 @@
+/**
+ * @typedef {import('../success').ApacuanaSuccess} ApacuanaSuccess
+ */
+
+/**
+ * @typedef {object} CreateFaceLivenessSessionData
+ * @property {string} sessionId - The session ID for the face liveness check.
+ */
+
+/**
+ * @typedef {object} CreateFaceLivenessSessionResponse
+ * @property {true} success
+ * @property {CreateFaceLivenessSessionData} data
+ */
+
+export {};

package/src/types/revocations.js

@@ -0,0 +1,45 @@
+/**
+ * @typedef {import('../success').ApacuanaSuccess} ApacuanaSuccess
+ */
+
+/**
+ * @typedef {object} RevocationReason
+ * @property {string} code - The code for the revocation reason.
+ * @property {string} description - The description of the revocation reason.
+ */
+
+/**
+ * @typedef {object} RequestRevocationData
+ * @property {string} message - A message providing details about the outcome.
+ */
+
+/**
+ * @typedef {object} RequestRevocationResponse
+ * @property {true} success
+ * @property {RequestRevocationData} data
+ */
+
+/**
+ * @typedef {object} GetRevocationReasonsData
+ * @property {RevocationReason[]} reasons - A list of revocation reasons.
+ */
+
+/**
+ * @typedef {object} GetRevocationReasonsResponse
+ * @property {true} success
+ * @property {GetRevocationReasonsData} data
+ */
+
+/**
+ * @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} RevocationReasonsResponse
+ * @property {boolean} success - Indicates if the request was successful.
+ * @property {RevocationReason[]} reasons - A list of revocation reasons.
+ */
+
+export {};

package/src/types/signatures.js

@@ -0,0 +1,91 @@
+/**
+ * @typedef {import('../success').ApacuanaSuccess} ApacuanaSuccess
+ */
+
+/**
+ * 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.
+ */
+
+/**
+ * @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 {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 de la firma.
+ */
+
+/**
+ * @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} reference - Referencia o identificador 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.
+ */
+
+/**
+ * @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 {true} success
+ * @property {GetDigestResponseData} data
+ */
+
+/**
+ * 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.
+ */
+
+/**
+ * @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.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ * @typedef {object} GetDocsResponse
+ * @property {true} success
+ * @property {GetDocsResponseData} data
+ */
+
+/**
+ * @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.
+ */
+
+export {};

package/src/types/users.js

@@ -0,0 +1,73 @@
+/**
+ * @typedef {object} UserData
+ * @property {string} email - Correo electrónico. No puede contener espacios y tiene un máximo de 128 caracteres.
+ * @property {number} typeuser - Tipo de usuario. Debe ser un ID valido.
+ * @property {string} name - Nombre de la persona.
+ * @property {string} lastname - Apellido de la persona.
+ * @property {'V' | 'P' | 'E'} kinddoc - Tipo de documento de identidad. Puede ser 'V' (Venezolano), 'P' (Pasaporte) o 'E' (Extranjero).
+ * @property {number} doc - Número de documento de identidad. Debe ser un número entero.
+ * @property {string} birthdate - Fecha de nacimiento. Debe ser una fecha válida en formato ISO y no puede ser una fecha futura.
+ * @property {'J' | 'G' | 'V' | 'P' | 'E'} kindrif - Tipo de RIF (Registro de Información Fiscal). Puede ser 'J', 'G', 'V', 'P' o 'E'.
+ * @property {'M' | 'F' | 'Sin especificar'} gender - Género. Puede ser 'M' (Masculino), 'F' (Femenino) o 'Sin especificar'.
+ * @property {number} rif - Número de RIF. Debe ser un número entero.
+ * @property {number} phone - Número de teléfono. Debe ser un número entero.
+ * @property {string} kindphone - Código de área del teléfono. Ej. 0424.
+ * @property {string} state - Nombre del estado.
+ * @property {string} municipality - Nombre del municipio.
+ * @property {string} parish - Nombre de la parroquia.
+ * @property {string} postalcode - Código postal.
+ * @property {string} address - Dirección.
+ * @property {string} fiscaladdress - Dirección fiscal.
+ * @property {string} fiscalkindphone - Código de área del teléfono fiscal. Ej. 0424.
+ * @property {number} fiscalphone - Número de teléfono fiscal. Debe ser un número entero.
+ * @property {string} occupation - Ocupacion de la persona.
+ * @property {string} degree - Título universitario.
+ * @property {string} university - Universidad.
+ * @property {string} graduationyear - Año de graduación.
+ * @property {string} collegiatenumber - Número de colegiado.
+ * @property {string} collegiateyear - Año de colegiatura.
+ * @property {string} companyname - Nombre de la empresa.
+ * @property {'J' | 'G' | 'V' | 'P' | 'E'} companykindrif - Tipo de RIF de la empresa. Puede ser 'J', 'G', 'V', 'P' o 'E'.
+ * @property {string} companyrif - Número de RIF de la empresa.
+ * @property {string} companystate - Estado de la empresa.
+ * @property {string} companymunicipality - Municipio de la empresa.
+ * @property {string} companyparish - Parroquia de la empresa.
+ * @property {string} companyaddress - Dirección de la empresa.
+ * @property {string} companykindphone - Código de área del teléfono de la empresa. Ej. 0212.
+ * @property {string} companyphone - Número de teléfono de la empresa.
+ * @property {string} companypostalcode - Código postal de la empresa.
+ * @property {string} companywebpage - Página web de la empresa.
+ * @property {string} companycommercialregister - Registro comercial de la empresa.
+ * @property {string} companyregisterdate - Fecha de registro de la empresa en formato ISO.
+ * @property {string} companyregisternumber - Número de registro de la empresa.
+ * @property {string} companyconstitutiondate - Fecha de constitución de la empresa en formato ISO.
+ * @property {string} companypublishdate - Fecha de publicación del decreto de constitución. Debe ser una fecha válida en formato ISO y no puede ser una fecha futura.
+ * @property {string} companyconstitutiondecree - Decreto de constitución de la empresa. Máximo 32 caracteres.
+ * @property {string} companynumberdecree - Número de decreto de la empresa. Máximo 16 caracteres.
+ * @property {string} positionprivate - Cargo empleado empresa privada.
+ * @property {string} departmentprivate - Departamento empleado empresa privada.
+ * @property {string} authorizedprivate - Autorizado de por empleado empresa privada.
+ * @property {string} functionsprivate - Funciones empleado empresa privada.
+ * @property {string} publishprivate - Fecha de publicación de la gaceta de la empresa privada.
+ * @property {string} issuedateprivate - Fecha de registro de la empresa privada. Debe ser una fecha válida en formato ISO.
+ * @property {string} kindphoneprivate - Código de área del teléfono de la empresa privada. ej. 0424.
+ * @property {number} phoneprivate - Número de teléfono privado. Debe ser un número entero.
+ * @property {string} positionpublic - Cargo empleado empresa publica.
+ * @property {string} departmentpublic - Departamento empleado empresa publica.
+ * @property {string} authorizedpublic - Autorizado empleado empresa publica.
+ * @property {string} functionspublic - Funciones de empleado empresa publica.
+ * @property {string} publishpublic - Fecha de publicación de la gaceta de la empresa pública.
+ * @property {string} issuedatepublic - Fecha de registro de la empresa pública. Debe ser una fecha válida en formato ISO.
+ * @property {string} kindphonepublic - Código de área del teléfono de la empresa publica. ej 0424.
+ * @property {number} phonepublic - Número de teléfono público. Debe ser un número entero.
+ * @property {string} companyid - ID de la empresa. Debe ser un UUID para la creacion de empleados.
+ */
+
+/**
+ * @typedef {object} GetCustomerResponse
+ * @property {string} token - El token de sesión del usuario.
+ * @property {UserData} userData - Los datos del usuario obtenidos.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+export {};

package/tests/api/certs.test.js

@@ -2,11 +2,13 @@ import { getConfig } from "../../src/config/index";
 import { httpRequest } from "../../src/utils/httpClient";
 import helpers from "../../src/utils/helpers";
 import { ApacuanaAPIError } from "../../src/errors";
+import ApacuanaSuccess from "../../src/success";
 import {
   generateCert,
   getCertStatus,
   getCertTypes,
   getRequerimentsByTypeUser,
+  requestCertificate,
 } from "../../src/api/certs";
 import { INTEGRATION_TYPE } from "../../src/utils/constant";
 
@@ -43,10 +45,10 @@ describe("Certificate API - certs.js", () => {
         mockEncryptedCsr,
         "POST"
       );
-      expect(result).toEqual({
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual({
         cert: "onboarding-cert",
         certifiedid: "onboarding-certified-id",
-        success: true,
       });
     });
 
@@ -93,7 +95,8 @@ describe("Certificate API - certs.js", () => {
         mockUserData,
         true
       );
-      expect(result).toEqual({ status: "VALID", success: true });
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual({ status: "VALID" });
     });
   });
 
@@ -112,7 +115,8 @@ describe("Certificate API - certs.js", () => {
         {},
         "GET"
       );
-      expect(result).toEqual({ types: mockApiResponse.types, success: true });
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual({ types: mockApiResponse.types });
     });
 
     it("should throw an error for ONPREMISE integration", async () => {
@@ -159,9 +163,9 @@ describe("Certificate API - certs.js", () => {
         {},
         "GET"
       );
-      expect(result).toEqual({
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual({
         requirements: mockApiResponse.requirements,
-        success: true,
       });
     });
 
@@ -202,5 +206,94 @@ describe("Certificate API - certs.js", () => {
         'The "params" object with a numeric "type" property is required.'
       );
     });
+    it("should throw a generic error for other failures", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
+      const genericError = new Error("Network failure");
+      httpRequest.mockRejectedValue(genericError);
+
+      await expect(getRequerimentsByTypeUser({ type: 1 })).rejects.toThrow(
+        `Failed to get requirements: ${genericError.message}`
+      );
+    });
+  });
+});
+
+describe("requestCertificate", () => {
+  const validParams = { type: 1, documents: [] };
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("should throw an error if params are invalid", async () => {
+    await expect(requestCertificate()).rejects.toThrow(
+      'The "params" object with a numeric "type" property and a "documents" array is required.'
+    );
+    await expect(requestCertificate({ type: 1 })).rejects.toThrow(
+      'The "params" object with a numeric "type" property and a "documents" array is required.'
+    );
+    await expect(requestCertificate({ documents: [] })).rejects.toThrow(
+      'The "params" object with a numeric "type" property and a "documents" array is required.'
+    );
+  });
+
+  it("should request a certificate for ONBOARDING integration", async () => {
+    getConfig.mockReturnValue({ integrationType: INTEGRATION_TYPE.ONBOARDING });
+    const mockResponse = { message: "Certificate requested" };
+    httpRequest.mockResolvedValue(mockResponse);
+
+    const result = await requestCertificate(validParams);
+
+    expect(result).toBeInstanceOf(ApacuanaSuccess);
+    expect(result.data).toEqual(mockResponse);
+    expect(httpRequest).toHaveBeenCalledWith(
+      "services/api/customer/request-certificate",
+      validParams,
+      "POST"
+    );
+  });
+
+  it("should throw a NOT_IMPLEMENTED error for ONPREMISE integration", async () => {
+    getConfig.mockReturnValue({ integrationType: INTEGRATION_TYPE.ONPREMISE });
+
+    await expect(requestCertificate(validParams)).rejects.toThrow(
+      new ApacuanaAPIError(
+        "Requesting a certificate is not supported for integration type: ONPREMISE",
+        501,
+        "NOT_IMPLEMENTED"
+      )
+    );
+  });
+
+  it("should throw an UNSUPPORTED_INTEGRATION_TYPE error for unsupported integration types", async () => {
+    getConfig.mockReturnValue({ integrationType: "unsupported-type" });
+
+    await expect(requestCertificate(validParams)).rejects.toThrow(
+      new ApacuanaAPIError(
+        "Unsupported integration type: unsupported-type",
+        400,
+        "UNSUPPORTED_INTEGRATION_TYPE"
+      )
+    );
+  });
+
+  it("should re-throw ApacuanaAPIError if caught", async () => {
+    getConfig.mockReturnValue({ integrationType: INTEGRATION_TYPE.ONBOARDING });
+    const apiError = new ApacuanaAPIError("API Error", 500, "API_ERROR");
+    httpRequest.mockRejectedValue(apiError);
+
+    await expect(requestCertificate(validParams)).rejects.toThrow(apiError);
+  });
+
+  it("should throw a generic error for other failures", async () => {
+    getConfig.mockReturnValue({ integrationType: INTEGRATION_TYPE.ONBOARDING });
+    const genericError = new Error("Network failure");
+    httpRequest.mockRejectedValue(genericError);
+
+    await expect(requestCertificate(validParams)).rejects.toThrow(
+      `Failed to request certificate: ${genericError.message}`
+    );
   });
 });