@voltom.io/sdk 1.0.3 → 1.0.5

package/dist/sdk/facegate/global.d.ts

@@ -0,0 +1,5 @@
+import type VoltomFaceGateType from "./facegate.d.ts";
+
+declare global {
+  var VoltomFaceGate: typeof VoltomFaceGateType;
+}

package/dist/sdk/facegate.d.ts

@@ -0,0 +1,55 @@
+export type FaceGatePose = "faceStraight" | "faceUp" | "faceLeft" | "faceRight" | "faceSmile";
+
+export type FaceGateOutcome = "pass" | "fail" | "error";
+
+export type VoltomBrowserSupport = { supported: boolean; unsupportedFeatures: string[] };
+
+export type VoltomFaceGateOptions = {
+  clientKey: string;
+  requireEyeLevelCamera?: boolean;
+  apiUrl?: string;
+  debug?: boolean;
+  language?: "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "zh";
+};
+
+export type FaceGateReject = {
+  outcome: "fail" | "error";
+  code: string | null;
+};
+
+export type FaceGateArmOptions = {
+  action: string;
+  subjectId?: () => Promise<string>;
+  context?: () => Promise<string>;
+  onPass: (token: string) => void | Promise<void>;
+  onReject: (reject: FaceGateReject) => void;
+  signal?: AbortSignal;
+};
+
+export type FaceGateHandle = {
+  control: HTMLElement;
+  options: FaceGateArmOptions;
+  detach: () => void;
+};
+
+export type FaceGateState = {
+  active: boolean;
+  phase: "idle" | "capturing" | "checking" | "pass" | "reject";
+  prompt: string;
+  completed: number;
+  total: number;
+  outcome: FaceGateOutcome | null;
+};
+
+export declare class VoltomFaceGate {
+  constructor(options: VoltomFaceGateOptions);
+  prepare(): Promise<void>;
+  caniuse(): Promise<VoltomBrowserSupport>;
+  arm(control: HTMLElement, options: FaceGateArmOptions): FaceGateHandle;
+  disarm(handle: FaceGateHandle): void;
+  stop(): void;
+  dispose(): void;
+  getState(): FaceGateState;
+}
+
+export default VoltomFaceGate;