react-native-rate-app 0.0.1

package/src/NativeRateApp.ts

@@ -0,0 +1,8 @@
+import type { TurboModule } from "react-native";
+import { TurboModuleRegistry } from "react-native";
+
+export interface Spec extends TurboModule {
+  requestReview(): Promise<boolean>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>("RateApp");

package/src/constants.ts

@@ -0,0 +1,10 @@
+import { AndroidMarket } from "./types";
+
+export const IOS_REVIEW_URL = "itms-apps://apps.apple.com/app/id";
+
+export const ANDROID_MARKET_URLS: Record<AndroidMarket, string> = {
+  [AndroidMarket.GOOGLE]: "market://details?id={packageName}",
+  [AndroidMarket.AMAZON]: "amzn://apps/android?p={packageName}",
+  [AndroidMarket.SAMSUNG]: "samsungapps://ProductDetail/{packageName}",
+  [AndroidMarket.HUAWEI]: "appmarket://details?id={packageName}",
+};

package/src/index.tsx

@@ -0,0 +1,91 @@
+import { Linking, Platform } from "react-native";
+import NativeRateApp from "./NativeRateApp";
+import { ANDROID_MARKET_URLS, IOS_REVIEW_URL } from "./constants";
+import { AndroidMarket, type OpenStoreForReviewProps } from "./types";
+
+/**
+ * Custom error for rate app operations
+ */
+class RateAppError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "RateAppError";
+  }
+}
+
+const RateApp = {
+  /**
+   * Requests a review from the user.
+   * @returns A promise that resolves to a boolean indicating whether the review was successfully requested.
+   */
+  async requestReview(): Promise<boolean> {
+    try {
+      return await NativeRateApp.requestReview();
+    } catch (error) {
+      throw new RateAppError(`Failed to request review: ${error}`);
+    }
+  },
+
+  /**
+   * Opens the store listing for the app.
+   * @param props The properties for the store listing.
+   * @returns A promise that resolves to a boolean indicating whether the store listing was successfully opened.
+   */
+  async openStoreForReview({
+    iOSAppId,
+    androidPackageName,
+    androidMarket = AndroidMarket.GOOGLE,
+  }: OpenStoreForReviewProps): Promise<boolean> {
+    const isIOS = Platform.OS === "ios";
+    const ismacOS = Platform.OS === "macos";
+    const isAndroid = Platform.OS === "android";
+    let url = "";
+
+    if (isIOS || ismacOS) {
+      if (!iOSAppId) {
+        throw new RateAppError("iOSAppId is required for iOS and macOS");
+      }
+      url = `${IOS_REVIEW_URL}${iOSAppId}?action=write-review`;
+    } else if (isAndroid) {
+      if (!androidPackageName) {
+        throw new RateAppError("androidPackageName is required for Android");
+      }
+      url = this.getAndroidMarketUrl(androidMarket, androidPackageName);
+    } else {
+      throw new RateAppError(`Unsupported platform: ${Platform.OS}`);
+    }
+
+    try {
+      const canOpenURL = await Linking.canOpenURL(url);
+      if (canOpenURL) {
+        await Linking.openURL(url);
+      }
+      return canOpenURL;
+    } catch (error) {
+      throw new RateAppError(`Failed to open store for review: ${error}`);
+    }
+  },
+
+  /**
+   * Gets the URL for the Android market.
+   * @param androidMarket The market where the app's store listing should be opened on Android.
+   * @param androidPackageName The package name of the app to open the store listing for on Android.
+   * @returns The URL for the Android market.
+   */
+  getAndroidMarketUrl(
+    androidMarket: AndroidMarket,
+    androidPackageName: string,
+  ): string {
+    const urlTemplate = ANDROID_MARKET_URLS[androidMarket];
+    if (!urlTemplate) {
+      throw new RateAppError(`Unsupported Android market: ${androidMarket}`);
+    }
+    return urlTemplate.replace("{packageName}", androidPackageName);
+  },
+};
+
+export * from "./types";
+export * from "./constants";
+export const { requestReview, openStoreForReview, getAndroidMarketUrl } =
+  RateApp;
+export default RateApp;

package/src/types.ts

@@ -0,0 +1,22 @@
+export enum AndroidMarket {
+  GOOGLE = "google",
+  AMAZON = "amazon",
+  SAMSUNG = "samsung",
+  HUAWEI = "huawei",
+}
+
+export interface OpenStoreForReviewProps {
+  /**
+   * The App Store ID of the app to open the store listing for on iOS.
+   */
+  iOSAppId?: string;
+  /**
+   * The package name of the app to open the store listing for on Android.
+   */
+  androidPackageName?: string;
+  /**
+   * The market where the app's store listing should be opened on Android.
+   * @default AndroidMarket.GOOGLE
+   */
+  androidMarket?: AndroidMarket;
+}