@capgo/native-market 8.0.0 → 8.0.2

package/android/build.gradle

@@ -1,8 +1,8 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
 }
 
 buildscript {
@@ -11,18 +11,18 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.0.1'
+        classpath 'com.android.tools.build:gradle:8.13.0'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    namespace "com.getcapacitor.community.nativemarket.nativemarket"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    namespace = "com.getcapacitor.community.nativemarket.nativemarket"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
     defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -34,7 +34,7 @@ android {
         }
     }
     lintOptions {
-        abortOnError false
+        abortOnError = false
         disable "UnsafeExperimentalUsageError",
                     "UnsafeExperimentalUsageWarning"
     }

package/android/src/main/java/com/getcapacitor/community/nativemarket/NativeMarket.java

@@ -3,7 +3,7 @@ package com.getcapacitor.community.nativemarket;
 import android.content.Context;
 import android.content.Intent;
 import android.net.Uri;
-import com.getcapacitor.NativePlugin;
+import com.getcapacitor.JSObject;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
@@ -12,120 +12,119 @@ import com.getcapacitor.annotation.CapacitorPlugin;
 @CapacitorPlugin(name = "NativeMarket")
 public class NativeMarket extends Plugin {
 
-  @PluginMethod
-  public void openStoreListing(PluginCall call) {
-    try {
-      if (call.hasOption("appId")) {
-        String appId = call.getString("appId");
-
-        Context context = this.bridge.getActivity().getApplicationContext();
-        Intent intent = new Intent(
-          Intent.ACTION_VIEW,
-          Uri.parse("market://details?id=" + appId)
-        );
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        context.startActivity(intent);
-
-        call.resolve();
-      } else {
-        call.reject("appId is missing");
-      }
-    } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+    private final String pluginVersion = "";
+
+    @PluginMethod
+    public void openStoreListing(PluginCall call) {
+        try {
+            String appId = call.getString("appId");
+            if (appId == null || appId.isEmpty()) {
+                call.reject("appId is missing");
+                return;
+            }
+
+            Context context = this.bridge.getActivity().getApplicationContext();
+            Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("market://details?id=" + appId));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(intent);
+
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
     }
-  }
-
-  @PluginMethod
-  public void openDevPage(PluginCall call) {
-    try {
-      if (call.hasOption("devId")) {
-        String devId = call.getString("devId");
-
-        Context context = this.getContext();
-        Intent intent = new Intent(Intent.ACTION_VIEW);
-        intent.setData(
-          Uri.parse("https://play.google.com/store/apps/dev?id=" + devId)
-        );
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        context.startActivity(intent);
-
-        call.resolve();
-      } else {
-        call.reject("devId is missing");
-      }
-    } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+
+    @PluginMethod
+    public void openDevPage(PluginCall call) {
+        try {
+            String devId = call.getString("devId");
+            if (devId == null || devId.isEmpty()) {
+                call.reject("devId is missing");
+                return;
+            }
+
+            Context context = this.getContext();
+            Intent intent = new Intent(Intent.ACTION_VIEW);
+            intent.setData(Uri.parse("https://play.google.com/store/apps/dev?id=" + devId));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(intent);
+
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void openCollection(PluginCall call) {
+        try {
+            String name = call.getString("name");
+            if (name == null || name.isEmpty()) {
+                call.reject("name is missing");
+                return;
+            }
+
+            Context context = this.getContext();
+            Intent intent = new Intent(Intent.ACTION_VIEW);
+            intent.setData(Uri.parse("https://play.google.com/store/apps/collection/" + name));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(intent);
+
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
     }
-  }
-
-  @PluginMethod
-  public void openCollection(PluginCall call) {
-    try {
-      if (call.hasOption("name")) {
-        String name = call.getString("name");
-
-        Context context = this.getContext();
-        Intent intent = new Intent(Intent.ACTION_VIEW);
-        intent.setData(
-          Uri.parse("https://play.google.com/store/apps/collection/" + name)
-        );
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        context.startActivity(intent);
-
-        call.resolve();
-      } else {
-        call.reject("name is missing");
-      }
-    } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+
+    @PluginMethod
+    public void openEditorChoicePage(PluginCall call) {
+        try {
+            String editorChoice = call.getString("editorChoice");
+            if (editorChoice == null || editorChoice.isEmpty()) {
+                call.reject("editorChoice is missing");
+                return;
+            }
+
+            Context context = this.getContext();
+            Intent intent = new Intent(Intent.ACTION_VIEW);
+            intent.setData(Uri.parse("https://play.google.com/store/apps/topic?id=" + editorChoice));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(intent);
+
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
     }
-  }
-
-  @PluginMethod
-  public void openEditorChoicePage(PluginCall call) {
-    try {
-      if (call.hasOption("editorChoice")) {
-        String editorChoice = call.getString("editorChoice");
-
-        Context context = this.getContext();
-        Intent intent = new Intent(Intent.ACTION_VIEW);
-        intent.setData(
-          Uri.parse(
-            "https://play.google.com/store/apps/topic?id=" + editorChoice
-          )
-        );
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        context.startActivity(intent);
-
-        call.resolve();
-      } else {
-        call.reject("editorChoice is missing");
-      }
-    } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+
+    @PluginMethod
+    public void search(PluginCall call) {
+        try {
+            String terms = call.getString("terms");
+            if (terms == null || terms.isEmpty()) {
+                call.reject("terms is missing");
+                return;
+            }
+
+            Context context = this.getContext();
+            Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("market://search?q=" + terms));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(intent);
+
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
     }
-  }
-
-  @PluginMethod
-  public void search(PluginCall call) {
-    try {
-      if (call.hasOption("terms")) {
-        String terms = call.getString("terms");
-
-        Context context = this.getContext();
-        Intent intent = new Intent(
-          Intent.ACTION_VIEW,
-          Uri.parse("market://search?q=" + terms)
-        );
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        context.startActivity(intent);
-
-        call.resolve();
-      } else {
-        call.reject("terms is missing");
-      }
-    } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+
+    @PluginMethod
+    public void getPluginVersion(final PluginCall call) {
+        try {
+            final JSObject ret = new JSObject();
+            ret.put("version", this.pluginVersion);
+            call.resolve(ret);
+        } catch (final Exception e) {
+            call.reject("Could not get plugin version", e);
+        }
     }
-  }
 }

package/dist/docs.json

@@ -2,157 +2,229 @@
   "api": {
     "name": "NativeMarketPlugin",
     "slug": "nativemarketplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Native Market Plugin for opening app store listings and pages.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "openStoreListing",
-        "signature": "(options: { appId: string; country?: string; }) => any",
+        "signature": "(options: { appId: string; country?: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Configuration for opening the store listing",
             "type": "{ appId: string; country?: string | undefined; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "appId - ID of your application. Eg. com.example.app"
+            "text": "options - Configuration for opening the store listing"
           },
           {
-            "name": "param",
-            "text": "country - International country code if application is not published in the US App store (only for iOS). Eg. IT"
+            "name": "returns",
+            "text": "Promise that resolves when the store is opened"
           },
           {
-            "name": "returns",
-            "text": "void"
+            "name": "throws",
+            "text": "Error if opening the store fails"
           },
           {
             "name": "since",
             "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Open app in store\nawait NativeMarket.openStoreListing({\n  appId: 'com.example.app'\n});\n\n// Open app in specific country store (iOS only)\nawait NativeMarket.openStoreListing({\n  appId: 'com.example.app',\n  country: 'IT'\n});\n```"
           }
         ],
-        "docs": "This method will launch link in Play/App Store.",
+        "docs": "Launch app listing page in Play Store (Android) or App Store (iOS).",
         "complexTypes": [],
         "slug": "openstorelisting"
       },
       {
         "name": "openDevPage",
-        "signature": "(options: { devId: string; }) => any",
+        "signature": "(options: { devId: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Configuration with developer ID",
             "type": "{ devId: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "devId - ID of developer. Eg. com.example.app"
+            "text": "options - Configuration with developer ID"
           },
           {
             "name": "returns",
-            "text": "void"
+            "text": "Promise that resolves when the page is opened"
+          },
+          {
+            "name": "throws",
+            "text": "Error if opening the page fails or if called on iOS"
           },
           {
             "name": "since",
             "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait NativeMarket.openDevPage({\n  devId: 'Google+LLC'\n});\n```"
           }
         ],
-        "docs": "This method will deep-link directly to an Play/App store listing page.\n\nOnly in Android.",
+        "docs": "Deep-link directly to a developer's page in the Play Store.\nAndroid only.",
         "complexTypes": [],
         "slug": "opendevpage"
       },
       {
         "name": "openCollection",
-        "signature": "(options: { name: string; }) => any",
+        "signature": "(options: { name: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Configuration with collection name",
             "type": "{ name: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "name - name of the collection. Click [here](https://developer.android.com/distribute/marketing-tools/linking-to-google-play#OpeningCollection) for android options."
+            "text": "options - Configuration with collection name"
           },
           {
             "name": "returns",
-            "text": "void"
+            "text": "Promise that resolves when the collection is opened"
+          },
+          {
+            "name": "throws",
+            "text": "Error if opening the collection fails or if called on iOS"
           },
           {
             "name": "since",
             "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait NativeMarket.openCollection({\n  name: 'featured'\n});\n```"
+          },
+          {
+            "name": "see",
+            "text": "https ://developer.android.com/distribute/marketing-tools/linking-to-google-play#OpeningCollection"
           }
         ],
