@voltom.io/sdk 1.0.6 → 1.0.7

package/dist/sdk/errors.d.ts

@@ -0,0 +1,121 @@
+export declare const Errors: {
+  INTENT_TOKEN_INVALID: "INTENT_TOKEN_INVALID";
+  FACEKEY_ALREADY_ENROLLED: "FACEKEY_ALREADY_ENROLLED";
+  FACEKEY_NOT_ENROLLED: "FACEKEY_NOT_ENROLLED";
+  FACEKEY_VERSION_MISMATCH: "FACEKEY_VERSION_MISMATCH";
+  FACEKEY_KEY_UNAVAILABLE: "FACEKEY_KEY_UNAVAILABLE";
+  FACEKEY_TEMPLATE_INVALID: "FACEKEY_TEMPLATE_INVALID";
+  OPERATION_CANCELLED: "OPERATION_CANCELLED";
+  OPERATION_TIMEOUT: "OPERATION_TIMEOUT";
+  CLIENT_KEY_REQUIRED: "CLIENT_KEY_REQUIRED";
+  API_KEY_FORBIDDEN: "API_KEY_FORBIDDEN";
+  CAMERA_INTERRUPTED: "CAMERA_INTERRUPTED";
+  CAMERA_NOT_FOUND: "CAMERA_NOT_FOUND";
+  CAMERA_PERMISSION_DENIED: "CAMERA_PERMISSION_DENIED";
+  CAMERA_UNAVAILABLE: "CAMERA_UNAVAILABLE";
+  CAMERA_UNSUPPORTED: "CAMERA_UNSUPPORTED";
+  CAPTURES_INCOMPLETE: "CAPTURES_INCOMPLETE";
+  CLIENT_ASSET_NOT_FOUND: "CLIENT_ASSET_NOT_FOUND";
+  CLIENT_NOT_AVAILABLE: "CLIENT_NOT_AVAILABLE";
+  CONTACT_RATE_LIMITED: "CONTACT_RATE_LIMITED";
+  DOCUMENT_BACK_CONTAINS_FACE: "DOCUMENT_BACK_CONTAINS_FACE";
+  DOCUMENT_BACK_NOT_DISTINCT: "DOCUMENT_BACK_NOT_DISTINCT";
+  DOCUMENT_BACK_REQUIRED: "DOCUMENT_BACK_REQUIRED";
+  DOCUMENT_BLURRY: "DOCUMENT_BLURRY";
+  DOCUMENT_CODE_TYPE_MISMATCH: "DOCUMENT_CODE_TYPE_MISMATCH";
+  DOCUMENT_FACE_GEOMETRY_INVALID: "DOCUMENT_FACE_GEOMETRY_INVALID";
+  DOCUMENT_FACE_NOT_CONTAINED: "DOCUMENT_FACE_NOT_CONTAINED";
+  DOCUMENT_FACE_NOT_FOUND: "DOCUMENT_FACE_NOT_FOUND";
+  DOCUMENT_NOT_FOUND: "DOCUMENT_NOT_FOUND";
+  DOCUMENT_NOT_RECOGNIZED: "DOCUMENT_NOT_RECOGNIZED";
+  DOCUMENT_TEXT_ALIGNMENT_INVALID: "DOCUMENT_TEXT_ALIGNMENT_INVALID";
+  DOCUMENT_TEXT_NOT_READABLE: "DOCUMENT_TEXT_NOT_READABLE";
+  DOCUMENT_VALIDATION_FAILED: "DOCUMENT_VALIDATION_FAILED";
+  EMAIL_ALREADY_REGISTERED: "EMAIL_ALREADY_REGISTERED";
+  EMAIL_DELIVERY_FAILED: "EMAIL_DELIVERY_FAILED";
+  EUROPEAN_LICENCE_BACK_MARKER_REQUIRED: "EUROPEAN_LICENCE_BACK_MARKER_REQUIRED";
+  FACE_AGE_MISMATCH: "FACE_AGE_MISMATCH";
+  FACE_ALIGNMENT_FAILED: "FACE_ALIGNMENT_FAILED";
+  FACE_ATTRIBUTES_UNAVAILABLE: "FACE_ATTRIBUTES_UNAVAILABLE";
+  FACE_GENDER_MISMATCH: "FACE_GENDER_MISMATCH";
+  FACE_LIGHTING_INVALID: "FACE_LIGHTING_INVALID";
+  FACE_MISMATCH: "FACE_MISMATCH";
+  FACE_NOT_FOUND: "FACE_NOT_FOUND";
+  FACE_NOT_STABLE: "FACE_NOT_STABLE";
+  FACE_NOT_USABLE: "FACE_NOT_USABLE";
+  FACE_OUT_OF_FRAME: "FACE_OUT_OF_FRAME";
+  FACE_POSE_INVALID: "FACE_POSE_INVALID";
+  FACE_SPOOF_DETECTED: "FACE_SPOOF_DETECTED";
+  GEO_DATABASE_DOWNLOAD_EMPTY: "GEO_DATABASE_DOWNLOAD_EMPTY";
+  GEO_DATABASE_DOWNLOAD_FAILED: "GEO_DATABASE_DOWNLOAD_FAILED";
+  IMAGE_DECODE_FAILED: "IMAGE_DECODE_FAILED";
+  IMAGE_ENCODE_FAILED: "IMAGE_ENCODE_FAILED";
+  IMAGE_PROCESSING_FAILED: "IMAGE_PROCESSING_FAILED";
+  IMAGE_TOO_LARGE: "IMAGE_TOO_LARGE";
+  INFERENCE_FAILED: "INFERENCE_FAILED";
+  INFERENCE_QUEUE_FULL: "INFERENCE_QUEUE_FULL";
+  INFERENCE_TIMEOUT: "INFERENCE_TIMEOUT";
+  VALIDATION_ERROR: "VALIDATION_ERROR";
+  RESPONSE_VALIDATION_ERROR: "RESPONSE_VALIDATION_ERROR";
+  RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
+  RESOURCE_NOT_FOUND_IN_VIEW: "RESOURCE_NOT_FOUND_IN_VIEW";
+  REQUEST_TOO_LARGE: "REQUEST_TOO_LARGE";
+  INTERNAL_ERROR: "INTERNAL_ERROR";
+  INVALID_CREDENTIALS: "INVALID_CREDENTIALS";
+  BILLING_DETAILS_REQUIRED: "BILLING_DETAILS_REQUIRED";
+  PAYMENT_METHOD_NOT_FOUND: "PAYMENT_METHOD_NOT_FOUND";
+  PAYMENT_NOT_FOUND: "PAYMENT_NOT_FOUND";
+  RECOVERY_SENT: "RECOVERY_SENT";
+  INVALID_DOCUMENT_AAMVA: "INVALID_DOCUMENT_AAMVA";
+  INVALID_DOCUMENT_MRZ: "INVALID_DOCUMENT_MRZ";
+  INVALID_FACE_MATCH_INPUT: "INVALID_FACE_MATCH_INPUT";
+  INVALID_IMAGE: "INVALID_IMAGE";
+  INVALID_KEY_LABEL: "INVALID_KEY_LABEL";
+  INVALID_MODEL_OUTPUT: "INVALID_MODEL_OUTPUT";
+  INVALID_OPTIONS: "INVALID_OPTIONS";
+  INVALID_PASSPORT_MRZ: "INVALID_PASSPORT_MRZ";
+  INVALID_POSES: "INVALID_POSES";
+  INVALID_CLIENT_KEY: "INVALID_CLIENT_KEY";
+  INVALID_REGISTRATION: "INVALID_REGISTRATION";
+  INVALID_SERVICE_RESPONSE: "INVALID_SERVICE_RESPONSE";
+  INVALID_VERIFICATION_FEEDBACK: "INVALID_VERIFICATION_FEEDBACK";
+  INVALID_VERIFICATION_INPUT: "INVALID_VERIFICATION_INPUT";
+  KEY_NOT_FOUND: "KEY_NOT_FOUND";
+  MODEL_LOAD_FAILED: "MODEL_LOAD_FAILED";
+  MULTIPLE_FACES: "MULTIPLE_FACES";
+  NETWORK_ERROR: "NETWORK_ERROR";
+  NO_USABLE_CANDIDATES: "NO_USABLE_CANDIDATES";
+  NO_USABLE_REFERENCES: "NO_USABLE_REFERENCES";
+  OCR_DICTIONARY_MISMATCH: "OCR_DICTIONARY_MISMATCH";
+  OCR_ENVIRONMENT_MISMATCH: "OCR_ENVIRONMENT_MISMATCH";
+  OCR_LANGUAGE_UNSUPPORTED: "OCR_LANGUAGE_UNSUPPORTED";
+  OCR_MODEL_UNSUPPORTED: "OCR_MODEL_UNSUPPORTED";
+  PAYMENT_FAILED: "PAYMENT_FAILED";
+  BILLING_ACCOUNT_BLOCKED: "BILLING_ACCOUNT_BLOCKED";
+  ACCOUNT_HAS_UNBILLED_USAGE: "ACCOUNT_HAS_UNBILLED_USAGE";
+  POSE_IDENTITY_MISMATCH: "POSE_IDENTITY_MISMATCH";
+  POSE_BACKGROUND_MISMATCH: "POSE_BACKGROUND_MISMATCH";
+  SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
+  SUPERADMIN_REQUIRED: "SUPERADMIN_REQUIRED";
+  UI_ELEMENT_NOT_FOUND: "UI_ELEMENT_NOT_FOUND";
+  UNAUTHORIZED: "UNAUTHORIZED";
+  USER_ACCESS_REQUIRED: "USER_ACCESS_REQUIRED";
+  USER_NOT_FOUND: "USER_NOT_FOUND";
+  VERIFICATION_SAVE_FAILED: "VERIFICATION_SAVE_FAILED";
+  INVALID_PDF: "INVALID_PDF";
+  PDF_LOAD_FAILED: "PDF_LOAD_FAILED";
+  PDF_PASSWORD_REQUIRED: "PDF_PASSWORD_REQUIRED";
+  SDK_CAPABILITY_NOT_CONFIGURED: "SDK_CAPABILITY_NOT_CONFIGURED";
+  SDK_DISPOSED: "SDK_DISPOSED";
+  OPERATION_IN_PROGRESS: "OPERATION_IN_PROGRESS";
+  AUTHORIZATION_FAILED: "AUTHORIZATION_FAILED";
+};
+
+export type ErrorCode = (typeof Errors)[keyof typeof Errors];
+export type VoltomSdkError = Error & {
+  name: "VoltomSdkError";
+  code: ErrorCode;
+  status?: number;
+  resultId?: string;
+};
+export declare const isSdkError: (error: unknown) => error is VoltomSdkError;

