@dynamicore/jumio-sdk 1.0.0 → 1.0.2

package/dist/core/index.d.ts

@@ -1,5 +1,5 @@
-import { f as JumioVerificationData, I as ImageSource, S as S3SignerFunction, a as JumioClientConfig, P as PollStatusOptions, i as VerifyIneResult } from '../client-BR1xIZ0X.js';
-export { A as AuthTokenProvider, J as JumioClient, b as JumioIneStartData, c as JumioProgressCallback, d as JumioStatusErrorCallback, e as JumioStatusResolvedCallback, g as JumioVerificationPayload, h as JumioWorkflowStatus, V as VerifyIneInput, j as createJumioClient } from '../client-BR1xIZ0X.js';
+import { f as JumioVerificationData, I as ImageSource, S as S3SignerFunction, a as JumioClientConfig, P as PollStatusOptions, l as VerifyIneResult, m as WebflowReturnParams, i as PollWebflowOptions, W as WebflowResult, j as StartWebflowInput, k as StartWebflowResult } from '../client-BwEiGMPy.js';
+export { A as AuthTokenProvider, G as GetWebflowStatusInput, J as JumioClient, b as JumioIneStartData, c as JumioProgressCallback, d as JumioStatusErrorCallback, e as JumioStatusResolvedCallback, g as JumioVerificationPayload, h as JumioWorkflowStatus, V as VerifyIneInput, n as createJumioClient } from '../client-BwEiGMPy.js';
 import 'axios';
 
 /**
@@ -81,7 +81,8 @@ declare function toLowerText(value: unknown): string;
  */
 declare function toUpperText(value: unknown): string;
 /**
- * Desempaqueta el envoltorio estándar `{ data: ... }` si está presente en la respuesta.
+ * Desempaqueta el envoltorio estándar `{ data: ... }` o `{ values: ... }` si están presentes en la respuesta.
+ * Soporta ambas formas de envelope usadas por los distintos endpoints de DynamiCore/Jumio.
  */
 declare function extractEnvelopeData<T>(responseData: unknown): T;
 /**
@@ -115,6 +116,18 @@ declare function isPassedJumioDecision(decision: unknown): boolean;
  * 3. Fallback conservador basado en el estado del workflow.
  */
 declare function resolveVerificationValidity(data: Pick<JumioVerificationData, "valid" | "decision">, fallbackStatus: unknown): boolean;
+/**
+ * Codifica una URL en Base64 URL-safe (sin `+`, `/` ni `=`).
+ *
+ * Compatible con:
+ * - **Node.js ≥ 18**: Usa `Buffer.from(url).toString("base64")`.
+ * - **Navegadores modernos**: Usa `TextEncoder` + `btoa`.
+ * - **Navegadores legacy**: Usa `btoa` directamente.
+ *
+ * @param url La URL a codificar.
+ * @returns La cadena codificada en Base64 URL-safe, o `null` si ocurre un error.
+ */
+declare function encodeUrlToBase64UrlSafe(url: string): string | null;
 
 interface RetryOptions {
     maxRetries?: number;
@@ -188,10 +201,12 @@ declare class JumioHttpClient {
     }): Promise<T>;
     /**
      * Ejecuta una petición GET para consultar el estado actual de una verificación de INE.
+     * Soporta un `clientId` opcional requerido por algunos endpoints de DynamiCore (p. ej. Hosted Webflow).
      */
     getVerificationStatus<T>(accountId: string, workflowId: string, options?: {
         signal?: AbortSignal;
         timeout?: number;
+        clientId?: string;
     }): Promise<T>;
     getConfig(): Readonly<JumioClientConfig>;
 }
