@dynamicore/jumio-sdk 1.0.0 → 1.0.2

package/dist/client-BR1xIZ0X.d.mts

@@ -1,252 +0,0 @@
-import { AxiosInstance } from 'axios';
-
-/**
- * Estados posibles del flujo de verificación en Jumio.
- */
-type JumioWorkflowStatus = "PENDING" | "INITIATED" | "ACQUIRED" | "SUBMITTED" | "PROCESSED" | "APPROVED_VERIFIED" | "REJECTED" | "FAILED" | "ERROR" | "DENIED" | "EXPIRED" | "ABANDONED" | (string & {});
-/**
- * Tipos de entrada soportados para las imágenes del documento.
- */
-type ImageSource = string | Blob | File | ArrayBuffer | Uint8Array | {
-    url?: unknown;
-} | {
-    [key: string]: unknown;
-};
-/**
- * Función personalizada para firmar URLs de S3 o descargar recursos privados.
- */
-type S3SignerFunction = (pathOrUrl: string, expires?: number) => Promise<string | {
-    url?: unknown;
-} | unknown>;
-/**
- * Función o valor para proveer el token de autenticación.
- */
-type AuthTokenProvider = string | (() => string | undefined | null | Promise<string | undefined | null>);
-/**
- * Opciones de configuración para instanciar el cliente JumioClient.
- */
-interface JumioClientConfig {
-    /**
-     * URL base de la API de DynamiCore / Backend.
-     * @default "https://front.dynamicore.io"
-     */
-    baseUrl?: string;
-    /**
-     * Endpoint específico del servicio de verificación Jumio.
-     * @default "/marketplace/apps/jumio"
-     */
-    endpoint?: string;
-    /**
-     * Header de contexto moral / negocio enviado en las peticiones.
-     */
-    context?: string;
-    /**
-     * Token de autenticación o función que lo obtiene.
-     */
-    authToken?: AuthTokenProvider;
-    /**
-     * Prefijo para el header Authorization (por defecto vacío o "Bearer ").
-     * @default ""
-     */
-    authTokenPrefix?: string;
-    /**
-     * Timeout en milisegundos para las peticiones POST de verificación.
-     * @default 180000 (3 minutos)
-     */
-    requestTimeout?: number;
-    /**
-     * Timeout en milisegundos para las peticiones GET de status.
-     * @default 120000 (2 minutos)
-     */
-    statusTimeout?: number;
-    /**
-     * Número máximo de reintentos ante timeouts o fallas transitorias de red.
-     * @default 3
-     */
-    maxRetries?: number;
-    /**
-     * Delay base en milisegundos para el backoff exponencial de reintentos.
-     * @default 800
-     */
-    retryDelayMs?: number;
-    /**
-     * Intervalo en milisegundos entre consultas sucesivas de sondeo (polling).
-     * @default 10000 (10 segundos)
-     */
-    pollingIntervalMs?: number;
-    /**
-     * Número máximo de intentos de sondeo antes de timeout.
-     * @default 20 (20 x 10s = aprox 200 segundos)
-     */
-    maxPollingAttempts?: number;
-    /**
-     * Función opcional para firmar rutas u URLs de Amazon S3.
-     */
-    s3Signer?: S3SignerFunction;
-    /**
-     * Headers HTTP adicionales para incluir en cada petición.
-     */
-    customHeaders?: Record<string, string>;
-    /**
-     * Instancia personalizada de Axios (opcional).
-     */
-    axiosInstance?: AxiosInstance;
-}
-/**
- * Payload enviado a la API de verificación de Jumio.
- */
-interface JumioVerificationPayload {
-    client: string;
-    front_image_b64: string;
-    back_image_b64: string;
-    [key: string]: unknown;
-}
-/**
- * Estructura de respuesta de datos de verificación.
- */
-interface JumioVerificationData {
-    valid?: boolean;
-    status?: JumioWorkflowStatus;
-    workflowStatus?: JumioWorkflowStatus;
-    decision?: string;
-    accountId?: string;
-    workflowId?: string;
-    message?: string;
-    [key: string]: unknown;
-}
-/**
- * Estructura inicial devuelta al iniciar el flujo de verificación.
- */
-interface JumioIneStartData extends JumioVerificationData {
-    accountId?: string;
-    workflowId?: string;
-}
-/**
- * Resultado estructurado retornado por el cliente tras una validación.
- */
-interface VerifyIneResult {
-    /**
-     * Indica si la validación fue exitosa (true) o fallida/rechazada (false).
-     */
-    valid: boolean;
-    /**
-     * Estado actual o final del flujo de Jumio.
-     */
-    status?: JumioWorkflowStatus;
-    /**
-     * Identificador de cuenta en Jumio.
-     */
-    accountId?: string;
-    /**
-     * Identificador del workflow en Jumio.
-     */
-    workflowId?: string;
-    /**
-     * Datos completos devueltos por la API de Jumio/DynamiCore.
-     */
-    data: unknown;
-    /**
-     * Mensaje descriptivo o de error si la validación falló.
-     */
-    errorMessage?: string;
-}
-/**
- * Callback ejecutado cuando el sondeo resuelve un estado final.
- */
-type JumioStatusResolvedCallback = (result: VerifyIneResult) => void;
-/**
- * Callback ejecutado si ocurre un error durante el sondeo o la petición.
- */
-type JumioStatusErrorCallback = (error: Error) => void;
-/**
- * Callback de progreso para reportar avances de conversión o polling.
- */
-type JumioProgressCallback = (stage: string, percent?: number) => void;
-/**
- * Parámetros de entrada para la función `verifyIne`.
- */
-interface VerifyIneInput {
-    /**
-     * Identificador único del cliente (persona, usuario o ID externo).
-     */
-    clientId: string;
-    /**
-     * Imagen frontal del documento (INE): URL, ruta S3, File, Blob o Base64.
-     */
-    frontImage: ImageSource;
-    /**
-     * Imagen trasera/reverso del documento (INE): URL, ruta S3, File, Blob o Base64.
-     */
-    backImage: ImageSource;
-    /**
-     * Si es `true`, la promesa espera hasta que Jumio resuelva el resultado final (bloqueante).
-     * Si es `false` (por defecto), inicia la validación, retorna de inmediato y ejecuta el sondeo en 2do plano.
-     * @default false
-     */
-    awaitFinalStatus?: boolean;
-    /**
-     * Callback invocado cuando se completa el proceso de validación (síncrono o en segundo plano).
-     */
-    onStatusResolved?: JumioStatusResolvedCallback;
-    /**
-     * Callback invocado ante errores no recuperables durante la validación o sondeo.
-     */
-    onStatusError?: JumioStatusErrorCallback;
-    /**
-     * Callback opcional para reportar etapas del proceso.
-     */
-    onProgress?: JumioProgressCallback;
-    /**
-     * Señal de cancelación (AbortSignal) para abortar peticiones o sondeo activo.
-     */
-    signal?: AbortSignal;
-}
-/**
- * Opciones para el método de polling de estado.
- */
-interface PollStatusOptions {
-    pollingIntervalMs?: number;
-    maxAttempts?: number;
-    signal?: AbortSignal;
-    onAttempt?: (attempt: number, maxAttempts: number, lastData: unknown) => void;
-}
-
-/**
- * Cliente principal para gestionar validaciones de identidad mediante Jumio.
- */
-declare class JumioClient {
-    private readonly http;
-    private readonly config;
-    constructor(config?: JumioClientConfig);
-    /**
-     * Inicia el proceso de verificación convirtiendo las imágenes y enviando el payload inicial a Jumio.
-     */
-    startIneVerification(params: {
-        clientId: string;
-        frontImage: ImageSource;
-        backImage: ImageSource;
-        signal?: AbortSignal;
-        onProgress?: JumioProgressCallback;
-    }): Promise<JumioIneStartData>;
-    /**
-     * Consulta una única vez el estado actual de la validación.
-     */
-    getIneStatus(accountId: string, workflowId: string, signal?: AbortSignal): Promise<JumioVerificationData>;
-    /**
-     * Sondea periódicamente el estado hasta obtener un resultado definitivo.
-     */
-    pollIneStatus(accountId: string, workflowId: string, options?: PollStatusOptions): Promise<VerifyIneResult>;
-    /**
-     * Ejecuta el flujo completo de validación de INE.
-     *
-     * @param input Parámetros de validación y callbacks.
-     * @returns `VerifyIneResult` con el resultado inicial o definitivo según `awaitFinalStatus`.
-     */
-    verifyIne(input: VerifyIneInput): Promise<VerifyIneResult>;
-}
-/**
- * Fábrica para crear una nueva instancia de `JumioClient`.
- */
-declare function createJumioClient(config?: JumioClientConfig): JumioClient;
-
-export { type AuthTokenProvider as A, type ImageSource as I, JumioClient as J, type PollStatusOptions as P, type S3SignerFunction as S, type VerifyIneInput as V, type JumioClientConfig as a, type JumioIneStartData as b, type JumioProgressCallback as c, type JumioStatusErrorCallback as d, type JumioStatusResolvedCallback as e, type JumioVerificationData as f, type JumioVerificationPayload as g, type JumioWorkflowStatus as h, type VerifyIneResult as i, createJumioClient as j };

