apacuana-sdk-core 0.9.0 → 0.11.0

package/src/api/signatures.js

@@ -2,72 +2,20 @@
 import { getConfig } from "../config/index";
 import { httpRequest } from "../utils/httpClient";
 import { ApacuanaAPIError } from "../errors";
+import ApacuanaSuccess from "../success";
 import helpers from "../utils/helpers";
 import { INTEGRATION_TYPE } from "../utils/constant";
 
-// =================================================================
-// 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.
- */
-
-/**
- * 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.
- */
+/** @typedef {import("../types/signatures").Signer} Signer */
+/** @typedef {import("../types/signatures").SignerData} SignerData */
+/** @typedef {import("../types/signatures").AddSignerResponse} AddSignerResponse */
+/** @typedef {import("../types/signatures").GetDigestData} GetDigestData */
+/** @typedef {import("../types/signatures").GetDigestResponse} GetDigestResponse */
+/** @typedef {import("../types/signatures").GetDocsParams} GetDocsParams */
+/** @typedef {import("../types/signatures").GetDocsResponse} GetDocsResponse */
+/** @typedef {import("../types/signatures").SignDocumentData} SignDocumentData */
+/** @typedef {import("../types/signatures").SignaturePosition} SignaturePosition */
+/** @typedef {import("../types/signatures").OnboardingSignerData} OnboardingSignerData */
 
 // =================================================================
 // Internal Functions
@@ -95,7 +43,7 @@ const signDocumentOnBoarding = async (signData) => {
       signBody,
       "PUT"
     );
-    return response;
+    return new ApacuanaSuccess(response);
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -132,7 +80,7 @@ const getDigestToSignOnBoarding = async (signData) => {
       );
     }
 
-    return { digest, success: true };
+    return new ApacuanaSuccess({ digest });
   } catch (error) {
     if (error.name === "ApacuanaAPIError") {
       throw error;
@@ -155,7 +103,9 @@ const addSignerOnBoarding = async (signerData) => {
   helpers.validateOnBoardingSignerData(signerData);
   try {
     await httpRequest("services/api/documents/signing", signerData, "POST");
-    return { signer: signerData.typedoc + signerData.doc, success: true };
+    return new ApacuanaSuccess({
+      signer: signerData.typedoc + signerData.doc,
+    });
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -203,11 +153,10 @@ const getDocsOnBoarding = async (data) => {
 
     const apiUrl = `services/api/documents/listcustomer?${params.toString()}`;
     const response = await httpRequest(apiUrl, {}, "GET");
-    return {
+    return new ApacuanaSuccess({
       totalRecords: response.numofrecords,
       records: response.records,
-      success: true,
-    };
+    });
   } catch (error) {
     if (error.name === "ApacuanaAPIError") {
       throw error;
@@ -225,7 +174,7 @@ const uploadSignatureVariantOnBoarding = async ({ file }) => {
       { file },
       "POST"
     );
-    return { ...response, success: true };
+    return new ApacuanaSuccess(response);
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -252,7 +201,7 @@ const getSignatureVariantOnBoarding = async () => {
       {},
       "GET"
     );
-    return { ...response, success: true };
+    return new ApacuanaSuccess(response);
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -278,7 +227,7 @@ const deleteSignatureVariantOnBoarding = async () => {
       {},
       "DELETE"
     );
-    return { ...response, success: true };
+    return new ApacuanaSuccess(response);
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -358,31 +307,6 @@ export const getDigest = async (signData) => {
  * @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.
- */
 export const addSigner = async (signerData) => {
   if (
     !signerData ||

package/src/api/users.js

@@ -1,6 +1,7 @@
 import { httpRequest } from "../utils/httpClient";
 import { ApacuanaAPIError } from "../errors/index";
 import { getConfig } from "../config/index";
+import ApacuanaSuccess from "../success";
 
 /**
  * @typedef {object} GetCustomerResponse
@@ -49,19 +50,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

@@ -2,7 +2,13 @@ import { setConfig, getConfig, close } from "./config/index";
 import { initHttpClient, setAuthToken } from "./utils/httpClient";
 import getCustomer from "./api/users";
 import { requestRevocation, getRevocationReasons } from "./api/revocations";
-import { generateCert, getCertStatus } from "./api/certs";
+import {
+  generateCert,
+  getCertStatus,
+  getCertTypes,
+  getRequerimentsByTypeUser,
+  requestCertificate,
+} from "./api/certs";
 import {
   addSigner,
   deleteSignatureVariant,
@@ -12,6 +18,10 @@ import {
   signDocument,
   uploadSignatureVariant,
 } from "./api/signatures";
+import {
+  createFaceLivenessSession,
+  validateFaceLiveness,
+} from "./api/faceLiveness";
 
 const apacuana = {
   /**
@@ -61,6 +71,11 @@ const apacuana = {
   uploadSignatureVariant,
   getSignatureVariant,
   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,7 @@
+/**
+ * @typedef {object} CreateFaceLivenessSessionResponse
+ * @property {string} sessionId - The session ID for the face liveness check.
+ * @property {boolean} success - Indicates if the operation was successful.
+ */
+
+export {};

package/src/types/revocations.js

@@ -0,0 +1,25 @@
+/**
+ * @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.
+ */
+
+/**
+ * @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.
+ */
+
+export {};

package/src/types/signatures.js

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+
+/**
+ * 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.
+ */
+
+/**
+ * @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 {};

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 {};