Merge branch 'master' into master

Author: jamesdaniels

.travis.yml

@@ -26,7 +26,7 @@ before_script:
 
 script:
   - npm run build
-  - ./node_modules/.bin/karma start --single-run --browsers Chrome --reporters mocha
+  - ./node_modules/.bin/karma start --single-run --browsers Firefox --reporters mocha
   # Run integration test to make sure our typings are correct for user-land.
   - node tools/run-typings-test.js
 

CHANGELOG.md

@@ -1,5 +1,19 @@
+<a name="5.0.0-rc.4"></a>
+# [5.0.0-rc.4](https://github.com/angular/angularfire2/compare/5.0.0-rc.3...5.0.0-rc.4) (2017-11-17)
+
+
+### Bug Fixes
+
+* **afs:** added missing type to doc() ([#1286](https://github.com/angular/angularfire2/issues/1286)) ([3e00e16](https://github.com/angular/angularfire2/commit/3e00e16))
+* **afs:** allow document set options ([#1333](https://github.com/angular/angularfire2/issues/1333)) ([81018ed](https://github.com/angular/angularfire2/commit/81018ed)), closes [#1332](https://github.com/angular/angularfire2/issues/1332)
+* **afs:** catch error when enabling persistence ([#1300](https://github.com/angular/angularfire2/issues/1300)) ([61245a3](https://github.com/angular/angularfire2/commit/61245a3))
+* **afs:** export interfaces ([#1277](https://github.com/angular/angularfire2/issues/1277)) ([4a21857](https://github.com/angular/angularfire2/commit/4a21857))
+* **db:** inherit generics in valueChanges interface ([10afd64](https://github.com/angular/angularfire2/commit/10afd64)), closes [#1214](https://github.com/angular/angularfire2/issues/1214)
+* **db:** update should take a Partial<T> object ([#1330](https://github.com/angular/angularfire2/issues/1330)) ([20e66f5](https://github.com/angular/angularfire2/commit/20e66f5)), closes [#1329](https://github.com/angular/angularfire2/issues/1329)
+
+
 <a name="5.0.0-rc.3"></a>
-# [5.0.0-rc.3](https://github.com/angular/angularfire2/compare/2.0.0-beta.8...5.0.0-rc.3) (2017-10-14)
+# [5.0.0-rc.3](https://github.com/angular/angularfire2/compare/5.0.0-rc.2...5.0.0-rc.3) (2017-10-14)
 
 
 ### Bug Fixes

docs/auth/getting-started.md

@@ -10,14 +10,13 @@ the Firebase docs for more information on what methods are available.](https://f
 
 ```ts
 import { Component } from '@angular/core';
-import { Observable } from 'rxjs/Observable';
 import { AngularFireAuth } from 'angularfire2/auth';
 import * as firebase from 'firebase/app';
 
 @Component({
   selector: 'app-root',
   template: `
-    <div *ngIf="afAuth.authState | async; let user; else showLogin">
+    <div *ngIf="afAuth.authState | async as user; else showLogin">
       <h1>Hello {{ user.displayName }}!</h1>
       <button (click)="logout()">Logout</button>
     </div>

docs/firestore/collections.md

@@ -37,7 +37,7 @@ export class AppComponent {
 }
 ```
 
-The `AngularFirestoreCollection` is service you use to create streams of the collection and perform data operations on the underyling collection.
+The `AngularFirestoreCollection` is a service you use to create streams of the collection and perform data operations on the underyling collection.
 
 ### The `DocumentChangeAction` type
 
@@ -78,7 +78,7 @@ There are multiple ways of streaming collection data from Firestore.
 
 **Why would you use it?** - When you just need a list of data. No document metadata is attached to the resulting array which makes it simple to render to a view.
 
-**When would you not use it?** - When you need a more complex data structure than an array or you need the `id` of each document to use data manipulation metods. This method assumes you either are saving the `id` to the document data or using a "readonly" approach.
+**When would you not use it?** - When you need a more complex data structure than an array or you need the `id` of each document to use data manipulation methods. This method assumes you either are saving the `id` to the document data or using a "readonly" approach.
 
 **Best practices** - Use this method to display data on a page. It's simple but effective. Use `.snapshotChanges()` once your needs become more complex.
 
@@ -220,8 +220,6 @@ export class AppComponent {
 
 **When would you not use it?** - When you just need a list of data. This is a more advanced usage of AngularFirestore. 
 
-**Best Practices** - 
-
 #### Example
 ```ts
 import { Component } from '@angular/core';
@@ -262,16 +260,14 @@ export class AppComponent {
 
 There are three `DocumentChangeType`s in Firestore: `added`, `removed`, and `modified`. Each streaming method listens to all three by default. However, you may only be intrested in one of these events. You can specify which events you'd like to use through the first parameter of each method:
 
-#### Basic smaple
+#### Basic sample
 ```ts
   constructor(private afs: AngularFirestore): {
     this.itemsCollection = afs.collection<Item>('items');
     this.items = this.itemsCollection.snapshotChanges(['added', 'removed']);
   }
 ```
 
-**Note:** Using 
-
 #### Component Sample
 ```ts
 import { Component } from '@angular/core';

docs/ionic/v3.md

@@ -125,7 +125,7 @@ Alternatively you can open `package.json` to ensure you've got the following Ang
     "@ionic-native/splash-screen": "3.12.1",
     "@ionic-native/status-bar": "3.12.1",
     "@ionic/storage": "2.0.1",
-    "ionic-angular": "3.5.0",
+    "ionic-angular": "3.6.0",
     "ionicons": "3.0.0",
     "rxjs": "5.4.0",
     "sw-toolbox": "3.6.0",

docs/rtdb/lists.md

@@ -91,9 +91,9 @@ AngularFire provides methods that stream data back as redux compatible actions.
 **When would you not use it?** - When you need a more complex data structure than an array or if you need to process changes as they occur. This array is synchronized with the remote and local changes in the Firebase Database.
 
 ### `stateChanges()`
-**What is it?** - Returns an Observable of the most recent changes as a `AngularFireAction[]`. 
+**What is it?** - Returns an Observable of the most recent change as an `AngularFireAction`. 
 
-**Why would you use it?** - The above methods return a synchronized array sorted in query order. `stateChanges()` emits changes as they occur rather than syncing the query order. This works well for ngrx integrations as you can build your own data structure in your reducer methods.
+**Why would you use it?** - The above methods return a singular `AngularFireAction` from each child event that occurs. `stateChanges()` emits changes as they occur rather than syncing the query order. This works well for ngrx integrations as you can build your own data structure in your reducer methods.
 
 **When would you not use it?** - When you just need a list of data. This is a more advanced usage of `AngularFireDatabase`. 
 

docs/rtdb/objects.md

@@ -157,17 +157,8 @@ export class AppComponent {
 }
 ```
 
-## Meta-fields on the object
-Data retrieved from the object binding contains special properties retrieved from the unwrapped Firebase DataSnapshot.
-
-| property |                    | 
-| ---------|--------------------| 
-| `$key`     | The key for each record. This is equivalent to each record's path in our database as it would be returned by `ref.key()`.|
-| `$value`   | If the data for this child node is a primitive (number, string, or boolean), then the record itself will still be an object. The primitive value will be stored under `$value` and can be changed and saved like any other field.|
-
-
 ## Retrieving the snapshot
-AngularFire unwraps the Firebase DataSnapshot by default, but you can get the data as the original snapshot by specifying the `preserveSnapshot` option. 
+AngularFire `valueChanges()` unwraps the Firebase DataSnapshot by default, but you can get the data as the original snapshot by using the `snapshotChanges()` option.
 
 ```ts
 this.itemRef = db.object('item');

docs/version-5-upgrade.md

@@ -34,18 +34,20 @@ Calling `.valueChanges()` returns an Observable without any metadata. If you are
 ### 4.0
 ```ts
 constructor(afDb: AngularFireDatabase) {
-  afDb.object('items/1').subscribe(item => console.log(item.$key));
+  afDb.list('items').subscribe(items => { 
+    const allKeys = items.map(item => item.$key);
+  });
 }
 ```
 
 ### 5.0
 ```ts
 constructor(afDb: AngularFireDatabase) {
-  afDb.object('items/1').snapshotChanges().map(action => {
-    const $key = action.payload.key;
-    const data = { $key, ...action.payload.val() };
-    return data;
-  }).subscribe(item => console.log(item.$key));
+  afDb.list('items').snapshotChanges().map(actions => {
+    return actions.map(action => ({ key: action.key, ...action.payload.val() }));
+  }).subscribe(items => {
+    return items.map(item => item.key);
+  });
 }
 ```
 

karma.conf.js

@@ -31,6 +31,7 @@ module.exports = function(config) {
       'dist/packages-dist/bundles/auth.umd.{js,map}',
       'dist/packages-dist/bundles/database.umd.{js,map}',
       'dist/packages-dist/bundles/firestore.umd.{js,map}',
+      'dist/packages-dist/bundles/storage.umd.{js,map}',
       'dist/packages-dist/bundles/database-deprecated.umd.{js,map}',
       'dist/packages-dist/bundles/test.umd.{js,map}',
     ],
@@ -40,7 +41,7 @@ module.exports = function(config) {
     logLevel: config.LOG_INFO,
     autoWatch: true,
     reporters: ['mocha'],
-    browsers: ['Chrome'],
+    browsers: ['Firefox'],
     singleRun: false
   })
 };

package.json

@@ -1,12 +1,13 @@
 {
   "name": "angularfire2",
-  "version": "5.0.0-rc.3",
+  "version": "5.0.0-rc.6",
   "description": "The official library of Firebase and Angular.",
   "private": true,
   "scripts": {
     "test": "npm run build && karma start --single-run",
     "test:watch": "concurrently \"npm run build:watch\" \"npm run delayed_karma\"",
     "test:debug": "npm run build && karma start",
+    "karma": "karma start",
     "test:universal": "npm run build && cp -R dist/packages-dist test/universal-test/node_modules/angularfire2 && cd test/universal-test && npm run prerender",
     "delayed_karma": "sleep 10 && karma start",
     "build": "rm -rf dist && node tools/build.js",
@@ -28,18 +29,29 @@
   },
   "homepage": "https://github.com/angular/angularfire2#readme",
   "dependencies": {
-    "@angular/common": "^4.0.0",
-    "@angular/compiler": "^4.0.0",
-    "@angular/core": "^4.0.0",
-    "@angular/platform-browser": "^4.0.0",
-    "@angular/platform-browser-dynamic": "^4.0.0",
-    "firebase": "^4.5.0",
-    "rxjs": "^5.0.1",
+    "@angular/common": "^5.0.0",
+    "@angular/compiler": "^5.0.0",
+    "@angular/core": "^5.0.0",
+    "@angular/platform-browser": "^5.0.0",
+    "@angular/platform-browser-dynamic": "^5.0.0",
+    "@firebase/app": "^0.1.6",
+    "@firebase/app-types": "^0.1.1",
+    "@firebase/auth": "^0.3.2",
+    "@firebase/auth-types": "^0.1.1",
+    "@firebase/database": "^0.1.7",
+    "@firebase/database-types": "^0.1.1",
+    "@firebase/firestore": "^0.2.3",
+    "@firebase/firestore-types": "^0.1.1",
+    "@firebase/messaging-types": "^0.1.1",
+    "@firebase/storage": "^0.1.6",
+    "@firebase/storage-types": "^0.1.1",
+    "firebase": "^4.8.2",
+    "rxjs": "^5.5.4",
     "zone.js": "^0.8.0"
   },
   "devDependencies": {
-    "@angular/compiler-cli": "^4.0.0",
-    "@angular/platform-server": "^4.0.0-rc.5",
+    "@angular/compiler-cli": "^5.0.0",
+    "@angular/platform-server": "^5.0.0",
     "@types/jasmine": "^2.5.36",
     "@types/request": "0.0.30",
     "concurrently": "^2.2.0",
@@ -55,9 +67,9 @@
     "jasmine": "^2.4.1",
     "jasmine-core": "^2.4.1",
     "json": "^9.0.3",
-    "karma": "^0.13.19",
-    "karma-chrome-launcher": "^0.2.2",
-    "karma-firefox-launcher": "^0.1.7",
+    "karma": "^2.0.0",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-firefox-launcher": "^1.1.0",
     "karma-jasmine": "^0.3.6",
     "karma-mocha-reporter": "^2.0.2",
     "karma-systemjs": "^0.10.0",
@@ -70,10 +82,11 @@
     "rollup": "^0.35.11",
     "rollup-plugin-node-resolve": "^3.0.0",
     "rollup-watch": "^2.5.0",
+    "shelljs": "^0.8.0",
     "systemjs": "^0.19.16",
     "systemjs-builder": "^0.15.7",
     "traceur": "0.0.96",
-    "typescript": "^2.5.3"
+    "typescript": ">=2.4.2 <2.5"
   },
   "typings": "index.d.ts"
 }