apacuana-sdk-core 0.10.0 → 0.12.0

package/dist/api/certs.d.ts

@@ -4,73 +4,12 @@ export function getCertTypes(): Promise<GetCertTypesResponse>;
 export function getRequerimentsByTypeUser(params: {
     type: number;
 }): Promise<GetRequirementsResponse>;
-export type GenerateCertResponse = {
-    /**
-     * - El certificado generado en formato string.
-     */
-    cert: string;
-    /**
-     * - El ID del certificado generado.
-     */
-    certifiedid: string;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
-};
-export type GetCertStatusResponse = {
-    /**
-     * - 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 = {
-    /**
-     * - The ID of the certificate type.
-     */
-    id: string;
-    /**
-     * - The name of the certificate type.
-     */
-    name: string;
-};
-export type GetCertTypesResponse = {
-    /**
-     * - A list of available certificate types.
-     */
-    types: Array<CertType>;
-    /**
-     * - Indicates if the operation was successful.
-     */
-    success: boolean;
-};
-export type Requirement = {
-    /**
-     * - The ID of the requirement.
-     */
-    id: string;
-    /**
-     * - The description of the requirement.
-     */
-    description: string;
-};
-export type GetRequirementsResponse = {
-    /**
-     * - A list of requirements for the user type.
-     */
-    requirements: Array<Requirement>;
-    /**
-     * - Indicates if the operation was successful.
-     */
-    success: boolean;
-};
+export function requestCertificate(params: CertificateRequestParams): Promise<RequestCertificateResponse>;
+export type UserData = import("../types/users").UserData;
+export type GenerateCertResponse = import("../types/certs").GenerateCertResponse;
+export type GetCertStatusResponse = import("../types/certs").GetCertStatusResponse;
+export type EncryptedCSRObject = import("../types/certs").EncryptedCSRObject;
+export type GetCertTypesResponse = import("../types/certs").GetCertTypesResponse;
+export type GetRequirementsResponse = import("../types/certs").GetRequirementsResponse;
+export type CertificateRequestParams = import("../types/certs").CertificateRequestParams;
+export type RequestCertificateResponse = import("../types/certs").RequestCertificateResponse;

package/dist/api/faceLiveness.d.ts

@@ -0,0 +1,6 @@
+export function createFaceLivenessSession(): Promise<CreateFaceLivenessSessionResponse>;
+export function validateFaceLiveness({ sessionId }: {
+    sessionId: string;
+}): Promise<ApacuanaSuccess>;
+export type CreateFaceLivenessSessionResponse = import("../types/faceLiveness").CreateFaceLivenessSessionResponse;
+import ApacuanaSuccess from "../success";

package/dist/api/revocations.d.ts

@@ -1,42 +1,6 @@
-export function requestRevocation(reasonCode: number): Promise<RevocationResponse>;
-export function getRevocationReasons(): Promise<RevocationReasonsResponse>;
-export type RequestRevocationResponse = {
-    /**
-     * - El estado de la solicitud de revocación (e.g., "pending").
-     */
-    revocationStatus: string;
-    /**
-     * - El ID de la solicitud de revocación.
-     */
-    requestId: string | number;
-};
-export type RevocationResponse = {
-    /**
-     * - Indicates if the revocation request was successful.
-     */
-    success: boolean;
-    /**
-     * - A message providing details about the outcome.
-     */
-    message?: string | undefined;
-};
-export type RevocationReason = {
-    /**
-     * - The code for the revocation reason.
-     */
-    code: string;
-    /**
-     * - The description of the revocation reason.
-     */
-    description: string;
-};
-export type RevocationReasonsResponse = {
-    /**
-     * - Indicates if the request was successful.
-     */
-    success: boolean;
-    /**
-     * - A list of revocation reasons.
-     */
-    reasons: RevocationReason[];
-};
+export function requestRevocation(params: {
+    reasonCode: number;
+}): Promise<RequestRevocationResponse>;
+export function getRevocationReasons(): Promise<GetRevocationReasonsResponse>;
+export type RequestRevocationResponse = import("../types/revocations").RequestRevocationResponse;
+export type GetRevocationReasonsResponse = import("../types/revocations").GetRevocationReasonsResponse;

package/dist/api/signatures.d.ts

@@ -1,161 +1,19 @@
 export function signDocument(signData: SignDocumentData): Promise<object>;
 export function getDigest(signData: GetDigestData): Promise<GetDigestResponse>;
-export function addSigner(signerData: OnboardingSignerData | object): Promise<object>;
+export function addSigner(signerData: SignerData): Promise<AddSignerResponse>;
 export function getDocs(data: GetDocsParams): Promise<GetDocsResponse>;
 export function uploadSignatureVariant(data: {
     file: File;
 }): Promise<object>;
 export function getSignatureVariant(): Promise<object>;
 export function deleteSignatureVariant(): Promise<object>;
