expo-secure-store/plugin/src/withSecureStore.ts

Provides a way to encrypt and securely store key-value pairs locally on the device.

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

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

const BACKUP_RULES_PATH = '@xml/secure_store_backup_rules';
const EXTRACTION_RULES_PATH = '@xml/secure_store_data_extraction_rules';
const FACEID_USAGE = 'Allow $(PRODUCT_NAME) to access your Face ID biometric data.';

export type Props = {
  /**
   * A string to set the `NSFaceIDUsageDescription` permission message.
   * @default "Allow $(PRODUCT_NAME) to access your Face ID biometric data."
   * @platform ios
   */
  faceIDPermission?: string | false;
  /**
   * Whether to configure automatic Android backup to work correctly with expo-secure-store.
   * @default true
   * @platform android
   */
  configureAndroidBackup?: boolean;
};

const withSecureStore: ConfigPlugin<Props | void> = (
  config,
  { faceIDPermission, configureAndroidBackup = true } = {}
) => {
  IOSConfig.Permissions.createPermissionsPlugin({
    NSFaceIDUsageDescription: FACEID_USAGE,
  })(config, {
    NSFaceIDUsageDescription: faceIDPermission,
  });

  withAndroidManifest(config, (config) => {
    const mainApplication = AndroidConfig.Manifest.getMainApplicationOrThrow(config.modResults);
    const backupConfig = mainApplication.$['android:fullBackupContent']; // SDK <= 30
    const dataExtractionRules = mainApplication.$['android:dataExtractionRules']; // SDK >= 31

    if (!configureAndroidBackup) {
      backupConfig === BACKUP_RULES_PATH && delete mainApplication.$['android:fullBackupContent'];
      dataExtractionRules === EXTRACTION_RULES_PATH &&
        delete mainApplication.$['android:dataExtractionRules'];
      return config;
    }

    const canApplyBackupConfig = !backupConfig || backupConfig === BACKUP_RULES_PATH;
    const canApplyDataExtractionRules =
      !dataExtractionRules || dataExtractionRules === EXTRACTION_RULES_PATH;

    if (canApplyBackupConfig && canApplyDataExtractionRules) {
      mainApplication.$['android:fullBackupContent'] = BACKUP_RULES_PATH;
      mainApplication.$['android:dataExtractionRules'] = EXTRACTION_RULES_PATH;
      return config;
    }

    console.warn(
      'Expo-secure-store tried to apply Android Auto Backup rules, but other backup rules are already present. ' +
        'Refer to the expo-secure-store docs (https://docs.expo.dev/versions/latest/sdk/securestore/) to configure your backup rules.'
    );
    return config;
  });
  return config;
};

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