diff options
Diffstat (limited to 'StoneIsland/plugins/cordova-plugin-firebasex')
42 files changed, 10989 insertions, 0 deletions
diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.editorconfig b/StoneIsland/plugins/cordova-plugin-firebasex/.editorconfig new file mode 100644 index 00000000..e255fddd --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.editorconfig @@ -0,0 +1,17 @@ +# http://editorconfig.org +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[{package.json,.travis.yml}] +indent_style = space +indent_size = 2 + +[{plugin.xml,Makefile}] +indent_style = tab diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.github/FUNDING.yml b/StoneIsland/plugins/cordova-plugin-firebasex/.github/FUNDING.yml new file mode 100644 index 00000000..c3f3e5bf --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.github/FUNDING.yml @@ -0,0 +1,6 @@ +# These are supported funding model platforms + +github: [ dpa99c ] +custom: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZRD3W47HQ3EMJ&source=url +patreon: dpa99c +ko_fi: davealden
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/bug_report.md b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..c16abb50 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,125 @@ +--- +name: Bug report +about: Report a problem +title: '' +labels: '' +assignees: '' + +--- + +<!-- +IMPORTANT: PLEASE READ + +WARNING: Failure to follow the issue template guidelines below will result in the issue being immediately closed. +--> + +<!-- Fill out the relevant sections below and delete irrelevant sections. --> + +# Bug report + +<!-- COMPLETE THIS CHECKLIST --> +**CHECKLIST** +- [ ] I have read the [issue reporting guidelines](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) + +- [ ] I confirm this is a suspected bug or issue that will affect other users +<!-- i.e. this is not a request for support in using/integrating the plugin into your specific project --> + +- [ ] I have reproduced the issue using the [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) or provided the necessary information to reproduce the issue. +<!-- necessary information e.g. exact steps, FCM notification message content, test case project repo --> + +- [ ] I have read [the documentation](https://github.com/dpa99c/cordova-plugin-firebasex) thoroughly and it does not help solve my issue. +<!-- e.g. if you're having a build issue ensure you've read through the build environment notes --> + +- [ ] I have checked that no similar issues (open or closed) already exist. +<!-- Duplicates or near-duplicates will be closed immediately. --> + + + +**Current behavior:** + +<!-- Describe how the bug manifests. --> + +<!-- Explain how you're sure there is an issue with this plugin rather than your own code: + - If this plugin has an example project, have you been able to reproduce the issue within it? + - Have you created a clean test Cordova project containing only this plugin to eliminate the potential for interference with other plugins/code? + --> + +**Expected behavior:** +<!-- Describe what the behavior should be without the bug. --> + +**Steps to reproduce:** +<!-- If you are able to illustrate the bug with an example, please provide steps to reproduce. --> + +**Screenshots** +<!-- If applicable, add screenshots to help explain your problem. --> + +**Environment information** +<!-- Please supply full details of your development environment including: --> +- Cordova CLI version + - `cordova -v` +- Cordova platform version + - `cordova platform ls` +- Plugins & versions installed in project (including this plugin) + - `cordova plugin ls` +- Dev machine OS and version, e.g. + - OSX + - `sw_vers` + - Windows 10 + - `winver` + +_Runtime issue_ +- Device details + - _e.g. iPhone X, Samsung Galaxy S8, iPhone X Simulator, Pixel XL Emulator_ +- OS details + - _e.g. iOS 12.2, Android 9.0_ + +_Android build issue:_ +- Node JS version + - `node -v` +- Gradle version + - `ls platforms/android/.gradle` +- Target Android SDK version + - `android:targetSdkVersion` in `AndroidManifest.xml` +- Android SDK details + - `sdkmanager --list | sed -e '/Available Packages/q'` + +_iOS build issue:_ +- Node JS version + - `node -v` +- XCode version + + +**Related code:** +``` +insert any relevant code here such as plugin API calls / input parameters +``` + +**Console output** +<details> +<summary>console output</summary> + +``` + +// Paste any relevant JS/native console output here + +``` + +</details><br/><br/> + +**Other information:** + +<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. --> + + + + + +<!-- +A POLITE REMINDER + +- This is free, open-source software. +- Although the author makes every effort to maintain it, no guarantees are made as to the quality or reliability, and reported issues will be addressed if and when the author has time. +- Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. +- If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk +- Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. +--> diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/documentation-issue.md b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/documentation-issue.md new file mode 100644 index 00000000..f8d8d819 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -0,0 +1,36 @@ +--- +name: Documentation issue +about: Describe an issue with the documentation +title: '' +labels: '' +assignees: '' + +--- +<!-- +WARNING: Failure to follow the issue template guidelines below will result in the issue being immediately closed. + +Only documentation issues should be opened here. + +Before opening an issue, please read [Reporting issues](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) +--> + + +# Documentation issue +<!-- +Describe the issue with the documentation or the request for documentation changes. +- Please give reasons why the change is necessary. +- If the change is trivial or you are able to make it, please consider making a Pull Request containing the necessary changes. +--> + + + + +<!-- +A POLITE REMINDER + +- This is free, open-source software. +- Although the author makes every effort to maintain it, no guarantees are made as to the quality or reliability, and reported issues will be addressed if and when the author has time. +- Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. +- If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk +- Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. +--> diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/feature_request.md b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..539d7766 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,43 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- +<!-- +WARNING: Failure to follow the issue template guidelines below will result in the issue being immediately closed. + +Only feature requests should be opened here. + +Before opening an issue, please read [Reporting issues](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) + +--> + + +# Feature request +<!-- +Feature requests should include as much detail as possible: + +- A descriptive title +- A description of the problem you're trying to solve, including why you think this is a problem +- An overview of the suggested solution +- Use case: why should this be implemented? +- If the feature changes current behavior, reasons why your solution is better +- Relevant links, e.g. + - Stack Overflow post illustrating a solution + - Code within a Github repo that illustrates a solution + - Native API documentation for proposed feature +--> + + +<!-- +A POLITE REMINDER + +- This is free, open-source software. +- Although the author makes every effort to maintain it, no guarantees are made as to the quality or reliability, and reported issues will be addressed if and when the author has time. +- Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. +- If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk +- Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. +--> diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.github/PULL_REQUEST_TEMPLATE.md b/StoneIsland/plugins/cordova-plugin-firebasex/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..fa6ad932 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +## PR Type +What kind of change does this PR introduce? + +<!-- Please check the one that applies to this PR using "x". --> +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting, local variables) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Documentation changes +- [ ] Other... Please describe: + +<!-- Fill out the relevant sections below and delete irrelevant sections. --> + +## PR Checklist +For bug fixes / features, please check if your PR fulfills the following requirements: + +- [ ] Testing has been carried out for the changes have been added +- [ ] Regression testing has been carried out for existing functionality +- [ ] Docs have been added / updated + +## What is the purpose of this PR? +<!-- Describe any current behavior that you are modifying, or link to a relevant issue. --> +<!-- Describe the new behaviour added/modified and its purpose. --> + +## Does this PR introduce a breaking change? +- [ ] Yes +- [ ] No + +<!-- If this PR contains a breaking change, please describe the impact and migration path for existing plugin versions. --> + +## What testing has been done on the changes in the PR? +<!-- e.g. if an example project exists for this plugin, has it been updated to test the new functionality? --> + +## What testing has been done on existing functionality? +<!-- e.g. if an example project exists for this plugin, has been it been tested to ensure no regression bugs have been introduced? --> + +## Other information
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/.travis.yml b/StoneIsland/plugins/cordova-plugin-firebasex/.travis.yml new file mode 100644 index 00000000..44e115c4 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/.travis.yml @@ -0,0 +1,108 @@ +env: + global: + - JAVA_HOME=/usr/lib/jvm/java-8-oracle + - LANG=en_US.UTF-8 + +matrix: + include: + - os: linux + sudo: false + language: android + android: + components: + - tools-26.0.0 + - platform-tools-26.0.0 + - build-tools-26.0.0 + - android-26.0.0 + - extra-google-google_play_services + - extra-google-m2repository + - extra-android-m2repository + addons: + apt: + packages: + - oracle-java8-installer + - oracle-java8-set-default + licenses: + - android-sdk-preview-license-.+ + - android-sdk-license-.+ + - google-gdk-license-.+ + env: CORDOVA_VERSION="6.5.0" CORDOVA_PLATFORM="android" CORDOVA_PLATFORM_VERSION="6.4.0" + + - os: linux + sudo: false + language: android + android: + components: + - tools-26.0.0 + - platform-tools-26.0.0 + - build-tools-26.0.0 + - android-26.0.0 + - extra-google-google_play_services + - extra-google-m2repository + - extra-android-m2repository + addons: + apt: + packages: + - oracle-java8-installer + - oracle-java8-set-default + licenses: + - android-sdk-preview-license-.+ + - android-sdk-license-.+ + - google-gdk-license-.+ + env: CORDOVA_VERSION="7.1.0" CORDOVA_PLATFORM="android" CORDOVA_PLATFORM_VERSION="7.1.0" + + - os: linux + sudo: false + language: android + android: + components: + - tools-26.0.0 + - platform-tools-26.0.0 + - build-tools-26.0.0 + - android-26.0.0 + - extra-google-google_play_services + - extra-google-m2repository + - extra-android-m2repository + addons: + apt: + packages: + - oracle-java8-installer + - oracle-java8-set-default + licenses: + - android-sdk-preview-license-.+ + - android-sdk-license-.+ + - google-gdk-license-.+ + env: CORDOVA_VERSION="8.0.0" CORDOVA_PLATFORM="android" CORDOVA_PLATFORM_VERSION="7.1.0" + + - os: osx + language: objective-c + osx_image: xcode9.4 + env: CORDOVA_VERSION="6.5.0" CORDOVA_PLATFORM="ios" CORDOVA_PLATFORM_VERSION="4.5.4" + + - os: osx + language: objective-c + osx_image: xcode9.4 + env: CORDOVA_VERSION="7.1.0" CORDOVA_PLATFORM="ios" CORDOVA_PLATFORM_VERSION="4.5.4" + + - os: osx + language: objective-c + osx_image: xcode9.4 + env: CORDOVA_VERSION="8.0.0" CORDOVA_PLATFORM="ios" CORDOVA_PLATFORM_VERSION="4.5.4" + + - os: linux + env: CORDOVA_VERSION="6.5.0" CORDOVA_PLATFORM="browser" CORDOVA_PLATFORM_VERSION="5.0.3" + + - os: linux + env: CORDOVA_VERSION="7.1.0" CORDOVA_PLATFORM="browser" CORDOVA_PLATFORM_VERSION="5.0.3" + + - os: linux + env: CORDOVA_VERSION="8.0.0" CORDOVA_PLATFORM="browser" CORDOVA_PLATFORM_VERSION="5.0.3" + +before_install: +- nvm install 8 +- PATH=$TRAVIS_BUILD_DIR/node_modules/.bin:$PATH ; export PATH +- if [[ "$CORDOVA_PLATFORM" == "android" ]]; then yes | sdkmanager "build-tools;26.0.0" "platforms;android-26" ; fi + +script: +- bash ./test/test-default.sh $CORDOVA_VERSION $CORDOVA_PLATFORM $CORDOVA_PLATFORM_VERSION +- if [[ "$CORDOVA_PLATFORM" == "android" ]]; then bash ./test/test-with-3-plugins.sh $CORDOVA_VERSION $CORDOVA_PLATFORM $CORDOVA_PLATFORM_VERSION cordova-plugin-request-location-accuracy cordova-android-play-services-gradle-release cordova-android-firebase-gradle-release; fi diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/CHANGELOG.md b/StoneIsland/plugins/cordova-plugin-firebasex/CHANGELOG.md new file mode 100644 index 00000000..c3b4d5f3 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/CHANGELOG.md @@ -0,0 +1,458 @@ +# 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). +* (iOS) Add support for iOS actionable notifications + * Merged from PR [#482](https://github.com/dpa99c/cordova-plugin-firebasex/pull/482). +* (Android): Handle task outcomes where task is not successful but exception is null. + * Resolves [#473](https://github.com/dpa99c/cordova-plugin-firebasex/issues/473). +* (iOS): Bump minimum required Cocoapods version to v1.9.1 due to requirement by Firestore v6.28.1 +* (Android) (Bug fix) Fix all cases where task outcomes are being incorrectly handled. +* (iOS) Update remote config to use `activateWithCompletion` instead of deprecated `activateWithCompletionHandler` for activating remote config. +* (iOS) (Bug fix) Use regex to extract cocoapods from stdout when verifying cocoapods version during plugin install. + * Resolves [#462](https://github.com/dpa99c/cordova-plugin-firebasex/issues/462). +* (Android, iOS): Support custom locations for Firebase config files + * Merged from PR [#465](https://github.com/dpa99c/cordova-plugin-firebasex/pull/465). + * Resolves [#452](https://github.com/dpa99c/cordova-plugin-firebasex/issues/452). + +# 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-cli +* (iOS) Fix regression bug in `getToken()` introduced by [35a2a68e8db3808723c9f2fcb6aa176021f6c77a](https://github.com/dpa99c/cordova-plugin-firebasex/commit/35a2a68e8db3808723c9f2fcb6aa176021f6c77a). + * Resolves [#456](https://github.com/dpa99c/cordova-plugin-firebasex/issues/456). +* (iOS) Update to use Firebase SDK v6.28.0 + * Resolves [#453](https://github.com/dpa99c/cordova-plugin-firebasex/issues/453). + +# 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. + * Based on PR [#440](https://github.com/dpa99c/cordova-plugin-firebasex/pull/440). + * Resolves [#407](https://github.com/dpa99c/cordova-plugin-firebasex/issues/407). +* (Android) Fixed regression bug related to default Crashlytics permission. + * See [this comment](https://github.com/dpa99c/cordova-plugin-firebasex/issues/335#issuecomment-651218052). +* (iOS) Bump pinned Firebase SDK versions to latest 6.27.0 + * 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 & Inapp Messaging. +# Version 10.0.0-cli +* *BREAKING CHANGE:* (Android, iOS) Migrate from Fabric Crashlytics SDK to Firebase Crashlytics SDK. +** 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). +** Resolves [#335](https://github.com/dpa99c/cordova-plugin-firebasex/issues/335). +** Removes `isCrashlyticsCollectionCurrentlyEnabled()` as it's no longer necessary to manually init Crashlytics and a runtime method exists to enable/disable it. +** For more info see the [Firebase Crashlytics SDK upgrade documentation](https://firebase.google.com/docs/crashlytics/upgrade-sdk). +* (iOS) Fix exception raised if another plugin as already configured Firebase + * Merged from PR [#419](https://github.com/dpa99c/cordova-plugin-firebasex/pull/419). +* (iOS) Handle case where LD_RUNPATH_SEARCH_PATHS is an array. Resolves [#344](https://github.com/dpa99c/cordova-plugin-firebasex/issues/344). +* (Android, iOS): Avoid collection state getting out of sync & remove restriction to override config defaults. + * Merged from PR [#423](https://github.com/dpa99c/cordova-plugin-firebasex/pull/423). +* (iOS) Fix escaping already escaped json. + * Merged from PR [#430](https://github.com/dpa99c/cordova-plugin-firebasex/pull/430). + * 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. + * 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-cli +* (Android) Fix retrieval of auth provider ID - [see here for more info](https://github.com/firebase/FirebaseUI-Android/issues/329#issuecomment-564409912) +* (iOS) Align retrieval of auth provider ID with Android. +* (Typing): correct return type of a method + * Merged from PR [#390](https://github.com/dpa99c/cordova-plugin-firebasex/pull/390). +* (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. + * Resolves [#401](https://github.com/dpa99c/cordova-plugin-firebasex/issues/401). +* (iOS): Set shouldEstablishDirectChannel via a plugin variable which defaults to false. + Resolves [#406](https://github.com/dpa99c/cordova-plugin-firebasex/issues/406). +* Bump androidx plugin version dependencies. + Resolves [#418](https://github.com/dpa99c/cordova-plugin-firebasex/issues/418). + +# Version 9.1.1-cli +* (iOS): Bump Firebase SDK components to v6.23.0. + * Relates to [#373](https://github.com/dpa99c/cordova-plugin-firebasex/issues/373). + * See https://firebase.google.com/support/release-notes/ios#version_6230_-_april_21_2020. +* (Android) Bump Firebase SDK (and other Gradle dependencies) to latest versions. + * See https://firebase.google.com/support/release-notes/android#2020-04-23 + +# 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-cli +* (Android & iOS) Add `reloadCurrentUser()` +* (Doc) `createChannel()` suggestion for multiple sounds + * Merged from PR [#225](https://github.com/dpa99c/cordova-plugin-firebasex/pull/225). +* (iOS) Implement `getInfo()` for iOS. + * Merged from PR [#363](https://github.com/dpa99c/cordova-plugin-firebasex/pull/363). +* (Android & iOS) Add `signInUserWithCustomToken()` AND `signInUserAnonymously()` auth methods + * Merged from PR [#359](https://github.com/dpa99c/cordova-plugin-firebasex/pull/359). + +# Version 9.0.2-cli + +* (Android): Don't display app icon for large notification icon on Android. Resolves [#343](https://github.com/dpa99c/cordova-plugin-firebasex/issues/343). +* (Android & iOS) Sign out of Google signing out of Firebase. Resolves [#353](https://github.com/dpa99c/cordova-plugin-firebasex/issues/353). +* (Android & iOS) Add `documentExistsInFirestoreCollection()` and fix resolution of `fetchDocumentInFirestoreCollection()`. + +# 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). + +# Version 9.0.0 +* *BREAKING CHANGE*: Change method signature of `setCrashlyticsCollectionEnabled()` to `(enabled, success, error)` (from `()`) to allow enabling/disabling of Crashlytics at runtime and align it with `setPerformanceCollectionEnabled()` and `setAnalyticsCollectionEnabled()` +* Add `isCrashlyticsCollectionEnabled()` and `isCrashlyticsCollectionCurrentlyEnabled()` to respectively check if persistent Crashlytics setting is enabled and if Crashlytics is enabling during the current app session. +* Add `isAnalyticsCollectionEnabled()` and `isPerformanceCollectionEnabled()` to check if persistent settings are enabled. +* *BREAKING CHANGE*: Remove Firebase Inapp Messaging SDK component due to causing Cordova CLI build issues. + * Resolves [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326). +* (iOS) Override CDVPlugin class abstract method `handleOpenURL` instead of implementing app delegate method `application:openURL:options` to prevent conflicts with other plugins. + * Resolves [#328](https://github.com/dpa99c/cordova-plugin-firebasex/issues/328). +* (Android) Fix parsing of existing `colors.xml` when it only contains a single `<color>` to prevent overwriting the existing value. + * Fixes [#284](https://github.com/dpa99c/cordova-plugin-firebasex/issues/284). + +# Version 8.1.1 +* (Doc) Document custom FCM message handling. +* (Doc) Rationalise heading levels. +* (iOS) Implement message receiver mechanism (equivalent to existing Android mechanism) to enable custom handling of specific message types. +* (Android) Extend custom receiver to handle payload obtained from system notification message bundle received while in background/not running. +* (Android) Ignore invocation of auth state change listener at app start (same as on iOS) to prevent error due to race condition with plugin initialisation. + + +# Version 8.1.0 +* Add support for Firebase inapp messaging + * Merged from PR [#312](https://github.com/dpa99c/cordova-plugin-firebasex/pull/312). +* Add support for Firestore realtime database. Resolves [#190](https://github.com/dpa99c/cordova-plugin-firebasex/issues/190). +* (Doc) Add note regarding persistence of data collection settings. Resolves [#315](https://github.com/dpa99c/cordova-plugin-firebasex/issues/315). +* (iOS) Added missing Google Tag Manager Pod for iOS. + * Merged from PR [#318](https://github.com/dpa99c/cordova-plugin-firebasex/pull/318). +* (iOS) Don't set `FirebaseScreenReportEnabled=false` in app list when `FIREBASE_ANALYTICS_COLLECTION_ENABLE=false`. Resolves [#317](https://github.com/dpa99c/cordova-plugin-firebasex/issues/317). +* (Android) Disable strict version check in Google Services plugin for Gradle as it causes erroneous build failures. + +# Version 8.0.1 +* Add `registerAuthStateChangeListener()` to support invocation of a callback function on the Firebase Authentication state changing. +Resolves [#311](https://github.com/dpa99c/cordova-plugin-firebasex/issues/311). +* (Android) Bump Firebase SDK dependency versions to latest releases. Resolves [#279](https://github.com/dpa99c/cordova-plugin-firebasex/issues/279). +* (iOS) Bump podspec versions for Firebase SDK components to [latest release (v6.17.0)](https://firebase.google.com/support/release-notes/ios#version_6170_-_february_11_2020) + +# Version 8.0.0 +* *BREAKING CHANGE*: Rework `verifyPhoneNumber()` to preserve and reference the native credentials object (rather than attempting to extract and parse its properties to JS). Fixes [#176](https://github.com/dpa99c/cordova-plugin-firebasex/issues/176). +* Add other Firebase Authentication methods: Google Sign In, Sign In with Apple, email/password sign in, and authentication utility methods. Partially resolves [#208](https://github.com/dpa99c/cordova-plugin-firebasex/issues/208). +* (Android) Add check `google-services` plugin does not already exist. Fixes [#282](https://github.com/dpa99c/cordova-plugin-firebasex/issues/282). +* (iOS) Update pinned Firebase SDK versions to latest v6.13.0. Resolves [#232](https://github.com/dpa99c/cordova-plugin-firebasex/issues/232). + +# Version 7.0.2 +* (Android) Fix error caused by local variable + * Merged from PR [#229](https://github.com/dpa99c/cordova-plugin-firebasex/pull/229). +* (iOS Hook) Fix retrieving Xcode project path + * Merged from PR [#234](https://github.com/dpa99c/cordova-plugin-firebasex/pull/234). +* (Android) Check google-services plugin doesn't already exist in Gradle script + * Merged from PR [#281](https://github.com/dpa99c/cordova-plugin-firebasex/pull/281). + +# Version 7.0.1 +* (Android) Replace references to cordovaActivity with applicationContext when app is not running and therefore cordovaActivity doesn't exist. +Resolves [#165](https://github.com/dpa99c/cordova-plugin-firebasex/issues/165). +* Fix .forEach is not a function. +Merged from PR [#219](https://github.com/dpa99c/cordova-plugin-firebasex/pull/219). +Resolves [#213](https://github.com/dpa99c/cordova-plugin-firebasex/issues/213). +* (Android) Parse this plugin's `plugin.xml` to extract default values for plugin variables not explicitly set at plugin install time. +Fixes [#218](https://github.com/dpa99c/cordova-plugin-firebasex/issues/218). +* (iOS) Fix after_prepare hook to run on multiple platforms so if they are added in one operation using `cordova prepare`, both platforms are processed. +Fixes [#221](https://github.com/dpa99c/cordova-plugin-firebasex/issues/221). +* (Typedef) Update the typedef for recent plugin API changes. + +# Version 7.0.0 +* (iOS) Update Firebase SDK to [v6.11.0 released 22 Oct 2019](https://firebase.google.com/support/release-notes/ios#version_6110_-_october_22_2019) +* (Android) Update pinned Firebase SDK versions to latest as of [25 Oct 2019](https://firebase.google.com/support/release-notes/android#2019-10-25) +Resolves [#207](https://github.com/dpa99c/cordova-plugin-firebasex/issues/207) +* (Doc) Document parameter types in API functions. +Resolves [#140](https://github.com/dpa99c/cordova-plugin-firebasex/issues/140) +* (Doc) fix `onMessageReceived()` code sample. +Merged from PR [#142](https://github.com/dpa99c/cordova-plugin-firebasex/pull/142). +* (Doc) Example sound name for custom Android notification sound. +Resolves [#160](https://github.com/dpa99c/cordova-plugin-firebasex/issues/160) +* (Feat): add Typescript declaration +Merged from PR [#166](https://github.com/dpa99c/cordova-plugin-firebasex/pull/166). +* (Doc) Fix `createChannel()` examples. +Merged from PR [#167](https://github.com/dpa99c/cordova-plugin-firebasex/pull/167). +* (Android) Expose `description` notification channel field. +Merged from PR [#168](https://github.com/dpa99c/cordova-plugin-firebasex/pull/168). +* (iOS) Update CocoaPods spec url to new CDN. +Merged from PR [#173](https://github.com/dpa99c/cordova-plugin-firebasex/pull/173). +* (Doc) Fix code example for default android icon. +Merged from PR [#174](https://github.com/dpa99c/cordova-plugin-firebasex/pull/174). +* (iOS) Support iOS 13 APNS format token change. +Merged from PR [#177](https://github.com/dpa99c/cordova-plugin-firebasex/pull/177). +* (Hook) Remove check for presence of platform in `config.xml` +Merged from PR [#185](https://github.com/dpa99c/cordova-plugin-firebasex/pull/185). +* (Feat) Expose Firebase Messaging autoinit API functions to allow enabling/disabling/checking of autoinit. + * If disabled and `unregister()` is called, a new token will not be automatically allocated. + * Resolves [#147](https://github.com/dpa99c/cordova-plugin-firebasex/issues/147). +* (iOS) Fix `logEvent()` so it doesn't generated warning message in console. Fixes [#154](https://github.com/dpa99c/cordova-plugin-firebasex/issues/154). +* (iOS) Handle notification messages that contain `"content-available":1` which wakes up the app while in the background to deliver the message payload immediately when the message arrives (without requiring user interaction by tapping the system notification). +Fixes [#158](https://github.com/dpa99c/cordova-plugin-firebasex/issues/158). +* (Android)(Do) Clarify Android custom notification icons example. Resolves [#183](https://github.com/dpa99c/cordova-plugin-firebasex/issues/183). +* (Doc) Add example of using stacktrace.js with `logError()`. +Clarifies [#118](https://github.com/dpa99c/cordova-plugin-firebasex/issues/118). +* (Doc) Add link to [cordova-plugin-firebasex-ionic3-test](https://github.com/dpa99c/cordova-plugin-firebasex-ionic3-test) Ionic 3 example project +* Add `signInWithCredential()` to sign user into Firebase account and `linkUserWithCredential()` to link user account with credentials obtained via `verifyPhoneNumber()`. +* (Android) *BREAKING CHANGE* Rework `verifyPhoneNumber()` + * Remove redundant `verified` in returned credentials object. + * Support mocking of instant verification for `verifyPhoneNumber()` on Android for integration testing. +* (iOS) *BREAKING CHANGE* Rework `verifyPhoneNumber()` + * Return the same credential object structure as Android. +* (iOS) Add `SETUP_RECAPTCHA_VERIFICATION` plugin variable to automatically set up reCAPTURE verification for phone auth. +* (Doc) Add section to explicitly document all supported plugin variables. +* (iOS) Add `onApnsTokenReceived()` to register a callback function to be invoked when the APNS token is allocated. +Resolves [#201](https://github.com/dpa99c/cordova-plugin-firebasex/issues/201). +* (Android) Tweak default empty values when sending stacktrace using `logError()` +* (Doc) Better example of using `logError()` to track unhandled JS exceptions vs logging a non-fatal logical error. +* (iOS) Modify `logError()` to send stacktrace.js output as an actual stacktrace instead of custom keys. +Resolves [#118](https://github.com/dpa99c/cordova-plugin-firebasex/issues/118). +* (Hook) Fix parsing of `config.xml` to extract app name. +Fixes [#139](https://github.com/dpa99c/cordova-plugin-firebasex/issues/139). +* (Android) Ensure functions which return a boolean result return an actual boolean type rather than a binary integer. +Fixes [#153](https://github.com/dpa99c/cordova-plugin-firebasex/issues/153). +* (Hook) Rework hook scripts to: + * be fully synchronous to eliminate race conditions (remove q dependency) + * use [xml-js](https://github.com/nashwaan/xml-js) (instead of [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js)) to convert XML>JSON and JSON>XML + * (Android) handle existing `colors.xml`. + Resolves [#132](https://github.com/dpa99c/cordova-plugin-firebasex/issues/132). + + +# Version 6.1.0 +* (iOS) Add `getAPNSToken()` plugin API method to get the APNS token on iOS. Derived from merging PR [#100](https://github.com/dpa99c/cordova-plugin-firebasex/pull/100). +* Merge PR [#103](https://github.com/dpa99c/cordova-plugin-firebasex/pull/103) - fix for app name containing an ampersand. +* Merge PR [#115](https://github.com/dpa99c/cordova-plugin-firebasex/pull/115) - fix for short attribute in app name. +* Merge PR [#121](https://github.com/dpa99c/cordova-plugin-firebasex/pull/121) - fixes missing resolution of promise in after_prepare hook which caused other plugins to not run their after_prepare script (a bug introduced in v6.0.7) +* (Android) Merge PR [#64](https://github.com/dpa99c/cordova-plugin-firebasex/pull/64) - replace Android hooks scripts to configure Gradle with actual Gradle configuration. +* (iOS) Add missing `tap` property for notification messages received while app is running in background. + * Based on https://github.com/arnesson/cordova-plugin-firebase/pull/1104 + * Resolves [#96](https://github.com/dpa99c/cordova-plugin-firebasex/issues/96) +* (iOS) Fix issues causing foreground notifications not to display on first run. Fixes [#109](https://github.com/dpa99c/cordova-plugin-firebasex/issues/109). +* (iOS) Update string format when subscribing/unsubscribing topics. Resolves [#110](https://github.com/dpa99c/cordova-plugin-firebasex/issues/110]). +* Support disabling of data collection (analytics/performance/crashlytics) at app startup and manual enabling of these at runtime. + * Resolves [#116](https://github.com/dpa99c/cordova-plugin-firebasex/issues/116]) and [#79](https://github.com/dpa99c/cordova-plugin-firebasex/issues/79]). +* Remove Android implementation of `getBadgeNumber()`/`setBadgeNumber()` as it doesn't work on Android 8+. + * Resolves [#124](https://github.com/dpa99c/cordova-plugin-firebasex/issues/124]). + +# Version 6.0.7 +* Merge PR [#93](https://github.com/dpa99c/cordova-plugin-firebasex/pull/93): Update Fabric dependencies +* Port code to apply IOS_STRIP_DEBUG plugin variable to Podfile into this plugin's hook scripts (from cordova-plugin-cocoapod-supportx). + * Fixes [#89](https://github.com/dpa99c/cordova-plugin-firebasex/issues/89). + +# Version 6.0.6 +* Fix parameter type passed to hasPermission success callback for Android. Fixes [#83](https://github.com/dpa99c/cordova-plugin-firebasex/issues/83). + +# Version 6.0.5 +* Fix `hasPermission()` to return boolean result on Android (same as iOS). + * Update docs to flag this as a breaking change from `cordova-plugin-firebase`. + * Resolves [#81](https://github.com/dpa99c/cordova-plugin-firebasex/issues/81). + +# Version 6.0.4 +* Replace dependency on `cordova-lib` with `xml2js`. +* (iOS) Restore placeholder GoogleService-Info.plist. + * Partially reverts a9c66746ca3592f0eec217f7701d5835f33b43c5 + * See [#74](https://github.com/dpa99c/cordova-plugin-firebasex/issues/74) +* (iOS) Handle and report native logical errors. + +# Version 6.0.3 +* (iOS) If grantPermission() is called when permission is already granted, return an error (rather than attempting to grant permission again which causes issues). + * See [#61](https://github.com/dpa99c/cordova-plugin-firebasex/issues/61) +* (iOS) Run badge number operations on UI thread (instead of background thread). + * Resolves [#72](https://github.com/dpa99c/cordova-plugin-firebasex/issues/72) +* (iOS) Handle situation where value of sound is not an NSString. + * See [#61](https://github.com/dpa99c/cordova-plugin-firebasex/issues/61) +* (iOS) Add try/catch handlers at all code entry points to handle unexpected exceptions in order to prevent app crashes. Log native exceptions to native and JS consoles. + * See [#61](https://github.com/dpa99c/cordova-plugin-firebasex/issues/61) +* Remove `google-services.json` and `GoogleService-Info.plist` placeholders. + * See [#63](https://github.com/dpa99c/cordova-plugin-firebasex/issues/63) + + +# Version 6.0.2 +* (Android) Improved exception handling to prevent app crashes due to plugin exceptions. +Document caveats of received message payload when notification message is received while app is not running on Android. +Further resolves [#52](https://github.com/dpa99c/cordova-plugin-firebasex/issues/52). + +# Version 6.0.1 +* (Android) Expose notification message properties in message object sent to onMessageReceived(). +Ensure message is always sent to onMessageReceived(), regardless if it was tapped. +Resolves [#52](https://github.com/dpa99c/cordova-plugin-firebasex/issues/52). + + +# Version 6.0.0 +* *BREAKING CHANGES* + * `onMessageReceived()` is now called when a message is received (data or notification) AND when a system notification is tapped (whether app is running or not) + * Resolves [#48](https://github.com/dpa99c/cordova-plugin-firebasex/issues/48). + * The `tap` parameter passed to `onMessageReceived()` is only set if a system notification is tapped + * If the system notification was tapped while the app is running in the foreground, the value will be `tap: "foreground"` + * If the system notification was tapped while the app is not running / in the background, the value will be `tap: "background"` + +# Version 5.0.0 +* *BREAKING CHANGES* + * `onNotificationOpen()` renamed to `onMessageReceived()` + * Changed key names for custom notification properties in FCM data messages to display system notifications in foreground. + * Message payload is always delivered to `onMessageReceived()` for both data and notification messages. + * `messageType` key indicates type of FCM message: `notification` or `data` + * `tap` is only set when `messageType` is `notification` + * Explicit dependency on `cordova-plugin-androidx-adapter` since Android implementation uses AndroidX so is incompatible with Android Support Library. + * Set `remote-notification` background mode in native Xcode project for iOS. + * Reworked plugin documentation. +* Support customisable display of system notifications while app is in foreground for both notification and data messages (both Android & iOS). +* Set default color accent and notification channel for FCM notifications. +* Add support for default and custom notification channels for Android 8+ + * Customise importance, visibility, LED light, badge number, notification sound and vibration pattern +* Calling `logError()` on Android now also logs to native logcat (as well as a non-fatal error to remote Crashlytics service). +* Fix `logError()` on iOS to log non-fatal error to remote Crashyltics service. +* Implement stubs for `hasPermission()` and `grantPermission()` on Android so they both return true in to the success callback. +* Rationalise permission check/request on iOS. +* Remove legacy support for iOS 9 and below. +* Support overridable default color accent for Android notification icons via `ANDROID_ICON_ACCENT` plugin variable. + +# Version 4.0.0 +* *BREAKING CHANGE:* set min supported versions to `cordova@9` and `cordova-ios@5`. + * Drop dependency on cordova-plugin-cocoapodsx to install pod dependencies. + * Instead update plugin.xml to use podspec formatting as required by cordova-ios@5. + * Remove iOS plugin variables as these are not (currently) supported by cordova-ios@5 + * Resolves [#22](https://github.com/dpa99c/cordova-plugin-firebasex/issues/22). + +# Version 3.0.8 +* \[iOS\] Add support for stripping debug symbols for libraries included via Cocoapods. Resolves [#28](https://github.com/dpa99c/cordova-plugin-firebasex/issues/28). + +# Version 3.0.7 +* \[iOS\] Ensure runpath search path contains `$(inherited)` to avoid build warnings/issues. Resolves [#25](https://github.com/dpa99c/cordova-plugin-firebasex/issues/25). + +# Version 3.0.6 +* Update iOS to Firebase SDK v6.3.0 (from v5.20.2) - major version increment so update source code for breaking changes to API. Resolves [#9](https://github.com/dpa99c/cordova-plugin-firebasex/issues/9). +* Add support for NDK crashlytics on Android. Resolves [#17](https://github.com/dpa99c/cordova-plugin-firebasex/issues/17). + +# Version 3.0.5 +* Bump min version of cordova-plugin-cocoapod-supportx to 1.7.2 which fixes bug when using a plugin variable to specify the `ios-min-version` in `<pods-config>` + +# Version 3.0.4 +* Bump min version of cordova-plugin-cocoapod-supportx to 1.7.1 which supports using a plugin variable to specify the `ios-min-version` in `<pods-config>` + +# Version 3.0.3 +* Implement didReceiveRegistrationToken delegate for iOS. Resolves [#16](https://github.com/dpa99c/cordova-plugin-firebasex/issues/16). +* Document dependency on Cocoapods. Resolves [#15](https://github.com/dpa99c/cordova-plugin-firebasex/issues/15). +* Make min iOS version configurable. Resolves [#14](https://github.com/dpa99c/cordova-plugin-firebasex/issues/14). + + +# Version 3.0.2 +* Update legacy Xpath reference to `<application>` element in `AndroidManifest.xml` + +# Version 3.0.1 +* Bump default iOS Firebase SDK version to 5.20.2 (https://firebase.google.com/support/release-notes/ios#version_5202_-_april_10_2019). Resolves [#8](https://github.com/dpa99c/cordova-plugin-firebasex/issues/8). + +# Version 3.0.0 +* Reapply: Support user-overriding of default Android Gradle & iOS Cocoapods versions using plugin variables. + +# Version 2.1.2 +* Revert: Support user-overriding of default Android Gradle & iOS Cocoapods versions using plugin variables. + * Since it's not working on iOS due to Cocoapods plugin dependency. + * Need to fix that plugin to handle plugin variables then reinstate this change in a major version release. + +# Version 2.1.1 +* Support user-overriding of default Android Gradle & iOS Cocoapods versions using plugin variables. + +# Version 2.1.0 +* Update Android source to use AndroidX class names and adds dependency on [cordova-plugin-androidx](https://github.com/dpa99c/cordova-plugin-androidx) for forward compatibility with future versions of Firebase libraries on Android. + * Note: if you include other plugins in your project which reference the legacy Android Support Library, you'll still need to include [cordova-plugin-androidx-adapter](https://github.com/dpa99c/cordova-plugin-androidx-adapter) in your project to dynamically patch them. +* Pins Firebase and Crashlytics Gradle dependencies to latest major version (to prevent build failures due to unexpected changes in subsequent major versions). +* Set minimum supported versions to `cordova@8+`, `cordova-android@8+`, `cordova-ios@4+`. + +# Version 2.0.7 +* Merge [PR #7](https://github.com/dpa99c/cordova-plugin-firebasex/pull/7): use `<pod>` instead of deprecated `<<framework type="podspec">`. Resolves [#5](https://github.com/dpa99c/cordova-plugin-firebasex/issues/5). + +# Version 2.0.6 +* Use Cocoapods to satisfy iOS Firebase SDK (rather than bundling with plugin). See https://github.com/arnesson/cordova-plugin-firebase/pull/972. +* Add support for logMessage() and sendCrash() functions (ported from cordova-fabric-plugin) +* Bump version of Crashlytics library on Android to current latest (v2.9.8 - Dec 2018) +* Bump Firebase SDK versions in iOS PodSpecs to latest version (v5.15.0) +* Remove redundant build-extras.gradle +* Set minimum iOS version to 9.0 in podspec +* Remove unnecessary extra <config-file> block which can lead to race condition +* Fixes issues cause by Firebase SDK updates on 5 April 2019 (https://firebase.google.com/support/release-notes/android#update_-_april_05_2019) which removed deprecated API features causing Android build failures. +See https://github.com/arnesson/cordov +* Fix compatibility with cordova@9 CLI +* Add explicit dependency on cordova-lib to prevent build error on iOS. Fixes #2. + +---> **FORKED FROM `cordova-plugin-firebase` AS `cordova-plugin-firebasex`** <--- + +# Version 2.0.5 + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/897">#897</a>: Fixed issue with after_prepare hook not copying required files + +# Version 2.0.4 + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/866">#866</a>: Fixed issue with loading .plist file on some iOS devices + +# Version 2.0.3 + +### Features +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/874">#874</a>: Added new api `setCrashlyticsUserId` which allows setting Crashlytics user identifier +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/861">#861</a>: Updated `verifyPhoneNumber` api on android to add the following properties to the returned object: + - `code` - sms code + - `verified` - whether or not the verification was successful + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/869">#869</a>: Replace add/remove hooks with install/uninstall hooks to ensure proper configuration of the plugin +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/870">#870</a>: Add error handling to `fetch` api on iOS + +# Version 2.0.2 + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/837">#837</a>: Fixed android build + +# Version 2.0.1 + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/836">#836</a>: Fixed Crashlytics on iOS +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/830">#830</a>: Fixed initialization of firebase services + +# Version 2.0.0 + +### Features +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/796">#796</a>: Update Firebase SDK Version to 5.x + +### Bug Fixes +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/822">#822</a>: Can't use initFirebase() on 1.1.3 [Firebase isn't initialized] +- <a href="https://github.com/arnesson/cordova-plugin-firebase/issues/827">#827</a>: doc missing: initFirebase call needed before anything +- <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/824">#824</a>: Removed initRemoteConfig method + +# Version 1.1.4 (deprecated) + +This version has been deprecated due to complications with PR <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/784">#784</a> + +# Version 1.1.3 (deprecated) + +This version has been deprecated due to complications with PR <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/784">#784</a> + +# Version 1.1.2 (deprecated) + +This version has been deprecated due to complications with PR <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/784">#784</a> + +# Version 1.1.1 (deprecated) + +This version has been deprecated due to complications with PR <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/784">#784</a> + +# Version 1.1.0 (deprecated) + +This version has been deprecated due to complications with PR <a href="https://github.com/arnesson/cordova-plugin-firebase/pull/784">#784</a> + +# Version 1.0.5 + +To force cordova to use this version, add the following to your project's config.xml: +``` +<plugin name="cordova-plugin-firebase" spec="1.0.5" /> +``` +or by running: +``` +cordova plugin add cordova-plugin-firebase@1.0.5 --save +``` diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/CODE_OF_CONDUCT.md b/StoneIsland/plugins/cordova-plugin-firebasex/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..3017b5b0 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at bsoumakian@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/CONTRIBUTING.md b/StoneIsland/plugins/cordova-plugin-firebasex/CONTRIBUTING.md new file mode 100644 index 00000000..8c1cac74 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# Contribution Guidelines + +# Find a bug? + +No one is perfect and we aren't any different. If you find an issue, please take a few minutes to let us know. + +1. Take a look at the current issues (there's a handy search feature) to see if someone already reported the issue. If they have, there might be work arounds or proposed fixes posted in the issue which could save you time. +2. If the issue have not been reported, please open an issue. +3. Look for questions or updates to your issue as we might need additioanl information. The faster we get the information, the faster we can resolve your issue. +4. The fastest way to fix your issue is to fix the bug yourself. See the "Have a fix or want to get your hands dirty?" section below to find out how to show off your awesome developer skills! + +## Help Wanted flag + +This plugin is maintained by a community of developers. We do this in our spare time and don't have unlimited time to implement features or fix bugs. As such, we look to others who can submit pull requests to fix bugs or make enhancements. + +# Have a fix or want to get your hands dirty? + +It's really not that hard! If you have questions please don't hesitate to ask in an issue as we can try to help point you in the right direction. + +## Where is the code? + +### Javascript APIs + +You can find the Javscipt APIs in [firebase.js](www/firebase.js) file. This file typically redirects calls to the FirebasePlugin implementation for the platform, but if you need to add APIs, this is where you do it. + +### Android + +There are a number of files that make up the Android platform code, but the main file is [Firebase.java](src/android/FirebasePlugin.java). That is the best place to start. + +### iOS + +Again, there are multiple files that make up the iOS platform, but most of the code is split between [FirebasePlugin.m](src/ios/FirebasePlugin.m) and [AppDelegate+FirebasePlugin.m](src/ios/AppDelegate+FirebasePlugin.m). + +## I found the code, but now what? + +Submitting a bug fix or feature takes only a few minutes. + +1. Fork the repository. +2. Create a new branch. +3. Make the code change. +4. Create a commit and push it to your repo. +5. See the Pull Request section to let us know your code is ready to be merged into the main repo. + +MAKE SURE THE CODE WORKS WITHOUT MODIFYING OR CHECKING IN ANY PLATFORM FILES. Any changes to platform files (like build scripts, config files or anything in the /platform directory) should be made by the plugin. Since Cordova 4.3.0, the [platform management feature](https://cordova.apache.org/docs/en/latest/platform_plugin_versioning_ref/) allows you to build your project without checking in any platform files. + +# Pull Requests + +* Fill in [the required template](PULL_REQUEST_TEMPLATE.md) +* Include one feature/bug fix per Pull Request. Multiple issues in one PR can increase the complexity of the review and could delay the merging of your code. +* Maintain the formatting (specifically white spacing) in the files you are modifying +* Reference the Issue number in the PR if there's a related issue +* If you are adding new APIs or changing behavior, include entries in the README.md so new users know how to interact with the new features. We want everyone to use your work! + +## Need to test a PR? +We rely on the community to help test out fixes and enhancements to this plugin. You can test out a PR by running the following commands: +1. `cordova plugin remove cordova-plugin-firebase` +2. `cordova plugin add https://github.com/<username>/cordova-plugin-firebase.git#<branch>` + * replace `<username>` with the name of user/org where the branch resides + * replace `<branch>` with the name of the branch used to create the PR +3. `cordova prepare` + +For example, to test the fix made by PR [#832](https://github.com/arnesson/cordova-plugin-firebase/pull/832#issuecomment-420386486), you would use the url `https://github.com/briantq/cordova-plugin-firebase.git#revert-lazy-init` since `briantq` is the name of the user and `revert-lazy-init` is the name of the branch. This information is available at the top of each PR. For this specific PR, the following information is displayed: +* briantq wants to merge 2 commits into arnesson:master from briantq:revert-lazy-init + +The last part being the vital information as it tells you exactly what to use in the url. diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/LICENSE b/StoneIsland/plugins/cordova-plugin-firebasex/LICENSE new file mode 100644 index 00000000..40d6a7d0 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Dave Alden + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/README.md b/StoneIsland/plugins/cordova-plugin-firebasex/README.md new file mode 100644 index 00000000..befafcec --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/README.md @@ -0,0 +1,3051 @@ +cordova-plugin-firebasex [](https://www.npmjs.com/package/cordova-plugin-firebasex) [](https://npm-stat.com/charts.html?package=cordova-plugin-firebasex) +======================== + +Brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project. + +Supported platforms: Android and iOS + +**IMPORTANT:** Before opening an issue against this plugin, please read [Reporting issues](#reporting-issues). + +# cli_build branch +This branch of the plugin is specifically intended for those building (directly or indirectly) via the Cordova CLI. +It removes the Firebase Inapp Messaging and Google Tag Manager SDK components due to these causing CLI builds to fail (see [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326)). + +To use it, install an npm release with the `-cli` suffix, e.g.: + + cordova plugin add cordova-plugin-firebasex@9.0.1-cli + +Or install it directly from this branch: + + cordova plugin add https://github.com/dpa99c/cordova-plugin-firebasex#cli_build + +If you wish to use either of these components, please use the [master](https://github.com/dpa99c/cordova-plugin-firebasex) branch or install a major plugin release via the NPM registry and build using Xcode. + +<!-- DONATE --> +[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZRD3W47HQ3EMJ) + +I dedicate a considerable amount of my free time to developing and maintaining this Cordova plugin, along with my other Open Source software. +To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance. Please consider donating if you're using this plugin in an app that makes you money, if you're being paid to make the app, if you're asking for new features or priority bug fixes. +<!-- END DONATE --> + + +<!-- START doctoc generated TOC please keep comment here to allow auto update --> +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> +**Table of Contents** + +- [Installation](#installation) + - [Plugin variables](#plugin-variables) + - [Android & iOS](#android--ios) + - [Android only](#android-only) + - [iOS only](#ios-only) + - [Supported Cordova Versions](#supported-cordova-versions) + - [Supported Mobile Platform Versions](#supported-mobile-platform-versions) + - [Migrating from cordova-plugin-firebase](#migrating-from-cordova-plugin-firebase) + - [Breaking API changes](#breaking-api-changes) + - [Ionic 4+](#ionic-4) + - [Ionic 3](#ionic-3) +- [Build environment notes](#build-environment-notes) + - [PhoneGap Build](#phonegap-build) + - [Android-specific](#android-specific) + - [Specifying Android library versions](#specifying-android-library-versions) + - [AndroidX](#androidx) + - [Google Play Services and Firebase libraries](#google-play-services-and-firebase-libraries) + - [iOS-specific](#ios-specific) + - [Specifying iOS library versions](#specifying-ios-library-versions) + - [Cocoapods](#cocoapods) + - [Out-of-date pods](#out-of-date-pods) + - [Strip debug symbols](#strip-debug-symbols) + - [Cordova CLI builds](#cordova-cli-builds) +- [Firebase config setup](#firebase-config-setup) +- [Disable data collection on startup](#disable-data-collection-on-startup) +- [Example project](#example-project) +- [Reporting issues](#reporting-issues) + - [Reporting a bug or problem](#reporting-a-bug-or-problem) + - [Requesting a new feature](#requesting-a-new-feature) +- [Cloud messaging](#cloud-messaging) + - [Background notifications](#background-notifications) + - [Foreground notifications](#foreground-notifications) + - [Android notifications](#android-notifications) + - [Android background notifications](#android-background-notifications) + - [Android foreground notifications](#android-foreground-notifications) + - [Android Notification Channels](#android-notification-channels) + - [Android 7 and below](#android-7-and-below) + - [Android Notification Icons](#android-notification-icons) + - [Android Default Notification Icon](#android-default-notification-icon) + - [Android Large Notification Icon](#android-large-notification-icon) + - [Android Custom Notification Icons](#android-custom-notification-icons) + - [Android Notification Color](#android-notification-color) + - [Android Notification Sound](#android-notification-sound) + - [Android 8.0 and above](#android-80-and-above) + - [On Android 7 and below](#on-android-7-and-below) + - [iOS notifications](#ios-notifications) + - [iOS background notifications](#ios-background-notifications) + - [iOS notification sound](#ios-notification-sound) + - [iOS badge number](#ios-badge-number) + - [iOS actionable notifications](#ios-actionable-notifications) + - [Data messages](#data-messages) + - [Data message notifications](#data-message-notifications) + - [Android data message notifications](#android-data-message-notifications) + - [iOS data message notifications](#ios-data-message-notifications) + - [Custom FCM message handling](#custom-fcm-message-handling) + - [Android](#android) + - [iOS](#ios) + - [Example](#example) +- [InApp Messaging](#inapp-messaging) +- [Google Tag Manager](#google-tag-manager) + - [Android](#android-1) + - [iOS](#ios-1) +- [API](#api) + - [Notifications and data messages](#notifications-and-data-messages) + - [getToken](#gettoken) + - [getId](#getid) + - [onTokenRefresh](#ontokenrefresh) + - [getAPNSToken](#getapnstoken) + - [onApnsTokenReceived](#onapnstokenreceived) + - [onMessageReceived](#onmessagereceived) + - [grantPermission](#grantpermission) + - [hasPermission](#haspermission) + - [unregister](#unregister) + - [isAutoInitEnabled](#isautoinitenabled) + - [setAutoInitEnabled](#setautoinitenabled) + - [setBadgeNumber](#setbadgenumber) + - [getBadgeNumber](#getbadgenumber) + - [clearAllNotifications](#clearallnotifications) + - [subscribe](#subscribe) + - [unsubscribe](#unsubscribe) + - [createChannel](#createchannel) + - [setDefaultChannel](#setdefaultchannel) + - [Default Android Channel Properties](#default-android-channel-properties) + - [deleteChannel](#deletechannel) + - [listChannels](#listchannels) + - [Analytics](#analytics) + - [setAnalyticsCollectionEnabled](#setanalyticscollectionenabled) + - [isAnalyticsCollectionEnabled](#isanalyticscollectionenabled) + - [logEvent](#logevent) + - [setScreenName](#setscreenname) + - [setUserId](#setuserid) + - [setUserProperty](#setuserproperty) + - [Crashlytics](#crashlytics) + - [setCrashlyticsCollectionEnabled](#setcrashlyticscollectionenabled) + - [isCrashlyticsCollectionEnabled](#iscrashlyticscollectionenabled) + - [setCrashlyticsUserId](#setcrashlyticsuserid) + - [sendCrash](#sendcrash) + - [logMessage](#logmessage) + - [logError](#logerror) + - [Authentication](#authentication) + - [isUserSignedIn](#isusersignedin) + - [signOutUser](#signoutuser) + - [getCurrentUser](#getcurrentuser) + - [reloadCurrentUser](#reloadcurrentuser) + - [updateUserProfile](#updateuserprofile) + - [updateUserEmail](#updateuseremail) + - [sendUserEmailVerification](#senduseremailverification) + - [updateUserPassword](#updateuserpassword) + - [sendUserPasswordResetEmail](#senduserpasswordresetemail) + - [deleteUser](#deleteuser) + - [createUserWithEmailAndPassword](#createuserwithemailandpassword) + - [signInUserWithEmailAndPassword](#signinuserwithemailandpassword) + - [signInUserWithCustomToken](#signinuserwithcustomtoken) + - [signInUserAnonymously](#signinuseranonymously) + - [verifyPhoneNumber](#verifyphonenumber) + - [Android](#android-2) + - [iOS](#ios-2) + - [authenticateUserWithGoogle](#authenticateuserwithgoogle) + - [Android](#android-3) + - [authenticateUserWithApple](#authenticateuserwithapple) + - [iOS](#ios-3) + - [Android](#android-4) + - [signInWithCredential](#signinwithcredential) + - [linkUserWithCredential](#linkuserwithcredential) + - [reauthenticateWithCredential](#reauthenticatewithcredential) + - [registerAuthStateChangeListener](#registerauthstatechangelistener) + - [Remote Config](#remote-config) + - [fetch](#fetch) + - [activateFetched](#activatefetched) + - [getValue](#getvalue) + - [getByteArray](#getbytearray) + - [getInfo](#getinfo) + - [setConfigSettings](#setconfigsettings) + - [setDefaults](#setdefaults) + - [Performance](#performance) + - [setPerformanceCollectionEnabled](#setperformancecollectionenabled) + - [isPerformanceCollectionEnabled](#isperformancecollectionenabled) + - [startTrace](#starttrace) + - [incrementCounter](#incrementcounter) + - [stopTrace](#stoptrace) + - [Firestore](#firestore) + - [addDocumentToFirestoreCollection](#adddocumenttofirestorecollection) + - [setDocumentInFirestoreCollection](#setdocumentinfirestorecollection) + - [updateDocumentInFirestoreCollection](#updatedocumentinfirestorecollection) + - [deleteDocumentFromFirestoreCollection](#deletedocumentfromfirestorecollection) + - [documentExistsInFirestoreCollection](#documentexistsinfirestorecollection) + - [fetchDocumentInFirestoreCollection](#fetchdocumentinfirestorecollection) + - [fetchFirestoreCollection](#fetchfirestorecollection) +- [Credits](#credits) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> + +# Installation +Install the plugin by adding it to your project's config.xml: +```xml +<plugin name="cordova-plugin-firebasex" spec="latest" /> +``` +or by running: +``` +cordova plugin add cordova-plugin-firebasex +``` + +## Plugin variables +The following Cordova plugin variables are supported by the plugin. +Note that these must be set at plugin installation time. If you wish to change plugin variables, you'll need to uninstall the plugin and reinstall it with the new variable values. + +### Android & iOS +- `FIREBASE_ANALYTICS_COLLECTION_ENABLED` - whether to automatically enable Firebase Analytics data collection on app startup +- `FIREBASE_PERFORMANCE_COLLECTION_ENABLED` - whether to automatically enable Firebase Performance data collection on app startup +- `FIREBASE_CRASHLYTICS_COLLECTION_ENABLED` - whether to automatically enable Firebase Crashlytics data collection on app startup +See [Disable data collection on startup](#disable-data-collection-on-startup) for more info. + +### Android only +The following plugin variables are used to specify the Firebase SDK versions as Gradle dependencies on Android: +- `ANDROID_PLAY_SERVICES_TAGMANAGER_VERSION` +- `ANDROID_PLAY_SERVICES_AUTH_VERSION` +- `ANDROID_FIREBASE_ANALYTICS_VERSION` +- `ANDROID_FIREBASE_MESSAGING_VERSION` +- `ANDROID_FIREBASE_CONFIG_VERSION` +- `ANDROID_FIREBASE_PERF_VERSION` +- `ANDROID_FIREBASE_AUTH_VERSION` +- `ANDROID_FIREBASE_FIRESTORE_VERSION` +- `ANDROID_FIREBASE_CRASHLYTICS_VERSION` +- `ANDROID_FIREBASE_CRASHLYTICS_NDK_VERSION` +- `ANDROID_GSON_VERSION` +See [Specifying Android library versions](#specifying-android-library-versions) for more info. + +- `ANDROID_ICON_ACCENT` - sets the default accent color for system notifications. See [Android Notification Color](#android-notification-color) for more info. +- `ANDROID_FIREBASE_CONFIG_FILEPATH` - sets a custom filepath to `google-services.json` file as a path relative to the project root + - e.g. `--variable ANDROID_FIREBASE_CONFIG_FILEPATH="resources/android/google-services.json"` + +### iOS only +- `IOS_STRIP_DEBUG` - prevents symbolification of all libraries included via Cocoapods. See [Strip debug symbols](#strip-debug-symbols) for more info. + - e.g. `--variable IOS_STRIP_DEBUG=true` + - Defaults to `false` if not specified. +- `SETUP_RECAPTCHA_VERIFICATION` - automatically sets up reCAPTCHA verification for phone authentication on iOS. See [verifyPhoneNumber](#verifyphonenumber) for more info. + - e.g. `--variable IOS_STRIP_DEBUG=true` + - Defaults to `false` if not specified. +- `IOS_SHOULD_ESTABLISH_DIRECT_CHANNEL` - If `true` Firebase Messaging will automatically establish a socket-based, direct channel to the FCM server. + - e.g. `--variable IOS_SHOULD_ESTABLISH_DIRECT_CHANNEL=true` + - Defaults to `false` if not specified. + - See [`shouldEstablishDirectChannel`](https://firebase.google.com/docs/reference/ios/firebasemessaging/api/reference/Classes/FIRMessaging#/c:objc(cs)FIRMessaging(py)shouldEstablishDirectChannel) + - Note: Firebase Messaging iOS SDK version 7.0 will be a breaking change where the SDK will no longer support iOS Direct Channel API. +- `IOS_FIREBASE_CONFIG_FILEPATH` - sets a custom filepath to `GoogleService-Info.plist` file as a path relative to the project root + - e.g. `--variable IOS_FIREBASE_CONFIG_FILEPATH="resources/ios/GoogleService-Info.plist"` + +## Supported Cordova Versions +- cordova: `>= 9` +- cordova-android: `>= 8` +- cordova-ios: `>= 5` + +## Supported Mobile Platform Versions +- Android `>= 4.1` +- iOS `>= 10.0` + +## Migrating from cordova-plugin-firebase +This plugin is a fork of [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) which has been reworked to fix issues and add new functionality. +If you already have [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) installed in your Cordova project, you need to completely remove it before installing this plugin otherwise they will conflict and cause build errors in your project. The safest way of doing this is as follows: + + rm -Rf platforms/android + cordova plugin rm cordova-plugin-firebase + rm -Rf plugins/ node_modules/ + npm install + cordova plugin add cordova-plugin-firebasex + cordova platform add android + +### Breaking API changes +**IMPORTANT:** Recent versions of `cordova-plugin-firebasex` have made breaking changes to the plugin API in order to fix bugs or add more functionality. +Therefore you can no longer directly substitute `cordova-plugin-firebasex` in place of `cordova-plugin-firebase` without making code changes. + +You should be aware of the following breaking changes compared with `cordova-plugin-firebase`: +* Minimum supported Cordova versions + * `cordova@9` (CLI) + * `cordova-android@8` (Android platform) + * `cordova-ios@5` (iOS platform) +* Migrated to AndroidX from legacy Android Support Library + * add dependency on [cordova-plugin-androidx](https://github.com/dpa99c/cordova-plugin-androidx) and [cordova-plugin-androidx-adapter](https://github.com/dpa99c/cordova-plugin-androidx-adapter) +* Migrated to Cocoapods to satisfy Firebase SDK dependencies on iOS +* `onNotificationOpen()` renamed to `onMessageReceived()` + * `tap` parameter is only set when user taps on a notification (not when a message is received from FCM) + * `tap=foreground|background` instead of `tap=true|false` +* `hasPermission()` receives argument as a boolean (rather than an object with `isEnabled` key) + * e.g. `FirebasePlugin.hasPermission(function(hasPermission){ + console.log("Permission is " + (hasPermission ? "granted" : "denied")); + });` +* Adds support for foreground notifications and data notification messages + +### Ionic 4+ +Ionic Native provides a [FirebaseX Typescript wrapper](https://ionicframework.com/docs/native/firebase-x) for using `cordova-plugin-firebasex` with Ionic v4, v5 and above. +Please see their documentation for usage. + +First install the package. + +``` +ionic cordova plugin add cordova-plugin-firebasex +npm install @ionic-native/firebase-x +``` + +If you're using Angular, register it in your component/service's `NgModule` (for example, app.module.ts) as a provider. + +```typescript +import { FirebaseX } from "@ionic-native/firebase-x/ngx"; + +@NgModule({ + //declarations, imports... + providers: [ + FirebaseX, + //other providers... + ] +}) +``` + +Then you're good to go. +```typescript +import { FirebaseX } from "@ionic-native/firebase-x/ngx"; + +//... + +constructor(private firebase: FirebaseX) + +this.firebase.getToken().then(token => console.log(`The token is ${token}`)) +this.firebase.onMessageReceived().subscribe(data => console.log(`FCM message: ${data}`)); +``` + +**NOTE:** +- This plugin provides only the Javascript API as documented below. +- The Typescript wrapper is owned and maintain by Ionic. +- Please [report any issues](https://github.com/ionic-team/ionic-native/issues) against the [Ionic Native repo](https://github.com/ionic-team/ionic-native/), not this one. +- Any issues opened against this repo which relate to the Typescript wrapper **will be closed immediately**. + + +### Ionic 3 +The above PR does not work for Ionic 3 so you (currently) can't use the [Ionic Native Firebase](https://ionicframework.com/docs/native/firebase) Typescript wrapper with Ionic 3. +(i.e. `import { Firebase } from "@ionic-native/firebase"` will not work). + +To use `cordova-plugin-firebasex` with Ionic 3, you'll need to call its Javascript API directly from your Typescript app code, for example: + +```typescript +(<any>window).FirebasePlugin.getToken(token => console.log(`token: ${token}`)) + +(<any>window).FirebasePlugin.onMessageReceived((message) => { + if (message.tap) { console.log(`Notification was tapped in the ${message.tap}`); } +}) +``` + +If you want to make the `onMessageReceived()` JS API behave like the Ionic Native wrapper: + +```javascript +onNotificationOpen() { + return new Observable(observer => { + (window as any).FirebasePlugin.onMessageReceived((response) => { + observer.next(response); + }); + }); +} +... +this.onNotificationOpen().subscribe(data => console.log(`FCM message: ${data}`)); +``` + +See the [cordova-plugin-firebasex-ionic3-test](https://github.com/dpa99c/cordova-plugin-firebasex-ionic3-test) example project for a demonstration of how to use the plugin with Ionic 3. + +# Build environment notes + +## PhoneGap Build +This plugin will not work with Phonegap Build (and other remote cloud build envs) do not support Cordova hook scripts as they are used by this plugin to configure the native platform projects. + +## Android-specific + +### Specifying Android library versions +This plugin depends on various components such as the Firebase SDK which are pulled in at build-time by Gradle on Android. +By default this plugin pins specific versions of these in [its `plugin.xml`](https://github.com/dpa99c/cordova-plugin-firebase/blob/master/plugin.xml) where you can find the currently pinned versions as `<preference>`'s, for example: + +```xml +<preference name="ANDROID_FIREBASE_ANALYTICS_VERSION" default="17.0.0" /> +``` + +The Android defaults can be overridden at plugin installation time by specifying plugin variables as command-line arguments, for example: + + cordova plugin add cordova-plugin-firebasex --variable ANDROID_FIREBASE_ANALYTICS_VERSION=17.0.0 + +Or you can specify them as plugin variables in your `config.xml`, for example: + +```xml +<plugin name="cordova-plugin-firebasex" spec="latest"> + <variable name="ANDROID_FIREBASE_ANALYTICS_VERSION" value="17.0.0" /> +</plugin> +``` + +The following plugin variables are used to specify the following Gradle dependency versions on Android: + +- `ANDROID_PLAY_SERVICES_TAGMANAGER_VERSION` => `com.google.android.gms:play-services-tagmanager` +- `ANDROID_PLAY_SERVICES_AUTH_VERSION` => `com.google.android.gms:play-services-auth` +- `ANDROID_FIREBASE_ANALYTICS_VERSION` => `com.google.firebase:firebase-analytics` +- `ANDROID_FIREBASE_MESSAGING_VERSION` => `com.google.firebase:firebase-messaging` +- `ANDROID_FIREBASE_CONFIG_VERSION` => `com.google.firebase:firebase-config` +- `ANDROID_FIREBASE_PERF_VERSION` => `com.google.firebase:firebase-perf` +- `ANDROID_FIREBASE_AUTH_VERSION` => `com.google.firebase:firebase-auth` +- `ANDROID_FIREBASE_FIRESTORE_VERSION` => `com.google.firebase:firebase-firestore` +- `ANDROID_FIREBASE_CRASHLYTICS_VERSION` => `com.google.firebase:firebase-crashlytics` +- `ANDROID_FIREBASE_CRASHLYTICS_NDK_VERSION` => `com.google.firebase:firebase-crashlytics-ndk` +- `ANDROID_GSON_VERSION` => `com.google.code.gson:gson` + +For example: + + cordova plugin add cordova-plugin-firebasex \ + --variable ANDROID_PLAY_SERVICES_TAGMANAGER_VERSION=17.0.0 \ + --variable ANDROID_PLAY_SERVICES_AUTH_VERSION=17.0.0 \ + --variable ANDROID_FIREBASE_ANALYTICS_VERSION=17.0.0 \ + --variable ANDROID_FIREBASE_MESSAGING_VERSION=19.0.0 \ + --variable ANDROID_FIREBASE_CONFIG_VERSION=18.0.0 \ + --variable ANDROID_FIREBASE_PERF_VERSION=18.0.0 \ + --variable ANDROID_FIREBASE_AUTH_VERSION=18.0.0 \ + --variable ANDROID_FIREBASE_CRASHLYTICS_VERSION=17.0.1 \ + --variable ANDROID_FIREBASE_CRASHLYTICS_NDK_VERSION=17.0.1 \ + +### AndroidX +This plugin has been migrated to use [AndroidX (Jetpack)](https://developer.android.com/jetpack/androidx/migrate) which is the successor to the [Android Support Library](https://developer.android.com/topic/libraries/support-library/index). +This is implemented by adding a dependency on [cordova-plugin-androidx](https://github.com/dpa99c/cordova-plugin-androidx) which enables AndroidX in the Android platform of a Cordova project. + +This is because the [major release of the Firebase and Play Services libraries on 17 June 2019](https://developers.google.com/android/guides/releases#june_17_2019) were migrated to AndroidX. + +Therefore if your project includes any plugins which are dependent on the legacy Android Support Library, you should add [cordova-plugin-androidx-adapter](https://github.com/dpa99c/cordova-plugin-androidx-adapter) to your project. +This plugin will dynamically migrate any plugin code from the Android Support Library to AndroidX equivalents. + +## Google Play Services and Firebase libraries +Your Android build may fail if you are installing multiple plugins that use the Google Play Services library. +This is caused by plugins installing different versions of the Google Play Services library. +This can be resolved by installing [cordova-android-play-services-gradle-release](https://github.com/dpa99c/cordova-android-play-services-gradle-release) which enables you to override the versions specified by other plugins in order to align them. + +Similarly, if your build is failing because multiple plugins are installing different versions of the Firebase library, +you can try installing [cordova-android-firebase-gradle-release](https://github.com/dpa99c/cordova-android-firebase-gradle-release) to align these. + +## iOS-specific +Please ensure you have the latest Xcode release version installed to build your app - direct download links can be [found here](https://stackoverflow.com/a/10335943/777265). + +### Specifying iOS library versions +This plugin depends on various components such as the Firebase SDK which are pulled in at build-time by Cocoapods on iOS. +This plugin pins specific versions of these in [its `plugin.xml`](https://github.com/dpa99c/cordova-plugin-firebase/blob/master/plugin.xml) where you can find the currently pinned iOS versions in the `<pod>`'s, for example: + + <pod name="Firebase/Core" spec="6.3.0"/> + +**It is currently not possible to override these at plugin installation time** because `cordova@9`/`cordova-ios@5` does not support the use of plugin variables in the `<pod>`'s `spec` attribute. +Therefore if you need to change the specified versions, you'll currently need to do this by forking the plugin and editing the `plugin.xml` to change the specified `spec` values. + +### Cocoapods +This plugin relies on `cordova@9`/`cordova-ios@5` support for the [CocoaPods dependency manager]( https://cocoapods.org/) in order to satisfy the iOS Firebase SDK library dependencies. + +Therefore please make sure you have `cocoapods@>=1.9` installed in your iOS build environment - setup instructions can be found [here](https://cocoapods.org/). + +If building your project in Xcode, you need to open `YourProject.xcworkspace` (not `YourProject.xcodeproj`) so both your Cordova app project and the Pods project will be loaded into Xcode. + +You can list the pod dependencies in your Cordova iOS project by installing [cocoapods-dependencies](https://github.com/segiddins/cocoapods-dependencies): + + sudo gem install cocoapods-dependencies + cd platforms/ios/ + pod dependencies + +### Out-of-date pods +If you receive a build error such as this: + + None of your spec sources contain a spec satisfying the dependencies: `Firebase/Analytics (~> 6.1.0), Firebase/Analytics (= 6.1.0, ~> 6.1.0)`. + +Make sure your local Cocoapods repo is up-to-date by running `pod repo update` then run `pod install` in `/your_project/platforms/ios/`. + +### Strip debug symbols +If your iOS app build contains too many debug symbols (i.e. because you include lots of libraries via a Cocoapods), you might get an error (e.g. [issue #28](https://github.com/dpa99c/cordova-plugin-firebase/issues/28)) when you upload your binary to App Store Connect, e.g.: + + ITMS-90381: Too many symbol files - These symbols have no corresponding slice in any binary [16EBC8AC-DAA9-39CF-89EA-6A58EB5A5A2F.symbols, 1B105D69-2039-36A4-A04D-96C1C5BAF235.symbols, 476EACDF-583B-3B29-95B9-253CB41097C8.symbols, 9789B03B-6774-3BC9-A8F0-B9D44B08DCCB.symbols, 983BAE60-D245-3291-9F9C-D25E610846AC.symbols]. + +To prevent this, you can set the `IOS_STRIP_DEBUG` plugin variable which prevents symbolification of all libraries included via Cocoapods ([see here for more information](https://stackoverflow.com/a/48518656/777265)): + + cordova plugin add cordova-plugin-firebasex --variable IOS_STRIP_DEBUG=true + +By default this preference is set to `false`. + +Note: if you enable this setting, any crashes that occur within libraries included via Cocopods will not be recorded in Crashlytics or other crash reporting services. + +### Cordova CLI builds +If you are building (directly or indirectly) via the Cordova CLI and a build failures on iOS such as the one below: + + error: Resource "/Build/Products/Debug-iphonesimulator/FirebaseInAppMessaging/InAppMessagingDisplayResources.bundle" not found. Run 'pod install' to update the copy resources script. + + +This is likely due to [an issue with Cordova CLI builds for iOS](https://github.com/apache/cordova-ios/issues/659) when including certain pods into the build (see [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326)): + +Note that building from Xcode works fine, so if you are able then do this. + +Otherwise (e.g. if building via a CI) then you'll need to switch to using the [cli_build branch](https://github.com/dpa99c/cordova-plugin-firebasex/tree/cli_build) of this plugin: + + cordova plugin rm cordova-plugin-firebasex && cordova plugin add cordova-plugin-firebasex@latest-cli + +This removes the Firebase Inapp Messaging and Google Tag Manager SDK components that are causing the build issues. +The `cli_build` branch is kept in sync with `master` but without the above components. + +You can validate your CLI build environment using [this publicly-available `GoogleService-Info.plist`](https://github.coventry.ac.uk/301CEM-1920OCTJAN/301CEM-6957713/raw/master/CanaryApparel/GoogleService-Info.plist): + + cordova create test com.canary.CanaryApparel && cd test + curl https://github.coventry.ac.uk/raw/301CEM-1920OCTJAN/301CEM-6957713/master/CanaryApparel/GoogleService-Info.plist -o GoogleService-Info.plist + cordova plugin add cordova-plugin-firebasex@latest-cli + cordova platform add ios + cordova build ios --emulator + #build succeeds + +Following the installation steps above, modify the `package.json` file to pin the `cli` variant of this package by removing the `^` or `~` prefix from the package declaration. Failure to do this will result in build issues the next time the `cordova prepare` steps are performed as the non-cli version of the package will replace the cli variant. +``` + "dependencies": { + "cordova-android": "~8.1.0", + "cordova-ios": "^6.1.0", + "cordova-plugin-androidx": "^2.0.0", + "cordova-plugin-androidx-adapter": "^1.1.1", + "cordova-plugin-firebasex": "^10.1.2-cli" --> Change to "10.1.2-cli" + }, +``` + +# Firebase config setup +There's a handy [installation and setup guide on medium.com](https://medium.com/@felipepucinelli/how-to-add-push-notifications-in-your-cordova-application-using-firebase-69fac067e821). +However, if using this, remember this forked plugin is `cordova-plugin-firebasex` (not `cordova-plugin-firebase`). + +Download your Firebase configuration files, `GoogleService-Info.plist` for iOS and `google-services.json` for android, and place them in the root folder of your cordova project. +Check out this [firebase article](https://support.google.com/firebase/answer/7015592) for details on how to download the files. + +``` +- My Project/ + platforms/ + plugins/ + www/ + config.xml + google-services.json <-- + GoogleService-Info.plist <-- + ... +``` + +Or you can set custom location for your platform configuration files using plugin variables in your `config.xml`: + +``` +<plugin name="cordova-plugin-firebasex"> + <variable name="ANDROID_FIREBASE_CONFIG_FILEPATH" value="resources/android/google-services.json" /> + <variable name="IOS_FIREBASE_CONFIG_FILEPATH" value="resources/ios/GoogleService-Info.plist" /> +</plugin> +``` + +IMPORTANT: The Firebase SDK requires the configuration files to be present and valid, otherwise your app will crash on boot or Firebase features won't work. + +# Disable data collection on startup +By default, analytics, performance and Crashlytics data will begin being collected as soon as the app starts up. +However, for data protection or privacy reasons, you may wish to disable data collection until such time as the user has granted their permission. + +To do this, set the following plugin variables to `false` at plugin install time: + +* `FIREBASE_ANALYTICS_COLLECTION_ENABLED` +* `FIREBASE_PERFORMANCE_COLLECTION_ENABLED` +* `FIREBASE_CRASHLYTICS_COLLECTION_ENABLED` + + + cordova plugin add cordova-plugin-firebasex \ + --variable FIREBASE_ANALYTICS_COLLECTION_ENABLED=false \ + --variable FIREBASE_PERFORMANCE_COLLECTION_ENABLED=false \ + --variable FIREBASE_CRASHLYTICS_COLLECTION_ENABLED=false + +This will disable data collection (on both Android & iOS) until you call [setAnalyticsCollectionEnabled](#setanalyticscollectionenabled), [setPerformanceCollectionEnabled](#setperformancecollectionenabled) and [setCrashlyticsCollectionEnabled](#setcrashlyticscollectionenabled): + + FirebasePlugin.setAnalyticsCollectionEnabled(true); + FirebasePlugin.setPerformanceCollectionEnabled(true); + FirebasePlugin.setCrashlyticsCollectionEnabled(true); + +Notes: +- Calling `setXCollectionEnabled()` will have no effect if the corresponding `FIREBASE_X_COLLECTION_ENABLED` variable is set to `true`. +- Calling `setXCollectionEnabled(true|false)` will enable/disable data collection during the current app session and across subsequent app sessions until such time as the same method is called again with a different value. + +# Example project +An example project repo exists to demonstrate and validate the functionality of this plugin: +https://github.com/dpa99c/cordova-plugin-firebasex-test + +Please use this as a working reference. + +Before reporting any issues, please (if possible) test against the example project to rule out causes external to this plugin. + +# Reporting issues +**IMPORTANT:** Please read the following carefully. +Failure to follow the issue template guidelines below will result in the issue being immediately closed. + +## Reporting a bug or problem +Before [opening a bug issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=bug_report.md&title=), please do the following: +- *DO NOT* open issues asking for support in using/integrating the plugin into your project + - Only open issues for suspected bugs/issues with the plugin that are generic and will affect other users + - I don't have time to offer free technical support: this is free open-source software + - Ask for help on StackOverflow, Ionic Forums, etc. + - Use the [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) as a known working reference + - Any issues requesting support will be closed immediately. +- *DO NOT* open issues related to the [Ionic Typescript wrapper for this plugin](https://github.com/ionic-team/ionic-native/blob/master/src/%40ionic-native/plugins/firebase-x/index.ts) + - This is owned/maintained by [Ionic](https://github.com/ionic-team) and is not part of this plugin + - Please raise such issues/PRs against [Ionic Native](https://github.com/ionic-team/ionic-native/) instead. + - To verify an if an issue is caused by this plugin or its Typescript wrapper, please re-test using the vanilla Javascript plugin interface (without the Ionic Native wrapper). + - Any issue opened here which is obviously an Ionic Typescript wrapper issue will be closed immediately. +- If you are migrating from [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) to `cordova-plugin-firebasex` please make sure you have read the [Migrating from cordova-plugin-firebase](#migrating-from-cordova-plugin-firebase) section. +- Read the above documentation thoroughly + - For example, if you're having a build issue ensure you've read through the [build environment notes](#build-environment-notes) + - If an iOS CLI build is failing, ensure you've read the [Cordova CLI builds](#cordova-cli-builds) section +- Check the [CHANGELOG](https://github.com/dpa99c/cordova-plugin-firebasex/blob/master/CHANGELOG.md) for any breaking changes that may be causing your issue. +- Check a similar issue (open or closed) does not already exist against this plugin. + - Duplicates or near-duplicates will be closed immediately. +- When [creating a new issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new/choose) + - Choose the "Bug report" template + - Fill out the relevant sections of the template and delete irrelevant sections + - *WARNING:* Failure to complete the issue template will result in the issue being closed immediately. +- Reproduce the issue using the [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) + - This will eliminate bugs in your code or conflicts with other code as possible causes of the issue + - This will also validate your development environment using a known working codebase + - If reproducing the issue using the example project is not possible, create an isolated test project that you are able to share +- Include full verbose console output when reporting build issues + - If the full console output is too large to insert directly into the Github issue, then post it on an external site such as [Pastebin](https://pastebin.com/) and link to it from the issue + - Often the details of an error causing a build failure is hidden away when building with the CLI + - To get the full detailed console output, append the `--verbose` flag to CLI build commands + - e.g. `cordova build ios --verbose` + - Failure to include the full console output will result in the issue being closed immediately +- If the issue relates to the plugin documentation (and not the code), please of a [documentation issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=documentation-issue.md&title=) + +## Requesting a new feature +Before [opening a feature request issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=feature_request.md&title=), please do the following: +- Check the above documentation to ensure the feature you are requesting doesn't already exist +- Check the list if open/closed issues to check if there's a reason that feature hasn't been included already +- Ensure the feature you are requesting is actually possible to implement and generically useful to other users than yourself +- Where possible, post a link to the documentation related to the feature you are requesting +- Include other relevant links, e.g. + - Stack Overflow post illustrating a solution + - Code within another Github repo that illustrates a solution + +# Cloud messaging + +<p align="center"> + <a href="https://youtu.be/qLPhan9YUhQ"><img src="https://media.giphy.com/media/U70vu02o9yCFEffidf/200w_d.gif" /></a> + <span> </span> + <a href="https://youtu.be/35feCmGYSR4"><img src="https://media.giphy.com/media/Y4oFG0Awhd3TpnggHz/200w_d.gif" /></a> +</p> + +There are 2 distinct types of messages that can be sent by Firebase Cloud Messaging (FCM): + +- [Notification messages](https://firebase.google.com/docs/cloud-messaging/concept-options#notifications) + - automatically displayed to the user by the operating system on behalf of the client app **while your app is not running or is in the background** + - **if your app is in the foreground when the notification message arrives**, it is passed to the client app and it is the responsibility of the client app to display it. + - have a predefined set of user-visible keys and an optional data payload of custom key-value pairs. +- [Data messages](https://firebase.google.com/docs/cloud-messaging/concept-options#data_messages) + - Client app is responsible for processing data messages. + - Data messages have only custom key-value pairs. + +Note: only notification messages can be sent via the Firebase Console - data messages must be sent via the [FCM APIs](https://firebase.google.com/docs/cloud-messaging/server). + +## Background notifications +If the notification message arrives while the app is in the background/not running, it will be displayed as a system notification. + +By default, no callback is made to the plugin when the message arrives while the app is not in the foreground, since the display of the notification is entirely handled by the operating system. +However, there are platform-specific circumstances where a callback can be made when the message arrives and the app is in the background that don't require user interaction to receive the message payload - see [Android background notifications](#android-background-notifications) and [iOS background notifications](#ios-background-notifications) for details. + +If the user taps the system notification, this launches/resumes the app and the notification title, body and optional data payload is passed to the [onMessageReceived](#onMessageReceived) callback. + +When the `onMessageReceived` is called in response to a user tapping a system notification while the app is in the background/not running, it will be passed the property `tap: "background"`. + + +## Foreground notifications +If the notification message arrives while the app is in running in the foreground, by default **it will NOT be displayed as a system notification**. +Instead the notification message payload will be passed to the [onMessageReceived](#onMessageReceived) callback for the plugin to handle (`tap` will not be set). + +If you include the `notification_foreground` key in the `data` payload, the plugin will also display a system notification upon receiving the notification messages while the app is running in the foreground. +For example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "data": { + "notification_foreground": "true", + } +} +``` + +When the `onMessageReceived` is called in response to a user tapping a system notification while the app is in the foreground, it will be passed the property `tap: "foreground"`. + +You can set additional properties of the foreground notification using the same key names as for [Data Message Notifications](#data-message-notification-keys). + +## Android notifications +Notifications on Android can be customised to specify the sound, icon, LED colour, etc. that's displayed when the notification arrives. + +### Android background notifications +If the notification message arrives while the app is in the background/not running, it will be displayed as a system notification. + +If a notification message arrives while the app is in the background but is still running (i.e. has not been task-killed) and the device is not in power-saving mode, the `onMessageReceived` callback will be invoked without the `tap` property, indicating the message was received without user interaction. + +If the user then taps the system notification, the app will be brought to the foreground and `onMessageReceived` will be invoked **again**, this time with `tap: "background"` indicating that the user tapped the system notification while the app was in the background. + +In addition to the title and body of the notification message, Android system notifications support specification of the following notification settings: +- [Icon](#android-notification-icons) +- [Sound](#android-notification-sound) +- [Color accent](#android-notification-color) +- [Channel ID](#android-notification-channels) (Android 8.0 (O) and above) + - This channel configuration enables you to specify: + - Sound + - Vibration + - LED light + - Badge + - Importance + - Visibility + - See [createChannel](#createchannel) for details. + +Note: on tapping a background notification, if your app is not running, only the `data` section of the notification message payload will be delivered to [onMessageReceived](#onMessageReceived). +i.e. the notification title, body, etc. will not. Therefore if you need the properties of the notification message itself (e.g. title & body) to be delivered to [onMessageReceived](#onMessageReceived), you must duplicate these in the `data` section, e.g.: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "data": { + "notification_body": "Notification body", + "notification_title": "Notification title" + } +} +``` + +### Android foreground notifications +If the notification message arrives while the app is in the foreground, by default a system notification won't be displayed and the data will be passed to [onMessageReceived](#onMessageReceived). + +However, if you set the `notification_foreground` key in the `data` section of the notification message payload, this will cause the plugin to display system notification when the message is received while your app is in the foreground. You can customise the notification using the same keys as for [Android data message notifications](#android-data-message-notifications). + +### Android Notification Channels +- Android 8 (O) introduced [notification channels](https://developer.android.com/training/notify-user/channels). +- Notification channels are configured by the app and used to determine the **sound/lights/vibration** settings of system notifications. +- By default, this plugin creates a default channel with [default properties](#default-android-channel-properties) + - These can be overridden via the [setDefaultChannel](#setdefaultchannel) function. +- The plugin enables the creation of additional custom channels via the [createChannel](#createchannel) function. + +First you need to create a custom channel with the desired settings, for example: + +```javascript +var channel = { + id: "my_channel_id", + sound: "mysound", + vibration: true, + light: true, + lightColor: parseInt("FF0000FF", 16).toString(), + importance: 4, + badge: true, + visibility: 1 +}; + +FirebasePlugin.createChannel(channel, +function(){ + console.log('Channel created: ' + channel.id); +}, +function(error){ + console.log('Create channel error: ' + error); +}); +``` + +Then reference it from your message payload: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "channel_id": "my_channel_id" + } + } +} +``` + +#### Android 7 and below +- the channel referenced in the message payload will be ignored +- the sound setting of system notifications is specified in the notification message itself - see [Android Notification Sound](#android-notification-sound). + + +### Android Notification Icons +By default the plugin will use the default app icon for notification messages. + +#### Android Default Notification Icon +To define a custom default notification icon, you need to create the images and deploy them to the `<projectroot>/platforms/android/app/src/main/res/<drawable-DPI>` folders. +The easiest way to create the images is using the [Image Asset Studio in Android Studio](https://developer.android.com/studio/write/image-asset-studio#create-notification) or using the [Android Asset Studio webapp](https://romannurik.github.io/AndroidAssetStudio/icons-notification.html#source.type=clipart&source.clipart=ac_unit&source.space.trim=1&source.space.pad=0&name=notification_icon). + +The icons should be monochrome transparent PNGs with the following sizes: + +- mdpi: 24x24 +- hdpi: 36x36 +- xhdpi: 48x48 +- xxhdpi: 72x72 +- xxxhdpi: 96x96 + +Once you've created the images, you need to deploy them from your Cordova project to the native Android project. +To do this, copy the `drawable-DPI` image directories into your Cordova project and add `<resource-file>` entries to the `<platform name="android">` section of your `config.xml`, where `src` specifies the relative path to the images files within your Cordova project directory. + +For example, copy the`drawable-DPI` image directories to `<projectroot>/res/android/` and add the following to your `config.xml`: + +```xml +<platform name="android"> + <resource-file src="res/android/drawable-mdpi/notification_icon.png" target="app/src/main/res/drawable-mdpi/notification_icon.png" /> + <resource-file src="res/android/drawable-hdpi/notification_icon.png" target="app/src/main/res/drawable-hdpi/notification_icon.png" /> + <resource-file src="res/android/drawable-xhdpi/notification_icon.png" target="app/src/main/res/drawable-xhdpi/notification_icon.png" /> + <resource-file src="res/android/drawable-xxhdpi/notification_icon.png" target="app/src/main/res/drawable-xxhdpi/notification_icon.png" /> + <resource-file src="res/android/drawable-xxxhdpi/notification_icon.png" target="app/src/main/res/drawable-xxxhdpi/notification_icon.png" /> +</platform> +``` + +The default notification icon images **must** be named `notification_icon.png`. + +You then need to add a `<config-file>` block to the `config.xml` which will instruct Firebase to use your icon as the default for notifications: + +```xml +<platform name="android"> + <config-file target="AndroidManifest.xml" parent="/manifest/application"> + <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/notification_icon" /> + </config-file> +</platform> +``` + + +#### Android Large Notification Icon +The default notification icons above are monochrome, however you can additionally define a larger multi-coloured icon. + +**NOTE:** FCM currently does not support large icons in system notifications displayed for notification messages received in the while the app is in the background (or not running). +So the large icon will currently only be used if specified in [data messages](#android-data-messages) or [foreground notifications](#foreground-notifications). + +The large icon image should be a PNG-24 that's 256x256 pixels and must be named `notification_icon_large.png` and should be placed in the `drawable-xxxhdpi` resource directory. +As with the small icons, you'll need to add a `<resource-file>` entry to the `<platform name="android">` section of your `config.xml`: + +```xml +<platform name="android"> + <resource-file src="res/android/drawable-xxxhdpi/notification_icon_large.png" target="app/src/main/res/drawable-xxxhdpi/notification_icon_large.png" /> +</platform> +``` + + +#### Android Custom Notification Icons +You can define additional sets of notification icons in the same manner as above. +These can be specified in notification or data messages. + +For example: + +```xml + <resource-file src="res/android/drawable-mdpi/my_icon.png" target="app/src/main/res/drawable-mdpi/my_icon.png" /> + <resource-file src="res/android/drawable-hdpi/my_icon.png" target="app/src/main/res/drawable-hdpi/my_icon.png" /> + <resource-file src="res/android/drawable-xhdpi/my_icon.png" target="app/src/main/res/drawable-xhdpi/my_icon.png" /> + <resource-file src="res/android/drawable-xxhdpi/my_icon.png" target="app/src/main/res/drawable-xxhdpi/my_icon.png" /> + <resource-file src="res/android/drawable-xxxhdpi/my_icon.png" target="app/src/main/res/drawable-xxxhdpi/my_icon.png" /> + <resource-file src="res/android/drawable-xxxhdpi/my_icon_large.png" target="app/src/main/res/drawable-xxxhdpi/my_icon_large.png" /> +``` + +When sending an FCM notification message, you will then specify the icon name in the `android.notification` section, for example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "icon": "my_icon", + } + }, + "data": { + "notification_foreground": "true", + } +} +``` + +You can also reference these icons in [data messages](#android-data-messages), for example: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_android_icon": "my_icon", + } +} +``` + + +### Android Notification Color +On Android Lollipop (5.0/API 21) and above you can set the default accent color for the notification by adding a color setting. +This is defined as an [ARGB colour](https://en.wikipedia.org/wiki/RGBA_color_space#ARGB_(word-order)) which the plugin sets by default to `#FF00FFFF` (cyan). +Note: On Android 7 and above, the accent color can only be set for the notification displayed in the system tray area - the icon in the statusbar is always white. + +You can override this default by specifying a value using the `ANDROID_ICON_ACCENT` plugin variable during plugin installation, for example: + + cordova plugin add cordova-plugin-firebasex --variable ANDROID_ICON_ACCENT=#FF123456 + +You can override the default color accent by specifying the `colour` key as an RGB value in a notification message, e.g.: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "color": "#00ff00" + } + } +} +``` + +And in a data message: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_android_color": "#00ff00" + } +} +``` + +### Android Notification Sound +You can specify custom sounds for notifications or play the device default notification sound. + +Custom sound files must be in `.mp3` format and deployed to the `/res/raw` directory in the Android project. +To do this, you can add `<resource-file>` tags to your `config.xml` to deploy the files, for example: + +```xml +<platform name="android"> + <resource-file src="res/android/raw/my_sound.mp3" target="app/src/main/res/raw/my_sound.mp3" /> +</platform> +``` + +To ensure your custom sounds works on all versions of Android, be sure to include both the channel name and sound name in your message payload (see below for details), for example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "channel_id": "my_channel_id", + "sound": "my_sound" + } + } +} +``` + +#### Android 8.0 and above +On Android 8.0 and above, the notification sound is specified by which [Android notification channel](#android-notification-channels) is referenced in the notification message payload. +First create a channel that references your sound, for example: + +```javascript +var channel = { + id: "my_channel_id", + sound: "my_sound" +}; + +FirebasePlugin.createChannel(channel, +function(){ + console.log('Channel created: ' + channel.id); +}, +function(error){ + console.log('Create channel error: ' + error); +}); +``` + +Then reference that channel in your message payload: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "channel_id": "my_channel_id" + } + } +} +``` + +#### On Android 7 and below +On Android 7 and below, you need to specify the sound file name in the `android.notification` section of the message payload. +For example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "android": { + "notification": { + "sound": "my_sound" + } + } +} +``` + +And in a data message by specifying it in the `data` section: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_android_sound": "my_sound" + } +} +``` + +- To play the default notification sound, set `"sound": "default"`. +- To display a silent notification (no sound), omit the `sound` key from the message. + +## iOS notifications +Notifications on iOS can be customised to specify the sound and badge number that's displayed when the notification arrives. + +Notification settings are specified in the `apns.payload.aps` key of the notification message payload. +For example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "apns": { + "payload": { + "aps": { + "sound": "default", + "badge": 1, + "content-available": 1 + } + } + } +} +``` + +### iOS background notifications +If the app is in the background but is still running (i.e. has not been task-killed) and the device is not in power-saving mode, the `onMessageReceived` callback can be invoked when the message arrives without requiring user interaction (i.e. tapping the system notification). +To do this you must specify `"content-available": 1` in the `apns.payload.aps` section of the message payload - see the [Apple documentation](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW8) for more information. +When the message arrives, the `onMessageReceived` callback will be invoked without the `tap` property, indicating the message was received without user interaction. +If the user then taps the system notification, the app will be brought to the foreground and `onMessageReceived` will be invoked **again**, this time with `tap: "background"` indicating that the user tapped the system notification while the app was in the background. + +### iOS notification sound +You can specify custom sounds for notifications or play the device default notification sound. + +Custom sound files must be in a supported audio format (see [this Apple documentation](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/SupportingNotificationsinYourApp.html#//apple_ref/doc/uid/TP40008194-CH4-SW10) for supported formats). +For example to convert an `.mp3` file to the supported `.caf` format run: + + afconvert my_sound.mp3 my_sound.caf -d ima4 -f caff -v + +Sound files must be deployed with the iOS application bundle. +To do this, you can add `<resource-file>` tags to your `config.xml` to deploy the files, for example: + +```xml +<platform name="ios"> + <resource-file src="res/ios/sound/my_sound.caf" /> +</platform> +``` + +In a notification message, specify the `sound` key in the `apns.payload.aps` section, for example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "apns": { + "payload": { + "aps": { + "sound": "my_sound.caf" + } + } + } +} +``` + +- To play the default notification sound, set `"sound": "default"`. +- To display a silent notification (no sound), omit the `sound` key from the message. + +In a data message, specify the `notification_ios_sound` key in the `data` section: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_ios_sound": "my_sound.caf" + } +} +``` + +### iOS badge number +In a notification message, specify the `badge` key in the `apns.payload.aps` section, for example: + +```json +{ + "name": "my_notification", + "notification": { + "body": "Notification body", + "title": "Notification title" + }, + "apns": { + "payload": { + "aps": { + "badge": 1 + } + } + } +} +``` + +In a data message, specify the `notification_ios_badge` key in the `data` section: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_ios_badge": 1 + } +} +``` + +### iOS actionable notifications +[Actionable notifications](https://developer.apple.com/documentation/usernotifications/declaring_your_actionable_notification_types) are supported on iOS: + +<img width="300" src="https://user-images.githubusercontent.com/2345062/90025071-88c0a180-dcad-11ea-86f7-033f84601a56.png"/> +<img width="300" src="https://user-images.githubusercontent.com/2345062/90028234-531db780-dcb1-11ea-9df3-6bfcf8f2e9d8.png"/> + +To use them in your app you must do the following: + +1. Add a `pn-actions.json` file to your Cordova project which defines categories and actions, for example: + +```json + { + "PushNotificationActions": [ + { + "category": "news", + "actions": [ + { + "id": "read", "title": "Read" + }, + { + "id": "skip", "title": "Skip" + }, + { + "id": "add", "title": "Add to list" + } + ] + } + ] + } +``` + +2. Reference it as a resource file in your `config.xml`: + +```xml + <platform name="ios"> + ... + <resource-file src="relative/path/to/pn-actions.json" /> + </platform> +``` + +3. Add a category entry to your FCM message payload which references one of your categories: + +```json +{ + "notification": { + "title": "iOS Actionable Notification", + "body": "With custom buttons" + }, + "apns": { + "payload": { + "aps": { + "category": "news" + } + } + } +} +``` + +When the notification arrives, if the user presses an action button the [`onMessageReceived()`](#onmessagereceived) function is invoked with the notification message payload, including the corresponding action ID. +For example: + +```json +{ + "action": "read", + "google.c.a.e": "1", + "notification_foreground": "true", + "aps": { + "alert": { + "title": "iOS Actionable Notification", + "body": "With custom buttons" + }, + "category": "news" + }, + "gcm.message_id": "1597240847657854", + "tap": "background", + "messageType": "notification" +} +``` + +So you can obtain the category with `message.aps.category` and the action with `message.action` and handle this appropriately in your app code. + +Notes: +- Actionable notifications are currently only available for iOS - not Android +- To reveal the notification action buttons, the user must drag downwards on the notification dialog +- Actionable notifications work with both foreground and background (system) notifications +- If your app is in the background/not running when the notification message arrives and a system notification is displayed, if the user chooses an action (instead of tapping the notification dialog body), your app will not be launched/foregrounded but [`onMessageReceived()`](#onmessagereceived) will be invoked, enabling your app code to handle the user's action selection silently in the background. +- You can test out actionable notifications by building and running [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) app and sending the [ios_notification_actionable.json](https://github.com/dpa99c/cordova-plugin-firebasex-test/blob/master/messages/ios_notification_actionable.json) FCM message using the [built-in FCM v1 HTTP API client](https://github.com/dpa99c/cordova-plugin-firebasex-test#messaging-client) which contains a category defined in the example [pn-actions.json](https://github.com/dpa99c/cordova-plugin-firebasex-test/blob/master/res/ios/pn-actions.json). + +## Data messages +FCM data messages are sent as an arbitrary k/v structure and by default are passed to the app for it to handle them. + +**NOTE:** FCM data messages **cannot** be sent from the Firebase Console - they can only be sent via the FCM APIs. + +### Data message notifications +This plugin enables a data message to be displayed as a system notification. +To have the app display a notification when the data message arrives, you need to set the `notification_foreground` key in the `data` section. +You can then set a `notification_title` and `notification_body`, for example: + +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "foo" : "bar" + } +} +``` + +Additional platform-specific notification options can be set using the additional keys below (which are only relevant if the `notification_foreground` key is set). + +Note: [foreground notification messages](#foreground-notifications) can also make use of these keys. + +#### Android data message notifications +On Android: +- Data messages that arrive while your app is running in the foreground or running in the background will be immediately passed to the `onMessageReceived()` Javascript handler in the Webview. +- Data messages (not containing notification keys) that arrive while your app is **not running** will be passed to the `onMessageReceived()` Javascript handler when the app is next launched. +- Data messages containing notification keys that arrive while your app is running or **not running** will be displayed as a system notification. + +The following Android-specific keys are supported and should be placed inside the `data` section: + +- `notification_android_icon` - name of a [custom notification icon](#android-custom-notification-icons) in the drawable resources + - if not specified, the plugin will use the default `notification_icon` if it exists; otherwise the default app icon will be displayed + - if a [large icon](#android-large-notification-icon) has been defined, it will also be displayed in the system notification. +- `notification_android_color` - the [color accent](#android-notification-color) to use for the small notification icon + - if not specified, the default color accent will be used +- `notification_android_channel_id` - ID of the [notification channel](#android-notification-channels) to use to display the notification + - Only applies to Android 8.0 and above + - If not specified, the [default notification channel](#default-android-channel-properties) will be used. + - You can override the default configuration for the default notification channel using [setDefaultChannel](#setdefaultchannel). + - You can create additional channels using [createChannel](#createchannel). +- `notification_android_priority` - Specifies the notification priority + - Possible values: + - `2` - Highest notification priority for your application's most important items that require the user's prompt attention or input. + - `1` - Higher notification priority for more important notifications or alerts. + - `0` - Default notification priority. + - `-1` - Lower notification priority for items that are less important. + - `-2` - Lowest notification priority. These items might not be shown to the user except under special circumstances, such as detailed notification logs. + - Defaults to `2` if not specified. +- `notification_android_visibility` - Specifies the notification visibility + - Possible values: + - `1` - Show this notification in its entirety on all lockscreens. + - `0` - Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens. + - `-1` - Do not reveal any part of this notification on a secure lockscreen. + - Defaults to `1` if not specified. + +The following keys only apply to Android 7 and below. +On Android 8 and above they will be ignored - the `notification_android_channel_id` property should be used to specify a [notification channel](#android-notification-channels) with equivalent settings. + +- `notification_android_sound` - name of a sound resource to play as the [notification sound](#android-notification-sound) + - if not specified, no sound is played + - `default` plays the default device notification sound + - otherwise should be the name of an `.mp3` file in the `/res/raw` directory, e.g. `my_sound.mp3` => `"sounds": "my_sound"` +- `notification_android_lights` - color and pattern to use to blink the LED light + - if not defined, LED will not blink + - in the format `ARGB, time_on_ms, time_off_ms` where + - `ARGB` is an ARGB color definition e.g. `#ffff0000` + - `time_on_ms` is the time in milliseconds to turn the LED on for + - `time_off_ms` is the time in milliseconds to turn the LED off for + - e.g. `"lights": "#ffff0000, 250, 250"` +- `notification_android_vibrate` - pattern of vibrations to use when the message arrives + - if not specified, device will not vibrate + - an array of numbers specifying the time in milliseconds to vibrate + - e.g. `"vibrate": "500, 200, 500"` + +Example data message with Android notification keys: + +```json +{ + "name": "my_data_message", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_android_channel_id": "my_channel", + "notification_android_priority": "2", + "notification_android_visibility": "1", + "notification_android_color": "#ff0000", + "notification_android_icon": "coffee", + "notification_android_sound": "my_sound", + "notification_android_vibrate": "500, 200, 500", + "notification_android_lights": "#ffff0000, 250, 250" + } +} +``` + +#### iOS data message notifications +On iOS: +- Data messages that arrive while your app is running in the foreground or running in the background will be immediately passed to the `onMessageReceived()` Javascript handler in the Webview. +- Data messages that arrive while your app is **not running** will **NOT be received by your app!** + +The following iOS-specific keys are supported and should be placed inside the `data` section: + +- `notification_ios_sound` - Sound to play when the notification is displayed + - To play a custom sound, set the name of the sound file bundled with your app, e.g. `"sound": "my_sound.caf"` - see [iOS notification sound](#ios-notification-sound) for more info. + - To play the default notification sound, set `"sound": "default"`. + - To display a silent notification (no sound), omit the `sound` key from the message. +- `notification_ios_badge` - Badge number to display on app icon on home screen. + +For example: +```json +{ + "name": "my_data", + "data" : { + "notification_foreground": "true", + "notification_body" : "Notification body", + "notification_title": "Notification title", + "notification_ios_sound": "my_sound.caf", + "notification_ios_badge": 1 + } +} +``` + +## Custom FCM message handling +In some cases you may want to handle certain incoming FCM messages differently rather than with the default behaviour of this plugin. +Therefore this plugin provides a mechanism by which you can implement your own custom FCM message handling for specific FCM messages which bypasses handling of those messages by this plugin. +To do this requires you to write native handlers for Android & iOS which hook into the native code of this plugin. + +### Android +You'll need to add a native class which extends the [`FirebasePluginMessageReceiver` abstract class](src/android/FirebasePluginMessageReceiver.java) and implements the `onMessageReceived()` and `sendMessage()` abstract methods. + +### iOS +You'll need to add a native class which extends the [`FirebasePluginMessageReceiver` abstract class](src/ios/FirebasePluginMessageReceiver.h) and implements the `sendNotification()` abstract method. + +### Example +The [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) contains an [example plugin](https://github.com/dpa99c/cordova-plugin-firebasex-test/tree/master/plugins/cordova-plugin-customfcmreceiver) which implements a custom receiver class for both platforms. +You can test this by building and running the example project app, and sending the [notification_custom_receiver](https://github.com/dpa99c/cordova-plugin-firebasex-test/blob/master/messages/notification_custom_receiver.json) and [data_custom_receiver](https://github.com/dpa99c/cordova-plugin-firebasex-test/blob/master/messages/data_custom_receiver.json) test messages using the [built-in FCM client](https://github.com/dpa99c/cordova-plugin-firebasex-test#messaging-client). + +# InApp Messaging +The Firebase Inapp Messaging SDK component has been removed from this [cli_build](https://github.com/dpa99c/cordova-plugin-firebasex/tree/cli_build) branch of the plugin due to the iOS component causing CLI builds to fail (see [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326)). +If you wish to use Firebase Inapp Messaging, please use the [master](https://github.com/dpa99c/cordova-plugin-firebasex) branch or install a plugin release via the NPM registry and build using Xcode. + +# Google Tag Manager +The Google Tag Manager component has been removed from this [cli_build](https://github.com/dpa99c/cordova-plugin-firebasex/tree/cli_build) branch of the plugin due to the iOS component causing CLI builds to fail (see [#326](https://github.com/dpa99c/cordova-plugin-firebasex/issues/326)). +If you wish to use Google Tag Manager, please use the [master](https://github.com/dpa99c/cordova-plugin-firebasex) branch or install a plugin release via the NPM registry and build using Xcode. + +# API +The list of available methods for this plugin is described below. + +## Notifications and data messages +The plugin is capable of receiving push notifications and FCM data messages. + +See [Cloud messaging](#cloud-messaging) section for more. + +### getToken +Get the current FCM token. +Null if the token has not been allocated yet by the Firebase SDK. + +**Parameters**: +- {function} success - callback function which will be passed the {string} token as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getToken(function(fcmToken) { + console.log(fcmToken); +}, function(error) { + console.error(error); +}); +``` +Note that token will be null if it has not been established yet. + +### getId +Get the app instance ID (an constant ID which persists as long as the app is not uninstalled/reinstalled). +Null if the ID has not been allocated yet by the Firebase SDK. + +**Parameters**: +- {function} success - callback function which will be passed the {string} ID as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getId(function(appInstanceId) { + console.log(appInstanceId); +}, function(error) { + console.error(error); +}); +``` +Note that token will be null if it has not been established yet. + +### onTokenRefresh +Registers a handler to call when the FCM token changes. +This is the best way to get the token as soon as it has been allocated. +This will be called on the first run after app install when a token is first allocated. +It may also be called again under other circumstances, e.g. if `unregister()` is called or Firebase allocates a new token for other reasons. +You can use this callback to return the token to you server to keep the FCM token associated with a given user up-to-date. + +**Parameters**: +- {function} success - callback function which will be passed the {string} token as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.onTokenRefresh(function(fcmToken) { + console.log(fcmToken); +}, function(error) { + console.error(error); +}); +``` + +### getAPNSToken +iOS only. +Get the APNS token allocated for this app install. +Note that token will be null if it has not been allocated yet. + +**Parameters**: +- {function} success - callback function which will be passed the {string} APNS token as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getAPNSToken(function(apnsToken) { + console.log(apnsToken); +}, function(error) { + console.error(error); +}); +``` + +### onApnsTokenReceived +iOS only. +Registers a handler to call when the APNS token is allocated. +This will be called once when remote notifications permission has been granted by the user at runtime. + +**Parameters**: +- {function} success - callback function which will be passed the {string} token as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.onApnsTokenReceived(function(apnsToken) { + console.log(apnsToken); +}, function(error) { + console.error(error); +}); +``` + +### onMessageReceived +Registers a callback function to invoke when: +- a notification or data message is received by the app +- a system notification is tapped by the user + +**Parameters**: +- {function} success - callback function which will be passed the {object} message as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.onMessageReceived(function(message) { + console.log("Message type: " + message.messageType); + if(message.messageType === "notification"){ + console.log("Notification message received"); + if(message.tap){ + console.log("Tapped in " + message.tap); + } + } + console.dir(message); +}, function(error) { + console.error(error); +}); +``` + +The `message` object passed to the callback function will contain the platform-specific FCM message payload along with the following keys: +- `messageType=notification|data` - indicates if received message is a notification or data message +- `tap=foreground|background` - set if the call to `onMessageReceived()` was initiated by user tapping on a system notification. + - indicates if the system notification was tapped while the app was in the foreground or background. + - not set if no system notification was tapped (i.e. message was received directly from FCM rather than via a user tap on a system notification). + +Notification message flow: + +1. App is in foreground: + a. By default, when a notification message arrives the app receives the notification message payload in the `onMessageReceived` JavaScript callback without any system notification on the device itself. + b. If the `data` section contains the `notification_foreground` key, the plugin will display a system notification while in the foreground. +2. App is in background: + a. User receives the notification message as a system notification in the device notification bar + b. User taps the system notification which launches the app + b. User receives the notification message payload in the `onMessageReceived` JavaScript callback + +Data message flow: + +1. App is in foreground: + a. By default, when a data message arrives the app receives the data message payload in the `onMessageReceived` JavaScript callback without any system notification on the device itself. + b. If the `data` section contains the `notification_foreground` key, the plugin will display a system notification while in the foreground. +2. App is in background: + a. The app receives the data message in the `onMessageReceived` JavaScript callback while in the background + b. If the data message contains the [data message notification keys](#data-message-notifications), the plugin will display a system notification for the data message while in the background. + +### grantPermission +Grant permission to receive push notifications (will trigger prompt) and return `hasPermission: true`. +iOS only (Android will always return true). + +**Parameters**: +- {function} success - callback function which will be passed the {boolean} permission result as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.grantPermission(function(hasPermission){ + console.log("Permission was " + (hasPermission ? "granted" : "denied")); +}); +``` +### hasPermission +Check permission to receive push notifications and return the result to a callback function as boolean. +On iOS, returns true is runtime permission for remote notifications is granted and enabled in Settings. +On Android, returns true if remote notifications are enabled. + +**Parameters**: +- {function} success - callback function which will be passed the {boolean} permission result as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.hasPermission(function(hasPermission){ + console.log("Permission is " + (hasPermission ? "granted" : "denied")); +}); +``` + +### unregister +Unregisters from Firebase by deleting the current device token. +Use this to stop receiving push notifications associated with the current token. +e.g. call this when you logout user from your app. +By default, a new token will be generated as soon as the old one is removed. +To prevent a new token being generated, by sure to disable autoinit using [`setAutoInitEnabled()`](#setautoinitenabled) before calling [`unregister()`](#unregister). + +**Parameters**: None + +```javascript +FirebasePlugin.unregister(); +``` + +### isAutoInitEnabled +Indicates whether autoinit is currently enabled. +If so, new FCM tokens will be automatically generated. + +**Parameters**: +- {function} success - callback function which will be passed the {boolean} result as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + + +```javascript +FirebasePlugin.isAutoInitEnabled(function(enabled){ + console.log("Auto init is " + (enabled ? "enabled" : "disabled")); +}); + +``` + +### setAutoInitEnabled +Sets whether to autoinit new FCM tokens. +By default, a new token will be generated as soon as the old one is removed. +To prevent a new token being generated, by sure to disable autoinit using [`setAutoInitEnabled()`](#setautoinitenabled) before calling [`unregister()`](#unregister). + +**Parameters**: +- {boolean} enabled - set true to enable, false to disable +- {function} success - callback function to call on successful execution of operation. +- {function} error - callback function which will be passed a {string} error message as an argument + + +```javascript +FirebasePlugin.setAutoInitEnabled(false, function(){ + console.log("Auto init has been disabled "); + FirebasePlugin.unregister(); +}); + +``` + +### setBadgeNumber +iOS only. +Set a number on the icon badge: + +**Parameters**: +- {integer} badgeNumber - number to set for the app badge + +```javascript +FirebasePlugin.setBadgeNumber(3); +``` + +Set 0 to clear the badge +```javascript +FirebasePlugin.setBadgeNumber(0); +``` + +Note: this function is no longer available on Android (see [#124](https://github.com/dpa99c/cordova-plugin-firebasex/issues/124)) + +### getBadgeNumber +iOS only. +Get icon badge number: + +**Parameters**: +- {function} success - callback function which will be passed the {integer} current badge number as an argument + +```javascript +FirebasePlugin.getBadgeNumber(function(n) { + console.log(n); +}); +``` + +Note: this function is no longer available on Android (see [#124](https://github.com/dpa99c/cordova-plugin-firebasex/issues/124)) + +### clearAllNotifications +Clear all pending notifications from the drawer: + +**Parameters**: None + +```javascript +FirebasePlugin.clearAllNotifications(); +``` + +### subscribe +Subscribe to a topic. + +Topic messaging allows you to send a message to multiple devices that have opted in to a particular topic. + +**Parameters**: +- {string} topicName - name of topic to subscribe to +- {function} success - callback function which will be call on successful subscription +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.subscribe("latest_news", function(){ + console.log("Subscribed to topic"); +}, function(error){ + console.error("Error subscribing to topic: " + error); +}); +``` + +### unsubscribe +Unsubscribe from a topic. + +This will stop you receiving messages for that topic + +**Parameters**: +- {string} topicName - name of topic to unsubscribe from +- {function} success - callback function which will be call on successful unsubscription +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.unsubscribe("latest_news", function(){ + console.log("Unsubscribed from topic"); +}, function(error){ + console.error("Error unsubscribing from topic: " + error); +}); +``` + +### createChannel +Android 8+ only. +Creates a custom channel to be used by notification messages which have the channel property set in the message payload to the `id` of the created channel: +- For background (system) notifications: `android.notification.channel_id` +- For foreground/data notifications: `data.notification_android_channel_id` + +For each channel you may set the sound to be played, the color of the phone LED (if supported by the device), whether to vibrate and set vibration pattern (if supported by the device), importance and visibility. +Channels should be created as soon as possible (on program start) so notifications can work as expected. +A default channel is created by the plugin at app startup; the properties of this can be overridden see [setDefaultChannel](#setdefaultchannel) + +Calling on Android 7 or below or another platform will have no effect. + +**Parameters**: +- {object} - channel configuration object (see below for object keys/values) +- {function} success - callback function which will be call on successful channel creation +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +// Define custom channel - all keys are except 'id' are optional. +var channel = { + // channel ID - must be unique per app package + id: "my_channel_id", + + // Channel description. Default: empty string + description: "Channel description", + + // Channel name. Default: empty string + name: "Channel name", + + //The sound to play once a push comes. Default value: 'default' + //Values allowed: + //'default' - plays the default notification sound + //'ringtone' - plays the currently set ringtone + //'false' - silent; don't play any sound + //filename - the filename of the sound file located in '/res/raw' without file extension (mysound.mp3 -> mysound) + sound: "mysound", + + //Vibrate on new notification. Default value: true + //Possible values: + //Boolean - vibrate or not + //Array - vibration pattern - e.g. [500, 200, 500] - milliseconds vibrate, milliseconds pause, vibrate, pause, etc. + vibration: true, + + // Whether to blink the LED + light: true, + + //LED color in ARGB format - this example BLUE color. If set to -1, light color will be default. Default value: -1. + lightColor: parseInt("FF0000FF", 16).toString(), + + //Importance - integer from 0 to 4. Default value: 4 + //0 - none - no sound, does not show in the shade + //1 - min - no sound, only shows in the shade, below the fold + //2 - low - no sound, shows in the shade, and potentially in the status bar + //3 - default - shows everywhere, makes noise, but does not visually intrude + //4 - high - shows everywhere, makes noise and peeks + importance: 4, + + //Show badge over app icon when non handled pushes are present. Default value: true + badge: true, + + //Show message on locked screen. Default value: 1 + //Possible values (default 1): + //-1 - secret - Do not reveal any part of the notification on a secure lockscreen. + //0 - private - Show the notification on all lockscreens, but conceal sensitive or private information on secure lockscreens. + //1 - public - Show the notification in its entirety on all lockscreens. + visibility: 1 +}; + +// Create the channel +FirebasePlugin.createChannel(channel, +function(){ + console.log('Channel created: ' + channel.id); +}, +function(error){ + console.log('Create channel error: ' + error); +}); +``` + +Example FCM v1 API notification message payload for invoking the above example channel: + +```json + +{ + "notification": + { + "title":"Notification title", + "body":"Notification body" + }, + "android": { + "notification": { + "channel_id": "my_channel_id" + } + } +} + +``` + +If your Android app plays multiple sounds or effects, it's a good idea to create a channel for each likely combination. This is because once a channel is created you cannot override sounds/effects. +IE, expanding on the createChannel example: +```javascript +let soundList = ["train","woop","clock","radar","sonar"]; +for (let key of soundList) { + let name = "yourchannelprefix_" + key; + channel.id = name; + channel.sound = key; + channel.name = "Your description " + key; + + // Create the channel + window.FirebasePlugin.createChannel(channel, + function(){ + console.log('Notification Channel created: ' + channel.id + " " + JSON.stringify(channel)); + }, + function(error){ + console.log('Create notification channel error: ' + error); + }); +} +``` + +Note, if you just have one sound / effect combination that the user can customise, just use setDefaultChannel when any changes are made. + + +### setDefaultChannel +Android 8+ only. +Overrides the properties for the default channel. +The default channel is used if no other channel exists or is specified in the notification. +Any options not specified will not be overridden. +Should be called as soon as possible (on app start) so default notifications will work as expected. +Calling on Android 7 or below or another platform will have no effect. + +**Parameters**: +- {object} - channel configuration object +- {function} success - callback function which will be call on successfully setting default channel +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +var channel = { + id: "my_default_channel", + name: "My Default Name", + description: "My Default Description", + sound: "ringtone", + vibration: [500, 200, 500], + light: true, + lightColor: parseInt("FF0000FF", 16).toString(), + importance: 4, + badge: false, + visibility: -1 +}; + +FirebasePlugin.setDefaultChannel(channel, +function(){ + console.log('Default channel set'); +}, +function(error){ + console.log('Set default channel error: ' + error); +}); +``` + +### Default Android Channel Properties +The default channel is initialised at app startup with the following default settings: + +```json +{ + id: "fcm_default_channel", + name: "Default", + description: "", + sound: "default", + vibration: true, + light: true, + lightColor: -1, + importance: 4, + badge: true, + visibility: 1 +} +``` + +### deleteChannel +Android 8+ only. +Removes a previously defined channel. +Calling on Android 7 or below or another platform will have no effect. + +**Parameters**: +- {string} - id of channel to delete +- {function} success - callback function which will be call on successfully deleting channel +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.deleteChannel("my_channel_id", +function(){ + console.log('Channel deleted'); +}, +function(error){ + console.log('Delete channel error: ' + error); +}); + +``` + +### listChannels +Android 8+ only. +Gets a list of all channels. +Calling on Android 7 or below or another platform will have no effect. + +**Parameters**: +- {function} success - callback function which will be passed the {array} of channel objects as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.listChannels( +function(channels){ + if(typeof channels == "undefined") + return; + + for(var i=0;i<channels.length;i++) + { + console.log("ID: " + channels[i].id + ", Name: " + channels[i].name); + } +}, +function(error){ + alert('List channels error: ' + error); +}); + +``` + +## Analytics +Firebase Analytics enables you to log events in order to track use and behaviour of your apps. + +By default, Firebase does not store fine-grain analytics data - only a sample is taken and detailed event data is then discarded. +The Firebase Analytics console is designed to give you a coarse overview of analytics data. + +If you want to analyse detailed, event-level analytics you should consider [exporting Firebase Analytics data to BigQuery](https://firebase.google.com/docs/projects/bigquery-export). +The easiest way to set this up is by [streaming Firebase Analytics data into BigQuery](https://cloud.google.com/bigquery/streaming-data-into-bigquery). +Note that until you set this up, all fine-grain event-level data is discarded by Firebase. + +### setAnalyticsCollectionEnabled +Manually enable/disable analytics data collection, e.g. if [disabled on app startup](#disable-data-collection-on-startup). + +**Parameters**: +- {boolean} setEnabled - whether to enable or disable analytics data collection + +```javascript +FirebasePlugin.setAnalyticsCollectionEnabled(true); // Enables analytics data collection + +FirebasePlugin.setAnalyticsCollectionEnabled(false); // Disables analytics data collection +``` + +### isAnalyticsCollectionEnabled +Indicates whether analytics data collection is enabled. + +Notes: +- This value applies both to the current app session and subsequent app sessions until such time as it is changed. +- It returns the value set by [setAnalyticsCollectionEnabled()](#setanalyticscollectionenabled). +- If automatic data collection was not [disabled on app startup](#disable-data-collection-on-startup), this will always return `true`. + +**Parameters**: +- {function} success - callback function which will be invoked on success. +Will be passed a {boolean} indicating if the setting is enabled. +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.isAnalyticsCollectionEnabled(function(enabled){ + console.log("Analytics data collection is "+(enabled ? "enabled" : "disabled")); +}, function(error){ + console.error("Error getting Analytics data collection setting: "+error); +}); +``` + +### logEvent +Log an event using Analytics: + +**Parameters**: +- {string} eventName - name of event to log to Firebase Analytics +- {object} eventProperties - key/value object of event properties (must be serializable) + +```javascript +FirebasePlugin.logEvent("select_content", {content_type: "page_view", item_id: "home"}); +``` + +### setScreenName +Set the name of the current screen in Analytics: + +**Parameters**: +- {string} screenName - name of screen to log to Firebase Analytics + +```javascript +FirebasePlugin.setScreenName("Home"); +``` + +### setUserId +Set a user id for use in Analytics: + +**Parameters**: +- {string} userName - name of user to set in Firebase Analytics + +```javascript +FirebasePlugin.setUserId("user_id"); +``` + +### setUserProperty +Set a user property for use in Analytics: + +**Parameters**: +- {string} userName - name of user property to set in Firebase Analytics +- {string} userName - value of user property to set in Firebase Analytics + +```javascript +FirebasePlugin.setUserProperty("name", "value"); +``` + +## Crashlytics +By default this plugin will ensure fatal native crashes in your apps are reported to Firebase via the Firebase (not Fabric) Crashlytics SDK. + +### setCrashlyticsCollectionEnabled +Manually enable/disable Crashlytics data collection, e.g. if [disabled on app startup](#disable-data-collection-on-startup). + +**Parameters**: +- {boolean} setEnabled - whether to enable or disable Crashlytics data collection. +- {function} success - (optional) callback function which will be invoked on success +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript +var shouldSetEnabled = true; +FirebasePlugin.setCrashlyticsCollectionEnabled(shouldSetEnabled, function(){ + console.log("Crashlytics data collection is enabled"); +}, function(error){ + console.error("Crashlytics data collection couldn't be enabled: "+error); +}); +``` + +### isCrashlyticsCollectionEnabled +Indicates whether Crashlytics collection setting is currently enabled. + +**Parameters**: +- {function} success - callback function which will be invoked on success. +Will be passed a {boolean} indicating if the setting is enabled. +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.isCrashlyticsCollectionEnabled(function(enabled){ + console.log("Crashlytics data collection is "+(enabled ? "enabled" : "disabled")); +}, function(error){ + console.error("Error getting Crashlytics data collection setting: "+error); +}); +``` + + +### setCrashlyticsUserId +Set Crashlytics user identifier. + +To diagnose an issue, it’s often helpful to know which of your users experienced a given crash. Crashlytics includes a way to anonymously identify users in your crash reports. +To add user IDs to your reports, assign each user a unique identifier in the form of an ID number, token, or hashed value. + +See [the Firebase docs for more](https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids). + +**Parameters**: +- {string} userId - User ID to associate with Crashlytics reports + +```javascript +FirebasePlugin.setCrashlyticsUserId("user_id"); +``` + + +### sendCrash +Simulates (causes) a fatal native crash which causes a crash event to be sent to Crashlytics (useful for testing). +See [the Firebase documentation](https://firebase.google.com/docs/crashlytics/force-a-crash?authuser=0#force_a_crash_to_test_your_implementation) regarding crash testing. +Crashes will appear under `Event type = "Crashes"` in the Crashlytics console. + +**Parameters**: None + +```javascript +FirebasePlugin.sendCrash(); +``` + +### logMessage +Sends a crash-related log message that will appear in the `Logs` section of the next native crash event. +Note: if you don't then crash, the message won't be sent! +Also logs the message to the native device console. + +**Parameters**: +- {string} message - message to associate with next native crash event + +```javascript +FirebasePlugin.logMessage("about to send a crash for testing!"); +FirebasePlugin.sendCrash(); +``` + +### logError +Sends a non-fatal error event to Crashlytics. +In a Cordova app, you may use this to log unhandled Javascript exceptions, for example. + +The event will appear under `Event type = "Non-fatals"` in the Crashlytics console. +The error message will appear in the `Logs` section of the non-fatal error event. +Also logs the error message to the native device console. + +**Parameters**: +- {string} errorMessage - non-fatal error message to log to Crashlytics +- {object} stackTrace - (optional) a stack trace generated by [stacktrace.js](http://www.stacktracejs.com/) +- {function} success - (optional) callback function which will be invoked on success +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript + // Send an unhandled JS exception + var appRootURL = window.location.href.replace("index.html",''); + window.onerror = function(errorMsg, url, line, col, error) { + var logMessage = errorMsg; + var stackTrace = null; + + var sendError = function(){ + FirebasePlugin.logError(logMessage, stackTrace, function(){ + console.log("Sent JS exception"); + },function(error){ + console.error("Failed to send JS exception", error); + }); + }; + + logMessage += ': url='+url.replace(appRootURL, '')+'; line='+line+'; col='+col; + + if(typeof error === 'object'){ + StackTrace.fromError(error).then(function(trace){ + stackTrace = trace; + sendError() + }); + }else{ + sendError(); + } + }; + + // Send a non-fatal error + FirebasePlugin.logError("A non-fatal error", function(){ + console.log("Sent non-fatal error"); + },function(error){ + console.error("Failed to send non-fatal error", error); + }); +``` + +An example of how the error entry will appear in the Crashlytics console: +<br/> +<b>Android</b> +<br/> +<img src="https://user-images.githubusercontent.com/2345062/68016874-5e0cdb80-fc8d-11e9-9a26-97b448039cf5.png"/> + +<br/><br/> +<b>iOS</b> +<br/> +<img src="https://user-images.githubusercontent.com/2345062/68041597-d1800e80-fcc8-11e9-90e1-eeeedf9cc43f.png"/> + + + +## Authentication + +### isUserSignedIn +Checks if there is a current Firebase user signed into the app. + +**Parameters**: +- {function} success - callback function to pass {boolean} result to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.isUserSignedIn(function(isSignedIn) { + console.log("User "+(isSignedIn ? "is" : "is not") + " signed in"); + }, function(error) { + console.error("Failed to check if user is signed in: " + error); + }); +``` + +### signOutUser +Signs current Firebase user out of the app. + +**Parameters**: +- {function} success - callback function to pass {boolean} result to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.signOutUser(function() { + console.log("User signed out"); + }, function(error) { + console.error("Failed to sign out user: " + error); + }); +``` + +### getCurrentUser +Returns details of the currently logged in user from local Firebase SDK. +Note that some user properties will be empty is they are not defined in Firebase for the current user. + +**Parameters**: +- {function} success - callback function to pass user {object} to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.getCurrentUser(function(user) { + console.log("Name: "+user.name); + console.log("Email: "+user.email); + console.log("Is email verified?: "+user.emailIsVerified); + console.log("Phone number: "+user.phoneNumber); + console.log("Photo URL: "+user.photoUrl); + console.log("UID: "+user.uid); + console.log("Provider ID: "+user.providerId); + console.log("ID token: "+user.idToken); + }, function(error) { + console.error("Failed to get current user data: " + error); + }); +``` + +### reloadCurrentUser +Loads details of the currently logged in user from remote Firebase server. +This differs from `getCurrentUser()` which loads the locally cached details which may be stale. +For example, if you want to check if a user has verified their email address, this method will guarantee the reported verified state is up-to-date. + +**Parameters**: +- {function} success - callback function to pass user {object} to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.reloadCurrentUser(function(user) { + console.log("Name: "+user.name); + console.log("Email: "+user.email); + console.log("Is email verified?: "+user.emailIsVerified); + console.log("Phone number: "+user.phoneNumber); + console.log("Photo URL: "+user.photoUrl); + console.log("UID: "+user.uid); + console.log("Provider ID: "+user.providerId); + console.log("ID token: "+user.idToken); + }, function(error) { + console.error("Failed to reload current user data: " + error); + }); +``` + +### updateUserProfile +Updates the display name and/or photo URL of the current Firebase user signed into the app. + +**Parameters**: +- {object} profile - new profile details: + - {string} name - display name of user + - {string} photoUri - URL of user profile photo +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.updateUserProfile({ + name: "Homer Simpson", + photoUri: "http://homer.simpson.com/photo.png" + },function() { + console.log("User profile successfully updated"); + }, function(error) { + console.error("Failed to update user profile: " + error); + }); +``` + +### updateUserEmail +Updates/sets the email address of the current Firebase user signed into the app. + +**Parameters**: +- {string} email - email address of user +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.updateUserEmail("user@somewhere.com",function() { + console.log("User email successfully updated"); + }, function(error) { + console.error("Failed to update user email: " + error); + }); +``` + +### sendUserEmailVerification +Sends a verification email to the currently configured email address of the current Firebase user signed into the app. +When the user opens the contained link, their email address will have been verified. + +**Parameters**: +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.sendUserEmailVerification(function() { + console.log("User verification email successfully sent"); + }, function(error) { + console.error("Failed to send user verification email: " + error); + }); +``` + +### updateUserPassword +Updates/sets the account password for the current Firebase user signed into the app. + +**Parameters**: +- {string} password - user-defined password +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.updateUserPassword("mypassword",function() { + console.log("User password successfully updated"); + }, function(error) { + console.error("Failed to update user password: " + error); + }); +``` + +### sendUserPasswordResetEmail +Sends a password reset email to the specified user email address. +Note: doesn't require the Firebase user to be signed in to the app. + +**Parameters**: +- {string} email - email address of user +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.sendUserPasswordResetEmail("user@somewhere.com",function() { + console.log("User password reset email sent successfully"); + }, function(error) { + console.error("Failed to send user password reset email: " + error); + }); +``` + +### deleteUser +Deletes the account of the current Firebase user signed into the app. + +**Parameters**: +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript + FirebasePlugin.deleteUser(function() { + console.log("User account deleted"); + }, function(error) { + console.error("Failed to delete current user account: " + error); + }); +``` + +### createUserWithEmailAndPassword +Creates a new email/password-based user account. +If account creation is successful, user will be automatically signed in. + +**Parameters**: +- {string} email - user email address. It is the responsibility of the app to ensure this is a valid email address. +- {string} password - user password. It is the responsibility of the app to ensure the password is suitable. +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript + FirebasePlugin.createUserWithEmailAndPassword(email, password, function() { + console.log("Successfully created email/password-based user account"); + // User is now signed in + }, function(error) { + console.error("Failed to create email/password-based user account", error); + }); +``` + +### signInUserWithEmailAndPassword +Signs in to an email/password-based user account. + +**Parameters**: +- {string} email - user email address +- {string} password - user password +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript + FirebasePlugin.signInUserWithEmailAndPassword(email, password, function() { + console.log("Successfully signed in"); + // User is now signed in + }, function(error) { + console.error("Failed to sign in", error); + }); +``` + +### signInUserWithCustomToken +Signs in user with custom token. + +**Parameters**: +- {string} customToken - the custom token +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript + FirebasePlugin.signInUserWithCustomToken(customToken, function() { + console.log("Successfully signed in"); + // User is now signed in + }, function(error) { + console.error("Failed to sign in", error); + }); +``` + +### signInUserAnonymously +Signs in user anonymously. + +**Parameters**: +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript + FirebasePlugin.signInUserAnonymously(function() { + console.log("Successfully signed in"); + // User is now signed in + }, function(error) { + console.error("Failed to sign in", error); + }); +``` + +### verifyPhoneNumber +Requests verification of a phone number. +The resulting credential can be used to create/sign in to a phone number-based user account in your app or to link the phone number to an existing user account + +**NOTE: This will only work on physical devices with a SIM card (not iOS Simulator or Android Emulator)** + +In response to your request, you'll receive a verification ID which you can use in conjunction with the verification code to sign the user in. + +There are 3 verification scenarios: +- Some Android devices support "instant verification" where the phone number can be instantly verified without sending or receiving an SMS. + - In this case, the user doesn't need to do anything in order for you to sign them in and you don't need to provide any additional credentials in order to sign the user in or link the user account to an existing Firebase user account. +- Some Android devices support "auto-retrieval" where Google Play services is able to detect the incoming verification SMS and perform verification with no user action required. + - As above, the user doesn't need to do anything in order for you to sign them in. +- For other Android devices and all iOS devices, the user must manually enter the verification code received in the SMS into your app. + - This code be used, along with the accompanying verification ID, to sign the user in or link phone number to an existing Firebase user account. + +**Parameters**: +- {function} success - callback function to pass {object} credentials to as an argument +- {function} error - callback function which will be passed a {string} error message as an argument +- {string} phoneNumber - phone number to verify +- {integer} timeOutDuration - (optional) time to wait in seconds before timing out +- {string} fakeVerificationCode - (optional) to test instant verification on Android ,specify a fake verification code to return for whitelisted phone numbers. + - See [Firebase SDK Phone Auth Android Integration Testing](https://firebase.google.com/docs/auth/android/phone-auth#integration-testing) for more info. + +The success callback will be passed a credential object with the following possible properties: +- {boolean} instantVerification - `true` if the Android device used instant verification to instantly verify the user without sending an SMS +or used auto-retrieval to automatically read an incoming SMS. +If this is `false`, the device will be sent an SMS containing the verification code. +If the Android device supports auto-retrieval, on the device receiving the SMS, this success callback will be immediately invoked again with `instantVerification: true` and no user action will be required for verification since Google Play services will extract and submit the verification code. +Otherwise the user must manually enter the verification code from the SMS into your app. +Always `false` on iOS. +- {string} id - the identifier of a native credential object which can be used for signing in the user. +Will only be present if `instantVerification` is `true`. +- {string} verificationId - the verification ID to be passed along with the verification code sent via SMS to sign the user in. +Will only be present if `instantVerification` is `false`. + +Example usage: + +```javascript +var number = '+441234567890'; +var timeOutDuration = 60; +var fakeVerificationCode = '123456'; +var awaitingSms = false; + +FirebasePlugin.verifyPhoneNumber(function(credential) { + + if(credential.instantVerification){ + if(awaitingSms){ + awaitingSms = false; + // the Android device used auto-retrieval to extract and submit the verification code in the SMS so dismiss user input UI + dismissUserPromptToInputCode(); + } + signInWithCredential(credential); + }else{ + awaitingSms = true; + promptUserToInputCode() // you need to implement this + .then(function(userEnteredCode){ + awaitingSms = false; + credential.code = userEnteredCode; // set the user-entered verification code on the credential object + signInWithCredential(credential); + }); + } +}, function(error) { + console.error("Failed to verify phone number: " + JSON.stringify(error)); +}, number, timeOutDuration, fakeVerificationCode); + +function signInWithCredential(credential){ + FirebasePlugin.signInWithCredential(credential, function() { + console.log("Successfully signed in"); + }, function(error) { + console.error("Failed to sign in", error); + }); +} +``` + +#### Android +To use phone auth with your Android app, you need to configure your app SHA-1 hash in the android app configuration in the Firebase console. +See [this guide](https://developers.google.com/android/guides/client-auth) to find how to your SHA-1 app hash. +See the [Firebase phone auth integration guide for native Android](https://firebase.google.com/docs/auth/android/phone-auth) for more information. + +#### iOS +When you call this method on iOS, FCM sends a silent push notification to the iOS device to verify it. +So to use phone auth with your iOS app, you need to: +- [setup your iOS app for push notifications](https://firebase.google.com/docs/cloud-messaging/ios/certs) +- Verify that push notifications are arriving on your physical device +- [Upload your APNs auth key to the Firebase console](https://firebase.google.com/docs/cloud-messaging/ios/client#upload_your_apns_authentication_key). + +You can [set up reCAPTCHA verification for iOS](https://firebase.google.com/docs/auth/ios/phone-auth#set-up-recaptcha-verification) automatically by specifying the `SETUP_RECAPTCHA_VERIFICATION` plugin variable at plugin install time: + + cordova plugin add cordova-plugin-firebasex --variable SETUP_RECAPTCHA_VERIFICATION=true + +This adds the `REVERSED_CLIENT_ID` from the `GoogleService-Info.plist` to the list of custom URL schemes in your Xcode project, so you don't need to do this manually. + +### authenticateUserWithGoogle +Authenticates the user with a Google account to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +**Parameters**: +- {string} clientId - your OAuth 2.0 client ID - [see here](https://developers.google.com/identity/sign-in/android/start-integrating#get_your_backend_servers_oauth_20_client_id) how to obtain it. +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +FirebasePlugin.authenticateUserWithGoogle(clientId, function(credential) { + FirebasePlugin.signInWithCredential(credential, function() { + console.log("Successfully signed in"); + }, function(error) { + console.error("Failed to sign in", error); + }); +}, function(error) { + console.error("Failed to authenticate with Google: " + error); +}); +``` + +#### Android +To use Google Sign-in in your Android app you need to do the following: +- Add the SHA-1 fingerprint of your app's signing key to your Firebase project +- Enable Google Sign-in in the Firebase console + +For details how to do the above, see the [Google Sign-In on Android page](https://firebase.google.com/docs/auth/android/google-signin) in the Firebase documentation. + +### authenticateUserWithApple +Authenticates the user with an Apple account using Sign In with Apple to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + +**Parameters**: +- {function} success - callback function to pass {object} credentials to as an argument. The credential object has the following properties: + - {string} id - the identifier of a native credential object which can be used for signing in the user. +- {function} error - callback function which will be passed a {string} error message as an argument + - {string} locale - (Android only) the language to display Apple's Sign-in screen in. + - Defaults to "en" (English) if not specified. + - See [the Apple documentation](https://developer.apple.com/documentation/signinwithapplejs/incorporating_sign_in_with_apple_into_other_platforms###2112) for a list of supported locales. + - The value is ignored on iOS which uses the locale of the device to determine the display language. + +Example usage: + +```javascript + +FirebasePlugin.authenticateUserWithApple(function(credential) { + FirebasePlugin.signInWithCredential(credential, function() { + console.log("Successfully signed in"); + }, function(error) { + console.error("Failed to sign in", error); + }); +}, function(error) { + console.error("Failed to authenticate with Apple: " + error); +}, 'en_GB'); +``` +#### iOS +To use Sign In with Apple in your iOS app you need to do the following: +- Configure your app for Sign In with Apple as outlined in the [Firebase documentation's "Before you begin" section](https://firebase.google.com/docs/auth/ios/apple#before-you-begin) +- After adding the `cordova-ios` platform, open the project workspace in Xcode (`platforms/ios/YourApp.xcworkspace`) and add the "Sign In with Apple" capability in the "Signing & Capabilities section" + - Note: AFAIK there is currently no way to automate the addition of this capability + +#### Android +To use Sign In with Apple in your Android app you need to do the following: +- Configure your app for Sign In with Apple as outlined in the [Firebase documentation's "Before you begin" section](https://firebase.google.com/docs/auth/android/apple#before-you-begin) + +### signInWithCredential +Signs the user into Firebase with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. +See the [Android-](https://firebase.google.com/docs/auth/android/phone-auth#sign-in-the-user) and [iOS](https://firebase.google.com/docs/auth/ios/phone-auth#sign-in-the-user-with-the-verification-code)-specific Firebase documentation for more info. + +**Parameters**: +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. + - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on successful sign-in using credentials +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +function signInWithCredential(credential){ + FirebasePlugin.signInWithCredential(credential, function() { + console.log("Successfully signed in"); + }, function(error) { + console.error("Failed to sign in", error); + }); +} + +``` + +### linkUserWithCredential +Links an existing Firebase user account with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. +See the [Android-](https://firebase.google.com/docs/auth/android/account-linking) and [iOS](https://firebase.google.com/docs/auth/ios/account-linking)-specific Firebase documentation for more info. + +**Parameters**: +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. + - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on successful linking using credentials +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript +function linkUserWithCredential(credential){ + FirebasePlugin.linkUserWithCredential(credential, function() { + console.log("Successfully linked"); + }, function(error) { + console.error("Failed to link", error); + }); +} + +``` + +### reauthenticateWithCredential +Reauthenticates the currently signed in user with credentials obtained via an authentication method such as `verifyPhoneNumber()` or `authenticateUserWithGoogle()`. + +**Parameters**: +- {object} credential - a credential object returned by the success callback of an authentication method; may have the following keys: + - {string} id - the identifier of a native credential object which can be used for signing in the user. + Present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `true`, or if another authentication method was used such as `authenticateUserWithGoogle()`. + - {boolean} instantVerification - true if an Android device and instant verification or auto-retrieval was used to verify the user. + If true, you do not need to provide a user-entered verification. + - Only present if the credential was obtained via `verifyPhoneNumber()` + - {string} verificationId - the verification ID to accompany the user-entered verification code from the SMS. + - Only present if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`. + - {string} code - if the credential was obtained via `verifyPhoneNumber()` and `instantVerification` is `false`, you must set this to the activation code value as entered by the user from the received SMS message. +- {function} success - callback function to call on success +- {function} error - callback function which will be passed a {string} error message as an argument + +Example usage: + +```javascript + FirebasePlugin.reauthenticateWithCredential(credential, function() { + console.log("Successfully reauthenticated"); + }, function(error) { + console.error("Failed to reauthenticate", error); + }); +``` + +### registerAuthStateChangeListener +Registers a Javascript function to invoke when Firebase Authentication state changes between user signed in/signed out. + +**Parameters**: +- {function} fn - callback function to invoke when authentication state changes + - Will be a passed a single boolean argument which is `true` if user just signed in and `false` if user just signed out. + +Example usage: + +```javascript + FirebasePlugin.registerAuthStateChangeListener(function(userSignedIn){ + console.log("Auth state changed: User signed " + (userSignedIn ? "in" : "out")); + }); +``` + +## Remote Config + +### fetch +Fetch Remote Config parameter values for your app: + +**Parameters**: +- {integer} cacheExpirationSeconds (optional) - cache expiration in seconds +- {function} success - callback function on successfully fetching remote config +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.fetch(function () { + // success callback +}, function () { + // error callback +}); +// or, specify the cacheExpirationSeconds +FirebasePlugin.fetch(600, function () { + // success callback +}, function () { + // error callback +}); +``` + +### activateFetched +Activate the Remote Config fetched config: + +**Parameters**: +- {function} success - callback function which will be passed a {boolean} argument indicating whether fetched config was successfully activated +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.activateFetched(function(activated) { + // activated will be true if there was a fetched config activated, + // or false if no fetched config was found, or the fetched config was already activated. + console.log(activated); +}, function(error) { + console.error(error); +}); +``` + +### getValue +Retrieve a Remote Config value: + +**Parameters**: +- {string} key - key for which to fetch associated value +- {function} success - callback function which will be passed a {any} argument containing the value stored against the specified key. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getValue("key", function(value) { + console.log(value); +}, function(error) { + console.error(error); +}); +``` + +### getByteArray +Android only. +Retrieve a Remote Config byte array: + +**Parameters**: +- {string} key - key for which to fetch associated value +- {function} success - callback function which will be passed a {string} argument containing the Base64 encoded string that represents the value stored against the specified key. +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getByteArray("key", function(bytes) { + // a Base64 encoded string that represents the value for "key" + console.log(bytes.base64); + // a numeric array containing the values of the byte array (i.e. [0xFF, 0x00]) + console.log(bytes.array); +}, function(error) { + console.error(error); +}); +``` + +### getInfo +Get the current state of the FirebaseRemoteConfig singleton object: + +**Parameters**: +- {function} success - callback function which will be passed an {object} argument containing the state info +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.getInfo(function(info) { + // the status of the developer mode setting (true/false) + console.log(info.configSettings.developerModeEnabled); + // (iOS only) for how much (secs) fetch cache is valid and data will not be refetched + console.log(info.configSettings.minimumFetchInterval); + // (iOS only) value in seconds to abandon a pending fetch request made to the backend + console.log(info.configSettings.fetchTimeout); + // the timestamp (milliseconds since epoch) of the last successful fetch + console.log(info.fetchTimeMillis); + // the status of the most recent fetch attempt (int) + // 0 = Config has never been fetched. + // 1 = Config fetch succeeded. + // 2 = Config fetch failed. + // 3 = Config fetch was throttled. + console.log(info.lastFetchStatus); +}, function(error) { + console.error(error); +}); +``` + +### setConfigSettings +Android only. +Change the settings for the FirebaseRemoteConfig object's operations: + +**Parameters**: +- {object} configSettings - object specifying the remote config settings +- {function} success - callback function to be call on successfully setting the remote config settings +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +var settings = { + developerModeEnabled: true +} +FirebasePlugin.setConfigSettings(settings); +``` + +### setDefaults +Android only. +Set defaults in the Remote Config: + +**Parameters**: +- {object} defaultSettings - object specifying the default remote config settings +- {function} success - callback function to be call on successfully setting the remote config setting defaults +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +// define defaults +var defaults = { + // map property name to value in Remote Config defaults + mLong: 1000, + mString: 'hello world', + mDouble: 3.14, + mBoolean: true, + // map "mBase64" to a Remote Config byte array represented by a Base64 string + // Note: the Base64 string is in an array in order to differentiate from a string config value + mBase64: ["SGVsbG8gV29ybGQ="], + // map "mBytes" to a Remote Config byte array represented by a numeric array + mBytes: [0xFF, 0x00] +} +// set defaults +FirebasePlugin.setDefaults(defaults); + +``` + +## Performance + +### setPerformanceCollectionEnabled +Manually enable/disable performance data collection, e.g. if [disabled on app startup](#disable-data-collection-on-startup). + +**Parameters**: +- {boolean} setEnabled - whether to enable or disable performance data collection + +```javascript +FirebasePlugin.setPerformanceCollectionEnabled(true); // Enables performance data collection + +FirebasePlugin.setPerformanceCollectionEnabled(false); // Disables performance data collection +``` + +### isPerformanceCollectionEnabled +Indicates whether performance data collection is enabled. + +Notes: +- This value applies both to the current app session and subsequent app sessions until such time as it is changed. +- It returns the value set by [setPerformanceCollectionEnabled()](#setperformancecollectionenabled). +- If automatic data collection was not [disabled on app startup](#disable-data-collection-on-startup), this will always return `true`. + +**Parameters**: +- {function} success - callback function which will be invoked on success. +Will be passed a {boolean} indicating if the setting is enabled. +- {function} error - (optional) callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.isPerformanceCollectionEnabled(function(enabled){ + console.log("Performance data collection is "+(enabled ? "enabled" : "disabled")); +}, function(error){ + console.error("Error getting Performance data collection setting: "+error); +}); +``` + +### startTrace + +Start a trace. + +**Parameters**: +- {string} name - name of trace to start +- {function} success - callback function to call on successfully starting trace +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.startTrace("test trace", success, error); +``` + +### incrementCounter + +To count the performance-related events that occur in your app (such as cache hits or retries), add a line of code similar to the following whenever the event occurs, using a string other than retry to name that event if you are counting a different type of event: + +**Parameters**: +- {string} name - name of trace +- {string} counterName - name of counter to increment +- {function} success - callback function to call on successfully incrementing counter +- {function} error - callback function which will be passed a {string} error message as an argument + + +```javascript +FirebasePlugin.incrementCounter("test trace", "retry", success, error); +``` + +### stopTrace + +Stop the trace + +**Parameters**: +- {string} name - name of trace to stop +- {function} success - callback function to call on successfully stopping trace +- {function} error - callback function which will be passed a {string} error message as an argument + +```javascript +FirebasePlugin.stopTrace("test trace"); +``` + +## Firestore +These plugin API functions provide CRUD operations for working with documents in Firestore collections. + +Notes: +- Only top-level Firestore collections are currently supported - [subcollections](https://firebase.google.com/docs/firestore/manage-data/structure-data#subcollections) (nested collections within documents) are currently not supported due to the complexity of mapping the native objects into the plugin's JS API layer. +- A document object may contain values of primitive Javascript types `string`, `number`, `boolean`, `array` or `object`. +Arrays and objects may contain nested structures of these types. +- If a collection name referenced in a document write operation does not already exist, it will be created by the first write operation referencing it. + +### addDocumentToFirestoreCollection +Adds a new document to a Firestore collection, which will be allocated an auto-generated document ID. + +**Parameters**: +- {object} document - document object to add to collection +- {string} collection - name of top-level collection to add document to. +- {function} success - callback function to call on successfully adding the document. +Will be passed a {string} argument containing the auto-generated document ID that the document was stored against. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var document = { + "a_string": "foo", + "a_list": [1, 2, 3], + "an_object": { + "an_integer": 1, + } +}; +var collection = "my_collection"; +FirebasePlugin.addDocumentToFirestoreCollection(document, collection, function(documentId){ + console.log("Successfully added document with id="+documentId); +}, function(error){ + console.error("Error adding document: "+error); +}); +``` + +### setDocumentInFirestoreCollection +Sets (adds/replaces) a document with the given ID in a Firestore collection. + +**Parameters**: +- {string} documentId - document ID to use when setting document in the collection. +- {object} document - document object to set in collection. +- {string} collection - name of top-level collection to set document in. +- {function} success - callback function to call on successfully setting the document. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var document = { + "a_string": "foo", + "a_list": [1, 2, 3], + "an_object": { + "an_integer": 1, + } +}; +var collection = "my_collection"; +FirebasePlugin.setDocumentInFirestoreCollection(documentId, document, collection, function(){ + console.log("Successfully set document with id="+documentId); +}, function(error){ + console.error("Error setting document: "+error); +}); +``` + +### updateDocumentInFirestoreCollection +Updates an existing document with the given ID in a Firestore collection. +This is a non-destructive update that will only overwrite existing keys in the existing document or add new ones if they don't already exist. +If the no document with the specified ID exists in the collection, an error will be raised. + +**Parameters**: +- {string} documentId - document ID of the document to update. +- {object} document - entire document or document fragment to update existing document with. +- {string} collection - name of top-level collection to update document in. +- {function} success - callback function to call on successfully updating the document. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var documentFragment = { + "a_string": "new value", + "a_new_string": "bar" +}; +var collection = "my_collection"; +FirebasePlugin.updateDocumentInFirestoreCollection(documentId, documentFragment, collection, function(){ + console.log("Successfully updated document with id="+documentId); +}, function(error){ + console.error("Error updating document: "+error); +}); +``` + +### deleteDocumentFromFirestoreCollection +Deletes an existing document with the given ID in a Firestore collection. + +Note: If the no document with the specified ID exists in the collection, the Firebase SDK will still return a successful outcome. + +**Parameters**: +- {string} documentId - document ID of the document to delete. +- {string} collection - name of top-level collection to delete document in. +- {function} success - callback function to call on successfully deleting the document. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.deleteDocumentFromFirestoreCollection(documentId, collection, function(){ + console.log("Successfully deleted document with id="+documentId); +}, function(error){ + console.error("Error deleting document: "+error); +}); +``` + +### documentExistsInFirestoreCollection +Indicates if a document with the given ID exists in a Firestore collection. + +**Parameters**: +- {string} documentId - document ID of the document. +- {string} collection - name of top-level collection to check for document. +- {function} success - callback function to call pass result. +Will be passed an {boolean} which is `true` if a document exists. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.documentExistsInFirestoreCollection(documentId, collection, function(exists){ + console.log("Document " + (exists ? "exists" : "doesn't exist")); +}, function(error){ + console.error("Error fetching document: "+error); +}); +``` + +### fetchDocumentInFirestoreCollection +Fetches an existing document with the given ID from a Firestore collection. + +Note: If the no document with the specified ID exists in the collection, the error callback will be invoked. + +**Parameters**: +- {string} documentId - document ID of the document to fetch. +- {string} collection - name of top-level collection to fetch document from. +- {function} success - callback function to call on successfully fetching the document. +Will be passed an {object} contain the document contents. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var documentId = "my_doc"; +var collection = "my_collection"; +FirebasePlugin.fetchDocumentInFirestoreCollection(documentId, collection, function(document){ + console.log("Successfully fetched document: "+JSON.stringify(document)); +}, function(error){ + console.error("Error fetching document: "+error); +}); +``` + +### fetchFirestoreCollection +Fetches all the documents in the specific collection. + +**Parameters**: +- {string} collection - name of top-level collection to fetch. +- {array} filters - a list of filters to sort/filter the documents returned from your collection. + - Supports `where`, `orderBy`, `startAt`, `endAt` and `limit` filters. + - See the [Firestore documentation](https://firebase.google.com/docs/firestore/query-data/queries) for more details. +- {function} success - callback function to call on successfully deleting the document. +Will be passed an {object} containing all the documents in the collection, indexed by document ID. +If a Firebase collection with that name does not exist or it contains no documents, the object will be empty. +- {function} error - callback function which will be passed a {string} error message as an argument. + +```javascript +var collection = "my_collection"; +var filters = [ + ['where', 'field', '==', 'value'], + ['orderBy', 'field', 'desc'] +]; +FirebasePlugin.fetchFirestoreCollection(collection, filters, function(documents){ + console.log("Successfully fetched collection: "+JSON.stringify(documents)); +}, function(error){ + console.error("Error fetching collection: "+error); +}); +``` + + + +# Credits +- [@robertarnesson](https://github.com/robertarnesson) for the original [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) from which this plugin is forked. +- [@sagrawal31](https://github.com/sagrawal31) and [Wiz Panda](https://github.com/wizpanda) for contributions via [cordova-plugin-firebase-lib](https://github.com/wizpanda/cordova-plugin-firebase-lib). +- [Full list of contributors](https://github.com/dpa99c/cordova-plugin-firebasex/graphs/contributors) diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/_config.yml b/StoneIsland/plugins/cordova-plugin-firebasex/_config.yml new file mode 100644 index 00000000..c4192631 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/bump-version.js b/StoneIsland/plugins/cordova-plugin-firebasex/bump-version.js new file mode 100644 index 00000000..8e4d075f --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/bump-version.js @@ -0,0 +1,8 @@ +#!/usr/bin/env node + +const fs = require('fs'); +const version = require('./package.json').version; + +let data = fs.readFileSync('./plugin.xml', "utf8"); +data = data.replace(/plugin id="cordova-plugin-firebase" version="[^"]+"/, `plugin id="cordova-plugin-firebase" version="${version}"`); +fs.writeFileSync('./plugin.xml', data); diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/package.json b/StoneIsland/plugins/cordova-plugin-firebasex/package.json new file mode 100644 index 00000000..3bdc2292 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/package.json @@ -0,0 +1,73 @@ +{ + "_from": "cordova-plugin-firebasex", + "_id": "cordova-plugin-firebasex@10.2.0-cli", + "_inBundle": false, + "_integrity": "sha512-EQWsbVHlr5jHrmi0WCdnkYpV/6BNBhhNIpD0gOIMFrHIETjCPSkV1epeW5nvISRW23OZqd4LAZTQeByFa7AcNQ==", + "_location": "/cordova-plugin-firebasex", + "_phantomChildren": {}, + "_requested": { + "type": "tag", + "registry": true, + "raw": "cordova-plugin-firebasex", + "name": "cordova-plugin-firebasex", + "escapedName": "cordova-plugin-firebasex", + "rawSpec": "", + "saveSpec": null, + "fetchSpec": "latest" + }, + "_requiredBy": [ + "#DEV:/", + "#USER" + ], + "_resolved": "https://registry.npmjs.org/cordova-plugin-firebasex/-/cordova-plugin-firebasex-10.2.0-cli.tgz", + "_shasum": "c1cdeb6d957a35e84977106f0db74c3a129e49ec", + "_spec": "cordova-plugin-firebasex", + "_where": "/Users/user/work/stone-island/StoneIsland", + "author": { + "name": "Dave Alden" + }, + "bugs": { + "url": "https://github.com/dpa99c/cordova-plugin-firebase/issues" + }, + "bundleDependencies": false, + "cordova": { + "id": "cordova-plugin-firebase", + "platforms": [ + "android", + "ios" + ] + }, + "dependencies": { + "plist": "^3.0.1", + "semver": "^7.3.2", + "xcode": "^3.0.1", + "xml-js": "^1.6.11" + }, + "deprecated": false, + "description": "Cordova plugin for Google Firebase", + "homepage": "https://github.com/dpa99c/cordova-plugin-firebase#readme", + "keywords": [ + "ecosystem:cordova", + "cordova-android", + "cordova-ios", + "firebase", + "push", + "notifications", + "phone auth" + ], + "license": "MIT", + "name": "cordova-plugin-firebasex", + "repository": { + "type": "git", + "url": "git+https://github.com/dpa99c/cordova-plugin-firebase.git" + }, + "scripts": { + "postversion": "git push && git push --tags && npm publish --verbose", + "test": "npm run test:ios && npm run test:android", + "test:android": "bash ./test/test-default.sh 9.0.0 android 8.1.0 && bash ./test/test-with-3-plugins.sh 9.0.0 android 8.1.0 cordova-plugin-request-location-accuracy cordova-android-play-services-gradle-release cordova-android-firebase-gradle-release", + "test:ios": "bash ./test/test-default.sh 9.0.0 ios 5.0.1", + "version": "node ./bump-version.js && git add -A plugin.xml" + }, + "types": "./types/index.d.ts", + "version": "10.2.0-cli" +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/plugin.xml b/StoneIsland/plugins/cordova-plugin-firebasex/plugin.xml new file mode 100644 index 00000000..934d49ca --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/plugin.xml @@ -0,0 +1,145 @@ +<?xml version='1.0' encoding='utf-8'?> +<plugin id="cordova-plugin-firebasex" version="10.2.0-cli" + xmlns="http://apache.org/cordova/ns/plugins/1.0" + xmlns:android="http://schemas.android.com/apk/res/android"> + <name>Google Firebase Plugin</name> + + <license>MIT</license> + + <dependency id="cordova-plugin-androidx" version="^2.0.0" /> + <dependency id="cordova-plugin-androidx-adapter" version="^1.1.1" /> + + <engines> + <engine name="cordova" version=">=9" /> + <engine name="cordova-android" version=">=8" /> + <engine name="cordova-ios" version=">=5" /> + </engines> + + <preference name="FIREBASE_ANALYTICS_COLLECTION_ENABLED" default="true" /> + <preference name="FIREBASE_PERFORMANCE_COLLECTION_ENABLED" default="true" /> + <preference name="FIREBASE_CRASHLYTICS_COLLECTION_ENABLED" default="true" /> + + <platform name="android"> + <preference name="ANDROID_ICON_ACCENT" default="#FF00FFFF" /> + + <js-module name="FirebasePlugin" src="www/firebase.js"> + <clobbers target="FirebasePlugin" /> + </js-module> + <config-file parent="/*" target="res/xml/config.xml"> + <feature name="FirebasePlugin"> + <param name="android-package" value="org.apache.cordova.firebase.FirebasePlugin" /> + <param name="onload" value="true" /> + </feature> + </config-file> + <config-file target="AndroidManifest.xml" parent="/*"> + <uses-permission android:name="android.permission.INTERNET" /> + <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> + <uses-permission android:name="android.permission.WAKE_LOCK" /> + </config-file> + <config-file target="AndroidManifest.xml" parent="application"> + <service android:enabled="true" android:exported="false" android:name="com.google.android.gms.measurement.AppMeasurementService" /> + <service android:name="org.apache.cordova.firebase.FirebasePluginMessagingService"> + <intent-filter> + <action android:name="com.google.firebase.MESSAGING_EVENT"/> + </intent-filter> + </service> + <receiver android:name="org.apache.cordova.firebase.OnNotificationOpenReceiver"/> + <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/accent" /> + <meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="@string/default_notification_channel_id"/> + <meta-data android:name="firebase_analytics_collection_enabled" android:value="$FIREBASE_ANALYTICS_COLLECTION_ENABLED" /> + <meta-data android:name="firebase_performance_collection_enabled" android:value="$FIREBASE_PERFORMANCE_COLLECTION_ENABLED" /> + <meta-data android:name="firebase_crashlytics_collection_enabled" android:value="$FIREBASE_CRASHLYTICS_COLLECTION_ENABLED" /> + </config-file> + <resource-file src="src/android/cordova-plugin-firebase-strings.xml" target="res/values/cordova-plugin-firebase-strings.xml" /> + <source-file src="src/android/FirebasePlugin.java" target-dir="src/org/apache/cordova/firebase" /> + <source-file src="src/android/OnNotificationOpenReceiver.java" target-dir="src/org/apache/cordova/firebase" /> + <source-file src="src/android/FirebasePluginMessagingService.java" target-dir="src/org/apache/cordova/firebase" /> + <source-file src="src/android/FirebasePluginMessageReceiver.java" target-dir="src/org/apache/cordova/firebase" /> + <source-file src="src/android/FirebasePluginMessageReceiverManager.java" target-dir="src/org/apache/cordova/firebase" /> + <source-file src="src/android/JavaScriptException.java" target-dir="src/org/apache/cordova/firebase"/> + + <framework src="src/android/build.gradle" custom="true" type="gradleReference" /> + + <!-- Default versions for Gradle dependencies --> + <preference name="ANDROID_PLAY_SERVICES_AUTH_VERSION" default="18.0.0" /> + <preference name="ANDROID_FIREBASE_ANALYTICS_VERSION" default="17.4.3" /> + <preference name="ANDROID_FIREBASE_MESSAGING_VERSION" default="20.2.1" /> + <preference name="ANDROID_FIREBASE_CONFIG_VERSION" default="19.1.4" /> + <preference name="ANDROID_FIREBASE_PERF_VERSION" default="19.0.7" /> + <preference name="ANDROID_FIREBASE_AUTH_VERSION" default="19.3.1" /> + <preference name="ANDROID_FIREBASE_FIRESTORE_VERSION" default="21.4.3" /> + <preference name="ANDROID_FIREBASE_CRASHLYTICS_VERSION" default="17.0.1" /> + <preference name="ANDROID_FIREBASE_CRASHLYTICS_NDK_VERSION" default="17.0.1" /> + <preference name="ANDROID_GSON_VERSION" default="2.8.6" /> + + <framework src="com.google.android.gms:play-services-auth:$ANDROID_PLAY_SERVICES_AUTH_VERSION" /> + <framework src="com.google.firebase:firebase-analytics:$ANDROID_FIREBASE_ANALYTICS_VERSION" /> + <framework src="com.google.firebase:firebase-messaging:$ANDROID_FIREBASE_MESSAGING_VERSION" /> + <framework src="com.google.firebase:firebase-config:$ANDROID_FIREBASE_CONFIG_VERSION" /> + <framework src="com.google.firebase:firebase-perf:$ANDROID_FIREBASE_PERF_VERSION" /> + <framework src="com.google.firebase:firebase-auth:$ANDROID_FIREBASE_AUTH_VERSION" /> + <framework src="com.google.firebase:firebase-firestore:$ANDROID_FIREBASE_FIRESTORE_VERSION" /> + <framework src="com.google.firebase:firebase-crashlytics:$ANDROID_FIREBASE_CRASHLYTICS_VERSION" /> + <framework src="com.google.firebase:firebase-crashlytics-ndk:$ANDROID_FIREBASE_CRASHLYTICS_NDK_VERSION" /> + <framework src="com.google.code.gson:gson:$ANDROID_GSON_VERSION" /> + </platform> + + <platform name="ios"> + <hook type="before_plugin_install" src="scripts/ios/before_plugin_install.js" /> + <hook type="after_plugin_install" src="scripts/ios/after_plugin_install.js" /> + <hook type="before_plugin_uninstall" src="scripts/ios/before_plugin_uninstall.js" /> + + <js-module name="FirebasePlugin" src="www/firebase.js"> + <clobbers target="FirebasePlugin" /> + </js-module> + <config-file parent="/*" target="config.xml"> + <feature name="FirebasePlugin"> + <param name="ios-package" value="FirebasePlugin" /> + <param name="onload" value="true" /> + </feature> + </config-file> + <config-file parent="aps-environment" target="*/Entitlements-Debug.plist"> + <string>development</string> + </config-file> + <config-file parent="aps-environment" target="*/Entitlements-Release.plist"> + <string>production</string> + </config-file> + <config-file target="*-Info.plist" parent="UIBackgroundModes"> + <array> + <string>remote-notification</string> + </array> + </config-file> + + <resource-file src="src/ios/GoogleService-Info.plist" /> + + <header-file src="src/ios/AppDelegate+FirebasePlugin.h" /> + <source-file src="src/ios/AppDelegate+FirebasePlugin.m" /> + <header-file src="src/ios/FirebasePlugin.h" /> + <source-file src="src/ios/FirebasePlugin.m" /> + <header-file src="src/ios/FirebasePluginMessageReceiver.h" /> + <source-file src="src/ios/FirebasePluginMessageReceiver.m" /> + <header-file src="src/ios/FirebasePluginMessageReceiverManager.h" /> + <source-file src="src/ios/FirebasePluginMessageReceiverManager.m" /> + + <framework src="AuthenticationServices.framework" /> + + <podspec> + <config> + <source url="https://cdn.cocoapods.org/"/> + </config> + <pods use-frameworks="true"> + <pod name="Firebase/Core" spec="6.28.1"/> + <pod name="Firebase/Auth" spec="6.28.1"/> + <pod name="Firebase/Messaging" spec="6.28.1"/> + <pod name="Firebase/Performance" spec="6.28.1"/> + <pod name="Firebase/RemoteConfig" spec="6.28.1"/> + <pod name="FirebaseFirestore" git="https://github.com/invertase/firestore-ios-sdk-frameworks.git" tag="6.28.1"/> + <pod name="Firebase/Crashlytics" spec="6.28.1"/> + <pod name="GoogleSignIn" spec="5.0.2"/> + </pods> + </podspec> + + </platform> + + <hook type="after_prepare" src="scripts/after_prepare.js" /> +</plugin> diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/after_prepare.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/after_prepare.js new file mode 100644 index 00000000..b3a7ab59 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/after_prepare.js @@ -0,0 +1,164 @@ +#!/usr/bin/env node + +'use strict'; + +/** + * This hook makes sure projects using [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) + * will build properly and have the required key files copied to the proper destinations when the app is build on Ionic Cloud using the package command. + * Credits: https://github.com/arnesson. + */ +var fs = require('fs'); +var path = require("path"); +var Utilities = require("./lib/utilities"); + +var appName = Utilities.getAppName(); +var pluginVariables = {}; + +var IOS_DIR = 'platforms/ios'; +var ANDROID_DIR = 'platforms/android'; +var PLUGIN_ID = 'cordova-plugin-firebasex'; + +var PLATFORM = { + IOS: { + dest: IOS_DIR + '/' + appName + '/Resources/GoogleService-Info.plist', + src: [ + 'GoogleService-Info.plist', + IOS_DIR + '/www/GoogleService-Info.plist', + 'www/GoogleService-Info.plist' + ], + appPlist: IOS_DIR + '/' + appName + '/'+appName+'-Info.plist', + }, + ANDROID: { + dest: ANDROID_DIR + '/app/google-services.json', + src: [ + 'google-services.json', + ANDROID_DIR + '/assets/www/google-services.json', + 'www/google-services.json', + ANDROID_DIR + '/app/src/main/google-services.json' + ], + colorsXml:{ + src: './plugins/' + Utilities.getPluginId() +'/src/android/colors.xml', + target: ANDROID_DIR + '/app/src/main/res/values/colors.xml' + } + } +}; + + +var parsePluginVariables = function(){ + // Parse plugin.xml + var plugin = Utilities.parsePluginXml(); + var prefs = []; + if(plugin.plugin.preference){ + prefs = prefs.concat(plugin.plugin.preference); + } + plugin.plugin.platform.forEach(function(platform){ + if(platform.preference){ + prefs = prefs.concat(platform.preference); + } + }); + prefs.forEach(function(pref){ + pluginVariables[pref._attributes.name] = pref._attributes.default; + }); + + // Parse config.xml + var config = Utilities.parseConfigXml(); + (config.widget.plugin ? [].concat(config.widget.plugin) : []).forEach(function(plugin){ + (plugin.variable ? [].concat(plugin.variable) : []).forEach(function(variable){ + if((plugin._attributes.name === PLUGIN_ID || plugin._attributes.id === PLUGIN_ID) && variable._attributes.name && variable._attributes.value){ + pluginVariables[variable._attributes.name] = variable._attributes.value; + } + }); + }); + + // Parse package.json + var packageJSON = Utilities.parsePackageJson(); + if(packageJSON.cordova && packageJSON.cordova.plugins){ + for(const pluginId in packageJSON.cordova.plugins){ + if(pluginId === PLUGIN_ID){ + for(const varName in packageJSON.cordova.plugins[pluginId]){ + var varValue = packageJSON.cordova.plugins[pluginId][varName]; + pluginVariables[varName] = varValue; + } + } + } + } + + // set platform key path from plugin variable + if (pluginVariables.ANDROID_FIREBASE_CONFIG_FILEPATH) PLATFORM.ANDROID.src = [pluginVariables.ANDROID_FIREBASE_CONFIG_FILEPATH]; + if (pluginVariables.IOS_FIREBASE_CONFIG_FILEPATH) PLATFORM.IOS.src = [pluginVariables.IOS_FIREBASE_CONFIG_FILEPATH]; +}; + +module.exports = function (context) { + + //get platform from the context supplied by cordova + var platforms = context.opts.platforms; + parsePluginVariables(); + + // Copy key files to their platform specific folders + if (platforms.indexOf('android') !== -1 && Utilities.directoryExists(ANDROID_DIR)) { + Utilities.log('Preparing Firebase on Android'); + Utilities.copyKey(PLATFORM.ANDROID); + + if(!fs.existsSync(path.resolve(PLATFORM.ANDROID.colorsXml.target))){ + fs.copyFileSync(path.resolve(PLATFORM.ANDROID.colorsXml.src), path.resolve(PLATFORM.ANDROID.colorsXml.target)); + } + + const $colorsXml = Utilities.parseXmlFileToJson(PLATFORM.ANDROID.colorsXml.target, {compact: true}); + var accentColor = pluginVariables.ANDROID_ICON_ACCENT, + $resources = $colorsXml.resources, + existingAccent = false, + writeChanges = false; + + if($resources.color){ + var $colors = $resources.color.length ? $resources.color : [$resources.color]; + $colors.forEach(function($color){ + if($color._attributes.name === 'accent'){ + existingAccent = true; + if($color._text !== accentColor){ + $color._text = accentColor; + writeChanges = true; + } + } + }); + }else{ + $resources.color = {}; + } + + if(!existingAccent){ + var $accentColor = { + _attributes: { + name: 'accent' + }, + _text: accentColor + }; + if($resources.color && Object.keys($resources.color).length){ + if(typeof $resources.color.length === 'undefined'){ + $resources.color = [$resources.color]; + } + $resources.color.push($accentColor) + }else{ + $resources.color = $accentColor; + } + writeChanges = true; + } + + if(writeChanges){ + Utilities.writeJsonToXmlFile($colorsXml, PLATFORM.ANDROID.colorsXml.target); + Utilities.log('Updated colors.xml with accent color'); + } + } + + if (platforms.indexOf('ios') !== -1 && Utilities.directoryExists(IOS_DIR)){ + Utilities.log('Preparing Firebase on iOS'); + Utilities.copyKey(PLATFORM.IOS); + + var helper = require("./ios/helper"); + var xcodeProjectPath = helper.getXcodeProjectPath(); + helper.ensureRunpathSearchPath(context, xcodeProjectPath); + + if(pluginVariables['IOS_STRIP_DEBUG'] && pluginVariables['IOS_STRIP_DEBUG'] === 'true'){ + helper.stripDebugSymbols(); + } + helper.applyPluginVarsToPlists(PLATFORM.IOS.dest, PLATFORM.IOS.appPlist, pluginVariables); + } +}; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/after_plugin_install.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/after_plugin_install.js new file mode 100644 index 00000000..3384f75b --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/after_plugin_install.js @@ -0,0 +1,10 @@ +var helper = require("./helper"); + +module.exports = function(context) { + + // Add a build phase which runs a shell script that executes the Crashlytics + // run command line tool which uploads the debug symbols at build time. + var xcodeProjectPath = helper.getXcodeProjectPath(); + helper.removeShellScriptBuildPhase(context, xcodeProjectPath); + helper.addShellScriptBuildPhase(context, xcodeProjectPath); +}; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_install.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_install.js new file mode 100644 index 00000000..9b860005 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_install.js @@ -0,0 +1,23 @@ +var execSync = require('child_process').execSync; +var semver = require('semver'); + +var minCocoapodsVersion = "^1.9.1"; + +module.exports = function(context) { + checkCocoapodsVersion(); +}; + +function checkCocoapodsVersion(){ + var version; + try{ + version = execSync('pod --version', {encoding: 'utf8'}).match(/(\d+\.\d+\.\d+)/)[1]; + }catch(err){ + throw new Error("cocoapods not found - please install cocoapods >="+minCocoapodsVersion); + } + + if(!semver.valid(version)){ + throw new Error("cocoapods version is invalid - please reinstall cocoapods@"+minCocoapodsVersion + ": "+version); + }else if(!semver.satisfies(version, minCocoapodsVersion)){ + throw new Error("cocoapods version is out-of-date - please update to cocoapods@"+minCocoapodsVersion + " - current version: "+version); + } +}
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_uninstall.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_uninstall.js new file mode 100644 index 00000000..783512a6 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/before_plugin_uninstall.js @@ -0,0 +1,8 @@ +var helper = require("./helper"); + +module.exports = function(context) { + + // Remove the build script that was added when the plugin was installed. + var xcodeProjectPath = helper.getXcodeProjectPath(); + helper.removeShellScriptBuildPhase(context, xcodeProjectPath); +}; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/helper.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/helper.js new file mode 100644 index 00000000..be12ae06 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/ios/helper.js @@ -0,0 +1,238 @@ +var fs = require("fs"); +var path = require("path"); +var utilities = require("../lib/utilities"); +var xcode = require("xcode"); +var plist = require('plist'); + +/** + * This is used as the display text for the build phase block in XCode as well as the + * inline comments inside of the .pbxproj file for the build script phase block. + */ +var comment = "\"Crashlytics\""; + +module.exports = { + + /** + * Used to get the path to the XCode project's .pbxproj file. + */ + getXcodeProjectPath: function () { + var appName = utilities.getAppName(); + return path.join("platforms", "ios", appName + ".xcodeproj", "project.pbxproj"); + }, + + /** + * This helper is used to add a build phase to the XCode project which runs a shell + * script during the build process. The script executes Crashlytics run command line + * tool with the API and Secret keys. This tool is used to upload the debug symbols + * (dSYMs) so that Crashlytics can display stack trace information in it's web console. + */ + addShellScriptBuildPhase: function (context, xcodeProjectPath) { + + // Read and parse the XCode project (.pxbproj) from disk. + // File format information: http://www.monobjc.net/xcode-project-file-format.html + var xcodeProject = xcode.project(xcodeProjectPath); + xcodeProject.parseSync(); + + // Build the body of the script to be executed during the build phase. + var script = '"' + '\\"${PODS_ROOT}/FirebaseCrashlytics/run\\"' + '"'; + + // Generate a unique ID for our new build phase. + var id = xcodeProject.generateUuid(); + // Create the build phase. + xcodeProject.hash.project.objects.PBXShellScriptBuildPhase[id] = { + isa: "PBXShellScriptBuildPhase", + buildActionMask: 2147483647, + files: [], + inputPaths: ['"' + '$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)' + '"'], + name: comment, + outputPaths: [], + runOnlyForDeploymentPostprocessing: 0, + shellPath: "/bin/sh", + shellScript: script, + showEnvVarsInLog: 0 + }; + + // Add a comment to the block (viewable in the source of the pbxproj file). + xcodeProject.hash.project.objects.PBXShellScriptBuildPhase[id + "_comment"] = comment; + + // Add this new shell script build phase block to the targets. + for (var nativeTargetId in xcodeProject.hash.project.objects.PBXNativeTarget) { + + // Skip over the comment blocks. + if (nativeTargetId.indexOf("_comment") !== -1) { + continue; + } + + var nativeTarget = xcodeProject.hash.project.objects.PBXNativeTarget[nativeTargetId]; + + nativeTarget.buildPhases.push({ + value: id, + comment: comment + }); + } + + // Finally, write the .pbxproj back out to disk. + fs.writeFileSync(path.resolve(xcodeProjectPath), xcodeProject.writeSync()); + }, + + /** + * This helper is used to remove the build phase from the XCode project that was added + * by the addShellScriptBuildPhase() helper method. + */ + removeShellScriptBuildPhase: function (context, xcodeProjectPath) { + + // Read and parse the XCode project (.pxbproj) from disk. + // File format information: http://www.monobjc.net/xcode-project-file-format.html + var xcodeProject = xcode.project(xcodeProjectPath); + xcodeProject.parseSync(); + + // First, we want to delete the build phase block itself. + + var buildPhases = xcodeProject.hash.project.objects.PBXShellScriptBuildPhase; + + var commentTest = comment.replace(/"/g, ''); + for (var buildPhaseId in buildPhases) { + + var buildPhase = xcodeProject.hash.project.objects.PBXShellScriptBuildPhase[buildPhaseId]; + var shouldDelete = false; + + if (buildPhaseId.indexOf("_comment") === -1) { + // Dealing with a build phase block. + + // If the name of this block matches ours, then we want to delete it. + shouldDelete = buildPhase.name && buildPhase.name.indexOf(commentTest) !== -1; + } else { + // Dealing with a comment block. + + // If this is a comment block that matches ours, then we want to delete it. + shouldDelete = buildPhase === commentTest; + } + + if (shouldDelete) { + delete buildPhases[buildPhaseId]; + } + } + + // Second, we want to delete the native target reference to the block. + + var nativeTargets = xcodeProject.hash.project.objects.PBXNativeTarget; + + for (var nativeTargetId in nativeTargets) { + + // Skip over the comment blocks. + if (nativeTargetId.indexOf("_comment") !== -1) { + continue; + } + + var nativeTarget = nativeTargets[nativeTargetId]; + + // We remove the reference to the block by filtering out the the ones that match. + nativeTarget.buildPhases = nativeTarget.buildPhases.filter(function (buildPhase) { + return buildPhase.comment !== commentTest; + }); + } + + // Finally, write the .pbxproj back out to disk. + fs.writeFileSync(path.resolve(xcodeProjectPath), xcodeProject.writeSync()); + }, + + ensureRunpathSearchPath: function(context, xcodeProjectPath){ + + function addRunpathSearchBuildProperty(proj, build) { + let LD_RUNPATH_SEARCH_PATHS = proj.getBuildProperty("LD_RUNPATH_SEARCH_PATHS", build); + + if (!Array.isArray(LD_RUNPATH_SEARCH_PATHS)) { + LD_RUNPATH_SEARCH_PATHS = [LD_RUNPATH_SEARCH_PATHS]; + } + + LD_RUNPATH_SEARCH_PATHS.forEach(LD_RUNPATH_SEARCH_PATH => { + if (!LD_RUNPATH_SEARCH_PATH) { + proj.addBuildProperty("LD_RUNPATH_SEARCH_PATHS", "\"$(inherited) @executable_path/Frameworks\"", build); + } + if (LD_RUNPATH_SEARCH_PATH.indexOf("@executable_path/Frameworks") == -1) { + var newValue = LD_RUNPATH_SEARCH_PATH.substr(0, LD_RUNPATH_SEARCH_PATH.length - 1); + newValue += ' @executable_path/Frameworks\"'; + proj.updateBuildProperty("LD_RUNPATH_SEARCH_PATHS", newValue, build); + } + if (LD_RUNPATH_SEARCH_PATH.indexOf("$(inherited)") == -1) { + var newValue = LD_RUNPATH_SEARCH_PATH.substr(0, LD_RUNPATH_SEARCH_PATH.length - 1); + newValue += ' $(inherited)\"'; + proj.updateBuildProperty("LD_RUNPATH_SEARCH_PATHS", newValue, build); + } + }); + } + + // Read and parse the XCode project (.pxbproj) from disk. + // File format information: http://www.monobjc.net/xcode-project-file-format.html + var xcodeProject = xcode.project(xcodeProjectPath); + xcodeProject.parseSync(); + + // Add search paths build property + addRunpathSearchBuildProperty(xcodeProject, "Debug"); + addRunpathSearchBuildProperty(xcodeProject, "Release"); + + // Finally, write the .pbxproj back out to disk. + fs.writeFileSync(path.resolve(xcodeProjectPath), xcodeProject.writeSync()); + }, + stripDebugSymbols: function(){ + var podFilePath = 'platforms/ios/Podfile', + podFile = fs.readFileSync(path.resolve(podFilePath)).toString(); + if(!podFile.match('DEBUG_INFORMATION_FORMAT')){ + podFile += "\npost_install do |installer|\n" + + " installer.pods_project.targets.each do |target|\n" + + " target.build_configurations.each do |config|\n" + + " config.build_settings['DEBUG_INFORMATION_FORMAT'] = 'dwarf'\n" + + " end\n" + + " end\n" + + "end"; + fs.writeFileSync(path.resolve(podFilePath), podFile); + console.log('cordova-plugin-firebasex: Applied IOS_STRIP_DEBUG to Podfile'); + } + }, + applyPluginVarsToPlists: function(googlePlistPath, appPlistPath, pluginVariables){ + var googlePlist = plist.parse(fs.readFileSync(path.resolve(googlePlistPath), 'utf8')), + appPlist = plist.parse(fs.readFileSync(path.resolve(appPlistPath), 'utf8')), + googlePlistModified = false, + appPlistModified = false; + + if(typeof pluginVariables['FIREBASE_ANALYTICS_COLLECTION_ENABLED'] !== 'undefined'){ + googlePlist["FIREBASE_ANALYTICS_COLLECTION_ENABLED"] = (pluginVariables['FIREBASE_ANALYTICS_COLLECTION_ENABLED'] !== "false" ? "true" : "false") ; + googlePlistModified = true; + } + if(typeof pluginVariables['FIREBASE_PERFORMANCE_COLLECTION_ENABLED'] !== 'undefined'){ + googlePlist["FIREBASE_PERFORMANCE_COLLECTION_ENABLED"] = (pluginVariables['FIREBASE_PERFORMANCE_COLLECTION_ENABLED'] !== "false" ? "true" : "false") ; + googlePlistModified = true; + } + if(typeof pluginVariables['FIREBASE_CRASHLYTICS_COLLECTION_ENABLED'] !== 'undefined'){ + googlePlist["FirebaseCrashlyticsCollectionEnabled"] = (pluginVariables['FIREBASE_CRASHLYTICS_COLLECTION_ENABLED'] !== "false" ? "true" : "false") ; + googlePlistModified = true; + } + if(typeof pluginVariables['IOS_SHOULD_ESTABLISH_DIRECT_CHANNEL'] !== 'undefined'){ + appPlist["shouldEstablishDirectChannel"] = (pluginVariables['IOS_SHOULD_ESTABLISH_DIRECT_CHANNEL'] === "true") ; + appPlistModified = true; + } + if(pluginVariables['SETUP_RECAPTCHA_VERIFICATION'] === 'true'){ + var reversedClientId = googlePlist['REVERSED_CLIENT_ID']; + + if(!appPlist['CFBundleURLTypes']) appPlist['CFBundleURLTypes'] = []; + var entry, i; + for(i=0; i<appPlist['CFBundleURLTypes'].length; i++){ + if(typeof appPlist['CFBundleURLTypes'][i] === 'object' && appPlist['CFBundleURLTypes'][i]['CFBundleURLSchemes']){ + entry = appPlist['CFBundleURLTypes'][i]; + break; + } + } + if(!entry) entry = {}; + if(!entry['CFBundleTypeRole']) entry['CFBundleTypeRole'] = 'Editor'; + if(!entry['CFBundleURLSchemes']) entry['CFBundleURLSchemes'] = []; + if(entry['CFBundleURLSchemes'].indexOf(reversedClientId) === -1){ + entry['CFBundleURLSchemes'].push(reversedClientId) + } + appPlist['CFBundleURLTypes'][i] = entry; + appPlistModified = true; + } + + if(googlePlistModified) fs.writeFileSync(path.resolve(googlePlistPath), plist.build(googlePlist)); + if(appPlistModified) fs.writeFileSync(path.resolve(appPlistPath), plist.build(appPlist)); + } +}; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/scripts/lib/utilities.js b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/lib/utilities.js new file mode 100644 index 00000000..837ff459 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/scripts/lib/utilities.js @@ -0,0 +1,109 @@ +/** + * Utilities and shared functionality for the build hooks. + */ +var fs = require('fs'); +var path = require("path"); +var parser = require('xml-js'); + +var _configXml, _pluginXml; + +var Utilities = {}; + +fs.ensureDirSync = function(dir){ + if(!fs.existsSync(dir)){ + dir.split(path.sep).reduce(function(currentPath, folder){ + currentPath += folder + path.sep; + if(!fs.existsSync(currentPath)){ + fs.mkdirSync(currentPath); + } + return currentPath; + }, ''); + } +}; + +Utilities.parsePackageJson = function(){ + return JSON.parse(fs.readFileSync(path.resolve('./package.json'))); +}; + +Utilities.parseConfigXml = function(){ + if(_configXml) return _configXml; + _configXml = Utilities.parseXmlFileToJson("config.xml"); + return _configXml; +}; + +Utilities.parsePluginXml = function(){ + if(_pluginXml) return _pluginXml; + _pluginXml = Utilities.parseXmlFileToJson("plugins/"+Utilities.getPluginId()+"/plugin.xml"); + return _pluginXml; +}; + +Utilities.parseXmlFileToJson = function(filepath, parseOpts){ + parseOpts = parseOpts || {compact: true}; + return JSON.parse(parser.xml2json(fs.readFileSync(path.resolve(filepath), 'utf-8'), parseOpts)); +}; + +Utilities.writeJsonToXmlFile = function(jsonObj, filepath, parseOpts){ + parseOpts = parseOpts || {compact: true, spaces: 4}; + var xmlStr = parser.json2xml(JSON.stringify(jsonObj), parseOpts); + fs.writeFileSync(path.resolve(filepath), xmlStr); +}; + +/** + * Used to get the name of the application as defined in the config.xml. + */ +Utilities.getAppName = function(){ + return Utilities.parseConfigXml().widget.name._text.toString().trim(); +}; + +/** + * The ID of the plugin; this should match the ID in plugin.xml. + */ +Utilities.getPluginId = function(){ + return "cordova-plugin-firebasex"; +}; + +Utilities.copyKey = function(platform){ + for(var i = 0; i < platform.src.length; i++){ + var file = platform.src[i]; + if(this.fileExists(file)){ + try{ + var contents = fs.readFileSync(path.resolve(file)).toString(); + + try{ + var destinationPath = platform.dest; + var folder = destinationPath.substring(0, destinationPath.lastIndexOf('/')); + fs.ensureDirSync(folder); + fs.writeFileSync(path.resolve(destinationPath), contents); + }catch(e){ + // skip + } + }catch(err){ + console.log(err); + } + + break; + } + } +}; + +Utilities.fileExists = function(filePath){ + try{ + return fs.statSync(path.resolve(filePath)).isFile(); + }catch(e){ + return false; + } +}; + +Utilities.directoryExists = function(dirPath){ + try{ + return fs.statSync(path.resolve(dirPath)).isDirectory(); + }catch(e){ + return false; + } +}; + +Utilities.log = function(msg){ + console.log(Utilities.getPluginId()+': '+msg); +}; + +module.exports = Utilities; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePlugin.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePlugin.java new file mode 100644 index 00000000..d81419e9 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePlugin.java @@ -0,0 +1,2441 @@ +package org.apache.cordova.firebase; + +import android.app.Activity; +import android.app.NotificationManager; +import android.app.NotificationChannel; +import android.content.ContentResolver; +import android.content.SharedPreferences; +import android.content.pm.PackageManager; +import android.media.RingtoneManager; +import android.net.Uri; +import android.media.AudioAttributes; +import android.content.Context; +import android.content.Intent; +import android.os.Build; +import android.os.Bundle; + +import androidx.annotation.NonNull; +import androidx.core.app.NotificationCompat; +import androidx.core.app.NotificationManagerCompat; + +import android.util.Base64; +import android.util.Log; + +import com.google.firebase.crashlytics.FirebaseCrashlytics; + +import com.google.android.gms.auth.api.Auth; +import com.google.android.gms.auth.api.signin.GoogleSignIn; +import com.google.android.gms.auth.api.signin.GoogleSignInAccount; +import com.google.android.gms.auth.api.signin.GoogleSignInClient; +import com.google.android.gms.auth.api.signin.GoogleSignInOptions; +import com.google.android.gms.common.api.ApiException; +import com.google.android.gms.common.api.CommonStatusCodes; +import com.google.android.gms.common.api.GoogleApiClient; +import com.google.android.gms.tasks.OnCompleteListener; +import com.google.android.gms.tasks.OnFailureListener; +import com.google.android.gms.tasks.OnSuccessListener; +import com.google.android.gms.tasks.Task; +import com.google.firebase.FirebaseApp; +import com.google.firebase.analytics.FirebaseAnalytics; +import com.google.firebase.auth.AuthCredential; +import com.google.firebase.auth.AuthResult; +import com.google.firebase.auth.FirebaseAuth; +import com.google.firebase.auth.FirebaseUser; +import com.google.firebase.auth.GetTokenResult; +import com.google.firebase.auth.GoogleAuthProvider; +import com.google.firebase.auth.OAuthProvider; +import com.google.firebase.auth.UserProfileChangeRequest; +import com.google.firebase.firestore.CollectionReference; +import com.google.firebase.firestore.DocumentReference; +import com.google.firebase.firestore.DocumentSnapshot; +import com.google.firebase.firestore.FirebaseFirestore; +import com.google.firebase.firestore.Query; +import com.google.firebase.firestore.QueryDocumentSnapshot; +import com.google.firebase.firestore.QuerySnapshot; +import com.google.firebase.firestore.Query.Direction; +import com.google.firebase.iid.FirebaseInstanceId; +import com.google.firebase.messaging.FirebaseMessaging; +import com.google.firebase.remoteconfig.FirebaseRemoteConfig; +import com.google.firebase.remoteconfig.FirebaseRemoteConfigInfo; +import com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings; +import com.google.firebase.remoteconfig.FirebaseRemoteConfigValue; +import com.google.firebase.perf.FirebasePerformance; +import com.google.firebase.perf.metrics.Trace; + + +import org.apache.cordova.CallbackContext; +import org.apache.cordova.CordovaInterface; +import org.apache.cordova.CordovaPlugin; +import org.apache.cordova.PluginResult; +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; +import java.util.Objects; +import java.util.Random; +import java.util.Set; +import java.util.List; + +// Firebase PhoneAuth +import java.util.concurrent.TimeUnit; + +import com.google.firebase.FirebaseException; +import com.google.firebase.auth.FirebaseAuthInvalidCredentialsException; +import com.google.firebase.FirebaseTooManyRequestsException; +import com.google.firebase.auth.PhoneAuthCredential; +import com.google.firebase.auth.PhoneAuthProvider; +import com.google.gson.Gson; +import com.google.gson.reflect.TypeToken; + +import static android.content.Context.MODE_PRIVATE; + +public class FirebasePlugin extends CordovaPlugin { + + protected static FirebasePlugin instance = null; + private FirebaseAnalytics mFirebaseAnalytics; + private FirebaseCrashlytics firebaseCrashlytics; + private FirebaseFirestore firestore; + private Gson gson; + private FirebaseAuth.AuthStateListener authStateListener; + private boolean authStateChangeListenerInitialized = false; + private static CordovaInterface cordovaInterface = null; + protected static Context applicationContext = null; + private static Activity cordovaActivity = null; + + protected static final String TAG = "FirebasePlugin"; + protected static final String JS_GLOBAL_NAMESPACE = "FirebasePlugin."; + protected static final String KEY = "badge"; + protected static final int GOOGLE_SIGN_IN = 0x1; + protected static final String SETTINGS_NAME = "settings"; + private static final String CRASHLYTICS_COLLECTION_ENABLED = "firebase_crashlytics_collection_enabled"; + private static final String ANALYTICS_COLLECTION_ENABLED = "firebase_analytics_collection_enabled"; + private static final String PERFORMANCE_COLLECTION_ENABLED = "firebase_performance_collection_enabled"; + + private static boolean inBackground = true; + private static ArrayList<Bundle> notificationStack = null; + private static CallbackContext notificationCallbackContext; + private static CallbackContext tokenRefreshCallbackContext; + private static CallbackContext activityResultCallbackContext; + private static CallbackContext authResultCallbackContext; + + private static NotificationChannel defaultNotificationChannel = null; + public static String defaultChannelId = null; + public static String defaultChannelName = null; + + private Map<String, AuthCredential> authCredentials = new HashMap<String, AuthCredential>(); + private Map<String, OAuthProvider> authProviders = new HashMap<String, OAuthProvider>(); + + @Override + protected void pluginInitialize() { + instance = this; + cordovaActivity = this.cordova.getActivity(); + applicationContext = cordovaActivity.getApplicationContext(); + final Bundle extras = cordovaActivity.getIntent().getExtras(); + FirebasePlugin.cordovaInterface = this.cordova; + firebaseCrashlytics = FirebaseCrashlytics.getInstance(); + this.cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + Log.d(TAG, "Starting Firebase plugin"); + + if(getMetaDataFromManifest(CRASHLYTICS_COLLECTION_ENABLED)){ + setPreference(CRASHLYTICS_COLLECTION_ENABLED, true); + } + + if(getMetaDataFromManifest(ANALYTICS_COLLECTION_ENABLED)){ + setPreference(ANALYTICS_COLLECTION_ENABLED, true); + } + + if(getMetaDataFromManifest(PERFORMANCE_COLLECTION_ENABLED)){ + setPreference(PERFORMANCE_COLLECTION_ENABLED, true); + } + + FirebaseApp.initializeApp(applicationContext); + mFirebaseAnalytics = FirebaseAnalytics.getInstance(applicationContext); + + authStateListener = new AuthStateListener(); + FirebaseAuth.getInstance().addAuthStateListener(authStateListener); + + firestore = FirebaseFirestore.getInstance(); + gson = new Gson(); + + if (extras != null && extras.size() > 1) { + if (FirebasePlugin.notificationStack == null) { + FirebasePlugin.notificationStack = new ArrayList<Bundle>(); + } + if (extras.containsKey("google.message_id")) { + extras.putString("messageType", "notification"); + extras.putString("tap", "background"); + notificationStack.add(extras); + Log.d(TAG, "Notification message found on init: " + extras.toString()); + } + } + defaultChannelId = getStringResource("default_notification_channel_id"); + defaultChannelName = getStringResource("default_notification_channel_name"); + createDefaultChannel(); + }catch (Exception e){ + handleExceptionWithoutContext(e); + } + } + }); + } + + @Override + public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException { + try{ + if (action.equals("getId")) { + this.getId(callbackContext); + return true; + } else if (action.equals("getToken")) { + this.getToken(callbackContext); + return true; + } else if (action.equals("hasPermission")) { + this.hasPermission(callbackContext); + return true; + }else if (action.equals("subscribe")) { + this.subscribe(callbackContext, args.getString(0)); + return true; + } else if (action.equals("unsubscribe")) { + this.unsubscribe(callbackContext, args.getString(0)); + return true; + } else if (action.equals("isAutoInitEnabled")) { + isAutoInitEnabled(callbackContext); + return true; + } else if (action.equals("setAutoInitEnabled")) { + setAutoInitEnabled(callbackContext, args.getBoolean(0)); + return true; + } else if (action.equals("unregister")) { + this.unregister(callbackContext); + return true; + } else if (action.equals("onMessageReceived")) { + this.onMessageReceived(callbackContext); + return true; + } else if (action.equals("onTokenRefresh")) { + this.onTokenRefresh(callbackContext); + return true; + } else if (action.equals("logEvent")) { + this.logEvent(callbackContext, args.getString(0), args.getJSONObject(1)); + return true; + } else if (action.equals("logError")) { + this.logError(callbackContext, args); + return true; + }else if(action.equals("setCrashlyticsUserId")){ + this.setCrashlyticsUserId(callbackContext, args.getString(0)); + return true; + } else if (action.equals("setScreenName")) { + this.setScreenName(callbackContext, args.getString(0)); + return true; + } else if (action.equals("setUserId")) { + this.setUserId(callbackContext, args.getString(0)); + return true; + } else if (action.equals("setUserProperty")) { + this.setUserProperty(callbackContext, args.getString(0), args.getString(1)); + return true; + } else if (action.equals("activateFetched")) { + this.activateFetched(callbackContext); + return true; + } else if (action.equals("fetch")) { + if (args.length() > 0) { + this.fetch(callbackContext, args.getLong(0)); + } else { + this.fetch(callbackContext); + } + return true; + } else if (action.equals("getByteArray")) { + this.getByteArray(callbackContext, args.getString(0)); + return true; + } else if (action.equals("getValue")) { + this.getValue(callbackContext, args.getString(0)); + return true; + } else if (action.equals("getInfo")) { + this.getInfo(callbackContext); + return true; + } else if (action.equals("setConfigSettings")) { + this.setConfigSettings(callbackContext, args.getJSONObject(0)); + return true; + } else if (action.equals("setDefaults")) { + this.setDefaults(callbackContext, args.getJSONObject(0)); + return true; + } else if (action.equals("verifyPhoneNumber")) { + this.verifyPhoneNumber(callbackContext, args); + return true; + } else if (action.equals("authenticateUserWithGoogle")) { + this.authenticateUserWithGoogle(callbackContext, args); + return true; + } else if (action.equals("authenticateUserWithApple")) { + this.authenticateUserWithApple(callbackContext, args); + return true; + } else if (action.equals("createUserWithEmailAndPassword")) { + this.createUserWithEmailAndPassword(callbackContext, args); + return true; + } else if (action.equals("signInUserWithEmailAndPassword")) { + this.signInUserWithEmailAndPassword(callbackContext, args); + return true; + } else if (action.equals("signInUserWithCustomToken")) { + this.signInUserWithCustomToken(callbackContext, args); + return true; + } else if (action.equals("signInUserAnonymously")) { + this.signInUserAnonymously(callbackContext); + return true; + } else if (action.equals("signInWithCredential")) { + this.signInWithCredential(callbackContext, args); + return true; + } else if (action.equals("linkUserWithCredential")) { + this.linkUserWithCredential(callbackContext, args); + return true; + } else if (action.equals("reauthenticateWithCredential")) { + this.reauthenticateWithCredential(callbackContext, args); + return true; + } else if (action.equals("isUserSignedIn")) { + this.isUserSignedIn(callbackContext, args); + return true; + } else if (action.equals("signOutUser")) { + this.signOutUser(callbackContext, args); + return true; + } else if (action.equals("getCurrentUser")) { + this.getCurrentUser(callbackContext, args); + return true; + } else if (action.equals("reloadCurrentUser")) { + this.reloadCurrentUser(callbackContext, args); + return true; + } else if (action.equals("updateUserProfile")) { + this.updateUserProfile(callbackContext, args); + return true; + } else if (action.equals("updateUserEmail")) { + this.updateUserEmail(callbackContext, args); + return true; + } else if (action.equals("sendUserEmailVerification")) { + this.sendUserEmailVerification(callbackContext, args); + return true; + } else if (action.equals("updateUserPassword")) { + this.updateUserPassword(callbackContext, args); + return true; + } else if (action.equals("sendUserPasswordResetEmail")) { + this.sendUserPasswordResetEmail(callbackContext, args); + return true; + } else if (action.equals("deleteUser")) { + this.deleteUser(callbackContext, args); + return true; + } else if (action.equals("startTrace")) { + this.startTrace(callbackContext, args.getString(0)); + return true; + } else if (action.equals("incrementCounter")) { + this.incrementCounter(callbackContext, args.getString(0), args.getString(1)); + return true; + } else if (action.equals("stopTrace")) { + this.stopTrace(callbackContext, args.getString(0)); + return true; + } else if (action.equals("setAnalyticsCollectionEnabled")) { + this.setAnalyticsCollectionEnabled(callbackContext, args.getBoolean(0)); + return true; + } else if (action.equals("isAnalyticsCollectionEnabled")) { + this.isAnalyticsCollectionEnabled(callbackContext); + return true; + } else if (action.equals("setPerformanceCollectionEnabled")) { + this.setPerformanceCollectionEnabled(callbackContext, args.getBoolean(0)); + return true; + } else if (action.equals("isPerformanceCollectionEnabled")) { + this.isPerformanceCollectionEnabled(callbackContext); + return true; + } else if (action.equals("setCrashlyticsCollectionEnabled")) { + this.setCrashlyticsCollectionEnabled(callbackContext, args.getBoolean(0)); + return true; + } else if (action.equals("isCrashlyticsCollectionEnabled")) { + this.isCrashlyticsCollectionEnabled(callbackContext); + return true; + } else if (action.equals("clearAllNotifications")) { + this.clearAllNotifications(callbackContext); + return true; + } else if (action.equals("logMessage")) { + logMessage(args, callbackContext); + return true; + } else if (action.equals("sendCrash")) { + sendCrash(args, callbackContext); + return true; + } else if (action.equals("createChannel")) { + this.createChannel(callbackContext, args.getJSONObject(0)); + return true; + } else if (action.equals("deleteChannel")) { + this.deleteChannel(callbackContext, args.getString(0)); + return true; + } else if (action.equals("listChannels")) { + this.listChannels(callbackContext); + return true; + } else if (action.equals("setDefaultChannel")) { + this.setDefaultChannel(callbackContext, args.getJSONObject(0)); + return true; + } else if (action.equals("addDocumentToFirestoreCollection")) { + this.addDocumentToFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("setDocumentInFirestoreCollection")) { + this.setDocumentInFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("updateDocumentInFirestoreCollection")) { + this.updateDocumentInFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("deleteDocumentFromFirestoreCollection")) { + this.deleteDocumentFromFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("documentExistsInFirestoreCollection")) { + this.documentExistsInFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("fetchDocumentInFirestoreCollection")) { + this.fetchDocumentInFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("fetchFirestoreCollection")) { + this.fetchFirestoreCollection(args, callbackContext); + return true; + } else if (action.equals("grantPermission") + || action.equals("setBadgeNumber") + || action.equals("getBadgeNumber") + ) { + // Stubs for other platform methods + callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, true)); + return true; + }else{ + callbackContext.error("Invalid action: " + action); + return false; + } + }catch(Exception e){ + handleExceptionWithContext(e, callbackContext); + } + return false; + } + + @Override + public void onPause(boolean multitasking) { + FirebasePlugin.inBackground = true; + } + + @Override + public void onResume(boolean multitasking) { + FirebasePlugin.inBackground = false; + } + + @Override + public void onReset() { + FirebasePlugin.notificationCallbackContext = null; + FirebasePlugin.tokenRefreshCallbackContext = null; + FirebasePlugin.activityResultCallbackContext = null; + FirebasePlugin.authResultCallbackContext = null; + } + + @Override + public void onDestroy() { + FirebaseAuth.getInstance().removeAuthStateListener(authStateListener); + instance = null; + cordovaActivity = null; + cordovaInterface = null; + applicationContext = null; + super.onDestroy(); + } + + @Override + public void onActivityResult(int requestCode, int resultCode, Intent data) { + super.onActivityResult(requestCode, resultCode, data); + try { + switch (requestCode) { + case GOOGLE_SIGN_IN: + Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data); + GoogleSignInAccount acct; + try{ + acct = task.getResult(ApiException.class); + }catch (ApiException ae){ + if(ae.getStatusCode() == 10){ + throw new Exception("Unknown server client ID"); + }else{ + throw new Exception(CommonStatusCodes.getStatusCodeString(ae.getStatusCode())); + } + } + AuthCredential credential = GoogleAuthProvider.getCredential(acct.getIdToken(), null); + String id = FirebasePlugin.instance.saveAuthCredential(credential); + + JSONObject returnResults = new JSONObject(); + returnResults.put("instantVerification", true); + returnResults.put("id", id); + FirebasePlugin.activityResultCallbackContext.success(returnResults); + break; + } + } catch (Exception e) { + handleExceptionWithContext(e, FirebasePlugin.activityResultCallbackContext); + } + } + + /** + * Get a string from resources without importing the .R package + * + * @param name Resource Name + * @return Resource + */ + private String getStringResource(String name) { + return applicationContext.getString( + applicationContext.getResources().getIdentifier( + name, "string", applicationContext.getPackageName() + ) + ); + } + + private void onMessageReceived(final CallbackContext callbackContext) { + FirebasePlugin.notificationCallbackContext = callbackContext; + if (FirebasePlugin.notificationStack != null) { + for (Bundle bundle : FirebasePlugin.notificationStack) { + FirebasePlugin.sendMessage(bundle, applicationContext); + } + FirebasePlugin.notificationStack.clear(); + } + } + + private void onTokenRefresh(final CallbackContext callbackContext) { + FirebasePlugin.tokenRefreshCallbackContext = callbackContext; + + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String currentToken = FirebaseInstanceId.getInstance().getToken(); + if (currentToken != null) { + FirebasePlugin.sendToken(currentToken); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public static void sendMessage(Bundle bundle, Context context) { + if (!FirebasePlugin.hasNotificationsCallback()) { + String packageName = context.getPackageName(); + if (FirebasePlugin.notificationStack == null) { + FirebasePlugin.notificationStack = new ArrayList<Bundle>(); + } + notificationStack.add(bundle); + + return; + } + + final CallbackContext callbackContext = FirebasePlugin.notificationCallbackContext; + if(bundle != null){ + // Pass the message bundle to the receiver manager so any registered receivers can decide to handle it + boolean wasHandled = FirebasePluginMessageReceiverManager.sendMessage(bundle); + if (wasHandled) { + Log.d(TAG, "Message bundle was handled by a registered receiver"); + }else if (callbackContext != null) { + JSONObject json = new JSONObject(); + Set<String> keys = bundle.keySet(); + for (String key : keys) { + try { + json.put(key, bundle.get(key)); + } catch (JSONException e) { + handleExceptionWithContext(e, callbackContext); + return; + } + } + + PluginResult pluginresult = new PluginResult(PluginResult.Status.OK, json); + pluginresult.setKeepCallback(true); + callbackContext.sendPluginResult(pluginresult); + } + } + } + + public static void sendToken(String token) { + if (FirebasePlugin.tokenRefreshCallbackContext == null) { + return; + } + + final CallbackContext callbackContext = FirebasePlugin.tokenRefreshCallbackContext; + if (callbackContext != null && token != null) { + PluginResult pluginresult = new PluginResult(PluginResult.Status.OK, token); + pluginresult.setKeepCallback(true); + callbackContext.sendPluginResult(pluginresult); + } + } + + public static boolean inBackground() { + return FirebasePlugin.inBackground; + } + + public static boolean hasNotificationsCallback() { + return FirebasePlugin.notificationCallbackContext != null; + } + + @Override + public void onNewIntent(Intent intent) { + try { + super.onNewIntent(intent); + final Bundle data = intent.getExtras(); + if (data != null && data.containsKey("google.message_id")) { + data.putString("messageType", "notification"); + data.putString("tap", "background"); + Log.d(TAG, "Notification message on new intent: " + data.toString()); + FirebasePlugin.sendMessage(data, applicationContext); + } + }catch (Exception e){ + handleExceptionWithoutContext(e); + } + } + + + private void getId(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String id = FirebaseInstanceId.getInstance().getId(); + callbackContext.success(id); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void getToken(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String token = FirebaseInstanceId.getInstance().getToken(); + callbackContext.success(token); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void hasPermission(final CallbackContext callbackContext) { + if(cordovaActivity == null) return; + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + NotificationManagerCompat notificationManagerCompat = NotificationManagerCompat.from(cordovaActivity); + boolean areNotificationsEnabled = notificationManagerCompat.areNotificationsEnabled(); + callbackContext.success(areNotificationsEnabled ? 1 : 0); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void subscribe(final CallbackContext callbackContext, final String topic) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + handleTaskOutcome(FirebaseMessaging.getInstance().subscribeToTopic(topic), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void unsubscribe(final CallbackContext callbackContext, final String topic) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + handleTaskOutcome(FirebaseMessaging.getInstance().unsubscribeFromTopic(topic), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void unregister(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseInstanceId.getInstance().deleteInstanceId(); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void isAutoInitEnabled(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + boolean isEnabled = FirebaseMessaging.getInstance().isAutoInitEnabled(); + callbackContext.success(isEnabled ? 1 : 0); + } catch (Exception e) { + logExceptionToCrashlytics(e); + callbackContext.error(e.getMessage()); + } + } + }); + } + + private void setAutoInitEnabled(final CallbackContext callbackContext, final boolean enabled) { + final FirebasePlugin self = this; + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseMessaging.getInstance().setAutoInitEnabled(enabled); + callbackContext.success(); + } catch (Exception e) { + logExceptionToCrashlytics(e); + e.printStackTrace(); + callbackContext.error(e.getMessage()); + } + } + }); + } + + private void logEvent(final CallbackContext callbackContext, final String name, final JSONObject params) + throws JSONException { + final Bundle bundle = new Bundle(); + Iterator iter = params.keys(); + while (iter.hasNext()) { + String key = (String) iter.next(); + Object value = params.get(key); + + if (value instanceof Integer || value instanceof Double) { + bundle.putFloat(key, ((Number) value).floatValue()); + } else { + bundle.putString(key, value.toString()); + } + } + + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + mFirebaseAnalytics.logEvent(name, bundle); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void logError(final CallbackContext callbackContext, final JSONArray args) throws JSONException { + final String message = args.getString(0); + + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + if(isCrashlyticsEnabled()) { + // We can optionally be passed a stack trace generated by stacktrace.js. + if (args.length() == 2) { + JSONArray stackTrace = args.getJSONArray(1); + StackTraceElement[] trace = new StackTraceElement[stackTrace.length()]; + for (int i = 0; i < stackTrace.length(); i++) { + JSONObject elem = stackTrace.getJSONObject(i); + trace[i] = new StackTraceElement( + "", + elem.optString("functionName", "(anonymous function)"), + elem.optString("fileName", "(unknown file)"), + elem.optInt("lineNumber", -1) + ); + } + + Exception e = new JavaScriptException(message); + e.setStackTrace(trace); + logExceptionToCrashlytics(e); + } else { + logExceptionToCrashlytics(new JavaScriptException(message)); + } + + Log.e(TAG, message); + callbackContext.success(1); + }else{ + callbackContext.error("Cannot log error - Crashlytics collection is disabled"); + } + } catch (Exception e) { + logExceptionToCrashlytics(e); + callbackContext.error(e.getMessage()); + } + } + }); + } + + private void logMessage(final JSONArray data, + final CallbackContext callbackContext) { + + if(isCrashlyticsEnabled()){ + String message = data.optString(0); + logMessageToCrashlytics(message); + callbackContext.success(); + }else{ + callbackContext.error("Cannot log message - Crashlytics collection is disabled"); + } + } + + private void sendCrash(final JSONArray data, + final CallbackContext callbackContext) { + + cordovaActivity.runOnUiThread(new Runnable() { + @Override + public void run() { + throw new RuntimeException("This is a crash"); + } + }); + } + + + private void setCrashlyticsUserId(final CallbackContext callbackContext, final String userId) { + cordovaActivity.runOnUiThread(new Runnable() { + public void run() { + try { + if(isCrashlyticsEnabled()){ + firebaseCrashlytics.setUserId(userId); + callbackContext.success(); + }else{ + callbackContext.error("Cannot set Crashlytics user ID - Crashlytics collection is disabled"); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setScreenName(final CallbackContext callbackContext, final String name) { + // This must be called on the main thread + cordovaActivity.runOnUiThread(new Runnable() { + public void run() { + try { + mFirebaseAnalytics.setCurrentScreen(cordovaActivity, name, null); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setUserId(final CallbackContext callbackContext, final String id) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + mFirebaseAnalytics.setUserId(id); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setUserProperty(final CallbackContext callbackContext, final String name, final String value) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + mFirebaseAnalytics.setUserProperty(name, value); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void activateFetched(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + final boolean activated = FirebaseRemoteConfig.getInstance().activateFetched(); + callbackContext.success(String.valueOf(activated)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void fetch(CallbackContext callbackContext) { + fetch(callbackContext, FirebaseRemoteConfig.getInstance().fetch()); + } + + private void fetch(CallbackContext callbackContext, long cacheExpirationSeconds) { + fetch(callbackContext, FirebaseRemoteConfig.getInstance().fetch(cacheExpirationSeconds)); + } + + private void fetch(final CallbackContext callbackContext, final Task<Void> task) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + handleTaskOutcome(task, callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void getByteArray(final CallbackContext callbackContext, final String key) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + byte[] bytes = FirebaseRemoteConfig.getInstance().getByteArray(key); + JSONObject object = new JSONObject(); + object.put("base64", Base64.encodeToString(bytes, Base64.DEFAULT)); + object.put("array", new JSONArray(bytes)); + callbackContext.success(object); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void getValue(final CallbackContext callbackContext, final String key) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseRemoteConfigValue value = FirebaseRemoteConfig.getInstance().getValue(key); + callbackContext.success(value.asString()); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void getInfo(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseRemoteConfigInfo remoteConfigInfo = FirebaseRemoteConfig.getInstance().getInfo(); + JSONObject info = new JSONObject(); + + JSONObject settings = new JSONObject(); + settings.put("developerModeEnabled", remoteConfigInfo.getConfigSettings().isDeveloperModeEnabled()); + info.put("configSettings", settings); + + info.put("fetchTimeMillis", remoteConfigInfo.getFetchTimeMillis()); + info.put("lastFetchStatus", remoteConfigInfo.getLastFetchStatus()); + + callbackContext.success(info); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setConfigSettings(final CallbackContext callbackContext, final JSONObject config) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + boolean devMode = config.getBoolean("developerModeEnabled"); + FirebaseRemoteConfigSettings.Builder settings = new FirebaseRemoteConfigSettings.Builder() + .setDeveloperModeEnabled(devMode); + FirebaseRemoteConfig.getInstance().setConfigSettings(settings.build()); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setDefaults(final CallbackContext callbackContext, final JSONObject defaults) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseRemoteConfig.getInstance().setDefaults(defaultsToMap(defaults)); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private static Map<String, Object> defaultsToMap(JSONObject object) throws JSONException { + final Map<String, Object> map = new HashMap<String, Object>(); + + for (Iterator<String> keys = object.keys(); keys.hasNext(); ) { + String key = keys.next(); + Object value = object.get(key); + + if (value instanceof Integer) { + //setDefaults() should take Longs + value = new Long((Integer) value); + } else if (value instanceof JSONArray) { + JSONArray array = (JSONArray) value; + if (array.length() == 1 && array.get(0) instanceof String) { + //parse byte[] as Base64 String + value = Base64.decode(array.getString(0), Base64.DEFAULT); + } else { + //parse byte[] as numeric array + byte[] bytes = new byte[array.length()]; + for (int i = 0; i < array.length(); i++) + bytes[i] = (byte) array.getInt(i); + value = bytes; + } + } + + map.put(key, value); + } + return map; + } + + + public void isUserSignedIn(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + boolean isSignedIn = FirebaseAuth.getInstance().getCurrentUser() != null; + callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, isSignedIn)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void signOutUser(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + // Sign out of Firebase + FirebaseAuth.getInstance().signOut(); + + // Try to sign out of Google + try{ + GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN).build(); + GoogleSignInClient mGoogleSignInClient = GoogleSignIn.getClient(cordovaActivity, gso); + handleTaskOutcome(mGoogleSignInClient.signOut(), callbackContext); + }catch(Exception googleSignOutException){ + callbackContext.success(); + } + + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void getCurrentUser(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + extractAndReturnUserInfo(callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void reloadCurrentUser(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + user.reload() + .addOnSuccessListener(new OnSuccessListener<Void>() { + @Override + public void onSuccess(Void aVoid) { + try { + extractAndReturnUserInfo(callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void extractAndReturnUserInfo(final CallbackContext callbackContext) throws Exception{ + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + JSONObject returnResults = new JSONObject(); + returnResults.put("name", user.getDisplayName()); + returnResults.put("email", user.getEmail()); + returnResults.put("emailIsVerified", user.isEmailVerified()); + returnResults.put("phoneNumber", user.getPhoneNumber()); + returnResults.put("photoUrl", user.getPhotoUrl() == null ? null : user.getPhotoUrl().toString()); + returnResults.put("uid", user.getUid()); + returnResults.put("providerId", user.getIdToken(false).getResult().getSignInProvider()); + returnResults.put("isAnonymous", user.isAnonymous()); + + user.getIdToken(true).addOnSuccessListener(new OnSuccessListener<GetTokenResult>() { + @Override + public void onSuccess(GetTokenResult result) { + try { + String idToken = result.getToken(); + returnResults.put("idToken", idToken); + callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, returnResults)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void updateUserProfile(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + + JSONObject profile = args.getJSONObject(0); + UserProfileChangeRequest profileUpdates; + if(profile.has("name") && profile.has("photoUri")){ + profileUpdates = new UserProfileChangeRequest.Builder() + .setDisplayName(profile.getString("name")) + .setPhotoUri(Uri.parse(profile.getString("photoUri"))) + .build(); + }else if(profile.has("name")){ + profileUpdates = new UserProfileChangeRequest.Builder() + .setDisplayName(profile.getString("name")) + .build(); + }else if(profile.has("photoUri")){ + profileUpdates = new UserProfileChangeRequest.Builder() + .setPhotoUri(Uri.parse(profile.getString("photoUri"))) + .build(); + }else{ + callbackContext.error("'name' and/or 'photoUri' keys must be specified in the profile object"); + return; + } + + handleTaskOutcome(user.updateProfile(profileUpdates), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void updateUserEmail(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + + String email = args.getString(0); + handleTaskOutcome(user.updateEmail(email), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void sendUserEmailVerification(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + + handleTaskOutcome(user.sendEmailVerification(), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void updateUserPassword(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + + String password = args.getString(0); + handleTaskOutcome(user.updatePassword(password), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void sendUserPasswordResetEmail(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseAuth auth = FirebaseAuth.getInstance(); + String email = args.getString(0); + handleTaskOutcome(auth.sendPasswordResetEmail(email), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void deleteUser(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + handleTaskOutcome(user.delete(), callbackContext); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void reauthenticateWithCredential(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); + if(user == null){ + callbackContext.error("No user is currently signed"); + return; + } + + JSONObject jsonCredential = args.getJSONObject(0); + if(!FirebasePlugin.instance.isValidJsonCredential(jsonCredential)){ + callbackContext.error("No auth credentials specified"); + return; + } + + AuthCredential authCredential = FirebasePlugin.instance.obtainAuthCredential(jsonCredential); + if(authCredential != null){ + handleTaskOutcome(user.reauthenticate(authCredential), callbackContext); + return; + } + + OAuthProvider authProvider = FirebasePlugin.instance.obtainAuthProvider(jsonCredential); + if(authProvider != null){ + FirebasePlugin.instance.authResultCallbackContext = callbackContext; + user.startActivityForReauthenticateWithProvider(FirebasePlugin.cordovaActivity, authProvider) + .addOnSuccessListener(new AuthResultOnSuccessListener()) + .addOnFailureListener(new AuthResultOnFailureListener()); + return; + } + + //ELSE + callbackContext.error("Specified native auth credential id does not exist"); + + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + + + public void signInWithCredential(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + JSONObject jsonCredential = args.getJSONObject(0); + if(!FirebasePlugin.instance.isValidJsonCredential(jsonCredential)){ + callbackContext.error("No auth credentials specified"); + return; + } + + AuthCredential authCredential = FirebasePlugin.instance.obtainAuthCredential(jsonCredential); + if(authCredential != null){ + FirebaseAuth.getInstance().signInWithCredential(authCredential).addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + return; + } + + OAuthProvider authProvider = FirebasePlugin.instance.obtainAuthProvider(jsonCredential); + if(authProvider != null){ + FirebasePlugin.instance.authResultCallbackContext = callbackContext; + FirebaseAuth.getInstance().startActivityForSignInWithProvider(FirebasePlugin.cordovaActivity, authProvider) + .addOnSuccessListener(new AuthResultOnSuccessListener()) + .addOnFailureListener(new AuthResultOnFailureListener()); + return; + } + + //ELSE + callbackContext.error("Specified native auth credential id does not exist"); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void linkUserWithCredential(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + JSONObject jsonCredential = args.getJSONObject(0); + if(!FirebasePlugin.instance.isValidJsonCredential(jsonCredential)){ + callbackContext.error("No auth credentials specified"); + return; + } + + AuthCredential authCredential = FirebasePlugin.instance.obtainAuthCredential(jsonCredential); + if(authCredential != null){ + FirebaseAuth.getInstance().getCurrentUser().linkWithCredential(authCredential).addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + return; + } + + //ELSE + callbackContext.error("Specified native auth credential id does not exist"); + + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private boolean isValidJsonCredential(JSONObject jsonCredential) throws JSONException{ + return jsonCredential.has("id") || (jsonCredential.has("verificationId") && jsonCredential.has("code")); + } + + private PhoneAuthProvider.OnVerificationStateChangedCallbacks mCallbacks; + + public void verifyPhoneNumber( + final CallbackContext callbackContext, + final JSONArray args + ) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + mCallbacks = new PhoneAuthProvider.OnVerificationStateChangedCallbacks() { + @Override + public void onVerificationCompleted(PhoneAuthCredential credential) { + // This callback will be invoked in two situations: + // 1 - Instant verification. In some cases the phone number can be instantly + // verified without needing to send or enter a verification code. + // 2 - Auto-retrieval. On some devices Google Play services can automatically + // detect the incoming verification SMS and perform verificaiton without + // user action. + Log.d(TAG, "success: verifyPhoneNumber.onVerificationCompleted"); + + String id = FirebasePlugin.instance.saveAuthCredential((AuthCredential) credential); + + JSONObject returnResults = new JSONObject(); + try { + returnResults.put("instantVerification", true); + returnResults.put("id", id); + } catch(JSONException e){ + handleExceptionWithContext(e, callbackContext); + return; + } + PluginResult pluginresult = new PluginResult(PluginResult.Status.OK, returnResults); + pluginresult.setKeepCallback(true); + callbackContext.sendPluginResult(pluginresult); + } + + @Override + public void onVerificationFailed(FirebaseException e) { + // This callback is invoked in an invalid request for verification is made, + // for instance if the the phone number format is not valid. + Log.w(TAG, "failed: verifyPhoneNumber.onVerificationFailed ", e); + + String errorMsg; + if (e instanceof FirebaseAuthInvalidCredentialsException) { + // Invalid request + errorMsg = "Invalid phone number"; + } else if (e instanceof FirebaseTooManyRequestsException) { + // The SMS quota for the project has been exceeded + errorMsg = "The SMS quota for the project has been exceeded"; + }else{ + errorMsg = e.getMessage(); + } + callbackContext.error(errorMsg); + } + + @Override + public void onCodeSent(String verificationId, PhoneAuthProvider.ForceResendingToken token) { + // The SMS verification code has been sent to the provided phone number, we + // now need to ask the user to enter the code and then construct a credential + // by combining the code with a verification ID [(in app)]. + Log.d(TAG, "success: verifyPhoneNumber.onCodeSent"); + + JSONObject returnResults = new JSONObject(); + try { + returnResults.put("verificationId", verificationId); + returnResults.put("instantVerification", false); + } catch (JSONException e) { + handleExceptionWithContext(e, callbackContext); + return; + } + PluginResult pluginresult = new PluginResult(PluginResult.Status.OK, returnResults); + pluginresult.setKeepCallback(true); + callbackContext.sendPluginResult(pluginresult); + } + }; + + String number = args.getString(0); + int timeOutDuration = args.getInt(1); + String smsCode = args.getString(2); + + if(smsCode != null && smsCode != "null"){ + FirebaseAuth.getInstance().getFirebaseAuthSettings().setAutoRetrievedSmsCodeForPhoneNumber(number, smsCode); + } + + PhoneAuthProvider.getInstance().verifyPhoneNumber(number, // Phone number to verify + timeOutDuration, // Timeout duration + TimeUnit.SECONDS, // Unit of timeout + cordovaActivity, // Activity (for callback binding) + mCallbacks); // OnVerificationStateChangedCallbacks + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void createUserWithEmailAndPassword(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String email = args.getString(0); + String password = args.getString(1); + + if(email == null || email.equals("")){ + callbackContext.error("User email address must be specified"); + return; + } + + if(password == null || password.equals("")){ + callbackContext.error("User password must be specified"); + return; + } + + FirebaseAuth.getInstance().createUserWithEmailAndPassword(email, password).addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void signInUserWithEmailAndPassword(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String email = args.getString(0); + String password = args.getString(1); + + if(email == null || email.equals("")){ + callbackContext.error("User email address must be specified"); + return; + } + + if(password == null || password.equals("")){ + callbackContext.error("User password must be specified"); + return; + } + + FirebaseAuth.getInstance().signInWithEmailAndPassword(email, password).addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + + public void authenticateUserWithGoogle(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String clientId = args.getString(0); + + GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) + .requestIdToken(clientId) + .requestEmail() + .build(); + + GoogleSignInClient mGoogleSignInClient = GoogleSignIn.getClient(FirebasePlugin.instance.cordovaActivity, gso); + Intent signInIntent = mGoogleSignInClient.getSignInIntent(); + FirebasePlugin.activityResultCallbackContext = callbackContext; + FirebasePlugin.instance.cordovaInterface.startActivityForResult(FirebasePlugin.instance, signInIntent, GOOGLE_SIGN_IN); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void authenticateUserWithApple(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String locale = args.getString(0); + OAuthProvider.Builder provider = OAuthProvider.newBuilder("apple.com"); + if(locale != null){ + provider.addCustomParameter("locale", locale); + } + Task<AuthResult> pending = FirebaseAuth.getInstance().getPendingAuthResult(); + if (pending != null) { + callbackContext.error("Auth result is already pending"); + pending + .addOnSuccessListener(new AuthResultOnSuccessListener()) + .addOnFailureListener(new AuthResultOnFailureListener()); + } else { + String id = FirebasePlugin.instance.saveAuthProvider(provider.build());; + JSONObject returnResults = new JSONObject(); + returnResults.put("instantVerification", true); + returnResults.put("id", id); + callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, returnResults)); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void signInUserWithCustomToken(final CallbackContext callbackContext, final JSONArray args){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String customToken = args.getString(0); + + if(customToken == null || customToken.equals("")){ + callbackContext.error("Custom token must be specified"); + return; + } + + FirebaseAuth.getInstance().signInWithCustomToken(customToken).addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void signInUserAnonymously(final CallbackContext callbackContext){ + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebaseAuth.getInstance().signInAnonymously().addOnCompleteListener(cordova.getActivity(), new AuthResultOnCompleteListener(callbackContext)); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + // + // Firebase Performace + // + + private HashMap<String, Trace> traces = new HashMap<String, Trace>(); + + private void startTrace(final CallbackContext callbackContext, final String name) { + final FirebasePlugin self = this; + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + + Trace myTrace = null; + if (self.traces.containsKey(name)) { + myTrace = self.traces.get(name); + } + + if (myTrace == null) { + myTrace = FirebasePerformance.getInstance().newTrace(name); + myTrace.start(); + self.traces.put(name, myTrace); + } + + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void incrementCounter(final CallbackContext callbackContext, final String name, final String counterNamed) { + final FirebasePlugin self = this; + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + + Trace myTrace = null; + if (self.traces.containsKey(name)) { + myTrace = self.traces.get(name); + } + + if (myTrace != null && myTrace instanceof Trace) { + myTrace.incrementMetric(counterNamed, 1); + callbackContext.success(); + } else { + callbackContext.error("Trace not found"); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void stopTrace(final CallbackContext callbackContext, final String name) { + final FirebasePlugin self = this; + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + + Trace myTrace = null; + if (self.traces.containsKey(name)) { + myTrace = self.traces.get(name); + } + + if (myTrace != null && myTrace instanceof Trace) { // + myTrace.stop(); + self.traces.remove(name); + callbackContext.success(); + } else { + callbackContext.error("Trace not found"); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void setAnalyticsCollectionEnabled(final CallbackContext callbackContext, final boolean enabled) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + mFirebaseAnalytics.setAnalyticsCollectionEnabled(enabled); + setPreference(ANALYTICS_COLLECTION_ENABLED, enabled); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void isAnalyticsCollectionEnabled(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + callbackContext.success(getPreference(ANALYTICS_COLLECTION_ENABLED) ? 1 : 0); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void setPerformanceCollectionEnabled(final CallbackContext callbackContext, final boolean enabled) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + FirebasePerformance.getInstance().setPerformanceCollectionEnabled(enabled); + setPreference(PERFORMANCE_COLLECTION_ENABLED, enabled); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void isPerformanceCollectionEnabled(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + callbackContext.success(getPreference(PERFORMANCE_COLLECTION_ENABLED) ? 1 : 0); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void setCrashlyticsCollectionEnabled(final CallbackContext callbackContext, final boolean enabled) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + firebaseCrashlytics.setCrashlyticsCollectionEnabled(enabled); + setPreference(CRASHLYTICS_COLLECTION_ENABLED, enabled); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private void isCrashlyticsCollectionEnabled(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + callbackContext.success(isCrashlyticsEnabled() ? 1 : 0); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + e.printStackTrace(); + } + } + }); + } + + private boolean isCrashlyticsEnabled(){ + return getPreference(CRASHLYTICS_COLLECTION_ENABLED); + } + + public void clearAllNotifications(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + NotificationManager nm = (NotificationManager) applicationContext.getSystemService(Context.NOTIFICATION_SERVICE); + nm.cancelAll(); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void createChannel(final CallbackContext callbackContext, final JSONObject options) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + createChannel(options); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + protected static NotificationChannel createChannel(final JSONObject options) throws JSONException { + NotificationChannel channel = null; + // only call on Android O and above + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { + String id = options.getString("id"); + Log.i(TAG, "Creating channel id="+id); + + if(channelExists(id)){ + deleteChannel(id); + } + + NotificationManager nm = (NotificationManager) applicationContext.getSystemService(Context.NOTIFICATION_SERVICE); + String packageName = cordovaActivity.getPackageName(); + + String name = options.optString("name", ""); + Log.d(TAG, "Channel "+id+" - name="+name); + + int importance = options.optInt("importance", NotificationManager.IMPORTANCE_HIGH); + Log.d(TAG, "Channel "+id+" - importance="+importance); + + channel = new NotificationChannel(id, + name, + importance); + + // Description + String description = options.optString("description", ""); + Log.d(TAG, "Channel "+id+" - description="+description); + channel.setDescription(description); + + // Light + boolean light = options.optBoolean("light", true); + Log.d(TAG, "Channel "+id+" - light="+light); + channel.enableLights(light); + + int lightColor = options.optInt("lightColor", -1); + if (lightColor != -1) { + Log.d(TAG, "Channel "+id+" - lightColor="+lightColor); + channel.setLightColor(lightColor); + } + + // Visibility + int visibility = options.optInt("visibility", NotificationCompat.VISIBILITY_PUBLIC); + Log.d(TAG, "Channel "+id+" - visibility="+visibility); + channel.setLockscreenVisibility(visibility); + + // Badge + boolean badge = options.optBoolean("badge", true); + Log.d(TAG, "Channel "+id+" - badge="+badge); + channel.setShowBadge(badge); + + // Sound + String sound = options.optString("sound", "default"); + AudioAttributes audioAttributes = new AudioAttributes.Builder() + .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION) + .setUsage(AudioAttributes.USAGE_NOTIFICATION_RINGTONE).build(); + if ("ringtone".equals(sound)) { + channel.setSound(RingtoneManager.getDefaultUri(RingtoneManager.TYPE_RINGTONE), audioAttributes); + Log.d(TAG, "Channel "+id+" - sound=ringtone"); + } else if (sound != null && !sound.contentEquals("default")) { + Uri soundUri = Uri.parse(ContentResolver.SCHEME_ANDROID_RESOURCE + "://" + packageName + "/raw/" + sound); + channel.setSound(soundUri, audioAttributes); + Log.d(TAG, "Channel "+id+" - sound="+sound); + } else if (sound != "false"){ + channel.setSound(RingtoneManager.getDefaultUri(RingtoneManager.TYPE_NOTIFICATION), audioAttributes); + Log.d(TAG, "Channel "+id+" - sound=default"); + }else{ + Log.d(TAG, "Channel "+id+" - sound=none"); + } + + // Vibration: if vibration setting is an array set vibration pattern, else set enable vibration. + JSONArray pattern = options.optJSONArray("vibration"); + if (pattern != null) { + int patternLength = pattern.length(); + long[] patternArray = new long[patternLength]; + for (int i = 0; i < patternLength; i++) { + patternArray[i] = pattern.optLong(i); + } + channel.enableVibration(true); + channel.setVibrationPattern(patternArray); + Log.d(TAG, "Channel "+id+" - vibrate="+pattern); + } else { + boolean vibrate = options.optBoolean("vibration", true); + channel.enableVibration(vibrate); + Log.d(TAG, "Channel "+id+" - vibrate="+vibrate); + } + + // Create channel + nm.createNotificationChannel(channel); + } + return channel; + } + + protected static void createDefaultChannel() throws JSONException { + JSONObject options = new JSONObject(); + options.put("id", defaultChannelId); + options.put("name", defaultChannelName); + createDefaultChannel(options); + } + + protected static void createDefaultChannel(final JSONObject options) throws JSONException { + defaultNotificationChannel = createChannel(options); + } + + public void setDefaultChannel(final CallbackContext callbackContext, final JSONObject options) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + deleteChannel(defaultChannelId); + + String id = options.optString("id", null); + if(id != null){ + defaultChannelId = id; + } + + String name = options.optString("name", null); + if(name != null){ + defaultChannelName = name; + } + createDefaultChannel(options); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public void deleteChannel(final CallbackContext callbackContext, final String channelID) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + deleteChannel(channelID); + callbackContext.success(); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + protected static void deleteChannel(final String channelID){ + // only call on Android O and above + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { + NotificationManager nm = (NotificationManager) applicationContext.getSystemService(Context.NOTIFICATION_SERVICE); + nm.deleteNotificationChannel(channelID); + } + } + + public void listChannels(final CallbackContext callbackContext) { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + List<NotificationChannel> notificationChannels = listChannels(); + JSONArray channels = new JSONArray(); + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { + for (NotificationChannel notificationChannel : notificationChannels) { + JSONObject channel = new JSONObject(); + channel.put("id", notificationChannel.getId()); + channel.put("name", notificationChannel.getName()); + channels.put(channel); + } + } + callbackContext.success(channels); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + public static List<NotificationChannel> listChannels(){ + List<NotificationChannel> notificationChannels = null; + // only call on Android O and above + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { + NotificationManager nm = (NotificationManager) applicationContext.getSystemService(Context.NOTIFICATION_SERVICE); + notificationChannels = nm.getNotificationChannels(); + } + return notificationChannels; + } + + public static boolean channelExists(String channelId){ + boolean exists = false; + if(Build.VERSION.SDK_INT >= Build.VERSION_CODES.O){ + List<NotificationChannel> notificationChannels = FirebasePlugin.listChannels(); + if(notificationChannels != null){ + for (NotificationChannel notificationChannel : notificationChannels) { + if(notificationChannel.getId().equals(channelId)){ + exists = true; + } + } + } + } + return exists; + } + + // + // Firestore + // + private void addDocumentToFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String jsonDoc = args.getString(0); + String collection = args.getString(1); + + firestore.collection(collection) + .add(jsonStringToMap(jsonDoc)) + .addOnSuccessListener(new OnSuccessListener<DocumentReference>() { + @Override + public void onSuccess(DocumentReference documentReference) { + callbackContext.success(documentReference.getId()); + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void setDocumentInFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String documentId = args.getString(0); + String jsonDoc = args.getString(1); + String collection = args.getString(2); + + firestore.collection(collection).document(documentId) + .set(jsonStringToMap(jsonDoc)) + .addOnSuccessListener(new OnSuccessListener<Void>() { + @Override + public void onSuccess(Void aVoid) { + callbackContext.success(); + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void updateDocumentInFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String documentId = args.getString(0); + String jsonDoc = args.getString(1); + String collection = args.getString(2); + + firestore.collection(collection).document(documentId) + .update(jsonStringToMap(jsonDoc)) + .addOnSuccessListener(new OnSuccessListener<Void>() { + @Override + public void onSuccess(Void aVoid) { + callbackContext.success(); + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void deleteDocumentFromFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String documentId = args.getString(0); + String collection = args.getString(1); + + firestore.collection(collection).document(documentId) + .delete() + .addOnSuccessListener(new OnSuccessListener<Void>() { + @Override + public void onSuccess(Void aVoid) { + callbackContext.success(); + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void documentExistsInFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String documentId = args.getString(0); + String collection = args.getString(1); + + firestore.collection(collection).document(documentId) + .get() + .addOnCompleteListener(new OnCompleteListener<DocumentSnapshot>() { + @Override + public void onComplete(@NonNull Task<DocumentSnapshot> task) { + try { + if (task.isSuccessful()) { + DocumentSnapshot document = task.getResult(); + callbackContext.success(document != null && document.getData() != null ? 1 : 0); + } else { + Exception e = task.getException(); + if(e != null){ + handleExceptionWithContext(e, callbackContext); + } + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void fetchDocumentInFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String documentId = args.getString(0); + String collection = args.getString(1); + + firestore.collection(collection).document(documentId) + .get() + .addOnCompleteListener(new OnCompleteListener<DocumentSnapshot>() { + @Override + public void onComplete(@NonNull Task<DocumentSnapshot> task) { + try { + if (task.isSuccessful()) { + DocumentSnapshot document = task.getResult(); + if (document != null && document.getData() != null) { + JSONObject jsonDoc = mapToJsonObject(document.getData()); + callbackContext.success(jsonDoc); + } else { + callbackContext.error("No document found in collection"); + } + } else { + Exception e = task.getException(); + if(e != null){ + handleExceptionWithContext(e, callbackContext); + } + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }) + .addOnFailureListener(new OnFailureListener() { + @Override + public void onFailure(@NonNull Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + private void fetchFirestoreCollection(JSONArray args, CallbackContext callbackContext) throws JSONException { + cordova.getThreadPool().execute(new Runnable() { + public void run() { + try { + String collection = args.getString(0); + JSONArray filters = args.getJSONArray(1); + Query query = firestore.collection(collection); + + for(int i = 0; i < filters.length(); i++) { + JSONArray filter = filters.getJSONArray(i); + switch(filter.getString(0)) { + case "where": + if (Objects.equals(filter.getString(2), new String("=="))) { + query = query.whereEqualTo(filter.getString(1), filter.getString(3)); + } + if (Objects.equals(filter.getString(2), new String("<"))) { + query = query.whereLessThan(filter.getString(1), filter.getString(3)); + } + if (Objects.equals(filter.getString(2), new String(">"))) { + query = query.whereGreaterThan(filter.getString(1), filter.getString(3)); + } + if (Objects.equals(filter.getString(2), new String("<="))) { + query = query.whereLessThanOrEqualTo(filter.getString(1), filter.getString(3)); + } + if (Objects.equals(filter.getString(2), new String(">="))) { + query = query.whereGreaterThanOrEqualTo(filter.getString(1), filter.getString(3)); + } + if (Objects.equals(filter.getString(2), new String("array-contains"))) { + query = query.whereArrayContains(filter.getString(1), filter.getString(3)); + } + break; + case "orderBy": + Direction direction = Direction.ASCENDING; + if (Objects.equals(filter.getString(2), new String("desc"))) { + direction = Direction.DESCENDING; + } + query = query.orderBy(filter.getString(1), direction); + break; + case "startAt": + query = query.startAt(filter.getString(1)); + break; + case "endAt": + query = query.endAt(filter.getString(1)); + break; + case "limit": + query = query.limit(filter.getLong(1)); + break; + } + } + + query.get() + .addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() { + @Override + public void onComplete(@NonNull Task<QuerySnapshot> task) { + try { + if (task.isSuccessful()) { + JSONObject jsonDocs = new JSONObject(); + for (QueryDocumentSnapshot document : task.getResult()) { + jsonDocs.put(document.getId(), mapToJsonObject(document.getData())); + } + callbackContext.success(jsonDocs); + } else { + handleExceptionWithContext(task.getException(), callbackContext); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + }); + } + + + protected static void handleExceptionWithContext(Exception e, CallbackContext context) { + String msg = e.toString(); + Log.e(TAG, msg); + instance.logExceptionToCrashlytics(e); + context.error(msg); + } + + protected static void handleExceptionWithoutContext(Exception e){ + String msg = e.toString(); + Log.e(TAG, msg); + if (instance != null) { + instance.logExceptionToCrashlytics(e); + instance.logErrorToWebview(msg); + } + } + + protected void logErrorToWebview(String msg){ + Log.e(TAG, msg); + executeGlobalJavascript("console.error(\""+TAG+"[native]: "+escapeDoubleQuotes(msg)+"\")"); + } + + private String escapeDoubleQuotes(String string){ + String escapedString = string.replace("\"", "\\\""); + escapedString = escapedString.replace("%22", "\\%22"); + return escapedString; + } + + private void executeGlobalJavascript(final String jsString){ + if(cordovaActivity == null) return; + cordovaActivity.runOnUiThread(new Runnable() { + @Override + public void run() { + webView.loadUrl("javascript:" + jsString); + } + }); + } + + private String saveAuthCredential(AuthCredential authCredential){ + String id = this.generateId(); + this.authCredentials.put(id, authCredential); + return id; + } + + private String saveAuthProvider(OAuthProvider authProvider){ + String id = this.generateId(); + this.authProviders.put(id, authProvider); + return id; + } + + private String generateId(){ + Random r = new Random(); + return Integer.toString(r.nextInt(1000+1)); + } + + private boolean getMetaDataFromManifest(String name) throws Exception{ + return applicationContext.getPackageManager().getApplicationInfo(applicationContext.getPackageName(), PackageManager.GET_META_DATA).metaData.getBoolean(name); + } + + private void setPreference(String name, boolean value){ + SharedPreferences settings = cordovaActivity.getSharedPreferences(SETTINGS_NAME, MODE_PRIVATE); + SharedPreferences.Editor editor = settings.edit(); + editor.putBoolean(name, value); + editor.apply(); + } + + private boolean getPreference(String name){ + SharedPreferences settings = cordovaActivity.getSharedPreferences(SETTINGS_NAME, MODE_PRIVATE); + return settings.getBoolean(name, false); + } + + private void handleTaskOutcome(@NonNull Task<Void> task, CallbackContext callbackContext) { + try { + task.addOnCompleteListener(new OnCompleteListener<Void>() { + @Override + public void onComplete(@NonNull Task<Void> task) { + try { + if (task.isSuccessful() || task.getException() == null) { + callbackContext.success(); + }else if(task.getException() != null){ + callbackContext.error(task.getException().getMessage()); + }else{ + callbackContext.error("Task failed for unknown reason"); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + }; + }); + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + + private void handleAuthTaskOutcome(@NonNull Task<AuthResult> task, CallbackContext callbackContext) { + try { + if (task.isSuccessful() || task.getException() == null) { + callbackContext.success(); + }else{ + String errMessage = task.getException().getMessage(); + if (task.getException() instanceof FirebaseAuthInvalidCredentialsException) { + errMessage = "Invalid verification code"; + } + callbackContext.error(errMessage); + } + } catch (Exception e) { + handleExceptionWithContext(e, callbackContext); + } + } + + private AuthCredential obtainAuthCredential(JSONObject jsonCredential) throws JSONException { + AuthCredential authCredential = null; + if(jsonCredential.has("verificationId") && jsonCredential.has("code")){ + Log.d(TAG, "Using specified verificationId and code to authenticate"); + authCredential = (AuthCredential) PhoneAuthProvider.getCredential(jsonCredential.getString("verificationId"), jsonCredential.getString("code")); + }else if(jsonCredential.has("id") && FirebasePlugin.instance.authCredentials.containsKey(jsonCredential.getString("id"))){ + Log.d(TAG, "Using native auth credential to authenticate"); + authCredential = FirebasePlugin.instance.authCredentials.get(jsonCredential.getString("id")); + } + return authCredential; + } + + private OAuthProvider obtainAuthProvider(JSONObject jsonCredential) throws JSONException{ + OAuthProvider authProvider = null; + if(jsonCredential.has("id") && FirebasePlugin.instance.authProviders.containsKey(jsonCredential.getString("id"))){ + Log.d(TAG, "Using native auth provider to authenticate"); + authProvider = FirebasePlugin.instance.authProviders.get(jsonCredential.getString("id")); + } + return authProvider; + } + + + private static class AuthResultOnSuccessListener implements OnSuccessListener<AuthResult> { + @Override + public void onSuccess(AuthResult authResult) { + Log.d(TAG, "AuthResult:onSuccess:" + authResult); + if(FirebasePlugin.instance.authResultCallbackContext != null){ + FirebasePlugin.instance.authResultCallbackContext.success(); + } + } + } + + private static class AuthResultOnFailureListener implements OnFailureListener { + @Override + public void onFailure(@NonNull Exception e) { + Log.w(TAG, "AuthResult:onFailure", e); + if(FirebasePlugin.instance.authResultCallbackContext != null){ + FirebasePlugin.instance.authResultCallbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, e.getMessage())); + } + } + } + + private static class AuthResultOnCompleteListener implements OnCompleteListener<AuthResult> { + private final CallbackContext callbackContext; + + public AuthResultOnCompleteListener(CallbackContext callbackContext) { + this.callbackContext = callbackContext; + } + + @Override + public void onComplete(@NonNull Task<AuthResult> task) { + FirebasePlugin.instance.handleAuthTaskOutcome(task, callbackContext); + } + } + + private static class AuthStateListener implements FirebaseAuth.AuthStateListener { + @Override + public void onAuthStateChanged(@NonNull FirebaseAuth firebaseAuth) { + try { + if(!FirebasePlugin.instance.authStateChangeListenerInitialized){ + FirebasePlugin.instance.authStateChangeListenerInitialized = true; + }else{ + FirebaseUser user = firebaseAuth.getCurrentUser(); + FirebasePlugin.instance.executeGlobalJavascript(JS_GLOBAL_NAMESPACE+"_onAuthStateChange("+(user != null ? "true" : "false")+")"); + } + } catch (Exception e) { + handleExceptionWithoutContext(e); + } + } + } + + private Map<String, Object> jsonStringToMap(String jsonString) throws JSONException { + Type type = new TypeToken<Map<String, Object>>(){}.getType(); + return gson.fromJson(jsonString, type); + } + + + private JSONObject mapToJsonObject(Map<String, Object> map) throws JSONException { + String jsonString = gson.toJson(map); + return new JSONObject(jsonString); + } + + private void logMessageToCrashlytics(String message){ + if(isCrashlyticsEnabled()){ + try{ + firebaseCrashlytics.log(message); + }catch (Exception e){ + Log.e(TAG, e.getMessage()); + } + }else{ + Log.e(TAG, "Cannot log message - Crashlytics collection is disabled"); + } + } + + private void logExceptionToCrashlytics(Exception exception){ + if(isCrashlyticsEnabled()){ + try{ + firebaseCrashlytics.recordException(exception); + }catch (Exception e){ + Log.e(TAG, e.getMessage()); + } + }else{ + Log.e(TAG, "Cannot log exception - Crashlytics collection is disabled"); + } + } +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiver.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiver.java new file mode 100644 index 00000000..1bb76d08 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiver.java @@ -0,0 +1,28 @@ +package org.apache.cordova.firebase; + +import android.os.Bundle; + +import com.google.firebase.messaging.RemoteMessage; + +public abstract class FirebasePluginMessageReceiver { + + public FirebasePluginMessageReceiver() { + FirebasePluginMessageReceiverManager.register(this); + } + + /** + * Concrete subclasses should override this and return true if they handle the received message. + * + * @param remoteMessage + * @return true if the received message was handled by the receiver so should not be handled by FirebasePluginMessagingService.onMessageReceived() + */ + public abstract boolean onMessageReceived(RemoteMessage remoteMessage); + + /** + * Concrete subclasses should override this and return true if they handle the message bundle before it's sent to FirebasePlugin.sendMessage(). + * + * @param bundle + * @return true if the received bundle was handled by the receiver so should not be handled by FirebasePlugin. + */ + public abstract boolean sendMessage(Bundle bundle); +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiverManager.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiverManager.java new file mode 100644 index 00000000..299e5cda --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessageReceiverManager.java @@ -0,0 +1,41 @@ +package org.apache.cordova.firebase; + +import android.os.Bundle; + +import com.google.firebase.messaging.RemoteMessage; + +import java.util.ArrayList; +import java.util.List; + +public class FirebasePluginMessageReceiverManager { + + private static List<FirebasePluginMessageReceiver> receivers = new ArrayList<FirebasePluginMessageReceiver>(); + + public static void register(FirebasePluginMessageReceiver receiver) { + receivers.add(receiver); + } + + public static boolean onMessageReceived(RemoteMessage remoteMessage) { + boolean handled = false; + for (FirebasePluginMessageReceiver receiver : receivers) { + boolean wasHandled = receiver.onMessageReceived(remoteMessage); + if (wasHandled) { + handled = true; + } + } + + return handled; + } + + public static boolean sendMessage(Bundle bundle) { + boolean handled = false; + for (FirebasePluginMessageReceiver receiver : receivers) { + boolean wasHandled = receiver.sendMessage(bundle); + if (wasHandled) { + handled = true; + } + } + + return handled; + } +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessagingService.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessagingService.java new file mode 100644 index 00000000..92e6aafb --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/FirebasePluginMessagingService.java @@ -0,0 +1,348 @@ +package org.apache.cordova.firebase; + +import android.app.NotificationChannel; +import android.app.NotificationManager; +import android.app.PendingIntent; +import android.content.Context; +import android.content.Intent; +import android.graphics.BitmapFactory; +import android.media.RingtoneManager; +import android.net.Uri; +import android.os.Build; +import android.os.Bundle; +import androidx.core.app.NotificationCompat; +import android.util.Log; +import android.app.Notification; +import android.text.TextUtils; +import android.content.ContentResolver; +import android.graphics.Color; + +import com.google.firebase.crashlytics.FirebaseCrashlytics; +import com.google.firebase.messaging.FirebaseMessagingService; +import com.google.firebase.messaging.RemoteMessage; + +import java.util.Map; +import java.util.Random; + +public class FirebasePluginMessagingService extends FirebaseMessagingService { + + private static final String TAG = "FirebasePlugin"; + + static final String defaultSmallIconName = "notification_icon"; + static final String defaultLargeIconName = "notification_icon_large"; + + + /** + * Called if InstanceID token is updated. This may occur if the security of + * the previous token had been compromised. Note that this is called when the InstanceID token + * is initially generated so this is where you would retrieve the token. + */ + @Override + public void onNewToken(String refreshedToken) { + try{ + super.onNewToken(refreshedToken); + Log.d(TAG, "Refreshed token: " + refreshedToken); + FirebasePlugin.sendToken(refreshedToken); + }catch (Exception e){ + FirebasePlugin.handleExceptionWithoutContext(e); + } + } + + + /** + * Called when message is received. + * Called IF message is a data message (i.e. NOT sent from Firebase console) + * OR if message is a notification message (e.g. sent from Firebase console) AND app is in foreground. + * Notification messages received while app is in background will not be processed by this method; + * they are handled internally by the OS. + * + * @param remoteMessage Object representing the message received from Firebase Cloud Messaging. + */ + @Override + public void onMessageReceived(RemoteMessage remoteMessage) { + try{ + // [START_EXCLUDE] + // There are two types of messages data messages and notification messages. Data messages are handled + // here in onMessageReceived whether the app is in the foreground or background. Data messages are the type + // traditionally used with GCM. Notification messages are only received here in onMessageReceived when the app + // is in the foreground. When the app is in the background an automatically generated notification is displayed. + // When the user taps on the notification they are returned to the app. Messages containing both notification + // and data payloads are treated as notification messages. The Firebase console always sends notification + // messages. For more see: https://firebase.google.com/docs/cloud-messaging/concept-options + // [END_EXCLUDE] + + // Pass the message to the receiver manager so any registered receivers can decide to handle it + boolean wasHandled = FirebasePluginMessageReceiverManager.onMessageReceived(remoteMessage); + if (wasHandled) { + Log.d(TAG, "Message was handled by a registered receiver"); + + // Don't process the message in this method. + return; + } + + if(FirebasePlugin.applicationContext == null){ + FirebasePlugin.applicationContext = this.getApplicationContext(); + } + + // TODO(developer): Handle FCM messages here. + // Not getting messages here? See why this may be: https://goo.gl/39bRNJ + String messageType; + String title = null; + String body = null; + String id = null; + String sound = null; + String vibrate = null; + String light = null; + String color = null; + String icon = null; + String channelId = null; + String visibility = null; + String priority = null; + boolean foregroundNotification = false; + + Map<String, String> data = remoteMessage.getData(); + + if (remoteMessage.getNotification() != null) { + // Notification message payload + Log.i(TAG, "Received message: notification"); + messageType = "notification"; + id = remoteMessage.getMessageId(); + RemoteMessage.Notification notification = remoteMessage.getNotification(); + title = notification.getTitle(); + body = notification.getBody(); + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { + channelId = notification.getChannelId(); + } + sound = notification.getSound(); + color = notification.getColor(); + icon = notification.getIcon(); + }else{ + Log.i(TAG, "Received message: data"); + messageType = "data"; + } + + if (data != null) { + // Data message payload + if(data.containsKey("notification_foreground")){ + foregroundNotification = true; + } + if(data.containsKey("notification_title")) title = data.get("notification_title"); + if(data.containsKey("notification_body")) body = data.get("notification_body"); + if(data.containsKey("notification_android_channel_id")) channelId = data.get("notification_android_channel_id"); + if(data.containsKey("notification_android_id")) id = data.get("notification_android_id"); + if(data.containsKey("notification_android_sound")) sound = data.get("notification_android_sound"); + if(data.containsKey("notification_android_vibrate")) vibrate = data.get("notification_android_vibrate"); + if(data.containsKey("notification_android_light")) light = data.get("notification_android_light"); //String containing hex ARGB color, miliseconds on, miliseconds off, example: '#FFFF00FF,1000,3000' + if(data.containsKey("notification_android_color")) color = data.get("notification_android_color"); + if(data.containsKey("notification_android_icon")) icon = data.get("notification_android_icon"); + if(data.containsKey("notification_android_visibility")) visibility = data.get("notification_android_visibility"); + if(data.containsKey("notification_android_priority")) priority = data.get("notification_android_priority"); + } + + if (TextUtils.isEmpty(id)) { + Random rand = new Random(); + int n = rand.nextInt(50) + 1; + id = Integer.toString(n); + } + + Log.d(TAG, "From: " + remoteMessage.getFrom()); + Log.d(TAG, "Id: " + id); + Log.d(TAG, "Title: " + title); + Log.d(TAG, "Body: " + body); + Log.d(TAG, "Sound: " + sound); + Log.d(TAG, "Vibrate: " + vibrate); + Log.d(TAG, "Light: " + light); + Log.d(TAG, "Color: " + color); + Log.d(TAG, "Icon: " + icon); + Log.d(TAG, "Channel Id: " + channelId); + Log.d(TAG, "Visibility: " + visibility); + Log.d(TAG, "Priority: " + priority); + + + if (!TextUtils.isEmpty(body) || !TextUtils.isEmpty(title) || (data != null && !data.isEmpty())) { + boolean showNotification = (FirebasePlugin.inBackground() || !FirebasePlugin.hasNotificationsCallback() || foregroundNotification) && (!TextUtils.isEmpty(body) || !TextUtils.isEmpty(title)); + sendMessage(remoteMessage, data, messageType, id, title, body, showNotification, sound, vibrate, light, color, icon, channelId, priority, visibility); + } + }catch (Exception e){ + FirebasePlugin.handleExceptionWithoutContext(e); + } + } + + private void sendMessage(RemoteMessage remoteMessage, Map<String, String> data, String messageType, String id, String title, String body, boolean showNotification, String sound, String vibrate, String light, String color, String icon, String channelId, String priority, String visibility) { + Log.d(TAG, "sendMessage(): messageType="+messageType+"; showNotification="+showNotification+"; id="+id+"; title="+title+"; body="+body+"; sound="+sound+"; vibrate="+vibrate+"; light="+light+"; color="+color+"; icon="+icon+"; channel="+channelId+"; data="+data.toString()); + Bundle bundle = new Bundle(); + for (String key : data.keySet()) { + bundle.putString(key, data.get(key)); + } + bundle.putString("messageType", messageType); + this.putKVInBundle("id", id, bundle); + this.putKVInBundle("title", title, bundle); + this.putKVInBundle("body", body, bundle); + this.putKVInBundle("sound", sound, bundle); + this.putKVInBundle("vibrate", vibrate, bundle); + this.putKVInBundle("light", light, bundle); + this.putKVInBundle("color", color, bundle); + this.putKVInBundle("icon", icon, bundle); + this.putKVInBundle("channel_id", channelId, bundle); + this.putKVInBundle("priority", priority, bundle); + this.putKVInBundle("visibility", visibility, bundle); + this.putKVInBundle("show_notification", String.valueOf(showNotification), bundle); + this.putKVInBundle("from", remoteMessage.getFrom(), bundle); + this.putKVInBundle("collapse_key", remoteMessage.getCollapseKey(), bundle); + this.putKVInBundle("sent_time", String.valueOf(remoteMessage.getSentTime()), bundle); + this.putKVInBundle("ttl", String.valueOf(remoteMessage.getTtl()), bundle); + + if (showNotification) { + Intent intent = new Intent(this, OnNotificationOpenReceiver.class); + intent.putExtras(bundle); + PendingIntent pendingIntent = PendingIntent.getBroadcast(this, id.hashCode(), intent, PendingIntent.FLAG_UPDATE_CURRENT); + + // Channel + if(channelId == null || !FirebasePlugin.channelExists(channelId)){ + channelId = FirebasePlugin.defaultChannelId; + } + if(Build.VERSION.SDK_INT >= Build.VERSION_CODES.O){ + Log.d(TAG, "Channel ID: "+channelId); + } + + NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(this, channelId); + notificationBuilder + .setContentTitle(title) + .setContentText(body) + .setStyle(new NotificationCompat.BigTextStyle().bigText(body)) + .setAutoCancel(true) + .setContentIntent(pendingIntent); + + // On Android O+ the sound/lights/vibration are determined by the channel ID + if(Build.VERSION.SDK_INT < Build.VERSION_CODES.O){ + // Sound + if (sound == null) { + Log.d(TAG, "Sound: none"); + }else if (sound.equals("default")) { + notificationBuilder.setSound(RingtoneManager.getDefaultUri(RingtoneManager.TYPE_NOTIFICATION)); + Log.d(TAG, "Sound: default"); + }else{ + Uri soundPath = Uri.parse(ContentResolver.SCHEME_ANDROID_RESOURCE + "://" + getPackageName() + "/raw/" + sound); + Log.d(TAG, "Sound: custom=" + sound+"; path="+soundPath.toString()); + notificationBuilder.setSound(soundPath); + } + + // Light + if (light != null) { + try { + String[] lightsComponents = color.replaceAll("\\s", "").split(","); + if (lightsComponents.length == 3) { + int lightArgb = Color.parseColor(lightsComponents[0]); + int lightOnMs = Integer.parseInt(lightsComponents[1]); + int lightOffMs = Integer.parseInt(lightsComponents[2]); + notificationBuilder.setLights(lightArgb, lightOnMs, lightOffMs); + Log.d(TAG, "Lights: color="+lightsComponents[0]+"; on(ms)="+lightsComponents[2]+"; off(ms)="+lightsComponents[3]); + } + + } catch (Exception e) {} + } + + // Vibrate + if (vibrate != null){ + try { + String[] sVibrations = vibrate.replaceAll("\\s", "").split(","); + long[] lVibrations = new long[sVibrations.length]; + int i=0; + for(String sVibration: sVibrations){ + lVibrations[i] = Integer.parseInt(sVibration.trim()); + i++; + } + notificationBuilder.setVibrate(lVibrations); + Log.d(TAG, "Vibrate: "+vibrate); + } catch (Exception e) { + Log.e(TAG, e.getMessage()); + } + } + } + + + // Icon + int defaultSmallIconResID = getResources().getIdentifier(defaultSmallIconName, "drawable", getPackageName()); + int customSmallIconResID = 0; + if(icon != null){ + customSmallIconResID = getResources().getIdentifier(icon, "drawable", getPackageName()); + } + + if (customSmallIconResID != 0) { + notificationBuilder.setSmallIcon(customSmallIconResID); + Log.d(TAG, "Small icon: custom="+icon); + }else if (defaultSmallIconResID != 0) { + Log.d(TAG, "Small icon: default="+defaultSmallIconName); + notificationBuilder.setSmallIcon(defaultSmallIconResID); + } else { + Log.d(TAG, "Small icon: application"); + notificationBuilder.setSmallIcon(getApplicationInfo().icon); + } + + if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.LOLLIPOP) { + int defaultLargeIconResID = getResources().getIdentifier(defaultLargeIconName, "drawable", getPackageName()); + int customLargeIconResID = 0; + if(icon != null){ + customLargeIconResID = getResources().getIdentifier(icon+"_large", "drawable", getPackageName()); + } + + int largeIconResID; + if (customLargeIconResID != 0 || defaultLargeIconResID != 0) { + if (customLargeIconResID != 0) { + largeIconResID = customLargeIconResID; + Log.d(TAG, "Large icon: custom="+icon); + }else{ + Log.d(TAG, "Large icon: default="+defaultLargeIconName); + largeIconResID = defaultLargeIconResID; + } + notificationBuilder.setLargeIcon(BitmapFactory.decodeResource(getApplicationContext().getResources(), largeIconResID)); + } + } + + // Color + if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.M) { + int defaultColor = getResources().getColor(getResources().getIdentifier("accent", "color", getPackageName()), null); + if(color != null){ + notificationBuilder.setColor(Color.parseColor(color)); + Log.d(TAG, "Color: custom="+color); + }else{ + Log.d(TAG, "Color: default"); + notificationBuilder.setColor(defaultColor); + } + } + + // Visibility + int iVisibility = NotificationCompat.VISIBILITY_PUBLIC; + if(visibility != null){ + iVisibility = Integer.parseInt(visibility); + } + Log.d(TAG, "Visibility: " + iVisibility); + notificationBuilder.setVisibility(iVisibility); + + // Priority + int iPriority = NotificationCompat.PRIORITY_MAX; + if(priority != null){ + iPriority = Integer.parseInt(priority); + } + Log.d(TAG, "Priority: " + iPriority); + notificationBuilder.setPriority(iPriority); + + + // Build notification + Notification notification = notificationBuilder.build(); + + // Display notification + NotificationManager notificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE); + Log.d(TAG, "show notification: "+notification.toString()); + notificationManager.notify(id.hashCode(), notification); + } + // Send to plugin + FirebasePlugin.sendMessage(bundle, this.getApplicationContext()); + } + + private void putKVInBundle(String k, String v, Bundle b){ + if(v != null && !b.containsKey(k)){ + b.putString(k, v); + } + } +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/JavaScriptException.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/JavaScriptException.java new file mode 100644 index 00000000..3d423fa3 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/JavaScriptException.java @@ -0,0 +1,45 @@ +package org.apache.cordova.firebase; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +/** + * Exception class to log Javascript based exceptions with stacktrace. + * + * Picked from https://github.com/wizpanda/cordova-plugin-firebase-lib/pull/8/files + * + * @author https://github.com/sagrawal31/ + */ +public class JavaScriptException extends Exception { + + public JavaScriptException(String message) { + super(message); + } + + public JavaScriptException(String message, JSONArray stackTrace) throws JSONException { + super(message); + this.handleStacktrace(stackTrace); + } + + private void handleStacktrace(JSONArray stackTrace) throws JSONException { + if (stackTrace == null) { + return; + } + + StackTraceElement[] trace = new StackTraceElement[stackTrace.length()]; + + for (int i = 0; i < stackTrace.length(); i++) { + JSONObject elem = stackTrace.getJSONObject(i); + + trace[i] = new StackTraceElement( + "undefined", + elem.optString("functionName", "undefined"), + elem.optString("fileName", "undefined"), + elem.optInt("lineNumber", -1) + ); + } + + this.setStackTrace(trace); + } +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/OnNotificationOpenReceiver.java b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/OnNotificationOpenReceiver.java new file mode 100644 index 00000000..818382ef --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/OnNotificationOpenReceiver.java @@ -0,0 +1,36 @@ +package org.apache.cordova.firebase; + +import android.app.PendingIntent; +import android.content.BroadcastReceiver; +import android.content.Context; +import android.content.Intent; +import android.content.pm.PackageManager; +import android.os.Bundle; +import android.util.Log; + +public class OnNotificationOpenReceiver extends BroadcastReceiver { + + // Called on tapping foreground notification + @Override + public void onReceive(Context context, Intent intent) { + try{ + PackageManager pm = context.getPackageManager(); + + Intent launchIntent = pm.getLaunchIntentForPackage(context.getPackageName()); + launchIntent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_NEW_TASK); + + Bundle data = intent.getExtras(); + if(!data.containsKey("messageType")) data.putString("messageType", "notification"); + data.putString("tap", FirebasePlugin.inBackground() ? "background" : "foreground"); + + Log.d(FirebasePlugin.TAG, "OnNotificationOpenReceiver.onReceive(): "+data.toString()); + + FirebasePlugin.sendMessage(data, context); + + launchIntent.putExtras(data); + context.startActivity(launchIntent); + }catch (Exception e){ + FirebasePlugin.handleExceptionWithoutContext(e); + } + } +} diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/build.gradle b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/build.gradle new file mode 100644 index 00000000..89c743f1 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/build.gradle @@ -0,0 +1,48 @@ +buildscript { + repositories { + google() + mavenCentral() + jcenter() + } + dependencies { + classpath 'com.android.tools.build:gradle:3.4.1' + classpath 'com.google.gms:google-services:4.3.3' + classpath 'com.google.firebase:firebase-crashlytics-gradle:2.1.1' + } +} +repositories { + mavenCentral() + maven { + url "https://maven.google.com" + } +} + +apply plugin: com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsPlugin +android { + buildTypes { + debug { + firebaseCrashlytics { + mappingFileUploadEnabled false + } + } + release { + firebaseCrashlytics { + nativeSymbolUploadEnabled true + unstrippedNativeLibsDir "obj/local" + strippedNativeLibsDir "build/intermediates/jniLibs/release" + } + } + } +} + +cdvPluginPostBuildExtras.add({ + rootProject.subprojects { + if (name == "app") { + if (!plugins.hasPlugin('com.google.gms.google-services')) { + apply plugin: com.google.gms.googleservices.GoogleServicesPlugin + } + } + } +}) + + diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/colors.xml b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/colors.xml new file mode 100644 index 00000000..045e125f --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/colors.xml @@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="utf-8"?> +<resources> +</resources> diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/android/cordova-plugin-firebase-strings.xml b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/cordova-plugin-firebase-strings.xml new file mode 100644 index 00000000..1f1d32cc --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/android/cordova-plugin-firebase-strings.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='utf-8'?> +<resources> + <string name="default_notification_channel_id">fcm_default_channel</string> + <string name="default_notification_channel_name">Default</string> +</resources>
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.h b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.h new file mode 100644 index 00000000..461b17e4 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.h @@ -0,0 +1,11 @@ +#import "AppDelegate.h"
+#import <GoogleSignIn/GoogleSignIn.h>
+
+@import UserNotifications;
+@import AuthenticationServices;
+
+@interface AppDelegate (FirebasePlugin) <UIApplicationDelegate, GIDSignInDelegate, ASAuthorizationControllerDelegate, ASAuthorizationControllerPresentationContextProviding>
++ (AppDelegate *) instance;
+@property (nonatomic, strong) NSNumber * _Nonnull applicationInBackground;
+@property (NS_NONATOMIC_IOSONLY, nullable, weak) id <UNUserNotificationCenterDelegate> delegate;
+@end
diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.m b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.m new file mode 100644 index 00000000..a14c6569 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/AppDelegate+FirebasePlugin.m @@ -0,0 +1,557 @@ +#import "AppDelegate+FirebasePlugin.h" +#import "FirebasePlugin.h" +#import "Firebase.h" +#import <objc/runtime.h> + + +@import UserNotifications; +@import FirebaseFirestore; + +// Implement UNUserNotificationCenterDelegate to receive display notification via APNS for devices running iOS 10 and above. +// Implement FIRMessagingDelegate to receive data message via FCM for devices running iOS 10 and above. +@interface AppDelegate () <UNUserNotificationCenterDelegate, FIRMessagingDelegate> +@end + +#define kApplicationInBackgroundKey @"applicationInBackground" + +@implementation AppDelegate (FirebasePlugin) + +static AppDelegate* instance; + ++ (AppDelegate*) instance { + return instance; +} + +static NSDictionary* mutableUserInfo; +static FIRAuthStateDidChangeListenerHandle authStateChangeListener; +static bool authStateChangeListenerInitialized = false; +static bool shouldEstablishDirectChannel = false; + ++ (void)load { + Method original = class_getInstanceMethod(self, @selector(application:didFinishLaunchingWithOptions:)); + Method swizzled = class_getInstanceMethod(self, @selector(application:swizzledDidFinishLaunchingWithOptions:)); + method_exchangeImplementations(original, swizzled); +} + +- (void)setApplicationInBackground:(NSNumber *)applicationInBackground { + objc_setAssociatedObject(self, kApplicationInBackgroundKey, applicationInBackground, OBJC_ASSOCIATION_RETAIN_NONATOMIC); +} + +- (NSNumber *)applicationInBackground { + return objc_getAssociatedObject(self, kApplicationInBackgroundKey); +} + +- (BOOL)application:(UIApplication *)application swizzledDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + [self application:application swizzledDidFinishLaunchingWithOptions:launchOptions]; + + @try{ + instance = self; + + bool isFirebaseInitializedWithPlist = false; + if(![FIRApp defaultApp]) { + // get GoogleService-Info.plist file path + NSString *filePath = [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"]; + + // if file is successfully found, use it + if(filePath){ + [FirebasePlugin.firebasePlugin _logMessage:@"GoogleService-Info.plist found, setup: [FIRApp configureWithOptions]"]; + // create firebase configure options passing .plist as content + FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:filePath]; + + // configure FIRApp with options + [FIRApp configureWithOptions:options]; + + isFirebaseInitializedWithPlist = true; + }else{ + // no .plist found, try default App + [FirebasePlugin.firebasePlugin _logError:@"GoogleService-Info.plist NOT FOUND, setup: [FIRApp defaultApp]"]; + [FIRApp configure]; + } + }else{ + // Firebase SDK has already been initialised: + // Assume that another call (probably from another plugin) did so with the plist + isFirebaseInitializedWithPlist = true; + } + + + + shouldEstablishDirectChannel = [[[NSBundle mainBundle] objectForInfoDictionaryKey:@"shouldEstablishDirectChannel"] boolValue]; + + // Set FCM messaging delegate + [FIRMessaging messaging].delegate = self; + [FIRMessaging messaging].shouldEstablishDirectChannel = shouldEstablishDirectChannel; + + // Setup Firestore + [FirebasePlugin setFirestore:[FIRFirestore firestore]]; + + // Setup Google SignIn + [GIDSignIn sharedInstance].clientID = [FIRApp defaultApp].options.clientID; + [GIDSignIn sharedInstance].delegate = self; + + authStateChangeListener = [[FIRAuth auth] addAuthStateDidChangeListener:^(FIRAuth * _Nonnull auth, FIRUser * _Nullable user) { + @try { + if(!authStateChangeListenerInitialized){ + authStateChangeListenerInitialized = true; + }else{ + [FirebasePlugin.firebasePlugin executeGlobalJavascript:[NSString stringWithFormat:@"FirebasePlugin._onAuthStateChange(%@)", (user != nil ? @"true": @"false")]]; + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } + }]; + + // Set NSNotificationCenter observer + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(tokenRefreshNotification:) + name:kFIRInstanceIDTokenRefreshNotification object:nil]; + + self.applicationInBackground = @(YES); + + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } + + return YES; +} + +- (void)applicationDidBecomeActive:(UIApplication *)application { + self.applicationInBackground = @(NO); + [FIRMessaging messaging].shouldEstablishDirectChannel = shouldEstablishDirectChannel; + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"Enter foreground: FCM direct channel = %@", shouldEstablishDirectChannel ? @"true" : @"false"]]; +} + +- (void)applicationDidEnterBackground:(UIApplication *)application { + self.applicationInBackground = @(YES); + [FIRMessaging messaging].shouldEstablishDirectChannel = false; + [FirebasePlugin.firebasePlugin _logMessage:@"Enter background: FCM direct channel = false"]; +} + +# pragma mark - Google SignIn +- (void)signIn:(GIDSignIn *)signIn +didSignInForUser:(GIDGoogleUser *)user + withError:(NSError *)error { + @try{ + CDVPluginResult* pluginResult; + if (error == nil) { + GIDAuthentication *authentication = user.authentication; + FIRAuthCredential *credential = + [FIRGoogleAuthProvider credentialWithIDToken:authentication.idToken + accessToken:authentication.accessToken]; + + int key = [[FirebasePlugin firebasePlugin] saveAuthCredential:credential]; + NSMutableDictionary* result = [[NSMutableDictionary alloc] init]; + [result setValue:@"true" forKey:@"instantVerification"]; + [result setValue:[NSNumber numberWithInt:key] forKey:@"id"]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:result]; + } else { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:error.description]; + } + if ([FirebasePlugin firebasePlugin].googleSignInCallbackId != nil) { + [[FirebasePlugin firebasePlugin].commandDelegate sendPluginResult:pluginResult callbackId:[FirebasePlugin firebasePlugin].googleSignInCallbackId]; + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +- (void)signIn:(GIDSignIn *)signIn +didDisconnectWithUser:(GIDGoogleUser *)user + withError:(NSError *)error { + NSString* msg = @"Google SignIn delegate: didDisconnectWithUser"; + if(error != nil){ + [FirebasePlugin.firebasePlugin _logError:[NSString stringWithFormat:@"%@: %@", msg, error]]; + }else{ + [FirebasePlugin.firebasePlugin _logMessage:msg]; + } +} + +# pragma mark - FIRMessagingDelegate +- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken { + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"didReceiveRegistrationToken: %@", fcmToken]]; + @try{ + [FirebasePlugin.firebasePlugin sendToken:fcmToken]; + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +- (void)tokenRefreshNotification:(NSNotification *)notification { + // Note that this callback will be fired everytime a new token is generated, including the first + // time. So if you need to retrieve the token as soon as it is available this is where that + // should be done. + @try{ + [[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result, + NSError * _Nullable error) { + @try{ + if (error == nil) { + NSString *refreshedToken = result.token; + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"tokenRefreshNotification: %@", refreshedToken]]; + [FirebasePlugin.firebasePlugin sendToken:refreshedToken]; + }else{ + [FirebasePlugin.firebasePlugin _logError:[NSString stringWithFormat:@"tokenRefreshNotification: %@", error.description]]; + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } + }]; + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { + [FIRMessaging messaging].APNSToken = deviceToken; + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"didRegisterForRemoteNotificationsWithDeviceToken: %@", deviceToken]]; + [FirebasePlugin.firebasePlugin sendApnsToken:[FirebasePlugin.firebasePlugin hexadecimalStringFromData:deviceToken]]; + + // Set UNUserNotificationCenter delegate + [UNUserNotificationCenter currentNotificationCenter].delegate = self; +} + +//Tells the app that a remote notification arrived that indicates there is data to be fetched. +// Called when a message arrives in the foreground and remote notifications permission has been granted +- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo + fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler { + + @try{ + [[FIRMessaging messaging] appDidReceiveMessage:userInfo]; + mutableUserInfo = [userInfo mutableCopy]; + NSDictionary* aps = [mutableUserInfo objectForKey:@"aps"]; + bool isContentAvailable = false; + if([aps objectForKey:@"alert"] != nil){ + isContentAvailable = [[aps objectForKey:@"content-available"] isEqualToNumber:[NSNumber numberWithInt:1]]; + [mutableUserInfo setValue:@"notification" forKey:@"messageType"]; + NSString* tap; + if([self.applicationInBackground isEqual:[NSNumber numberWithBool:YES]] && !isContentAvailable){ + tap = @"background"; + } + [mutableUserInfo setValue:tap forKey:@"tap"]; + }else{ + [mutableUserInfo setValue:@"data" forKey:@"messageType"]; + } + + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"didReceiveRemoteNotification: %@", mutableUserInfo]]; + + completionHandler(UIBackgroundFetchResultNewData); + if([self.applicationInBackground isEqual:[NSNumber numberWithBool:YES]] && isContentAvailable){ + [FirebasePlugin.firebasePlugin _logError:@"didReceiveRemoteNotification: omitting foreground notification as content-available:1 so system notification will be shown"]; + }else{ + [self processMessageForForegroundNotification:mutableUserInfo]; + } + if([self.applicationInBackground isEqual:[NSNumber numberWithBool:YES]] || !isContentAvailable){ + [FirebasePlugin.firebasePlugin sendNotification:mutableUserInfo]; + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +// Receive data messages on iOS 10+ directly from FCM (bypassing APNs) when the app is in the foreground. +// Called when a data message is arrives in the foreground and remote notifications permission has been NOT been granted +- (void)messaging:(FIRMessaging *)messaging didReceiveMessage:(FIRMessagingRemoteMessage *)remoteMessage { + @try{ + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"didReceiveMessage: %@", remoteMessage.appData]]; + + NSDictionary* appData = [remoteMessage.appData mutableCopy]; + [appData setValue:@"data" forKey:@"messageType"]; + [self processMessageForForegroundNotification:appData]; + + // This will allow us to handle FCM data-only push messages even if the permission for push + // notifications is yet missing. This will only work when the app is in the foreground. + [FirebasePlugin.firebasePlugin sendNotification:appData]; + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +// Scans a message for keys which indicate a notification should be shown. +// If found, extracts relevant keys and uses then to display a local notification +-(void)processMessageForForegroundNotification:(NSDictionary*)messageData { + bool showForegroundNotification = [messageData objectForKey:@"notification_foreground"]; + if(!showForegroundNotification){ + return; + } + + NSString* title = nil; + NSString* body = nil; + NSString* sound = nil; + NSNumber* badge = nil; + + // Extract APNS notification keys + NSDictionary* aps = [messageData objectForKey:@"aps"]; + if([aps objectForKey:@"alert"] != nil){ + NSDictionary* alert = [aps objectForKey:@"alert"]; + if([alert objectForKey:@"title"] != nil){ + title = [alert objectForKey:@"title"]; + } + if([alert objectForKey:@"body"] != nil){ + body = [alert objectForKey:@"body"]; + } + if([aps objectForKey:@"sound"] != nil){ + sound = [aps objectForKey:@"sound"]; + } + if([aps objectForKey:@"badge"] != nil){ + badge = [aps objectForKey:@"badge"]; + } + } + + // Extract data notification keys + if([messageData objectForKey:@"notification_title"] != nil){ + title = [messageData objectForKey:@"notification_title"]; + } + if([messageData objectForKey:@"notification_body"] != nil){ + body = [messageData objectForKey:@"notification_body"]; + } + if([messageData objectForKey:@"notification_ios_sound"] != nil){ + sound = [messageData objectForKey:@"notification_ios_sound"]; + } + if([messageData objectForKey:@"notification_ios_badge"] != nil){ + badge = [messageData objectForKey:@"notification_ios_badge"]; + } + + if(title == nil || body == nil){ + return; + } + + [[UNUserNotificationCenter currentNotificationCenter] getNotificationSettingsWithCompletionHandler:^(UNNotificationSettings * _Nonnull settings) { + @try{ + if (settings.alertSetting == UNNotificationSettingEnabled) { + UNMutableNotificationContent *objNotificationContent = [[UNMutableNotificationContent alloc] init]; + objNotificationContent.title = [NSString localizedUserNotificationStringForKey:title arguments:nil]; + objNotificationContent.body = [NSString localizedUserNotificationStringForKey:body arguments:nil]; + + NSDictionary* alert = [[NSDictionary alloc] initWithObjectsAndKeys: + title, @"title", + body, @"body" + , nil]; + NSMutableDictionary* aps = [[NSMutableDictionary alloc] initWithObjectsAndKeys: + alert, @"alert", + nil]; + + if(![sound isKindOfClass:[NSString class]] || [sound isEqualToString:@"default"]){ + objNotificationContent.sound = [UNNotificationSound defaultSound]; + [aps setValue:sound forKey:@"sound"]; + }else if(sound != nil){ + objNotificationContent.sound = [UNNotificationSound soundNamed:sound]; + [aps setValue:sound forKey:@"sound"]; + } + + if(badge != nil){ + [aps setValue:badge forKey:@"badge"]; + } + + NSString* messageType = @"data"; + if([mutableUserInfo objectForKey:@"messageType"] != nil){ + messageType = [mutableUserInfo objectForKey:@"messageType"]; + } + + NSDictionary* userInfo = [[NSDictionary alloc] initWithObjectsAndKeys: + @"true", @"notification_foreground", + messageType, @"messageType", + aps, @"aps" + , nil]; + + objNotificationContent.userInfo = userInfo; + + UNTimeIntervalNotificationTrigger *trigger = [UNTimeIntervalNotificationTrigger triggerWithTimeInterval:0.1f repeats:NO]; + UNNotificationRequest *request = [UNNotificationRequest requestWithIdentifier:@"local_notification" content:objNotificationContent trigger:trigger]; + [[UNUserNotificationCenter currentNotificationCenter] addNotificationRequest:request withCompletionHandler:^(NSError * _Nullable error) { + if (!error) { + [FirebasePlugin.firebasePlugin _logMessage:@"Local Notification succeeded"]; + } else { + [FirebasePlugin.firebasePlugin _logError:[NSString stringWithFormat:@"Local Notification failed: %@", error.description]]; + } + }]; + }else{ + [FirebasePlugin.firebasePlugin _logError:@"processMessageForForegroundNotification: cannot show notification as permission denied"]; + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } + }]; +} + +- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error { + [FirebasePlugin.firebasePlugin _logError:[NSString stringWithFormat:@"didFailToRegisterForRemoteNotificationsWithError: %@", error.description]]; +} + +// Asks the delegate how to handle a notification that arrived while the app was running in the foreground +// Called when an APS notification arrives when app is in foreground +- (void)userNotificationCenter:(UNUserNotificationCenter *)center + willPresentNotification:(UNNotification *)notification + withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler { + + @try{ + + if (![notification.request.trigger isKindOfClass:UNPushNotificationTrigger.class] && ![notification.request.trigger isKindOfClass:UNTimeIntervalNotificationTrigger.class]){ + [FirebasePlugin.firebasePlugin _logError:@"willPresentNotification: aborting as not a supported UNNotificationTrigger"]; + return; + } + + [[FIRMessaging messaging] appDidReceiveMessage:notification.request.content.userInfo]; + + mutableUserInfo = [notification.request.content.userInfo mutableCopy]; + + NSString* messageType = [mutableUserInfo objectForKey:@"messageType"]; + if(![messageType isEqualToString:@"data"]){ + [mutableUserInfo setValue:@"notification" forKey:@"messageType"]; + } + + // Print full message. + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"willPresentNotification: %@", mutableUserInfo]]; + + + NSDictionary* aps = [mutableUserInfo objectForKey:@"aps"]; + bool isContentAvailable = [[aps objectForKey:@"content-available"] isEqualToNumber:[NSNumber numberWithInt:1]]; + if(isContentAvailable){ + [FirebasePlugin.firebasePlugin _logError:@"willPresentNotification: aborting as content-available:1 so system notification will be shown"]; + return; + } + + bool showForegroundNotification = [mutableUserInfo objectForKey:@"notification_foreground"]; + bool hasAlert = [aps objectForKey:@"alert"] != nil; + bool hasBadge = [aps objectForKey:@"badge"] != nil; + bool hasSound = [aps objectForKey:@"sound"] != nil; + + if(showForegroundNotification){ + [FirebasePlugin.firebasePlugin _logMessage:[NSString stringWithFormat:@"willPresentNotification: foreground notification alert=%@, badge=%@, sound=%@", hasAlert ? @"YES" : @"NO", hasBadge ? @"YES" : @"NO", hasSound ? @"YES" : @"NO"]]; + if(hasAlert && hasBadge && hasSound){ + completionHandler(UNNotificationPresentationOptionAlert + UNNotificationPresentationOptionBadge + UNNotificationPresentationOptionSound); + }else if(hasAlert && hasBadge){ + completionHandler(UNNotificationPresentationOptionAlert + UNNotificationPresentationOptionBadge); + }else if(hasAlert && hasSound){ + completionHandler(UNNotificationPresentationOptionAlert + UNNotificationPresentationOptionSound); + }else if(hasBadge && hasSound){ + completionHandler(UNNotificationPresentationOptionBadge + UNNotificationPresentationOptionSound); + }else if(hasAlert){ + completionHandler(UNNotificationPresentationOptionAlert); + }else if(hasBadge){ + completionHandler(UNNotificationPresentationOptionBadge); + }else if(hasSound){ + completionHandler(UNNotificationPresentationOptionSound); + } + }else{ + [FirebasePlugin.firebasePlugin _logMessage:@"willPresentNotification: foreground notification not set"]; + } + + if(![messageType isEqualToString:@"data"]){ + [FirebasePlugin.firebasePlugin sendNotification:mutableUserInfo]; + } + + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +// Asks the delegate to process the user's response to a delivered notification. +// Called when user taps on system notification +- (void) userNotificationCenter:(UNUserNotificationCenter *)center + didReceiveNotificationResponse:(UNNotificationResponse *)response + withCompletionHandler:(void (^)(void))completionHandler +{ + @try{ + + if (![response.notification.request.trigger isKindOfClass:UNPushNotificationTrigger.class] && ![response.notification.request.trigger isKindOfClass:UNTimeIntervalNotificationTrigger.class]){ + [FirebasePlugin.firebasePlugin _logMessage:@"didReceiveNotificationResponse: aborting as not a supported UNNotificationTrigger"]; + return; + } + + [[FIRMessaging messaging] appDidReceiveMessage:response.notification.request.content.userInfo]; + + mutableUserInfo = [response.notification.request.content.userInfo mutableCopy]; + + NSString* tap; + if([self.applicationInBackground isEqual:[NSNumber numberWithBool:YES]]){ + tap = @"background"; + }else{ + tap = @"foreground"; + + } + [mutableUserInfo setValue:tap forKey:@"tap"]; + if([mutableUserInfo objectForKey:@"messageType"] == nil){ + [mutableUserInfo setValue:@"notification" forKey:@"messageType"]; + } + + // Dynamic Actions + if (response.actionIdentifier && ![response.actionIdentifier isEqual:UNNotificationDefaultActionIdentifier]) { + [mutableUserInfo setValue:response.actionIdentifier forKey:@"action"]; + } + + // Print full message. + [FirebasePlugin.firebasePlugin _logInfo:[NSString stringWithFormat:@"didReceiveNotificationResponse: %@", mutableUserInfo]]; + + [FirebasePlugin.firebasePlugin sendNotification:mutableUserInfo]; + + completionHandler(); + + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +// Receive data message on iOS 10 devices. +- (void)applicationReceivedRemoteMessage:(FIRMessagingRemoteMessage *)remoteMessage { + // Print full message + [FirebasePlugin.firebasePlugin _logInfo:[NSString stringWithFormat:@"applicationReceivedRemoteMessage: %@", [remoteMessage appData]]]; +} + +// Apple Sign In +- (void)authorizationController:(ASAuthorizationController *)controller + didCompleteWithAuthorization:(ASAuthorization *)authorization API_AVAILABLE(ios(13.0)) { + @try{ + CDVPluginResult* pluginResult; + NSString* errorMessage = nil; + FIROAuthCredential *credential; + + if ([authorization.credential isKindOfClass:[ASAuthorizationAppleIDCredential class]]) { + ASAuthorizationAppleIDCredential *appleIDCredential = authorization.credential; + NSString *rawNonce = [FirebasePlugin appleSignInNonce]; + if(rawNonce == nil){ + errorMessage = @"Invalid state: A login callback was received, but no login request was sent."; + }else if (appleIDCredential.identityToken == nil) { + errorMessage = @"Unable to fetch identity token."; + }else{ + NSString *idToken = [[NSString alloc] initWithData:appleIDCredential.identityToken + encoding:NSUTF8StringEncoding]; + if (idToken == nil) { + errorMessage = [NSString stringWithFormat:@"Unable to serialize id token from data: %@", appleIDCredential.identityToken]; + }else{ + // Initialize a Firebase credential. + credential = [FIROAuthProvider credentialWithProviderID:@"apple.com" + IDToken:idToken + rawNonce:rawNonce]; + + int key = [[FirebasePlugin firebasePlugin] saveAuthCredential:credential]; + NSMutableDictionary* result = [[NSMutableDictionary alloc] init]; + [result setValue:@"true" forKey:@"instantVerification"]; + [result setValue:[NSNumber numberWithInt:key] forKey:@"id"]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:result]; + } + } + if(errorMessage != nil){ + [FirebasePlugin.firebasePlugin _logError:errorMessage]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage]; + } + if ([FirebasePlugin firebasePlugin].appleSignInCallbackId != nil) { + [[FirebasePlugin firebasePlugin].commandDelegate sendPluginResult:pluginResult callbackId:[FirebasePlugin firebasePlugin].appleSignInCallbackId]; + } + } + }@catch (NSException *exception) { + [FirebasePlugin.firebasePlugin handlePluginExceptionWithoutContext:exception]; + } +} + +- (void)authorizationController:(ASAuthorizationController *)controller + didCompleteWithError:(NSError *)error API_AVAILABLE(ios(13.0)) { + NSString* errorMessage = [NSString stringWithFormat:@"Sign in with Apple errored: %@", error]; + [FirebasePlugin.firebasePlugin _logError:errorMessage]; + if ([FirebasePlugin firebasePlugin].appleSignInCallbackId != nil) { + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage]; + [[FirebasePlugin firebasePlugin].commandDelegate sendPluginResult:pluginResult callbackId:[FirebasePlugin firebasePlugin].appleSignInCallbackId]; + } +} + +- (nonnull ASPresentationAnchor)presentationAnchorForAuthorizationController:(nonnull ASAuthorizationController *)controller API_AVAILABLE(ios(13.0)){ + return self.viewController.view.window; +} + +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.h b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.h new file mode 100644 index 00000000..2a65108d --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.h @@ -0,0 +1,119 @@ +#import <Cordova/CDV.h> +#import "AppDelegate.h" +#import "Firebase.h" +@import FirebaseFirestore; + +@interface FirebasePlugin : CDVPlugin + +- (void)setAutoInitEnabled:(CDVInvokedUrlCommand*)command; +- (void)isAutoInitEnabled:(CDVInvokedUrlCommand*)command; + +// Authentication +- (void)verifyPhoneNumber:(CDVInvokedUrlCommand*)command; +- (void)createUserWithEmailAndPassword:(CDVInvokedUrlCommand*)command; +- (void)signInUserWithEmailAndPassword:(CDVInvokedUrlCommand*)command; +- (void)signInUserWithCustomToken:(CDVInvokedUrlCommand*)command; +- (void)signInUserAnonymously:(CDVInvokedUrlCommand*)command; +- (void)authenticateUserWithGoogle:(CDVInvokedUrlCommand*)command; +- (void)authenticateUserWithApple:(CDVInvokedUrlCommand*)command; +- (void)signInWithCredential:(CDVInvokedUrlCommand*)command; +- (void)linkUserWithCredential:(CDVInvokedUrlCommand*)command; +- (void)reauthenticateWithCredential:(CDVInvokedUrlCommand*)command; +- (void)isUserSignedIn:(CDVInvokedUrlCommand*)command; +- (void)signOutUser:(CDVInvokedUrlCommand*)command; +- (void)getCurrentUser:(CDVInvokedUrlCommand*)command; +- (void)reloadCurrentUser:(CDVInvokedUrlCommand*)command; +- (void)updateUserProfile:(CDVInvokedUrlCommand*)command; +- (void)updateUserEmail:(CDVInvokedUrlCommand*)command; +- (void)sendUserEmailVerification:(CDVInvokedUrlCommand*)command; +- (void)updateUserPassword:(CDVInvokedUrlCommand*)command; +- (void)sendUserPasswordResetEmail:(CDVInvokedUrlCommand*)command; +- (void)deleteUser:(CDVInvokedUrlCommand*)command; + +// Remote notifications +- (void)getId:(CDVInvokedUrlCommand*)command; +- (void)getToken:(CDVInvokedUrlCommand*)command; +- (void)getAPNSToken:(CDVInvokedUrlCommand*)command; +- (NSString *)hexadecimalStringFromData:(NSData *)data; +- (void)grantPermission:(CDVInvokedUrlCommand*)command; +- (void)hasPermission:(CDVInvokedUrlCommand*)command; +- (void)setBadgeNumber:(CDVInvokedUrlCommand*)command; +- (void)getBadgeNumber:(CDVInvokedUrlCommand*)command; +- (void)subscribe:(CDVInvokedUrlCommand*)command; +- (void)unsubscribe:(CDVInvokedUrlCommand*)command; +- (void)unregister:(CDVInvokedUrlCommand*)command; +- (void)onMessageReceived:(CDVInvokedUrlCommand*)command; +- (void)onTokenRefresh:(CDVInvokedUrlCommand*)command; +- (void)onApnsTokenReceived:(CDVInvokedUrlCommand *)command; +- (void)sendNotification:(NSDictionary*)userInfo; +- (void)sendToken:(NSString*)token; +- (void)sendApnsToken:(NSString*)token; +- (void)clearAllNotifications:(CDVInvokedUrlCommand *)command; + +// Analytics +- (void)setAnalyticsCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)isAnalyticsCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)logEvent:(CDVInvokedUrlCommand*)command; +- (void)setScreenName:(CDVInvokedUrlCommand*)command; +- (void)setUserId:(CDVInvokedUrlCommand*)command; +- (void)setUserProperty:(CDVInvokedUrlCommand*)command; + +// Crashlytics +- (void)setCrashlyticsCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)isCrashlyticsCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)logError:(CDVInvokedUrlCommand*)command; +- (void)logMessage:(CDVInvokedUrlCommand*)command; +- (void)sendCrash:(CDVInvokedUrlCommand*)command; +- (void)setCrashlyticsUserId:(CDVInvokedUrlCommand*)command; + +// Remote config +- (void)fetch:(CDVInvokedUrlCommand*)command; +- (void)activateFetched:(CDVInvokedUrlCommand*)command; +- (void)getValue:(CDVInvokedUrlCommand*)command; +- (void)getInfo:(CDVInvokedUrlCommand*)command; + +// Performance +- (void)setPerformanceCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)isPerformanceCollectionEnabled:(CDVInvokedUrlCommand*)command; +- (void)startTrace:(CDVInvokedUrlCommand*)command; +- (void)incrementCounter:(CDVInvokedUrlCommand*)command; +- (void)stopTrace:(CDVInvokedUrlCommand*)command; + +// Firestore +- (void)addDocumentToFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)setDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)updateDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)deleteDocumentFromFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)documentExistsInFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)fetchDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command; +- (void)fetchFirestoreCollection:(CDVInvokedUrlCommand*)command; + + +// Internals ++ (FirebasePlugin *) firebasePlugin; ++ (NSString*) appleSignInNonce; ++ (void) setFirestore:(FIRFirestore*) firestoreInstance; +- (void) handlePluginExceptionWithContext: (NSException*) exception :(CDVInvokedUrlCommand*)command; +- (void) handlePluginExceptionWithoutContext: (NSException*) exception; +- (void) _logError: (NSString*)msg; +- (void) _logInfo: (NSString*)msg; +- (void) _logMessage: (NSString*)msg; +- (BOOL) _shouldEnableCrashlytics; +- (int) saveAuthCredential: (FIRAuthCredential *) authCredential; +- (void)executeGlobalJavascript: (NSString*)jsString; + +- (void)createChannel:(CDVInvokedUrlCommand *)command; +- (void)setDefaultChannel:(CDVInvokedUrlCommand *)command; +- (void)deleteChannel:(CDVInvokedUrlCommand *)command; +- (void)listChannels:(CDVInvokedUrlCommand *)command; + +@property (nonatomic, copy) NSString *notificationCallbackId; +@property (nonatomic, copy) NSString *tokenRefreshCallbackId; +@property (nonatomic, copy) NSString *apnsTokenRefreshCallbackId; +@property (nonatomic, copy) NSString *googleSignInCallbackId; +@property (nonatomic, copy) NSString *appleSignInCallbackId; + +@property (nonatomic, retain) NSMutableArray *notificationStack; +@property (nonatomic, readwrite) NSMutableDictionary* traces; + +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.m b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.m new file mode 100644 index 00000000..e72514c0 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePlugin.m @@ -0,0 +1,1757 @@ +#import "FirebasePlugin.h" +#import "FirebasePluginMessageReceiverManager.h" +#import "AppDelegate+FirebasePlugin.h" +#import <Cordova/CDV.h> +#import "AppDelegate.h" +#import <GoogleSignIn/GoogleSignIn.h> +@import FirebaseInstanceID; +@import FirebaseMessaging; +@import FirebaseAnalytics; +@import FirebaseRemoteConfig; +@import FirebasePerformance; +@import FirebaseAuth; +@import UserNotifications; +@import CommonCrypto; +@import AuthenticationServices; + +@implementation FirebasePlugin + +@synthesize notificationCallbackId; +@synthesize tokenRefreshCallbackId; +@synthesize apnsTokenRefreshCallbackId; +@synthesize googleSignInCallbackId; +@synthesize appleSignInCallbackId; +@synthesize notificationStack; +@synthesize traces; + +static NSString*const LOG_TAG = @"FirebasePlugin[native]"; +static NSInteger const kNotificationStackSize = 10; +static NSString*const FIREBASE_CRASHLYTICS_COLLECTION_ENABLED = @"FIREBASE_CRASHLYTICS_COLLECTION_ENABLED"; //preference +static NSString*const FirebaseCrashlyticsCollectionEnabled = @"FirebaseCrashlyticsCollectionEnabled"; //plist +static NSString*const FIREBASE_ANALYTICS_COLLECTION_ENABLED = @"FIREBASE_ANALYTICS_COLLECTION_ENABLED"; +static NSString*const FIREBASE_PERFORMANCE_COLLECTION_ENABLED = @"FIREBASE_PERFORMANCE_COLLECTION_ENABLED"; + +static FirebasePlugin* firebasePlugin; +static BOOL registeredForRemoteNotifications = NO; +static NSMutableDictionary* authCredentials; +static NSString* currentNonce; // used for Apple Sign In +static FIRFirestore* firestore; +static NSUserDefaults* preferences; +static NSDictionary* googlePlist; + + ++ (FirebasePlugin*) firebasePlugin { + return firebasePlugin; +} + ++ (NSString*) appleSignInNonce { + return currentNonce; +} + ++ (void) setFirestore:(FIRFirestore*) firestoreInstance{ + firestore = firestoreInstance; +} + +// @override abstract +- (void)pluginInitialize { + NSLog(@"Starting Firebase plugin"); + firebasePlugin = self; + + @try { + preferences = [NSUserDefaults standardUserDefaults]; + googlePlist = [NSMutableDictionary dictionaryWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"]]; + + if([self getGooglePlistFlagWithDefaultValue:FirebaseCrashlyticsCollectionEnabled defaultValue:YES]){ + [self setPreferenceFlag:FIREBASE_CRASHLYTICS_COLLECTION_ENABLED flag:YES]; + } + + if([self getGooglePlistFlagWithDefaultValue:FIREBASE_ANALYTICS_COLLECTION_ENABLED defaultValue:YES]){ + [self setPreferenceFlag:FIREBASE_ANALYTICS_COLLECTION_ENABLED flag:YES]; + } + + if([self getGooglePlistFlagWithDefaultValue:FIREBASE_PERFORMANCE_COLLECTION_ENABLED defaultValue:YES]){ + [self setPreferenceFlag:FIREBASE_PERFORMANCE_COLLECTION_ENABLED flag:YES]; + } + + // Set actionable categories if pn-actions.json exist in bundle + [self setActionableNotifications]; + + // Check for permission and register for remote notifications if granted + [self _hasPermission:^(BOOL result) {}]; + + [GIDSignIn sharedInstance].presentingViewController = self.viewController; + + authCredentials = [[NSMutableDictionary alloc] init]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } +} + + +// Dynamic actions from pn-actions.json +- (void)setActionableNotifications { + + // Parse JSON + NSString *path = [[NSBundle mainBundle] pathForResource:@"pn-actions" ofType:@"json"]; + NSData *data = [NSData dataWithContentsOfFile:path]; + NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]; + + // Assign actions for categories + NSMutableSet *categories = [[NSMutableSet alloc] init]; + NSArray *actionsArray = [dict objectForKey:@"PushNotificationActions"]; + for (NSDictionary *item in actionsArray) { + NSMutableArray *buttons = [NSMutableArray new]; + NSString *category = [item objectForKey:@"category"]; + + NSArray *actions = [item objectForKey:@"actions"]; + for (NSDictionary *action in actions) { + NSString *actionId = [action objectForKey:@"id"]; + NSString *actionTitle = [action objectForKey:@"title"]; + + [buttons addObject:[UNNotificationAction actionWithIdentifier:actionId + title:NSLocalizedString(actionTitle, nil) options:UNNotificationActionOptionNone]]; + } + + [categories addObject:[UNNotificationCategory categoryWithIdentifier:category + actions:buttons intentIdentifiers:@[] options:UNNotificationCategoryOptionNone]]; + } + + // Initialize categories + [[UNUserNotificationCenter currentNotificationCenter] setNotificationCategories:categories]; +} + +// @override abstract +- (void)handleOpenURL:(NSNotification*)notification{ + NSURL* url = [notification object]; + [[GIDSignIn sharedInstance] handleURL:url]; +} + +- (void)setAutoInitEnabled:(CDVInvokedUrlCommand *)command { + @try { + bool enabled = [[command.arguments objectAtIndex:0] boolValue]; + [self runOnMainThread:^{ + @try { + [FIRMessaging messaging].autoInitEnabled = enabled; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)isAutoInitEnabled:(CDVInvokedUrlCommand *)command { + @try { + + [self runOnMainThread:^{ + @try { + bool enabled =[FIRMessaging messaging].isAutoInitEnabled; + + CDVPluginResult *commandResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:enabled]; + [self.commandDelegate sendPluginResult:commandResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +/* + * Remote notifications + */ + +- (void)getId:(CDVInvokedUrlCommand *)command { + __block CDVPluginResult *pluginResult; + + FIRInstanceIDHandler handler = ^(NSString *_Nullable instID, NSError *_Nullable error) { + @try { + [self handleStringResultWithPotentialError:error command:command result:instID]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }; + + @try { + [[FIRInstanceID instanceID] getIDWithHandler:handler]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)getToken:(CDVInvokedUrlCommand *)command { + @try { + [[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result, + NSError * _Nullable error) { + NSString* token = nil; + if (error == nil && result != nil && result.token != nil) { + token = result.token; + } + [self handleStringResultWithPotentialError:error command:command result:token]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)getAPNSToken:(CDVInvokedUrlCommand *)command { + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:[self getAPNSToken]]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; +} + +- (NSString *)getAPNSToken { + NSString* hexToken = nil; + NSData* apnsToken = [FIRMessaging messaging].APNSToken; + if (apnsToken) { +#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 130000 + // [deviceToken description] Starting with iOS 13 device token is like "{length = 32, bytes = 0xd3d997af 967d1f43 b405374a 13394d2f ... 28f10282 14af515f }" + hexToken = [self hexadecimalStringFromData:apnsToken]; +#else + hexToken = [[apnsToken.description componentsSeparatedByCharactersInSet:[[NSCharacterSet alphanumericCharacterSet]invertedSet]]componentsJoinedByString:@""]; +#endif + } + return hexToken; +} + +- (NSString *)hexadecimalStringFromData:(NSData *)data +{ + NSUInteger dataLength = data.length; + if (dataLength == 0) { + return nil; + } + + const unsigned char *dataBuffer = data.bytes; + NSMutableString *hexString = [NSMutableString stringWithCapacity:(dataLength * 2)]; + for (int i = 0; i < dataLength; ++i) { + [hexString appendFormat:@"%02x", dataBuffer[i]]; + } + return [hexString copy]; +} + +- (void)hasPermission:(CDVInvokedUrlCommand *)command { + @try { + [self _hasPermission:^(BOOL enabled) { + CDVPluginResult *commandResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:enabled]; + [self.commandDelegate sendPluginResult:commandResult callbackId:command.callbackId]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +-(void)_hasPermission:(void (^)(BOOL result))completeBlock { + @try { + [[UNUserNotificationCenter currentNotificationCenter] getNotificationSettingsWithCompletionHandler:^(UNNotificationSettings * _Nonnull settings) { + @try { + BOOL enabled = NO; + if (settings.alertSetting == UNNotificationSettingEnabled) { + enabled = YES; + [self registerForRemoteNotifications]; + } + NSLog(@"_hasPermission: %@", enabled ? @"YES" : @"NO"); + completeBlock(enabled); + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } +} + +- (void)grantPermission:(CDVInvokedUrlCommand *)command { + NSLog(@"grantPermission"); + @try { + [self _hasPermission:^(BOOL enabled) { + @try { + if(enabled){ + NSString* message = @"Permission is already granted - call hasPermission() to check before calling grantPermission()"; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:message]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }else{ + [UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate> _Nullable) self; + UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert|UNAuthorizationOptionSound|UNAuthorizationOptionBadge; + [[UNUserNotificationCenter currentNotificationCenter] + requestAuthorizationWithOptions:authOptions + completionHandler:^(BOOL granted, NSError * _Nullable error) { + @try { + NSLog(@"requestAuthorizationWithOptions: granted=%@", granted ? @"YES" : @"NO"); + if (error == nil && granted) { + [self registerForRemoteNotifications]; + } + [self handleBoolResultWithPotentialError:error command:command result:granted]; + + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + } + ]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)registerForRemoteNotifications { + NSLog(@"registerForRemoteNotifications"); + if(registeredForRemoteNotifications) return; + + [self runOnMainThread:^{ + @try { + [[UIApplication sharedApplication] registerForRemoteNotifications]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } + registeredForRemoteNotifications = YES; + }]; +} + +- (void)setBadgeNumber:(CDVInvokedUrlCommand *)command { + @try { + int number = [[command.arguments objectAtIndex:0] intValue]; + [self runOnMainThread:^{ + @try { + [[UIApplication sharedApplication] setApplicationIconBadgeNumber:number]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)getBadgeNumber:(CDVInvokedUrlCommand *)command { + [self runOnMainThread:^{ + @try { + long badge = [[UIApplication sharedApplication] applicationIconBadgeNumber]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDouble:badge]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)subscribe:(CDVInvokedUrlCommand *)command { + @try { + NSString* topic = [NSString stringWithFormat:@"%@", [command.arguments objectAtIndex:0]]; + + [[FIRMessaging messaging] subscribeToTopic: topic completion:^(NSError * _Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)unsubscribe:(CDVInvokedUrlCommand *)command { + @try { + NSString* topic = [NSString stringWithFormat:@"%@", [command.arguments objectAtIndex:0]]; + + [[FIRMessaging messaging] unsubscribeFromTopic: topic completion:^(NSError * _Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)unregister:(CDVInvokedUrlCommand *)command { + @try { + [[FIRInstanceID instanceID] deleteIDWithHandler:^void(NSError *_Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + + + +- (void)onMessageReceived:(CDVInvokedUrlCommand *)command { + @try { + self.notificationCallbackId = command.callbackId; + + if (self.notificationStack != nil && [self.notificationStack count]) { + for (NSDictionary *userInfo in self.notificationStack) { + [self sendNotification:userInfo]; + } + [self.notificationStack removeAllObjects]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)onTokenRefresh:(CDVInvokedUrlCommand *)command { + self.tokenRefreshCallbackId = command.callbackId; + @try { + [[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result, + NSError * _Nullable error) { + @try { + if (result.token != nil && error == nil) { + [self sendToken:result.token]; + }else{ + [self handleStringResultWithPotentialError:error command:command result:result.token]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)onApnsTokenReceived:(CDVInvokedUrlCommand *)command { + self.apnsTokenRefreshCallbackId = command.callbackId; + @try { + NSString* apnsToken = [self getAPNSToken]; + if(apnsToken != nil){ + [self sendApnsToken:apnsToken]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)sendNotification:(NSDictionary *)userInfo { + @try { + if([FirebasePluginMessageReceiverManager sendNotification:userInfo]){ + [self _logMessage:@"Message handled by custom receiver"]; + return; + } + if (self.notificationCallbackId != nil) { + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:userInfo]; + [pluginResult setKeepCallbackAsBool:YES]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:self.notificationCallbackId]; + } else { + if (!self.notificationStack) { + self.notificationStack = [[NSMutableArray alloc] init]; + } + + // stack notifications until a callback has been registered + [self.notificationStack addObject:userInfo]; + + if ([self.notificationStack count] >= kNotificationStackSize) { + [self.notificationStack removeLastObject]; + } + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :self.commandDelegate]; + } +} + +- (void)sendToken:(NSString *)token { + @try { + if (self.tokenRefreshCallbackId != nil) { + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:token]; + [pluginResult setKeepCallbackAsBool:YES]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:self.tokenRefreshCallbackId]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :self.commandDelegate]; + } +} + +- (void)sendApnsToken:(NSString *)token { + @try { + if (self.apnsTokenRefreshCallbackId != nil) { + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:token]; + [pluginResult setKeepCallbackAsBool:YES]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:self.apnsTokenRefreshCallbackId]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :self.commandDelegate]; + } +} + +- (void)clearAllNotifications:(CDVInvokedUrlCommand *)command { + [self runOnMainThread:^{ + @try { + [[UIApplication sharedApplication] setApplicationIconBadgeNumber:1]; + [[UIApplication sharedApplication] setApplicationIconBadgeNumber:0]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +/* + * Authentication + */ +- (void)verifyPhoneNumber:(CDVInvokedUrlCommand *)command { + NSString* number = [command.arguments objectAtIndex:0]; + + @try { + [[FIRPhoneAuthProvider provider] + verifyPhoneNumber:number + UIDelegate:nil + completion:^(NSString *_Nullable verificationID, NSError *_Nullable error) { + + @try { + CDVPluginResult* pluginResult; + if (error) { + // Verification code not sent. + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:error.description]; + } else { + // Successful. + NSMutableDictionary* result = [[NSMutableDictionary alloc] init]; + [result setValue:@"false" forKey:@"instantVerification"]; + [result setValue:verificationID forKey:@"verificationId"]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:result]; + } + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)createUserWithEmailAndPassword:(CDVInvokedUrlCommand*)command { + @try { + NSString* email = [command.arguments objectAtIndex:0]; + NSString* password = [command.arguments objectAtIndex:1]; + [[FIRAuth auth] createUserWithEmail:email + password:password + completion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + @try { + [self handleAuthResult:authResult error:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)signInUserWithEmailAndPassword:(CDVInvokedUrlCommand*)command { + @try { + NSString* email = [command.arguments objectAtIndex:0]; + NSString* password = [command.arguments objectAtIndex:1]; + [[FIRAuth auth] signInWithEmail:email + password:password + completion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + @try { + [self handleAuthResult:authResult error:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)signInUserWithCustomToken:(CDVInvokedUrlCommand*)command { + @try { + NSString* customToken = [command.arguments objectAtIndex:0]; + [[FIRAuth auth] signInWithCustomToken:customToken + completion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + @try { + [self handleAuthResult:authResult error:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)signInUserAnonymously:(CDVInvokedUrlCommand*)command { + @try { + [[FIRAuth auth] signInAnonymouslyWithCompletion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + @try { + [self handleAuthResult:authResult error:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)authenticateUserWithGoogle:(CDVInvokedUrlCommand*)command{ + @try { + self.googleSignInCallbackId = command.callbackId; + [[GIDSignIn sharedInstance] signIn]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_NO_RESULT]; + [pluginResult setKeepCallbackAsBool:YES]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)authenticateUserWithApple:(CDVInvokedUrlCommand*)command{ + @try { + CDVPluginResult *pluginResult; + if (@available(iOS 13.0, *)) { + self.appleSignInCallbackId = command.callbackId; + [self startSignInWithAppleFlow]; + + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_NO_RESULT]; + [pluginResult setKeepCallbackAsBool:YES]; + } else { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"OS version is too low - Apple Sign In requires iOS 13.0+"]; + } + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)signInWithCredential:(CDVInvokedUrlCommand*)command { + @try { + FIRAuthCredential* credential = [self obtainAuthCredential:[command.arguments objectAtIndex:0] command:command]; + if(credential == nil) return; + + [[FIRAuth auth] signInWithCredential:credential + completion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + [self handleAuthResult:authResult error:error command:command]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)reauthenticateWithCredential:(CDVInvokedUrlCommand*)command{ + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + FIRAuthCredential* credential = [self obtainAuthCredential:[command.arguments objectAtIndex:0] command:command]; + if(credential == nil) return; + + [user reauthenticateWithCredential:credential completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) { + [self handleAuthResult:authResult error:error command:command]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)linkUserWithCredential:(CDVInvokedUrlCommand*)command { + @try { + FIRAuthCredential* credential = [self obtainAuthCredential:[command.arguments objectAtIndex:0] command:command]; + if(credential == nil) return; + + [[FIRAuth auth].currentUser linkWithCredential:credential + completion:^(FIRAuthDataResult * _Nullable authResult, + NSError * _Nullable error) { + [self handleAuthResult:authResult error:error command:command]; + }]; + + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)isUserSignedIn:(CDVInvokedUrlCommand*)command { + @try { + bool isSignedIn = [FIRAuth auth].currentUser ? true : false; + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:isSignedIn] callbackId:command.callbackId]; + + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)signOutUser:(CDVInvokedUrlCommand*)command { + @try { + bool isSignedIn = [FIRAuth auth].currentUser ? true : false; + if(!isSignedIn){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + // Sign out of Google + if([[GIDSignIn sharedInstance] currentUser] != nil){ + [[GIDSignIn sharedInstance] signOut]; + } + + // Sign out of Firebase + NSError *signOutError; + BOOL status = [[FIRAuth auth] signOut:&signOutError]; + if (!status) { + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:[NSString stringWithFormat:@"Error signing out: %@", signOutError]] callbackId:command.callbackId]; + }else{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)getCurrentUser:(CDVInvokedUrlCommand *)command { + + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + [self extractAndReturnUserInfo:command]; + + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)reloadCurrentUser:(CDVInvokedUrlCommand *)command { + + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + [user reloadWithCompletion:^(NSError * _Nullable error) { + if (error != nil) { + [self handleEmptyResultWithPotentialError:error command:command]; + }else { + [self extractAndReturnUserInfo:command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void) extractAndReturnUserInfo:(CDVInvokedUrlCommand *)command { + FIRUser* user = [FIRAuth auth].currentUser; + NSMutableDictionary* userInfo = [NSMutableDictionary new]; + [userInfo setValue:user.displayName forKey:@"name"]; + [userInfo setValue:user.email forKey:@"email"]; + [userInfo setValue:@(user.isEmailVerified ? true : false) forKey:@"emailIsVerified"]; + [userInfo setValue:user.phoneNumber forKey:@"phoneNumber"]; + [userInfo setValue:user.photoURL ? user.photoURL.absoluteString : nil forKey:@"photoUrl"]; + [userInfo setValue:user.uid forKey:@"uid"]; + [userInfo setValue:@(user.isAnonymous ? true : false) forKey:@"isAnonymous"]; + [user getIDTokenWithCompletion:^(NSString * _Nullable token, NSError * _Nullable error) { + [userInfo setValue:token forKey:@"idToken"]; + [user getIDTokenResultWithCompletion:^(FIRAuthTokenResult * _Nullable tokenResult, NSError * _Nullable error) { + [userInfo setValue:tokenResult.signInProvider forKey:@"providerId"]; + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:userInfo] callbackId:command.callbackId]; + }]; + }]; +} + +- (void)updateUserProfile:(CDVInvokedUrlCommand*)command { + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + NSDictionary* profile = [command.arguments objectAtIndex:0]; + + FIRUserProfileChangeRequest* changeRequest = [user profileChangeRequest]; + if([profile objectForKey:@"name"] != nil){ + changeRequest.displayName = [profile objectForKey:@"name"]; + } + if([profile objectForKey:@"photoUri"] != nil){ + changeRequest.photoURL = [NSURL URLWithString:[profile objectForKey:@"photoUri"]]; + } + + [changeRequest commitChangesWithCompletion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)updateUserEmail:(CDVInvokedUrlCommand*)command { + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + NSString* email = [command.arguments objectAtIndex:0]; + [user updateEmail:email completion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)sendUserEmailVerification:(CDVInvokedUrlCommand*)command{ + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + [user sendEmailVerificationWithCompletion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)updateUserPassword:(CDVInvokedUrlCommand*)command{ + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + NSString* password = [command.arguments objectAtIndex:0]; + [user updatePassword:password completion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)sendUserPasswordResetEmail:(CDVInvokedUrlCommand*)command{ + @try { + NSString* email = [command.arguments objectAtIndex:0]; + [[FIRAuth auth] sendPasswordResetWithEmail:email completion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)deleteUser:(CDVInvokedUrlCommand*)command{ + @try { + FIRUser* user = [FIRAuth auth].currentUser; + if(!user){ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"No user is currently signed"] callbackId:command.callbackId]; + return; + } + + [user deleteWithCompletion:^(NSError *_Nullable error) { + @try { + [self handleEmptyResultWithPotentialError:error command:command]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)startSignInWithAppleFlow API_AVAILABLE(ios(13.0)){ + NSString *nonce = [self randomNonce:32]; + currentNonce = nonce; + ASAuthorizationAppleIDProvider *appleIDProvider = [[ASAuthorizationAppleIDProvider alloc] init]; + ASAuthorizationAppleIDRequest *request = [appleIDProvider createRequest]; + request.requestedScopes = @[ASAuthorizationScopeFullName, ASAuthorizationScopeEmail]; + request.nonce = [self stringBySha256HashingString:nonce]; + + ASAuthorizationController *authorizationController = + [[ASAuthorizationController alloc] initWithAuthorizationRequests:@[request]]; + authorizationController.delegate = [AppDelegate instance]; + authorizationController.presentationContextProvider = [AppDelegate instance]; + [authorizationController performRequests]; +} + +- (NSString *)stringBySha256HashingString:(NSString *)input { + const char *string = [input UTF8String]; + unsigned char result[CC_SHA256_DIGEST_LENGTH]; + CC_SHA256(string, (CC_LONG)strlen(string), result); + + NSMutableString *hashed = [NSMutableString stringWithCapacity:CC_SHA256_DIGEST_LENGTH * 2]; + for (NSInteger i = 0; i < CC_SHA256_DIGEST_LENGTH; i++) { + [hashed appendFormat:@"%02x", result[i]]; + } + return hashed; +} + +// Generates random nonce for Apple Sign In +- (NSString *)randomNonce:(NSInteger)length { + NSAssert(length > 0, @"Expected nonce to have positive length"); + NSString *characterSet = @"0123456789ABCDEFGHIJKLMNOPQRSTUVXYZabcdefghijklmnopqrstuvwxyz-._"; + NSMutableString *result = [NSMutableString string]; + NSInteger remainingLength = length; + + while (remainingLength > 0) { + NSMutableArray *randoms = [NSMutableArray arrayWithCapacity:16]; + for (NSInteger i = 0; i < 16; i++) { + uint8_t random = 0; + int errorCode = SecRandomCopyBytes(kSecRandomDefault, 1, &random); + NSAssert(errorCode == errSecSuccess, @"Unable to generate nonce: OSStatus %i", errorCode); + + [randoms addObject:@(random)]; + } + + for (NSNumber *random in randoms) { + if (remainingLength == 0) { + break; + } + + if (random.unsignedIntValue < characterSet.length) { + unichar character = [characterSet characterAtIndex:random.unsignedIntValue]; + [result appendFormat:@"%C", character]; + remainingLength--; + } + } + } + + return result; +} + +/* + * Analytics + */ +- (void)setAnalyticsCollectionEnabled:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + BOOL enabled = [[command argumentAtIndex:0] boolValue]; + CDVPluginResult* pluginResult; + [FIRAnalytics setAnalyticsCollectionEnabled:enabled]; + [self setPreferenceFlag:FIREBASE_ANALYTICS_COLLECTION_ENABLED flag:enabled]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)isAnalyticsCollectionEnabled:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate runInBackground:^{ + @try { + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:[self getPreferenceFlag:FIREBASE_ANALYTICS_COLLECTION_ENABLED]]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)logEvent:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* name = [command.arguments objectAtIndex:0]; + NSDictionary *parameters = [command argumentAtIndex:1]; + + [FIRAnalytics logEventWithName:name parameters:parameters]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)setScreenName:(CDVInvokedUrlCommand *)command { + @try { + NSString* name = [command.arguments objectAtIndex:0]; + + [FIRAnalytics setScreenName:name screenClass:NULL]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (void)setUserId:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* id = [command.arguments objectAtIndex:0]; + + [FIRAnalytics setUserID:id]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)setUserProperty:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* name = [command.arguments objectAtIndex:0]; + NSString* value = [command.arguments objectAtIndex:1]; + + [FIRAnalytics setUserPropertyString:value forName:name]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +/* + * Crashlytics + */ + +- (void)setCrashlyticsCollectionEnabled:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + BOOL enabled = [[command argumentAtIndex:0] boolValue]; + CDVPluginResult* pluginResult; + [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:enabled]; + [self setPreferenceFlag:FIREBASE_CRASHLYTICS_COLLECTION_ENABLED flag:enabled]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)isCrashlyticsCollectionEnabled:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate runInBackground:^{ + @try { + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:[self isCrashlyticsEnabled]]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +-(BOOL)isCrashlyticsEnabled{ + return [self getPreferenceFlag:FIREBASE_CRASHLYTICS_COLLECTION_ENABLED]; +} + +- (void)logError:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + NSString* errorMessage = [command.arguments objectAtIndex:0]; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + @try { + if(![self isCrashlyticsEnabled]){ + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Cannot log error - Crashlytics collection is disabled"]; + } + // We can optionally be passed a stack trace from stackTrace.js which we'll put in userInfo. + else if ([command.arguments count] > 1) { + NSArray* stackFrames = [command.arguments objectAtIndex:1]; + + NSString* message = errorMessage; + NSString* name = @"Uncaught Javascript exception"; + NSMutableArray *customFrames = [[NSMutableArray alloc] init]; + FIRExceptionModel *exceptionModel = [FIRExceptionModel exceptionModelWithName:name reason:message]; + + for (NSDictionary* stackFrame in stackFrames) { + FIRStackFrame *customFrame = [FIRStackFrame stackFrameWithSymbol:stackFrame[@"functionName"] file:stackFrame[@"fileName"] line:(uint32_t) [stackFrame[@"lineNumber"] intValue]]; + [customFrames addObject:customFrame]; + } + exceptionModel.stackTrace = customFrames; + [[FIRCrashlytics crashlytics] recordExceptionModel:exceptionModel]; + }else{ + //TODO detect and handle non-stack userInfo and pass to recordError + NSMutableDictionary* userInfo = [[NSMutableDictionary alloc] init]; + NSError *error = [NSError errorWithDomain:errorMessage code:0 userInfo:userInfo]; + [[FIRCrashlytics crashlytics] recordError:error]; + } + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + } @catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + + }]; +} + +- (void)logMessage:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate runInBackground:^{ + @try { + NSString* message = [command argumentAtIndex:0 withDefault:@""]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + if(![self isCrashlyticsEnabled]){ + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Cannot log message - Crashlytics collection is disabled"]; + }else if(message){ + [[FIRCrashlytics crashlytics] logWithFormat:@"%@", message]; + } + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)sendCrash:(CDVInvokedUrlCommand*)command{ + assert(NO); +} + +- (void)setCrashlyticsUserId:(CDVInvokedUrlCommand *)command { + @try { + NSString* userId = [command.arguments objectAtIndex:0]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + if(![self isCrashlyticsEnabled]){ + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Cannot set user ID - Crashlytics collection is disabled"]; + }else{ + [[FIRCrashlytics crashlytics] setUserID:userId]; + } + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +/* + * Remote config + */ +- (void)fetch:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + FIRRemoteConfig* remoteConfig = [FIRRemoteConfig remoteConfig]; + + if ([command.arguments count] > 0) { + int expirationDuration = [[command.arguments objectAtIndex:0] intValue]; + + [remoteConfig fetchWithExpirationDuration:expirationDuration completionHandler:^(FIRRemoteConfigFetchStatus status, NSError * _Nullable error) { + if (status == FIRRemoteConfigFetchStatusSuccess && error == nil){ + [self sendPluginSuccess:command]; + }else if (error != nil) { + [self handleEmptyResultWithPotentialError:error command:command]; + } else { + [self sendPluginError:command]; + } + }]; + } else { + [remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError * _Nullable error) { + if (status == FIRRemoteConfigFetchStatusSuccess && error == nil){ + [self sendPluginSuccess:command]; + }else if (error != nil) { + [self handleEmptyResultWithPotentialError:error command:command]; + } else { + [self sendPluginError:command]; + } + }]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)activateFetched:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + FIRRemoteConfig* remoteConfig = [FIRRemoteConfig remoteConfig]; + [remoteConfig activateWithCompletion:^(BOOL changed, NSError* _Nullable error) { + [self handleBoolResultWithPotentialError:error command:command result:true]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)getValue:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* key = [command.arguments objectAtIndex:0]; + FIRRemoteConfig* remoteConfig = [FIRRemoteConfig remoteConfig]; + NSString* value = remoteConfig[key].stringValue; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:value]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)getInfo:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + FIRRemoteConfig* remoteConfig = [FIRRemoteConfig remoteConfig]; + NSInteger minimumFetchInterval = remoteConfig.configSettings.minimumFetchInterval; + NSInteger fetchTimeout = remoteConfig.configSettings.fetchTimeout; + NSDate* lastFetchTime = remoteConfig.lastFetchTime; + FIRRemoteConfigFetchStatus lastFetchStatus = remoteConfig.lastFetchStatus; + // isDeveloperModeEnabled is deprecated new recommnded way to check is minimumFetchInterval == 0 + BOOL isDeveloperModeEnabled = minimumFetchInterval == 0 ? true : false; + + NSDictionary* configSettings = @{ + @"developerModeEnabled": [NSNumber numberWithBool:isDeveloperModeEnabled], + @"minimumFetchInterval": [NSNumber numberWithInteger:minimumFetchInterval], + @"fetchTimeout": [NSNumber numberWithInteger:fetchTimeout], + }; + + NSDictionary* infoObject = @{ + @"configSettings": configSettings, + @"fetchTimeMillis": (lastFetchTime ? [NSNumber numberWithInteger:(lastFetchTime.timeIntervalSince1970 * 1000)] : [NSNull null]), + @"lastFetchStatus": [NSNumber numberWithInteger:(lastFetchStatus)], + }; + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:infoObject]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +/* + * Performance + */ +- (void)setPerformanceCollectionEnabled:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + BOOL enabled = [[command argumentAtIndex:0] boolValue]; + CDVPluginResult* pluginResult; + [[FIRPerformance sharedInstance] setDataCollectionEnabled:enabled]; + [self setPreferenceFlag:FIREBASE_PERFORMANCE_COLLECTION_ENABLED flag:enabled]; + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)isPerformanceCollectionEnabled:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate runInBackground:^{ + @try { + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:[self getPreferenceFlag:FIREBASE_PERFORMANCE_COLLECTION_ENABLED]]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)startTrace:(CDVInvokedUrlCommand *)command { + + [self.commandDelegate runInBackground:^{ + @try { + NSString* traceName = [command.arguments objectAtIndex:0]; + FIRTrace *trace = [self.traces objectForKey:traceName]; + + if ( self.traces == nil) { + self.traces = [NSMutableDictionary new]; + } + + if (trace == nil) { + trace = [FIRPerformance startTraceWithName:traceName]; + [self.traces setObject:trace forKey:traceName ]; + + } + + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)incrementCounter:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* traceName = [command.arguments objectAtIndex:0]; + NSString* counterNamed = [command.arguments objectAtIndex:1]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + FIRTrace *trace = (FIRTrace*)[self.traces objectForKey:traceName]; + + if (trace != nil) { + [trace incrementMetric:counterNamed byInt:1]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + } else { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Trace not found"]; + } + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)stopTrace:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* traceName = [command.arguments objectAtIndex:0]; + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + FIRTrace *trace = [self.traces objectForKey:traceName]; + + if (trace != nil) { + [trace stop]; + [self.traces removeObjectForKey:traceName]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + } else { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Trace not found"]; + } + + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +/* +* Firestore +*/ + +- (void)addDocumentToFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSDictionary* document = [command.arguments objectAtIndex:0]; + NSString* collection = [command.arguments objectAtIndex:1]; + __block FIRDocumentReference *ref = + [[firestore collectionWithPath:collection] addDocumentWithData:document completion:^(NSError * _Nullable error) { + [self handleStringResultWithPotentialError:error command:command result:ref.documentID]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)setDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* documentId = [command.arguments objectAtIndex:0]; + NSDictionary* document = [command.arguments objectAtIndex:1]; + NSString* collection = [command.arguments objectAtIndex:2]; + + [[[firestore collectionWithPath:collection] documentWithPath:documentId] setData:document completion:^(NSError * _Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)updateDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* documentId = [command.arguments objectAtIndex:0]; + NSDictionary* document = [command.arguments objectAtIndex:1]; + NSString* collection = [command.arguments objectAtIndex:2]; + + FIRDocumentReference* docRef = [[firestore collectionWithPath:collection] documentWithPath:documentId]; + if(docRef != nil){ + [docRef updateData:document completion:^(NSError * _Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + }else{ + [self sendPluginErrorWithMessage:@"Document not found in collection":command]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)deleteDocumentFromFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* documentId = [command.arguments objectAtIndex:0]; + NSString* collection = [command.arguments objectAtIndex:1]; + + [[[firestore collectionWithPath:collection] documentWithPath:documentId] + deleteDocumentWithCompletion:^(NSError * _Nullable error) { + [self handleEmptyResultWithPotentialError:error command:command]; + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)documentExistsInFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* documentId = [command.arguments objectAtIndex:0]; + NSString* collection = [command.arguments objectAtIndex:1]; + + FIRDocumentReference* docRef = [[firestore collectionWithPath:collection] documentWithPath:documentId]; + if(docRef != nil){ + [docRef getDocumentWithCompletion:^(FIRDocumentSnapshot * _Nullable snapshot, NSError * _Nullable error) { + BOOL docExists = snapshot.data != nil; + [self handleBoolResultWithPotentialError:error command:command result:docExists]; + }]; + }else{ + [self sendPluginErrorWithMessage:@"Collection not found":command]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)fetchDocumentInFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* documentId = [command.arguments objectAtIndex:0]; + NSString* collection = [command.arguments objectAtIndex:1]; + + FIRDocumentReference* docRef = [[firestore collectionWithPath:collection] documentWithPath:documentId]; + if(docRef != nil){ + [docRef getDocumentWithCompletion:^(FIRDocumentSnapshot * _Nullable snapshot, NSError * _Nullable error) { + if (error != nil) { + [self sendPluginErrorWithMessage:error.localizedDescription:command]; + } else if(snapshot.data != nil) { + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:snapshot.data] callbackId:command.callbackId]; + }else{ + [self sendPluginErrorWithMessage:@"Document not found in collection":command]; + } + }]; + }else{ + [self sendPluginErrorWithMessage:@"Collection not found":command]; + } + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +- (void)fetchFirestoreCollection:(CDVInvokedUrlCommand*)command { + [self.commandDelegate runInBackground:^{ + @try { + NSString* collection = [command.arguments objectAtIndex:0]; + NSArray* filters = [command.arguments objectAtIndex:1]; + FIRQuery* query = [firestore collectionWithPath:collection]; + + for (int i = 0; i < [filters count]; i++) { + NSArray* filter = [filters objectAtIndex:i]; + if ([[filter objectAtIndex:0] isEqualToString:@"where"]) { + if ([[filter objectAtIndex:2] isEqualToString:@"=="]) { + query = [query queryWhereField:[filter objectAtIndex:1] isEqualTo:[filter objectAtIndex:3]]; + } + if ([[filter objectAtIndex:2] isEqualToString:@"<"]) { + query = [query queryWhereField:[filter objectAtIndex:1] isLessThan:[filter objectAtIndex:3]]; + } + if ([[filter objectAtIndex:2] isEqualToString:@">"]) { + query = [query queryWhereField:[filter objectAtIndex:1] isGreaterThan:[filter objectAtIndex:3]]; + } + if ([[filter objectAtIndex:2] isEqualToString:@"<="]) { + query = [query queryWhereField:[filter objectAtIndex:1] isLessThanOrEqualTo:[filter objectAtIndex:3]]; + } + if ([[filter objectAtIndex:2] isEqualToString:@">="]) { + query = [query queryWhereField:[filter objectAtIndex:1] isGreaterThanOrEqualTo:[filter objectAtIndex:3]]; + } + if ([[filter objectAtIndex:2] isEqualToString:@"array-contains"]) { + query = [query queryWhereField:[filter objectAtIndex:1] arrayContains:[filter objectAtIndex:3]]; + } + continue; + } + if ([[filter objectAtIndex:0] isEqualToString:@"orderBy"]) { + query = [query queryOrderedByField:[filter objectAtIndex:1] descending:([[filter objectAtIndex:2] isEqualToString:@"desc"])]; + continue; + } + if ([[filter objectAtIndex:0] isEqualToString:@"startAt"]) { + query = [query queryStartingAtValues:[filter objectAtIndex:1]]; + continue; + } + if ([[filter objectAtIndex:0] isEqualToString:@"endAt"]) { + query = [query queryEndingAtValues:[filter objectAtIndex:1]]; + continue; + } + if ([[filter objectAtIndex:0] isEqualToString:@"limit"]) { + query = [query queryLimitedTo:[(NSNumber *)[filter objectAtIndex:1] integerValue]]; + continue; + } + } + + [query getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot, NSError * _Nullable error) { + if (error != nil) { + [self sendPluginErrorWithMessage:error.localizedDescription:command]; + } else { + NSMutableDictionary* documents = [[NSMutableDictionary alloc] init];; + for (FIRDocumentSnapshot *document in snapshot.documents) { + [documents setObject:document.data forKey:document.documentID]; + } + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:documents] callbackId:command.callbackId]; + } + }]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } + }]; +} + +/********************************/ +#pragma mark - utility functions +/********************************/ +- (void) sendPluginSuccess:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId]; +} + +- (void) sendPluginError:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR] callbackId:command.callbackId]; +} + +- (void) sendPluginErrorWithMessage: (NSString*) errorMessage :(CDVInvokedUrlCommand*)command +{ + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage]; + [self _logError:errorMessage]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; +} + +- (void) sendPluginErrorWithError:(NSError*)error command:(CDVInvokedUrlCommand*)command{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:error.description] callbackId:command.callbackId]; +} + +- (void) handleEmptyResultWithPotentialError:(NSError*) error command:(CDVInvokedUrlCommand*)command { + if (error) { + [self sendPluginErrorWithError:error command:command]; + }else{ + [self sendPluginSuccess:command]; + } +} + +- (void) handleStringResultWithPotentialError:(NSError*) error command:(CDVInvokedUrlCommand*)command result:(NSString*)result { + if (error) { + [self sendPluginErrorWithError:error command:command]; + }else{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:result] callbackId:command.callbackId]; + } +} + +- (void) handleBoolResultWithPotentialError:(NSError*) error command:(CDVInvokedUrlCommand*)command result:(BOOL)result { + if (error) { + [self sendPluginErrorWithError:error command:command]; + }else{ + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:result] callbackId:command.callbackId]; + } +} + +- (void) handlePluginExceptionWithContext: (NSException*) exception :(CDVInvokedUrlCommand*)command +{ + [self handlePluginExceptionWithoutContext:exception]; + CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:exception.reason]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; +} + +- (void) handlePluginExceptionWithoutContext: (NSException*) exception +{ + [self _logError:[NSString stringWithFormat:@"EXCEPTION: %@", exception.reason]]; +} + +- (void)executeGlobalJavascript: (NSString*)jsString +{ + [self.commandDelegate evalJs:jsString]; +} + +- (void)_logError: (NSString*)msg +{ + NSLog(@"%@ ERROR: %@", LOG_TAG, msg); + NSString* jsString = [NSString stringWithFormat:@"console.error(\"%@: %@\")", LOG_TAG, [self escapeJavascriptString:msg]]; + [self executeGlobalJavascript:jsString]; +} + +- (void)_logInfo: (NSString*)msg +{ + NSLog(@"%@ INFO: %@", LOG_TAG, msg); + NSString* jsString = [NSString stringWithFormat:@"console.info(\"%@: %@\")", LOG_TAG, [self escapeJavascriptString:msg]]; + [self executeGlobalJavascript:jsString]; +} + +- (void)_logMessage: (NSString*)msg +{ + NSLog(@"%@ LOG: %@", LOG_TAG, msg); + NSString* jsString = [NSString stringWithFormat:@"console.log(\"%@: %@\")", LOG_TAG, [self escapeJavascriptString:msg]]; + [self executeGlobalJavascript:jsString]; +} + +- (NSString*)escapeJavascriptString: (NSString*)str +{ + NSString* result = [str stringByReplacingOccurrencesOfString: @"\\\"" withString: @"\""]; + result = [result stringByReplacingOccurrencesOfString: @"\"" withString: @"\\\""]; + result = [result stringByReplacingOccurrencesOfString: @"\n" withString: @"\\\n"]; + return result; +} + +- (void)runOnMainThread:(void (^)(void))completeBlock { + if (![NSThread isMainThread]) { + dispatch_sync(dispatch_get_main_queue(), ^{ + @try { + completeBlock(); + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } + }); + } else { + @try { + completeBlock(); + }@catch (NSException *exception) { + [self handlePluginExceptionWithoutContext:exception]; + } + } +} + +- (FIRAuthCredential*)obtainAuthCredential:(NSDictionary*)credential command:(CDVInvokedUrlCommand *)command { + FIRAuthCredential* authCredential = nil; + + if(credential == nil){ + NSString* errMsg = @"credential object must be passed as first and only argument"; + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errMsg] callbackId:command.callbackId]; + return authCredential; + } + + NSString* key = [credential objectForKey:@"id"]; + NSString* verificationId = [credential objectForKey:@"verificationId"]; + NSString* code = [credential objectForKey:@"code"]; + + if(key != nil){ + authCredential = [authCredentials objectForKey:key]; + if(authCredential == nil){ + NSString* errMsg = [NSString stringWithFormat:@"no native auth credential exists for specified id '%@'", key]; + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errMsg] callbackId:command.callbackId]; + } + }else if(verificationId != nil && code != nil){ + authCredential = [[FIRPhoneAuthProvider provider] + credentialWithVerificationID:verificationId + verificationCode:code]; + }else{ + NSString* errMsg = @"credential object must either specify the id key of an existing native auth credential or the verificationId/code keys must be specified for a phone number authentication"; + [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errMsg] callbackId:command.callbackId]; + } + + return authCredential; +} + +- (void) handleAuthResult:(FIRAuthDataResult*) authResult error:(NSError*) error command:(CDVInvokedUrlCommand*)command { + @try { + CDVPluginResult* pluginResult; + if (error) { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:error.description]; + }else if (authResult == nil) { + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"User not signed in"]; + }else{ + pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + } + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }@catch (NSException *exception) { + [self handlePluginExceptionWithContext:exception :command]; + } +} + +- (int) saveAuthCredential: (FIRAuthCredential*) authCredential { + int key = -1; + while (key < 0 || [authCredentials objectForKey:[NSNumber numberWithInt:key]] != nil) { + key = arc4random_uniform(100000); + } + + [authCredentials setObject:authCredential forKey:[NSNumber numberWithInt:key]]; + + return key; +} + +- (void) setPreferenceFlag:(NSString*) name flag:(BOOL)flag { + [preferences setBool:flag forKey:name]; + [preferences synchronize]; +} + +- (BOOL) getPreferenceFlag:(NSString*) name { + if([preferences objectForKey:name] == nil){ + return false; + } + return [preferences boolForKey:name]; +} + +- (BOOL) getGooglePlistFlagWithDefaultValue:(NSString*) name defaultValue:(BOOL)defaultValue { + if([googlePlist objectForKey:name] == nil){ + return defaultValue; + } + return [[googlePlist objectForKey:name] isEqualToString:@"true"]; +} + + +# pragma mark - Stubs +- (void)createChannel:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }]; +} + +- (void)setDefaultChannel:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }]; +} + +- (void)deleteChannel:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }]; +} + +- (void)listChannels:(CDVInvokedUrlCommand *)command { + [self.commandDelegate runInBackground:^{ + CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; + [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId]; + }]; +} +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.h b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.h new file mode 100644 index 00000000..639de9ba --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.h @@ -0,0 +1,5 @@ +#import <Foundation/Foundation.h> + +@interface FirebasePluginMessageReceiver : NSObject {} +- (bool) sendNotification:(NSDictionary *)userInfo; +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.m b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.m new file mode 100644 index 00000000..0990d8c1 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiver.m @@ -0,0 +1,17 @@ +#import "FirebasePluginMessageReceiver.h" +#import "FirebasePluginMessageReceiverManager.h" + +@implementation FirebasePluginMessageReceiver + +- (id) init { + [FirebasePluginMessageReceiverManager register:self]; + return self; +} + +// Concrete subclasses should override this and return true if they handle the received message. +- (bool) sendNotification:(NSDictionary *)userInfo { + NSAssert(false, @"You cannot call sendNotification on the FirebasePluginMessageReceiver class directly. Instead, you must override it using a subclass."); + return false; +} + +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.h b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.h new file mode 100644 index 00000000..96dac9d8 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.h @@ -0,0 +1,6 @@ +#import "FirebasePluginMessageReceiver.h" + +@interface FirebasePluginMessageReceiverManager ++ (void) register:(FirebasePluginMessageReceiver *)receiver; ++ (bool) sendNotification:(NSDictionary *)userInfo; +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.m b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.m new file mode 100644 index 00000000..7d463265 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/FirebasePluginMessageReceiverManager.m @@ -0,0 +1,24 @@ +#import "FirebasePluginMessageReceiverManager.h" + +@implementation FirebasePluginMessageReceiverManager + +static NSMutableArray* receivers; + ++ (void) register:(FirebasePluginMessageReceiver*)receiver { + if(receivers == nil){ + receivers = [[NSMutableArray alloc] init]; + } + [receivers addObject:receiver]; +} + ++ (bool) sendNotification:(NSDictionary *)userInfo { + bool handled = false; + for(FirebasePluginMessageReceiver* receiver in receivers){ + bool wasHandled = [receiver sendNotification:userInfo]; + if(wasHandled){ + handled = true; + } + } + return handled; +} +@end diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/GoogleService-Info.plist b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/GoogleService-Info.plist new file mode 100644 index 00000000..5516ebf3 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/src/ios/GoogleService-Info.plist @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> +</dict> +</plist>
\ No newline at end of file diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/types/index.d.ts b/StoneIsland/plugins/cordova-plugin-firebasex/types/index.d.ts new file mode 100644 index 00000000..6dd26472 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/types/index.d.ts @@ -0,0 +1,315 @@ +interface IChannelOptions { + id: string + name?: string + description?: string + sound?: string + vibration?: boolean | number[] + light?: boolean + lightColor?: string + importance?: 0 | 1 | 2 | 3 | 4 + badge?: boolean + visibility?: -1 | 0 | 1 +} + +interface FirebasePlugin { + getId( + success: (value: string) => void, + error: (err: string) => void + ): void + getToken( + success: (value: string) => void, + error: (err: string) => void + ): void + onTokenRefresh( + success: (value: string) => void, + error: (err: string) => void): void + getAPNSToken( + success: (value: string) => void, + error: (err: string) => void + ): void + onApnsTokenReceived( + success: (value: string) => void, + error: (err: string) => void + ): void + onMessageReceived( + success: (value: object) => void, + error: (err: string) => void + ): void + grantPermission( + success: (value: boolean) => void, + error: (err: string) => void + ): void + hasPermission( + success: (value: boolean) => void, + error: (err: string) => void + ): void + unregister(): void + setBadgeNumber( + badgeNumber: number + ): void + getBadgeNumber( + success: (badgeNumber: number) => void, + error: (err: string) => void + ): void + clearAllNotifications(): void + subscribe( + topic: string, + success?: () => void, + error?: (err: string) => void + ): void + unsubscribe( + topic: string, + success?: () => void, + error?: (err: string) => void + ): void + isAutoInitEnabled( + success: (enabled: boolean) => void, + error?: (err: string) => void + ): void + setAutoInitEnabled( + enabled: boolean, + success?: () => void, + error?: (err: string) => void + ): void + createChannel( + channel: IChannelOptions, + success: () => void, + error: (err: string) => void + ): void + setDefaultChannel( + channel: IChannelOptions, + success: () => void, + error: (err: string) => void + ): void + deleteChannel( + channel: string, + success: () => void, + error: (err: string) => void + ): void + listChannels( + success: (list: { id: string; name: string }[]) => void, + error: (err: string) => void + ): void + setAnalyticsCollectionEnabled( + setEnabled: boolean + ): void + logEvent( + eventName: string, + eventProperties: object + ): void + setScreenName( + screenName: string + ): void + setUserId( + userId: string + ): void + setUserProperty( + userName: string, + userValue: string + ): void + setCrashlyticsCollectionEnabled(): void + setCrashlyticsUserId( + userId: string + ): void + sendCrash(): void + logMessage( + message: string + ): void + logError( + errorMessage: string, + stackTrace?: object, + success?: () => void, + error?: (err: string) => void + ): void + verifyPhoneNumber( + success: (value: object) => void, + error: (err: string) => void, + phoneNumber: string, + timeOutDuration: number, + fakeVerificationCode?: string + ): void + createUserWithEmailAndPassword( + email: string, + password: string, + success?: () => void, + error?: (err: string) => void + ): void + signInUserWithEmailAndPassword( + email: string, + password: string, + success?: () => void, + error?: (err: string) => void + ): void + signInUserWithCustomToken( + customToken: string, + success?: () => void, + error?: (err: string) => void + ): void + signInUserAnonymously( + success?: () => void, + error?: (err: string) => void + ): void + authenticateUserWithGoogle( + clientId: string, + success?: () => void, + error?: (err: string) => void + ): void + authenticateUserWithApple( + success?: () => void, + error?: (err: string) => void, + locale?: string, + ): void + signInWithCredential( + credential: object, + success?: () => void, + error?: (err: string) => void + ): void + linkUserWithCredential( + credential: object, + success?: () => void, + error?: (err: string) => void + ): void + reauthenticateWithCredential( + credential: object, + success?: () => void, + error?: (err: string) => void + ): void + isUserSignedIn( + success: (isSignedIn: boolean) => void, + error?: (err: string) => void + ): void + signOutUser( + success?: () => void, + error?: (err: string) => void + ): void + getCurrentUser( + success: (user: object) => void, + error?: (err: string) => void + ): void + updateUserProfile( + profile: { + name: string, + photoUri: string + }, + success?: () => void, + error?: (err: string) => void + ): void + updateUserEmail( + email: string, + success?: () => void, + error?: (err: string) => void + ): void + sendUserEmailVerification( + success?: () => void, + error?: (err: string) => void + ): void + updateUserPassword( + password: string, + success?: () => void, + error?: (err: string) => void + ): void + sendUserPasswordResetEmail( + email: string, + success?: () => void, + error?: (err: string) => void + ): void + deleteUser( + success?: () => void, + error?: (err: string) => void + ): void + registerAuthStateChangeListener( + fn: (userSignedIn: boolean) => void, + ): void + fetch( + cacheExpirationSeconds: number, + success: () => void, + error: (err: string) => void + ): void + fetch( + success: () => void, + error: (err: string) => void + ): void + activateFetched( + success: (activated: boolean) => void, + error: (err: string) => void + ): void + getValue( + key: string, + success: (value: string) => void, + error: (err: string) => void + ): void + getByteArray( + key: string, + success: (value: object) => void, + error: (err: string) => void + ): void + getInfo( + success: (info: object) => void, + error: (err: string) => void + ): void + setConfigSettings( + configSettings: object, + success: (info: object) => void, + error: (err: string) => void + ): void + setDefaults( + defaultSettings: object, + success: (info: object) => void, + error: (err: string) => void + ): void + setPerformanceCollectionEnabled( + setEnabled: boolean + ): void + startTrace( + name: string, + success: () => void, + error: (err: string) => void + ): void + incrementCounter( + name: string, + counterName: string, + success: () => void, + error: (err: string) => void + ): void + stopTrace( + name: string + ): void + addDocumentToFirestoreCollection( + document: object, + collection: string, + success: () => void, + error: (err: string) => void + ): void + setDocumentInFirestoreCollection( + documentId: string, + document: object, + collection: string, + success: () => void, + error: (err: string) => void + ): void + updateDocumentInFirestoreCollection( + documentId: string, + document: object, + collection: string, + success: () => void, + error: (err: string) => void + ): void + deleteDocumentFromFirestoreCollection( + documentId: string, + collection: string, + success: () => void, + error: (err: string) => void + ): void + fetchDocumentInFirestoreCollection( + documentId: string, + collection: string, + success: (document: object) => void, + error: (err: string) => void + ): void + fetchFirestoreCollection( + collection: string, + success: (collection: object) => void, + error: (err: string) => void + ): void +} +declare var FirebasePlugin: FirebasePlugin; diff --git a/StoneIsland/plugins/cordova-plugin-firebasex/www/firebase.js b/StoneIsland/plugins/cordova-plugin-firebasex/www/firebase.js new file mode 100644 index 00000000..ac2e2d75 --- /dev/null +++ b/StoneIsland/plugins/cordova-plugin-firebasex/www/firebase.js @@ -0,0 +1,385 @@ +var exec = require('cordova/exec'); + +var ensureBooleanFn = function (callback){ + return function(result){ + callback(ensureBoolean(result)); + } +}; + +var ensureBoolean = function(value){ + if(value === "true"){ + value = true; + }else if(value === "false"){ + value = false; + } + return !!value; +}; + +var onAuthStateChangeCallback = function(){}; + +/*********************** + * Protected internals + ***********************/ +exports._onAuthStateChange = function(userSignedIn){ + onAuthStateChangeCallback(userSignedIn); +}; + +/************** + * Public API + **************/ + +// Notifications +exports.getId = function (success, error) { + exec(success, error, "FirebasePlugin", "getId", []); +}; + +exports.getToken = function (success, error) { + exec(success, error, "FirebasePlugin", "getToken", []); +}; + +exports.getAPNSToken = function (success, error) { + exec(success, error, "FirebasePlugin", "getAPNSToken", []); +}; + +exports.onMessageReceived = function (success, error) { + exec(success, error, "FirebasePlugin", "onMessageReceived", []); +}; + +exports.onTokenRefresh = function (success, error) { + exec(success, error, "FirebasePlugin", "onTokenRefresh", []); +}; + +exports.onApnsTokenReceived = function (success, error) { + exec(success, error, "FirebasePlugin", "onApnsTokenReceived", []); +}; + +exports.subscribe = function (topic, success, error) { + exec(success, error, "FirebasePlugin", "subscribe", [topic]); +}; + +exports.unsubscribe = function (topic, success, error) { + exec(success, error, "FirebasePlugin", "unsubscribe", [topic]); +}; + +exports.unregister = function (success, error) { + exec(success, error, "FirebasePlugin", "unregister", []); +}; + +exports.isAutoInitEnabled = function (success, error) { + exec(success, error, "FirebasePlugin", "isAutoInitEnabled", []); +}; + +exports.setAutoInitEnabled = function (enabled, success, error) { + exec(success, error, "FirebasePlugin", "setAutoInitEnabled", [!!enabled]); +}; + +// Notifications - iOS-only +exports.setBadgeNumber = function (number, success, error) { + exec(success, error, "FirebasePlugin", "setBadgeNumber", [number]); +}; + +exports.getBadgeNumber = function (success, error) { + exec(success, error, "FirebasePlugin", "getBadgeNumber", []); +}; + +exports.grantPermission = function (success, error) { + exec(ensureBooleanFn(success), error, "FirebasePlugin", "grantPermission", []); +}; + +exports.hasPermission = function (success, error) { + exec(ensureBooleanFn(success), error, "FirebasePlugin", "hasPermission", []); +}; + +// Notifications - Android-only +exports.setDefaultChannel = function (options, success, error) { + exec(success, error, "FirebasePlugin", "setDefaultChannel", [options]); +}; + +exports.createChannel = function (options, success, error) { + exec(success, error, "FirebasePlugin", "createChannel", [options]); +}; + +exports.deleteChannel = function (channelID, success, error) { + exec(success, error, "FirebasePlugin", "deleteChannel", [channelID]); +}; + +exports.listChannels = function (success, error) { + exec(success, error, "FirebasePlugin", "listChannels", []); +}; + +// Analytics +exports.setAnalyticsCollectionEnabled = function (enabled, success, error) { + exec(success, error, "FirebasePlugin", "setAnalyticsCollectionEnabled", [!!enabled]); +}; + +exports.isAnalyticsCollectionEnabled = function (success, error) { + exec(success, error, "FirebasePlugin", "isAnalyticsCollectionEnabled", []); +}; + +exports.logEvent = function (name, params, success, error) { + exec(success, error, "FirebasePlugin", "logEvent", [name, params]); +}; + +exports.setScreenName = function (name, success, error) { + exec(success, error, "FirebasePlugin", "setScreenName", [name]); +}; + +exports.setUserId = function (id, success, error) { + exec(success, error, "FirebasePlugin", "setUserId", [id]); +}; + +exports.setUserProperty = function (name, value, success, error) { + exec(success, error, "FirebasePlugin", "setUserProperty", [name, value]); +}; + +exports.activateFetched = function (success, error) { + exec(ensureBooleanFn(success), error, "FirebasePlugin", "activateFetched", []); +}; + +exports.fetch = function (cacheExpirationSeconds, success, error) { + var args = []; + if (typeof cacheExpirationSeconds === 'number') { + args.push(cacheExpirationSeconds); + } else { + error = success; + success = cacheExpirationSeconds; + } + exec(success, error, "FirebasePlugin", "fetch", args); +}; + +exports.getByteArray = function (key, success, error) { + exec(success, error, "FirebasePlugin", "getByteArray", [key]); +}; + +exports.getValue = function (key, success, error) { + exec(success, error, "FirebasePlugin", "getValue", [key]); +}; + +exports.getInfo = function (success, error) { + exec(success, error, "FirebasePlugin", "getInfo", []); +}; + +exports.setConfigSettings = function (settings, success, error) { + exec(success, error, "FirebasePlugin", "setConfigSettings", [settings]); +}; + +exports.setDefaults = function (defaults, success, error) { + exec(success, error, "FirebasePlugin", "setDefaults", [defaults]); +}; + +exports.startTrace = function (name, success, error) { + exec(success, error, "FirebasePlugin", "startTrace", [name]); +}; + +exports.incrementCounter = function (name, counterNamed, success, error) { + exec(success, error, "FirebasePlugin", "incrementCounter", [name, counterNamed]); +}; + +exports.stopTrace = function (name, success, error) { + exec(success, error, "FirebasePlugin", "stopTrace", [name]); +}; + +exports.setPerformanceCollectionEnabled = function (enabled, success, error) { + exec(success, error, "FirebasePlugin", "setPerformanceCollectionEnabled", [!!enabled]); +}; + +exports.isPerformanceCollectionEnabled = function (success, error) { + exec(success, error, "FirebasePlugin", "isPerformanceCollectionEnabled", []); +}; + +exports.clearAllNotifications = function (success, error) { + exec(success, error, "FirebasePlugin", "clearAllNotifications", []); +}; + + +// Crashlytics +exports.setCrashlyticsCollectionEnabled = function (enabled, success, error) { + exec(success, error, "FirebasePlugin", "setCrashlyticsCollectionEnabled", [!!enabled]); +}; + +exports.isCrashlyticsCollectionEnabled = function (success, error) { + exec(success, error, "FirebasePlugin", "isCrashlyticsCollectionEnabled", []); +}; + +exports.logMessage = function (message, success, error) { + exec(success, error, "FirebasePlugin", "logMessage", [message]); +}; + +exports.sendCrash = function (success, error) { + exec(success, error, "FirebasePlugin", "sendCrash", []); +}; + +exports.logError = function (message, stackTrace, success, error) { + var args = [message]; + // "stackTrace" is an optional arg that's an array of objects. + if (stackTrace) { + if (typeof stackTrace === 'function') { + error = success; + success = stackTrace; + } else { + args.push(stackTrace); + } + } + exec(success, error, "FirebasePlugin", "logError", args); +}; + +exports.setCrashlyticsUserId = function (userId, success, error) { + exec(success, error, "FirebasePlugin", "setCrashlyticsUserId", [userId]); +}; + + +// Authentication +exports.verifyPhoneNumber = function (success, error, number, timeOutDuration, fakeVerificationCode) { + exec(function(credential){ + if(typeof credential === 'object'){ + credential.instantVerification = ensureBoolean(credential.instantVerification); + } + success(credential); + }, error, "FirebasePlugin", "verifyPhoneNumber", [number, timeOutDuration, fakeVerificationCode]); +}; + +exports.createUserWithEmailAndPassword = function (email, password, success, error) { + exec(success, error, "FirebasePlugin", "createUserWithEmailAndPassword", [email, password]); +}; + +exports.signInUserWithEmailAndPassword = function (email, password, success, error) { + exec(success, error, "FirebasePlugin", "signInUserWithEmailAndPassword", [email, password]); +}; + +exports.signInUserWithCustomToken = function (customToken, success, error) { + exec(success, error, "FirebasePlugin", "signInUserWithCustomToken", [customToken]); +}; + +exports.signInUserAnonymously = function (success, error) { + exec(success, error, "FirebasePlugin", "signInUserAnonymously"); +}; + +exports.authenticateUserWithGoogle = function (clientId, success, error) { + exec(success, error, "FirebasePlugin", "authenticateUserWithGoogle", [clientId]); +}; + +exports.authenticateUserWithApple = function (success, error, locale) { + exec(success, error, "FirebasePlugin", "authenticateUserWithApple", [locale]); +}; + +exports.signInWithCredential = function (credential, success, error) { + if(typeof credential !== 'object') return error("'credential' must be an object"); + exec(success, error, "FirebasePlugin", "signInWithCredential", [credential]); +}; + +exports.linkUserWithCredential = function (credential, success, error) { + if(typeof credential !== 'object') return error("'credential' must be an object"); + exec(success, error, "FirebasePlugin", "linkUserWithCredential", [credential]); +}; + +exports.reauthenticateWithCredential = function (credential, success, error) { + if(typeof credential !== 'object') return error("'credential' must be an object"); + exec(success, error, "FirebasePlugin", "reauthenticateWithCredential", [credential]); +}; + +exports.isUserSignedIn = function (success, error) { + exec(ensureBooleanFn(success), error, "FirebasePlugin", "isUserSignedIn", []); +}; + +exports.signOutUser = function (success, error) { + exec(ensureBooleanFn(success), error, "FirebasePlugin", "signOutUser", []); +}; + + +exports.getCurrentUser = function (success, error) { + exec(function(user){ + user.emailIsVerified = ensureBoolean(user.emailIsVerified); + success(user); + }, error, "FirebasePlugin", "getCurrentUser", []); +}; + +exports.reloadCurrentUser = function (success, error) { + exec(function(user){ + user.emailIsVerified = ensureBoolean(user.emailIsVerified); + success(user); + }, error, "FirebasePlugin", "reloadCurrentUser", []); +}; + +exports.updateUserProfile = function (profile, success, error) { + if(typeof profile !== 'object') return error("'profile' must be an object with keys 'name' and/or 'photoUri'"); + exec(success, error, "FirebasePlugin", "updateUserProfile", [profile]); +}; + +exports.updateUserEmail = function (email, success, error) { + if(typeof email !== 'string' || !email) return error("'email' must be a valid email address"); + exec(success, error, "FirebasePlugin", "updateUserEmail", [email]); +}; + +exports.sendUserEmailVerification = function (success, error) { + exec(success, error, "FirebasePlugin", "sendUserEmailVerification", []); +}; + +exports.updateUserPassword = function (password, success, error) { + if(typeof password !== 'string' || !password) return error("'password' must be a valid string"); + exec(success, error, "FirebasePlugin", "updateUserPassword", [password]); +}; + +exports.sendUserPasswordResetEmail = function (email, success, error) { + if(typeof email !== 'string' || !email) return error("'email' must be a valid email address"); + exec(success, error, "FirebasePlugin", "sendUserPasswordResetEmail", [email]); +}; + +exports.deleteUser = function (success, error) { + exec(success, error, "FirebasePlugin", "deleteUser", []); +}; + +exports.registerAuthStateChangeListener = function(fn){ + if(typeof fn !== "function") throw "The specified argument must be a function"; + onAuthStateChangeCallback = fn; +}; + +// Firestore +exports.addDocumentToFirestoreCollection = function (document, collection, success, error) { + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + if(typeof document !== 'object' || typeof document.length === 'number') return error("'document' must be an object specifying record data"); + + exec(success, error, "FirebasePlugin", "addDocumentToFirestoreCollection", [document, collection]); +}; + +exports.setDocumentInFirestoreCollection = function (documentId, document, collection, success, error) { + if(typeof documentId !== 'string' && typeof documentId !== 'number') return error("'documentId' must be a string or number specifying the Firestore document identifier"); + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + if(typeof document !== 'object' || typeof document.length === 'number') return error("'document' must be an object specifying record data"); + + exec(success, error, "FirebasePlugin", "setDocumentInFirestoreCollection", [documentId.toString(), document, collection]); +}; + +exports.updateDocumentInFirestoreCollection = function (documentId, document, collection, success, error) { + if(typeof documentId !== 'string' && typeof documentId !== 'number') return error("'documentId' must be a string or number specifying the Firestore document identifier"); + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + if(typeof document !== 'object' || typeof document.length === 'number') return error("'document' must be an object specifying record data"); + + exec(success, error, "FirebasePlugin", "updateDocumentInFirestoreCollection", [documentId.toString(), document, collection]); +}; + +exports.deleteDocumentFromFirestoreCollection = function (documentId, collection, success, error) { + if(typeof documentId !== 'string' && typeof documentId !== 'number') return error("'documentId' must be a string or number specifying the Firestore document identifier"); + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + + exec(success, error, "FirebasePlugin", "deleteDocumentFromFirestoreCollection", [documentId.toString(), collection]); +}; + +exports.documentExistsInFirestoreCollection = function (documentId, collection, success, error) { + if(typeof documentId !== 'string' && typeof documentId !== 'number') return error("'documentId' must be a string or number specifying the Firestore document identifier"); + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + + exec(ensureBooleanFn(success), error, "FirebasePlugin", "documentExistsInFirestoreCollection", [documentId.toString(), collection]); +}; + +exports.fetchDocumentInFirestoreCollection = function (documentId, collection, success, error) { + if(typeof documentId !== 'string' && typeof documentId !== 'number') return error("'documentId' must be a string or number specifying the Firestore document identifier"); + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + + exec(success, error, "FirebasePlugin", "fetchDocumentInFirestoreCollection", [documentId.toString(), collection]); +}; + +exports.fetchFirestoreCollection = function (collection, filters, success, error) { + if(typeof collection !== 'string') return error("'collection' must be a string specifying the Firestore collection name"); + if(filters && (typeof filters !== 'object' || typeof filters.length === 'undefined')) return error("'filters' must be a array specifying a list of filters to apply to documents in the Firestore collection"); + exec(success, error, "FirebasePlugin", "fetchFirestoreCollection", [collection, filters || []]); +}; |