apacuana-sdk-core 0.11.0 → 0.12.0

package/dist/types/faceLiveness.d.ts

@@ -1,10 +1,11 @@
-export type CreateFaceLivenessSessionResponse = {
+export type ApacuanaSuccess = import("../success").ApacuanaSuccess;
+export type CreateFaceLivenessSessionData = {
     /**
      * - The session ID for the face liveness check.
      */
     sessionId: string;
-    /**
-     * - Indicates if the operation was successful.
-     */
-    success: boolean;
+};
+export type CreateFaceLivenessSessionResponse = {
+    success: true;
+    data: CreateFaceLivenessSessionData;
 };

package/dist/types/revocations.d.ts

@@ -1,32 +1,43 @@
-export type RequestRevocationResponse = {
+export type ApacuanaSuccess = import("../success").ApacuanaSuccess;
+export type RevocationReason = {
     /**
-     * - El estado de la solicitud de revocación (e.g., "pending").
+     * - The code for the revocation reason.
      */
-    revocationStatus: string;
+    code: string;
     /**
-     * - El ID de la solicitud de revocación.
+     * - The description of the revocation reason.
      */
-    requestId: string | number;
+    description: string;
 };
-export type RevocationResponse = {
+export type RequestRevocationData = {
     /**
-     * - Indicates if the revocation request was successful.
+     * - A message providing details about the outcome.
      */
-    success: boolean;
+    message: string;
+};
+export type RequestRevocationResponse = {
+    success: true;
+    data: RequestRevocationData;
+};
+export type GetRevocationReasonsData = {
     /**
-     * - A message providing details about the outcome.
+     * - A list of revocation reasons.
      */
-    message?: string | undefined;
+    reasons: RevocationReason[];
 };
-export type RevocationReason = {
+export type GetRevocationReasonsResponse = {
+    success: true;
+    data: GetRevocationReasonsData;
+};
+export type RevocationResponse = {
     /**
-     * - The code for the revocation reason.
+     * - Indicates if the revocation request was successful.
      */
-    code: string;
+    success: boolean;
     /**
-     * - The description of the revocation reason.
+     * - A message providing details about the outcome.
      */
-    description: string;
+    message?: string | undefined;
 };
 export type RevocationReasonsResponse = {
     /**

package/dist/types/signatures.d.ts

@@ -1,3 +1,4 @@
+export type ApacuanaSuccess = import("../success").ApacuanaSuccess;
 /**
  * Define la estructura de un objeto Firmante.
  */
@@ -15,27 +16,18 @@ export type Signer = {
      */
     document: string;
 };
-/**
- * Define la estructura de datos para añadir un firmante.
- */
-export type SignerData = {
+export type AddSignerData = {
     /**
-     * - Identificador único del documento.
+     * - Identificador de confirmación del firmante añadido.
      */
-    docId: string;
+    signer: string;
 };
 /**
  * Define la estructura de la respuesta al añadir un firmante.
  */
 export type AddSignerResponse = {
-    /**
-     * - Identificador de confirmación del firmante añadido.
-     */
-    signer: string;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
+    success: true;
+    data: AddSignerData;
 };
 /**
  * Define la estructura de datos para obtener el digest de un documento.
@@ -46,22 +38,61 @@ export type GetDigestData = {
      */
     cert: string;
     /**
-     * - Identificador único del proceso de firma.
+     * - Identificador único de la firma.
      */
     signatureId: string;
 };
+export type SignaturePlacement = {
+    /**
+     * - Página donde se estampará la firma.
+     */
+    page: number;
+    /**
+     * - Coordenada X de la firma.
+     */
+    x: number;
+    /**
+     * - Coordenada Y de la firma.
+     */
+    y: number;
+};
 /**
- * Define la estructura de la respuesta al obtener el digest.
+ * Define la estructura de datos para añadir un firmante.
  */
-export type GetDigestResponse = {
+export type SignerData = {
     /**
-     * - El digest del documento que se va a firmar.
+     * - Nombre del firmante.
      */
-    digest: string;
+    name: string;
+    /**
+     * - Referencia o identificador del firmante.
+     */
+    reference: string;
     /**
-     * - Indica si la operación fue exitosa.
+     * - Tipo de documento de identidad del firmante.
+     */
+    typedoc: string;
+    /**
+     * - Número de documento de identidad del firmante.
+     */
+    doc: string;
+    /**
+     * - Array con las coordenadas donde se estampará la firma.
+     */
+    signature: Array<SignaturePlacement>;
+};
+export type GetDigestResponseData = {
+    /**
+     * - El digest del documento que se va a firmar.
      */
-    success: boolean;
+    digest: string;
+};
+/**
+ * Define la estructura de la respuesta al obtener el digest.
+ */
+export type GetDigestResponse = {
+    success: true;
+    data: GetDigestResponseData;
 };
 /**
  * Define la estructura de los parámetros para obtener documentos.
@@ -80,10 +111,7 @@ export type GetDocsParams = {
      */
     status?: string | undefined;
 };
-/**
- * Define la estructura de la respuesta al obtener documentos.
- */
-export type GetDocsResponse = {
+export type GetDocsResponseData = {
     /**
      * - El número total de registros encontrados.
      */
@@ -92,10 +120,13 @@ export type GetDocsResponse = {
      * - Un arreglo con los registros de los documentos.
      */
     records: Array<object>;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
+};
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ */
+export type GetDocsResponse = {
+    success: true;
+    data: GetDocsResponseData;
 };
 export type SignDocumentData = {
     /**
@@ -114,39 +145,3 @@ export type SignDocumentData = {
      */
     signedDigest: string;
 };
-export type SignaturePosition = {
-    /**
-     * - The page number for the signature.
-     */
-    page: number;
-    /**
-     * - The x-coordinate for the signature's position (from 0 to 1).
-     */
-    x: number;
-    /**
-     * - The y-coordinate for the signature's position (from 0 to 1).
-     */
-    y: number;
-};
-export type OnboardingSignerData = {
-    /**
-     * - The name of the document.
-     */
-    name: string;
-    /**
-     * - An external reference for the document.
-     */
-    reference: string;
-    /**
-     * - The type of document of the signer (e.g., "V", "E", "J").
-     */
-    typedoc: string;
-    /**
-     * - The document number of the signer.
-     */
-    doc: string;
-    /**
-     * - An array of signature positions.
-     */
-    signature: SignaturePosition[];
-};

package/package.json

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

package/src/api/faceLiveness.js

@@ -8,6 +8,12 @@ import { ApacuanaAPIError } from "../errors";
 import ApacuanaSuccess from "../success";
 import { INTEGRATION_TYPE } from "../utils/constant";
 
+/**
+ * Creates a new Face Liveness session.
+ * @returns {Promise<CreateFaceLivenessSessionResponse>} Object with the session ID and a success indicator.
+ * @throws {ApacuanaAPIError} If the API response is invalid or the integration type is not supported.
+ * @throws {Error} If the request fails for another reason.
+ */
 const createFaceLivenessSessionOnBoarding = async () => {
   try {
     const response = await httpRequest(
@@ -15,8 +21,7 @@ const createFaceLivenessSessionOnBoarding = async () => {
       {},
       "POST"
     );
-
-    if (!response.sessionId) {
+    if (!response.sessionid) {
       throw new ApacuanaAPIError(
         "The API response does not contain the session ID.",
         response.status,
@@ -24,12 +29,16 @@ const createFaceLivenessSessionOnBoarding = async () => {
       );
     }
 
-    return new ApacuanaSuccess({ sessionId: response.sessionId });
+    return new ApacuanaSuccess({
+      sessionId: response.sessionid,
+    });
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
     }
-    throw new Error(`Failed to create Face Liveness session: ${error.message}`);
+    throw new ApacuanaAPIError(
+      `Failed to create Face Liveness session: ${error.message}`
+    );
   }
 };
 

package/src/api/revocations.js

@@ -4,10 +4,13 @@ import { INTEGRATION_TYPE } from "../utils/constant";
 import { ApacuanaAPIError } from "../errors";
 import ApacuanaSuccess from "../success";
 
+/** @typedef {import("../types/revocations").RequestRevocationResponse} RequestRevocationResponse */
+/** @typedef {import("../types/revocations").GetRevocationReasonsResponse} GetRevocationReasonsResponse */
+
 const requestRevocationOnBoarding = async (params) => {
   try {
     const response = await httpRequest(
-      "services/api/certificate/revocation",
+      "services/api/onboardingclient/requestcert",
       params,
       "POST"
     );
@@ -28,6 +31,13 @@ const requestRevocationOnPremise = async () => {
   );
 };
 
+/**
+ * Solicita la revocación de un certificado.
+ * @param {object} params - Parámetros para la solicitud.
+ * @param {number} params.reasonCode - El código de la razón de la revocación.
+ * @returns {Promise<RequestRevocationResponse>} Una promesa que resuelve con la confirmación de la solicitud.
+ * @throws {Error} Si los parámetros son inválidos.
+ */
 export const requestRevocation = async (params) => {
   if (!params || typeof params.reasonCode !== "number") {
     throw new Error(
@@ -53,14 +63,14 @@ export const requestRevocation = async (params) => {
 const getRevocationReasonsOnBoarding = async () => {
   try {
     const response = await httpRequest(
-      "services/api/certificate/revocation-reasons",
+      "config/api/revocation/reasonsonboarding",
       {},
       "GET"
     );
     if (!response || !response.records) {
       throw new ApacuanaAPIError("Failed to fetch revocation reasons.");
     }
-    return new ApacuanaSuccess(response.records);
+    return new ApacuanaSuccess({ reasons: response.records });
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
@@ -77,6 +87,11 @@ const getRevocationReasonsOnPremise = async () => {
   );
 };
 
+/**
+ * Obtiene la lista de razones de revocación de certificados.
+ * @returns {Promise<GetRevocationReasonsResponse>} Una promesa que resuelve con la lista de razones de revocación.
+ * @throws {ApacuanaAPIError} Si la llamada a la API falla o el tipo de integración no es soportado.
+ */
 export const getRevocationReasons = async () => {
   const { integrationType } = getConfig();
 

package/src/api/users.js

@@ -4,10 +4,15 @@ 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.
  */
 
 /**
@@ -15,7 +20,7 @@ import ApacuanaSuccess from "../success";
  * 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.
  */

package/src/index.js

@@ -22,6 +22,8 @@ import {
   createFaceLivenessSession,
   validateFaceLiveness,
 } from "./api/faceLiveness";
+import ApacuanaSuccess from "./success/index";
+import { ApacuanaAPIError } from "./errors/index";
 
 const apacuana = {
   /**
@@ -42,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,

package/src/types/faceLiveness.js

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

package/src/types/revocations.js

@@ -1,19 +1,39 @@
+/**
+ * @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 {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.
+ * @property {true} success
+ * @property {RequestRevocationData} 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} GetRevocationReasonsData
+ * @property {RevocationReason[]} reasons - A list of revocation reasons.
  */
 
 /**
- * @typedef {object} RevocationReason
- * @property {string} code - The code for the revocation reason.
- * @property {string} description - The description of the revocation reason.
+ * @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.
  */
 
 /**
@@ -22,4 +42,4 @@
  * @property {RevocationReason[]} reasons - A list of revocation reasons.
  */
 
-export {};
+export {};

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,51 @@
  */
 
 /**
- * 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.
+ */
+
+/**
+ * @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 {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 +67,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
  */
 
 /**
@@ -58,20 +88,4 @@
  * @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 {};
+export {};