@dynamicore/jumio-sdk 1.0.0 → 1.0.2

package/dist/react/index.d.mts

@@ -1,4 +1,4 @@
-import { a as JumioClientConfig, J as JumioClient, e as JumioStatusResolvedCallback, d as JumioStatusErrorCallback, c as JumioProgressCallback, i as VerifyIneResult, V as VerifyIneInput } from '../client-BR1xIZ0X.mjs';
+import { a as JumioClientConfig, J as JumioClient, e as JumioStatusResolvedCallback, d as JumioStatusErrorCallback, c as JumioProgressCallback, l as VerifyIneResult, V as VerifyIneInput, W as WebflowResult, j as StartWebflowInput, k as StartWebflowResult, m as WebflowReturnParams } from '../client-BwEiGMPy.mjs';
 import 'axios';
 
 /**
@@ -87,6 +87,110 @@ interface UseJumioVerificationReturn extends UseJumioVerificationState {
      */
     client: JumioClient;
 }
+/**
+ * Opciones para configurar el hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowOptions extends JumioClientConfig {
+    /**
+     * Instancia existente de `JumioClient` (opcional). Si se pasa, reutiliza dicha instancia.
+     */
+    client?: JumioClient;
+    /**
+     * Callback ejecutado cuando el sondeo de resultados resuelve un veredicto final.
+     */
+    onResult?: (result: WebflowResult) => void;
+    /**
+     * Callback ejecutado si ocurre un error durante el inicio o el sondeo del flujo.
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Estado reactivo expuesto por el hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowState {
+    /**
+     * `true` mientras se esté realizando la solicitud de inicio del flujo (POST).
+     */
+    isStarting: boolean;
+    /**
+     * `true` mientras se esté sondeando el estado de la verificación (GET polling).
+     */
+    isChecking: boolean;
+    /**
+     * `true` mientras cualquiera de los dos procesos esté activo.
+     */
+    isLoading: boolean;
+    /**
+     * Resultado de la verificación si ya está disponible.
+     */
+    result: WebflowResult | null;
+    /**
+     * Error más reciente ocurrido durante el inicio o el sondeo.
+     */
+    error: Error | null;
+    /**
+     * `true` si la verificación resultó válida (aprobada).
+     */
+    isValid: boolean;
+    /**
+     * `true` si la verificación fue rechazada o si ocurrió un error no recuperable.
+     */
+    isRejected: boolean;
+}
+/**
+ * Retorno del hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowReturn extends UseJumioWebflowState {
+    /**
+     * Inicia el flujo Hosted Webflow: solicita la URL de verificación al backend
+     * y opcionalmente redirige al usuario automáticamente.
+     *
+     * @param input Parámetros del flujo. Si `autoRedirect` es `true`, el navegador
+     *              se redirigirá automáticamente a la URL de Jumio.
+     * @returns `StartWebflowResult` con el `href` de Jumio.
+     */
+    startWebflow: (input: StartWebflowInput) => Promise<StartWebflowResult>;
+    /**
+     * Consulta o sondea el estado de verificación tras el retorno de Jumio.
+     * Usa los `accountId` y `workflowId` obtenidos de la URL de retorno.
+     *
+     * @param params `accountId`, `workflowId`, y `clientId` opcional.
+     * @param options Opciones de sondeo (maxAttempts, pollingIntervalMs, etc.).
+     * @returns `WebflowResult` con el veredicto final.
+     */
+    checkResult: (params: {
+        accountId: string;
+        workflowId: string;
+        clientId?: string;
+    }, options?: {
+        maxAttempts?: number;
+        pollingIntervalMs?: number;
+        signal?: AbortSignal;
+    }) => Promise<WebflowResult>;
+    /**
+     * Extrae los parámetros de retorno de Jumio de la URL actual o provista.
+     * Util para leer `accountId` y `workflowId` al montar el componente de retorno.
+     *
+     * @param source URL completa, `URLSearchParams`, o nada para usar `window.location`.
+     * @returns `WebflowReturnParams`.
+     */
+    parseReturnParams: (source?: string | URLSearchParams | {
+        search?: string;
+        href?: string;
+    }) => WebflowReturnParams;
+    /**
+     * Cancela cualquier operación activa en curso.
+     */
+    cancel: () => void;
+    /**
+     * Reinicia el estado del hook a sus valores iniciales.
+     */
+    reset: () => void;
+    /**
+     * Instancia subyacente de `JumioClient`.
+     */
+    client: JumioClient;
+}
 
 /**
  * Hook de React para integrar validación de documentos e INE con Jumio.
@@ -104,4 +208,44 @@ interface UseJumioVerificationReturn extends UseJumioVerificationState {
  */
 declare function useJumioVerification(options?: UseJumioVerificationOptions): UseJumioVerificationReturn;
 
