@incodetech/core 2.0.0-alpha.8 → 2.0.0-rc.0

package/dist/deepsightService-CEVxzehb.d.ts

@@ -0,0 +1,412 @@
+import { n as WasmPipeline } from "./warmup-CEcppFiS.js";
+import { t as CameraStream } from "./camera-DBSxa6ML.js";
+
+//#region ../infra/src/capabilities/IRecordingCapability.d.ts
+type RecordingPublisher = {
+  getStreamId: () => string | undefined;
+  replaceVideoTrack: (track: MediaStreamTrack) => Promise<void>;
+  destroy: () => void;
+};
+type RecordingConnection = {
+  sessionId: string | undefined;
+  publisher: RecordingPublisher;
+  disconnect: () => Promise<void>;
+};
+type RecordingConnectionEvents = {
+  onSessionConnected?: (sessionId: string | undefined) => void;
+  onSessionDisconnected?: (sessionId: string | undefined) => void;
+  onSessionException?: (params: {
+    name?: string;
+    message?: string;
+    sessionId?: string;
+  }) => void;
+  onPublisherCreated?: (params: {
+    streamId?: string;
+    sessionId?: string;
+  }) => void;
+  onPublisherError?: (params: {
+    message?: string;
+    sessionId?: string;
+    streamId?: string;
+  }) => void;
+};
+type ConnectRecordingParams = {
+  sessionToken: string;
+  stream: MediaStream;
+  events?: RecordingConnectionEvents;
+};
+type IRecordingCapability = {
+  /**
+   * Connects to a recording session and publishes the provided media stream.
+   * Returns a connection handle that can be disconnected and used to manage the publisher.
+   */
+  connect: (params: ConnectRecordingParams) => Promise<RecordingConnection>;
+};
+//#endregion
+//#region ../infra/src/capabilities/IStorageCapability.d.ts
+/**
+ * Storage capability interface for abstracting storage operations.
+ * Enables swapping between browser localStorage and future WASM-based storage.
+ */
+interface IStorageCapability {
+  /**
+   * Retrieves a value from storage.
+   * @param key - The storage key
+   * @returns The stored value or null if not found
+   */
+  get<T>(key: string): Promise<T | null>;
+  /**
+   * Stores a value in storage.
+   * @param key - The storage key
+   * @param value - The value to store (will be serialized)
+   */
+  set<T>(key: string, value: T): Promise<void>;
+  /**
+   * Removes a value from storage.
+   * @param key - The storage key to remove
+   */
+  remove(key: string): Promise<void>;
+  /**
+   * Clears all values from storage.
+   */
+  clear(): Promise<void>;
+}
+//#endregion
+//#region ../infra/src/capabilities/IMLProviderCapability.d.ts
+/**
+ * Base configuration shared by all ML provider capabilities.
+ */
+interface MLProviderConfig {
+  /** Path to the WASM binary */
+  wasmPath?: string;
+  /** Path to the SIMD-optimized WASM binary (optional) */
+  wasmSimdPath?: string;
+  /** Path to the WASM glue code (paired with `wasmPath`) */
+  glueCodePath?: string;
+  /**
+   * Path to the SIMD-optimized WASM glue code (paired with `wasmSimdPath`).
+   * If omitted, defaults to a sibling `.js` derived from `wasmSimdPath`.
+   */
+  glueCodeSimdPath?: string;
+  /** Whether to use SIMD optimizations (default: true) */
+  useSimd?: boolean;
+  /**
+   * Base path for ML model files. Models will be loaded from `${modelsBasePath}/${modelFileName}`.
+   * If not provided, models are expected in a 'models' subdirectory relative to the WASM binary.
+   */
+  modelsBasePath?: string;
+}
+/**
+ * Base interface for ML provider capabilities.
+ * Provides common lifecycle and frame processing methods shared by
+ * FaceDetectionCapability and IdCaptureCapability.
+ */
+interface IMLProviderCapability<TConfig extends MLProviderConfig> {
+  /**
+   * Whether the provider has been initialized and is ready to process frames.
+   */
+  readonly initialized: boolean;
+  /**
+   * Initializes the provider with the given configuration.
+   * If WASM was already warmed up via `setup()` or `warmupWasm()`, this returns almost instantly.
+   * @param config - Provider configuration including WASM paths
+   */
+  initialize(config: TConfig): Promise<void>;
+  /**
+   * Processes a frame through the ML pipeline.
+   * Callbacks set via `setCallbacks()` will be invoked based on the analysis results.
+   * @param image - Image data to process
+   * @throws Error if provider is not initialized
+   */
+  processFrame(image: ImageData): Promise<void>;
+  /**
+   * Resets the pipeline to its initial state.
+   * Safe to call even if not initialized (no-op in that case).
+   */
+  reset(): void;
+  /**
+   * Disposes of resources and resets initialization state.
+   * Safe to call even if not initialized.
+   */
+  dispose(): Promise<void>;
+}
+//#endregion
+//#region ../infra/src/capabilities/IWasmUtilCapability.d.ts
+type WasmUtilConfig = MLProviderConfig & {
+  pipelines?: WasmPipeline[];
+};
+type VirtualCameraCheckOutput = {
+  canvas: HTMLCanvasElement | null;
+  itr: boolean | null;
+  skipped: boolean | null;
+};
+type IWasmUtilCapability = {
+  /**
+   * Whether the provider has been initialized and is ready to be used.
+   */
+  readonly initialized: boolean;
+  /**
+   * Initializes the provider with the given configuration.
+   * If WASM was already warmed up via `warmupWasm()`, this returns almost instantly.
+   * @param config - Provider configuration including WASM paths
+   */
+  initialize(config: WasmUtilConfig): Promise<void>;
+  /**
+   * Encrypts a base64 image using the WASM utility API.
+   * @param image - Base64 image string (no data URL prefix)
+   * @returns Encrypted string
+   */
+  encryptImage(image: string): string;
+  setSdkVersion(version: string): void;
+  setSdkPlatform(platform: string): void;
+  setDeviceInfo(deviceInfo: object, overrideExisting?: boolean): void;
+  setBrowserInfo(browserInfo: object, overrideExisting?: boolean): void;
+  setCameraInfo(cameraInfo: object, overrideExisting?: boolean): void;
+  setMotionStatus(status: string): void;
+  setBackgroundMode(backgroundMode: boolean): void;
+  setZc(zc: string): void;
+  setInspectorOpened(opened: boolean): void;
+  getMetadata(): string;
+  analyzeFrame(image: ImageData): Promise<void>;
+  getCheck(): string;
+  /**
+   * Gets the current pipeline state. Must be called before setMotionStatus(),
+   * getCheck(), setBackgroundMode(), and getMetadata() for proper metadata generation.
+   */
+  getPipelineState(): string;
+  estimatePerformance(): string;
+  isVirtualCamera(label: string | null): boolean;
+  prc(): Promise<void>;
+  poc(output: VirtualCameraCheckOutput): Promise<void>;
+  ckvcks(data: ArrayBuffer): void;
+  getVersions(): Promise<unknown>;
+  /**
+   * Disposes of resources and resets initialization state.
+   */
+  dispose(): Promise<void>;
+};
+//#endregion
+//#region ../infra/src/media/canvas.d.ts
+/**
+ * Class representing a canvas element for image capture and manipulation.
+ */
+declare class IncodeCanvas {
+  canvas: HTMLCanvasElement;
+  private base64Image;
+  private blobData;
+  /**
+   * Creates an {@link IncodeCanvas} from a raw {@link ImageData} frame.
+   * @param imageData - Frame pixels in RGBA format
+   * @returns An {@link IncodeCanvas} containing the provided pixels
+   */
+  static fromImageData(imageData: ImageData): IncodeCanvas;
+  /**
+   * Create a new canvas element.
+   * @param canvas_ - The canvas element to clone.
+   */
+  constructor(canvas_: HTMLCanvasElement);
+  /**
+   * Check if the current canvas is valid.
+   */
+  private checkCanvas;
+  /**
+   * Disposes of resources, including revoking object URLs to prevent memory leaks.
+   */
+  dispose(): void;
+  /**
+   * Release the data stored by IncodeCanvas.
+   */
+  release(): void;
+  /**
+   * Revokes the object URL if one exists, preventing memory leaks.
+   * Use this when you no longer need the preview image URL.
+   */
+  revokeObjectURL(): void;
+  /**
+   * Get the width of the canvas.
+   */
+  width(): number | null;
+  /**
+   * Get the height of the canvas.
+   */
+  height(): number | null;
+  /**
+   * Set the width of the canvas.
+   */
+  setWidth(width: number): void;
+  /**
+   * Set the height of the canvas.
+   */
+  setHeight(height: number): void;
+  /**
+   * Clone the current canvas.
+   */
+  clone(): IncodeCanvas | null;
+  /**
+   * Deep clone the current IncodeCanvas including blob data.
+   */
+  deepClone(): Promise<IncodeCanvas | null>;
+  /**
+   * Returns the drawing context on the canvas.
+   */
+  getContext(contextId: '2d', contextAttributes?: CanvasRenderingContext2DSettings): CanvasRenderingContext2D | null;
+  /**
+   * Retrieves the image data from the canvas.
+   */
+  getImageData(): ImageData | null;
+  /**
+   * Updates the base64 representation of the current canvas image.
+   */
+  updateBase64Image(jpegQuality?: number): void;
+  /**
+   * Converts the current canvas element to a base64 string.
+   */
+  getBase64Image(jpegQuality?: number, includeDataURLPrefix?: boolean): string | null;
+  /**
+   * Sets the base64 representation of the current canvas image.
+   */
+  setBase64Image(base64Image: string | null): void;
+  /**
+   * Updates the Blob representation of the current canvas image.
+   */
+  updateBlob(jpegQuality?: number, includeDataURLPrefix?: boolean): void;
+  /**
+   * Converts a base64 string to a Blob and creates a URL for it.
+   */
+  static base64ToBlob(base64: string): {
+    blob: Blob;
+    url: string;
+  } | null;
+  /**
+   * Retrieves the Blob data and its URL from the current canvas.
+   */
+  getBlobData(jpegQuality?: number, includeDataURLPrefix?: boolean): {
+    blob: Blob;
+    url: string;
+  } | null;
+  /**
+   * Sets the Blob data of the current canvas image.
+   */
+  setBlobData(blobData: {
+    blob: Blob;
+    url: string;
+  }): Promise<void>;
+  /**
+   * Returns a resized canvas according to video element size.
+   */
+  getResizedCanvas(videoElementWidth: number, videoElementHeight: number): IncodeCanvas | null;
+}
+//#endregion
+//#region ../infra/src/media/StreamCanvasCapture.d.ts
+type StreamCanvasCaptureOptions = {
+  fps?: number;
+  width?: number;
+  height?: number;
+};
+type StreamCanvasCaptureEventMap = {
+  frame: Event;
+};
+declare class StreamCanvasCapture {
+  private video;
+  private canvas;
+  private ctx;
+  private rafId;
+  private lastFrameTimeSeconds;
+  private lastTickTimeMs;
+  private hasFrame;
+  private disposed;
+  private eventTarget;
+  constructor(stream: CameraStream, options?: StreamCanvasCaptureOptions);
+  addEventListener(type: keyof StreamCanvasCaptureEventMap, listener: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions): void;
+  removeEventListener(type: keyof StreamCanvasCaptureEventMap, listener: EventListenerOrEventListenerObject | null, options?: boolean | EventListenerOptions): void;
+  /**
+   * Returns the latest cached frame as an {@link IncodeCanvas}.
+   */
+  getLatestCanvas(): IncodeCanvas | null;
+  /**
+   * Returns the latest cached frame as raw {@link ImageData}.
+   */
+  getLatestFrame(): ImageData | null;
+  /**
+   * Disposes internal resources and stops the capture loop.
+   */
+  dispose(): void;
+  private rafLoop;
+  private tick;
+}
+//#endregion
+//#region ../infra/src/capabilities/IMotionSensorCapability.d.ts
+type MotionStatus = 'PASS' | 'FAIL' | 'UNCLEAR';
+type MotionPermissionState = 'granted' | 'denied' | 'not-required';
+type IMotionSensorCapability = {
+  requestPermission(): Promise<MotionPermissionState>;
+  start(): Promise<void>;
+  stop(): void;
+  check(): MotionStatus;
+  readonly isRunning: boolean;
+  readonly hasPermission: boolean;
+};
+//#endregion
+//#region src/internal/deepsight/metadataService.d.ts
+type MetadataService = {
+  initialize(sdkVersion: string, disableIpify?: boolean): Promise<void>;
+  updateCameraInfo(videoTrack: MediaStreamTrack): void;
+  checkForVirtualCameraByLabel(videoTrack: MediaStreamTrack | null): Promise<boolean>;
+  analyzeFrame(imageData: ImageData): Promise<void>;
+  setMotionStatus(status: string): void;
+  setBackgroundMode(backgroundMode: boolean): void;
+  estimatePerformance(): string;
+  getMetadata(): string;
+  getCheck(): string;
+  getPipelineState(): string;
+  /**
+   * Prepares pipeline state for metadata collection.
+   * Must be called before setMotionStatus, getCheck, setBackgroundMode, and getMetadata.
+   */
+  preparePipelineState(): void;
+};
+//#endregion
+//#region src/internal/deepsight/motionStatusService.d.ts
+type MotionStatusService = {
+  requestPermission(): Promise<MotionPermissionState>;
+  start(): Promise<void>;
+  stop(): void;
+  check(): MotionStatus;
+  readonly isRunning: boolean;
+  readonly hasPermission: boolean;
+};
+//#endregion
+//#region src/internal/virtualCameraCheck.d.ts
+declare const frameSources: {
+  readonly front: "FRONT_ID";
+  readonly back: "BACK_ID";
+  readonly selfie: "SELFIE";
+};
+type FrameSource = (typeof frameSources)[keyof typeof frameSources];
+//#endregion
+//#region src/internal/deepsight/deepsightService.d.ts
+type DeepsightService = {
+  readonly metadata: MetadataService;
+  readonly motion: MotionStatusService;
+  initialize(disableIpify?: boolean): Promise<void>;
+  requestMotionPermission(): Promise<'granted' | 'denied' | 'not-required'>;
+  startMotionSensors(): Promise<void>;
+  stopMotionSensors(): void;
+  checkVirtualCamera(videoTrack: MediaStreamTrack): Promise<boolean>;
+  performVirtualCameraCheck(sessionToken: string | null, source: FrameSource): Promise<void>;
+  /**
+   * Runs PRC warmup and stores DS flag using infrastructure providers.
+   */
+  performPrcCheck(params: DeepsightPrcCheckParams): Promise<void>;
+  analyzeFrame(imageData: ImageData): Promise<void>;
+  getMetadata(): string;
+  getMotionStatus(): string;
+  getAnalysisStatus(): string;
+  getPipelineState(): string;
+  cleanup(): void;
+};
+type DeepsightPrcCheckParams = {
+  constraints: MediaStreamConstraints;
+};
+//#endregion
+export { IWasmUtilCapability as a, IMLProviderCapability as c, IRecordingCapability as d, RecordingConnection as f, IncodeCanvas as i, MLProviderConfig as l, IMotionSensorCapability as n, VirtualCameraCheckOutput as o, StreamCanvasCapture as r, WasmUtilConfig as s, DeepsightService as t, IStorageCapability as u };