@neofaceid/web-sdk 1.29.0 → 1.31.0

package/dist/index.d.ts

@@ -47,6 +47,15 @@ export declare interface AuthorizationResult {
     message?: string;
 }
 
+/**
+ * NeoFaceSDK.authorize — autoriza uma operação por biometria, orquestrando
+ * consent + captura + desafio de vivacidade (via runLivenessChallenge, NEO-408).
+ *
+ * O servidor sorteia a sequência de gestos, valida cada frame enviado e decide
+ * o resultado. O SDK apenas exibe e coleta ("client collects, server decides").
+ */
+export declare function authorize(options: AuthorizeOptions): Promise<void>;
+
 /**
  * NEO-108: Authorization operation with multi-photo capture and gesture detection
  *
@@ -64,6 +73,26 @@ export declare interface AuthorizationResult {
  */
 export declare const authorizeOperation: (applicationToken: string, cpf: string, options?: AuthorizationOptions) => Promise<AuthorizationResult>;
 
+export declare interface AuthorizeOptions {
+    applicationToken: string;
+    /** Titular sendo autorizado (CPF, e-mail ou id opaco). */
+    subject: string;
+    /** Nome do integrador (fallback: `init({ appName })`). */
+    appName?: string;
+    /**
+     * Número máximo de desafios (0-3). O servidor decide a sequência (NEO-408
+     * runLivenessChallenge) — este campo é apenas um teto sugerido ao backend.
+     */
+    challenges?: 0 | 1 | 2 | 3;
+    /** Valor monetário exibido no header. Ex.: 1250 = "R$ 1.250,00". */
+    amount?: number;
+    onChallengeStart?: (gesture: ChallengeGesture, index: number, total: number) => void;
+    onChallengeComplete?: (gesture: ChallengeGesture, index: number, total: number) => void;
+    onSuccess?: (result: LivenessChallengeResult) => void;
+    onError?: (error: NeoFaceError) => void;
+    onCancel?: () => void;
+}
+
 export declare class BiometricCaptureModal {
     private modal;
     private video;
@@ -90,9 +119,11 @@ export declare class BiometricCaptureModal {
      */
     private initializeCamera;
     /**
-     * Inicia a contagem regressiva
+     * NEO-413 · US14.6 (item 18) — a contagem "3, 2, 1" foi removida.
+     * Agora habilita direto o botão "Capturar" assim que a câmera fica pronta.
+     * Vivacidade fica com o desafio `runLivenessChallenge` (NEO-408), servidor decide.
      */
-    private startCountdown;
+    private enableCaptureButton;
     /**
      * Captura a imagem da câmera
      */
@@ -503,12 +534,6 @@ export declare interface EmailPasswordOptions {
     subtitle?: string;
 }
 
-/**
- * SDK Global Configuration
- *
- * Este módulo gerencia a configuração global do SDK, permitindo
- * inicialização com detecção automática de ambiente ou override manual.
- */
 export declare type Environment = 'development' | 'sandbox' | 'production';
 
 /**
@@ -596,11 +621,17 @@ export declare interface GestureResponse {
     images: string[];
 }
 
+/** Retorna a cor de acento configurada, se houver (antes do validador de contraste). */
+export declare function getAccent(): string | null;
+
 /**
  * Retorna o token de aplicação configurado, se houver.
  */
 export declare function getApplicationToken(): string | null;
 
+/** Retorna o nome do integrador configurado, se houver. */
+export declare function getAppName(): string | null;
+
 /**
  * Retorna a URL base configurada para a API.
  * Se o SDK não foi inicializado, retorna o fallback para sandbox.
@@ -619,6 +650,22 @@ export declare function getConfig(): Readonly<SDKConfig>;
  */
 export declare function getEnvironment(): Environment | 'custom';
 
+/** Retorna o locale configurado (padrão 'pt-BR'). */
+export declare function getLocale(): string;
+
+/** Retorna o raio base configurado (padrão 16). */
+export declare function getRadius(): SDKRadius;
+
+/**
+ * Retorna o modo de tema resolvido para a superfície de UI (light | dark).
+ * Considera 'auto' + `prefers-color-scheme`. Útil para consumidores que
+ * precisam alinhar visualmente algum elemento próprio ao SDK.
+ */
+export declare function getResolvedThemeMode(): ThemeMode;
+
+/** Retorna o modo de tema configurado (padrão 'light'). */
+export declare function getTheme(): SDKTheme;
+
 /**
  * Identifies a person from an image and returns name and age
  * @param image The image blob to process
@@ -1286,6 +1333,15 @@ export declare function requestPasswordReset(email: string, applicationToken: st
 
 export declare function resetCaptureSession(): void;
 
+declare interface ResolvedTheme {
+    mode: ThemeMode;
+    tokens: ThemeTokens;
+    radius: 8 | 16 | 24;
+    accent: string;
+    /** True quando o `accent` do integrador foi rejeitado por contraste. */
+    accentFellBack: boolean;
+}
+
 /**
  * Orquestra o fluxo completo:
  * 1. Abre `capture/session`
@@ -1319,6 +1375,12 @@ declare interface SDKConfig {
     applicationToken: string | null;
     environment: Environment | 'custom';
     initialized: boolean;
+    appName: string | null;
+    accent: string | null;
+    radius: SDKRadius;
+    theme: SDKTheme;
+    locale: string;
+    resolvedTheme: ResolvedTheme | null;
 }
 
 /**
@@ -1340,8 +1402,42 @@ export declare interface SDKInitOptions {
      * Obtido através do painel administrativo do NeoFaceID.
      */
     applicationToken?: string;
+    /**
+     * Nome do integrador — mostrado no topo dos modais do SDK ("Banco Exemplo" >
+     * NeoFaceID). Obrigatório na prática: omitir gera `console.warn` e cai para o
+     * fallback "sua aplicação".
+     */
+    appName?: string;
+    /**
+     * Cor de acento do integrador. Pinta APENAS o preenchimento do botão primário.
+     * Nunca o anel de captura, o arco de desafio, os colchetes Focus Frame, os
+     * glifos ou o selo de resultado — o visor precisa ser idêntico em toda parte
+     * para que uma tela falsa não engane.
+     *
+     * Validado em runtime: contraste vs `#FFFFFF` < 4.5 = fallback para `#0059C4`
+     * + `console.warn`. É segurança, não gosto.
+     */
+    accent?: string;
+    /**
+     * Raio base dos containers. Restrito aos três raios do sistema: 8, 16 ou 24.
+     * Padrão 16. Valor fora dos três permitidos = `console.warn` + fallback 16.
+     */
+    radius?: SDKRadius;
+    /**
+     * Modo do tema para a superfície dos modais. Padrão `light`. `auto` respeita
+     * `prefers-color-scheme`. O visor de captura é sempre escuro nos dois modos.
+     */
+    theme?: SDKTheme;
+    /**
+     * Locale da UI. Padrão `pt-BR`.
+     */
+    locale?: string;
 }
 