-export { type UseJumioVerificationOptions, type UseJumioVerificationReturn, type UseJumioVerificationState, useJumioVerification };
+/**
+ * Hook de React para integrar el flujo Hosted Webflow de Jumio (verificacion por redireccion).
+ *
+ * @example Paso 1 - Iniciar el flujo (componente de inicio):
+ * ```tsx
+ * const { startWebflow, isStarting, error } = useJumioWebflow({
+ *   baseUrl: process.env.NEXT_PUBLIC_API_URL,
+ *   context: process.env.NEXT_PUBLIC_DYNAMICORE_CONTEXT,
+ * });
+ *
+ * const handleStart = async () => {
+ *   const { href } = await startWebflow({
+ *     clientId: "usr_123",
+ *     successUrl: `${window.location.origin}/verify/return`,
+ *     errorUrl: `${window.location.origin}/verify/return`,
+ *     autoRedirect: true, // redirige automaticamente
+ *   });
+ *   // si autoRedirect es false, redirigir manualmente:
+ *   // window.location.href = href;
+ * };
+ * ```
+ *
+ * @example Paso 2 - Verificar resultado (componente de retorno, en /verify/return):
+ * ```tsx
+ * const { parseReturnParams, checkResult, isChecking, result, isValid } = useJumioWebflow({
+ *   baseUrl: process.env.NEXT_PUBLIC_API_URL,
+ *   context: process.env.NEXT_PUBLIC_DYNAMICORE_CONTEXT,
+ *   onResult: (r) => { if (r.valid) router.push("/dashboard"); },
+ * });
+ *
+ * useEffect(() => {
+ *   const { accountId, workflowId } = parseReturnParams();
+ *   if (accountId && workflowId) {
+ *     checkResult({ accountId, workflowId, clientId: "usr_123" });
+ *   }
+ * }, []);
+ * ```
+ */
+declare function useJumioWebflow(options?: UseJumioWebflowOptions): UseJumioWebflowReturn;
+
+export { type UseJumioVerificationOptions, type UseJumioVerificationReturn, type UseJumioVerificationState, type UseJumioWebflowOptions, type UseJumioWebflowReturn, type UseJumioWebflowState, useJumioVerification, useJumioWebflow };

package/dist/react/index.d.ts

@@ -1,4 +1,4 @@
-import { a as JumioClientConfig, J as JumioClient, e as JumioStatusResolvedCallback, d as JumioStatusErrorCallback, c as JumioProgressCallback, i as VerifyIneResult, V as VerifyIneInput } from '../client-BR1xIZ0X.js';
+import { a as JumioClientConfig, J as JumioClient, e as JumioStatusResolvedCallback, d as JumioStatusErrorCallback, c as JumioProgressCallback, l as VerifyIneResult, V as VerifyIneInput, W as WebflowResult, j as StartWebflowInput, k as StartWebflowResult, m as WebflowReturnParams } from '../client-BwEiGMPy.js';
 import 'axios';
 
 /**
@@ -87,6 +87,110 @@ interface UseJumioVerificationReturn extends UseJumioVerificationState {
      */
     client: JumioClient;
 }
