@microblink/biometrics 1000.0.0

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@microblink/biometrics",
+  "version": "1000.0.0",
+  "author": "Microblink",
+  "type": "module",
+  "main": "./dist/biometrics.js",
+  "module": "./dist/biometrics.js",
+  "description": "Biometrics browser SDK for guided and headless face capture.",
+  "keywords": [],
+  "files": [
+    "dist",
+    "types"
+  ],
+  "peerDependencies": {
+    "@ark-ui/solid": "^5.38.1",
+    "solid-js": "^1.9.14",
+    "solid-zustand": "^2.0.0"
+  },
+  "dependencies": {
+    "@microblink/biometrics-core": "1000.0.0",
+    "@microblink/biometrics-ux-manager": "1000.0.0",
+    "@microblink/camera-manager": "^8.1.0"
+  },
+  "access": "public",
+  "types": "./types/index.rollup.d.ts",
+  "homepage": "https://github.com/microblink/web-sdks",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microblink/web-sdks.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.rollup.d.ts",
+      "import": "./dist/biometrics.js"
+    },
+    "./package.json": "./package.json"
+  }
+}

package/types/index.rollup.d.ts

@@ -0,0 +1,376 @@
+import { BiometricsDiagnosticCallback, BiometricsDiagnosticCallback as BiometricsDiagnosticCallback$1, BiometricsDiagnosticComponent, BiometricsDiagnosticEvent, BiometricsDiagnosticPhase, BiometricsDiagnosticResource, BiometricsDiagnosticStatus, BiometricsError, BiometricsError as BiometricsError$1, BiometricsErrorCode, BiometricsErrorComponent, BiometricsErrorOptions, BiometricsErrorStage, BiometricsFace, BiometricsResourceKind, BiometricsResourceKind as CaptureBiometricsResourceKind, BiometricsSupportCheck, BiometricsSupportCheckId, BiometricsSupportCheckStatus, BiometricsSupportReport, BrowserStorageSupport, CaptureFaceConfig, CaptureFaceConfig as CaptureFaceConfig$1, CaptureFrame, CaptureLogLevel, CaptureSessionState, CaptureSignature, CapturedImage, CheckBiometricsSupportOptions, ConfigurationError, DerivedDeviceInfo, DeviceInfo, DeviceScreenInfo, FaceAnalysisSessionSettings, FaceCaptureResult, FaceCaptureResult as FaceCaptureResult$1, FaceLandmarks, FaceLandmarks as FaceLandmarks$1, FormFactor, GpuInfo, ImageOrigin, LicenseError, LivenessFrame, LivenessFrameQuality, PermissionError, SessionError, UADataValues, UnifiedFeedback, UnifiedFeedback as UnifiedFeedback$1, WasmVariant, WasmVariant as WasmVariant$1, checkBiometricsSupport, createDerivedDeviceInfo, getBiometricsFaceFromCaptureResult, getDeviceInfo, getUserAgentData, isFaceCaptureResult, normalizeBiometricsError } from "@microblink/biometrics-core";
+import { FeedbackUiOptions, LocaleRecord, LocalizationStrings, PartialLocalizationStrings } from "@microblink/biometrics-ux-manager/ui";
+import { CameraManagerUiOptions } from "@microblink/camera-manager/ui";
+//#region ../analytics/types/ping/ping.browser.device.info.d.ts
+type PingBrowserDeviceInfoData = {
+  userAgentData?: UserAgentData;
+  userAgent: string;
+  threads: number;
+  memory?: number;
+  gpu?: Gpu;
+  screen: Screen;
+  browserStorageSupport: BrowserStorageSupport$1;
+  derivedDeviceInfo: DerivedDeviceInfo$1;
+};
+type UserAgentData = {
+  brands?: BrandsItem[];
+  mobile?: boolean;
+  platform?: string;
+  architecture?: string;
+  bitness?: string;
+  formFactors?: FormFactorsItem[];
+  model?: string;
+  platformVersion?: string;
+  fullVersionList?: FullVersionListItem[];
+  wow64?: boolean;
+};
+type Gpu = {
+  renderer: string;
+  shadingLanguageVersion: string;
+  vendor: string;
+  version: string;
+};
+type Screen = {
+  screenWidth: number;
+  screenHeight: number;
+  devicePixelRatio: number;
+  physicalScreenWidth: number;
+  physicalScreenHeight: number;
+  maxTouchPoints: number;
+};
+type BrowserStorageSupport$1 = {
+  cookieEnabled: boolean;
+  localStorageEnabled: boolean;
+};
+type DerivedDeviceInfo$1 = {
+  model: string;
+  formFactors: FormFactorsItem[];
+  platform: string;
+  browser: Browser;
+};
+type BrandsItem = {
+  brand: string;
+  version: string;
+};
+type FullVersionListItem = {
+  brand: string;
+  version: string;
+};
+type Browser = {
+  brand: string;
+  version: string;
+};
+type FormFactorsItem = "Desktop" | "Automotive" | "Mobile" | "Tablet" | "XR" | "EInk" | "Watch";
+/** Ping type for ping.browser.device.info */
+type PingBrowserDeviceInfo = PingBase<"ping.browser.device.info", "1.0.0", PingBrowserDeviceInfoData>;
+//#endregion
+//#region ../analytics/types/ping/ping.error.d.ts
+type PingErrorData = {
+  errorType: ErrorType;
+  errorMessage: string;
+  stackTrace?: string;
+};
+type ErrorType = "NonFatal" | "Crash";
+/** Ping type for ping.error */
+type PingError = PingBase<"ping.error", "1.0.0", PingErrorData>;
+//#endregion
+//#region ../analytics/types/ping/ping.hardware.camera.info.d.ts
+type PingCameraHardwareInfoData = {
+  availableCameras: AvailableCamerasItem[];
+};
+type AvailableCamerasItem = {
+  deviceId: string;
+  cameraFacing: CameraFacing$1;
+  focus?: Focus;
+  availableResolutions?: AvailableResolutionsItem[];
+};
+type AvailableResolutionsItem = {
+  width: number;
+  height: number;
+};
+type CameraFacing$1 = "Front" | "Back" | "Unknown";
+type Focus = "Auto" | "Fixed";
+/** Ping type for ping.hardware.camera.info */
+type PingCameraHardwareInfo = PingBase<"ping.hardware.camera.info", "1.0.3", PingCameraHardwareInfoData>;
+//#endregion
+//#region ../analytics/types/ping/ping.log.d.ts
+type PingLogData = {
+  logLevel: LogLevel;
+  logMessage: string;
+};
+type LogLevel = "Info" | "Warning";
+/** Ping type for ping.log */
+type PingLog = PingBase<"ping.log", "1.0.0", PingLogData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.camera.input.info.d.ts
+type PingCameraInputInfoData = {
+  deviceId: string;
+  cameraFacing: CameraFacing;
+  cameraFrameWidth: number;
+  cameraFrameHeight: number;
+  roiWidth: number;
+  roiHeight: number;
+  viewPortAspectRatio: number;
+};
+type CameraFacing = "Front" | "Back" | "Unknown";
+/** Ping type for ping.sdk.camera.input.info */
+type PingCameraInputInfo = PingBase<"ping.sdk.camera.input.info", "1.0.2", PingCameraInputInfoData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.camera.permission.d.ts
+type PingCameraPermissionData = {
+  eventType: EventType$2;
+  cameraPermissionGranted?: boolean;
+};
+type EventType$2 = "CameraPermissionCheck" | "CameraPermissionRequest" | "CameraPermissionUserResponse";
+/** Ping type for ping.sdk.camera.permission */
+type PingCameraPermission = PingBase<"ping.sdk.camera.permission", "1.0.0", PingCameraPermissionData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.init.start.d.ts
+type PingSdkInitStartData = {
+  product: Product;
+  platform: Platform;
+  platformDetails?: PlatformDetails;
+  packageName: string;
+  userId: string;
+  pingProxyEnabled: boolean;
+  baltazarProxyEnabled: boolean;
+};
+type Product = "BlinkCard" | "BlinkID" | "BlinkInput" | "Capture" | "DocumentVerification" | "Pdf417Mobi" | "PhotoPay" | "Biometrics";
+type Platform = "iOS" | "Android" | "Emscripten" | "MacOS" | "Linux" | "Windows";
+type PlatformDetails = "simd" | "simd-threads" | "simd-relaxed" | "simd-relaxed-threads" | "lightweight-simd" | "lightweight-simd-threads" | "lightweight-simd-relaxed" | "lightweight-simd-relaxed-threads";
+/** Ping type for ping.sdk.init.start */
+type PingSdkInitStart = PingBase<"ping.sdk.init.start", "3.0.0", PingSdkInitStartData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.scan.conditions.d.ts
+type PingScanningConditionsData = {
+  updateType: UpdateType;
+  deviceOrientation?: DeviceOrientation;
+  flashlightOn?: boolean;
+};
+type UpdateType = "DeviceOrientation" | "FlashlightState";
+type DeviceOrientation = "Portrait" | "LandscapeRight" | "LandscapeLeft" | "PortraitUpside";
+/** Ping type for ping.sdk.scan.conditions */
+type PingScanningConditions = PingBase<"ping.sdk.scan.conditions", "1.0.0", PingScanningConditionsData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.upload.d.ts
+type PingUploadData = {
+  sessionId: string;
+  eventType: EventType$1;
+  durationMs?: number;
+  payloadBytes?: number;
+  errorCategory?: string;
+  retryCount?: number;
+};
+type EventType$1 = "Initialized" | "Completed" | "Failed" | "RetryInitialized" | "Cancelled";
+/** Ping type for ping.sdk.upload */
+type PingUpload = PingBase<"ping.sdk.upload", "1.0.0", PingUploadData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.ux.event.d.ts
+type PingUxEventData = {
+  eventType: EventType;
+  errorMessageType?: ErrorMessageType;
+  alertType?: AlertType;
+  helpCloseType?: HelpCloseType;
+  cameraFailureCategory?: string;
+  closeReason?: CloseReason;
+};
+type EventType = "CameraStarted" | "CameraClosed" | "OnboardingInfoDisplayed" | "CloseButtonClicked" | "HelpTooltipDisplayed" | "HelpOpened" | "HelpClosed" | "AlertDisplayed" | "ErrorMessage" | "StepTimeout" | "AppMovedToBackground" | "InactivityTimeout" | "UnsupportedBarcodeTimeout" | "CameraOpenFailed" | "FaceCaptureScreenDisplayed";
+type ErrorMessageType = "MoveCloser" | "MoveFarther" | "KeepVisible" | "FlipSide" | "AlignDocument" | "MoveFromEdge" | "IncreaseLighting" | "DecreaseLighting" | "EliminateBlur" | "EliminateGlare";
+type AlertType = "InvalidLicenseKey" | "NetworkError" | "DocumentClassNotAllowed" | "StepTimeout" | "DocumentNotSupported" | "InactivityTimeout" | "UnsupportedBarcodeTimeout";
+type HelpCloseType = "ContentSkipped" | "ContentFullyViewed";
+type CloseReason = "User" | "Sdk" | "SystemError";
+/** Ping type for ping.sdk.ux.event */
+type PingUxEvent = PingBase<"ping.sdk.ux.event", "1.3.0", PingUxEventData>;
+//#endregion
+//#region ../analytics/types/ping/ping.sdk.wrapper.product.d.ts
+type PingWrapperProductInfoData = {
+  wrapperProduct: WrapperProduct;
+  correlationId?: string;
+};
+type WrapperProduct = "CrossplatformFlutter" | "CrossplatformReactNative" | "IdentityVerification";
+/** Ping type for ping.sdk.wrapper.product */
+type PingWrapperProductInfo = PingBase<"ping.sdk.wrapper.product", "1.0.0", PingWrapperProductInfoData>;
+//#endregion
+//#region ../analytics/types/ping/Ping.d.ts
+type Ping = PingBrowserDeviceInfo | PingError | PingCameraHardwareInfo | PingLog | PingCameraInputInfo | PingCameraPermission | PingSdkInitStart | PingScanningConditions | PingUpload | PingUxEvent | PingWrapperProductInfo;
+type SchemaName = Ping["schemaName"];
+//#endregion
+//#region ../analytics/types/ping/ping.base.d.ts
+type Semver = `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}`;
+/** Generated base structure for a ping event. */
+interface PingBase<TSchemaName extends SchemaName, TSchemaVersion extends Semver = "1.0.0", TData extends object = {}, TSessionNumber extends number = number> {
+  schemaName: TSchemaName;
+  schemaVersion: TSchemaVersion;
+  data: TData;
+  sessionNumber?: TSessionNumber;
+}
+//#endregion
+//#region types/types.d.ts
+type BiometricsCaptureSettings = {
+  imageOrigin?: ImageOrigin;
+  logLevel?: CaptureLogLevel;
+  faceAnalysis?: FaceAnalysisSessionSettings;
+};
+type BiometricsAnalyticsSettings = {
+  enabled?: boolean;
+  pingProxyUrl?: string;
+  userId?: string;
+};
+/** Progress reported while SDK resources are downloaded. */
+type DownloadProgress = {
+  loaded: number;
+  contentLength: number;
+  progress: number;
+  finished: boolean;
+};
+type ProgressStatusCallback = (progress: DownloadProgress) => void;
+type BiometricsAnalyticsEvent = Ping extends (infer Event) ? Event extends {
+  sessionNumber?: number;
+} ? Omit<Event, "sessionNumber"> : never : never;
+/** Session-scoped access to the native analytics transport. */
+type BiometricsSessionContext = {
+  readonly sessionId: string;
+  readonly traceId: string;
+  readonly sessionNumber: number;
+  report(event: BiometricsAnalyticsEvent): Promise<void>;
+  flush(): Promise<void>;
+};
+/** Root SDK settings for face capture. */
+type BiometricsSettings = {
+  licenseKey: string;
+  resourcesLocation?: string;
+  /** WebAssembly module variant to use. Defaults to automatic feature detection. */
+  wasmVariant?: WasmVariant$1;
+  /** Maximum initialization duration in milliseconds. @default 60000 */
+  initializationTimeoutMs?: number;
+  capture?: BiometricsCaptureSettings;
+  analytics?: BiometricsAnalyticsSettings;
+  onDiagnostic?: BiometricsDiagnosticCallback$1;
+  /** Optional callback for WASM and data-file download progress. */
+  onDownloadProgress?: ProgressStatusCallback;
+};
+/** Per-session face capture options. */
+type BiometricsSessionConfig = {
+  /** Capture timeout in milliseconds. Set to `null` to disable. @default 60000 */
+  captureTimeoutMs?: number | null;
+  /** Additional capture session and attempt options. */
+  captureFace?: Omit<CaptureFaceConfig$1, "timeoutMs" | "onFeedbackChange" | "onStateChange" | "onCapture" | "onTimeout" | "onError" | "onAnalysisResult"> & {
+    /** Native quality thresholds fixed for this session and reused by every capture attempt. */
+    thresholds?: FaceAnalysisSessionSettings;
+  };
+};
+/** Events surfaced by {@link BiometricsSession}. */
+type BiometricsSessionEvent = {
+  kind: "faceGuidance";
+  feedback: UnifiedFeedback$1;
+} | {
+  kind: "captureTechnicalData";
+  data: CaptureTechnicalData;
+} | {
+  kind: "captureFinished";
+  result: FaceCaptureResult$1;
+} | {
+  kind: "captureTimeout";
+};
+type BiometricsUiEvent = BiometricsSessionEvent | {
+  kind: "ux";
+  name: "onboardingShown" | "onboardingClosed" | "helpOpened" | "helpClosed";
+};
+type CaptureTechnicalData = {
+  normalizedFaceBounds?: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  };
+  landmarks?: FaceLandmarks$1;
+  inputImageSize?: {
+    width: number;
+    height: number;
+  };
+  frameNumber?: number;
+};
+type BiometricsSessionState = {
+  phase: "idle";
+} | {
+  phase: "capturing";
+  capture: {
+    sessionState: CaptureSessionState;
+    feedback: UnifiedFeedback$1;
+    technicalData?: CaptureTechnicalData;
+  };
+} | {
+  phase: "failed";
+  stage: "capture";
+  error: BiometricsError$1;
+} | {
+  phase: "succeeded";
+  result: FaceCaptureResult$1;
+} | {
+  phase: "finished";
+};
+/** Headless session for one face capture. */
+type BiometricsSession = {
+  getState(): BiometricsSessionState;
+  subscribe(listener: (state: BiometricsSessionState) => void): () => void;
+  /** Feed camera frames while {@link BiometricsSession.run} is in progress. */
+  processFrame(imageData: ImageData): Promise<ArrayBuffer>;
+  /** Set the camera source used by subsequent capture attempts. */
+  setCameraSource(videoElement: HTMLVideoElement | undefined, track: MediaStreamTrack | undefined): void;
+  /** Pauses or resumes the active capture attempt's timeout. */
+  setCaptureTimeoutPaused(paused: boolean): void;
+  /** Starts face capture. */
+  run(): Promise<FaceCaptureResult$1>;
+  retry(): Promise<FaceCaptureResult$1>;
+  onEvent(listener: (event: BiometricsSessionEvent) => void): () => void;
+  onError(listener: (error: BiometricsError$1) => void): () => void;
+  onDiagnostic(listener: BiometricsDiagnosticCallback$1): () => void;
+  getSessionContext(): Promise<BiometricsSessionContext>;
+  finish(): void;
+};
+/** Initialized Biometrics capture SDK instance. */
+type BiometricsSdk = {
+  /** Creates a face capture session. */
+  startSession(config?: BiometricsSessionConfig): BiometricsSession;
+  close(): Promise<void>;
+};
+type BiometricsFeedbackUiOptions = Pick<FeedbackUiOptions, "localizationStrings" | "showHelpButton"> & {
+  showOnboardingGuide?: boolean;
+  helpTooltipShowDelay?: number | null;
+};
+type BiometricsUiOptions = {
+  licenseKey: string;
+  targetNode?: HTMLElement;
+  cameraManagerUiOptions?: Partial<CameraManagerUiOptions>;
+  preferredCameraDeviceId?: string;
+  /** Called whenever the selected camera changes. */
+  onSelectedCameraDeviceIdChange?: (deviceId: string | undefined) => void;
+  resourcesLocation?: string;
+  /** WebAssembly module variant to use. Defaults to automatic feature detection. */
+  wasmVariant?: WasmVariant$1;
+  /** Maximum SDK initialization duration in milliseconds. @default 60000 */
+  initializationTimeoutMs?: number;
+  capture?: BiometricsCaptureSettings;
+  analytics?: BiometricsAnalyticsSettings;
+  /** Capture timeout in milliseconds. Set to `null` to disable. @default 60000 */
+  captureTimeoutMs?: number | null;
+  captureFace?: BiometricsSessionConfig["captureFace"];
+  feedbackUiOptions?: BiometricsFeedbackUiOptions;
+  onEvent?: (event: BiometricsUiEvent) => void;
+  onResult?: (result: FaceCaptureResult$1) => void;
+  onError?: (error: BiometricsError$1) => void;
+  onDiagnostic?: BiometricsDiagnosticCallback$1;
+};
+type BiometricsUi = {
+  destroy(): Promise<void>;
+};
+//#endregion
+//#region types/createBiometrics.d.ts
+export declare function createBiometrics(settings: BiometricsSettings): Promise<BiometricsSdk>;
+//#endregion
+//#region types/createBiometricsUi.d.ts
+export declare function createBiometricsUi(options: BiometricsUiOptions): Promise<BiometricsUi>;
+//#endregion
+export { type BiometricsAnalyticsEvent, type BiometricsAnalyticsSettings, type BiometricsCaptureSettings, type BiometricsDiagnosticCallback, type BiometricsDiagnosticComponent, type BiometricsDiagnosticEvent, type BiometricsDiagnosticPhase, type BiometricsDiagnosticResource, type BiometricsDiagnosticStatus, BiometricsError, type BiometricsErrorCode, type BiometricsErrorComponent, type BiometricsErrorOptions, type BiometricsErrorStage, type BiometricsFace, type BiometricsFeedbackUiOptions, type BiometricsResourceKind, type BiometricsSdk, type BiometricsSession, type BiometricsSessionConfig, type BiometricsSessionContext, type BiometricsSessionEvent, type BiometricsSessionState, type BiometricsSettings, type BiometricsSupportCheck, type BiometricsSupportCheckId, type BiometricsSupportCheckStatus, type BiometricsSupportReport, type BiometricsUi, type BiometricsUiEvent, type BiometricsUiOptions, type BrowserStorageSupport, type CaptureBiometricsResourceKind, type CaptureFaceConfig, type CaptureFrame, type CaptureSignature, type CaptureTechnicalData, type CapturedImage, type CheckBiometricsSupportOptions, ConfigurationError, type DerivedDeviceInfo, type DeviceInfo, type DeviceScreenInfo, type DownloadProgress, type FaceCaptureResult, type FaceLandmarks, type FormFactor, type GpuInfo, LicenseError, type LivenessFrame, type LivenessFrameQuality, type LocaleRecord, type LocalizationStrings, type PartialLocalizationStrings, PermissionError, type ProgressStatusCallback, SessionError, type UADataValues, type UnifiedFeedback, type WasmVariant, checkBiometricsSupport, createDerivedDeviceInfo, getBiometricsFaceFromCaptureResult, getDeviceInfo, getUserAgentData, isFaceCaptureResult, normalizeBiometricsError };
+
+export {};