-/**
- * Define la estructura de un objeto Firmante.
- */
-export type Signer = {
-    /**
-     * - Nombre completo del firmante.
-     */
-    name: string;
-    /**
-     * - Correo electrónico del firmante.
-     */
-    email: string;
-    /**
-     * - Documento de identidad del firmante.
-     */
-    document: string;
-};
-/**
- * Define la estructura de datos para añadir un firmante.
- */
-export type SignerData = {
-    /**
-     * - Identificador único del documento.
-     */
-    docId: 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;
-};
-/**
- * Define la estructura de datos para obtener el digest de un documento.
- */
-export type GetDigestData = {
-    /**
-     * - Certificado del firmante en formato base64.
-     */
-    cert: string;
-    /**
-     * - Identificador único del proceso de firma.
-     */
-    signatureId: string;
-};
-/**
- * Define la estructura de la respuesta al obtener el digest.
- */
-export type GetDigestResponse = {
-    /**
-     * - El digest del documento que se va a firmar.
-     */
-    digest: string;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
-};
-/**
- * Define la estructura de los parámetros para obtener documentos.
- */
-export type GetDocsParams = {
-    /**
-     * - Número de página para la paginación.
-     */
-    page: number;
-    /**
-     * - Cantidad de registros por página.
-     */
-    size: number;
-    /**
-     * - (Opcional) Estado para filtrar los documentos.
-     */
-    status?: string | undefined;
-};
-/**
- * Define la estructura de la respuesta al obtener documentos.
- */
-export type GetDocsResponse = {
-    /**
-     * - El número total de registros encontrados.
-     */
-    totalRecords: number;
-    /**
-     * - Un arreglo con los registros de los documentos.
-     */
-    records: Array<object>;
-    /**
-     * - Indica si la operación fue exitosa.
-     */
-    success: boolean;
-};
-export type SignDocumentData = {
-    /**
-     * - Objeto con información de la firma.
-     */
-    signature: {
-        id: string;
-        positions: Array<object>;
-    };
-    /**
-     * - Certificado en base64.
-     */
-    cert: string;
-    /**
-     * - Digest firmado.
-     */
-    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[];
-};
+export type Signer = import("../types/signatures").Signer;
+export type SignerData = import("../types/signatures").SignerData;
+export type AddSignerResponse = import("../types/signatures").AddSignerResponse;
+export type GetDigestData = import("../types/signatures").GetDigestData;
+export type GetDigestResponse = import("../types/signatures").GetDigestResponse;
+export type GetDocsParams = import("../types/signatures").GetDocsParams;
+export type GetDocsResponse = import("../types/signatures").GetDocsResponse;
+export type SignDocumentData = import("../types/signatures").SignDocumentData;
+export type SignaturePosition = import("../types/signatures").SignaturePosition;
+export type OnboardingSignerData = import("../types/signatures").OnboardingSignerData;

package/dist/api/users.d.ts

@@ -1,5 +1,5 @@
 export default getCustomer;
-export type GetCustomerResponse = {
+export type GetCustomerData = {
     /**
      * - El token de sesión del usuario.
      */
@@ -8,23 +8,33 @@ export type GetCustomerResponse = {
      * - Los datos del usuario obtenidos.
      */
     userData: object;
+};
+export type GetCustomerResponse = {
+    /**
+     * - Indica que la operación fue exitosa.
+     */
+    success: true;
     /**
-     * - Indica si la operación fue exitosa.
+     * - El payload de la respuesta.
      */
-    success: boolean;
+    data: GetCustomerData;
 };
 /**
- * @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.
  */
 /**
  * Obtiene el token de un usuario a través de una petición POST.
  * 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/dist/index.d.ts

@@ -24,6 +24,9 @@ declare namespace apacuana {
     export { deleteSignatureVariant };
     export { getCertTypes };
     export { getRequerimentsByTypeUser };
+    export { createFaceLivenessSession };
+    export { validateFaceLiveness };
+    export { requestCertificate };
 }
 import { getConfig } from "./config/index";
 import { requestRevocation } from "./api/revocations";
@@ -40,3 +43,6 @@ import { getSignatureVariant } from "./api/signatures";
 import { deleteSignatureVariant } from "./api/signatures";
 import { getCertTypes } from "./api/certs";
 import { getRequerimentsByTypeUser } from "./api/certs";
+import { createFaceLivenessSession } from "./api/faceLiveness";
+import { validateFaceLiveness } from "./api/faceLiveness";
+import { requestCertificate } from "./api/certs";