apacuana-sdk-core 0.12.0 → 0.14.0

package/dist/types/certs.d.ts

@@ -1,4 +1,5 @@
-export type GenerateCertResponse = {
+export type ApacuanaSuccess = import("../success").ApacuanaSuccess;
+export type GenerateCertResponseData = {
     /**
      * - El certificado generado en formato string.
      */
@@ -7,26 +8,12 @@ export type GenerateCertResponse = {
      * - El ID del certificado generado.
      */
     certifiedid: string;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
 };
-export type GetCertStatusResponse = {
+export type GetCertStatusResponseData = {
     /**
      * - El estado actual del certificado del usuario.
      */
     status: string;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
-};
-export type EncryptedCSRObject = {
-    /**
-     * - The encrypted Certificate Signing Request.
-     */
-    csr: string;
 };
 export type CertType = {
     /**
@@ -38,15 +25,11 @@ export type CertType = {
      */
     name: string;
 };
-export type GetCertTypesResponse = {
+export type GetCertTypesResponseData = {
     /**
      * - A list of available certificate types.
      */
     types: Array<CertType>;
-    /**
-     * - Indicates if the operation was successful.
-     */
-    success: boolean;
 };
 export type Requirement = {
     /**
@@ -58,15 +41,28 @@ export type Requirement = {
      */
     description: string;
 };
-export type GetRequirementsResponse = {
+export type GetRequirementsResponseData = {
     /**
      * - A list of requirements for the user type.
      */
     requirements: Array<Requirement>;
+};
+export type RequestCertificateResponseData = {
+    /**
+     * - A message confirming the request.
+     */
+    message: string;
+};
+export type GenerateCertResponse = GenerateCertResponseData & ApacuanaSuccess;
+export type GetCertStatusResponse = GetCertStatusResponseData & ApacuanaSuccess;
+export type GetCertTypesResponse = GetCertTypesResponseData & ApacuanaSuccess;
+export type GetRequirementsResponse = GetRequirementsResponseData & ApacuanaSuccess;
+export type RequestCertificateResponse = RequestCertificateResponseData & ApacuanaSuccess;
+export type EncryptedCSRObject = {
     /**
-     * - Indicates if the operation was successful.
+     * - The encrypted Certificate Signing Request.
      */
-    success: boolean;
+    csr: string;
 };
 export type CertificateRequestParams = {
     /**
@@ -85,13 +81,3 @@ export type CertificateRequestParams = {
         file: string;
     }>;
 };
-export type RequestCertificateResponse = {
-    /**
-     * - A message confirming the request.
-     */
-    message: string;
-    /**
-     * - Indicates if the operation was successful.
-     */
-    success: boolean;
-};

package/dist/types/signatures.d.ts

@@ -41,6 +41,10 @@ export type GetDigestData = {
      * - Identificador único de la firma.
      */
     signatureId: string;
+    /**
+     * - Documento a firmar en formato de archivo. Este campo es opcional.
+     */
+    document?: File | undefined;
 };
 export type SignaturePlacement = {
     /**
@@ -64,10 +68,6 @@ export type SignerData = {
      * - Nombre del firmante.
      */
     name: string;
-    /**
-     * - Referencia o identificador del firmante.
-     */
-    reference: string;
     /**
      * - Tipo de documento de identidad del firmante.
      */
@@ -80,7 +80,18 @@ export type SignerData = {
      * - Array con las coordenadas donde se estampará la firma.
      */
     signature: Array<SignaturePlacement>;
+    /**
+     * - Referencia a un documento pre-cargado. Se debe proporcionar 'reference' o 'file', pero no ambos.
+     */
+    reference?: string | undefined;
+    /**
+     * - Archivo del documento a firmar. Se debe proporcionar 'reference' o 'file', pero no ambos.
+     */
+    file?: File | undefined;
 };
+/**
+ * Define la estructura de datos para la respuesta de la creación de una firma.
+ */
 export type GetDigestResponseData = {
     /**
      * - El digest del documento que se va a firmar.
@@ -144,4 +155,8 @@ export type SignDocumentData = {
      * - Digest firmado.
      */
     signedDigest: string;
+    /**
+     * - Documento a firmar en formato de archivo. Este campo es opcional.
+     */
+    document?: File | undefined;
 };

package/dist/utils/constant.d.ts

@@ -8,6 +8,37 @@ export namespace STATUS_CERTIFICATE {
     let certificate_another_device: string;
     let sign_pending: string;
 }
+export const PARSE_STATUS: {
+    [STATUS_CERTIFICATE.certificate_another_device]: {
+        text: string;
+        descriptionText: undefined;
+    };
+    [STATUS_CERTIFICATE.request]: {
+        text: string;
+        descriptionText: string;
+    };
+    [STATUS_CERTIFICATE.generate]: {
+        text: string;
+        descriptionText: string;
+    };
+    [STATUS_CERTIFICATE.current]: {
+        text: string;
+        descriptionText: undefined;
+    };
+    [STATUS_CERTIFICATE.expire]: string;
+    [STATUS_CERTIFICATE.request_revoque]: {
+        text: string;
+        descriptionText: string;
+    };
+    [STATUS_CERTIFICATE.revoque]: {
+        text: string;
+        descriptionText: string;
+    };
+    [STATUS_CERTIFICATE.request_cert]: {
+        text: string;
+        descriptionText: string;
+    };
+};
 export namespace VERIFICATION_STATUS {
     let IN_REGISTER: number;
     let APPROVED: number;

package/dist/utils/helpers.d.ts

@@ -8,16 +8,18 @@ declare namespace _default {
     export { validateGetDocsData };
     export { validateGetDigestData };
     export { validateOnBoardingSignDocumentData };
+    export { createPayloadGetDigest };
 }
 export default _default;
-declare function getCertificateStatus(userData: any, certificateInDevice: any): string;
+declare function getCertificateStatus(userData: any, certificateInDevice: any): any;
 declare function exportPrivateKey(key: any): Promise<string>;
 declare function arrayBufferToBase64(buffer: any): string;
 declare function encryptedCsr(csr: any, encryptKey?: string): {
     csr: any;
 };
-declare function validateOnBoardingSignerData(signerData: any): void;
+declare function validateOnBoardingSignerData(signerData: any): FormData;
 declare function validateCsr(encryptedCSR: any): void;
 declare function validateGetDocsData(data: any): void;
 declare function validateGetDigestData(signData: any): void;
-declare function validateOnBoardingSignDocumentData(signData: any): void;
+declare function validateOnBoardingSignDocumentData(signData: any): FormData;
+declare function createPayloadGetDigest(signData: any): FormData;

package/package.json

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

package/src/api/certs.js

@@ -14,7 +14,7 @@ import { httpRequest } from "../utils/httpClient";
 import helpers from "../utils/helpers";
 import { ApacuanaAPIError } from "../errors";
 import ApacuanaSuccess from "../success";
-import { INTEGRATION_TYPE } from "../utils/constant";
+import { INTEGRATION_TYPE, PARSE_STATUS } from "../utils/constant";
 
 /**
  * @param {EncryptedCSRObject} encryptedCSR
@@ -88,7 +88,9 @@ export const getCertStatus = (isCertificateInDevice = false) => {
     config.userData,
     isCertificateInDevice
   );
-  return new ApacuanaSuccess({ status });
+  const parseStatus = PARSE_STATUS[status];
+
+  return new ApacuanaSuccess({ status: parseStatus });
 };
 
 const getCertTypesOnBoarding = async () => {

package/src/api/revocations.js

@@ -11,7 +11,7 @@ const requestRevocationOnBoarding = async (params) => {
   try {
     const response = await httpRequest(
       "services/api/onboardingclient/requestcert",
-      params,
+      { reason: params.reasonCode },
       "POST"
     );
     return new ApacuanaSuccess(response);

package/src/api/signatures.js

@@ -22,25 +22,13 @@ import { INTEGRATION_TYPE } from "../utils/constant";
 // =================================================================
 
 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 payload = helpers.validateOnBoardingSignDocumentData(signData);
 
+  const { signature } = signData;
+  try {
     const response = await httpRequest(
       `services/api/documents/sign/${signature.id}`,
-      signBody,
+      payload,
       "PUT"
     );
     return new ApacuanaSuccess(response);
@@ -64,11 +52,10 @@ const signDocumentOnPremise = async () => {
 
 const getDigestToSignOnBoarding = async (signData) => {
   try {
+    const formData = helpers.createPayloadGetDigest(signData);
     const response = await httpRequest(
       `services/api/documents/getdigest/${signData.signatureId}`,
-      {
-        publickey: signData.cert,
-      },
+      formData,
       "POST"
     );
     const digest = response.data?.digest || response.digest;
@@ -100,9 +87,9 @@ const getDigestToSignOnPremise = async () => {
 };
 
 const addSignerOnBoarding = async (signerData) => {
-  helpers.validateOnBoardingSignerData(signerData);
+  const payload = helpers.validateOnBoardingSignerData(signerData);
   try {
-    await httpRequest("services/api/documents/signing", signerData, "POST");
+    await httpRequest("services/api/documents/signingsdk", payload, "POST");
     return new ApacuanaSuccess({
       signer: signerData.typedoc + signerData.doc,
     });

package/src/api/users.js

@@ -24,7 +24,7 @@ import ApacuanaSuccess from "../success";
  * @throws {Error} Si los parámetros de entrada son inválidos.
  * @throws {ApacuanaAPIError} Si ocurre un error en la API de Apacuana.
  */
-const getCustomer = async () => {
+export const getCustomer = async () => {
   const { verificationId, customerId } = getConfig();
 
   if (!verificationId || !customerId) {
@@ -69,4 +69,53 @@ const getCustomer = async () => {
   }
 };
 
-export default getCustomer;
+/**
+ * @typedef {object} CreateUserPayload
+ * @property {string} usr - Correo electrónico del usuario.
+ * @property {string} pwd - Contraseña del usuario.
+ * @property {string} kinddoc - Tipo de documento de identidad (ej. 'V', 'P', 'E').
+ * @property {string} doc - Número de documento de identidad.
+ */
+
+/**
+ * @typedef {object} CreateUserResponse
+ * @property {string} message - Mensaje de confirmación de la creación del usuario.
+ */
+
+/**
+ * Crea un nuevo usuario en la plataforma de Apacuana.
+ * @param {CreateUserPayload} userData - Objeto con los datos del usuario a crear.
+ * @returns {Promise<ApacuanaSuccess>} Una promesa que resuelve a un objeto con la respuesta exitosa.
+ * @throws {ApacuanaAPIError} Si los datos de entrada son inválidos o si ocurre un error en la API.
+ */
+
+export const createApacuanaUser = async (userData) => {
+  try {
+    const formData = new FormData();
+    Object.keys(userData).forEach((key) => {
+      const value = userData[key];
+      if (value instanceof File) {
+        formData.append(key, value);
+      } else if (value !== null && value !== undefined) {
+        formData.append(key, String(value));
+      }
+    });
+
+    const response = await httpRequest(
+      "services/api/register/initial",
+      formData,
+      "POST"
+    );
+
+    return new ApacuanaSuccess({
+      ...response,
+    });
+  } catch (error) {
+    if (error instanceof ApacuanaAPIError) {
+      throw error;
+    }
+    throw new ApacuanaAPIError(
+      `Unexpected failure creating user: ${error.message || "Unknown error"}`
+    );
+  }
+};

package/src/index.js

@@ -1,13 +1,11 @@
 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,
   getCertTypes,
   getRequerimentsByTypeUser,
-  requestCertificate,
 } from "./api/certs";
 import {
   addSigner,
@@ -24,44 +22,59 @@ import {
 } 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 y obtiene
-   * los detalles del usuario.
-   * @param {object} config - Objeto de configuración.
-   * @param {string} config.apiUrl - La URL base de la API de Apacuana.
-   * @param {string} config.secretKey - La clave secreta para la autenticación.
-   * @param {string} config.apiKey - La clave de API para la autenticación.
-   * @param {string} config.verificationId - El ID de verificación del usuario.
-   * @param {string} config.customerId - El ID del cliente.
-   * @param {string} config.integrationType - El tipo de integración ('onpremise' o 'onboarding').
-   * @returns {Promise<object>} retorna los detalles del usuario si la inicialización es exitosa.
+   * Inicializa el Apacuana SDK con la configuración necesaria.
    */
   init: async (config) => {
     try {
       setConfig(config);
       initHttpClient();
       const currentConfig = getConfig();
-      if (!currentConfig.customerId) {
-        throw new ApacuanaAPIError(
-          "Apacuana SDK: La configuración de CustomerId no se ha guardado" +
-            " correctamente.",
-          400,
-          { code: "CONFIG_ERROR" }
-        );
+
+      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.",
+        });
       }
 
-      const customer = await getCustomer();
-      const { token, userData } = customer.data;
-      setConfig({ ...currentConfig, token, userData });
-      setAuthToken(token);
       return new ApacuanaSuccess({
         initialized: true,
-        message: "SDK inicializado correctamente.",
+        message: "SDK inicializado para operaciones públicas (sin customerId).",
       });
     } catch (error) {
-      // eslint-disable-next-line no-console
       console.error("Error durante la inicialización del SDK:", error);
       if (error instanceof ApacuanaAPIError) {
         throw error;
@@ -74,28 +87,83 @@ const apacuana = {
     }
   },
 
-  /**
-   * Permite obtener la configuración actual del SDK.
-   */
+  // --- 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,
-  requestRevocation,
-  getCertStatus,
-  getCustomer,
-  addSigner,
-  getDocs,
-  generateCert,
-  signDocument,
-  getDigest,
-  getRevocationReasons,
-  uploadSignatureVariant,
-  getSignatureVariant,
-  deleteSignatureVariant,
-  getCertTypes,
-  getRequerimentsByTypeUser,
-  createFaceLivenessSession,
-  validateFaceLiveness,
-  requestCertificate,
 };
 
 export default apacuana;

package/src/types/certs.js

@@ -1,45 +1,62 @@
 /**
- * @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 {import('../success').ApacuanaSuccess} ApacuanaSuccess
  */
 
+// Tipos de datos para las respuestas
 /**
- * @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} GenerateCertResponseData
+ * @property {string} cert - El certificado generado en formato string.
+ * @property {string} certifiedid - El ID del certificado generado.
  */
-
 /**
- * @typedef {object} EncryptedCSRObject
- * @property {string} csr - The encrypted Certificate Signing Request.
+ * @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} GetCertTypesResponse
+ * @typedef {object} GetCertTypesResponseData
  * @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
+ * @typedef {object} GetRequirementsResponseData
  * @property {Array<Requirement>} requirements - A list of requirements for the user type.
- * @property {boolean} success - Indicates if the operation was successful.
+ */
+/**
+ * @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.
@@ -47,10 +64,4 @@
  * @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 {};
+export {};

package/src/types/signatures.js

@@ -27,6 +27,7 @@
  * @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.
  */
 
 /**
@@ -40,13 +41,15 @@
  * 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.
+ * @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.
  */
@@ -86,6 +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.
+ 
  */
 
 export {};