react-native-cameraroll/typings/CameraRoll.d.ts

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

declare namespace CameraRoll {
  type GroupType =
    | 'Album'
    | 'All'
    | 'Event'
    | 'Faces'
    | 'Library'
    | 'PhotoStream'
    | 'SavedPhotos';

  type AssetType = 'All' | 'Videos' | 'Photos';

  type Include =
    /** Ensures the filename is included. Has a large performance hit on iOS */
    | 'filename'
    /** Ensures the fileSize is included. Has a large performance hit on iOS */
    | 'fileSize'
    /** Ensures the location is included. Has a medium performance hit on Android */
    | 'location'
    /** Ensures the image width and height are included. Has a small performance hit on Android */
    | 'imageSize'
    /** Ensures the image playableDuration is included. Has a medium performance hit on Android */
    | 'playableDuration';

  /**
   * Shape of the param arg for the `getPhotosFast` function.
   */
  interface GetPhotosParams {
    /**
     * The number of photos wanted in reverse order of the photo application
     * (i.e. most recent first).
     */
    first: number;

    /**
     * A cursor that matches `page_info { end_cursor }` returned from a previous
     * call to `getPhotos`. Note that using this will reduce performance
     * slightly on iOS. An alternative is just using the `fromTime` and `toTime`
     * filters, which have no such impact.
     */
    after?: string;

    /**
     * Specifies which group types to filter the results to.
     */
    groupTypes?: GroupType;

    /**
     * Specifies filter on group names, like 'Recent Photos' or custom album
     * titles.
     */
    groupName?: string;

    /**
     * Specifies filter on asset type
     */
    assetType?: AssetType;

    /**
     * Filter by creation time with a timestamp in milliseconds. This time is
     * exclusive, so we'll select all photos with `timestamp > fromTime`.
     */
    fromTime?: number;

    /**
     * Filter by creation time with a timestamp in milliseconds. This time is
     * inclusive, so we'll select all photos with `timestamp <= toTime`.
     */
    toTime?: number;

    /**
     * Filter by mimetype (e.g. image/jpeg). Note that using this will reduce
     * performance slightly on iOS.
     */
    mimeTypes?: Array<string>;

    /**
     * Specific fields in the output that we want to include, even though they
     * might have some performance impact.
     */
    include?: Include[];
  }

  interface PhotoIdentifier {
    node: {
      type: string;
      group_name: string;
      image: {
        /** Only set if the `include` parameter contains `filename`. */
        filename: string | null;
        uri: string;
        /** Only set if the `include` parameter contains `imageSize`. */
        height: number;
        /** Only set if the `include` parameter contains `imageSize`. */
        width: number;
        /** Only set if the `include` parameter contains `fileSize`. */
        fileSize: number | null;
        /**
         * Only set if the `include` parameter contains `playableDuration`.
         * Will be null for images.
         */
        playableDuration: number | null;
      };
      /** Timestamp in seconds. */
      timestamp: number;
      /** Only set if the `include` parameter contains `location`. */
      location: {
        latitude?: number;
        longitude?: number;
        altitude?: number;
        heading?: number;
        speed?: number;
      } | null;
    };
  }

  interface PhotoIdentifiersPage {
    edges: Array<PhotoIdentifier>;
    page_info: {
      has_next_page: boolean;
      start_cursor?: string;
      end_cursor?: string;
    };
  }

  interface GetAlbumsParams {
    assetType?: AssetType;
  }

  interface Album {
    title: string;
    count: number;
  }

  type SaveToCameraRollOptions = {
    type?: 'photo' | 'video' | 'auto';
    album?: string;
  };

  /**
   * `CameraRoll.saveImageWithTag()` is deprecated. Use `CameraRoll.saveToCameraRoll()` instead.
   */
  function saveImageWithTag(tag: string): Promise<string>;

  /**
   * Delete a photo from the camera roll or media library. photoUris is an array of photo uri's.
   */
  function deletePhotos(photoUris: Array<string>): Promise<boolean>;

  /**
   * Returns the Camera Roll images count on iOS.
   */
  function getPhotosCountiOS(): Promise<number>;

  /**
   * Returns the Camera Roll favorite images count on iOS.
   */
  function getFavoritesiOS(): Promise<Album>;

  /**
   * Saves the photo or video to the camera roll or photo library.
   */
  function saveToCameraRoll(
    tag: string,
    type?: 'photo' | 'video',
  ): Promise<string>;

  /**
   * Saves the photo or video to the camera roll or photo library.
   */
  function save(
    tag: string,
    options?: SaveToCameraRollOptions,
  ): Promise<string>;

  /**
   * Returns a Promise with photo identifier objects from the local camera
   * roll of the device matching shape defined by `getPhotosReturnChecker`.
   */
  function getPhotos(params: GetPhotosParams): Promise<PhotoIdentifiersPage>;

  function getAlbums(params: GetAlbumsParams): Promise<Album[]>;
}

export = CameraRoll;