package/dist/sdk/facegate.d.ts

@@ -1,3 +1,7 @@
+import type { ErrorCode, Errors, isSdkError, VoltomSdkError } from "./errors.js";
+
+export { type ErrorCode, Errors, isSdkError, type VoltomSdkError } from "./errors.js";
+
 export type Language = "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "ru" | "zh";
 
 export type Theme = "light" | "dark";
@@ -10,17 +14,20 @@ export type FaceGateOutcome = "pass" | "fail" | "error";
 
 export type VoltomFaceGateOptions = {
   clientKey: string;
+  authorize: (input: FaceGateAuthorizeInput) => Promise<FaceGateAuthorizedIntent>;
   prepare?: boolean;
+  debug?: boolean;
   requireEyeLevelCamera?: boolean;
   apiUrl?: string;
-  debug?: boolean;
+  sdkUrl?: string;
   language?: Language;
   theme?: Theme;
 };
 
-export type FaceGateReject = {
-  outcome: "fail" | "error";
-  reason: string | null;
+export type FaceGateCheckResult = {
+  resultId: string;
+  outcome: "pass" | "fail";
+  reason: ErrorCode | null;
 };
 
 export type FaceGateAuthorizeInput = { action: string; subjectId?: string; metadata?: string };
@@ -33,23 +40,19 @@ export type FaceGateAuthorizedIntent = {
   poses?: FaceGatePose[];
 };
 
-export type FaceGateArmOptions = {
+export type FaceGateAssertionGender = "female" | "male" | "any";
+
+export type FaceGateCheckOptions = {
   action: string;
-  subjectId?: () => Promise<string>;
-  metadata?: () => Promise<string>;
-  authorize: (input: FaceGateAuthorizeInput) => Promise<FaceGateAuthorizedIntent>;
-  onPass: (input: { resultId: string }) => void | Promise<void>;
-  onReject: (reject: FaceGateReject) => void;
+  subjectId?: string;
+  metadata?: string;
+  gender?: FaceGateAssertionGender;
+  age?: [number, number];
   signal?: AbortSignal;
 };
 
-export type FaceGateHandle = {
-  control: HTMLElement;
-  options: FaceGateArmOptions;
-  detach: () => void;
-};
-
 export type FaceGateState = {
+  error: VoltomSdkError | null;
   active: boolean;
   phase: "idle" | "capturing" | "checking" | "pass" | "reject";
   prompt: string;
@@ -59,11 +62,14 @@ export type FaceGateState = {
 };
 
 export declare class VoltomFaceGate {
+  static Errors: typeof Errors;
+  static isSdkError: typeof isSdkError;
   constructor(options: VoltomFaceGateOptions);
+  preload(): Promise<void>;
   prepare(): Promise<void>;
   caniuse(): Promise<VoltomBrowserSupport>;
-  arm(control: HTMLElement, options: FaceGateArmOptions): FaceGateHandle;
-  disarm(handle: FaceGateHandle): void;
+  check(options: FaceGateCheckOptions): Promise<FaceGateCheckResult>;
+  setDebug({ enabled }: { enabled: boolean }): void;
   stop(): void;
   dispose(): void;
   getState(): FaceGateState;