cordova-plugin-firebasex - npm Package Compare versions

Comparing version 16.5.0 to 17.0.0-cli

CHANGELOG.md

@@ -1,2 +0,15 @@
-# Version 16.5.0
+# Version 17.0.0
+* (ios) BREAKING: Update pinned Firebase SDK versions to [v11.2.0](https://firebase.google.com/support/release-notes/ios#version_1120_-_september_10_2024) and updated related dependencies: GoogleSignIn v7.0.0, GoogleTagManager v8.0.0
+  * Firebase iOS SDK v11 supports iOS 13+
+    * BREAKING: drops support for iOS 12 which was supported by Firebase iOS SDK v10
+  * Resolves [#892](https://github.com/dpa99c/cordova-plugin-firebasex/issues/892)
+* (ios) Update to use Google Sign-In SDK v7 signatures.
+  * Resolves [#809](https://github.com/dpa99c/cordova-plugin-firebasex/issues/809)
+* (ios) bugfix: gracefully handle missing iOS deployment target in Podfile.
+    * Resolves [#868](https://github.com/dpa99c/cordova-plugin-firebasex/issues/868)
+* (Android) update: Pin latest Firebase SDK component versions to [Bom v33.3.0](https://firebase.google.com/support/release-notes/android#bom_v33-3-0) as of [12 Sep 2024](https://firebase.google.com/support/release-notes/android#2024-09-12)
+* fix: Queue global JS executions if plugin is not yet initialized to prevent calling functions on the plugin JS API before Cordova has loaded the plugin JS namespace.
+  * Resolves [#888](https://github.com/dpa99c/cordova-plugin-firebasex/issues/888)
+
+# Version 16.5.0-cli
 * (Android) update: Pin latest Firebase SDK component versions as of [11 Apr 2024](https://firebase.google.com/support/release-notes/android#2024-04-11)
@@ -15,3 +28,3 @@ * (iOS) update: Pin latest Firebase SDK components v10.24.0 as of [9 Apr 2024](https://firebase.google.com/support/release-notes/ios#version_10240_-_april_9_2024)
 
-# Version 16.4.0
+# Version 16.4.0-cli
 * (doc) Add note about xmlns:android attribute for config.xml
@@ -31,3 +44,3 @@ Merged from PR [#840](https://github.com/dpa99c/cordova-plugin-firebasex/pull/840)
 
-# Version 16.3.0
+# Version 16.3.0-cli
 * (Android) apply FIREBASE_ANALYTICS_WITHOUT_ADS plugin variable to disable AD ID data collection and remove AD ID permission from manifest
@@ -42,3 +55,3 @@ * (iOS) build: apply FIREBASE_ANALYTICS_WITHOUT_ADS and IOS_ON_DEVICE_CONVERSION_ANALYTICS plugin variables to plugin.xml using npm post_install script
 
-# Version 16.2.0
+# Version 16.2.0-cli
 * (iOS) add npm post_install script to apply IOS_USE_PRECOMPILED_FIRESTORE_POD plugin variable to plugin.xml before the plugin config is loaded by Cordova
@@ -60,3 +73,3 @@ * (iOS) use product pods for firebase packages
 
-# Version 16.1.0
+# Version 16.1.0-cli
 * (iOS) feat: add support for IOS_FCM_ENABLED variable to allow disabling FCM functionality on iOS
@@ -66,3 +79,3 @@ * Merged from PR [#797](https://github.com/dpa99c/cordova-plugin-firebasex/pull/797)
     * Merged from PR [#793](https://github.com/dpa99c/cordova-plugin-firebasex/pull/793)
-* (iOS) doc: Tutorial to make the necessary configurations to send images in notifications
+* (iOS) doc: Tutorial to make the necessary configurations to send images in notifications    
     * Merged from PR [#798](https://github.com/dpa99c/cordova-plugin-firebasex/pull/798)
@@ -82,3 +95,3 @@ * (iOS) Fix foreground notifications not being displayed after calling grantPermission when permissions haven't been previously granted
 
-# Version 16.0.0
+# Version 16.0.0-cli
 * (iOS & Android) **BREAKING CHANGE**: Changed signature of `verifyPhoneNumber()` to pass optional arguments as an object.
@@ -91,3 +104,3 @@ * (iOS & Android) feat: Add support for multi-factor authentication
 
-# Version 15.0.0
+# Version 15.0.0-cli
 * (Android) Update pinned Firebase SDK component versions to [BOM v31.1.0 - November 17, 2022](https://firebase.google.com/support/release-notes/android#2022-11-17)
@@ -110,3 +123,3 @@ * (iOS) Update pinned version of Firebase SDK to [v10.2.0 - November 15, 2022](https://firebase.google.com/support/release-notes/ios#version_1020_-_november_15_2022)
 
-# Version 14.2.1
+# Version 14.2.1-cli
 * (iOS) bugfix: remove openURL delegate that was erroneously re-added by merge error.
@@ -116,3 +129,3 @@ * Re-implements PR [#731](https://github.com/dpa99c/cordova-plugin-firebasex/pull/731)
 
-# Version 14.2.0
+# Version 14.2.0-cli
 * (Android) bugfix: Fix no notifications on Android 12 and above
@@ -127,3 +140,3 @@ * Merged from PR [#747](https://github.com/dpa99c/cordova-plugin-firebasex/pull/747)
 
-# Version 14.1.0
+# Version 14.1.0-cli
 * (Doc) bugfix: Fix markdown issue caused by unescaped HTML tags.
@@ -148,3 +161,3 @@ * Resolves [#707](https://github.com/dpa99c/cordova-plugin-firebasex/issues/707)
 
-# Version 14.0.0
+# Version 14.0.0-cli
 * (iOS) chore: Minor version update to Firebase iOS SDK to latest ([Version 8.11.0 - January 18, 2022](https://firebase.google.com/support/release-notes/ios#version_8110_-_january_18_2022))
@@ -183,3 +196,3 @@ * BREAKING CHANGE: Requires Cocoapods v1.11.2+
 
-# Version 13.0.1
+# Version 13.0.1-cli
 * (iOS) Fix `onTokenRefresh` to return FCM token (not installation auth token).
@@ -194,7 +207,7 @@ * Resolves [#637](https://github.com/dpa99c/cordova-plugin-firebasex/issues/637)
 
-# Version 13.0.0
+# Version 13.0.0-cli
 * (iOS) BREAKING CHANGE: Major version update to Firebase iOS SDK from v7 to v8 ([Version 8.1.1 - June 11, 2021](https://firebase.google.com/support/release-notes/ios#version_811_-_june_11_2021))
-    * Remove/replace references to previously-deprecated Firebase IID SDK component which is removed in SDK v8 with Firebase Installations SDK
+    * Remove/replace references to previously-deprecated Firebase IID SDK component which is removed in SDK v2 with Firebase Installations SDK
 * (Android) BREAKING CHANGE: Major version update to Firebase Android BOM from v26 to v28 ([v28.1.0 - June 03, 2021](https://firebase.google.com/support/release-notes/android#2021-06-03))
-    * Remove/replace references to previously-deprecated Firebase IID SDK component which is removed in SDK BOM v28 with Firebase Installations SDK
+    * Remove/replace references to previously-deprecated Firebase IID SDK component which is removed in SDK v2 with Firebase Installations SDK
     * Add explicit dependency on deprecated `firebase-iid` because latest version `firebase-functions:20.0.0` [depends on an older version](https://mvnrepository.com/artifact/com.google.firebase/firebase-functions/20.0.0) and so causes duplicate class conflicts with latest `firebase-messaging:22.0.0`
@@ -216,4 +229,3 @@ * (Android) doc: Add note regarding creating new notification channels for each new sound.
 
-
-# Version 12.1.0
+# Version 12.1.0-cli
 * (iOS & Android) feature: Add support for Firebase Installations SDK.
@@ -224,3 +236,3 @@ * Resolves [#603](https://github.com/dpa99c/cordova-plugin-firebasex/issues/603)
 
-# Version 12.0.0
+# Version 12.0.0-cli
 * (iOS) BREAKING CHANGE: Major version update to Firebase iOS SDK from v6 to v7 ([v7.8.1 - 12 March 2021](https://firebase.google.com/support/release-notes/ios#version_781_-_march_12_2021))
@@ -257,4 +269,3 @@ * Requires `cocoapods@1.10` (previously `cocoapods@1.9`)
 
-
-# Version 11.0.3
+# Version 11.0.3-cli
 * (Android) Make Firebase Performance Monitoring Gradle plugin optional (disabled by default) via `ANDROID_FIREBASE_PERFORMANCE_MONITORING` plugin variable due to increased build times/memory usage when it's included.
@@ -266,3 +277,3 @@ * (Android) Add defensive code in `handleExceptionWithContext()` to prevent app crashes.
 
-# Version 11.0.2
+# Version 11.0.2-cli
 * (iOS) Check if file contents for `pn-actions.json` exists before attempting to use it.
@@ -281,7 +292,7 @@ * Resolves [#512](https://github.com/dpa99c/cordova-plugin-firebasex/issues/512).
 
-# Version 11.0.1
+# Version 11.0.1-cli
 * (iOS) Set the Sign In with Apple capability based on the `IOS_ENABLE_APPLE_SIGNIN` plugin variable.
     * Resolves [#511](https://github.com/dpa99c/cordova-plugin-firebasex/issues/511).
 
-# Version 11.0.0
+# Version 11.0.0-cli
 * (Android & iOS): Bump pinned Firebase SDK component versions to latest releases.
@@ -310,9 +321,8 @@ * Added support for `didCrashOnPreviousExecution()` and `setCrashlyticsCustomKey()`
     * Cherrypicked from PR [#487](https://github.com/dpa99c/cordova-plugin-firebasex/pull/487)
-
-# Version 10.2.0
+# Version 10.2.0-cli
 * (iOS) Fix crashes on receiving push notifications on iOS due to delegate chaining.
-    * Resolves [#385](https://github.com/dpa99c/cordova-plugin-firebasex/issues/385).
-    * Reverts commit 4e9a0f4a1fd4ceb871af40629e1ddf146f287ca8 "co-existence with cordova-plugin-local-notification on iOS"
-    * Since upon testing, this plugin does not work with `cordova-plugin-local-notification` present in the same project even with this code in place.
-    * And the conflict between the 2 plugins will need to be addressed separately under [#230](https://github.com/dpa99c/cordova-plugin-firebasex/issues/230).
+** Resolves [#385](https://github.com/dpa99c/cordova-plugin-firebasex/issues/385).
+** Reverts commit 4e9a0f4a1fd4ceb871af40629e1ddf146f287ca8 "co-existence with cordova-plugin-local-notification on iOS"
+** Since upon testing, this plugin does not work with `cordova-plugin-local-notification` present in the same project even with this code in place.
+** And the conflict between the 2 plugins will need to be addressed separately under [#230](https://github.com/dpa99c/cordova-plugin-firebasex/issues/230).
 * (iOS) Add support for iOS actionable notifications
@@ -322,4 +332,2 @@ * Merged from PR [#482](https://github.com/dpa99c/cordova-plugin-firebasex/pull/482).
     * Resolves [#473](https://github.com/dpa99c/cordova-plugin-firebasex/issues/473).
-* (Android) Add missing Inapp Messaging component.
-    * Resolves [#478](https://github.com/dpa99c/cordova-plugin-firebasex/issues/478).
 * (iOS): Bump minimum required Cocoapods version to v1.9.1 due to requirement by Firestore v6.28.1
@@ -334,7 +342,7 @@ * (Android) (Bug fix) Fix all cases where task outcomes are being incorrectly handled.
 
-# Version 10.1.2
+# Version 10.1.2-cli
 * (iOS): Bump Firebase SDK versions to v6.28.1 to resolve build freeze issue.
     * Resolves [#460](https://github.com/dpa99c/cordova-plugin-firebasex/issues/460).
 
-# Version 10.1.1
+# Version 10.1.1-cli
 * (iOS) Fix regression bug in `getToken()` introduced by [35a2a68e8db3808723c9f2fcb6aa176021f6c77a](https://github.com/dpa99c/cordova-plugin-firebasex/commit/35a2a68e8db3808723c9f2fcb6aa176021f6c77a).
@@ -345,6 +353,6 @@ * Resolves [#456](https://github.com/dpa99c/cordova-plugin-firebasex/issues/456).
 
-# Version 10.1.0
+# Version 10.1.0-cli
 * (iOS) Use precompiled pod for Firestore to reduce build times.
     * *BREAKING CHANGE:* Requires `cocoapods>=1.9` (previously `cocoapods>=1.8`).
-    * Adds hook script to check local cocoapods version during plugin install.
+    * Adds hook script to check local cocoapods version during plugin install. 
     * Based on PR [#440](https://github.com/dpa99c/cordova-plugin-firebasex/pull/440).
@@ -356,5 +364,4 @@ * Resolves [#407](https://github.com/dpa99c/cordova-plugin-firebasex/issues/407).
     * See [release notes](https://firebase.google.com/support/release-notes/ios#version_6270_-_june_16_2020)
-* (Android): Bump Firebase SDK versions to latest for Analytics, Cloud Messaging & Inapp Messaging.
-
-# Version 10.0.0
+* (Android): Bump Firebase SDK versions to latest for Analytics & Inapp Messaging.
+# Version 10.0.0-cli
 * *BREAKING CHANGE:* (Android, iOS) Migrate from Fabric Crashlytics SDK to Firebase Crashlytics SDK.
@@ -373,8 +380,8 @@ ** Based on [this commit](https://github.com/vickydlion/cordova-plugin-firebasex/commit/0dfb5753edcd9fc19a0e7a52fdd4fc79d6d976ea) in [PR #432](https://github.com/dpa99c/cordova-plugin-firebasex/pull/432).
     * Further resolves [#401](https://github.com/dpa99c/cordova-plugin-firebasex/issues/401).
-* (Android): Fix parsing of existing `colors.xml` when it contains multiple existing `<color>` to prevent overwriting the existing values.
+* (Android): Fix parsing of existing `colors.xml` when it contains multiple existing `<color>` to prevent overwriting the existing values. 
     * Resolves [#436](https://github.com/dpa99c/cordova-plugin-firebasex/issues/436).
 * (Android, iOS): Return success/failure result when subscribing/unsubscribing from topics.
     * Resolves [#422](https://github.com/dpa99c/cordova-plugin-firebasex/issues/422).
-
-# Version 9.1.2
+    
+# Version 9.1.2-cli
 * (Android) Fix retrieval of auth provider ID - [see here for more info](https://github.com/firebase/FirebaseUI-Android/issues/329#issuecomment-564409912)
@@ -385,5 +392,5 @@ * (iOS) Align retrieval of auth provider ID with Android.
 * (Documentation) Update guidance and requirements when opening issues
-* (iOS): Fix escaping of line endings in multi-line log messages being sent from native iOS implementation to JS console.
+* (iOS): Fix escaping of line endings in multi-line log messages being sent from native iOS implementation to JS console. 
     * Resolves [#401](https://github.com/dpa99c/cordova-plugin-firebasex/issues/401).
-* (iOS): Set shouldEstablishDirectChannel via a  plugin variable which defaults to false.
+* (iOS): Set shouldEstablishDirectChannel via a  plugin variable which defaults to false. 
     Resolves [#406](https://github.com/dpa99c/cordova-plugin-firebasex/issues/406).
@@ -393,3 +400,3 @@ * Bump androidx plugin version dependencies.
 
-# Version 9.1.1
+# Version 9.1.1-cli
 * (iOS): Bump Firebase SDK components to v6.23.0.
@@ -400,9 +407,11 @@ * Relates to [#373](https://github.com/dpa99c/cordova-plugin-firebasex/issues/373).
     * See https://firebase.google.com/support/release-notes/android#2020-04-23
-
-# Version 9.1.0
+    
+# Version 9.1.0-cli
 * (Android & iOS) *BREAKING CHANGE*: Add support for filters to `fetchDocumentInFirestoreCollection()`
     * *BREAKING CHANGE* to function signature.
     * Merged from PR [#367](https://github.com/dpa99c/cordova-plugin-firebasex/pull/367).
+* (Android) Fix regression bug which causes CLI builds to fail on Android. 
+Resolves [#369](https://github.com/dpa99c/cordova-plugin-firebasex/issues/369).  
 
-# Version 9.0.3
+# Version 9.0.3-cli
 * (Android & iOS) Add `reloadCurrentUser()`
@@ -415,4 +424,5 @@ * (Doc) `createChannel()` suggestion for multiple sounds
     * Merged from PR [#359](https://github.com/dpa99c/cordova-plugin-firebasex/pull/359).
+    
+# Version 9.0.2-cli
 
-# Version 9.0.2
 * (Android): Don't display app icon for large notification icon on Android. Resolves [#343](https://github.com/dpa99c/cordova-plugin-firebasex/issues/343).
@@ -422,5 +432,6 @@ * (Android & iOS) Sign out of Google signing out of Firebase. Resolves [#353](https://github.com/dpa99c/cordova-plugin-firebasex/issues/353).
 
-# Version 9.0.1
-* Re-add Firebase Inapp Messaging SDK component to master branch.
-* Document `cli_build` branch. See [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326).
+# Version 9.0.1-cli
+* Document `cli_build` branch.
+* *BREAKING CHANGE*: Remove Firebase Inapp Messaging and Google Tag Manager SDK components due to causing Cordova CLI build issues.
+    * Resolves [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326).
 
@@ -427,0 +438,0 @@ # Version 9.0.0

package.json

 {
   "name": "cordova-plugin-firebasex",
-  "version": "16.5.0",
+  "version": "17.0.0-cli",
   "description": "Cordova plugin for Google Firebase",
@@ -5,0 +5,0 @@ "types": "./types/index.d.ts",

scripts/ios/helper.js

@@ -15,2 +15,3 @@ var fs = require("fs");
     firebasePodRegex = /pod 'Firebase([^']+)', '(\d+\.\d+\.\d+[^'"]*)'/g,
+    inAppMessagingPodRegEx = /pod 'FirebaseInAppMessaging', '(\d+\.\d+\.\d+[^'"]*)'/,
     standardFirestorePodRegEx = /pod 'FirebaseFirestore', '(\d+\.\d+\.\d+[^'"]*)'/,
@@ -87,2 +88,6 @@ googleSignInPodRegEx = /pod 'GoogleSignIn', '(\d+\.\d+\.\d+[^'"]*)'/,
         // Create the build phase.
+        if (!xcodeProject.hash.project.objects.PBXShellScriptBuildPhase) {
+            xcodeProject.hash.project.objects.PBXShellScriptBuildPhase = {};
+        }
+
         xcodeProject.hash.project.objects.PBXShellScriptBuildPhase[id] = {
@@ -228,3 +233,4 @@ isa: "PBXShellScriptBuildPhase",
             DEBUG_INFORMATION_FORMAT = pluginVariables['IOS_STRIP_DEBUG'] && pluginVariables['IOS_STRIP_DEBUG'] === 'true' ? 'dwarf' : 'dwarf-with-dsym',
-            IPHONEOS_DEPLOYMENT_TARGET = podFile.match(iosDeploymentTargetPodRegEx)[1];
+            iosDeploymentTargetMatch = podFile.match(iosDeploymentTargetPodRegEx),
+            IPHONEOS_DEPLOYMENT_TARGET = iosDeploymentTargetMatch ? iosDeploymentTargetMatch[1] : null;
 
@@ -237,3 +243,3 @@ if(!podFile.match('post_install')){
             config.build_settings['DEBUG_INFORMATION_FORMAT'] = '${DEBUG_INFORMATION_FORMAT}'
-            config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '${IPHONEOS_DEPLOYMENT_TARGET}'
+            ${IPHONEOS_DEPLOYMENT_TARGET ? "config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '"+IPHONEOS_DEPLOYMENT_TARGET + "'" : ""}
             if target.respond_to?(:product_type) and target.product_type == "com.apple.product-type.bundle"
@@ -341,4 +347,24 @@ config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
         var podFileContents = fs.readFileSync(path.resolve(iosPlatform.podFile), 'utf8'),
-            podFileModified = false;
+            podFileModified = false,
+            specifiedInAppMessagingVersion = false;
 
+        if(pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION']){
+            if(pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION'].match(versionRegex)){
+                specifiedInAppMessagingVersion = true;
+                var matches = podFileContents.match(inAppMessagingPodRegEx);
+                if(matches){
+                    matches.forEach((match) => {
+                        var currentVersion = match.match(versionRegex)[0];
+                        if(!match.match(pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION'])){
+                            podFileContents = podFileContents.replace(match, match.replace(currentVersion, pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION']));
+                            podFileModified = true;
+                        }
+                    });
+                    if(podFileModified) utilities.log("Firebase iOS InAppMessaging SDK version set to v"+pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION']+" in Podfile");
+                }
+            }else{
+                throw new Error("The value \""+pluginVariables['IOS_FIREBASE_IN_APP_MESSAGING_VERSION']+"\" for IOS_FIREBASE_IN_APP_MESSAGING_VERSION is not a valid semantic version format")
+            }
+        }
+
         if(pluginVariables['IOS_FIREBASE_SDK_VERSION']){
@@ -349,2 +375,6 @@ if(pluginVariables['IOS_FIREBASE_SDK_VERSION'].match(versionRegex)){
                     matches.forEach((match) => {
+                        if(match.match(inAppMessagingPodRegEx) && specifiedInAppMessagingVersion){
+                            return; // Skip Firebase In App Messaging pod if it was specified separately
+                        }
+
                         var currentVersion = match.match(versionRegex)[0];
@@ -359,3 +389,3 @@ if(!match.match(pluginVariables['IOS_FIREBASE_SDK_VERSION'])){
             }else{
-                throw new Error("The value \""+pluginVariables['IOS_FIREBASE_SDK_VERSION']+"\" for IOS_FIREBASE_SDK_VERSION is not a valid version in the format 'X.Y.Z'")
+                throw new Error("The value \""+pluginVariables['IOS_FIREBASE_SDK_VERSION']+"\" for IOS_FIREBASE_SDK_VERSION is not a valid semantic version format")
             }
@@ -378,3 +408,3 @@ }
             }else{
-                throw new Error("The value \""+pluginVariables['IOS_GOOGLE_SIGIN_VERSION']+"\" for IOS_GOOGLE_SIGIN_VERSION is not a valid version in the format 'X.Y.Z'")
+                throw new Error("The value \""+pluginVariables['IOS_GOOGLE_SIGIN_VERSION']+"\" for IOS_GOOGLE_SIGIN_VERSION is not a valid semantic version format")
             }
@@ -397,3 +427,3 @@ }
             }else{
-                throw new Error("The value \""+pluginVariables['IOS_GOOGLE_TAG_MANAGER_VERSION']+"\" for IOS_GOOGLE_TAG_MANAGER_VERSION is not a valid version in the format 'X.Y.Z'")
+                throw new Error("The value \""+pluginVariables['IOS_GOOGLE_TAG_MANAGER_VERSION']+"\" for IOS_GOOGLE_TAG_MANAGER_VERSION is not a valid semantic version format")
             }
@@ -427,2 +457,2 @@ }
     }
-};
+};

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

823841

0.6%

Lines of code

6380

0.84%

Number of lines in readme file

5219

0.04%

Worsened metrics

Number of low quality alerts

2

100%

No dependency changes