react-native-camera/types/index.d.ts

// Type definitions for react-native-camera 1.0
// Definitions by Felipe Constantino <https://github.com/fconstant>
// If you modify this file, put your GitHub info here as well (for easy contacting purposes)

/*
 * Author notes:
 * I've tried to find a easy tool to convert from Flow to Typescript definition files (.d.ts).
 * So we woudn't have to do it manually... Sadly, I haven't found it.
 * 
 * If you are seeing this from the future, please, send us your cutting-edge technology :) (if it exists)
 */
import { Component } from 'react';
import { ViewProperties } from "react-native";

type AutoFocus = { on: any, off: any };
type FlashMode = { on: any, off: any, torch: any, auto: any };
type CameraType = { front: any, back: any };
type WhiteBalance = { sunny: any, cloudy: any, shadow: any, incandescent: any, fluorescent: any, auto: any };
type BarCodeType = { aztec: any, code128: any, code39: any, code39mod43: any, code93: any, ean13: any, ean8: any, pdf417: any, qr: any, upce: any, interleaved2of5: any, itf14: any, datamatrix: any };
type VideoQuality = { '2160p': any, '1080p': any, '720p': any, '480p': any, '4:3': any };
type VideoCodec = { 'H264': symbol, 'JPEG': symbol, 'HVEC': symbol, 'AppleProRes422': symbol, 'AppleProRes4444': symbol };

type FaceDetectionClassifications = { all: any, none: any };
type FaceDetectionLandmarks = { all: any, none: any };
type FaceDetectionMode = { fast: any, accurate: any };

export interface Constants {
    AutoFocus: AutoFocus;
    FlashMode: FlashMode;
    VideoCodec: VideoCodec;
    Type: CameraType;
    WhiteBalance: WhiteBalance;
    VideoQuality: VideoQuality;
    BarCodeType: BarCodeType;
    FaceDetection: {
        Classifications: FaceDetectionClassifications;
        Landmarks: FaceDetectionLandmarks;
        Mode: FaceDetectionMode;
    }
}

export interface RNCameraProps {
    autoFocus?: keyof AutoFocus;
    type?: keyof CameraType;
    flashMode?: keyof FlashMode;
    notAuthorizedView?: JSX.Element;
    pendingAuthorizationView?: JSX.Element;

    onCameraReady?(): void;
    onMountError?(): void;

    /** Value: float from 0 to 1.0 */
    zoom?: number;
    /** Value: float from 0 to 1.0 */
    focusDepth?: number;

    // -- BARCODE PROPS
    barCodeTypes?: Array<keyof BarCodeType>;
    onBarCodeRead?(event: {
        data: string,
        type: keyof BarCodeType,
        /**
         * @description For Android use `[Point<string>, Point<string>]`
         * @description For iOS use `{ origin: Point<string>, size: Size<string> }`
         */
        bounds: [Point<string>, Point<string>] | { origin: Point<string>, size: Size<string> }
    }): void;
    
    // -- FACE DETECTION PROPS

    onFacesDetected?(response: { faces: Face[] }): void;
    onFaceDetectionError?(response: { isOperational: boolean }): void;
    faceDetectionMode?: keyof FaceDetectionMode;
    faceDetectionLandmarks?: keyof FaceDetectionLandmarks;
    faceDetectionClassifications?: keyof FaceDetectionClassifications;

    // -- ANDROID ONLY PROPS
    /** Android only */
    onTextRecognized?(response: { textBlocks: TrackedTextFeature[] }): void;
    /** Android only */
    ratio?: string;
    /** Android only */
    permissionDialogTitle?: string;
    /** Android only */
    permissionDialogMessage?: string;

    // -- IOS ONLY PROPS
    
    /** iOS Only */
    captureAudio?: boolean;

}

interface Point<T = number> {
    x: T,
    y: T
}

interface Size<T = number> {
    width: T;
    height: T;
}

interface Face {
    faceID?: number,
    bounds: {
        size: Size;
        origin: Point;
    };
    smilingProbability?: number;
    leftEarPosition?: Point;
    rightEarPosition?: Point;
    leftEyePosition?: Point;
    leftEyeOpenProbability?: number;
    rightEyePosition?: Point;
    rightEyeOpenProbability?: number;
    leftCheekPosition?: Point;
    rightCheekPosition?: Point;
    leftMouthPosition?: Point;
    mouthPosition?: Point;
    rightMouthPosition?: Point;
    bottomMouthPosition?: Point;
    noseBasePosition?: Point;
    yawAngle?: number;
    rollAngle?: number;
}

interface TrackedTextFeature {
    type: 'block' | 'line' | 'element';
    bounds: {
        size: Size;
        origin: Point;
    },
    value: string;
    components: TrackedTextFeature[];
}

interface TakePictureOptions {
    quality?: number;
    base64?: boolean;
    exif?: boolean;
    width?: number;
    mirrorImage?: boolean;

    /** Android only */
    skipProcessing?: boolean;
    /** Android only */
    fixOrientation?: boolean;
    
    /** iOS only */
    forceUpOrientation?: boolean;
}

interface TakePictureResponse {
    width: number;
    height: number;
    uri: string;
    base64?: string;
    exif?: { [name: string]: any };
}


interface RecordOptions {
    quality?: keyof VideoQuality;
    maxDuration?: number;
    maxFileSize?: number;
    mute?: boolean;

    /** iOS only */
    codec?: keyof VideoCodec | VideoCodec[keyof VideoCodec];
}

interface RecordResponse {
    /** Path to the video saved on your app's cache directory. */
    uri: string;
    /** iOS only */
    codec: VideoCodec[keyof VideoCodec];
}

export class RNCamera extends Component<RNCameraProps & ViewProperties> {
    static Constants: Constants;

    takePictureAsync(options?: TakePictureOptions): Promise<TakePictureResponse>;
    recordAsync(options?: RecordOptions): Promise<RecordResponse>;
    stopRecording(): void;

    /** Android only */
    getSupportedRatiosAsync(): Promise<string[]>;
}

interface DetectionOptions {
    mode?: keyof FaceDetectionMode,
    detectLandmarks?: keyof FaceDetectionLandmarks,
    runClassifications?: keyof FaceDetectionClassifications
}

export class FaceDetector {
    private constructor();
    static Constants: Constants['FaceDetection'];
    static detectFacesAsync(uri: string, options?: DetectionOptions): Promise<Face[]>;
}

// -- DEPRECATED CONTENT BELOW

/**
 * @deprecated As of 1.0.0 release, RCTCamera is deprecated. Please use RNCamera for the latest fixes and improvements.
 */
export default class RCTCamera extends Component<any> {
    static constants: any;
}