Merge pull request #1 from appupgrade-dev/platform-supports

Add support for Amazon app store, Huawei AppGallery and other android market places.

Author: appupgrade-dev

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes will be documented in this file.
 
+## [1.0.11] - 2023-02-27
+
+* Added support for Amazon, Huawei and other marketplaces.
+
 ## [1.0.10] - 2023-02-03
 
 * Fix url encoding for app name.

README.md

@@ -14,6 +14,12 @@ This SDK communicate with App Upgrade and check the version with store version i
 - If app needs to be updated but not a force update, it will show a dismissable popup.
 - If no action is required it won't do anything.
 
+App Upgrade is a cross platform solution to getting users to easily update your app.
+##### Stores Supported:
+Apple App Store | Google Play Store | Amazon App Store | Huawei AppGallery | Other Android Markets
+--- | --- | --- | --- | ---
+**✓** | **✓** | **✓** | **✓** |  **✓** If your app market place isn't one of these you can pass your own store URL.
+
 ## Installation
 Install via npm
 ```
@@ -26,6 +32,7 @@ Or if using Expo than you can use `expo install app-upgrade-react-native-sdk` as
 1. Register on App Upgrade and follow the instructions to create project and get the x-api-key.
 
 2. Import the SDK and use it.
+### React Native Example
 ```
 import {appUpgradeVersionCheck} from 'app-upgrade-react-native-sdk';
 
@@ -61,19 +68,9 @@ const App: () => Node = () => {
   );
 };
 
-```
-### Note:
-1. For opening the app store or play store the app should be live.
-2. It might not be able to open the app store or play store in simulator. You can try it in physical device.
-3. If you are using the same code base for both android and ios than you can detect the platform and provide the appId.
-4. You can find a sample app from here [app-upgrade-react-native-demo-app](https://github.com/appupgrade-dev/app_upgrade_react_native_demo_app)
-r. Read detailed blog on how to integrate from here [How to upgrade/force upgrade React Native app](https://appupgrade.dev/blog/how-to-force-upgrade-react-native-app)
-
-```
-const appId = Platform.OS === 'android' ? 'com.android.chrome' : 'id310633997'
 ```
 
-Expo Example:
+### Expo Example:
 ```
 import {appUpgradeVersionCheck} from 'app-upgrade-react-native-sdk';
 
@@ -109,6 +106,74 @@ export default function App() {
   );
 }
 
