expo-media-library/plugin/src/withMediaLibrary.ts

Provides access to user's media library.

import {
  ConfigPlugin,
  withAndroidManifest,
  AndroidConfig,
  createRunOncePlugin,
  IOSConfig,
  withInfoPlist,
} from 'expo/config-plugins';

const pkg = require('../../package.json');

type GranularPermission = 'photo' | 'video' | 'audio';
const GRANULAR_PERMISSIONS_MAP: Record<GranularPermission, string> = {
  photo: 'android.permission.READ_MEDIA_IMAGES',
  video: 'android.permission.READ_MEDIA_VIDEO',
  audio: 'android.permission.READ_MEDIA_AUDIO',
};
const defaultGranularPermissions: GranularPermission[] = ['photo', 'video', 'audio'];

export function modifyAndroidManifest(
  manifest: AndroidConfig.Manifest.AndroidManifest
): AndroidConfig.Manifest.AndroidManifest {
  // Starting with Android 10, the concept of scoped storage is introduced.
  // Currently, to make expo-media-library working with that change, you have to add
  // android:requestLegacyExternalStorage="true" to AndroidManifest.xml:
  const app = AndroidConfig.Manifest.getMainApplicationOrThrow(manifest);
  app.$['android:requestLegacyExternalStorage'] = 'true';
  return manifest;
}

const withMediaLibraryExternalStorage: ConfigPlugin = (config) => {
  return withAndroidManifest(config, async (config) => {
    config.modResults = modifyAndroidManifest(config.modResults);
    return config;
  });
};

export type Props = {
  /**
   * A string to set the `NSPhotoLibraryUsageDescription` permission message.
   * @default "Allow $(PRODUCT_NAME) to access your photos"
   * @platform ios
   */
  photosPermission?: string | false;
  /**
   * A string to set the `NSPhotoLibraryAddUsageDescription` permission message.
   * @default "Allow $(PRODUCT_NAME) to save photos"
   * @platform ios
   */
  savePhotosPermission?: string | false;
  /**
   * Whether to request the `ACCESS_MEDIA_LOCATION` permission on Android.
   * @default false
   * @platform android
   */
  isAccessMediaLocationEnabled?: boolean;
  /**
   * Whether to prevent the automatic limited access alert when the user has limited photo library access.
   * @default false
   * @platform ios
   */
  preventAutomaticLimitedAccessAlert?: boolean;
  /**
   * Which media permissions (`READ_MEDIA_IMAGES`, `READ_MEDIA_VIDEO`, `READ_MEDIA_AUDIO`) to add to the Android manifest.
   * @default ["photo", "video", "audio"]
   * @platform android
   */
  granularPermissions?: GranularPermission[];
};

const withMediaLibrary: ConfigPlugin<Props | void> = (
  config,
  {
    photosPermission,
    savePhotosPermission,
    isAccessMediaLocationEnabled,
    preventAutomaticLimitedAccessAlert,
    granularPermissions = defaultGranularPermissions,
  } = {}
) => {
  IOSConfig.Permissions.createPermissionsPlugin({
    NSPhotoLibraryUsageDescription: 'Allow $(PRODUCT_NAME) to access your photos',
    NSPhotoLibraryAddUsageDescription: 'Allow $(PRODUCT_NAME) to save photos',
  })(config, {
    NSPhotoLibraryUsageDescription: photosPermission,
    NSPhotoLibraryAddUsageDescription: savePhotosPermission,
  });

  AndroidConfig.Permissions.withPermissions(
    config,
    [
      'android.permission.READ_EXTERNAL_STORAGE',
      'android.permission.WRITE_EXTERNAL_STORAGE',
      'android.permission.READ_MEDIA_VISUAL_USER_SELECTED',
      isAccessMediaLocationEnabled && 'android.permission.ACCESS_MEDIA_LOCATION',
      ...granularPermissions.map((type) => GRANULAR_PERMISSIONS_MAP[type]),
    ].filter(Boolean) as string[]
  );

  if (preventAutomaticLimitedAccessAlert) {
    config = withInfoPlist(config, (config) => {
      config.modResults.PHPhotoLibraryPreventAutomaticLimitedAccessAlert = true;
      return config;
    });
  }

  return withMediaLibraryExternalStorage(config);
};

export default createRunOncePlugin(withMediaLibrary, pkg.name, pkg.version);