package/dist/client-BR1xIZ0X.d.ts

@@ -1,252 +0,0 @@
-import { AxiosInstance } from 'axios';
-
-/**
- * Estados posibles del flujo de verificación en Jumio.
- */
-type JumioWorkflowStatus = "PENDING" | "INITIATED" | "ACQUIRED" | "SUBMITTED" | "PROCESSED" | "APPROVED_VERIFIED" | "REJECTED" | "FAILED" | "ERROR" | "DENIED" | "EXPIRED" | "ABANDONED" | (string & {});
-/**
- * Tipos de entrada soportados para las imágenes del documento.
- */
-type ImageSource = string | Blob | File | ArrayBuffer | Uint8Array | {
-    url?: unknown;
-} | {
-    [key: string]: unknown;
-};
-/**
- * Función personalizada para firmar URLs de S3 o descargar recursos privados.
- */
-type S3SignerFunction = (pathOrUrl: string, expires?: number) => Promise<string | {
-    url?: unknown;
-} | unknown>;
-/**
- * Función o valor para proveer el token de autenticación.
- */
-type AuthTokenProvider = string | (() => string | undefined | null | Promise<string | undefined | null>);
-/**
- * Opciones de configuración para instanciar el cliente JumioClient.
- */
-interface JumioClientConfig {
-    /**
-     * URL base de la API de DynamiCore / Backend.
-     * @default "https://front.dynamicore.io"
-     */
-    baseUrl?: string;
-    /**
-     * Endpoint específico del servicio de verificación Jumio.
-     * @default "/marketplace/apps/jumio"
-     */
-    endpoint?: string;
-    /**
-     * Header de contexto moral / negocio enviado en las peticiones.
-     */
-    context?: string;
-    /**
-     * Token de autenticación o función que lo obtiene.
-     */
-    authToken?: AuthTokenProvider;
-    /**
-     * Prefijo para el header Authorization (por defecto vacío o "Bearer ").
-     * @default ""
-     */
-    authTokenPrefix?: string;
-    /**
-     * Timeout en milisegundos para las peticiones POST de verificación.
-     * @default 180000 (3 minutos)
-     */
-    requestTimeout?: number;
-    /**
-     * Timeout en milisegundos para las peticiones GET de status.
-     * @default 120000 (2 minutos)
-     */
-    statusTimeout?: number;
-    /**
-     * Número máximo de reintentos ante timeouts o fallas transitorias de red.
-     * @default 3
-     */
-    maxRetries?: number;
-    /**
-     * Delay base en milisegundos para el backoff exponencial de reintentos.
-     * @default 800
-     */
-    retryDelayMs?: number;
-    /**
-     * Intervalo en milisegundos entre consultas sucesivas de sondeo (polling).
-     * @default 10000 (10 segundos)
-     */
-    pollingIntervalMs?: number;
-    /**
-     * Número máximo de intentos de sondeo antes de timeout.
-     * @default 20 (20 x 10s = aprox 200 segundos)
-     */
-    maxPollingAttempts?: number;
-    /**
-     * Función opcional para firmar rutas u URLs de Amazon S3.
-     */
-    s3Signer?: S3SignerFunction;
-    /**
-     * Headers HTTP adicionales para incluir en cada petición.
-     */
-    customHeaders?: Record<string, string>;
-    /**
-     * Instancia personalizada de Axios (opcional).
-     */
-    axiosInstance?: AxiosInstance;
-}
-/**
- * Payload enviado a la API de verificación de Jumio.
- */
-interface JumioVerificationPayload {
-    client: string;
-    front_image_b64: string;
-    back_image_b64: string;
-    [key: string]: unknown;
-}
-/**
- * Estructura de respuesta de datos de verificación.
- */
-interface JumioVerificationData {
-    valid?: boolean;
-    status?: JumioWorkflowStatus;
-    workflowStatus?: JumioWorkflowStatus;
-    decision?: string;
-    accountId?: string;
-    workflowId?: string;
-    message?: string;
-    [key: string]: unknown;
-}
-/**
- * Estructura inicial devuelta al iniciar el flujo de verificación.
- */
-interface JumioIneStartData extends JumioVerificationData {
-    accountId?: string;
-    workflowId?: string;
-}
-/**
- * Resultado estructurado retornado por el cliente tras una validación.
- */
-interface VerifyIneResult {
-    /**
-     * Indica si la validación fue exitosa (true) o fallida/rechazada (false).
-     */
-    valid: boolean;
-    /**
-     * Estado actual o final del flujo de Jumio.
-     */
-    status?: JumioWorkflowStatus;
-    /**
-     * Identificador de cuenta en Jumio.
-     */
-    accountId?: string;
-    /**
-     * Identificador del workflow en Jumio.
-     */
-    workflowId?: string;
-    /**
-     * Datos completos devueltos por la API de Jumio/DynamiCore.
-     */
-    data: unknown;
-    /**
-     * Mensaje descriptivo o de error si la validación falló.
-     */
-    errorMessage?: string;
-}
-/**
- * Callback ejecutado cuando el sondeo resuelve un estado final.
- */
-type JumioStatusResolvedCallback = (result: VerifyIneResult) => void;
-/**
- * Callback ejecutado si ocurre un error durante el sondeo o la petición.
- */
-type JumioStatusErrorCallback = (error: Error) => void;
-/**
- * Callback de progreso para reportar avances de conversión o polling.
- */
-type JumioProgressCallback = (stage: string, percent?: number) => void;
-/**
- * Parámetros de entrada para la función `verifyIne`.
- */
-interface VerifyIneInput {
-    /**
-     * Identificador único del cliente (persona, usuario o ID externo).
-     */
-    clientId: string;
-    /**
-     * Imagen frontal del documento (INE): URL, ruta S3, File, Blob o Base64.
-     */
-    frontImage: ImageSource;
-    /**
-     * Imagen trasera/reverso del documento (INE): URL, ruta S3, File, Blob o Base64.
-     */
-    backImage: ImageSource;
-    /**
-     * Si es `true`, la promesa espera hasta que Jumio resuelva el resultado final (bloqueante).
-     * Si es `false` (por defecto), inicia la validación, retorna de inmediato y ejecuta el sondeo en 2do plano.
-     * @default false
-     */
-    awaitFinalStatus?: boolean;
-    /**
-     * Callback invocado cuando se completa el proceso de validación (síncrono o en segundo plano).
-     */
-    onStatusResolved?: JumioStatusResolvedCallback;
-    /**
-     * Callback invocado ante errores no recuperables durante la validación o sondeo.
-     */
-    onStatusError?: JumioStatusErrorCallback;
-    /**
-     * Callback opcional para reportar etapas del proceso.
-     */
-    onProgress?: JumioProgressCallback;
-    /**
-     * Señal de cancelación (AbortSignal) para abortar peticiones o sondeo activo.
-     */
-    signal?: AbortSignal;
-}
-/**
- * Opciones para el método de polling de estado.
- */
-interface PollStatusOptions {
-    pollingIntervalMs?: number;
-    maxAttempts?: number;
-    signal?: AbortSignal;
-    onAttempt?: (attempt: number, maxAttempts: number, lastData: unknown) => void;
-}
-
-/**
- * Cliente principal para gestionar validaciones de identidad mediante Jumio.
- */
-declare class JumioClient {
-    private readonly http;
-    private readonly config;
-    constructor(config?: JumioClientConfig);
-    /**
-     * Inicia el proceso de verificación convirtiendo las imágenes y enviando el payload inicial a Jumio.
-     */
-    startIneVerification(params: {
-        clientId: string;
-        frontImage: ImageSource;
-        backImage: ImageSource;
-        signal?: AbortSignal;
-        onProgress?: JumioProgressCallback;
-    }): Promise<JumioIneStartData>;
-    /**
-     * Consulta una única vez el estado actual de la validación.
-     */
-    getIneStatus(accountId: string, workflowId: string, signal?: AbortSignal): Promise<JumioVerificationData>;
-    /**
-     * Sondea periódicamente el estado hasta obtener un resultado definitivo.
-     */
-    pollIneStatus(accountId: string, workflowId: string, options?: PollStatusOptions): Promise<VerifyIneResult>;
-    /**
-     * Ejecuta el flujo completo de validación de INE.
-     *
-     * @param input Parámetros de validación y callbacks.
-     * @returns `VerifyIneResult` con el resultado inicial o definitivo según `awaitFinalStatus`.
-     */
-    verifyIne(input: VerifyIneInput): Promise<VerifyIneResult>;
-}
-/**
- * Fábrica para crear una nueva instancia de `JumioClient`.
- */
-declare function createJumioClient(config?: JumioClientConfig): JumioClient;
-
-export { type AuthTokenProvider as A, type ImageSource as I, JumioClient as J, type PollStatusOptions as P, type S3SignerFunction as S, type VerifyIneInput as V, type JumioClientConfig as a, type JumioIneStartData as b, type JumioProgressCallback as c, type JumioStatusErrorCallback as d, type JumioStatusResolvedCallback as e, type JumioVerificationData as f, type JumioVerificationPayload as g, type JumioWorkflowStatus as h, type VerifyIneResult as i, createJumioClient as j };