-[Firebase iOS SDK Changelog](https://firebase.google.com/support/release-notes/ios)
-[Firebase Android SDK Changelog](https://firebase.google.com/support/release-notes/android)
+- [Firebase iOS SDK Changelog](https://firebase.google.com/support/release-notes/ios)
+- [Firebase Android SDK Changelog](https://firebase.google.com/support/release-notes/android)
+
+## 10.4.0 (2020, Feb 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/122?closed=1)
+
+> Make sure to run a `pod repo update` on your dev machine, because this version includes the latest Firebase iOS (and Android) SDKs.
+
+## 10.3.3 (2019, Dec 24)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/121?closed=1)
+
+
+## 10.3.2 (2019, Dec 11)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/120?closed=1)
+
+
+## 10.3.1 (2019, Dec 6)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/119?closed=1)
+
+
+## 10.3.0 (2019, Dec 2)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/118?closed=1)
+
+
+## 10.2.1 (2019, Nov 26)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/117?closed=1)
+
+
+## 10.2.0 (2019, Nov 18)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/116?closed=1)
+
+
+## 10.1.1 (2019, Oct 29)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/114?closed=1)
+
+
+## 10.1.0 (2019, Oct 18)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/113?closed=1)
+
+
+## 10.0.2 (2019, Oct 16)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/112?closed=1)
+
+
+## 10.0.1 (2019, Sep 30)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/111?closed=1)
+
+
+## 10.0.0 (2019, Sep 17)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/109?closed=1)
+
+> Make sure to run a `pod repo update` on your dev machine, because this version includes the latest Firebase iOS (and Android) SDKs.
+
+> This version requires a minimum version of NativeScript 5.2. For MLKit features on iOS it's recommended to use a minimum `tns-ios` version of 6.1.0, otherwise you may run into build issues.
+
+
+## 9.1.1 (2019, Aug 27)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/110?closed=1)
+
+
+## 9.1.0 (2019, Aug 19)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/104?closed=1)
+
+> Make sure to run a `pod repo update` on your dev machine, because this version includes the latest Firebase iOS (and Android) SDKs.
+
+
+## 9.0.4 (2019, July 22)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/108?closed=1)
+
+
+## 9.0.3 (2019, July 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/107?closed=1)
+
+
+## 9.0.2 (2019, July 9)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/106?closed=1)
+
+
+## 9.0.1 (2019, June 18)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/105?closed=1)
+
+
+## 9.0.0 (2019, June 18)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/103?closed=1)
+
+#### BREAKING CHANGES
+
+> `fetchProvidersForEmail` has been removed - use `fetchSignInMethodsForEmail` instead.
+
+> Firebase Invites has been removed - use Dynamic Links instead! Also see https://firebase.google.com/docs/invites/deprecation and https://firebase.google.com/docs/dynamic-links/use-cases/user-to-user
+
+> Firebase crash reporting has been removed from the SDKs. Use Crashlytics instead. This also means `firebase.sendCrashLog` is gone. Use `firebase.crashlytics.sendCrashLog()` instead.
+
+> If you're on NativeScript < 5.2 and target iOS, then it's recommended to stick with a plugin version < 9.0.0 because you _may_ run into incompatibilities with certain features.
+
+> Also, make sure to run a `pod repo update` on your dev machine, because this version includes the latest Firebase iOS SDKs.
+
+## 8.3.2 (2019, May 14)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/101?closed=1)
+
+
+## 8.3.1 (2019, May 7)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/102?closed=1)
+
+
+## 8.3.0 (2019, May 2)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/100?closed=1)
+
+
+## 8.2.1 (2019, April 17)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/99?closed=1)
+
+
+## 8.2.0 (2019, April 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/98?closed=1)
+
+> Note: The Firebase iOS SDK now requires Xcode 10.1 or later.
+
+> Also note that there's a little breaking change that's easy to fix: the `name` and `profileImageURL` properties of the login result object have new names: `displayName` and `photoURL` respectively.
+
+## 8.1.1 (2019, March 24)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/97?closed=1)
+
+
+## 8.1.0 (2019, March 24)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/96?closed=1)
+
+
+## 8.0.1 (2019, March 16)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/95?closed=1)
+
+
+## 8.0.0 (2019, February 26)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/94?closed=1)
+
+### BREAKING CHANGES
+- `getAuthToken` no longer returns a token (`string`), but an `GetAuthTokenResult` object which contains more data. See #1008.
+- For better alignment with the Web API, `changePassword` is now `updatePassword`, `resetPassword` is now `sendPasswordResetEmail`. See #1080.
+
+
+## 7.7.0 (2019, January 20)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/92?closed=1)
+
+
+## 7.6.1 (2019, January 8)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/91?closed=1)
+
+
+## 7.6.0 (2018, December 21)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/90?closed=1)
+
+
+## 7.5.1 (2018, December 15)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/89?closed=1)
+
+
+## 7.5.0 (2018, December 15)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/88?closed=1)
+
+
+## 7.4.6 (2018, December 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/87?closed=1)
+
+
+## 7.4.5 (2018, December 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/86?closed=1)
+
+
+## 7.4.4 (2018, December 8)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/85?closed=1)
+
+
+## 7.4.3 (2018, December 3)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/84?closed=1)
+
+
+## 7.4.2 (2018, November 16)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/83?closed=1)
+
+
+## 7.4.1 (2018, November 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/82?closed=1)
+
+
+## 7.4.0 (2018, November 9)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/81?closed=1)
+
+
+## 7.3.0 (2018, October 24)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/80?closed=1)
+
+
+## 7.2.0 (2018, October 19)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/79?closed=1)
+
+
+## 7.1.6 (2018, October 12)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/78?closed=1)
+
+
+## 7.1.5 (2018, October 10)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/77?closed=1)
+
+
+## 7.1.4 (2018, October 9)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/76?closed=1)
+
+
+## 7.1.3 (2018, October 8)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/75?closed=1)
+
+
+## 7.1.2 (2018, October 2)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/74?closed=1)
+
+
+## 7.1.1 (2018, September 30)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/73?closed=1)
+
+
+## 7.1.0 (2018, September 26)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/72?closed=1)
+
+
+## 7.0.1 (2018, September 21)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/71?closed=1)
+
+
+## 7.0.0 (2018, September 19)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/70?closed=1)
+
## 6.8.1 (2018, September 14)
[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/69?closed=1)
diff --git a/README.md b/README.md
index a898bb6f..1d41d78f 100755
--- a/README.md
+++ b/README.md
@@ -1,31 +1,33 @@
# NativeScript Firebase plugin
+
+
+
+
diff --git a/demo/hosting/public/index.html b/demo/hosting/public/index.html
new file mode 100644
index 00000000..e65858eb
--- /dev/null
+++ b/demo/hosting/public/index.html
@@ -0,0 +1,23 @@
+
+
+
+
+
+ 404
+Page Not Found
+The specified file was not found on this website. Please check the URL for mistakes and try again.
+Why am I seeing this?
+This page was generated by the Firebase Command-Line Interface. To modify it, edit the 404.html file in your project's configured public directory.
+ 
+
+ Open Hosting Documentation
+
+
+
\ No newline at end of file
diff --git a/demo/hosting/public/media/NativeScript_logo.png b/demo/hosting/public/media/NativeScript_logo.png
new file mode 100644
index 00000000..82450946
Binary files /dev/null and b/demo/hosting/public/media/NativeScript_logo.png differ
diff --git a/demo/karma.conf.js b/demo/karma.conf.js
index 35132146..79746027 100644
--- a/demo/karma.conf.js
+++ b/demo/karma.conf.js
@@ -1,5 +1,5 @@
module.exports = function (config) {
- config.set({
+ const options = {
// base path that will be used to resolve all patterns (eg. files, exclude)
basePath: '',
@@ -11,18 +11,18 @@ module.exports = function (config) {
// list of files / patterns to load in the browser
- files: [
- 'app/**/*.js'
- ],
+ files: ['app/tests/**/*.*'],
// list of files to exclude
- exclude: [],
+ exclude: [
+ ],
// preprocess matching files before serving them to the browser
// available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
- preprocessors: {},
+ preprocessors: {
+ },
// test results reporter to use
@@ -70,6 +70,39 @@ module.exports = function (config) {
// Continuous Integration mode
// if true, Karma captures browsers, runs the tests and exits
- singleRun: true
- });
-};
+ singleRun: false
+ };
+
+ setWebpackPreprocessor(config, options);
+ setWebpack(config, options);
+
+ config.set(options);
+}
+
+function setWebpackPreprocessor(config, options) {
+ if (config && config.bundle) {
+ if (!options.preprocessors) {
+ options.preprocessors = {};
+ }
+
+ options.files.forEach(file => {
+ if (!options.preprocessors[file]) {
+ options.preprocessors[file] = [];
+ }
+ options.preprocessors[file].push('webpack');
+ });
+ }
+}
+
+function setWebpack(config, options) {
+ if (config && config.bundle) {
+ const env = {};
+ env[config.platform] = true;
+ env.sourceMap = config.debugBrk;
+ options.webpack = require('./webpack.config')(env);
+ delete options.webpack.entry;
+ delete options.webpack.output.libraryTarget;
+ const invalidPluginsForUnitTesting = ["GenerateBundleStarterPlugin", "GenerateNativeScriptEntryPointsPlugin"];
+ options.webpack.plugins = options.webpack.plugins.filter(p => !invalidPluginsForUnitTesting.includes(p.constructor.name));
+ }
+}
diff --git a/demo/nativescript.config.ts b/demo/nativescript.config.ts
new file mode 100644
index 00000000..7c68e182
--- /dev/null
+++ b/demo/nativescript.config.ts
@@ -0,0 +1,12 @@
+import { NativeScriptConfig } from '@nativescript/core'
+
+export default {
+ id: 'org.nativescript.firebasedemo',
+ appResourcesPath: 'app_resources',
+ android: {
+ v8Flags: '--expose_gc',
+ markingMode: 'none',
+ },
+ discardUncaughtJsExceptions: false,
+ appPath: 'app',
+} as NativeScriptConfig
diff --git a/demo/nsconfig.json b/demo/nsconfig.json
deleted file mode 100644
index d2b232c9..00000000
--- a/demo/nsconfig.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "appPath": "app",
- "appResourcesPath": "app_resources"
-}
diff --git a/demo/package.json b/demo/package.json
index b52d420e..6be11157 100644
--- a/demo/package.json
+++ b/demo/package.json
@@ -1,51 +1,32 @@
{
- "nativescript": {
- "id": "org.nativescript.firebasedemo",
- "tns-ios": {
- "version": "4.2.0"
- },
- "tns-android": {
- "version": "4.2.0"
- }
- },
"dependencies": {
- "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-6.8.1.tgz",
- "nativescript-theme-core": "^1.0.4",
- "nativescript-unit-test-runner": "^0.3.4",
- "tns-core-modules": "~4.2.0"
+ "@nativescript/core": "~7.0.13",
+ "@nativescript/firebase": "file:../publish/package/nativescript-firebase-11.1.3.tgz",
+ "@nativescript/unit-test-runner": "~1.0.2",
+ "firebase-functions": "^2.0.5",
+ "nativescript-theme-core": "^1.0.4"
},
"devDependencies": {
+ "@nativescript/android": "7.0.1",
+ "@nativescript/ios": "7.0.4",
+ "@nativescript/types": "~7.0.4",
+ "@nativescript/webpack": "~3.0.8",
"@types/jasmine": "~2.8.0",
- "awesome-typescript-loader": "~3.1.3",
"babel-traverse": "6.12.0",
"babel-types": "6.11.1",
"babylon": "6.8.4",
- "copy-webpack-plugin": "~4.0.1",
- "css-loader": "~0.28.7",
- "extract-text-webpack-plugin": "~3.0.0",
"filewalker": "0.1.2",
"jasmine-core": "~2.8.0",
- "karma": "^1.7.1",
- "karma-jasmine": "^1.1.0",
+ "karma": "4.1.0",
+ "karma-jasmine": "2.0.1",
"karma-nativescript-launcher": "^0.4.0",
"lazy": "1.0.11",
- "nativescript-css-loader": "~0.26.0",
- "nativescript-dev-typescript": "~0.7.1",
- "nativescript-dev-webpack": "~0.10.0",
- "nativescript-worker-loader": "~0.8.1",
- "raw-loader": "~0.5.1",
- "resolve-url-loader": "~2.1.0",
- "tns-platform-declarations": "~4.2.0",
"tslint": "~5.4.3",
- "typescript": "~2.8.0",
- "webpack": "~3.8.1",
- "webpack-bundle-analyzer": "^2.8.2",
- "webpack-sources": "~1.0.1",
- "uglifyjs-webpack-plugin": "~1.1.6",
- "clean-webpack-plugin": "~0.1.19"
+ "typescript": "~4.0.5"
},
"scripts": {
"build.plugin": "cd ../src && npm run build",
"ci.tslint": "npm i && tslint --config '../tslint.json' 'app/**/*.ts' --exclude '**/node_modules/**' --exclude '**/typings/**'"
- }
-}
\ No newline at end of file
+ },
+ "main": "app.js"
+}
diff --git a/demo/references.d.ts b/demo/references.d.ts
index 5c2cbd67..df4cb14c 100644
--- a/demo/references.d.ts
+++ b/demo/references.d.ts
@@ -1,4 +1,2 @@
-///
+
+ Open Hosting Documentation
+ 
+
+
+_AdMob currently supports these three types of Ads, as does this plugin_
+
## Enabling AdMob
-Since plugin version 3.10.0 you can use Firebase _AdMob_ features.
-_AdMob_ lets you show banners or interstitials (full screen ads) in your app so you can earn a little money.
+### Android
+> ⚠️ Important! Plugin version 7.4.0+ requires you to do this - or your app will crash on start-up! ⚠️
+
+Open your App_Resources/Android/AndroidManifest.xml file and add this `meta-data` line at [the right spot](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/3fe3f6b4b9d1b83b048b10472bec923f64e08c75/demo/app_resources/Android/src/main/AndroidManifest.xml#L28-L30) (and replace the value by the actual App ID of [your app](https://apps.admob.com/)!):
+
+```xml
+
## Enabling Analytics
-This plugin has had enalytics enabled since day 1 to collect usage and behavior data for your app. However, you were not able to push your own events. That changed with version 3.6.0 😃🔥
+This plugin has had enalytics enabled since day 1 to collect usage and behavior data for your app,
+and since version 3.6.0 you are able to push your own events.
-_Beware that your Analytics events in the Firebase console dashboards are updated periodically throughout the day, not real-time._
+With version 10.0.0 I've been able to make Analytics an optional dependency (because the upstream SDKs made it optional as well),
+so if you want to use Analytics then nothing needs to change (enabled by default), but if you don't, you can edit `firebase.nativescript.json`
+and add `"analytics": false`, then `rm -rf node_modules platforms`.
+_Beware that your Analytics events in the Firebase console dashboards are updated periodically throughout the day, not real-time._
## Functions
@@ -48,6 +52,41 @@ For a list of predefined Events [check this Android reference](https://firebase.
);
```
+### analytics.logComplexEvent
+Same thing as logEvent but you can add an `Array` or specific types (not just `string`).
+See `LogComplexEventTypeParameter` for all available types.
+
+```typescript
+import * as firebase from "nativescript-plugin-firebase";
+import { LogComplexEventTypeParameter } from "nativescript-plugin-firebase";
+
+firebase.analytics.logComplexEvent({
+ key: "view_item_list",
+ parameters: [{
+ key: "item1",
+ type: "array",
+ value: [
+ {
+ parameters: [
+ {key: "item_id", value: "id of item", type: LogComplexEventTypeParameter.STRING},
+ {key: "item_name", value: "name of item", type: LogComplexEventTypeParameter.STRING},
+ {key: "price", value: 1, type: LogComplexEventTypeParameter.DOUBLE},
+ {key: "index", value: 1, type: LogComplexEventTypeParameter.INT}
+ ]
+ },
+ {
+ parameters: [
+ {key: "item_id", value: "id of item", type: LogComplexEventTypeParameter.STRING},
+ {key: "item_name", value: "name of item", type: LogComplexEventTypeParameter.STRING},
+ {key: "price", value: 1, type: LogComplexEventTypeParameter.DOUBLE},
+ {key: "index", value: 2, type: LogComplexEventTypeParameter.INT}
+ ]
+ }
+ ]
+ }]
+});
+```
+
### analytics.setUserProperty
User properties are attributes you define to describe segments of your userbase, such as language preference or geographic location.
@@ -99,3 +138,10 @@ You can also pass this property during `init()`:
```
> If you want to disable collection without calling this function programmatically, then you can add a flag to your `App_Resources/iOS/Info.plist` and `App_Resources/Android/AndroidManifest.xml`, see [Firebase's documentation](https://firebase.google.com/support/guides/disable-analytics) for details.
+
+### analytics.setSessionTimeoutDuration
+Sets the duration of inactivity that terminates the current session. The default value is 1800 seconds (30 minutes).
+
+```js
+ firebase.analytics.setSessionTimeoutDuration(600); // 10 minutes
+```
diff --git a/docs/AUTHENTICATION.md b/docs/AUTHENTICATION.md
index 618b74ea..c6e08a70 100644
--- a/docs/AUTHENTICATION.md
+++ b/docs/AUTHENTICATION.md
@@ -1,7 +1,7 @@
## Enabling Authentication
-You can sign in a user either
+You can sign in a user, using either
* [anonymously](#anonymous-login),
* by [email and password](#email-password-login),
@@ -9,7 +9,8 @@ You can sign in a user either
* by [phone verification](#phone-verification),
* using a [custom token](#custom-login),
* using [Facebook](#facebook-login),
-* using [Google](#google-sign-in).
+* using [Google](#google-sign-in),
+* using [Apple](#sign-in-with-apple).
Each of these login mechanisms need to be enabled in your Firebase console at the 'Login & Auth' tab.
@@ -23,8 +24,8 @@ All login functions below, as well as `getCurrentUser` return a 'User' object wi
|`emailVerified`|no|You can send an email with a verification link which this refers to
|`providers`|no|An array of {id: value} objects, where value can be 'facebook.com', etc
|`email`|yes|Not all providers require an email address
-|`name`|yes|The name stored at the provider
-|`profileImageURL`|yes|A string containing a link to a user image on the web
+|`displayName`|yes|The name stored at the provider. Note that before plugin version 8.2.0 this was called `name`.
+|`photoURL`|yes|A string containing a link to a user image on the web. Note that before plugin version 8.2.0 this was called `profileImageURL`.
|`phoneNumber`|yes|The user's phone number
|`refreshToken`|yes|iOS only
|`additionalUserInfo`|no|See `AdditionalUserInfo` below
@@ -62,12 +63,13 @@ const firebaseWebApi = require("nativescript-plugin-firebase/app");
As stated [here](https://firebase.google.com/docs/auth/ios/manage-users#get_the_currently_signed-in_user):
> The recommended way to get the current user is by setting a listener on the Auth object
-
+
+
-### Fetch providers for email
-Want to know which auth providers are associated with an emailaddress?
+### Get Current User
+Once the user is logged in you can retrieve the currently logged in user:
) => {
- console.log(`Providers for ${emailAddress}: ${JSON.stringify(providers)}`);
- });
+ firebase.getCurrentUser()
+ .then(user => console.log("User uid: " + user.uid))
+ .catch(error => console.log("Trouble in paradise: " + error));
```
### Fetch sign-in methods for email
-Both email-password login and email-link login are `password` providers, so by just using `fetchProvidersForEmail`
-you won't be able to differentiate between those login methods. That's where `fetchSignInMethodsForEmail` comes in.
+Use this if you want to know which auth providers are associated with an emailaddress.
+
+> Firebase Crash reporting has been deprecated since plugin version 5.3.0 and was removed in plugin version 9.0.0 - use Crashlytics instead.
+
+## Enabling Crashlytics
+You will be prompted during installation of the plugin to enable Crashlytics (off by default).
+This will add `"crashlytics": true` to your `firebase.nativescript.json` file, now remove the `platforms` folder so this change is picked up.
+
+## Enabling Opt-In Crashlytics Collection (GDPR, anyone?)
+Since plugin version 8.3.0 you can disable Crashlytics collection by default, and enabled it at runtime.
+
+Add [this](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/7418905a22661dfc3bf40d1a67a5e7254c89d54e/demo/app_resources/Android/src/main/AndroidManifest.xml#L32-L34) to your `AndroidManifest.xml`
+and [this](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/7418905a22661dfc3bf40d1a67a5e7254c89d54e/demo/app_resources/iOS/Info.plist#L109-L110) to your `Info.plist`, so it's disabled by default.
+
+You can then either pass `crashlyticsCollectionEnabled: true` in `firebase.init()`,
+or call `crashlytics.setCrashlyticsCollectionEnabled(true)` to enabled Crashlytics collection for the user.
+
+## Configuration in the Firebase Console
+When setting up Crashlytics, select "This app is new to Crashlytics" and press "Next".
+Then the screen changes to something like "waiting for your first crash report".
+Then produce a crash, and it can easily take a day before that screen changes (later data comes in much quicker).
+
+## Crashlytics API
+
+### `sendCrashLog`
+Send a native iOS or Android exception to Crashlytics.
+
+```typescript
+// for NativeScript 7, import like this:
+import { crashlytics } from "@nativescript/firebase/crashlytics";
+
+// for older versions of NativeScript, either import like this:
+import { crashlytics } from "nativescript-plugin-firebase"; // and do: crashlytics.sendCrashLog
+// or this:
+import { crashlytics as firebaseCrashlytics } from "nativescript-plugin-firebase"; // and do: firebaseCrashlytics.sendCrashLog
+// or this:
+import * as firebase from "nativescript-plugin-firebase"; // and do: firebase.crashlytics.sendCrashLog
+
+import { isAndroid, isIOS } from "tns-core-modules/platform";
+
+if (isAndroid) {
+ crashlytics.sendCrashLog(new java.lang.Exception("test Exception"));
+} else if (isIOS) {
+ crashlytics.sendCrashLog(new NSError({
+ domain: 'ShiploopHttpResponseErrorDomain',
+ code: 42,
+ userInfo: null
+ }));
+}
+```
+
+### `set*`
+Set a value that will be logged with an error and showing in the Firebase console on the 'Keys' tab of the error details.
+
+```typescript
+import { crashlytics } from "nativescript-plugin-firebase";
+
+crashlytics.setString("test_key", "test_value");
+crashlytics.setBool("test_key_bool", true);
+crashlytics.setInt("test_key_int", 2);
+crashlytics.setDouble("test_key_double", 56615.55548465);
+crashlytics.setFloat("test_key", 54646.45);
+
+crashlytics.setUserId("user#42");
+```
+
+### `log`
+Add a message that will be logged with an error and showing in the Firebase console on the 'Logs' tab of the error details.
+
+```typescript
+crashlytics.log("more log info...");
+```
+
+### `crash`
+For easier testing, version 8.2.0 exposed this `crash()` function of the native Firebase Crashlytics SDKs:
+
+```typescript
+import { crashlytics } from "nativescript-plugin-firebase";
+
+crashlytics.crash();
+```
+
+> This should crash your app unless you have `discardUncaughtJsExceptions` set to `true` in `app/package.json`.
\ No newline at end of file
diff --git a/docs/CRASHREPORTING.md b/docs/CRASHREPORTING.md
deleted file mode 100644
index 7a23512f..00000000
--- a/docs/CRASHREPORTING.md
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-## Enabling Crash Reporting / Crashlytics
-Since version 5.3.0 you can choose either Crashlytics (recommended) or the older Firebase Crash Reporting (which doesn't really work on iOS).
-You will be prompted during installation of the plugin to enable either Crashlytics or Crash Reporting (both are off by default).
-
-Note that if you want to use Crashlytics, make sure your `firebase.nativescript.json` file has `"crashlytics": true` and `"crash_reporting": false`,
-then remove the `platforms` folder so these changes are picked up.
diff --git a/docs/DATABASE.md b/docs/DATABASE.md
index 0fc707d1..4d48f62d 100644
--- a/docs/DATABASE.md
+++ b/docs/DATABASE.md
@@ -170,7 +170,8 @@ Let's say we have the structure as defined at `setValue`, then use this query to
if (!result.error) {
console.log("Event type: " + result.type);
console.log("Key: " + result.key);
- console.log("Value: " + JSON.stringify(result.value));
+ console.log("Value: " + JSON.stringify(result.value)); // a JSON object
+ console.log("Children: " + JSON.stringify(result.children)); // an array, added in plugin v 8.0.0
}
};
@@ -255,9 +256,12 @@ Removes values in multiple locations
```
### addChildEventListener
+
To listen for changes in your database you can pass in a listener callback function.
You get to control which path inside you database you want to listen to, by default it's `/` which is the entire database.
+If you have defined access rules that depend on authentication, add listeners after authentication, attempting to access data not authorized by the access rules will prevent your listener from working properly, even if you add them at first. listing some data as just added, which seems to be a bug in Firebase's access rules system.
+
The plugin will take care of serializing native data structures to JSON data.
```js
@@ -311,7 +315,8 @@ The link is for the iOS SDK, but it's the same for Android.
console.log("Listener error: " + result.error);
} else {
console.log("Key: " + result.key);
- console.log("Calue: " + JSON.stringify(result.val()));
+ console.log("key exists? " + result.exists());
+ console.log("Value: " + JSON.stringify(result.val()));
}
};
@@ -345,6 +350,42 @@ You can see an example of this (for both the native and web API) in the [demo ap
```
+### OnDisconnect
+Use OnDisconnect to run operations on Firebase Realtime Database when the client disconnects.
+Disconnections can happen when the app is killed from the recent tasks, internet loss, etc. When
+you regain internet (app wasn't closed) then the database will update instantly.
+
+Note that if the device restarts / app is killed in background (ungraceful disconnect) the database will
+NOT update in realtime (there's no way), but after Firebase detects that the device is unreachable then it
+will run the function given to onDisconnect.
+
+Rather than passing in callbacks every function returns a promise.
+
+
+### Transaction
+Transactions are used when you want to atomically modify data at this location. This
+ensures there are no conflicts with other clients writing to the same location at the
+same time.
+
+You can look at the [docs](https://firebase.google.com/docs/reference/js/firebase.database.Reference#transaction) for more information.
+
+Note that a return value of `null` will delete the value at this location whereas returning
+undefined will not modify the data at this location. Firebase web aborts the transaction when
+given an undefined, but due to technically difficulties we just return transaction success which
+results in committed = true. On transaction complete a promise is returned containing
+{committed:boolean, snapshot: DataSnapshot} and an error will be returned if the transaciton
+failed.
+
+Native API
To listen to auth state changes you can register a listener during `init`: ```js firebase.init({ - onAuthStateChanged: function(data) { // optional but useful to immediately re-logon the user when he re-visits your app + onAuthStateChanged: function(data) { // optional but useful to immediately re-logon the user when they re-visit your app console.log(data.loggedIn ? "Logged in to firebase" : "Logged out from firebase"); if (data.loggedIn) { console.log("user's email address: " + (data.user.email ? data.user.email : "N/A")); @@ -98,62 +100,59 @@ If - for some reason - you want more control over the listener you can use these // check if already listening to auth state changes firebase.hasAuthStateListener(listener); -``` - -### Get Current User -Once the user is logged in you can retrieve the currently logged in user: - -
-
Native API
- -```typescript - firebase.getCurrentUser() - .then(user => console.log("User uid: " + user.uid)) - .catch(error => console.log("Trouble in paradise: " + error)); -``` + ```Web API
-```typescript - const user = firebaseWebApi.auth().currentUser; +The callback handler in will be called with the currentUser (undefined if not signed in) upon attaching the listener +and when the auth state changes. + +```js + firebaseWebApi.auth().onAuthStateChanged((user?: User) => { + console.log(">> auth state changed: " + user); + if (user) { + this.set("userEmailOrPhone", user.email ? user.email : (user.phoneNumber ? user.phoneNumber : "N/A")); + alert({ + title: "User signed in", + message: JSON.stringify(user), + okButtonText: "Nice!" + }); + } else { + alert({ + title: "User signed out", + okButtonText: "Bye!" + }); + } + }, +error => console.log("OnAuthChanged Error: " + error)); ```Native API
```typescript - const emailAddress = "someone@domain.com"; - firebase.fetchProvidersForEmail(emailAddress).then((providers: ArrayWeb API
-```js +```typescript const user = firebaseWebApi.auth().currentUser; - if (!user || !user.email) { - console.log("Can't fetch providers; no user with an emailaddress logged in."); - return; - } - - firebaseWebApi.auth().fetchProvidersForEmail(user.email) - .then(result => console.log(`Providers for ${user.email}: ${JSON.stringify(result)}`)) - .catch(error => console.log("Fetch Providers for Email error: " + error)); ```Native API
@@ -200,6 +199,34 @@ The logged in user will be updated, but for `getCurrentUser` to reflect the chan ); ``` +### Reloading a user +The currently logged in user will be reloaded (the one returned by `getCurrentUser`). + +```js + firebase.reloadUser().then( + function () { + // now call 'getCurrentUser' to get the reloaded user data + }, + function (errorMessage) { + console.log(errorMessage); + } + ); +``` + +### Deleting a user +The currently logged in user will be deleted (the one returned by `getCurrentUser`). + +```js + firebase.deleteUser().then( + function () { + // called when the user was successfully deleted + }, + function (errorMessage) { + console.log(errorMessage); + } + ); +``` + ### Anonymous login Don't forget to enable anonymous login in your firebase instance. @@ -263,7 +290,7 @@ Enable email-password login in your firebase instance, and flip the "E-mail link This login type allows your users to login without providing a password. They can simply click a link and get redirected to the app. The app may even run on a different device. -Enable dynamic links, as described in the [Dynamic Links readme](./INVITES_DYNAMICLINKS.md), because the user +Enable dynamic links, as described in the [Dynamic Links readme](./DYNAMIC_LINKS.md), because the user that receives the link will need to be redirected to your app. #### iOS configuration @@ -271,7 +298,7 @@ that receives the link will need to be redirected to your app. #### Android configuration - Specify the package name of your app in the Firebase console. -- Upload the SHA-1 and SHA-256 of the (debug) signing certificates to the Firebase console, as described in the [Dynamic Links readme](./INVITES_DYNAMICLINKS.md). +- Upload the SHA-1 and SHA-256 of the (debug) signing certificates to the Firebase console, as described in the [Dynamic Links readme](./DYNAMIC_LINKS.md). - Also add an `android:host` for the `emailLinkOptions.url` to your `app/App_Resources/Android/AndroidManifest.xml` file as described in that readme.
@@ -320,9 +347,7 @@ that receives the link will need to be redirected to your app.
-#### Managing email-password accounts
-
-##### Creating a Password account
+#### Creating a Password account
This may not work on an (Android) simulator. See #463.
@@ -365,41 +390,81 @@ This may not work on an (Android) simulator. See #463.
#### Resetting a password
-```js
- firebase.resetPassword({
- email: 'useraccount@provider.com'
- }).then(
- function () {
- // called when password reset was successful,
- // you could now prompt the user to check his email
- },
- function (errorMessage) {
- console.log(errorMessage);
- }
- );
+> ⚠️ The method name and signature has changed in 8.0.0 from `resetPassword` to `sendPasswordResetEmail` to better align with the Web API.
+
+
Then add the following lines to your code and check for setup instructions for your platform below.
@@ -523,7 +612,10 @@ Then add the following lines to your code and check for setup instructions for y
type: firebase.LoginType.GOOGLE,
// Optional
googleOptions: {
- hostedDomain: "mygsuitedomain.com"
+ hostedDomain: "mygsuitedomain.com",
+ // NOTE: no need to add 'profile' nor 'email', because they are always provided
+ // NOTE 2: requesting scopes means you may access those properties, but they are not automatically fetched by the plugin
+ scopes: ['https://www.googleapis.com/auth/user.birthday.read']
}
}).then(
function (result) {
@@ -548,9 +640,9 @@ Upon successful authentication, Google creates an access token that can be obtai
```
#### iOS
-If you didn't choose this feature during installation you can open the `Podfile` in the plugin's `platforms/ios` folder and uncomment the `GoogleSignIn` line.
+If you didn't choose `Firebase Authentication` and `Firebase Google Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
-Make sure the URL Scheme for `REVERSED_CLIENT_ID` is in `app/App_Resources/iOS/Info.plist`:
+Make sure the URL Scheme for `REVERSED_CLIENT_ID` is in `app/App_Resources/iOS/Info.plist`. The value of `REVERSED_CLIENT_ID` can be found in your `App_Resources/iOS/GoogleService-Info.plist` :
```xml
CFBundleURLTypes
@@ -595,28 +687,88 @@ To solve, you will want to pass in the appropriate iOS controller of the active
```
#### Android
-
-1. If you didn't choose this feature during installation you can uncomment `google-services-auth` in `node_modules\nativescript-plugin-firebase\platforms\android\include.gradle`
+1. If you didn't choose `Firebase Authentication` and `Firebase Google Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
2. Google Sign-In requires an SHA1 fingerprint: see [Authenticating Your Client for details](https://developers.google.com/android/guides/client-auth). If you don't do this you will see the account selection popup, but you won't be able to actually sign in.
3. Those fingerprints need to be added to your Firebase console. Go to 'project overview', 'project settings', then scroll down a bit.
-### getAuthToken
-If you want to authenticate your user from your backend server you can obtain
-a Firebase auth token for the currently logged in user.
+### Sign in with Apple
+First, enable Apple login in your Firebase instance.
+
+Then add the following lines to your code and check for further setup instructions for your platform below.
+
+```js
+ firebase.login({
+ type: firebase.LoginType.APPLE,
+ // Optional
+ appleOptions: {
+ locale: "nl", // for Android
+ scopes: ["email"] // default ["email", "name"]
+ }
+ }).then(
+ function (result) {
+ JSON.stringify(result);
+ },
+ function (errorMessage) {
+ console.log(errorMessage);
+ }
+ );
+```
+
+#### iOS
+1. If you didn't choose `Firebase Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
+2. Follow [these instructions](https://firebase.google.com/docs/auth/ios/apple), including enabling Sign In for your App ID. You may need to recreate your provisioning profile as well.
+3. Add this to `app\App_Resources\iOS\*.entitlements`:
+
+```xml
+ com.apple.developer.applesignin
+
+ Default
+
+```
+
+[Here's a complete example.](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/master/demo/app_resources/iOS/app.entitlements)
+
+#### Android
+1. If you didn't choose `Firebase Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
+2. In your Firebase console add the "Services ID". Make sure to follow all steps, including completing the "OAuth code flow configuration".
+3. Follow [these instructions](https://firebase.google.com/docs/auth/android/apple), including adding your `SHA-1` hash, website association, website ownership confirmation, creating an Apple private key. Just do everything except for adding Java code, because the plugin takes care of that.
+
+### getAuthToken / getIdToken
+If you want to authenticate your user from your backend server you can obtain a Firebase auth token for the currently logged in user.
+
+You'll get the token, as well as the provider that was used to sign in, and any custom claims you may have previously set via the Firebase Admin SDK as outlined [here](https://firebase.google.com/docs/auth/admin/custom-claims):
+
+
+
+### unlinking provider
+For a given user, and a given provider ("google.com","password",...)
+
+
+
-#### Changing a password
-```js
- firebase.changePassword({
- email: 'useraccount@provider.com',
- oldPassword: 'myOldPassword',
- newPassword: 'myNewPassword'
- }).then(
- function () {
- // called when password change was successful
- },
- function (errorMessage) {
- console.log(errorMessage);
- }
- );
+Native API
+ +```typescript + firebase.sendPasswordResetEmail("user@example.com") + .then(() => console.log("Password reset email sent")) + .catch(error => console.log("Error sending password reset email: " + error)); ``` +
+
+
+#### Updating an email address
+Note that changing an email address may fail if your login for this `email` was too long ago (per Firebase's standards, whatever they are).
+
+Web API
+ +```typescript + firebaseWebApi.auth().sendPasswordResetEmail("user@example.com") + .then(() => console.log("Password reset email sent")) + .catch(error => console.log("Error sending password reset email: " + error)); ``` +
+
+
+Native API
+ +```typescript + firebase.updateEmail("user@example.com") + .then(() => console.log("Email updated")) + .catch(error => console.log("Error updating email: " + error)); +``` +
+
+
+#### Updating a password
+> ⚠️ The method name and signature has changed in 8.0.0 from `changePassword` to `updatePassword` to better align with the Web API.
+
+Note that changing a password may fail if your login for this `email` was too long ago (per Firebase's standards, whatever they are).
+
+Web API
+ +```typescript + firebaseWebApi.auth().updateEmail("user@example.com") + .then(() => console.log("Email updated")) + .catch(error => console.log("Error updating email: " + error)); +``` +
+
+
+Native API
+ +```typescript + firebase.updatePassword("myNewPassword") + .then(() => console.log("Password updated")) + .catch(error => console.log("Error updating password: " + error)); +``` +
+
### Phone Verification
* Don't forget to enable Phone login in your firebase instance.
* You can only test this on a real device (not on an emulator/simulator).
* Use the phone number of the device you're testing on.
-* _ANDROID:_ [Make sure you've uploaded your SHA1 fingerprint(s)](https://developers.google.com/android/guides/client-auth) to the Firebase console, then download the latest `google-services.json` file and add it to `app/App_Resources/Android`.
+* _ANDROID:_ [Make sure you've uploaded your SHA1 fingerprints](https://developers.google.com/android/guides/client-auth) to the Firebase console, then download the latest `google-services.json` file and add it to `app/App_Resources/Android`.
* _iOS:_ Make sure you have messaging enabled as well, as this uses push notifications on iOS.
```js
@@ -407,7 +472,11 @@ This may not work on an (Android) simulator. See #463.
type: firebase.LoginType.PHONE,
phoneOptions: {
phoneNumber: '+12345678900',
- verificationPrompt: "The received verification code" // default "Verification code"
+ verificationPrompt: "The received verification code", // default "Verification code"
+ // Optional
+ android: {
+ timeout: 30 // The maximum amount of time you are willing to wait for SMS auto-retrieval to be completed by the library
+ }
}
}).then(
function (result) {
@@ -423,6 +492,9 @@ This may not work on an (Android) simulator. See #463.
### Custom login
Use this login type to authenticate against firebase using a token generated by your own backend server. See these [instructions on how to generate the authentication token](https://firebase.google.com/docs/auth/server).
+Web API
+ +```typescript + firebaseWebApi.auth().updatePassword("myNewPassword") + .then(() => console.log("Password updated")) + .catch(error => console.log("Error updating password: " + error)); +``` +
+
+
+Native API
+ ```js var token = "myBackendToken"; @@ -440,6 +512,17 @@ Use this login type to authenticate against firebase using a token generated by } ); ``` +
+
### Facebook login
@@ -453,7 +536,7 @@ Then add the following lines to your code and check for setup instructions for y
// Optional
facebookOptions: {
// defaults to ['public_profile', 'email']
- scope: ['public_profile', 'email']
+ scopes: ['public_profile', 'email'] // note: this property was renamed from "scope" in 8.4.0
}
}).then(
function (result) {
@@ -480,12 +563,11 @@ Upon successful authentication, Facebook creates an access token that can be obt
```
#### iOS
- 1. If you didn't choose this feature during installation you can open the `Podfile` in the plugin's `platforms/ios` folder and uncomment the Facebook line.
- 2. Add a bit of config to `app\App_Resources\iOS\Info.plist` as instructed in Step 4 [here](https://developers.facebook.com/docs/ios/getting-started). Facebook login works perfectly on the demo app, so if you can't get it working, make sure to check out the [demo app's config](https://github.com/EddyVerbruggen/nativescript-plugin-firebase-demo/blob/ad85e187dbbb12ef0e705d1bfaed90c702846bc4/Firebase/app/App_Resources/iOS/Info.plist).
+1. If you didn't choose `Firebase Authentication` and `Firebase Facebook Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
+2. Add a bit of config to `app\App_Resources\iOS\Info.plist` as instructed in Step 4 of the iOS Quickstart in the Facebook Developer console of your app. Facebook login works perfectly on the demo app, so if you can't get it working, make sure to check out the [demo app's config](https://github.com/EddyVerbruggen/nativescript-plugin-firebase-demo/blob/ad85e187dbbb12ef0e705d1bfaed90c702846bc4/Firebase/app/App_Resources/iOS/Info.plist).
#### Android
-
-1. If you didn't choose this feature during installation you can uncomment the facebook SDK in `node_modules\nativescript-plugin-firebase\platforms\android\include.gradle`
+1. If you didn't choose `Firebase Authentication` and `Firebase Facebook Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
2. Add `Web API
+ +```typescript + firebaseWebApi.auth().signInWithCustomToken(token) + .then(result => console.log(JSON.stringify(result))) + .catch(error => console.log(JSON.stringify(error))); +``` +
Then add the following lines to your code and check for setup instructions for your platform below.
@@ -523,7 +612,10 @@ Then add the following lines to your code and check for setup instructions for y
type: firebase.LoginType.GOOGLE,
// Optional
googleOptions: {
- hostedDomain: "mygsuitedomain.com"
+ hostedDomain: "mygsuitedomain.com",
+ // NOTE: no need to add 'profile' nor 'email', because they are always provided
+ // NOTE 2: requesting scopes means you may access those properties, but they are not automatically fetched by the plugin
+ scopes: ['https://www.googleapis.com/auth/user.birthday.read']
}
}).then(
function (result) {
@@ -548,9 +640,9 @@ Upon successful authentication, Google creates an access token that can be obtai
```
#### iOS
-If you didn't choose this feature during installation you can open the `Podfile` in the plugin's `platforms/ios` folder and uncomment the `GoogleSignIn` line.
+If you didn't choose `Firebase Authentication` and `Firebase Google Authentication` during installation you can remove the `platforms` and `node_modules` folders and the `firebase.nativescript.json` file, then run `npm i`. This will prompt your which Firebase features you'd like to enable.
-Make sure the URL Scheme for `REVERSED_CLIENT_ID` is in `app/App_Resources/iOS/Info.plist`:
+Make sure the URL Scheme for `REVERSED_CLIENT_ID` is in `app/App_Resources/iOS/Info.plist`. The value of `REVERSED_CLIENT_ID` can be found in your `App_Resources/iOS/GoogleService-Info.plist` :
```xml
+
+
+Native API
```js firebase.getAuthToken({ // default false, not recommended to set to true by Firebase but exposed for {N} devs nonetheless :) forceRefresh: false }).then( - function (token) { - console.log("Auth token retrieved: " + token); + function (result) { + // for both platforms + console.log("Auth token retrieved: " + result.token); + console.log("Sign-In provider: " + result.signInProvider); + console.log("Specific custom claim retrieved: " + result.claims.yourClaimKey); // or result.claims["yourClaimKey"] }, function (errorMessage) { - console.log("Auth token retrieval error: " + errorMessage); + console.log("Auth result retrieval error: " + errorMessage); } ); ``` +
+
### logout
Shouldn't be more complicated than:
@@ -639,11 +791,36 @@ Shouldn't be more complicated than:
```
Web API
+ +```typescript + firebaseWebApi.auth().currentUser.getIdToken(false) + .then((token: string) => console.log("Auth token retrieved: " + token)) + .catch(errorMessage => console.log("Auth token retrieval error: " + errorMessage)); +``` +
+
+
+Native API
+ +```js + user.unlink(providerId /* string */) + .then(user => console.log("Unlink OK, user: " + JSON.stringify(user))) + .catch(error => console.log("Unlink error: " + JSON.stringify(error))); +``` +
+
+
### reauthenticate
Some security-sensitive actions (deleting an account, changing a password) require that the user has recently signed in.
If you perform one of these actions, and the user signed in too long ago, the action fails.
When this happens (or to prevent it from happening), re-authenticate the user.
+> Since plugin version 9.0.0 the Promise will resolve the user in the result. Older version don't return anything.
+
```js
firebase.reauthenticate({
type: firebase.LoginType.PASSWORD, // or GOOGLE / FACEBOOK
@@ -653,10 +830,11 @@ When this happens (or to prevent it from happening), re-authenticate the user.
password: 'thePassword'
}
}).then(
- function () {
- // you can now safely delete the account / change the password
+ function (result) {
+ // you can now safely delete the account / change the password, etc
dialogs.alert({
title: "Re-authenticated user",
+ message: JSON.stringify(result),
okButtonText: "OK"
});
},
@@ -674,14 +852,46 @@ When this happens (or to prevent it from happening), re-authenticate the user.
Sending an "email confirmation" email can be done after the user logged in:
```js
- firebase.sendEmailVerification().then(
- function () {
- console.log("Email verification sent");
- },
- function (error) {
- console.log("Error sending email verification: " + error);
- }
- );
+firebase.sendEmailVerification().then(
+ function () {
+ console.log("Email verification sent");
+ },
+ function (error) {
+ console.log("Error sending email verification: " + error);
+ }
+);
+```
+
+You can also pass state to this function - for details on the properties, see [the Firebase docs](https://firebase.google.com/docs/auth/web/passing-state-in-email-actions).
+
+```js
+firebase.sendEmailVerification({
+ url: "https://www.google.com",
+ handleCodeInApp: true,
+ iOS: {
+ bundleId: "com.bla.hoopla",
+ dynamicLinkDomain: "xyz"
+ },
+ android: {
+ minimumVersion: "13",
+ installApp: true,
+ packageName: "x.y.z"
+ }
+ }).then(
+ function () {
+ console.log("Email verification sent");
+ },
+ function (error) {
+ console.log("Error sending email verification: " + error);
+ }
+);
```
+Note that you can also use this with the Web API:
+
+```js
+const firebaseWebApi = require("nativescript-plugin-firebase/app");
+const user = firebaseWebApi.auth().currentUser;
+user.sendEmailVerification() // see the implementation above
+```
diff --git a/docs/CRASHLYTICS.md b/docs/CRASHLYTICS.md
new file mode 100644
index 00000000..e8df5bde
--- /dev/null
+++ b/docs/CRASHLYTICS.md
@@ -0,0 +1,83 @@
+Web API
+ +```js + firebaseWebApi.auth().unlink(providerId /* string */) + .then(user => console.log("Unlink OK, user: " + JSON.stringify(user))) + .catch(error => console.log("Unlink error: " + JSON.stringify(error))); +``` +
+
+> Firebase Crash reporting has been deprecated since plugin version 5.3.0 and was removed in plugin version 9.0.0 - use Crashlytics instead.
+
+## Enabling Crashlytics
+You will be prompted during installation of the plugin to enable Crashlytics (off by default).
+This will add `"crashlytics": true` to your `firebase.nativescript.json` file, now remove the `platforms` folder so this change is picked up.
+
+## Enabling Opt-In Crashlytics Collection (GDPR, anyone?)
+Since plugin version 8.3.0 you can disable Crashlytics collection by default, and enabled it at runtime.
+
+Add [this](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/7418905a22661dfc3bf40d1a67a5e7254c89d54e/demo/app_resources/Android/src/main/AndroidManifest.xml#L32-L34) to your `AndroidManifest.xml`
+and [this](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/7418905a22661dfc3bf40d1a67a5e7254c89d54e/demo/app_resources/iOS/Info.plist#L109-L110) to your `Info.plist`, so it's disabled by default.
+
+You can then either pass `crashlyticsCollectionEnabled: true` in `firebase.init()`,
+or call `crashlytics.setCrashlyticsCollectionEnabled(true)` to enabled Crashlytics collection for the user.
+
+## Configuration in the Firebase Console
+When setting up Crashlytics, select "This app is new to Crashlytics" and press "Next".
+Then the screen changes to something like "waiting for your first crash report".
+Then produce a crash, and it can easily take a day before that screen changes (later data comes in much quicker).
+
+## Crashlytics API
+
+### `sendCrashLog`
+Send a native iOS or Android exception to Crashlytics.
+
+```typescript
+// for NativeScript 7, import like this:
+import { crashlytics } from "@nativescript/firebase/crashlytics";
+
+// for older versions of NativeScript, either import like this:
+import { crashlytics } from "nativescript-plugin-firebase"; // and do: crashlytics.sendCrashLog
+// or this:
+import { crashlytics as firebaseCrashlytics } from "nativescript-plugin-firebase"; // and do: firebaseCrashlytics.sendCrashLog
+// or this:
+import * as firebase from "nativescript-plugin-firebase"; // and do: firebase.crashlytics.sendCrashLog
+
+import { isAndroid, isIOS } from "tns-core-modules/platform";
+
+if (isAndroid) {
+ crashlytics.sendCrashLog(new java.lang.Exception("test Exception"));
+} else if (isIOS) {
+ crashlytics.sendCrashLog(new NSError({
+ domain: 'ShiploopHttpResponseErrorDomain',
+ code: 42,
+ userInfo: null
+ }));
+}
+```
+
+### `set*`
+Set a value that will be logged with an error and showing in the Firebase console on the 'Keys' tab of the error details.
+
+```typescript
+import { crashlytics } from "nativescript-plugin-firebase";
+
+crashlytics.setString("test_key", "test_value");
+crashlytics.setBool("test_key_bool", true);
+crashlytics.setInt("test_key_int", 2);
+crashlytics.setDouble("test_key_double", 56615.55548465);
+crashlytics.setFloat("test_key", 54646.45);
+
+crashlytics.setUserId("user#42");
+```
+
+### `log`
+Add a message that will be logged with an error and showing in the Firebase console on the 'Logs' tab of the error details.
+
+```typescript
+crashlytics.log("more log info...");
+```
+
+### `crash`
+For easier testing, version 8.2.0 exposed this `crash()` function of the native Firebase Crashlytics SDKs:
+
+```typescript
+import { crashlytics } from "nativescript-plugin-firebase";
+
+crashlytics.crash();
+```
+
+> This should crash your app unless you have `discardUncaughtJsExceptions` set to `true` in `app/package.json`.
\ No newline at end of file
diff --git a/docs/CRASHREPORTING.md b/docs/CRASHREPORTING.md
deleted file mode 100644
index 7a23512f..00000000
--- a/docs/CRASHREPORTING.md
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-## Enabling Crash Reporting / Crashlytics
-Since version 5.3.0 you can choose either Crashlytics (recommended) or the older Firebase Crash Reporting (which doesn't really work on iOS).
-You will be prompted during installation of the plugin to enable either Crashlytics or Crash Reporting (both are off by default).
-
-Note that if you want to use Crashlytics, make sure your `firebase.nativescript.json` file has `"crashlytics": true` and `"crash_reporting": false`,
-then remove the `platforms` folder so these changes are picked up.
diff --git a/docs/DATABASE.md b/docs/DATABASE.md
index 0fc707d1..4d48f62d 100644
--- a/docs/DATABASE.md
+++ b/docs/DATABASE.md
@@ -170,7 +170,8 @@ Let's say we have the structure as defined at `setValue`, then use this query to
if (!result.error) {
console.log("Event type: " + result.type);
console.log("Key: " + result.key);
- console.log("Value: " + JSON.stringify(result.value));
+ console.log("Value: " + JSON.stringify(result.value)); // a JSON object
+ console.log("Children: " + JSON.stringify(result.children)); // an array, added in plugin v 8.0.0
}
};
@@ -255,9 +256,12 @@ Removes values in multiple locations
```
### addChildEventListener
+
To listen for changes in your database you can pass in a listener callback function.
You get to control which path inside you database you want to listen to, by default it's `/` which is the entire database.
+If you have defined access rules that depend on authentication, add listeners after authentication, attempting to access data not authorized by the access rules will prevent your listener from working properly, even if you add them at first. listing some data as just added, which seems to be a bug in Firebase's access rules system.
+
The plugin will take care of serializing native data structures to JSON data.
```js
@@ -311,7 +315,8 @@ The link is for the iOS SDK, but it's the same for Android.
console.log("Listener error: " + result.error);
} else {
console.log("Key: " + result.key);
- console.log("Calue: " + JSON.stringify(result.val()));
+ console.log("key exists? " + result.exists());
+ console.log("Value: " + JSON.stringify(result.val()));
}
};
@@ -345,6 +350,42 @@ You can see an example of this (for both the native and web API) in the [demo ap
```
+
+
+Native API
+ +```typescript + firebase.onDisconnect("/companies").cancel().then(() => console.log("Success")).catch(error => console.log(error)); + firebase.onDisconnect("/companies").remove(); + firebase.onDisconnect("/companies").set(value); + firebase.onDisconnect("/companies").setWithPriority(value, priority /* string | number */); + firebase.onDisconnect("/companies").update(value); + +``` +
+
+
### remove
You can remove the entire database content by passing `/` as param,
but if you only want to for instance wipe everything at `/users`, do this:
@@ -371,6 +412,94 @@ but if you only want to for instance wipe everything at `/users`, do this:
```
Web API
+ +```typescript + firebaseWebApi.database().ref("/companies").onDisconnect().cancel().then(() => console.log("Success")); + firebaseWebApi.database().ref("/companies").onDisconnect().remove(); + firebaseWebApi.database().ref("/companies").onDisconnect().set(value); + firebaseWebApi.database().ref("/companies").onDisconnect().setWithPriority(value, priority /* string | number*/); + firebaseWebApi.database().ref("/companies").onDisconnect().update(values); +``` +
+
+
+Native API
+ +```typescript +firebase.transaction(path, (currentValue => { + if (currentValue === null) { + return 0; + } else { + return ++currentValue; // Increment the current value. Do not try to increment currentValue if its NaN! + } + })) + .then((result: { committed: boolean, snapshot: firebase.DataSnapshot }) => { + console.log(result.committed + " snapshotValue: " + result.snapshot.val()); + }).catch(err => console.log("Encountered an error " + err)); +``` +
+
+
+### enableLogging
+The Firebase Realtime Database allows you turn on/off logs. This can be especially useful when trying to pinpoint any issues you may be having.
+By default the log level is set to INFO. Turning on logging will set the log level to DEBUG and off will set it to NONE.
+
+You MUST call `enableLogging()` before initializing firebase otherwise the app will crash.
+
+```js
+ firebase.enableLogging(true); // OR
+ firebaseWebApi.database.enableLogging(false);
+```
### keepInSync
The Firebase Realtime Database synchronizes and stores a local copy of the data for active listeners (see the methods above). In addition, you can keep specific locations in sync.
diff --git a/docs/DYNAMIC_LINKS.md b/docs/DYNAMIC_LINKS.md
new file mode 100644
index 00000000..04b018d5
--- /dev/null
+++ b/docs/DYNAMIC_LINKS.md
@@ -0,0 +1,110 @@
+Web API
+ +```typescript +firebaseWebApi.database().ref(path).transaction(currentValue => { + if (currentValue === null) { + return { name: { first: 'Ada', last: 'Lovelace' } }; + } else { + // console.log('User ada already exists.'); + return; // Abort the transaction. + } + }) + .then((result: { committed: boolean, snapshot: firebase.DataSnapshot }) => { + console.log(result.committed + " snapshotValue: " + result.snapshot.val()); + }).catch(err => console.log("Encountered an error " + err)); + + +firebaseWebApi.database().ref(path).transaction(currentValue => { + if (currentValue === null) { + return null; // Do nothing if this value doesn't exist or return undefined (null works here because theres nothing at this path) + //return 0 // If you want to put a 0 in if no value exist + } else { + return ++currentValue; // increment the value + } + }) + +// Based off Firebase simple blog post. You can also treat the +// data as an object and return an updated version of post +firebaseWebApi.database().ref(path).transaction(function(post) { + if (post) { + console.log("Post Object looks like: " + JSON.stringify(post)); + if (post.stars && post.stars[uid]) { + post.starCount--; + post.stars[uid] = null; + } else { + post.starCount++; + if (!post.stars) { + post.stars = {}; + } + post.stars[uid] = true; + } + } + return post; + }); +``` +
+
+> Note that the _Invites_ feature has been removed in plugin version 9.0.0, and will be removed from Firebase itself on January 24, 2020.
+
+## Enabling Dynamic Links
+
+You will be prompted during installation of the plugin to enable Dynamic Links (off by default).
+This will add `"dynamic_links": true` to your `firebase.nativescript.json` file, now remove the `platforms` folder so this change is picked up.
+
+### Android
+* If you want to use App Links, [make sure you've uploaded your SHA256 fingerprints](https://developers.google.com/android/guides/client-auth) to the Firebase console.
+
+### iOS
+* You must have the App Store ID and App ID set in your developer console [project settings](https://console.firebase.google.com/project/_/settings/general/).
+
+## Receiving Dynamic Links
+
+### Android
+To have a dynamic link open your app you need to add an Intent filter to the `
+
+> Added in plugin version 7.1.0, by [breningham](https://github.com/breningham)
+
+## Cloud Functions?
+Cloud Functions for Firebase lets you automatically run backend code in response to events triggered by Firebase features and HTTPS requests.
+Your code is stored in Google's cloud and runs in a managed environment. There's no need to manage and scale your own servers.
+
+[Learn more here..](https://firebase.google.com/docs/functions/)
+
+> Note that you don't need to enable this feature in the plugin unless you want to [call those Cloud Functions from your app](https://firebase.google.com/docs/functions/callable).
+
+## Enabling Cloud Functions
+To add this feature to your project, either:
+
+* Remove `firebase.nativescript.json` from the root of the project and run `npm i`, or
+* Edit that file and add `"functions": true`.
+
+In both cases, remove the `/platforms` folder afterwards so the required native library will be added upon the next build.
+
+
+## API
+You can use either the Web API syntax (easy for interoperability with a web version of your app), or our custom native syntax.
+Use whichever syntax you like most - the underlying implementation is the same.
+
+Both API supports Cloud Functions locations/regions as [described here](https://firebase.google.com/docs/functions/locations).
+To set a function's region, pass the region string as the second parameter of `httpsCallable`.
+If the region parameter is not supplied, the function will use Cloud Function's default region, which as of this doc is written is `us-central1`.
+
+### `httpsCallable`
+This example uses the Cloud Function as [implemented here](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/ff95c77c7b09acf66654f53c52e8ae0c8d7b1c78/demo/firebasefunctions/functions/src/index.ts#L15-L19).
+
+
+
+
+Native API
+ +```typescript +import * as firebase from "nativescript-plugin-firebase"; + +const fn = firebase.functions.httpsCallable("helloName"); + +// example of specifying the function's region +// defaults to `us-central1` if not specified +// const fn = firebase.functions.httpsCallable("helloName", "us-central1"); + +fn("Nativescript-Plugin-Firebase!") + .then((dataCue: any) => console.log("Callable Function Result: " + dataCue.message)) + .catch((errorMessage: string) => console.log("Callable Function Error: " + errorMessage)); +``` +
+
+
+### `useFunctionsEmulator`
+Changes this instance to point to a Cloud Functions emulator running locally.
+See [the Firebase docs](https://firebase.google.com/docs/functions/local-emulator).
diff --git a/docs/INVITES_DYNAMICLINKS.md b/docs/INVITES_DYNAMICLINKS.md
deleted file mode 100644
index 4c58a64e..00000000
--- a/docs/INVITES_DYNAMICLINKS.md
+++ /dev/null
@@ -1,151 +0,0 @@
-Web API
+ +```typescript +const firebaseWebApi = require("nativescript-plugin-firebase/app"); // mind the /app! + +const fn = firebaseWebApi.functions().httpsCallable("helloName"); + +// example of specifying the function's region +// defaults to `us-central1` if not specified +// const fn = firebaseWebApi.functions().httpsCallable("helloName", "us-central1"); + +fn("Nativescript-Plugin-Firebase!") + .then((dataCue: any) => console.log("Callable Function Result: " + dataCue.message)) + .catch((errorMessage: string) => console.log("Callable Function Error: " + errorMessage)); +``` +
-
-## Enabling Invites
-Since plugin version 3.12.0 you can use Firebase _Invites_ features.
-
-_Invites_ lets you invite other users to your app from right within your own app, via SMS and/or Email.
-
-Keep in mind that invites are based of dynamic links, and so calling for an invite may return a plain dynamic link, in which case invitationId is null.
-
-### Android
-* [Make sure you've uploaded your SHA1 and SHA256 fingerprints](https://developers.google.com/android/guides/client-auth) to the Firebase console.
-
-### iOS
-* On iOS the user must be signed in with their Google Account to send invitations.
-* You must have the App Store ID set in your developer console project in order for invitations to successfully be sent.
-* For more details see [https://firebase.google.com/docs/invites/ios](https://firebase.google.com/docs/invites/ios).
-
-#### Contacts Usage Permission
-Open `app/App_Resources/iOS/Info.plist` and add this somewhere in the file (if it's not already there):
-
-```xml
- 
+
+> Added in plugin version 8.2.0
+
+## In-App Messaging?
+Engage active app users with contextual messages.
+
+[Learn more here..](https://firebase.google.com/docs/in-app-messaging/)
+
+## Want to see a demo?
+Check out the (code of the) [Vue demo](demo-vue)!
+
+## Enabling In-App Messaging
+To add this feature to your project, either:
+
+* Remove `firebase.nativescript.json` from the root of the project and run `npm i`, or
+* Edit that file and add `"in_app_messaging": true`.
+
+In both cases, remove the `/platforms` folder afterwards so the required native library will be added upon the next build.
+
+## API
+There's nothing you have to do code-wise if you only want to display messages.
+If you want to capture a 'button clicked' event however, read on.
+
+### `onMessageClicked`
+
+```typescript
+import { inappmessaging } from "nativescript-plugin-firebase/inappmessaging";
+
+inappmessaging.onMessageClicked(message => {
+ console.log("Clicked a button for Campaign: " + message.campaignName);
+});
+```
+
+### `onMessageImpression`
+You can also get notified if a message is being shown to a user:
+
+```typescript
+import { inappmessaging } from "nativescript-plugin-firebase/inappmessaging";
+
+inappmessaging.onMessageImpression(message => {
+ console.log("A message belonging to this campaign is being shown: " + message.campaignName);
+});
+```
+
+### `triggerEvent`
+Trigger in-app messages programmatically.
+
+Firebase In-App Messaging by default allows you to trigger in-app messages with Google Analytics for Firebase events, with no additional integration. You can also manually trigger events programmatically with the Firebase In-App Messaging SDK’s programmatic triggers.
+
+In the In-App Messaging campaign composer, create a new campaign or select an existing campaign, and in the Scheduling step of the composer workflow, note the event ID of a newly-created or existing messaging event. Once noted, instrument your app to trigger the event by its ID.
+
+```typescript
+import { inappmessaging } from "nativescript-plugin-firebase/inappmessaging";
+
+const eventName = "myEvent";
+inappmessaging.triggerEvent(eventName);
+```
\ No newline at end of file
diff --git a/docs/MESSAGING.md b/docs/MESSAGING.md
index 2ca4c26c..487b1620 100644
--- a/docs/MESSAGING.md
+++ b/docs/MESSAGING.md
@@ -8,7 +8,17 @@ Although using push messages in your Firebase app is really easy setting it up i
If you didn't choose this feature during installation you can add `"messaging": true` to `
-> Note that if you don't want a badge on the app icon, remove the `badge` property or set it to 0. Note that launching the app clears the badge anyway.
+> Note that if you don't want a badge on the app icon, remove the `badge` property or set it to 0.
### Notfication-popup example
@@ -160,6 +208,8 @@ This results in a payload of:
- App in the foreground: `{"foo":"bar", "gcm.message_id":"0:1522952720644653%3194ccac3194ccac", "foreground":true, "title":"My title", "body":"My text"}`
- App in the background: `{"foo":"bar", "gcm.message_id":"0:1522952737879515%3194ccac3194ccac", "title":"My title", "body":"My text", "foreground":false}`
+Note that on iOS, when the notification was tapped, the payload will contain `notificationTapped: true`. That may help you with some logic in your app.
+
### (iOS) background notification example
> Take note of `content_available:true` here
@@ -176,13 +226,13 @@ This results in a payload of:
To register the app to receive interactive pushes you need to call `firebase.registerForInteractivePush(model)`.
And you may hook to the `model.onNotificationActionTakenCallback` callback to know what action the user took interacting with the notification.
-Each action has either type `button` or `input`, and you can set `options` to do any or all of:
+Each action has a type of either `button` or `input`, and you can set `options` to do any or all of:
- Launch the app: `foreground`.
- Only allow the action when the device is unlocked: `authenticationRequired`.
- Make the text red to indicate something will be removed/deleted/killed: `destructive`.
Consider this example, where an interactive push notification is received which the user expands and picks the fourth option.
-He then types his reply, and (because of how the action was configured) the app launches and captures the reply.
+They then type their reply, and (because of how the action was configured) the app launches and captures the reply.
@@ -262,7 +312,7 @@ The payload to trigger the notification in the screenshots above is:
}
```
-> *IMPORTANT* Use the `click_action` only for push notifications on iOS. When such a message is tapped in the Android notification center the app WON'T be opened. This will probably be fixed in the future.
+> *IMPORTANT* Use `click_action` only for push notifications on iOS. When such a message is tapped in the Android notification center the app WON'T be opened. This will probably be fixed in the future.
### (iOS) showing a notification while the app is in the foreground
Add the `showWhenInForeground` flag to your payload:
@@ -275,6 +325,15 @@ Add the `showWhenInForeground` flag to your payload:
}
```
+### (iOS) Disable automatic clearing the badge
+Currently by default, when launching the app, badge is cleared. You can disable the feature by passing a flag in your init option.
+
+```js
+firebase.init({
+ autoClearBadge: false
+});
+```
+
## What if iOS doesn't show/receive notifications in the background?
Make sure you [`require` the plugin in `app.ts` / `main.ts` / `main.aot.ts`](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/55cfb4f69cf8939f9101712fed22383196b08d36/demo/app/app.ts#L5)
*before* `application.start()`, and do `init()` *after* the app has started (not in `app.ts` - not even in a timeout; move it out of `app.ts` entirely!).
diff --git a/docs/ML_KIT.md b/docs/ML_KIT.md
index daa0037c..02bfc2b6 100644
--- a/docs/ML_KIT.md
+++ b/docs/ML_KIT.md
@@ -2,6 +2,8 @@
Make sure to check out [this demo app](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/tree/master/demo-ng) because it has almost all ML Kit features this plugin currently supports! Steps:
+> Supported on Android, and iOS 10+
+
```bash
git clone https://github.com/EddyVerbruggen/nativescript-plugin-firebase
cd nativescript-plugin-firebase/src
@@ -32,6 +34,11 @@ and add this somewhere in the file (if it's not already there):
@@ -90,6 +100,8 @@ To be able to use Cloud features you need to do two things:
#### Still image (on-device)
+##### TypeScript
+
```typescript
import { MLKitRecognizeTextResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
const firebase = require("nativescript-plugin-firebase");
@@ -101,8 +113,22 @@ firebase.mlkit.textrecognition.recognizeTextOnDevice({
}).catch(errorMessage => console.log("ML Kit error: " + errorMessage));
```
+##### JavaScript
+
+```js
+var firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.textrecognition.recognizeTextOnDevice({
+ image: imageSource // a NativeScript Image or ImageSource, see the demo for examples
+}).then(function(result) {
+ console.log(result.text ? result.text : "");
+}).catch(function (errorMessage) { return console.log("ML Kit error: " + errorMessage); });
+```
+
#### Still image (cloud)
+##### TypeScript
+
```typescript
import { MLKitRecognizeTextResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
const firebase = require("nativescript-plugin-firebase");
@@ -114,19 +140,35 @@ firebase.mlkit.textrecognition.recognizeTextCloud({
.catch(errorMessage => console.log("ML Kit error: " + errorMessage));
```
+##### JavaScript
+
+```js
+var firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.textrecognition.recognizeTextCloud({
+ image: imageSource // a NativeScript Image or ImageSource, see the demo for examples
+}).then(function(result) {
+ console.log(result.text ? result.text : "");
+}).catch(function (errorMessage) { return console.log("ML Kit error: " + errorMessage); });
+```
+
#### Live camera feed
The exact details of using the live camera view depend on whether or not you're using Angular / Vue.
You can use any view-related property you like as we're extending `ContentView`.
So things like `class`, `row`, `width`, `horizontalAlignment`, `style` are all valid properties.
-Plugin-specific are the optional properties `processEveryNthFrame` and `torchOn`, and optional event `scanResult`.
-You can `processEveryNthFrame` set to a lower value than the default (5) to put less strain on the device.
+Plugin-specific are the optional properties `processEveryNthFrame`, `preferFrontCamera` (default `false`), `torchOn`, and `pause`, as well as the optional `scanResult` event.
+
+You can set `processEveryNthFrame` set to a lower value than the default (5) to put less strain on the device.
Especially 'Face detection' seems a bit more CPU intensive, but for 'Text recognition' the default is fine.
+If you don't destroy the scanner page/modal but instead briefly want to hide it (but keep it alive),
+you can pause the scanner with the `pause` property.
+
> Look at [the demo app](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/tree/master/demo-ng) to see how to wire up that `onTextRecognitionResult` function, and how to wire `torchOn` to a `Switch`.
-##### Angular / Vue
+##### Angular
Register a custom element like so in the component/module:
```typescript
@@ -142,11 +184,32 @@ Now you're able to use the registered element in the view:
width="260"
height="380"
processEveryNthFrame="10"
+ preferFrontCamera="false"
+ [pause]="pause"
[torchOn]="torchOn"
(scanResult)="onTextRecognitionResult($event)">
```
+##### Vue
+Register a custom element like so in `main.js`:
+
+```typescript
+Vue.registerElement("MLKitTextRecognition", () => require("nativescript-plugin-firebase/mlkit/textrecognition").MLKitTextRecognition);
+```
+
+Now you're able to use the registered element in your `.Vue` file:
+
+```vue
+ 
@@ -203,11 +268,52 @@ registerElement("MLKitFaceDetection", () => require("nativescript-plugin-firebas
detectionMode="accurate"
enableFaceTracking="true"
minimumFaceSize="0.2"
+ preferFrontCamera="true"
[torchOn]="torchOn"
(scanResult)="onFaceDetectionResult($event)">
```
+### Object detection and tracking
+
+
+[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/object-detection)
+
+#### Still image
+
+```typescript
+import { MLKitObjectDetectionResult } from "nativescript-plugin-firebase/mlkit/objectdetection";
+const firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.objectdetection.detectObjects({
+ image: imageSource, // a NativeScript Image or ImageSource, see the demo for examples
+ classify: true, // default false, attempts to classify the object(s) if true
+ multiple: true // default false, attempts to detect multiple objects (instead of only the most prominent one) when true
+})
+.then((result: MLKitObjectDetectionResult) => console.log(JSON.stringify(result.objects)))
+.catch(errorMessage => console.log("ML Kit error: " + errorMessage));
+```
+
+#### Live camera feed
+The basics are explained above for 'Text recognition', so we're only showing the differences here.
+
+```typescript
+import { registerElement } from "nativescript-angular/element-registry";
+registerElement("MLKitObjectDetection", () => require("nativescript-plugin-firebase/mlkit/objectdetection").MLKitObjectDetection);
+```
+
+```html
+
@@ -221,6 +327,7 @@ const firebase = require("nativescript-plugin-firebase");
firebase.mlkit.barcodescanning.scanBarcodesOnDevice({
image: imageSource,
+ supportInverseBarcodes: true, // only set to true if you need this as it's degrades performance slightly
formats: [BarcodeFormat.QR_CODE, BarcodeFormat.CODABAR] // limit recognition to certain formats (faster), or leave out entirely for all formats (default)
})
.then((result: MLKitScanBarcodesOnDeviceResult) => console.log(JSON.stringify(result.barcodes)))
@@ -239,7 +346,10 @@ registerElement("MLKitBarcodeScanner", () => require("nativescript-plugin-fireba
@@ -295,6 +407,7 @@ registerElement("MLKitImageLabeling", () => require("nativescript-plugin-firebas
width="260"
height="380"
confidenceThreshold="0.6"
+ preferFrontCamera="false"
[torchOn]="torchOn"
(scanResult)="onImageLabelingResult($event)">
@@ -320,7 +433,182 @@ firebase.mlkit.landmarkrecognition.recognizeLandmarksCloud({
.catch(errorMessage => console.log("ML Kit error: " + errorMessage));
```
+### Natural language identification
+
+
+[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/identify-languages)
+
+#### Still image
+Note that you could hook this up to text recognition running from a live camera stream, to get realtime results.
+Check [demo-ng](demo-ng) if you're interested in such a solution.
+
+```typescript
+import { MLKitNaturalLanguageIdentificationResult } from "nativescript-plugin-firebase/mlkit/naturallanguageidentification";
+const firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.naturallanguageidentification.identifyNaturalLanguage({
+ text: "Some text to detect the language for"
+})
+.then((languageIdResult: MLKitNaturalLanguageIdentificationResult) => console.log(`Language code: ${languageIdResult.languageCode}`))
+.catch(errorMessage => console.log("ML Kit error: " + errorMessage));
+```
+
+### Translate text
+> ⚠️ Because of a model-download bug on iOS this feature currently only works on Android.
+
+
+
+[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/translation)
+
+#### Still image
+You could use MLKit to perform OCR, then identify the language, and then translate it to another language.
+Check [demo-ng](demo-ng) if you're interested in such an approach.
+
+```typescript
+const firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.translation.ensureTranslationModelDownloaded({
+ from: "nl",
+ to: "en"
+}).then(() => {
+ firebase.mlkit.translation.translateText({
+ from: "nl",
+ to: "en",
+ text: "De kat krabt de krullen van de trap" // some Dutch text
+ })
+ .then(result => console.log(`Translated to English: ${result}`))
+ .catch(console.error)
+}).catch(console.error);
+```
+
+### Smart reply
+
+
+[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/generate-smart-replies)
+
+#### Still image
+
+```typescript
+import { MLKitSmartReplyConversationMessage } from "nativescript-plugin-firebase/mlkit/smartreply";
+const firebase = require("nativescript-plugin-firebase");
+
+// build a converstation history MLKit can create suggestions for, in chronological order
+const conversation: Array
+
+[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/automl-image-labeling)
+
+> NOTE: currently only local models are supported (not cloud models), but it's fairly easy to add those so open an issue if you need it. See the demo-ng folder for an example.
+
+#### Still image (on-device)
+
+```typescript
+import { MLKitAutoMLResult } from "nativescript-plugin-firebase/mlkit/automl";
+const firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.automl.labelImage({
+ localModelResourceFolder: "leftright",
+ image: imageSource,
+ confidenceThreshold: 0.6 // this will only return labels with at least 0.6 (60%) confidence. Default 0.5.
+})
+.then((result: MLKitAutoMLResult) => console.log(JSON.stringify(result.labels)))
+.catch(errorMessage => console.log("ML Kit error: " + errorMessage));
+```
+
+#### Live camera feed
+The basics are explained above for 'Text recognition', so we're only showing the differences here.
+
+```typescript
+import { registerElement } from "nativescript-angular/element-registry";
+registerElement("MLKitAutoML", () => require("nativescript-plugin-firebase/mlkit/automl").MLKitAutoML);
+```
+
+```html
+
+
[Firebase documentation 🌎](https://firebase.google.com/docs/ml-kit/use-custom-models)
-Coming soon. See issue #702.
+⚠️ **Please take note of the following:**
+
+- Currently only models bundled with your app can be used (not ones hosted on Firebase). That may change in the future.
+- Prefix the `localModelFile` and `labelsFile` below with `~/` so they point to your `app/` folder. This is for future compatibility, because I'd like to support loading models from the native bundle as well.
+- On Android, make sure the model is not compressed by adding [your model's file extension to app.gradle](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/57969d0a62d761bffb98b19db85af88bfae858dd/demo-ng/app/App_Resources/Android/app.gradle#L22).
+- Only "Quantized" models can be used. Not "Float" models, so `modelInput.type` below must be set to `QUANT`.
+- The `modelInput.shape` parameter below must specify your model's dimensions. If you're not sure, use the script in the paragraph "Specify the model's input and output" at [the Firebase docs](https://firebase.google.com/docs/ml-kit/ios/use-custom-models).
+- If you're using Webpack, make sure to have it copy the model and labels files to the bundled app as well. [Here's an example.](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/816a529be7f19bad1bbd572b77835ab8e557f32d/demo-ng/webpack.config.js#L275)
+
+#### Still image (on-device)
+
+```typescript
+import { MLKitCustomModelResult } from "nativescript-plugin-firebase/mlkit/custommodel";
+const firebase = require("nativescript-plugin-firebase");
+
+firebase.mlkit.custommodel.useCustomModel({
+ image: imageSource, // a NativeScript Image or ImageSource, see the demo for examples
+ maxResults: 10, // default 5 (limit numbers to this amount of results)
+ localModelFile: "~/custommodel/inception/inception_v3_quant.tflite", // see the demo, where the model lives in app/custommodel/etc..
+ labelsFile: "~/custommodel/inception/inception_labels.txt",
+ modelInput: [{ // Array
+
+> Without this enabled you will receive push messages in the foreground, but **NOT in the background** / when the app is killed.
+
+#### Copy the entitlements file
+The previous step created a the file`platforms/ios/YourAppName/(Resources/)YourAppName.entitlements`.
+Copy that file to `app/App_Resources/iOS/` (if it doesn't exist yet, otherwise merge its contents),
+so it's not removed when you remove and re-add the iOS platform. The relevant content for background push in that file is:
+
+```xml
+
+
+```typescript
+import { messaging, Message } from "nativescript-plugin-firebase/messaging";
+
+const model = new messaging.PushNotificationModel();
+model.iosSettings = new messaging.IosPushSettings();
+model.iosSettings.badge = false;
+model.iosSettings.alert = true;
+
+model.iosSettings.interactiveSettings = new messaging.IosInteractivePushSettings();
+model.iosSettings.interactiveSettings.actions = [
+ {
+ identifier: "OPEN_ACTION",
+ title: "Open the app (if closed)",
+ options: messaging.IosInteractiveNotificationActionOptions.foreground
+ },
+ {
+ identifier: "AUTH",
+ title: "Open the app, but only if device is not locked with a passcode",
+ options: messaging.IosInteractiveNotificationActionOptions.foreground | messaging.IosInteractiveNotificationActionOptions.authenticationRequired
+ },
+ {
+ identifier: "INPUT_ACTION",
+ title: "Tap to reply without opening the app",
+ type: "input",
+ submitLabel: "Fire!",
+ placeholder: "Load the gun..."
+ },
+ {
+ identifier: "INPUT_ACTION",
+ title: "Tap to reply and open the app",
+ options: messaging.IosInteractiveNotificationActionOptions.foreground,
+ type: "input",
+ submitLabel: "OK, send it",
+ placeholder: "Type here, baby!"
+ },
+ {
+ identifier: "DELETE_ACTION",
+ title: "Delete without opening the app",
+ options: messaging.IosInteractiveNotificationActionOptions.destructive
+ }
+];
+
+model.iosSettings.interactiveSettings.categories = [{
+ identifier: "GENERAL"
+}];
+
+model.onNotificationActionTakenCallback = (actionIdentifier: string, message: Message) => {
+ console.log(`onNotificationActionTakenCallback fired! Message: ${JSON.stringify(message)}, Action taken: ${actionIdentifier}`);
+};
+
+messaging.registerForInteractivePush(model);
+```
+
+To send an interactive push, add the `"category"` property to the notification, with a value corresponding to the `category` defined in the model you've registered in the app.
+The payload to trigger the notification in the screenshots above is:
+
+```json
+{
+ "aps": {
+ "alert": {
+ "title": "Realtime Custom Push Notifications",
+ "subtitle": "Now with iOS 10 support!",
+ "body": "Add multimedia content to your notifications"
+ },
+ "sound": "default",
+ "badge": 1,
+ "category": "GENERAL",
+ "showWhenInForeground": true,
+ "data": {
+ "foo": "bar"
+ }
+ }
+}
+```
+
+> *IMPORTANT* Use the `click_action` only for push notifications on iOS. When such a message is tapped in the Android notification center the app WON'T be opened. This will probably be fixed in the future.
+
+
+## Testing push notifications
+
+### iOS
+For testing notifications on iOS the easiest tool I found is [Pusher](https://github.com/noodlewerk/NWPusher):
+
+
+
+### Android
+For testing on Android I prefer using [Postman](https://www.getpostman.com/) to *POST* to the FCM REST API. Look at which headers you need to set, and how the payload needs to be added:
+
+
diff --git a/docs/PERFORMANCE_MONITORING.md b/docs/PERFORMANCE_MONITORING.md
new file mode 100644
index 00000000..12bac3b3
--- /dev/null
+++ b/docs/PERFORMANCE_MONITORING.md
@@ -0,0 +1,124 @@
+
+
+> Added in plugin version 7.3.0
+
+## Performance Monitoring?
+With Firebase Performance Monitoring you get insights into how your app performs from your users' point of view, with automatic and customized performance tracing.
+
+[Learn more here..](https://firebase.google.com/products/performance/)
+
+## Enabling Performance Monitoring
+To add this feature to your project, either:
+
+* Remove `firebase.nativescript.json` from the root of the project and run `npm i`, or
+* Edit that file and add `"performance_monitoring": true`.
+
+In both cases, remove the `/platforms` folder afterwards so the required native library will be added upon the next build.
+
+> ⚠️ It may take up to 12 hours before results pop up in your Firebase console, so be patient.
+
+> ℹ️ Per Firebase's documentation, by enabling this feature, Remote Config will be enabled as well. So you may be interested in [what Remote Config can do for your app](../REMOTECONFIG.md).
+
+## API
+
+### `startTrace`
+To be able to interact with a started trace, you can remember it in a property (in this case `firebaseTrace`):
+
+```typescript
+import { performance as firebasePerformance } from "nativescript-plugin-firebase";
+import { FirebaseTrace } from "nativescript-plugin-firebase/performance/performance";
+
+const firebaseTrace: FirebaseTrace = firebasePerformance.startTrace("myTrace");
+```
+
+Now you can call several functions on the remembered trace object, read on below. And don't forget to use `trace.stop` afterwards.
+
+### `trace.setValue`
+
+```typescript
+if (firebaseTrace) {
+ firebaseTrace.setValue("foo", "bar");
+}
+```
+
+### `trace.getValue`
+
+```typescript
+if (firebaseTrace) {
+ firebaseTrace.getValue("foo");
+}
+```
+
+### `trace.getAttributes`
+
+```typescript
+if (firebaseTrace) {
+ const attributes = firebaseTrace.getAttributes();
+ console.log(`trace attributes: ${attributes}`);
+}
+```
+
+### `trace.removeAttribute`
+
+```typescript
+if (firebaseTrace) {
+ const attributes = firebaseTrace.removeAttribute("foo");
+}
+```
+
+### `trace.incrementMetric`
+
+```typescript
+if (firebaseTrace) {
+ const incrementBy = 1;
+ const attributes = firebaseTrace.incrementMetric("foo_metric", incrementBy);
+}
+```
+
+### `trace.stop`
+To stop the trace, call `stop` on the remembered trace object:
+
+```typescript
+if (firebaseTrace) {
+ firebaseTrace.stop();
+ firebaseTrace = undefined;
+}
+```
+
+### `startHttpMetric`
+To be able to interact with a started HTTP metric, you can remember it in a property (in this case `firebaseHttpMetric`):
+
+```typescript
+import { performance as firebasePerformance } from "nativescript-plugin-firebase";
+import { FirebaseHttpMetric } from "nativescript-plugin-firebase/performance/performance";
+
+const firebaseHttpMetric: FirebaseHttpMetric = firebasePerformance.startHttpMetric("https://postman-echo.com/get", "GET");
+```
+
+Now you can call several functions on the remembered metric object, read on below. And don't forget to use `metric.stop` afterwards.
+
+### `metric.setRequestPayloadSize`
+
+```typescript
+if (firebaseHttpMetric) {
+ firebaseHttpMetric.setRequestPayloadSize(42);
+}
+```
+
+### `metric.setHttpResponseCode`
+
+```typescript
+if (firebaseHttpMetric) {
+ firebaseHttpMetric.setHttpResponseCode(200);
+}
+```
+
+### `metric.stop`
+To stop the metric, call `stop` on the remembered metric object:
+
+```typescript
+if (firebaseHttpMetric) {
+ firebaseHttpMetric.stop();
+ firebaseHttpMetric = undefined;
+}
+```
\ No newline at end of file
diff --git a/docs/STORAGE.md b/docs/STORAGE.md
index 8d0bff0f..9f5d5a21 100644
--- a/docs/STORAGE.md
+++ b/docs/STORAGE.md
@@ -1,19 +1,16 @@
+_Storage_ lets you upload and download files to/from Google Cloud Storage which is connected to your Firebase instance.
+
> NOTE: since plugin version 6.2.0 you have to use `firebase.storage.xxx` instead of `firebase.xxx`, because I've extracted storage-related functions into a separate module.
## Enabling Storage
-Since plugin version 3.4.0 you can use Firebase _Storage_ features.
-
-_Storage_ lets you upload and download files to/from Google Cloud Storage which is connected to your Firebase instance.
-
-If you didn't choose this feature during installation you can manually uncomment
-the relevant lines to add the SDK's to your app in
-[Podfile](../platforms/ios/Podfile) and [include.gradle](../platforms/android/include.gradle).
+During plugin installation you'll be asked whether or not you use "Firebase Storage".
-Just uncomment the relevant lines (one for each platform) to add the SDK's to your app.
+In case you're upgrading and you have the `firebase.nativescript.json` file in your project root, edit it and add: `"storage": true`.
+Then run `rm -rf platforms && rm -rf node_modules && npm i`.
-### Setting the storage bucket (optional since plugin version 6.5.0)
+### Setting the storage bucket (no longer required since plugin version 6.5.0)
If (in the odd situation) the storage bucket URL you want to use is different than the one in the downloaded config file,
you can tell Firebase what it should use instead.
@@ -62,6 +59,16 @@ You can either pass in a full local path to a file, or (as a convenience) use th
// determine the path to a file in the app/res folder
var logoPath = appPath + "/res/telerik-logo.png";
+ // if you don't want/need to include metadata, pass in an empty object ({}) to avoid errors
+ var metadata = {
+ contentType: "demo/test",
+ contentLanguage: "fr",
+ customMetadata: {
+ "foo": "bar",
+ "foo2": "bar2"
+ }
+ };
+
// now upload the file with either of the options below:
firebase.storage.uploadFile({
// optional, can be omitted since 6.5.0, and also be passed during init() as 'storageBucket' param so we can cache it (find it in the Firebase console)
@@ -76,7 +83,8 @@ You can either pass in a full local path to a file, or (as a convenience) use th
onProgress: function(status) {
console.log("Uploaded fraction: " + status.fractionCompleted);
console.log("Percentage complete: " + status.percentageCompleted);
- }
+ },
+ metadata
}).then(
function (uploadedFile) {
console.log("File uploaded: " + JSON.stringify(uploadedFile));
@@ -103,7 +111,16 @@ You can either pass in a full local path to a file, or (as a convenience) use th
const storageRef = firebaseWebApi.storage().ref();
const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
- childRef.put(fs.File.fromPath(logoPath)).then(
+ // if you don't want/need to include metadata, pass in an empty object ({}) to avoid errors
+ const metadata = {
+ contentType: "demo/test",
+ contentLanguage: "fr",
+ customMetadata: {
+ "foo": "bar",
+ "foo2": "bar2"
+ }
+ };
+ childRef.put(fs.File.fromPath(logoPath), metadata).then(
uploadedFile => console.log("Uploaded! " + JSON.stringify(uploadedFile)),
error => console.log("firebase.doWebUploadFile error: " + error)
);
@@ -211,6 +228,61 @@ In this example we'll determine the remote URL of the previously uploaded file.
```
+### listAll
+Note that your security rules must be version "2" for this to work,
+so if it fails try adding this at the top of your rules defined for your storage bucket: `rules_version = '2';`
+
+
+
+
+Native API
+ +```js + firebase.storage.listAll({ + // optional, can also be passed during init() as 'storageBucket' param so we can cache it + bucket: 'gs://n-plugin-test.appspot.com', + // the full path of an existing file in your Firebase storage + remoteFullPath: 'uploads/images' + }).then( + function (result) { + console.log(JSON.stringify(result)); + // see the Web API example below for an advanced example + }, + function (error) { + console.log(error); + } + ); +``` +
+
+
### deleteFile
You can pass in remote file path to delete it.
diff --git a/docs/images/admob-types.png b/docs/images/admob-types.png
new file mode 100644
index 00000000..39643a77
Binary files /dev/null and b/docs/images/admob-types.png differ
diff --git a/docs/images/app-signing.png b/docs/images/app-signing.png
new file mode 100644
index 00000000..ac90b141
Binary files /dev/null and b/docs/images/app-signing.png differ
diff --git a/docs/images/features/crashlytics.png b/docs/images/features/crashlytics.png
new file mode 100644
index 00000000..27606515
Binary files /dev/null and b/docs/images/features/crashlytics.png differ
diff --git a/docs/images/features/functions.png b/docs/images/features/functions.png
new file mode 100644
index 00000000..cb812e2f
Binary files /dev/null and b/docs/images/features/functions.png differ
diff --git a/docs/images/features/inappmessaging.png b/docs/images/features/inappmessaging.png
new file mode 100644
index 00000000..d83d6ccf
Binary files /dev/null and b/docs/images/features/inappmessaging.png differ
diff --git a/docs/images/features/mlkit_automl.png b/docs/images/features/mlkit_automl.png
new file mode 100644
index 00000000..f34efe6a
Binary files /dev/null and b/docs/images/features/mlkit_automl.png differ
diff --git a/docs/images/features/mlkit_custom_model_tflite.png b/docs/images/features/mlkit_custom_model_tflite.png
new file mode 100644
index 00000000..3e34088a
Binary files /dev/null and b/docs/images/features/mlkit_custom_model_tflite.png differ
diff --git a/docs/images/features/mlkit_language_detection.png b/docs/images/features/mlkit_language_detection.png
new file mode 100644
index 00000000..6f18c5c4
Binary files /dev/null and b/docs/images/features/mlkit_language_detection.png differ
diff --git a/docs/images/features/mlkit_object_detection.png b/docs/images/features/mlkit_object_detection.png
new file mode 100644
index 00000000..60537adf
Binary files /dev/null and b/docs/images/features/mlkit_object_detection.png differ
diff --git a/docs/images/features/mlkit_smart_reply.png b/docs/images/features/mlkit_smart_reply.png
new file mode 100644
index 00000000..fc6dd7d3
Binary files /dev/null and b/docs/images/features/mlkit_smart_reply.png differ
diff --git a/docs/images/features/mlkit_text_translation.png b/docs/images/features/mlkit_text_translation.png
new file mode 100644
index 00000000..fc944245
Binary files /dev/null and b/docs/images/features/mlkit_text_translation.png differ
diff --git a/docs/images/features/performance_monitoring.png b/docs/images/features/performance_monitoring.png
new file mode 100644
index 00000000..fd390e88
Binary files /dev/null and b/docs/images/features/performance_monitoring.png differ
diff --git a/docs/images/messaging/postman-headers.png b/docs/images/messaging/postman-headers.png
new file mode 100644
index 00000000..108cd7a0
Binary files /dev/null and b/docs/images/messaging/postman-headers.png differ
diff --git a/docs/images/messaging/postman-payload.png b/docs/images/messaging/postman-payload.png
new file mode 100644
index 00000000..1ab2d7c6
Binary files /dev/null and b/docs/images/messaging/postman-payload.png differ
diff --git a/docs/images/messaging/pusher.png b/docs/images/messaging/pusher.png
new file mode 100644
index 00000000..39d77361
Binary files /dev/null and b/docs/images/messaging/pusher.png differ
diff --git a/docs/images/mlkit-custom-cloud-model.png b/docs/images/mlkit-custom-cloud-model.png
new file mode 100644
index 00000000..3e31e8b6
Binary files /dev/null and b/docs/images/mlkit-custom-cloud-model.png differ
diff --git a/publish/scripts/installer.js b/publish/scripts/installer.js
index 38dc2bda..5aae77f0 100755
--- a/publish/scripts/installer.js
+++ b/publish/scripts/installer.js
@@ -3,7 +3,7 @@ var path = require('path');
var prompt = require('prompt-lite');
// Default settings for a few prompts
-var usingiOS = false, usingAndroid = false, externalPushClientOnly = false;
+var usingiOS = false, usingAndroid = false, externalPushClient = false;
// The directories where the Podfile and include.gradle are stored
var directories = {
@@ -13,7 +13,7 @@ var directories = {
console.log('NativeScript Firebase Plugin Installation');
-var appRoot = "../../";
+var appRoot = "../../../";
var pluginConfigFile = "firebase.nativescript.json";
var pluginConfigPath = path.join(appRoot, pluginConfigFile);
var config = {};
@@ -22,6 +22,8 @@ function mergeConfig(result) {
for (var key in result) {
config[key] = isSelected(result[key]);
}
+ // note that the semantics of "external_push_client_only" changed to "external push client" with plugin version 10.1.0
+ externalPushClient = isSelected(config["external_push_client_only"]);
}
function saveConfig() {
@@ -31,6 +33,7 @@ function saveConfig() {
function readConfig() {
try {
config = JSON.parse(fs.readFileSync(pluginConfigPath));
+ externalPushClient = isSelected(config["external_push_client_only"]);
} catch (e) {
console.log("Failed reading " + pluginConfigFile);
console.log(e);
@@ -48,33 +51,13 @@ if (process.argv.indexOf("config") === -1 && fs.existsSync(pluginConfigPath)) {
console.log("Config file exists (" + pluginConfigFile + ")");
askiOSPromptResult(config);
askAndroidPromptResult(config);
- askExternalPushMessagingOnlyPromptResult(config);
promptQuestionsResult(config);
} else if (!isInteractive()) {
console.log("No existing " + pluginConfigFile + " config file found and terminal is not interactive! Default configuration will be used.");
} else {
console.log("No existing " + pluginConfigFile + " config file found, so let's configure the Firebase plugin!");
prompt.start();
- askExternalPushMessagingOnlyPrompt();
-}
-
-/**
- * Prompt the user if they are integrating Firebase with iOS
- */
-function askExternalPushMessagingOnlyPrompt() {
- prompt.get({
- name: 'external_push_client_only',
- description: 'Are you using this plugin ONLY as a Push Notification client for an external (non-Firebase) Push service? (y/n)',
- default: 'n'
- }, function (err, result) {
- if (err) {
- return console.log(err);
- }
- console.log(">> askExternalPushMessagingOnlyPrompt result: " + JSON.stringify(result));
- mergeConfig(result);
- askExternalPushMessagingOnlyPromptResult(result);
- askiOSPrompt();
- });
+ askiOSPrompt();
}
/**
@@ -95,12 +78,6 @@ function askiOSPrompt() {
});
}
-function askExternalPushMessagingOnlyPromptResult(result) {
- if (isSelected(result.external_push_client_only)) {
- externalPushClientOnly = true;
- }
-}
-
function askiOSPromptResult(result) {
if (isSelected(result.using_ios)) {
usingiOS = true;
@@ -121,11 +98,8 @@ function askAndroidPrompt() {
}
mergeConfig(result);
askAndroidPromptResult(result);
- if ((usingiOS || usingAndroid) && !externalPushClientOnly) {
+ if (usingiOS || usingAndroid) {
promptQuestions();
- } else if (externalPushClientOnly) {
- promptQuestionsResult(result);
- askSaveConfigPrompt();
} else {
askSaveConfigPrompt();
}
@@ -143,6 +117,10 @@ function askAndroidPromptResult(result) {
*/
function promptQuestions() {
prompt.get([{
+ name: 'analytics',
+ description: 'Do you want to enable Firebase Analytics? (y/n)',
+ default: 'y'
+ }, {
name: 'firestore',
description: 'Are you using Firestore? (y/n)',
default: 'n'
@@ -158,22 +136,34 @@ function promptQuestions() {
name: 'remote_config',
description: 'Are you using Firebase RemoteConfig? (y/n)',
default: 'n'
+ }, {
+ name: 'performance_monitoring',
+ description: 'Are you using Performance Monitoring? (y/n)',
+ default: 'n'
+ }, {
+ name: 'external_push_client_only',
+ description: 'Are you using this plugin as a Push Notification client for an external (NOT Firebase Cloud Messaging) Push service? (y/n)',
+ default: 'n'
}, {
name: 'messaging',
- description: 'Are you using Firebase Messaging? (y/n)',
+ description: 'Are you using Firebase Cloud Messaging? (y/n)',
default: 'n'
}, {
- name: 'crashlytics',
- description: 'Are you using Firebase Crashlytics? (y/n)',
+ name: 'in_app_messaging',
+ description: 'Are you using In-App Messaging? (y/n)',
default: 'n'
}, {
- name: 'crash_reporting',
- description: 'Are you using Firebase Crash Reporting? (answer "n" if you want to use Crashlytics instead) (y/n)',
+ name: 'crashlytics',
+ description: 'Are you using Firebase Crashlytics? (y/n)',
default: 'n'
}, {
name: 'storage',
description: 'Are you using Firebase Storage? (y/n)',
default: 'n'
+ }, {
+ name: 'functions',
+ description: 'Are you using Firebase Cloud Functions? (y/n)',
+ default: 'n'
}, {
name: 'facebook_auth',
description: 'Are you using Firebase Facebook Authentication? (y/n)',
@@ -186,10 +176,6 @@ function promptQuestions() {
name: 'admob',
description: 'Are you using AdMob? (y/n)',
default: 'n'
- }, {
- name: 'invites',
- description: 'Are you using Firebase Invites? (y/n)',
- default: 'n'
}, {
name: 'dynamic_links',
description: 'Are you using Firebase Dynamic Links? (y/n)',
@@ -209,34 +195,51 @@ function promptQuestions() {
} else {
prompt.get([{
name: 'ml_kit_text_recognition',
- description: 'With Ml Kit, do you want to recognize text? (y/n)',
+ description: 'With ML Kit, do you want to recognize text? (y/n)',
default: 'n'
}, {
name: 'ml_kit_barcode_scanning',
- description: 'With Ml Kit, do you want to scan barcodes? (y/n)',
+ description: 'With ML Kit, do you want to scan barcodes? (y/n)',
default: 'n'
}, {
name: 'ml_kit_face_detection',
- description: 'With Ml Kit, do you want to detect faces? (y/n)',
+ description: 'With ML Kit, do you want to detect faces? (y/n)',
default: 'n'
}, {
name: 'ml_kit_image_labeling',
- description: 'With Ml Kit, do you want to label images? (y/n)',
+ description: 'With ML Kit, do you want to label images? (y/n)',
+ default: 'n'
+ }, {
+ name: 'ml_kit_object_detection',
+ description: 'With ML Kit, do you want to use Object Detection and Tracking? (y/n)',
+ default: 'n'
+ }, {
+ name: 'ml_kit_automl',
+ description: 'With ML Kit, do you want to use AutoML Vision Edge to label images with your own models? (y/n)',
default: 'n'
}, {
name: 'ml_kit_custom_model',
- description: 'With Ml Kit, do you want to use a custom TensorFlow Lite model? (y/n)',
+ description: 'With ML Kit, do you want to use a custom TensorFlow Lite model? (y/n)',
+ default: 'n'
+ }, {
+ name: 'ml_kit_natural_language_identification',
+ description: 'With ML Kit, do you want to recognize natural languages? (y/n)',
+ default: 'n'
+ }, {
+ name: 'ml_kit_natural_language_translation',
+ description: 'With ML Kit, do you want to translate text? (y/n)',
+ default: 'n'
+ }, {
+ name: 'ml_kit_natural_language_smartreply',
+ description: 'With ML Kit, do you want to use smart reply? (y/n)',
default: 'n'
}], function (mlkitErr, mlkitResult) {
if (mlkitErr) {
return console.log(mlkitErr);
}
- console.log("result: " + JSON.stringify(result));
- console.log("mlkitResult: " + JSON.stringify(mlkitResult));
for (var attrname in mlkitResult) {
result[attrname] = mlkitResult[attrname];
}
- console.log("mergedResult result: " + JSON.stringify(result));
mergeConfig(result);
promptQuestionsResult(result);
askSaveConfigPrompt();
@@ -247,11 +250,10 @@ function promptQuestions() {
function promptQuestionsResult(result) {
if (usingiOS) {
- if (!externalPushClientOnly) {
- writePodFile(result);
- exposeAdMobSymbols(isSelected(result.admob));
- }
- writeBuildscriptHook(isSelected(result.crashlytics));
+ writePodFile(result);
+ writeGoogleServiceCopyHook();
+ writeBuildscriptHookForCrashlytics(isSelected(result.crashlytics));
+ activateIOSMLKitCameraFramework(isSelected(result.ml_kit));
}
if (usingAndroid) {
@@ -259,6 +261,8 @@ function promptQuestionsResult(result) {
writeGoogleServiceCopyHook();
writeGoogleServiceGradleHook(result);
echoAndroidManifestChanges(result);
+ activateAndroidPushNotificationsLib(isSelected(result.messaging) || isSelected(result.external_push_client_only));
+ activateAndroidMLKitCustomModelLib(isSelected(result.ml_kit) && isSelected(result.ml_kit_custom_model));
}
console.log('Firebase post install completed. To re-run this script, navigate to the root directory of `nativescript-plugin-firebase` in your `node_modules` folder and run: `npm run config`.');
@@ -290,11 +294,27 @@ function echoAndroidManifestChanges(result) {
}
}
-function exposeAdMobSymbols(enable) {
- if (enable && fs.existsSync(directories.ios + '/build.xcconfig.admob')) {
- fs.renameSync(directories.ios + '/build.xcconfig.admob', directories.ios + '/build.xcconfig');
- } else if (!enable && fs.existsSync(directories.ios + '/build.xcconfig')) {
- fs.renameSync(directories.ios + '/build.xcconfig', directories.ios + '/build.xcconfig.admob');
+function activateAndroidPushNotificationsLib(enable) {
+ if (enable && fs.existsSync(path.join(directories.android, 'firebase-release.aar-disabled'))) {
+ fs.renameSync(path.join(directories.android, 'firebase-release.aar-disabled'), path.join(directories.android, 'firebase-release.aar'));
+ } else if (!enable && fs.existsSync(path.join(directories.android, 'firebase-release.aar'))) {
+ fs.renameSync(path.join(directories.android, 'firebase-release.aar'), path.join(directories.android, 'firebase-release.aar-disabled'));
+ }
+}
+
+function activateAndroidMLKitCustomModelLib(enable) {
+ if (enable && fs.existsSync(path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar-disabled'))) {
+ fs.renameSync(path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar-disabled'), path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar'));
+ } else if (!enable && fs.existsSync(path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar'))) {
+ fs.renameSync(path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar'), path.join(directories.android, 'nativescript-firebase-mlkit-helper.jar-disabled'));
+ }
+}
+
+function activateIOSMLKitCameraFramework(enable) {
+ if (enable && fs.existsSync(path.join(directories.ios, 'TNSMLKitCamera.framework-disabled'))) {
+ fs.renameSync(path.join(directories.ios, 'TNSMLKitCamera.framework-disabled'), path.join(directories.ios, 'TNSMLKitCamera.framework'));
+ } else if (!enable && fs.existsSync(path.join(directories.ios, 'TNSMLKitCamera.framework'))) {
+ fs.renameSync(path.join(directories.ios, 'TNSMLKitCamera.framework'), path.join(directories.ios, 'TNSMLKitCamera.framework-disabled'));
}
}
@@ -324,13 +344,19 @@ function writePodFile(result) {
}
try {
fs.writeFileSync(directories.ios + '/Podfile',
- `pod 'Firebase/Core', '~> 5.6.0'
+// The MLVision pod requires a minimum of iOS 9, otherwise the build will fail
+(isPresent(result.ml_kit) ? `` : `#`) + `platform :ios, '9.0'
+
+` + (!isSelected(result.external_push_client_only) ? `` : `#`) + `pod 'Firebase/Core', '~>6.34.0'
+
+# Analytics
+` + (isSelected(result.analytics) || isSelected(result.crashlytics) || (!isSelected(result.external_push_client_only) && !isPresent(result.analytics)) ? `` : `#`) + `pod 'Firebase/Analytics'
# Authentication
-` + (!isPresent(result.authentication) || isSelected(result.authentication) ? `` : `#`) + `pod 'Firebase/Auth'
+` + (isSelected(result.authentication) || (!isSelected(result.external_push_client_only) && !isPresent(result.external_push_client_only)) ? `` : `#`) + `pod 'Firebase/Auth'
# Realtime DB
-` + (!isPresent(result.realtimedb) || isSelected(result.realtimedb) ? `` : `#`) + `pod 'Firebase/Database'
+` + (isSelected(result.realtimedb) || (!isSelected(result.external_push_client_only) && !isPresent(result.realtimedb)) ? `` : `#`) + `pod 'Firebase/Database'
# Cloud Firestore
` + (isSelected(result.firestore) ? `` : `#`) + `pod 'Firebase/Firestore'
@@ -338,12 +364,11 @@ function writePodFile(result) {
# Remote Config
` + (isSelected(result.remote_config) ? `` : `#`) + `pod 'Firebase/RemoteConfig'
-# Crash Reporting
-` + (isSelected(result.crash_reporting) && !isSelected(result.crashlytics) ? `` : `#`) + `pod 'Firebase/Crash'
+# Performance Monitoring
+` + (isSelected(result.performance_monitoring) ? `` : `#`) + `pod 'Firebase/Performance'
# Crashlytics
-` + (isSelected(result.crashlytics) ? `` : `#`) + `pod 'Fabric'
-` + (isSelected(result.crashlytics) ? `` : `#`) + `pod 'Crashlytics'
+` + (isSelected(result.crashlytics) ? `` : `#`) + `pod 'Firebase/Crashlytics'
` + (!isSelected(result.crashlytics) ? `` : `
# Crashlytics works best without bitcode
post_install do |installer|
@@ -358,15 +383,18 @@ end`) + `
# Firebase Cloud Messaging (FCM)
` + (isSelected(result.messaging) ? `` : `#`) + `pod 'Firebase/Messaging'
-# Firebase Storage
+# Firebase In-App Messaging
+` + (isSelected(result.in_app_messaging) ? `` : `#`) + `pod 'Firebase/InAppMessaging'
+
+# Firebase Cloud Storage
` + (isSelected(result.storage) ? `` : `#`) + `pod 'Firebase/Storage'
+# Firebase Cloud Functions
+` + (isSelected(result.functions) ? `` : `#`) + `pod 'Firebase/Functions'
+
# AdMob
` + (isSelected(result.admob) ? `` : `#`) + `pod 'Firebase/AdMob'
-# Invites
-` + (isSelected(result.invites) ? `` : `#`) + `pod 'Firebase/Invites'
-
# Dynamic Links
` + (isSelected(result.dynamic_links) ? `` : `#`) + `pod 'Firebase/DynamicLinks'
@@ -376,14 +404,21 @@ end`) + `
` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_barcode_scanning) ? `` : `#`) + `pod 'Firebase/MLVisionBarcodeModel'
` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_face_detection) ? `` : `#`) + `pod 'Firebase/MLVisionFaceModel'
` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_image_labeling) ? `` : `#`) + `pod 'Firebase/MLVisionLabelModel'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_object_detection) ? `` : `#`) + `pod 'Firebase/MLVisionObjectDetection'
` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_custom_model) ? `` : `#`) + `pod 'Firebase/MLModelInterpreter'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_automl) ? `` : `#`) + `pod 'Firebase/MLVisionAutoML'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_natural_language_identification) ? `` : `#`) + `pod 'Firebase/MLNaturalLanguage'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_natural_language_identification) ? `` : `#`) + `pod 'Firebase/MLNLLanguageID'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_natural_language_translation) ? `` : `#`) + `pod 'Firebase/MLNLTranslate'
+` + (isSelected(result.ml_kit) && (isSelected(result.ml_kit_natural_language_smartreply) || isSelected(result.ml_kit_natural_language_translation)) ? `` : `#`) + `pod 'Firebase/MLCommon'
+` + (isSelected(result.ml_kit) && isSelected(result.ml_kit_natural_language_smartreply) ? `` : `#`) + `pod 'Firebase/MLNLSmartReply'
# Facebook Authentication
` + (isSelected(result.facebook_auth) ? `` : `#`) + `pod 'FBSDKCoreKit'
` + (isSelected(result.facebook_auth) ? `` : `#`) + `pod 'FBSDKLoginKit'
# Google Authentication
-` + (isSelected(result.google_auth) ? `` : `#`) + `pod 'GoogleSignIn'`);
+` + (isSelected(result.google_auth) ? `` : `#`) + `pod 'GoogleSignIn', '~> 5.0.2'`);
console.log('Successfully created iOS (Pod) file.');
} catch (e) {
console.log('Failed to create iOS (Pod) file.');
@@ -396,7 +431,7 @@ end`) + `
*
* @param {any} enable Is Crashlytics enabled
*/
-function writeBuildscriptHook(enable) {
+function writeBuildscriptHookForCrashlytics(enable) {
var scriptPath = path.join(appRoot, "hooks", "after-prepare", "firebase-crashlytics-buildscript.js");
if (!enable) {
@@ -420,7 +455,7 @@ const pattern3 = /\\n\\s*\\/\\/Crashlytics 3 BEGIN[\\s\\S]*\\/\\/Crashlytics 3 E
const string1 = \`
//Crashlytics 1 BEGIN
#else
-#import