Merge remote-tracking branch 'refs/remotes/EddyVerbruggen/master'

Author: guillaume-roy

.npmignore

@@ -1 +1,2 @@
-platforms/android/libraryproject/
+platforms/android/libraryproject/
+docs

CHANGELOG.md

@@ -0,0 +1,125 @@
+<img src="docs/images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
+
+## 3.4.4 (2016, July 17)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.4.3...3.4.4)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.3.x
+- Android: 9.2.0
+
+### New
+- [#75](#75) [Nathan Walker](https://github.com/NathanWalker) added the ability to remove files from Firebase Storage, thanks Nathan!
+
+
+
+## 3.4.3 (2016, July 16)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.4.2...3.4.3)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.3.x
+- Android: 9.2.0
+
+### New
+- [#74](#74) Facebook login for Android.
+
+
+
+## 3.4.2 (2016, July 14)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.4.0...3.4.2)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.3.x
+- Android: 9.2.0
+
+### New
+- [#61](#61) Added `keepInSync` for enhanced offline support.
+- [#65](#65) Crash Reporting, which is automatically enabled for you.
+
+### Fixes
+- [#68](#68) Fix an issue where you'd log in on Android before `application.start()`.
+- [#70](#70) Added a TypeScript definition for `getCurrentUser()`.
+- [#71](#71) Added a TypeScript definition for LoginResult.email.
+
+
+
+## 3.4.0 (2016, July 7)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.3.0...3.4.0)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.3.x
+- Android: 9.2.0
+
+### New
+- [#43](#43) Storage ([docs](docs/STORAGE.md))
+- [#66](#66) Added `iOSSimulatorFlush` for a known iOS emulator issue with `invalid_token`
+
+### Fixes
+- [#69](#69) Fix `onAuthStateChanged` feature on `init`
+
+
+## 3.3.0 (2016, June 26)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.2.0...3.3.0)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.2.x
+- Android: 9.0.2
+
+### New
+- [#54](#54) FCM Messaging / Push Notifications ([docs](docs/MESSAGING.md))
+
+
+## 3.2.0 (2016, June 19)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.1.0...3.2.0)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.2.0
+- Android: 9.0.2
+
+### New
+- [#56](#56) Remote Config ([docs](docs/REMOTECONFIG.md))
+
+
+## 3.1.0 (2016, June 17)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.0.0...3.1.0)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.2.0
+- Android: 9.0.0
+
+### New
+- [#49](#49) Custom Authentication ([docs](docs/AUTHENTICATION.md#custom-login))
+
+
+## 3.0.0 (2016, May 26)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/2.1.8...3.0.0)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.2.0
+- Android: 9.0.0
+
+### New
+- [#34](#34) Support new Firebase 3 release

README.md

@@ -1,15 +1,18 @@
 # NativeScript Firebase plugin
 
-<img src="docs/images/firebase.png" width="154px" height="43px" alt="Firebase"/><br/>
+<img src="docs/images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/><br/>
 Google's realtime app platform (Database, Authentication, Configuration, Notifications) [firebase.google.com](https://firebase.google.com/)
 
-### Use when
-* you need to store JSON data in the cloud (but don't want to loose data when the device is offline),
-* you want to sync that data to other devices and platforms,
-* you want to optionally protect that data by having users log in,
-* you want to update clients at the moment the data changes (think chat and multiplayer games),
-* you want an easy way to remotely configure app features,
-* you want push notifications.
+## Features
+For readability the supported features have been moved to their own README's:
+
+* Setup and troubleshooting (continue reading below)
+* [Realtime Database](docs/DATABASE.md)
+* [Authentication](docs/AUTHENTICATION.md)
+* [Remote Config](docs/REMOTECONFIG.md)
+* [Cloud Messaging](docs/MESSAGING.md)
+* [Storage](docs/STORAGE.md)
+* [Crash Reporting](docs/CRASHREPORTING.md)
 
 ## Prerequisites
 Head on over to [https://console.firebase.google.com/](https://console.firebase.google.com/) and sign up for a free account.
@@ -112,15 +115,6 @@ firebase.init({
 );
 ```
 
-## Features
-For readability the supported features have been moved to their own README's:
-
-* [Realtime Database](docs/DATABASE.md)
-* [Authentication](docs/AUTHENTICATION.md)
-* [Remote Config](docs/REMOTECONFIG.md)
-* [Cloud Messaging](docs/MESSAGING.md)
-
-
 ## Known issues on iOS
 On the simulator you may see this message if you have more than one app with the Firebase SDK ever installed:
 

docs/AUTHENTICATION.md

@@ -1,17 +1,12 @@
-<table>
-<tr>
-<td><img src="images/firebase.png" width="154px" height="43px" alt="Firebase"/></td>
-<td>Authentication</td>
-</tr>
-</table>
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
 ## Enabling Authentication
 Version 1.1.0 of this plugin added the capability to log your users in, either
 
 * anonymously,
 * by email and password,
 * using a custom token,
-* using Facebook (iOS: solid, Android: experimental).
+* using Facebook.
 
 Each of these login mechanisms need to be enabled in your Firebase console at the 'Login & Auth' tab.
 
@@ -185,13 +180,15 @@ Use this login type to authenticate against firebase using a token generated by
 ```
 
 ### Facebook login
-On iOS this is rock solid, but on Android it's work in progress. If you want to use it for iOS open the `Podfile` in the plugin's `platforms/ios` folder and uncomment the Facebook line (you can't miss it).
 
-Don't forget to enable Facebook login in your firebase instance.
+First, enable Facebook login in your firebase instance and add the App-ID and App-Secret.
+
+Then add the following lines to your code and check for setup instructions for your platform below.
 
 ```js
   firebase.login({
-    type: firebase.LoginType.FACEBOOK
+    type: firebase.LoginType.FACEBOOK,
+    scope: ['public_profile', 'email'] // optional: defaults
   }).then(
       function (result) {
         JSON.stringify(result);
@@ -202,6 +199,38 @@ Don't forget to enable Facebook login in your firebase instance.
   )
 ```
 
+For a complete list of the available scope permissions, visit Facebook's documentation: https://developers.facebook.com/docs/facebook-login/permissions. 
+
+#### iOS
+ If you want to use it for iOS open the `Podfile` in the plugin's `platforms/ios` folder and uncomment the Facebook line (you can't miss it).
+
+#### Android
+
+1. Uncomment the facebook SDK in `node_modules\nativescript-plugin-firebase\platforms\android\include.gradle`
+2. Add `<meta-data android:name="com.facebook.sdk.ApplicationId" android:value="@string/facebook_app_id"/>` to the `manifest/application tag` in `app\App_Resources\Android\AndroidManifest.xml`, so it becomes similar to this:
+
+   ```xml
+   	<application
+   		android:name="com.tns.NativeScriptApplication"
+   		..>
+   		
+   		<meta-data android:name="com.facebook.sdk.ApplicationId" android:value="@string/facebook_app_id"/>
+   
+   		<activity
+   			android:name="com.tns.NativeScriptActivity"
+   			..>
+   ```
+3. Create a file `app\App_Resources\Android\values\facebooklogin.xml` and add this (replace the id):
+
+   ```xml
+   <?xml version='1.0' encoding='utf-8'?>
+   <resources>
+        <string name="facebook_app_id">126035687816994</string>
+   </resources>
+   ```
+4. In your Facebook dev console, go to the Basic settings and add the Android platform if you haven't already. Then set the 'Google Play Packagename' to your applicationId (see your `package.json`) and set 'Classname' to `com.tns.NativeScriptActivity`.
+5. Set the Key-Hash as well. If you don't know it you can try Facebook login in your app and observe the `adb logcat` output for something like `Key hash <......> does not match any stored key hashes.` 
+
 ### logout
 Shouldn't be more complicated than:
 

docs/CRASHREPORTING.md

@@ -0,0 +1,13 @@
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
+
+## Enabling Crash Reporting
+Nothing to do - since plugin version 3.4.2 this plugin automatically uploads
+crashes to your Firebase Console. Just check the 'Crash' menu item every now and then.
+
+## Making sense of the stacktraces
+Please read [the official docs](https://firebase.google.com/docs/crash/)
+on what Crash reporting is and what you can do to have a better experience.
+
+## Future work
+There's an option to send logs to Firebase along with the crash in order
+to add some context. This is however currently problematic on iOS but we'll keep an eye out.

docs/DATABASE.md

@@ -1,9 +1,4 @@
-<table>
-<tr>
-<td><img src="images/firebase.png" width="154px" height="43px" alt="Firebase"/></td>
-<td>Database</td>
-</tr>
-</table>
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
 If you can spare 41 seconds, check (an older version of) this plugin's [demo app](https://github.com/EddyVerbruggen/nativescript-plugin-firebase-demo) in action:
 [![YouTube demo, 41 sec](images/yt-thumb-database.png)](https://youtu.be/7zYU5e0Djkw "YouTube demo, 41 sec")
@@ -163,4 +158,25 @@ but if you only want to wipe everything at `/users`, do this:
 
 ```js
   firebase.remove("/users");
-```
+```
+
+### 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.
+
+The client will automatically download the data at these locations and keep it in sync even if the reference has no active listeners.
+
+```js
+  firebase.keepInSync(
+    "/users", // which path in your Firebase needs to be kept in sync?
+    true      // set to false to disable this feature again
+  ).then(
+    function () {
+      console.log("firebase.keepInSync is ON for /users");
+    },
+    function (error) {
+      console.log("firebase.keepInSync error: " + error);
+    }
+  );
+```
+
+By default, 10MB of previously synced data will be cached. If the cache outgrows its configured size, the Firebase Realtime Database will purge data that has been used least recently. Data that is kept in sync, will not be purged from the cache. _(From the official doc for [iOS](https://firebase.google.com/docs/database/ios/offline-capabilities) and [Android](https://firebase.google.com/docs/database/android/offline-capabilities))._

docs/MESSAGING.md

@@ -1,9 +1,4 @@
-<table>
-<tr>
-<td><img src="images/firebase.png" width="154px" height="43px" alt="Firebase"/></td>
-<td>Cloud Messaging</td>
-</tr>
-</table>
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
 ## Enabling Firebase Cloud Messaging (FCM)
 Version 3.3.0 of this plugin added FCM support (which is the successor of GCM).

docs/REMOTECONFIG.md

@@ -1,9 +1,4 @@
-<table>
-<tr>
-<td><img src="images/firebase.png" width="154px" height="43px" alt="Firebase"/></td>
-<td>Remote Config</td>
-</tr>
-</table>
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
 ## Enabling Remote Config
 Since plugin version 3.2.0 you can retrieve _Remote Config_ properties.