expo-store-review/build/StoreReview.js

Provides access to native APIs for in-app reviews.

import Constants from 'expo-constants';
import { Platform } from 'expo-modules-core';
import { Linking } from 'react-native';
import StoreReview from './ExpoStoreReview';
// @needsAudit
/**
 * Determines if the platform has the capabilities to use `StoreReview.requestReview()`.
 * @return
 * This returns a promise fulfills with `boolean`, depending on the platform:
 * - On iOS, it will resolve to `true` unless the app is distributed through TestFlight.
 * - On Android, it will resolve to `true` if the device is running Android 5.0+.
 * - On Web, it will resolve to `false`.
 */
export async function isAvailableAsync() {
    return StoreReview.isAvailableAsync?.() ?? false;
}
// @needsAudit
/**
 * In ideal circumstances this will open a native modal and allow the user to select a star rating
 * that will then be applied to the App Store, without leaving the app. If the device is running
 * a version of Android lower than 5.0, this will attempt to get the store URL and link the user to it.
 */
export async function requestReview() {
    if (StoreReview?.requestReview) {
        return StoreReview.requestReview();
    }
    // If StoreReview is unavailable then get the store URL from `app.config.js` or `app.json` and open the store
    const url = storeUrl();
    if (url) {
        const supported = await Linking.canOpenURL(url);
        if (!supported) {
            console.warn("StoreReview.requestReview(): Can't open store url: ", url);
        }
        else {
            await Linking.openURL(url);
        }
    }
    else {
        // If the store URL is missing, let the dev know.
        console.warn("StoreReview.requestReview(): Couldn't link to store, please make sure the `android.playStoreUrl` & `ios.appStoreUrl` fields are filled out in your `app.json`");
    }
}
// @needsAudit
/**
 * This uses the `Constants` API to get the `Constants.expoConfig.ios.appStoreUrl` on iOS, or the
 * `Constants.expoConfig.android.playStoreUrl` on Android.
 *
 * On Web this will return `null`.
 */
export function storeUrl() {
    const expoConfig = Constants.expoConfig;
    if (Platform.OS === 'ios' && expoConfig?.ios) {
        return expoConfig.ios.appStoreUrl ?? null;
    }
    else if (Platform.OS === 'android' && expoConfig?.android) {
        return expoConfig.android.playStoreUrl ?? null;
    }
    return null;
}
// @needsAudit
/**
 * @return This returns a promise that fulfills to `true` if `StoreReview.requestReview()` is capable
 * directing the user to some kind of store review flow. If the app config (`app.json`) does not
 * contain store URLs and native store review capabilities are not available then the promise
 * will fulfill to `false`.
 *
 * @example
 * ```ts
 * if (await StoreReview.hasAction()) {
 *   // you can call StoreReview.requestReview()
 * }
 * ```
 */
export async function hasAction() {
    return !!storeUrl() || (await isAvailableAsync());
}
//# sourceMappingURL=StoreReview.js.map