react-native-rate-app/src/plugin/withReactNativeRateApp.ts

React Native module for In App Rating on Android and iOS

import { withInfoPlist, withXcodeProject } from "@expo/config-plugins";
import type { ConfigPlugin } from "expo/config-plugins";

/**
 * Modifies the `Info.plist` file to add `LSApplicationQueriesSchemes`,
 * allowing the app to open App Store links.
 *
 * @param {ConfigPlugin} config - The Expo configuration object.
 * @returns {ConfigPlugin} - The modified Expo configuration.
 */
const withCustomInfoPlist: ConfigPlugin = (config) => {
  return withInfoPlist(config, (config) => {
    if (!config.modResults.LSApplicationQueriesSchemes) {
      config.modResults.LSApplicationQueriesSchemes = [];
    }
    if (!config.modResults.LSApplicationQueriesSchemes.includes("itms-apps")) {
      config.modResults.LSApplicationQueriesSchemes.push("itms-apps");
    }
    return config;
  });
};

/**
 * Adds the `StoreKit.framework` to the iOS Xcode project.
 * This framework is required for in-app review prompts.
 *
 * @param {ConfigPlugin} config - The Expo configuration object.
 * @returns {ConfigPlugin} - The modified Expo configuration.
 */
const withStoreKitFramework: ConfigPlugin = (config) => {
  return withXcodeProject(config, (config) => {
    config.modResults.addFramework("StoreKit.framework", { required: true });
    return config;
  });
};

/**
 * Applies both `withCustomInfoPlist` and `withStoreKitFramework`
 * to enable in-app rating functionality in a React Native app.
 *
 * @param {ConfigPlugin} config - The Expo configuration object.
 * @returns {ConfigPlugin} - The modified Expo configuration.
 */
const withReactNativeRateApp: ConfigPlugin = (config) => {
  const configWithInfoPlist = withCustomInfoPlist(config);
  const configWithStoreKit = withStoreKitFramework(configWithInfoPlist);
  return configWithStoreKit;
};

export default withReactNativeRateApp;