@voltom.io/sdk 1.0.5 → 1.0.7

package/dist/sdk/verify.d.ts

@@ -1,6 +1,9 @@
-export type Mode = "hard";
+import type { ErrorCode, Errors, isSdkError, VoltomSdkError } from "./errors.js";
+
+export { type ErrorCode, Errors, isSdkError, type VoltomSdkError } from "./errors.js";
 
 export type Pose =
+  | "faceReference"
   | "faceStraight"
   | "faceUp"
   | "faceDown"
@@ -11,7 +14,9 @@ export type Pose =
   | "faceTiltLeft"
   | "faceTiltRight";
 
-export type Language = "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "zh";
+export type Language = "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "ru" | "zh";
+
+export type Theme = "light" | "dark";
 
 export type OcrEngine =
   | "auto"
@@ -25,28 +30,39 @@ export type OcrEngine =
 
 export type FaceDetectorName = "high" | "standard" | "low";
 
-export type VerificationCapability = "verifyHuman" | "verifyDocument" | "matchID" | "matchPicture";
+export type VerificationCapability = "acquireFace" | "acquireDocument" | "acquireReference" | "matchID" | "matchReference";
+
+export type VerificationAction = "verify_face" | "verify_document" | "match_id" | "match_reference";
+
+export type AuthorizedVerifyIntent = {
+  resultId: string;
+  token: string;
+  expiresAt: string;
+  action: string;
+};
 
-export type VerificationOperationOptions = {
+export type VerificationConfiguration = {
   poses?: Pose[] | "all";
   randomizeFaceSequence?: boolean;
   showFaceOverlay?: boolean;
   showDocumentOverlay?: boolean;
   showTextOverlay?: boolean;
   debug?: boolean;
-  signal?: AbortSignal;
 };
 
 export type VoltomOptions = {
-  root?: HTMLElement;
   video?: HTMLVideoElement;
   ui?: boolean;
+  prepare?: boolean;
   language?: Language;
+  theme?: Theme;
   ocrEngine?: OcrEngine;
   faceDetector?: FaceDetectorName;
   clientKey: string;
+  authorize?: (input: { action: string }) => Promise<AuthorizedVerifyIntent>;
   requireEyeLevelCamera?: boolean;
   apiUrl?: string;
+  sdkUrl?: string;
   threshold?: number;
   poses?: Pose[] | "all";
   randomizeFaceSequence?: boolean;
@@ -79,13 +95,24 @@ export type VoltomOptions = {
   capabilities?: VerificationCapability[];
 };
 
+export type VoltomReferenceCandidate = { portrait: Blob; pose: { yaw: number; pitch: number; roll: number } };
+
+export type VoltomReference = {
+  digest: string;
+  portrait: Blob;
+  pose: { yaw: number; pitch: number; roll: number };
+  candidates?: VoltomReferenceCandidate[];
+  poseGroups?: { candidateIndices: number[]; pose: { yaw: number; pitch: number; roll: number } }[];
+  picture?: Blob;
+};
+
 export type VoltomBrowserSupport = { supported: boolean; unsupportedFeatures: string[] };
 
-export type VoltomCaptures = Partial<Record<Pose | "documentFront" | "documentBack", Blob>>;
+export type VoltomCaptures = Partial<Record<Pose | `faceReference_${number}` | "documentFront" | "documentBack" | "reference", Blob>>;
 
 export type FaceImages = { rgb: Blob; greyscale: Blob };
 
-export type VoltomPreparedCaptures = Partial<Record<keyof VoltomCaptures | "picture", FaceImages>>;
+export type VoltomPreparedCaptures = Partial<Record<keyof VoltomCaptures, FaceImages>>;
 
 export type IdentityPayload = {
   document: {
@@ -118,6 +145,8 @@ export type IdentityPayload = {
   raw_data: { mrz_lines: string[]; aamva_version: string | null };
 };
 
+export type VoltomIdentity = Omit<IdentityPayload, "raw_data">;
+
 export type DocumentCode = { code: string; payload: IdentityPayload; type: "mrz" | "aamva" | "ocr" };
 
 export type OcrLine = {
@@ -150,23 +179,22 @@ export type VoltomCaptureResult = {
 };
 
 export type VoltomVerificationResult = {
-  verificationId: string;
-  mode: Mode;
-  flow: "human" | "document" | "match_id" | "match_picture";
-  outcome: "completed" | "failed";
-  matched: boolean | null;
+  resultId: string;
+  action: VerificationAction;
+  outcome: "pass" | "fail";
+  matched: boolean;
   score: number | null;
   threshold: number | null;
-  reason: string | null;
-  code: string | null;
-  identity: IdentityPayload | null;
+  reason: ErrorCode | null;
+  documentCode: string | null;
+  identity: VoltomIdentity | null;
   completedAt: string | null;
   createdAt: string;
 };
 
 export type VerificationPresentationState = {
   activity: { message: string } | "matching" | null;
-  error: unknown | null;
+  error: VoltomSdkError | null;
   retryAvailable: boolean;
   feedback:
     | { flow: "face"; pose: Pose; code: string | null }
@@ -176,16 +204,24 @@ export type VerificationPresentationState = {
 };
 
 declare class VoltomVerify {
+  static Errors: typeof Errors;
+  static isSdkError: typeof isSdkError;
+  events: EventTarget;
   constructor(options: VoltomOptions);
+  preload(): Promise<void>;
   prepare(): Promise<void>;
   caniuse(): Promise<VoltomBrowserSupport>;
-  verifyHuman(settings?: VerificationOperationOptions): Promise<VoltomVerificationResult>;
-  verifyDocument(settings?: VerificationOperationOptions): Promise<VoltomVerificationResult>;
-  matchID(settings?: VerificationOperationOptions): Promise<VoltomVerificationResult>;
+  configure(options: VerificationConfiguration): void;
+  acquireReference(file: Blob): Promise<VoltomReference>;
+  forgetReference(): void;
+  acquireFace(): Promise<VoltomVerificationResult>;
+  acquireDocument(): Promise<VoltomVerificationResult>;
+  matchID(): Promise<VoltomVerificationResult>;
   /** Accepts images or PDFs up to 10 MB. PDFs use only page 1, rendered at up to 1200 pixels. */
-  matchPicture(picture: Blob, settings?: VerificationOperationOptions): Promise<VoltomVerificationResult>;
-  forgetHuman(): void;
+  matchReference(file: Blob): Promise<VoltomVerificationResult>;
+  forgetFace(): void;
   forgetDocument(): void;
+  setDebug({ enabled }: { enabled: boolean }): void;
   stop(): void;
   dispose(): void;
   getState(): VerificationPresentationState;