@@ -201,4 +216,79 @@ declare class JumioHttpClient {
  */
 declare function pollJumioStatus(http: JumioHttpClient, accountId: string, workflowId: string, options?: PollStatusOptions): Promise<VerifyIneResult>;
 
-export { APPROVED_JUMIO_STATUSES, FINAL_JUMIO_STATUSES, ImageSource, JumioAbortError, JumioClientConfig, JumioError, JumioHttpClient, JumioImageProcessingError, JumioNetworkError, JumioPollingTimeoutError, JumioTimeoutError, JumioValidationError, JumioVerificationData, PollStatusOptions, type RetryOptions, S3SignerFunction, VerifyIneResult, arrayBufferToBase64, blobToBase64, delay, extractEnvelopeData, extractJumioMessage, extractNestedData, fetchUrlAsBase64, isApprovedJumioStatus, isBase64String, isFinalJumioStatus, isJumioError, isPassedJumioDecision, normalizeSignedUrl, pollJumioStatus, resolveImageSourceToBase64, resolveVerificationValidity, shouldRetryJumio, stripDataUrlPrefix, toLowerText, toUpperText, withRetry };
+/**
+ * Construye la URL de redirección para el flujo Hosted Webflow.
+ *
+ * Si se provee un `proxyUrl`, la URL de retorno se codifica en Base64 URL-safe y
+ * se adjunta al proxy. Esto es util cuando la gateway de Jumio o el backend requiere
+ * un intermediario para manejar la redireccion.
+ *
+ * Si no se provee `proxyUrl`, la URL de retorno se usa directamente tal cual.
+ *
+ * @param returnUrl La URL de la aplicacion a la que Jumio redirigira al usuario.
+ * @param proxyUrl URL base del proxy de redireccion (opcional).
+ * @returns La URL final construida.
+ */
+declare function buildRedirectUrl(returnUrl: string, proxyUrl?: string): string;
+/**
+ * Extrae los parametros de seguimiento de Jumio de la URL de retorno.
+ *
+ * Jumio redirige al usuario de vuelta a la aplicacion anadiendo `accountId` y
+ * `workflowExecutionId` (o `workflowId`) como query params. Este helper los
+ * extrae correctamente, manejando:
+ *
+ * - Parametros directos: `?accountId=...&workflowExecutionId=...`
+ * - Parametros anidados dentro de `?status=...?workflowExecutionId=...`
+ * - Alias `workflowId` ademas de `workflowExecutionId`
+ *
+ * @param source URL completa, `URLSearchParams`, o un objeto similar a `window.location`.
+ *               Si se omite, usa `window.location.search` (solo en navegador).
+ * @returns `WebflowReturnParams` con los parametros extraidos.
+ */
+declare function parseWebflowReturnParams(source?: string | URLSearchParams | {
+    search?: string;
+    href?: string;
+}): WebflowReturnParams;
+/**
+ * Evalua los datos de respuesta del backend para determinar si la verificacion
+ * del flujo Hosted Webflow fue exitosa.
+ *
+ * Logica de decision (por prioridad):
+ * 1. `valid: true` explicito → aprobado.
+ * 2. `valid: false` explicito → rechazado.
+ * 3. `decision.type === "REJECTED"` → rechazado.
+ * 4. Extraccion con datos + (`decision.type === "PASSED"` o `"WARNING"`) → aprobado.
+ * 5. Sin datos de extraccion → pendiente (retorna null).
+ *
+ * @returns `WebflowResult | null` -- null indica que la verificacion aun esta pendiente.
+ */
+declare function resolveWebflowResult(rawData: unknown, accountId: string, workflowId: string): WebflowResult | null;
+/**
+ * Sondea periodicamente el estado de verificacion de un flujo Hosted Webflow de Jumio.
+ *
+ * Continua consultando hasta:
+ * - Obtener un resultado definitivo (aprobado, rechazado o `valid` explicito).
+ * - Agotar el numero maximo de intentos (lanza `JumioPollingTimeoutError`).
+ * - Recibir una senal de cancelacion (lanza `JumioAbortError`).
+ *
+ * @param http Instancia del cliente HTTP de Jumio.
+ * @param params Parametros de la verificacion.
+ * @param options Opciones de configuracion del sondeo.
+ * @returns `WebflowResult` con el resultado definitivo.
+ */
+declare function pollWebflowStatus(http: JumioHttpClient, params: {
+    accountId: string;
+    workflowId: string;
+    clientId?: string;
+}, options?: PollWebflowOptions): Promise<WebflowResult>;
+/**
+ * Inicia el flujo Hosted Webflow solicitando al backend la URL de verificacion de Jumio.
+ *
+ * @param http Instancia del cliente HTTP de Jumio.
+ * @param config Configuracion del cliente (para leer `redirectProxyUrl`).
+ * @param input Parametros de inicio del flujo.
+ * @returns `StartWebflowResult` con el `href` de Jumio y datos adicionales.
+ */
+declare function startWebflowSession(http: JumioHttpClient, config: JumioClientConfig, input: StartWebflowInput): Promise<StartWebflowResult>;
+
+export { APPROVED_JUMIO_STATUSES, FINAL_JUMIO_STATUSES, ImageSource, JumioAbortError, JumioClientConfig, JumioError, JumioHttpClient, JumioImageProcessingError, JumioNetworkError, JumioPollingTimeoutError, JumioTimeoutError, JumioValidationError, JumioVerificationData, PollStatusOptions, PollWebflowOptions, type RetryOptions, S3SignerFunction, StartWebflowInput, StartWebflowResult, VerifyIneResult, WebflowResult, WebflowReturnParams, arrayBufferToBase64, blobToBase64, buildRedirectUrl, delay, encodeUrlToBase64UrlSafe, extractEnvelopeData, extractJumioMessage, extractNestedData, fetchUrlAsBase64, isApprovedJumioStatus, isBase64String, isFinalJumioStatus, isJumioError, isPassedJumioDecision, normalizeSignedUrl, parseWebflowReturnParams, pollJumioStatus, pollWebflowStatus, resolveImageSourceToBase64, resolveVerificationValidity, resolveWebflowResult, shouldRetryJumio, startWebflowSession, stripDataUrlPrefix, toLowerText, toUpperText, withRetry };