@privateid/ultrapass-web-sdk 1.2.0 → 1.3.1-1300478

package/dist/application/modules/support/camera/camera.utils.d.ts

@@ -1,157 +1,157 @@
-/// <reference types="ua-parser-js" />
-import { CameraFaceMode, CameraOpenResult, CameraServiceType, FacingMode, GeneratedUserMediaConstraints, ScreenOrientation } from './camera.types';
-export declare function getScreenOrientation(): ScreenOrientation;
-export declare function getUserAgent(): string | undefined;
-export declare function parseUserAgent(): import("ua-parser-js").IResult;
-export declare function isPortrait(): boolean;
-export declare function isBackCameraAndPortrait(faceMode: FacingMode): boolean;
-export declare function isMobileUA(): boolean;
-export declare function isFirefoxUA(): boolean;
-export declare function isSafariUA(): boolean;
-export declare function isChromeUA(): boolean;
-export declare function isSamsungUA(): boolean;
-export declare function isAndroid(): boolean;
-/**
- * See https://developer.chrome.com/docs/multidevice/user-agent/#webview_user_agent
- * This onloy detects the WebView after Android 4.4. It'd return false for older
- * Android version.
- */
-export declare function isAndroidWebView(): boolean;
-export declare function isAndroid12OrAbove(): boolean;
-export declare function isIOSUA(): boolean;
-export declare function getMajorAndroidVersion(): number;
-export declare function getMajorSafariVersion(): number;
-export declare function getMajorChromeVersion(): number;
-export declare function getMajorIOSVersion(): number;
-export declare function getMajorMinorOsVersion(): string;
-export declare function isWindows(): boolean;
-export declare function isMac(): boolean;
-export declare function isLinux(): boolean;
-export declare function getPlatform(): string;
-export declare function isMobileDevice(): boolean;
-export declare function isIOSDesktop(): boolean;
-export declare function isIOS(): boolean;
-export declare function isIOS15OrGreater(): boolean;
-export declare function isAndroidDesktop(): boolean;
-export declare const isBackCameraLabel: (label: string) => boolean;
-export declare const isMobileBackCameraPortrait: ({ label, facingMode }: {
-    label: string;
-    facingMode: FacingMode[];
-}) => boolean;
-export declare function isFaceTimeCamera(label: string, isDocumentScan: boolean): boolean;
-export declare const getCameraList: (backOnly: boolean) => Promise<Array<any>>;
-export declare const getMobileVideoConstraints: (availableDevices?: Array<any> | null, faceMode?: FacingMode, isDocumentScan?: boolean, canvasResolution?: {
-    width: number;
-    height: number;
-}, selectedDeviceId?: string, isFirstPermissionRequest?: boolean) => {
-    audio: boolean;
-    video: {
-        aspectRatio: number;
-        deviceId: string;
-        facingMode: FacingMode;
-        resizeMode: string;
-        width: {
-            ideal: number;
-        };
-        height: {
-            ideal: number;
-        };
-    };
-} | {
-    audio: boolean;
-    video: {
-        facingMode: FacingMode;
-        aspectRatio?: undefined;
-        height?: undefined;
-        resizeMode?: undefined;
-    };
-} | {
-    audio: boolean;
-    video: {
-        aspectRatio: number;
-        height: {
-            min: number;
-        };
-        resizeMode: string;
-        facingMode?: undefined;
-    };
-};
-export declare function scaleImageData(imageData: any, scaleFactor: number): ImageData;
-export declare function zoomInCanvasImage(canvas: any, scaleFactor: number): ImageData;
-export declare const checkDeviceIsVirtualCamera: (deviceLabel: string) => boolean;
-export declare function getFilteredVideoDevices(): Promise<MediaDeviceInfo[]>;
-export declare function filterDevicesByPattern(devices: MediaDeviceInfo[], pattern: RegExp): MediaDeviceInfo[];
-export declare function getExternalDevice(devices: MediaDeviceInfo[]): MediaDeviceInfo | undefined;
-export declare function isWindowsDevice(): boolean;
-export declare function getMediaDeviceInfo(devices: MediaDeviceInfo[], deviceId: string): Promise<MediaDeviceInfo>;
-/**
- * This function open camera, and returns the stream, current faceMode and the list of available media devices
- * @category Face
- * @param domElement id of the video tag
- */
-export declare function getTheNextResolutionAvailable(currentResolution: number): number;
-export declare function startVideo(videoElement: string, stream: MediaStream): Promise<void>;
-export declare function enableMutationObserver(videoElement: HTMLVideoElement, stream: MediaStream): void;
-export declare function calculateWidth(canvasResolution: {
-    width: number;
-    height: number;
-} | null, isPortraitMobileCamera: boolean, resolution: number): number;
-export declare function calculateHeight(canvasResolution: {
-    width: number;
-    height: number;
-} | null): number;
-export declare function calculateAspectRatio(canvasResolution: {
-    width: number;
-    height: number;
-} | null, isPortraitMobileCamera: boolean): 1 | 1.7777777778;
-export declare function prepareCameraResult(stream: MediaStream, devices: MediaDeviceInfo[], faceMode: CameraFaceMode | null, videoElement: string): Promise<CameraOpenResult>;
-/**
- * Handles device ID selection for camera devices based on platform and availability.
- *
- * @returns The most probable device ID string
- */
-export declare function handleDeviceId(devices: MediaDeviceInfo[], id?: string, isMacSafari?: boolean): string;
-/**
- * Creates a MediaStream from the specified camera device for a specific camera service with optimized constraints.
- *
- * @returns A promise that resolves to a MediaStream from the specified camera device
- * @throws {Error} When camera access is denied or device is not available
- *
- * @example
- * ```typescript
- * const devices = await navigator.mediaDevices.enumerateDevices();
- * const camera = devices.find(d => d.kind === 'videoinput');
- * const stream = await getDeviceMediaStream(camera.deviceId, 'desktop', {
- *   canvasResolution: { width: 1280, height: 720 }
- * });
- * ```
- */
-export declare function getDeviceMediaStream(deviceId: string | undefined, type: CameraServiceType | null, options?: {
-    isMacFaceTimeCamera?: boolean;
-    isDocumentScan?: boolean;
-    canvasResolution?: {
-        width: number;
-        height: number;
-    } | null;
-    faceMode?: CameraFaceMode;
-    enabledDevices?: MediaDeviceInfo[];
-    isFirstPermissionRequest?: boolean;
-}): Promise<MediaStream>;
-/**
- * Creates platform-specific video constraints for different camera service types including
- * desktop, Firefox, Mac Safari, and mobile devices with appropriate resolutions and settings.
- *
- * @returns A promise that resolves to GeneratedUserMediaConstraints object
- */
-export declare function generateUserMediaConstraints(type?: CameraServiceType, params?: {
-    deviceId?: string;
-    idealResolution?: {
-        width: number;
-        height: number;
-    };
-    faceMode?: CameraFaceMode;
-    isMacFaceTimeCamera?: boolean;
-    isDocumentScan?: boolean;
-    enabledDevices?: MediaDeviceInfo[];
-    isFirstPermissionRequest?: boolean;
-}): Promise<GeneratedUserMediaConstraints>;
+/// <reference types="ua-parser-js" />
+import { CameraFaceMode, CameraOpenResult, CameraServiceType, FacingMode, GeneratedUserMediaConstraints, ScreenOrientation } from './camera.types';
+export declare function getScreenOrientation(): ScreenOrientation;
+export declare function getUserAgent(): string | undefined;
+export declare function parseUserAgent(): import("ua-parser-js").IResult;
+export declare function isPortrait(): boolean;
+export declare function isBackCameraAndPortrait(faceMode: FacingMode): boolean;
+export declare function isMobileUA(): boolean;
+export declare function isFirefoxUA(): boolean;
+export declare function isSafariUA(): boolean;
+export declare function isChromeUA(): boolean;
+export declare function isSamsungUA(): boolean;
+export declare function isAndroid(): boolean;
+/**
+ * See https://developer.chrome.com/docs/multidevice/user-agent/#webview_user_agent
+ * This onloy detects the WebView after Android 4.4. It'd return false for older
+ * Android version.
+ */
+export declare function isAndroidWebView(): boolean;
+export declare function isAndroid12OrAbove(): boolean;
+export declare function isIOSUA(): boolean;
+export declare function getMajorAndroidVersion(): number;
+export declare function getMajorSafariVersion(): number;
+export declare function getMajorChromeVersion(): number;
+export declare function getMajorIOSVersion(): number;
+export declare function getMajorMinorOsVersion(): string;
+export declare function isWindows(): boolean;
+export declare function isMac(): boolean;
+export declare function isLinux(): boolean;
+export declare function getPlatform(): string;
+export declare function isMobileDevice(): boolean;
+export declare function isIOSDesktop(): boolean;
+export declare function isIOS(): boolean;
+export declare function isIOS15OrGreater(): boolean;
+export declare function isAndroidDesktop(): boolean;
+export declare const isBackCameraLabel: (label: string) => boolean;
+export declare const isMobileBackCameraPortrait: ({ label, facingMode }: {
+    label: string;
+    facingMode: FacingMode[];
+}) => boolean;
+export declare function isFaceTimeCamera(label: string, isDocumentScan: boolean): boolean;
+export declare const getCameraList: (backOnly: boolean) => Promise<Array<any>>;
+export declare const getMobileVideoConstraints: (availableDevices?: Array<any> | null, faceMode?: FacingMode, isDocumentScan?: boolean, canvasResolution?: {
+    width: number;
+    height: number;
+}, selectedDeviceId?: string, isFirstPermissionRequest?: boolean) => {
+    audio: boolean;
+    video: {
+        aspectRatio: number;
+        deviceId: string;
+        facingMode: FacingMode;
+        resizeMode: string;
+        width: {
+            ideal: number;
+        };
+        height: {
+            ideal: number;
+        };
+    };
+} | {
+    audio: boolean;
+    video: {
+        facingMode: FacingMode;
+        aspectRatio?: undefined;
+        height?: undefined;
+        resizeMode?: undefined;
+    };
+} | {
+    audio: boolean;
+    video: {
+        aspectRatio: number;
+        height: {
+            min: number;
+        };
+        resizeMode: string;
+        facingMode?: undefined;
+    };
+};
+export declare function scaleImageData(imageData: any, scaleFactor: number): ImageData;
+export declare function zoomInCanvasImage(canvas: any, scaleFactor: number): ImageData;
+export declare const checkDeviceIsVirtualCamera: (deviceLabel: string) => boolean;
+export declare function getFilteredVideoDevices(): Promise<MediaDeviceInfo[]>;
+export declare function filterDevicesByPattern(devices: MediaDeviceInfo[], pattern: RegExp): MediaDeviceInfo[];
+export declare function getExternalDevice(devices: MediaDeviceInfo[]): MediaDeviceInfo | undefined;
+export declare function isWindowsDevice(): boolean;
+export declare function getMediaDeviceInfo(devices: MediaDeviceInfo[], deviceId: string): Promise<MediaDeviceInfo>;
+/**
+ * This function open camera, and returns the stream, current faceMode and the list of available media devices
+ * @category Face
+ * @param domElement id of the video tag
+ */
+export declare function getTheNextResolutionAvailable(currentResolution: number): number;
+export declare function startVideo(videoElement: string, stream: MediaStream): Promise<void>;
+export declare function enableMutationObserver(videoElement: HTMLVideoElement, stream: MediaStream): void;
+export declare function calculateWidth(canvasResolution: {
+    width: number;
+    height: number;
+} | null, isPortraitMobileCamera: boolean, resolution: number): number;
+export declare function calculateHeight(canvasResolution: {
+    width: number;
+    height: number;
+} | null): number;
+export declare function calculateAspectRatio(canvasResolution: {
+    width: number;
+    height: number;
+} | null, isPortraitMobileCamera: boolean): 1 | 1.7777777778;
+export declare function prepareCameraResult(stream: MediaStream, devices: MediaDeviceInfo[], faceMode: CameraFaceMode | null, videoElement: string): Promise<CameraOpenResult>;
+/**
+ * Handles device ID selection for camera devices based on platform and availability.
+ *
+ * @returns The most probable device ID string
+ */
+export declare function handleDeviceId(devices: MediaDeviceInfo[], id?: string, isMacSafari?: boolean): string;
+/**
+ * Creates a MediaStream from the specified camera device for a specific camera service with optimized constraints.
+ *
+ * @returns A promise that resolves to a MediaStream from the specified camera device
+ * @throws {Error} When camera access is denied or device is not available
+ *
+ * @example
+ * ```typescript
+ * const devices = await navigator.mediaDevices.enumerateDevices();
+ * const camera = devices.find(d => d.kind === 'videoinput');
+ * const stream = await getDeviceMediaStream(camera.deviceId, 'desktop', {
+ *   canvasResolution: { width: 1280, height: 720 }
+ * });
+ * ```
+ */
+export declare function getDeviceMediaStream(deviceId: string | undefined, type: CameraServiceType | null, options?: {
+    isMacFaceTimeCamera?: boolean;
+    isDocumentScan?: boolean;
+    canvasResolution?: {
+        width: number;
+        height: number;
+    } | null;
+    faceMode?: CameraFaceMode;
+    enabledDevices?: MediaDeviceInfo[];
+    isFirstPermissionRequest?: boolean;
+}): Promise<MediaStream>;
+/**
+ * Creates platform-specific video constraints for different camera service types including
+ * desktop, Firefox, Mac Safari, and mobile devices with appropriate resolutions and settings.
+ *
+ * @returns A promise that resolves to GeneratedUserMediaConstraints object
+ */
+export declare function generateUserMediaConstraints(type?: CameraServiceType, params?: {
+    deviceId?: string;
+    idealResolution?: {
+        width: number;
+        height: number;
+    };
+    faceMode?: CameraFaceMode;
+    isMacFaceTimeCamera?: boolean;
+    isDocumentScan?: boolean;
+    enabledDevices?: MediaDeviceInfo[];
+    isFirstPermissionRequest?: boolean;
+}): Promise<GeneratedUserMediaConstraints>;