@neofaceid/web-sdk 1.28.2 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +91 -8
- package/dist/neoface-id-sdk.es.js +453 -216
- package/dist/neoface-id-sdk.umd.js +1 -1
- package/package.json +2 -1
package/dist/index.d.ts
CHANGED
|
@@ -503,12 +503,6 @@ export declare interface EmailPasswordOptions {
|
|
|
503
503
|
subtitle?: string;
|
|
504
504
|
}
|
|
505
505
|
|
|
506
|
-
/**
|
|
507
|
-
* SDK Global Configuration
|
|
508
|
-
*
|
|
509
|
-
* Este módulo gerencia a configuração global do SDK, permitindo
|
|
510
|
-
* inicialização com detecção automática de ambiente ou override manual.
|
|
511
|
-
*/
|
|
512
506
|
export declare type Environment = 'development' | 'sandbox' | 'production';
|
|
513
507
|
|
|
514
508
|
/**
|
|
@@ -596,11 +590,17 @@ export declare interface GestureResponse {
|
|
|
596
590
|
images: string[];
|
|
597
591
|
}
|
|
598
592
|
|
|
593
|
+
/** Retorna a cor de acento configurada, se houver (antes do validador de contraste). */
|
|
594
|
+
export declare function getAccent(): string | null;
|
|
595
|
+
|
|
599
596
|
/**
|
|
600
597
|
* Retorna o token de aplicação configurado, se houver.
|
|
601
598
|
*/
|
|
602
599
|
export declare function getApplicationToken(): string | null;
|
|
603
600
|
|
|
601
|
+
/** Retorna o nome do integrador configurado, se houver. */
|
|
602
|
+
export declare function getAppName(): string | null;
|
|
603
|
+
|
|
604
604
|
/**
|
|
605
605
|
* Retorna a URL base configurada para a API.
|
|
606
606
|
* Se o SDK não foi inicializado, retorna o fallback para sandbox.
|
|
@@ -619,6 +619,22 @@ export declare function getConfig(): Readonly<SDKConfig>;
|
|
|
619
619
|
*/
|
|
620
620
|
export declare function getEnvironment(): Environment | 'custom';
|
|
621
621
|
|
|
622
|
+
/** Retorna o locale configurado (padrão 'pt-BR'). */
|
|
623
|
+
export declare function getLocale(): string;
|
|
624
|
+
|
|
625
|
+
/** Retorna o raio base configurado (padrão 16). */
|
|
626
|
+
export declare function getRadius(): SDKRadius;
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* Retorna o modo de tema resolvido para a superfície de UI (light | dark).
|
|
630
|
+
* Considera 'auto' + `prefers-color-scheme`. Útil para consumidores que
|
|
631
|
+
* precisam alinhar visualmente algum elemento próprio ao SDK.
|
|
632
|
+
*/
|
|
633
|
+
export declare function getResolvedThemeMode(): ThemeMode;
|
|
634
|
+
|
|
635
|
+
/** Retorna o modo de tema configurado (padrão 'light'). */
|
|
636
|
+
export declare function getTheme(): SDKTheme;
|
|
637
|
+
|
|
622
638
|
/**
|
|
623
639
|
* Identifies a person from an image and returns name and age
|
|
624
640
|
* @param image The image blob to process
|
|
@@ -1239,7 +1255,7 @@ export declare const registerPersonWithoutFace: (personData: {
|
|
|
1239
1255
|
/**
|
|
1240
1256
|
* Data de lançamento da versão atual
|
|
1241
1257
|
*/
|
|
1242
|
-
export declare const RELEASE_DATE = "2026-09-
|
|
1258
|
+
export declare const RELEASE_DATE = "2026-09-02";
|
|
1243
1259
|
|
|
1244
1260
|
declare interface RequestChallengeWithSessionParams {
|
|
1245
1261
|
applicationToken: string;
|
|
@@ -1286,6 +1302,15 @@ export declare function requestPasswordReset(email: string, applicationToken: st
|
|
|
1286
1302
|
|
|
1287
1303
|
export declare function resetCaptureSession(): void;
|
|
1288
1304
|
|
|
1305
|
+
declare interface ResolvedTheme {
|
|
1306
|
+
mode: ThemeMode;
|
|
1307
|
+
tokens: ThemeTokens;
|
|
1308
|
+
radius: 8 | 16 | 24;
|
|
1309
|
+
accent: string;
|
|
1310
|
+
/** True quando o `accent` do integrador foi rejeitado por contraste. */
|
|
1311
|
+
accentFellBack: boolean;
|
|
1312
|
+
}
|
|
1313
|
+
|
|
1289
1314
|
/**
|
|
1290
1315
|
* Orquestra o fluxo completo:
|
|
1291
1316
|
* 1. Abre `capture/session`
|
|
@@ -1319,6 +1344,12 @@ declare interface SDKConfig {
|
|
|
1319
1344
|
applicationToken: string | null;
|
|
1320
1345
|
environment: Environment | 'custom';
|
|
1321
1346
|
initialized: boolean;
|
|
1347
|
+
appName: string | null;
|
|
1348
|
+
accent: string | null;
|
|
1349
|
+
radius: SDKRadius;
|
|
1350
|
+
theme: SDKTheme;
|
|
1351
|
+
locale: string;
|
|
1352
|
+
resolvedTheme: ResolvedTheme | null;
|
|
1322
1353
|
}
|
|
1323
1354
|
|
|
1324
1355
|
/**
|
|
@@ -1340,8 +1371,42 @@ export declare interface SDKInitOptions {
|
|
|
1340
1371
|
* Obtido através do painel administrativo do NeoFaceID.
|
|
1341
1372
|
*/
|
|
1342
1373
|
applicationToken?: string;
|
|
1374
|
+
/**
|
|
1375
|
+
* Nome do integrador — mostrado no topo dos modais do SDK ("Banco Exemplo" >
|
|
1376
|
+
* NeoFaceID). Obrigatório na prática: omitir gera `console.warn` e cai para o
|
|
1377
|
+
* fallback "sua aplicação".
|
|
1378
|
+
*/
|
|
1379
|
+
appName?: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* Cor de acento do integrador. Pinta APENAS o preenchimento do botão primário.
|
|
1382
|
+
* Nunca o anel de captura, o arco de desafio, os colchetes Focus Frame, os
|
|
1383
|
+
* glifos ou o selo de resultado — o visor precisa ser idêntico em toda parte
|
|
1384
|
+
* para que uma tela falsa não engane.
|
|
1385
|
+
*
|
|
1386
|
+
* Validado em runtime: contraste vs `#FFFFFF` < 4.5 = fallback para `#0059C4`
|
|
1387
|
+
* + `console.warn`. É segurança, não gosto.
|
|
1388
|
+
*/
|
|
1389
|
+
accent?: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* Raio base dos containers. Restrito aos três raios do sistema: 8, 16 ou 24.
|
|
1392
|
+
* Padrão 16. Valor fora dos três permitidos = `console.warn` + fallback 16.
|
|
1393
|
+
*/
|
|
1394
|
+
radius?: SDKRadius;
|
|
1395
|
+
/**
|
|
1396
|
+
* Modo do tema para a superfície dos modais. Padrão `light`. `auto` respeita
|
|
1397
|
+
* `prefers-color-scheme`. O visor de captura é sempre escuro nos dois modos.
|
|
1398
|
+
*/
|
|
1399
|
+
theme?: SDKTheme;
|
|
1400
|
+
/**
|
|
1401
|
+
* Locale da UI. Padrão `pt-BR`.
|
|
1402
|
+
*/
|
|
1403
|
+
locale?: string;
|
|
1343
1404
|
}
|
|
1344
1405
|
|
|
1406
|
+
export declare type SDKRadius = 8 | 16 | 24;
|
|
1407
|
+
|
|
1408
|
+
export declare type SDKTheme = 'light' | 'dark' | 'auto';
|
|
1409
|
+
|
|
1345
1410
|
/**
|
|
1346
1411
|
* Session data interface for external integrations
|
|
1347
1412
|
*/
|
|
@@ -1476,6 +1541,24 @@ export declare interface SubmitLivenessChallengeParams {
|
|
|
1476
1541
|
gestures: GestureResponse[];
|
|
1477
1542
|
}
|
|
1478
1543
|
|
|
1544
|
+
declare type ThemeMode = 'light' | 'dark';
|
|
1545
|
+
|
|
1546
|
+
/** Tokens semânticos por tema — o que os componentes consomem. */
|
|
1547
|
+
declare interface ThemeTokens {
|
|
1548
|
+
ground: string;
|
|
1549
|
+
surface: string;
|
|
1550
|
+
surfaceMuted: string;
|
|
1551
|
+
line: string;
|
|
1552
|
+
text: string;
|
|
1553
|
+
textMuted: string;
|
|
1554
|
+
textSubtle: string;
|
|
1555
|
+
action: string;
|
|
1556
|
+
actionText: string;
|
|
1557
|
+
accent: string;
|
|
1558
|
+
overlay: string;
|
|
1559
|
+
focusRing: string;
|
|
1560
|
+
}
|
|
1561
|
+
|
|
1479
1562
|
/**
|
|
1480
1563
|
* Result of user existence check
|
|
1481
1564
|
*/
|
|
@@ -1512,7 +1595,7 @@ export declare const validateToken: (applicationToken: string) => Promise<boolea
|
|
|
1512
1595
|
* MINOR: Incrementado quando adicionamos funcionalidades mantendo compatibilidade
|
|
1513
1596
|
* PATCH: Incrementado quando corrigimos bugs mantendo compatibilidade
|
|
1514
1597
|
*/
|
|
1515
|
-
export declare const VERSION = "1.
|
|
1598
|
+
export declare const VERSION = "1.30.0";
|
|
1516
1599
|
|
|
1517
1600
|
/**
|
|
1518
1601
|
* Executa `fn(sessionId)`. Se o servidor devolver 410 (sessão consumida/expirada),
|