@voltom.io/sdk 1.0.4 → 1.0.6

package/dist/sdk/facegate.js

@@ -1,2 +1,2 @@
 /*! Copyright (c) 2026 VOLTOM. All rights reserved. Proprietary software. See LICENSE at https://voltom.io/license. */
-import{E as e,Q as t,et as n,q as r,s as i,t as a}from"./poseGuidance-DLg3Dm3T.js";import{E as o,a as s,f as c,h as l,i as u,l as d,m as f,o as p,s as m,t as h,u as g}from"./media-KU3CWepq.js";import{n as _}from"./facekey.browser-D_vfob8H.js";var v=()=>({active:n(!1),phase:n(`idle`),prompt:n(``),completed:n(0),total:n(1),outcome:n(null),captures:n([])}),y=e=>{if(typeof e.clientKey!=`string`||e.clientKey.length<8)throw Error(f.INVALID_OPTIONS);return e},b=e=>{if(typeof e.action!=`string`||e.action.length<1||e.action.length>255||typeof e.onPass!=`function`||typeof e.onReject!=`function`)throw Error(f.INVALID_OPTIONS);return e},x=e=>{if(typeof e!=`string`||e.length<32||e.length>128)throw Error(f.INVALID_SERVICE_RESPONSE);return e},{detectPictureFaces:S,loadFaceDetector:C}=_,w=3e4,T=e=>new Promise(t=>setTimeout(t,e)),E=async({frame:t,neutral:n,pose:r})=>{let o=await S(t,{blendshapes:!0}),s=o.length===1?o[0]:null;if(!s)return{alignment:null,code:null,prompt:`faceNotFound`,ready:!1};let c={pitch:s.pitch,yaw:s.yaw,roll:s.roll},l=s.boundingRect.height/Math.min(t.width,t.height),u=s.boundingRect.x+s.boundingRect.width/2,d=s.boundingRect.y+s.boundingRect.height/2,f=Math.hypot(u-t.width/2,d-t.height/2)<=Math.min(t.width,t.height)*.12;if(l<.5)return{alignment:c,code:null,prompt:`faceTooSmall`,ready:!1};if(!f)return{alignment:c,code:null,prompt:`centerFace`,ready:!1};let p=a({alignment:c,blendshapes:s.blendshapes,neutral:n,pose:r,options:e});if(p.code){let e=i({pose:r,code:p.code});return{alignment:c,code:p.code,prompt:e.corrective??e.primary,ready:!1}}return{alignment:c,code:null,prompt:i({pose:r,code:null}).primary,ready:!0}},D=class{options;display=v();handles=new Set;controller=null;view=null;prepared=!1;running=!1;disposed=!1;constructor(e){this.options=Object.freeze(y(e))}async caniuse(){return await h()}async prepare(){if(this.disposed)throw Error(f.SDK_NOT_READY);if(!this.prepared){if(await c({language:this.options.language}),await r({filenames:[`fd.ort`,`fe.ort`,`fl.ort`,`fmu.ort`,`ort-wasm-simd-threaded.mjs`,`ort-wasm-simd-threaded.wasm`]}),this.disposed)throw Error(f.SDK_NOT_READY);if(await C({faceDetector:`standard`}),!this.view){let{createFaceGateView:e}=await import(`./view-WiNYUW9A.js`);if(this.disposed)throw Error(f.SDK_NOT_READY);this.view=e({options:this.options,display:this.display,onCancel:()=>this.stop()})}if(this.disposed)throw Error(f.SDK_NOT_READY);this.prepared=!0}}arm(e,t){if(this.disposed||!this.prepared)throw Error(f.SDK_NOT_READY);let n=b(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:f.INVALID_SERVICE_RESPONSE);return i}async capture({video:e,poses:n,signal:r}){let{translate:a}=g({language:this.options.language}),o=[],c=null;for(let[l,f]of n.entries()){let n=0;for(t(()=>{this.display.phase.value=`capturing`,this.display.completed.value=l,this.display.prompt.value=a(i({pose:f,code:null}).primary)});n<3;){await d({video:e,signal:r}),r.throwIfAborted();let t=await createImageBitmap(e);try{let e=await E({frame:t,neutral:c,pose:f});if(r.throwIfAborted(),n=e.ready?n+1:0,this.display.prompt.value=a(e.prompt),f===`faceStraight`&&!c&&e.ready&&(c=e.alignment),n>=3){let e=await u({frame:t});o.push(await s({image:e}))}}finally{t.close()}}this.display.completed.value=l+1}return o}async runGate(e){if(this.disposed||this.running)return;this.running=!0;let n=new AbortController;this.controller=n;let r=n.signal,i=e.options,a=()=>n.abort(new DOMException(f.FACEGATE_ABORTED,`AbortError`)),o=setTimeout(()=>n.abort(new DOMException(f.FACEGATE_TIMEOUT,`TimeoutError`)),w);i.signal?.addEventListener(`abort`,a,{once:!0}),i.signal?.aborted&&n.abort();let s=null;t(()=>{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(f.INVALID_OPTIONS);await p({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=x(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=g({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 T(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?l({error:r.reason,fallback:f.FACEGATE_ABORTED}):l({error:e,fallback:f.SERVICE_UNAVAILABLE});if(t!==f.FACEGATE_ABORTED&&(this.display.outcome.value=`error`,this.display.phase.value=`reject`,this.display.prompt.value=``,await T(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&&m({video:e}),this.display.active.value=!1,this.controller=null,this.running=!1}}stop(){this.controller&&this.controller.abort(new DOMException(f.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}}};o({moduleUrl:import.meta.url});var O=D;export{D as VoltomFaceGate,O as default};
+import{E as e,Q as t,et as n,l as r,n as i,q as a,r as o,t as s}from"./eyeLevelCamera-aDRPs63K.js";import{O as c,_ as l,a as u,c as d,f,g as p,i as m,m as h,s as g,t as _,u as v}from"./media-Cejmtltt.js";import{n as y}from"./facekey.browser-bs8vp3ON.js";var b=()=>({active:n(!1),phase:n(`idle`),prompt:n(``),completed:n(0),total:n(1),outcome:n(null),captures:n([])}),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.authorize!=`function`||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;preparing=null;prepared=!1;running=!1;disposed=!1;constructor(e){let{prepare:t=!0,...n}=e;this.options=Object.freeze(x(n)),t&&this.prepare().catch(e=>console.error(e))}async caniuse(){return await _()}async prepare(){if(this.disposed)throw Error(p.SDK_NOT_READY);if(this.prepared)return;if(this.preparing)return this.preparing;let e=(async()=>{if(await h({language:this.options.language}),await a({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-iMF-mWfw.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})();this.preparing=e;try{await e}finally{this.preparing===e&&(this.preparing=null)}}arm(e,t){if(this.disposed)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:n,signal:i}){let{translate:a}=f({language:this.options.language}),o=[],s=null;for(let[c,l]of n.entries()){let n=0;for(t(()=>{this.display.phase.value=`capturing`,this.display.completed.value=c,this.display.prompt.value=a(r({pose:l,code:null}).primary)});n<3;){await v({video:e,signal:i}),i.throwIfAborted();let t=await createImageBitmap(e);try{let e=await O({frame:t,neutral:s,pose:l,requireEyeLevelCamera:this.options.requireEyeLevelCamera??!1});if(i.throwIfAborted(),n=e.ready?n+1:0,this.display.prompt.value=a(e.prompt),l===`faceStraight`&&e.ready&&(s=e.alignment),n>=3){let e=await m({frame:t});o.push(await u({image:e}))}}finally{t.close()}}this.display.completed.value=c+1}return o}async runGate(e){if(this.disposed||this.running)return;this.running=!0;let n=e.options;try{await this.prepare()}catch(e){this.running=!1;let t=l({error:e,fallback:p.SERVICE_UNAVAILABLE});n.onReject({outcome:`error`,reason:t});return}let r=new AbortController;this.controller=r;let i=r.signal,a=()=>r.abort(new DOMException(p.FACEGATE_ABORTED,`AbortError`)),o=setTimeout(()=>r.abort(new DOMException(p.FACEGATE_TIMEOUT,`TimeoutError`)),E);n.signal?.addEventListener(`abort`,a,{once:!0}),n.signal?.aborted&&r.abort(),t(()=>{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:i}),i.throwIfAborted();let t=await Promise.all([n.subjectId?.(),n.metadata?.()]),r=await n.authorize({action:n.action,subjectId:t[0],metadata:t[1]});if(!r.poses?.length)throw Error(p.INVALID_OPTIONS);C(r.token),this.display.total.value=r.poses.length;let a=await this.capture({video:e,poses:r.poses,signal:i});i.throwIfAborted(),this.display.phase.value=`checking`,this.display.prompt.value=f({language:this.options.language}).translate(`checkingFaceMatch`);let o=await this.request({path:`verify`,body:{token:r.token,poses:r.poses,faces:a},signal:i});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 n.onPass({resultId:o.resultId}):n.onReject({outcome:o.outcome,reason:o.reason})}catch(e){let t=i.aborted?l({error:i.reason,fallback:p.FACEGATE_ABORTED}):l({error:e,fallback:p.SERVICE_UNAVAILABLE});t!==p.FACEGATE_ABORTED&&(this.display.outcome.value=`error`,this.display.phase.value=`reject`,this.display.prompt.value=``,await D(950)),this.view?.close(),n.onReject({outcome:`error`,reason:t})}finally{clearTimeout(o),n.signal?.removeEventListener(`abort`,a);let e=this.view?.video;e&&d({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-bs8vp3ON.js

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

package/dist/sdk/facekey.d.ts

@@ -1,54 +1,63 @@
-export type FaceKeyOperation = "enroll" | "unlock";
+export type Language = "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "ru" | "zh";
 
-export type FaceKeyPose = "faceStraight" | "faceUp" | "faceLeft" | "faceRight" | "faceSmile";
+export type Theme = "light" | "dark";
 
-export type FaceKeyInput = { token: string; userId?: string };
+export type VoltomBrowserSupport = { supported: boolean; unsupportedFeatures: string[] };
 
-export type FaceKeyUnlock = {
-  userId: string;
-  matched: boolean;
-  matches: { pose: FaceKeyPose; matched: boolean; score: number }[];
-  reason: string | null;
-};
+export type FaceKeyOperation = "enroll" | "unlock";
 
 export type FaceKeyCapability = FaceKeyOperation;
 
+export type FaceKeyPose = "faceStraight" | "faceUp" | "faceLeft" | "faceRight" | "faceSmile";
+
 export type FaceKeyOperationOptions = { signal?: AbortSignal; debug?: boolean };
 
 export type VoltomFaceKeyOptions = {
   clientKey: string;
+  prepare?: boolean;
+  requireEyeLevelCamera?: boolean;
   apiUrl?: string;
   debug?: boolean;
-  language?: "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "zh";
+  language?: Language;
+  theme?: Theme;
   capabilities?: FaceKeyCapability[];
-  ui?: boolean;
-  video?: HTMLVideoElement;
 };
 
-export type FaceKeyIdentity = { userId: string };
+export type FaceKeyIntent = {
+  resultId: string;
+  token: string;
+  action: FaceKeyOperation;
+  subjectId: string;
+  poses: FaceKeyPose[];
+  expiresAt: string;
+};
+
+export type FaceKeyInput = FaceKeyIntent;
+
+export type FaceKeyIdentity = { subjectId: string };
+
+export type FaceKeyUnlock = {
+  subjectId: string;
+  matched: boolean;
+  matches: { pose: FaceKeyPose; matched: boolean; score: number }[];
+  reason: string | null;
+};
+
+export type FaceKeyFramingRejection =
+  | "FACE_NOT_DETECTED"
+  | "FACE_IN_POLYGON"
+  | "FACE_TOO_SMALL"
+  | "FACE_NOT_CENTERED"
+  | "FACE_CAMERA_ALIGNMENT_REQUIRED";
 
 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"
-    | null;
+  framing: FaceKeyFramingRejection | null;
   retry: string | null;
 };
 
 export type VoltomFaceKeyState = {
   operation: FaceKeyOperation;
-  phase: "loading" | "capturing" | "checking" | "processing" | "success" | "failure";
+  phase: "loading" | "capturing" | "processing" | "success" | "failure";
   instruction: FaceKeyInstruction | null;
   progress: { completed: number; total: number };
   feedback: { matched: boolean; animating: boolean } | null;
@@ -59,9 +68,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>;
+  faceUnlock(input: FaceKeyInput & { subjectId: string }, options?: FaceKeyOperationOptions): Promise<FaceKeyUnlock>;
   stop(): void;
   dispose(): void;
   getState(): VoltomFaceKeyState;