apacuana-sdk-core 1.0.0 → 1.2.0

package/src/index.js

@@ -0,0 +1,169 @@
+import { setConfig, getConfig, close } from "./config/index";
+import { initHttpClient, setAuthToken } from "./utils/httpClient";
+import { requestRevocation, getRevocationReasons } from "./api/revocations";
+import {
+  generateCert,
+  getCertStatus,
+  getCertTypes,
+  getRequerimentsByTypeUser,
+} from "./api/certs";
+import {
+  addSigner,
+  deleteSignatureVariant,
+  getDigest,
+  getDocs,
+  getSignatureVariant,
+  signDocument,
+  uploadSignatureVariant,
+} from "./api/signatures";
+import {
+  createFaceLivenessSession,
+  validateFaceLiveness,
+} from "./api/faceLiveness";
+import ApacuanaSuccess from "./success/index";
+import { ApacuanaAPIError } from "./errors/index";
+import { createApacuanaUser, getCustomer } from "./api/users";
+
+/**
+ * Valida si el SDK está inicializado y si se dispone de un customerId.
+ * @param {boolean} requiresCustomerId - Indica si la operación necesita un customerId.
+ * @throws {ApacuanaAPIError} Si el SDK no está inicializado o el customerId es requerido y no está presente.
+ */
+const checkSdk = (requiresCustomerId = true) => {
+  const config = getConfig();
+
+  if (!config || !config.apiUrl) {
+    throw new ApacuanaAPIError(
+      "El SDK no está inicializado. Llama a apacuana.init() primero.",
+      400,
+      "NOT_INITIALIZED_ERROR"
+    );
+  }
+
+  if (requiresCustomerId && !config.customerId) {
+    throw new ApacuanaAPIError(
+      "Se requiere un CustomerId para esta operación. Por favor, inicia sesión.",
+      403,
+      "CUSTOMER_ID_REQUIRED"
+    );
+  }
+};
+
+const apacuana = {
+  /**
+   * Inicializa el Apacuana SDK con la configuración necesaria.
+   */
+  init: async (config) => {
+    try {
+      setConfig(config);
+      initHttpClient();
+      const currentConfig = getConfig();
+
+      if (currentConfig.customerId) {
+        const customer = await getCustomer();
+        const { token, userData } = customer.data;
+        setConfig({ ...currentConfig, token, userData });
+        setAuthToken(token);
+        return new ApacuanaSuccess({
+          initialized: true,
+          message: "SDK inicializado con sesión de usuario.",
+        });
+      }
+
+      return new ApacuanaSuccess({
+        initialized: true,
+        message: "SDK inicializado para operaciones públicas (sin customerId).",
+      });
+    } catch (error) {
+      console.error("Error durante la inicialización del SDK:", error);
+      if (error instanceof ApacuanaAPIError) {
+        throw error;
+      }
+      throw new ApacuanaAPIError(
+        error.message || "Error desconocido durante la inicialización.",
+        500,
+        error
+      );
+    }
+  },
+
+  // --- Métodos de Revocación ---
+  requestRevocation: (data) => {
+    checkSdk(true);
+    return requestRevocation(data);
+  },
+  getRevocationReasons: () => {
+    checkSdk(true);
+    return getRevocationReasons();
+  },
+
+  // --- Métodos de Certificados ---
+  generateCert: (data) => {
+    checkSdk(true);
+    return generateCert(data);
+  },
+  getCertStatus: (isCertificateInDevice) => {
+    checkSdk(true);
+    return getCertStatus(isCertificateInDevice);
+  },
+  getCertTypes: () => {
+    checkSdk(false);
+    return getCertTypes();
+  },
+  getRequerimentsByTypeUser: (data) => {
+    checkSdk(false);
+    return getRequerimentsByTypeUser(data);
+  },
+
+  // --- Métodos de Firmas y Documentos ---
+  addSigner: (data) => {
+    checkSdk(true);
+    return addSigner(data);
+  },
+  deleteSignatureVariant: () => {
+    checkSdk(true);
+    return deleteSignatureVariant();
+  },
+  getDigest: (data) => {
+    checkSdk(true);
+    return getDigest(data);
+  },
+  getDocs: (data) => {
+    checkSdk(true);
+    return getDocs(data);
+  },
+  getSignatureVariant: () => {
+    checkSdk(true);
+    return getSignatureVariant();
+  },
+  signDocument: (data) => {
+    checkSdk(true);
+    return signDocument(data);
+  },
+  uploadSignatureVariant: (data) => {
+    checkSdk(true);
+    return uploadSignatureVariant(data);
+  },
+
+  getCustomer: () => {
+    checkSdk(true);
+    return getCustomer();
+  },
+  createFaceLivenessSession: () => {
+    checkSdk(true);
+    return createFaceLivenessSession();
+  },
+  createApacuanaUser: (data) => {
+    checkSdk(false);
+    return createApacuanaUser(data);
+  },
+  validateFaceLiveness: (data) => {
+    checkSdk(true);
+    return validateFaceLiveness(data);
+  },
+
+  close: () => close(),
+  getConfig,
+};
+
+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,67 @@
+/**
+ * @typedef {import('../success').ApacuanaSuccess} ApacuanaSuccess
+ */
+
+// Tipos de datos para las respuestas
+/**
+ * @typedef {object} GenerateCertResponseData
+ * @property {string} cert - El certificado generado en formato string.
+ * @property {string} certifiedid - El ID del certificado generado.
+ */
+/**
+ * @typedef {object} GetCertStatusResponseData
+ * @property {string} status - El estado actual del certificado del usuario.
+ */
+/**
+ * @typedef {object} CertType
+ * @property {string} id - The ID of the certificate type.
+ * @property {string} name - The name of the certificate type.
+ */
+/**
+ * @typedef {object} GetCertTypesResponseData
+ * @property {Array<CertType>} types - A list of available certificate types.
+ */
+/**
+ * @typedef {object} Requirement
+ * @property {string} id - The ID of the requirement.
+ * @property {string} description - The description of the requirement.
+ */
+/**
+ * @typedef {object} GetRequirementsResponseData
+ * @property {Array<Requirement>} requirements - A list of requirements for the user type.
+ */
+/**
+ * @typedef {object} RequestCertificateResponseData
+ * @property {string} message - A message confirming the request.
+ */
+
+// Tipos de respuesta combinados con ApacuanaSuccess
+/**
+ * @typedef {GenerateCertResponseData & ApacuanaSuccess} GenerateCertResponse
+ */
+/**
+ * @typedef {GetCertStatusResponseData & ApacuanaSuccess} GetCertStatusResponse
+ */
+/**
+ * @typedef {GetCertTypesResponseData & ApacuanaSuccess} GetCertTypesResponse
+ */
+/**
+ * @typedef {GetRequirementsResponseData & ApacuanaSuccess} GetRequirementsResponse
+ */
+/**
+ * @typedef {RequestCertificateResponseData & ApacuanaSuccess} RequestCertificateResponse
+ */
+
+// Otros tipos de datos
+/**
+ * @typedef {object} EncryptedCSRObject
+ * @property {string} csr - The encrypted Certificate Signing Request.
+ */
+/**
+ * @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.
+ */
+
+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,96 @@
+/**
+ * @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.
+ * @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 {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.
+ * @property {File} [document] - Documento a firmar en formato de archivo. Este campo es opcional.
+ 
+ */
+
+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/src/utils/constant.js

