@voltom.io/sdk 1.0.3 → 1.0.5

package/dist/sdk/facegate.js

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2026 VOLTOM. All rights reserved. Proprietary software. See LICENSE at https://voltom.io/license. */
+import{O as e,Y as t,et as n,l as r,n as i,nt as a,r as o,t as s}from"./eyeLevelCamera-DY4onSBz.js";import{D as c,a as l,c as u,d,g as f,h as p,i as m,p as h,s as g,t as _,u as v}from"./media-BRKPXpu3.js";import{n as y}from"./facekey.browser-CVJiBw1f.js";var b=()=>({active:a(!1),phase:a(`idle`),prompt:a(``),completed:a(0),total:a(1),outcome:a(null),captures:a([])}),x=e=>{if(typeof e.clientKey!=`string`||e.clientKey.length<8||e.requireEyeLevelCamera!==void 0&&typeof e.requireEyeLevelCamera!=`boolean`)throw Error(p.INVALID_OPTIONS);return{...e,requireEyeLevelCamera:e.requireEyeLevelCamera??!1}},S=e=>{if(typeof e.action!=`string`||e.action.length<1||e.action.length>255||typeof e.onPass!=`function`||typeof e.onReject!=`function`)throw Error(p.INVALID_OPTIONS);return e},C=e=>{if(typeof e!=`string`||e.length<32||e.length>128)throw Error(p.INVALID_SERVICE_RESPONSE);return e},{detectPictureFaces:w,loadFaceDetector:T}=y,E=3e4,D=e=>new Promise(t=>setTimeout(t,e)),O=async({frame:t,neutral:n,pose:a,requireEyeLevelCamera:c})=>{let l=await w(t,{blendshapes:!0}),u=l.length===1?l[0]:null;if(!u)return{alignment:null,code:null,prompt:`faceNotFound`,ready:!1};let d={pitch:u.pitch,yaw:u.yaw,roll:u.roll},f=u.boundingRect.height/Math.min(t.width,t.height),p=u.boundingRect.x+u.boundingRect.width/2,m=u.boundingRect.y+u.boundingRect.height/2,h=Math.hypot(p-t.width/2,m-t.height/2)<=Math.min(t.width,t.height)*.12;if(f<.5)return{alignment:d,code:null,prompt:`faceTooSmall`,ready:!1};if(!h)return{alignment:d,code:null,prompt:`centerFace`,ready:!1};let g=i({pitch:u.pitch,pose:a,requireEyeLevelCamera:c,options:e});if(g)return{alignment:d,code:g,prompt:s(),ready:!1};let _=o({alignment:d,blendshapes:u.blendshapes,neutral:n,pose:a,options:e});if(_.code){let e=r({pose:a,code:_.code});return{alignment:d,code:_.code,prompt:e.corrective??e.primary,ready:!1}}return{alignment:d,code:null,prompt:r({pose:a,code:null}).primary,ready:!0}},k=class{options;display=b();handles=new Set;controller=null;view=null;prepared=!1;running=!1;disposed=!1;constructor(e){this.options=Object.freeze(x(e))}async caniuse(){return await _()}async prepare(){if(this.disposed)throw Error(p.SDK_NOT_READY);if(!this.prepared){if(await h({language:this.options.language}),await t({filenames:[`fd.ort`,`fe.ort`,`fl.ort`,`fmu.ort`,`ort-wasm-simd-threaded.mjs`,`ort-wasm-simd-threaded.wasm`]}),this.disposed)throw Error(p.SDK_NOT_READY);if(await T({faceDetector:`standard`}),!this.view){let{createFaceGateView:e}=await import(`./view-Bfg8u_hZ.js`);if(this.disposed)throw Error(p.SDK_NOT_READY);this.view=e({options:this.options,display:this.display,onCancel:()=>this.stop()})}if(this.disposed)throw Error(p.SDK_NOT_READY);this.prepared=!0}}arm(e,t){if(this.disposed||!this.prepared)throw Error(p.SDK_NOT_READY);let n=S(t),r,i=()=>{this.runGate(r)};return r={control:e,options:n,detach:()=>e.removeEventListener(`click`,i)},e.addEventListener(`click`,i),this.handles.add(r),r}disarm(e){e.detach(),this.handles.delete(e)}async request({path:e,body:t,signal:n}){let r=await fetch(`${(this.options.apiUrl??`https://api.voltom.io`).replace(/\/$/,``)}/facegate/${e}`,{method:`POST`,headers:{authorization:`Bearer ${this.options.clientKey}`,"content-type":`application/json`},body:JSON.stringify(t),signal:n}),i=await r.json().catch(()=>null);if(!r.ok)throw Error(typeof i?.code==`string`?i.code:p.INVALID_SERVICE_RESPONSE);return i}async capture({video:e,poses:t,signal:i}){let{translate:a}=d({language:this.options.language}),o=[],s=null;for(let[c,u]of t.entries()){let t=0;for(n(()=>{this.display.phase.value=`capturing`,this.display.completed.value=c,this.display.prompt.value=a(r({pose:u,code:null}).primary)});t<3;){await v({video:e,signal:i}),i.throwIfAborted();let n=await createImageBitmap(e);try{let e=await O({frame:n,neutral:s,pose:u,requireEyeLevelCamera:this.options.requireEyeLevelCamera??!1});if(i.throwIfAborted(),t=e.ready?t+1:0,this.display.prompt.value=a(e.prompt),u===`faceStraight`&&e.ready&&(s=e.alignment),t>=3){let e=await m({frame:n});o.push(await l({image:e}))}}finally{n.close()}}this.display.completed.value=c+1}return o}async runGate(e){if(this.disposed||this.running)return;this.running=!0;let t=new AbortController;this.controller=t;let r=t.signal,i=e.options,a=()=>t.abort(new DOMException(p.FACEGATE_ABORTED,`AbortError`)),o=setTimeout(()=>t.abort(new DOMException(p.FACEGATE_TIMEOUT,`TimeoutError`)),E);i.signal?.addEventListener(`abort`,a,{once:!0}),i.signal?.aborted&&t.abort();let s=null;n(()=>{this.display.active.value=!0,this.display.phase.value=`capturing`,this.display.outcome.value=null,this.display.completed.value=0,this.display.total.value=1,this.display.prompt.value=``}),this.view?.open();try{let e=this.view?.video;if(!e)throw Error(p.INVALID_OPTIONS);await g({facingMode:`user`,video:e,signal:r}),r.throwIfAborted();let t=await Promise.all([i.subjectId?.(),i.context?.()]),n=await this.request({path:`challenge`,body:{action:i.action,subjectId:t[0],context:t[1]},signal:r});s=C(n.token),this.display.total.value=n.poses.length;let a=await this.capture({video:e,poses:n.poses,signal:r});r.throwIfAborted(),this.display.phase.value=`checking`,this.display.prompt.value=d({language:this.options.language}).translate(`checkingFaceMatch`);let o=await this.request({path:`verify`,body:{token:n.token,poses:n.poses,faces:a},signal:r});this.display.outcome.value=o.outcome,this.display.phase.value=o.outcome===`pass`?`pass`:`reject`,this.display.prompt.value=``,await D(950),this.view?.close(),o.outcome===`pass`?await i.onPass(n.token):i.onReject({outcome:o.outcome,code:o.code})}catch(e){let t=r.aborted?f({error:r.reason,fallback:p.FACEGATE_ABORTED}):f({error:e,fallback:p.SERVICE_UNAVAILABLE});if(t!==p.FACEGATE_ABORTED&&(this.display.outcome.value=`error`,this.display.phase.value=`reject`,this.display.prompt.value=``,await D(950)),this.view?.close(),s)try{await this.request({path:`abort`,body:{token:s,code:t},signal:AbortSignal.timeout(1e4)})}catch{}i.onReject({outcome:`error`,code:t})}finally{clearTimeout(o),i.signal?.removeEventListener(`abort`,a);let e=this.view?.video;e&&u({video:e}),this.display.active.value=!1,this.controller=null,this.running=!1}}stop(){this.controller&&this.controller.abort(new DOMException(p.FACEGATE_ABORTED,`AbortError`))}dispose(){if(!this.disposed){this.disposed=!0,this.stop();for(let e of this.handles)e.detach();this.handles.clear(),this.view?.close()}}getState(){return{active:this.display.active.value,phase:this.display.phase.value,prompt:this.display.prompt.value,completed:this.display.completed.value,total:this.display.total.value,outcome:this.display.outcome.value}}};c({moduleUrl:import.meta.url});var A=k;export{k as VoltomFaceGate,A as default};

package/dist/sdk/facekey.browser-CVJiBw1f.js

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2026 VOLTOM. All rights reserved. Proprietary software. See LICENSE at https://voltom.io/license. */
+import{V as e,g as t,h as n,m as r,p as i,z as a}from"./eyeLevelCamera-DY4onSBz.js";var o=e({runtime:a}),s=r({runtime:a}),c=t({runtime:a}),l=n({runtime:a,imageFromImageBitmap:o}),u=i({runtime:a,...s,...c,...l,faceDetection:l});export{l as n,u as r,c as t};

package/dist/sdk/facekey.d.ts

@@ -1,4 +1,4 @@
-export type FaceKeyOperation = "enroll" | "unlock" | "forget";
+export type FaceKeyOperation = "enroll" | "unlock";
 
 export type FaceKeyPose = "faceStraight" | "faceUp" | "faceLeft" | "faceRight" | "faceSmile";
 
@@ -11,12 +11,15 @@ export type FaceKeyUnlock = {
   reason: string | null;
 };
 
-export type FaceKeyCapability = "enroll" | "unlock" | "forget";
+export type FaceKeyCapability = FaceKeyOperation;
+
+export type VoltomBrowserSupport = { supported: boolean; unsupportedFeatures: string[] };
 
 export type FaceKeyOperationOptions = { signal?: AbortSignal; debug?: boolean };
 
 export type VoltomFaceKeyOptions = {
   clientKey: string;
+  requireEyeLevelCamera?: boolean;
   apiUrl?: string;
   debug?: boolean;
   language?: "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "zh";
@@ -28,20 +31,12 @@ export type VoltomFaceKeyOptions = {
 export type FaceKeyIdentity = { userId: string };
 
 export type FaceKeyInstruction = {
-  pose: FaceKeyPose;
-  rejection:
-    | "FACEKEY_LOWER_HEAD"
-    | "FACEKEY_LOWER_HEAD_LESS"
-    | "FACEKEY_RAISE_HEAD"
-    | "FACEKEY_RAISE_HEAD_LESS"
-    | "FACEKEY_TILT_HEAD_LEFT"
-    | "FACEKEY_TILT_HEAD_LESS"
-    | "FACEKEY_TILT_HEAD_RIGHT"
-    | "FACEKEY_TURN_HEAD_LEFT"
-    | "FACEKEY_TURN_HEAD_LESS"
-    | "FACEKEY_TURN_HEAD_RIGHT"
-    | "FACEKEY_SMILE_REQUIRED"
-    | "FACEKEY_WINK_LEFT_REQUIRED"
+  framing:
+    | "FACE_NOT_DETECTED"
+    | "FACE_IN_POLYGON"
+    | "FACE_TOO_SMALL"
+    | "FACE_NOT_CENTERED"
+    | "FACE_CAMERA_ALIGNMENT_REQUIRED"
     | null;
   retry: string | null;
 };
@@ -59,10 +54,11 @@ export type VoltomFaceKeyState = {
 
 export declare class VoltomFaceKey {
   constructor(options: VoltomFaceKeyOptions);
+  preload(): Promise<void>;
   prepare(): Promise<void>;
+  caniuse(): Promise<VoltomBrowserSupport>;
   faceEnroll(input: FaceKeyInput, options?: FaceKeyOperationOptions): Promise<FaceKeyIdentity>;
   faceUnlock(input: FaceKeyInput & { userId: string }, options?: FaceKeyOperationOptions): Promise<FaceKeyUnlock>;
-  faceForget(input: FaceKeyInput & { userId: string }, options?: FaceKeyOperationOptions): Promise<FaceKeyIdentity>;
   stop(): void;
   dispose(): void;
   getState(): VoltomFaceKeyState;