@neofaceid/web-sdk 1.27.0 → 1.28.0

package/dist/index.d.ts

@@ -33,6 +33,8 @@ export declare interface AuthorizationOptions {
     onProgress?: (step: number, totalSteps: number, instruction: string) => void;
     onPhotoTaken?: (photoNumber: number, blob: Blob) => void;
     captureDelay?: number;
+    /** Nome do integrador exibido no topo do modal de consentimento (US14.2). */
+    appName?: string;
 }
 
 export declare interface AuthorizationResult {
@@ -141,6 +143,11 @@ export declare function biometricLogin(applicationToken: string, mode?: 'face' |
 
 export declare interface BiometricLoginOptions {
     applicationToken: string;
+    /**
+     * Nome do integrador exibido no topo do modal de consentimento (US14.2).
+     * Ausência gera console.warn e cai para o fallback "sua aplicação".
+     */
+    appName?: string;
     onSuccess: (result: BiometricLoginResult) => void;
     onError: (error: NeoFaceError) => void;
     onCancel?: () => void;
@@ -350,16 +357,15 @@ export declare function confirmPasswordReset(token: string, new_password: string
     message: string;
 }>;
 
+declare type ConsentFlow = 'verification' | 'registration';
+
 export declare interface ConsentInfo {
-    purpose: string;
-    legalBasis: string;
-    privacyPolicyUrl: string;
-    retentionDays: number;
+    appName?: string;
+    flow?: ConsentFlow;
+    privacyPolicyUrl?: string;
+    retentionDays?: number;
 }
 
-/**
- * Gerencia o ciclo de vida (montagem/desmontagem) do modal de consentimento.
- */
 export declare class ConsentModal {
     private container;
     private root;
@@ -367,21 +373,18 @@ export declare class ConsentModal {
     close(): void;
 }
 
-/**
- * Props do modal de consentimento LGPD exibido antes de qualquer captura de câmera.
- */
 export declare interface ConsentModalProps {
-    purpose: string;
-    legalBasis: string;
-    privacyPolicyUrl: string;
-    retentionDays: number;
+    appName: string;
+    flow: ConsentFlow;
+    privacyPolicyUrl?: string;
+    retentionDays?: number;
     onAccept: () => void;
     onDecline: () => void;
 }
 
 /**
- * Defaults conservadores usados enquanto `SDKInitOptions` não expõe `consent` (US7.2).
- * Quando essa opção existir, este helper passa a ler `getConfig().consent`.
+ * Compatibilidade com callers antigos que passavam `{ purpose, legalBasis }`.
+ * Deprecated — remover quando US14.4 unificar tokens.
  */
 export declare const DEFAULT_CONSENT_INFO: ConsentInfo;
 
@@ -444,6 +447,9 @@ export declare interface DocumentCaptureOptions {
     useBackCamera?: boolean;
     onCancel?: () => void;
     preSelectedDocument?: DocumentType_2;
+    /** Nome do integrador exibido no topo do modal de consentimento (US14.2). */
+    appName?: string;
+    /* Excluded from this release type: skipConsent */
 }
 
 export declare interface DocumentCaptureResult {
@@ -1232,8 +1238,12 @@ declare interface RequestChallengeWithSessionParams {
 /**
  * Exibe o modal de consentimento e resolve `true` se o titular aceitou,
  * `false` se recusou. Deve ser chamado antes de qualquer `getUserMedia()`.
+ *
+ * `appName` é obrigatório na prática — omitir gera console.warn e fallback.
+ * `flow` decide a copy da terceira linha: 'verification' (padrão) descarta a
+ * imagem; 'registration' informa que o vetor biométrico é armazenado.
  */
-export declare function requestConsent(info?: Partial<ConsentInfo>): Promise<boolean>;
+export declare function requestConsent(info?: ConsentInfo): Promise<boolean>;
 
 /**
  * Pede ao servidor a sequência de gestos do desafio de liveness.
@@ -1349,7 +1359,9 @@ export declare const simpleIdentification: (documentType: string, documentNumber
     };
 }>;
 
-export declare function start(applicationToken: string, callbacks: Callbacks): void;
+export declare function start(applicationToken: string, callbacks: Callbacks, options?: {
+    appName?: string;
+}): void;
 
 /**
  * Inicia o processo de login com detecção automática do tipo biométrico
@@ -1371,6 +1383,7 @@ export declare function startBiometricRegistration(personData: {
     password: string;
 }, applicationToken: string, callbacks: BiometricRegistrationCallbacks, options?: {
     useRealApi?: boolean;
+    appName?: string;
 }): void;
 
 /**
@@ -1400,6 +1413,8 @@ export declare function startLivenessCapture(applicationToken: string, callbacks
     onSuccess(photos: Blob[]): void;
     onError(code: string, message: string): void;
     onCancel?(): void;
+}, options?: {
+    appName?: string;
 }): void;
 
 /**
@@ -1414,6 +1429,8 @@ export declare interface StartOnboardingOptions {
     countdown?: number;
     title?: string;
     subtitle?: string;
+    /** Nome do integrador exibido no topo do modal de consentimento (US14.2). */
+    appName?: string;
     onSuccess: (result: {
         success: boolean;
         message: string;
@@ -1477,7 +1494,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.27.0";
+export declare const VERSION = "1.28.0";
 
 /**
  * Executa `fn(sessionId)`. Se o servidor devolver 410 (sessão consumida/expirada),