+/**
+ * Opciones para configurar el hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowOptions extends JumioClientConfig {
+    /**
+     * Instancia existente de `JumioClient` (opcional). Si se pasa, reutiliza dicha instancia.
+     */
+    client?: JumioClient;
+    /**
+     * Callback ejecutado cuando el sondeo de resultados resuelve un veredicto final.
+     */
+    onResult?: (result: WebflowResult) => void;
+    /**
+     * Callback ejecutado si ocurre un error durante el inicio o el sondeo del flujo.
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Estado reactivo expuesto por el hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowState {
+    /**
+     * `true` mientras se esté realizando la solicitud de inicio del flujo (POST).
+     */
+    isStarting: boolean;
+    /**
+     * `true` mientras se esté sondeando el estado de la verificación (GET polling).
+     */
+    isChecking: boolean;
+    /**
+     * `true` mientras cualquiera de los dos procesos esté activo.
+     */
+    isLoading: boolean;
+    /**
+     * Resultado de la verificación si ya está disponible.
+     */
+    result: WebflowResult | null;
+    /**
+     * Error más reciente ocurrido durante el inicio o el sondeo.
+     */
+    error: Error | null;
+    /**
+     * `true` si la verificación resultó válida (aprobada).
+     */
+    isValid: boolean;
+    /**
+     * `true` si la verificación fue rechazada o si ocurrió un error no recuperable.
+     */
+    isRejected: boolean;
+}
+/**
+ * Retorno del hook `useJumioWebflow`.
+ */
+interface UseJumioWebflowReturn extends UseJumioWebflowState {
+    /**
+     * Inicia el flujo Hosted Webflow: solicita la URL de verificación al backend
+     * y opcionalmente redirige al usuario automáticamente.
+     *
+     * @param input Parámetros del flujo. Si `autoRedirect` es `true`, el navegador
+     *              se redirigirá automáticamente a la URL de Jumio.
+     * @returns `StartWebflowResult` con el `href` de Jumio.
+     */
+    startWebflow: (input: StartWebflowInput) => Promise<StartWebflowResult>;
+    /**
+     * Consulta o sondea el estado de verificación tras el retorno de Jumio.
+     * Usa los `accountId` y `workflowId` obtenidos de la URL de retorno.
+     *
+     * @param params `accountId`, `workflowId`, y `clientId` opcional.
+     * @param options Opciones de sondeo (maxAttempts, pollingIntervalMs, etc.).
+     * @returns `WebflowResult` con el veredicto final.
+     */
+    checkResult: (params: {
+        accountId: string;
+        workflowId: string;
+        clientId?: string;
+    }, options?: {
+        maxAttempts?: number;
+        pollingIntervalMs?: number;
+        signal?: AbortSignal;
+    }) => Promise<WebflowResult>;
+    /**
+     * Extrae los parámetros de retorno de Jumio de la URL actual o provista.
+     * Util para leer `accountId` y `workflowId` al montar el componente de retorno.
+     *
+     * @param source URL completa, `URLSearchParams`, o nada para usar `window.location`.
+     * @returns `WebflowReturnParams`.
+     */
+    parseReturnParams: (source?: string | URLSearchParams | {
+        search?: string;
+        href?: string;
+    }) => WebflowReturnParams;
+    /**
+     * Cancela cualquier operación activa en curso.
+     */
+    cancel: () => void;
+    /**
+     * Reinicia el estado del hook a sus valores iniciales.
+     */
+    reset: () => void;
+    /**
+     * Instancia subyacente de `JumioClient`.
+     */
+    client: JumioClient;
+}
 
 /**
  * Hook de React para integrar validación de documentos e INE con Jumio.
@@ -104,4 +208,44 @@ interface UseJumioVerificationReturn extends UseJumioVerificationState {
  */
 declare function useJumioVerification(options?: UseJumioVerificationOptions): UseJumioVerificationReturn;
 
-export { type UseJumioVerificationOptions, type UseJumioVerificationReturn, type UseJumioVerificationState, useJumioVerification };
+/**
+ * Hook de React para integrar el flujo Hosted Webflow de Jumio (verificacion por redireccion).
+ *
+ * @example Paso 1 - Iniciar el flujo (componente de inicio):
+ * ```tsx
+ * const { startWebflow, isStarting, error } = useJumioWebflow({
+ *   baseUrl: process.env.NEXT_PUBLIC_API_URL,
+ *   context: process.env.NEXT_PUBLIC_DYNAMICORE_CONTEXT,
+ * });
+ *
+ * const handleStart = async () => {
+ *   const { href } = await startWebflow({
+ *     clientId: "usr_123",
+ *     successUrl: `${window.location.origin}/verify/return`,
+ *     errorUrl: `${window.location.origin}/verify/return`,
+ *     autoRedirect: true, // redirige automaticamente
+ *   });
+ *   // si autoRedirect es false, redirigir manualmente:
+ *   // window.location.href = href;
+ * };
+ * ```
+ *
+ * @example Paso 2 - Verificar resultado (componente de retorno, en /verify/return):
+ * ```tsx
+ * const { parseReturnParams, checkResult, isChecking, result, isValid } = useJumioWebflow({
+ *   baseUrl: process.env.NEXT_PUBLIC_API_URL,
+ *   context: process.env.NEXT_PUBLIC_DYNAMICORE_CONTEXT,
+ *   onResult: (r) => { if (r.valid) router.push("/dashboard"); },
+ * });
+ *
+ * useEffect(() => {
+ *   const { accountId, workflowId } = parseReturnParams();
+ *   if (accountId && workflowId) {
+ *     checkResult({ accountId, workflowId, clientId: "usr_123" });
+ *   }
+ * }, []);
+ * ```
+ */
+declare function useJumioWebflow(options?: UseJumioWebflowOptions): UseJumioWebflowReturn;
+
+export { type UseJumioVerificationOptions, type UseJumioVerificationReturn, type UseJumioVerificationState, type UseJumioWebflowOptions, type UseJumioWebflowReturn, type UseJumioWebflowState, useJumioVerification, useJumioWebflow };