+```
+### Note:
+1. For opening the app store or play store the app should be live.
+2. It might not be able to open the app store or play store in simulator. You can try it in physical device.
+3. If you are using the same code base for both android and ios than you can detect the platform and provide the appId.
+4. You can find a sample app from here [app-upgrade-react-native-demo-app](https://github.com/appupgrade-dev/app_upgrade_react_native_demo_app)
+5. Read detailed blog on how to integrate from here [How to upgrade/force upgrade React Native app](https://appupgrade.dev/blog/how-to-force-upgrade-react-native-app)
+
+### Example with store other than app store or play store.
+If you want users to redirect to store other than app store or playstore. You can add these additional parameters **preferredAndroidMarket** see the example below.
+```
+import {appUpgradeVersionCheck, PreferredAndroidMarket } from 'app-upgrade-react-native-sdk';
+
+.....
+
+const App: () => Node = () => {
+
+  const xApiKey = "MDNmNmZkNDEtNmNkMi00NzY3LThjOWEtYWYxMGFjZWQ0ZjI2"; // Your project key
+  const appInfo = {
+    appId: 'com.android.com' or 'id1549468967', // Your app url in play store or app store
+    appName: 'Wallpaper app', // Your app name
+    appVersion: '1.0.0', // Your app version
+    platform: 'android', // App Platform, android or ios
+    environment: 'production', // App Environment, production, development
+    appLanguage: 'es' //Your app language ex: en, es etc. Optional.
+    preferredAndroidMarket: PreferredAndroidMarket.AMAZON // or PreferredAndroidMarket.HUAWEI or PreferredAndroidMarket.OTHER If not provided default is Google playstore. Optional
+  };
+
+  appUpgradeVersionCheck(appInfo, xApiKey);
+
+  return (
+      <SafeAreaView style={backgroundStyle}>
+        ...
+      </SafeAreaView>
+  );
+};
+
+```
+
+If you want to redirect user to some other android market place you can use the following example:
+```
+import {appUpgradeVersionCheck, PreferredAndroidMarket } from 'app-upgrade-react-native-sdk';
+
+.....
+
+const App: () => Node = () => {
+
+  const xApiKey = "MDNmNmZkNDEtNmNkMi00NzY3LThjOWEtYWYxMGFjZWQ0ZjI2"; // Your project key
+  const appInfo = {
+    appId: 'com.android.com' or 'id1549468967', // Your app url in play store or app store
+    appName: 'Wallpaper app', // Your app name
+    appVersion: '1.0.0', // Your app version
+    platform: 'android', // App Platform, android or ios
+    environment: 'production', // App Environment, production, development
+    appLanguage: 'es' //Your app language ex: en, es etc. Optional.
+    preferredAndroidMarket: PreferredAndroidMarket.OTHER
+    otherAndroidMarketUrl: 'https://someotherandroidmarket.com/app/id'// Required if preferredAndroidMarket is Other.
+  };
+
+  appUpgradeVersionCheck(appInfo, xApiKey);
+
+  return (
+      <SafeAreaView style={backgroundStyle}>
+        ...
+      </SafeAreaView>
+  );
+};
+
 ```
 
 ## Example Screenshot

index.js

@@ -1,7 +1,14 @@
 import { versionCheck } from "./src/version-check";
 
+const PreferredAndroidMarket = {
+  GOOGLE: 'Google',
+  HUAWEI: 'Huawei',
+  AMAZON: 'Amazon',
+  OTHER: 'Other',
+}
+
 function appUpgradeVersionCheck(appInfo, xApiKey, alertInfo) {
   versionCheck(appInfo, xApiKey, alertInfo);
 }
 
-export { appUpgradeVersionCheck };
+export { appUpgradeVersionCheck, PreferredAndroidMarket };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "app-upgrade-react-native-sdk",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Official App Upgrade react-native sdk",
   "main": "index.js",
   "scripts": {

src/validation.js

@@ -1,3 +1,5 @@
+import { PreferredAndroidMarket } from "app-upgrade-react-native-sdk";
+
 function validate(appInfo, xApiKey) {
   if (!xApiKey || xApiKey === undefined || xApiKey === "") {
     console.error("App Upgrade Validation Error: xApiKey is required.");
@@ -42,9 +44,28 @@ function validate(appInfo, xApiKey) {
   ) {
     console.error("App Upgrade Validation Error: environment is required.");
     return false;
+  } else if (
+    appInfo.preferredAndroidMarket &&
+    appInfo.preferredAndroidMarket === PreferredAndroidMarket.OTHER &&
+    !appInfo.otherAndroidMarketUrl
+  ) {
+    console.error(
+      "App Upgrade Validation Error: otherMarketUrl is required when prefferedAndroidMarket is Other."
+    );
+    return false;
+  } else if (
+    appInfo.preferredAndroidMarket &&
+    !Object.values(PreferredAndroidMarket).includes(
+      appInfo.preferredAndroidMarket
+    )
+  ) {
+    console.error(
+      "App Upgrade Validation Error: Unsupported prefferedAndroidMarket value."
+    );
+    return false;
   } else {
     return true;
   }
 }
 
-export { validate };
+export { validate };

src/version-check.js

@@ -1,6 +1,7 @@
 import { validate } from "./validation";
 import { checkVersionWithAppUpgrade } from "./api";
 import { Platform, Alert, Linking } from "react-native";
+import { PreferredAndroidMarket } from "app-upgrade-react-native-sdk";
 
 async function versionCheck(appInfo, xApiKey, alertInfo) {
   const isValid = validate(appInfo, xApiKey);
@@ -38,7 +39,7 @@ function showForceUpgradeAlert(appInfo, alertInfo, msg) {
         text: alertInfo.updateButtonTitle,
         onPress: () => {
           showForceUpgradeAlert(appInfo, alertInfo, msg)
-          redirectToStore(appInfo.appId)
+          redirectToStore(appInfo)
         },
       },
     ],
@@ -60,7 +61,7 @@ function showUpgradeAlert(appInfo, alertInfo, msg) {
       },
       {
         text: alertInfo.updateButtonTitle,
-        onPress: () => redirectToStore(appInfo.appId),
+        onPress: () => redirectToStore(appInfo),
       },
     ],
     {
@@ -71,12 +72,31 @@ function showUpgradeAlert(appInfo, alertInfo, msg) {
   );
 }
 
-function redirectToStore(appId) {
+function redirectToStore(appInfo) {
   if (Platform.OS === 'android') {
-    Linking.openURL(`https://play.google.com/store/apps/details?id=${appId}`);
+    if (appInfo.preferredAndroidMarket === PreferredAndroidMarket.GOOGLE) {
+      const url = `https://play.google.com/store/apps/details?id=${appInfo.appId}`
+      openStore(url);
+    } else if (appInfo.preferredAndroidMarket === PreferredAndroidMarket.HUAWEI) {
+      const url = `appmarket://details?id=${appInfo.appId}`;
+      openStore(url);
+    } else if (appInfo.preferredAndroidMarket === PreferredAndroidMarket.AMAZON) {
+      const url = `https://www.amazon.com/gp/mas/dl/android?p=${appInfo.appId}`;
+      openStore(url);
+    } else if (appInfo.preferredAndroidMarket === PreferredAndroidMarket.OTHER) {
+      Linking.openURL(appInfo.otherAndroidMarketUrl);
+    } else {
+      Linking.openURL(`https://play.google.com/store/apps/details?id=${appInfo.appId}`);
+    }
   } else {
-    Linking.openURL(`https://apps.apple.com/app/id/${appId}`);
+    Linking.openURL(`https://apps.apple.com/app/id/${appInfo.appId}`);
   }
 }
 
+function openStore(url) {
+  Linking.openURL(url).catch((err) => {
+    console.debug("App Upgrade Error: ", err);
+  })
+}
+
 export { versionCheck };