@@ -0,0 +1,57 @@
+export const STATUS_CERTIFICATE = {
+  request: "SOLICITUD",
+  generate: "GENERAR",
+  current: "VIGENTE",
+  revoque: "REVOCADO",
+  expire: "EXPIRADO",
+  request_revoque: "SOLICITUD_DE_REVOCACION",
+  certificate_another_device: "CERTIFICADO_EN_OTRO_DISPOSITIVO",
+  sign_pending: "PENDIENTE_POR_FIRMAR",
+};
+
+export const PARSE_STATUS = {
+  [STATUS_CERTIFICATE.certificate_another_device]: {
+    text: "Verificado",
+    descriptionText: undefined,
+  },
+  [STATUS_CERTIFICATE.request_cert]: {
+    text: "En revisión",
+    descriptionText:
+      "La información y documentos enviados están siendo certificados por la Autoridad de Certificación para confirmar su validez.",
+  },
+  [STATUS_CERTIFICATE.request]: {
+    text: "Por verificar",
+    descriptionText:
+      "La información y documentos enviados están siendo revisados por la Autoridad de Registro.",
+  },
+  [STATUS_CERTIFICATE.generate]: {
+    text: "Por generar",
+    descriptionText:
+      "Tu solicitud fue aprobada. Solo falta que generes tu certificado para comenzar a usarlo.",
+  },
+  [STATUS_CERTIFICATE.current]: {
+    text: " ",
+    descriptionText: undefined,
+  },
+  [STATUS_CERTIFICATE.expire]: "Certificado expirado.",
+  [STATUS_CERTIFICATE.request_revoque]: {
+    text: "Por revocar",
+    descriptionText:
+      "Recibimos tu solicitud de revocación y estamos procesándola. El certificado dejará de ser válido una vez finalice el trámite.",
+  },
+  [STATUS_CERTIFICATE.revoque]: {
+    text: "Revocado",
+    descriptionText:
+      "Este certificado ha sido revocado. Debes solicitar uno nuevo.",
+  },
+};
+
+export const VERIFICATION_STATUS = {
+  IN_REGISTER: 0,
+  APPROVED: 1,
+};
+
+export const INTEGRATION_TYPE = {
+  ONBOARDING: "ONBOARDING",
+  ONPREMISE: "ONPREMISE",
+};