+export declare type SDKRadius = 8 | 16 | 24;
+
+export declare type SDKTheme = 'light' | 'dark' | 'auto';
+
 /**
  * Session data interface for external integrations
  */
@@ -1476,6 +1572,24 @@ export declare interface SubmitLivenessChallengeParams {
     gestures: GestureResponse[];
 }
 
+declare type ThemeMode = 'light' | 'dark';
+
+/** Tokens semânticos por tema — o que os componentes consomem. */
+declare interface ThemeTokens {
+    ground: string;
+    surface: string;
+    surfaceMuted: string;
+    line: string;
+    text: string;
+    textMuted: string;
+    textSubtle: string;
+    action: string;
+    actionText: string;
+    accent: string;
+    overlay: string;
+    focusRing: string;
+}
+
 /**
  * Result of user existence check
  */
@@ -1512,7 +1626,7 @@ export declare const validateToken: (applicationToken: string) => Promise<boolea
  * MINOR: Incrementado quando adicionamos funcionalidades mantendo compatibilidade
  * PATCH: Incrementado quando corrigimos bugs mantendo compatibilidade
  */
-export declare const VERSION = "1.29.0";
+export declare const VERSION = "1.31.0";
 
 /**
  * Executa `fn(sessionId)`. Se o servidor devolver 410 (sessão consumida/expirada),