@simprints/simface-sdk 0.4.1 → 0.6.1

package/dist/types/index.d.ts

@@ -0,0 +1,61 @@
+/** Configuration for the SimFace SDK. */
+export interface SimFaceConfig {
+    /** Base URL of the SimFace API backend. */
+    apiUrl: string;
+    /** Unique identifier for the project. */
+    projectId: string;
+    /** API key for authentication. */
+    apiKey: string;
+}
+/** Result of an enrollment operation. */
+export interface EnrollResult {
+    success: boolean;
+    clientId: string;
+    message?: string;
+    /** True if the user was already enrolled and verification is needed instead. */
+    alreadyEnrolled?: boolean;
+}
+/** Result of a verification operation. */
+export interface VerifyResult {
+    match: boolean;
+    score: number;
+    threshold: number;
+    message?: string;
+    /** True if the user was not found and enrollment is needed instead. */
+    notEnrolled?: boolean;
+}
+/** Result of API key validation. */
+export interface ValidateResult {
+    valid: boolean;
+    projectId: string;
+    name: string;
+}
+/** Face quality assessment result from MediaPipe. */
+export type FaceFeedbackCode = 'no-face' | 'multiple-faces' | 'too-far' | 'too-close' | 'move-left' | 'move-right' | 'move-up' | 'move-down' | 'turn-left' | 'turn-right' | 'face-unclear' | 'good';
+export interface FaceQualityResult {
+    hasFace: boolean;
+    faceCount: number;
+    confidence: number;
+    captureScore: number;
+    isCentered: boolean;
+    passesQualityChecks: boolean;
+    feedback: FaceFeedbackCode;
+    message: string;
+}
+/** Events emitted by the SimFace capture component. */
+export interface SimFaceCaptureEvents {
+    /** Fired when a face image is captured and quality-checked. */
+    'simface-captured': CustomEvent<{
+        imageBlob: Blob;
+    }>;
+    /** Fired when the user cancels the capture flow. */
+    'simface-cancelled': CustomEvent<void>;
+    /** Fired when an error occurs during capture. */
+    'simface-error': CustomEvent<{
+        error: string;
+    }>;
+}
+/** API error response from the backend. */
+export interface APIError {
+    error: string;
+}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simprints/simface-sdk",
-  "version": "0.4.1",
+  "version": "0.6.1",
   "simprints:releaseMajorVersion": "0",
   "description": "SimFace facial recognition SDK for web-based KYC workflows",
   "type": "module",