Merge pull request #53 from capacitor-community/capacitor-v3

Capacitor V3 Support

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
         with:
           node-version: "12"
       - name: Install NPM Dependencies
-        run: npm install
+        run: npm ci
       - name: Build NPM Module
         run: npm run build
       - name: Install Cocoapods
@@ -47,7 +47,7 @@ jobs:
           distribution: "zulu"
           java-version: "8"
       - name: Install NPM Dependencies
-        run: npm install
+        run: npm ci
       - name: Build NPM Module
         run: npm run build
       - name: Run Android Tests

CapacitorCommunityFirebaseAnalytics.podspec

@@ -9,7 +9,7 @@ Pod::Spec.new do |s|
     s.author = package['author']
     s.source = { :git => 'https://github.com/capacitor-community/firebase-analytics', :tag => s.version.to_s }
     s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
-    s.ios.deployment_target  = '11.0'
+    s.ios.deployment_target  = '12.0'
     s.static_framework = true
     s.dependency 'Capacitor'
     s.dependency 'Firebase'

README.md

@@ -105,12 +105,7 @@ git checkout -b firebase-analytics
 ## Usage
 
 ```typescript
-// Must import the package once to make sure the web support initializes
-import "@capacitor-community/firebase-analytics";
-
-import { Plugins } from "@capacitor/core";
-
-const { FirebaseAnalytics } = Plugins;
+import { FirebaseAnalytics } from "@capacitor-community/firebase-analytics";
 
 /**
  * Platform: Web

android/.npmignore

@@ -1 +1,3 @@
-/build
+.gradle
+build
+local.properties

android/build.gradle

@@ -1,7 +1,8 @@
 ext {
     junitVersion =  project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.12'
-    androidxJunitVersion =  project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.1'
-    androidxEspressoCoreVersion =  project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.2.0'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.2.0'
+    androidxJunitVersion =  project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.2'
+    androidxEspressoCoreVersion =  project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.3.0'
 }
 
 buildscript {
@@ -19,10 +20,10 @@ buildscript {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 29
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 29
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -48,6 +49,7 @@ repositories {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

android/src/main/AndroidManifest.xml

@@ -1,5 +1,4 @@
-
-  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-      package="com.getcapacitor.community.firebaseanalytics.firebaseanalytics">
-  </manifest>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="com.getcapacitor.community.firebaseanalytics.firebaseanalytics">
+</manifest>
 

android/src/main/java/com/getcapacitor/community/firebaseanalytics/FirebaseAnalytics.java

@@ -4,20 +4,28 @@
 import android.os.Bundle;
 import androidx.annotation.NonNull;
 import com.getcapacitor.JSObject;
-import com.getcapacitor.NativePlugin;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.android.gms.tasks.Task;
 import java.util.Iterator;
 import org.json.JSONObject;
 
-@NativePlugin(
+@CapacitorPlugin(
+  name = "FirebaseAnalytics",
   permissions = {
-    Manifest.permission.ACCESS_NETWORK_STATE,
-    Manifest.permission.INTERNET,
-    Manifest.permission.WAKE_LOCK,
+    @Permission(
+      strings = { Manifest.permission.ACCESS_NETWORK_STATE },
+      alias = "network"
+    ),
+    @Permission(strings = { Manifest.permission.INTERNET }, alias = "internet"),
+    @Permission(
+      strings = { Manifest.permission.WAKE_LOCK },
+      alias = "wakelock"
+    ),
   }
 )
 public class FirebaseAnalytics extends Plugin {
@@ -33,7 +41,7 @@ public void load() {
     // Obtain the FirebaseAnalytics instance.
     mFirebaseAnalytics =
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-        this.bridge.getActivity()
+        bridge.getActivity()
       );
   }
 
@@ -45,20 +53,20 @@ public void load() {
   public void setUserId(PluginCall call) {
     try {
       if (mFirebaseAnalytics == null) {
-        call.error(MISSING_REF_MSSG);
+        call.reject(MISSING_REF_MSSG);
         return;
       }
 
       if (!call.hasOption("userId")) {
-        call.error("userId property is missing");
+        call.reject("userId property is missing");
         return;
       }
 
       String userId = call.getString("userId");
       mFirebaseAnalytics.setUserId(userId);
-      call.success();
+      call.resolve();
     } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+      call.reject(ex.getLocalizedMessage());
     }
   }
 
@@ -71,27 +79,27 @@ public void setUserId(PluginCall call) {
   public void setUserProperty(PluginCall call) {
     try {
       if (mFirebaseAnalytics == null) {
-        call.error(MISSING_REF_MSSG);
+        call.reject(MISSING_REF_MSSG);
         return;
       }
 
       if (!call.hasOption("name")) {
-        call.error("name property is missing");
+        call.reject("name property is missing");
         return;
       }
 
       if (!call.hasOption("value")) {
-        call.error("value property is missing");
+        call.reject("value property is missing");
         return;
       }
 
       String name = call.getString("name");
       String value = call.getString("value");
 
       mFirebaseAnalytics.setUserProperty(name, value);
-      call.success();
+      call.resolve();
     } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+      call.reject(ex.getLocalizedMessage());
     }
   }
 
@@ -102,7 +110,7 @@ public void setUserProperty(PluginCall call) {
   @PluginMethod
   public void getAppInstanceId(final PluginCall call) {
     if (mFirebaseAnalytics == null) {
-      call.error(MISSING_REF_MSSG);
+      call.reject(MISSING_REF_MSSG);
       return;
     }
     Task<String> task = mFirebaseAnalytics.getAppInstanceId();
@@ -112,15 +120,15 @@ public void onComplete(@NonNull Task<String> task) {
             if (task.isSuccessful()) {
               String instanceId = task.getResult();
               if (instanceId.isEmpty()) {
-                call.error("failed to obtain app instance id");
+                call.reject("failed to obtain app instance id");
               } else {
                 JSObject result = new JSObject();
                 result.put("instanceId", instanceId);
-                call.success(result);
+                call.resolve(result);
               }
             } else {
                 Exception exception = task.getException();
-                call.error(exception.getLocalizedMessage());
+                call.reject(exception.getLocalizedMessage());
             }
         }
     });
@@ -135,12 +143,12 @@ public void onComplete(@NonNull Task<String> task) {
   public void setScreenName(final PluginCall call) {
     try {
       if (mFirebaseAnalytics == null) {
-        call.error(MISSING_REF_MSSG);
+        call.reject(MISSING_REF_MSSG);
         return;
       }
 
       if (!call.hasOption("screenName")) {
-        call.error("screenName property is missing");
+        call.reject("screenName property is missing");
         return;
       }
 
@@ -167,12 +175,12 @@ public void run() {
                 com.google.firebase.analytics.FirebaseAnalytics.Event.SCREEN_VIEW,
                 bundle
               );
-              call.success();
+              call.resolve();
             }
           }
         );
     } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+      call.reject(ex.getLocalizedMessage());
     }
   }
 
@@ -184,14 +192,14 @@ public void run() {
   public void reset(PluginCall call) {
     try {
       if (mFirebaseAnalytics == null) {
-        call.error(MISSING_REF_MSSG);
+        call.reject(MISSING_REF_MSSG);
         return;
       }
 
       mFirebaseAnalytics.resetAnalyticsData();
-      call.success();
+      call.resolve();
     } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+      call.reject(ex.getLocalizedMessage());
     }
   }
 
@@ -204,12 +212,12 @@ public void reset(PluginCall call) {
   public void logEvent(PluginCall call) {
     try {
       if (mFirebaseAnalytics == null) {
-        call.error(MISSING_REF_MSSG);
+        call.reject(MISSING_REF_MSSG);
         return;
       }
 
       if (!call.hasOption("name")) {
-        call.error("name property is missing");
+        call.reject("name property is missing");
         return;
       }
 
@@ -240,9 +248,9 @@ public void logEvent(PluginCall call) {
       }
 
       mFirebaseAnalytics.logEvent(name, bundle);
-      call.success();
+      call.resolve();
     } catch (Exception ex) {
-      call.error(ex.getLocalizedMessage());
+      call.reject(ex.getLocalizedMessage());
     }
   }
 
@@ -253,14 +261,14 @@ public void logEvent(PluginCall call) {
   @PluginMethod
   public void setCollectionEnabled(PluginCall call) {
     if (mFirebaseAnalytics == null) {
-      call.error(MISSING_REF_MSSG);
+      call.reject(MISSING_REF_MSSG);
       return;
     }
 
     boolean enabled = call.getBoolean("enabled", false);
 
     mFirebaseAnalytics.setAnalyticsCollectionEnabled(enabled);
-    call.success();
+    call.resolve();
   }
 
   /**
@@ -272,12 +280,12 @@ public void setCollectionEnabled(PluginCall call) {
   @PluginMethod
   public void enable(PluginCall call) {
     if (mFirebaseAnalytics == null) {
-      call.error(MISSING_REF_MSSG);
+      call.reject(MISSING_REF_MSSG);
       return;
     }
 
     mFirebaseAnalytics.setAnalyticsCollectionEnabled(true);
-    call.success();
+    call.resolve();
   }
 
   /**
@@ -289,12 +297,12 @@ public void enable(PluginCall call) {
   @PluginMethod
   public void disable(PluginCall call) {
     if (mFirebaseAnalytics == null) {
-      call.error(MISSING_REF_MSSG);
+      call.reject(MISSING_REF_MSSG);
       return;
     }
 
     mFirebaseAnalytics.setAnalyticsCollectionEnabled(false);
-    call.success();
+    call.resolve();
   }
 
   /**
@@ -304,13 +312,13 @@ public void disable(PluginCall call) {
   @PluginMethod
   public void setSessionTimeoutDuration(PluginCall call) {
     if (mFirebaseAnalytics == null) {
-      call.error(MISSING_REF_MSSG);
+      call.reject(MISSING_REF_MSSG);
       return;
     }
 
     int duration = call.getInt("duration", 1800);
 
     mFirebaseAnalytics.setSessionTimeoutDuration(duration);
-    call.success();
+    call.resolve();
   }
 }

ios/.npmignore

@@ -0,0 +1,4 @@
+Pods/
+Podfile.lock
+contents.xcworkspacedata
+xcuserdata/