-        "docs": "This method will link users to a collection or top charts.\nOnly in Android.",
+        "docs": "Link users to a collection or top charts in the Play Store.\nAndroid only.",
         "complexTypes": [],
         "slug": "opencollection"
       },
       {
         "name": "openEditorChoicePage",
-        "signature": "(options: { editorChoice: string; }) => any",
+        "signature": "(options: { editorChoice: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Configuration with editor choice ID",
             "type": "{ editorChoice: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "editorChoice - ID of your application. Eg. editorial_fitness_apps_us"
+            "text": "options - Configuration with editor choice ID"
           },
           {
             "name": "returns",
-            "text": "void"
+            "text": "Promise that resolves when the page is opened"
+          },
+          {
+            "name": "throws",
+            "text": "Error if opening the page fails or if called on iOS"
           },
           {
             "name": "since",
             "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait NativeMarket.openEditorChoicePage({\n  editorChoice: 'editorial_fitness_apps_us'\n});\n```"
           }
         ],
-        "docs": "This method will link users to Editor's choice page.\n\nOnly in Android.",
+        "docs": "Link users to Editor's choice page in the Play Store.\nAndroid only.",
         "complexTypes": [],
         "slug": "openeditorchoicepage"
       },
       {
         "name": "search",
-        "signature": "(options: { terms: string; }) => any",
+        "signature": "(options: { terms: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Configuration with search terms",
             "type": "{ terms: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "editorChoice - terms to be searched in Play/App store."
+            "text": "options - Configuration with search terms"
           },
           {
             "name": "returns",
-            "text": "void"
+            "text": "Promise that resolves when the search is opened"
+          },
+          {
+            "name": "throws",
+            "text": "Error if opening search fails or if called on iOS"
           },
           {
             "name": "since",
             "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait NativeMarket.search({\n  terms: 'fitness apps'\n});\n```"
           }
         ],
-        "docs": "This method will link users to custom search query.\n\nOnly in Android.",
+        "docs": "Search the Play Store with custom search terms.\nAndroid only.",
         "complexTypes": [],
         "slug": "search"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await NativeMarket.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
       }
     ],
     "properties": []