chore(merge): merge AngularFirestore with master

Author: davideast

.DS_Store

@@ -9,6 +9,7 @@ npm-debug.log
 angularfire2-*.tgz
 *.ngfactory.ts
 *.ngsummary.json
-firestore-module.tgz
 .DS_Store
 yarn-error.log
+*.bak
+.DS_Store

.gitignore

@@ -2,10 +2,9 @@ language: node_js
 sudo: false
 node_js:
 - 'node'
-dist: precise
 
 addons:
-  firefox: latest
+  chrome: stable
   apt:
     sources:
       - ubuntu-toolchain-r-test
@@ -27,7 +26,7 @@ before_script:
 
 script:
   - npm run build
-  - ./node_modules/.bin/karma start --single-run --browsers Firefox --reporters mocha
+  - ./node_modules/.bin/karma start --single-run --browsers Chrome --reporters mocha
   # Run integration test to make sure our typings are correct for user-land.
   - node tools/run-typings-test.js
 

.travis.yml

@@ -10,7 +10,7 @@ Status: Release candidate
 ## What is AngularFire?
 
 - **Observable based** - Use the power of RxJS, Angular, and Firebase.
-- **Realtime bindings** - Synchronize data in reatime.
+- **Realtime bindings** - Synchronize data in realtime.
 - **Authentication** - Log users in with a variety of providers and monitor authentication state in realtime.
 - **Offline Data** - Store data offline automatically with AngularFirestore.
 - **ngrx friendly** - Integrate with ngrx using AngularFire's action based APIs.
@@ -20,7 +20,7 @@ Status: Release candidate
 
 [Stackblitz Template](https://stackblitz.com/edit/angular-2ed5zx?) - Remember to set your Firebase configuration in `app/app.module.ts`.
 
-[Upgrading to v4.0? Check out our guide.](docs/version-4-upgrade.md)
+[Upgrading to v5.0? Check out our guide.](docs/version-5-upgrade.md)
 
 ## Install
 
@@ -70,9 +70,9 @@ export class MyApp {
 - [Retrieving data as lists](docs/3-retrieving-data-as-lists.md)
 - [Querying lists](docs/4-querying-lists.md)
 
+### Deploy to Firebase Hosting
+- [Deploying AngularFire to Firebase Hosting](docs/7-deploying-angularfire-to-firebase.md)
+
 ### Ionic
 - [Using AngularFire with Ionic 2](docs/Auth-with-Ionic2.md)
 - [Using AngularFire with Ionic 3 and Angular 4](docs/Auth-with-Ionic3-Angular4.md)
-
-### Deploy to Firebase Hosting
-- [Deploying AngularFire to Firebase Hosting](docs/7-deploying-angularfire-to-firebase.md)

README.md

@@ -1,35 +1,13 @@
 # 1. Installation and Setup
 
-> Getting started with AngularFire2 is easy with the [Angular CLI](https://github.com/angular/angular-cli). Follow the 10 steps below to get started. Don't worry, we're always working to make this shorter.
-
 > Using Ionic and the Ionic CLI? Check out these [specific instructions](6-angularfire-and-ionic-cli.md) for Ionic and their CLI.
 
 ### 0. Prerequisites
 
-Before you start installing AngularFire2, make sure you have latest version of angular-cli installed.
-To verify run the command `ng -v` and ensure you see `angular-cli: 1.x.x-beta.xx`. The lowest compatible version is `1.x.x-beta.14`.
-
-If not, you may need to do the following:
-
-```bash
-# if you have the wrong cli version only
-npm uninstall -g angular-cli
-npm uninstall -g @angular/cli
-npm cache clean
-
-# reinstall clean version
-npm install -g @angular/cli@latest
-```
-
-You need the Angular CLI, typings, and TypeScript.
+AngularFire provides multiple module formats for different types of builds. The guide is based off the Angular CLI. It is possible to do a manual setup with Webpack or a SystemJS build as well.
 
 ```bash
-npm install -g @angular/cli@latest
-# or install locally
-npm install @angular/cli --save-dev
-# make sure you have typings installed
-npm install -g typings
-npm install -g typescript
+npm install @angular/cli
 ```
 
 ### 1. Create a new project
@@ -50,13 +28,13 @@ open http://localhost:4200
 
 You should see a message that says *App works!*
 
-### 3. Install AngularFire 2 and Firebase
+### 3. Install AngularFire and Firebase
 
 ```bash
 npm install angularfire2 firebase --save
 ```
 
-Now that you have a new project setup, install AngularFire2 and Firebase from npm.
+Now that you have a new project setup, install AngularFire and Firebase from npm.
 
 ### 4. Add Firebase config to environments variable
 
@@ -79,6 +57,7 @@ export const environment = {
 ### 5. Setup @NgModule for the AngularFireModule
 
 Open `/src/app/app.module.ts`, inject the Firebase providers, and specify your Firebase configuration.
+
 This can be found in your project at [the Firebase Console](https://console.firebase.google.com):
 
 ```ts

docs/1-install-and-setup.md

@@ -1,30 +1,33 @@
 # 2. Retrieving data as objects
 
-> AngularFire2 synchronizes data as objects using the `FirebaseObjectObservable`. 
-The `FirebaseObjectObservable` is not created by itself, but through the `AngularFireDatabase` service. 
+> The `AngularFireObject` is a service for manipulating and streaming object data.
+
+The `AngularFireObject` service is not created by itself, but through the `AngularFireDatabase` service. 
+
 The guide below demonstrates how to retrieve, save, and remove data as objects.
 
 ## Injecting the AngularFireDatabase service
 
-**Make sure you have bootstrapped your application for AngularFire2. See the Installation guide for bootstrap setup.**
+**Make sure you have bootstrapped your application for AngularFire. See the Installation guide for bootstrap setup.**
 
 `AngularFireDatabase` is a service which can be injected through the constructor of your Angular component or `@Injectable()` service.
 
 If you've followed the earlier step "Installation and Setup"  your `/src/app/app.component.ts` should look like below. 
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFireDatabase, FirebaseListObservable } from 'angularfire2/database';
+import { AngularFireDatabase } from 'angularfire2/database';
+import { Observable } from 'rxjs/Observable';
 
 @Component({
   selector: 'app-root',
   templateUrl: 'app.component.html',
   styleUrls: ['app.component.css']
 })
 export class AppComponent {
-  items: FirebaseListObservable<any[]>;
+  items: Observable<any[]>;
   constructor(db: AngularFireDatabase) {
-    this.items = db.list('items');
+    this.items = db.list('items').valueChanges();
   }
 }
 ```
@@ -33,31 +36,20 @@ In this section, we're going to modify the `/src/app/app.component.ts`  to retre
 
 ## Create an object binding
 
-Data is retrieved through the `AngularFireDatabase` service.
-
-There are two ways to create an object binding:
-
-1. Relative URL
-1. Absolute URL
-
 ```ts
-// relative URL, uses the database url provided in bootstrap
-const relative = db.object('/item');
-// absolute URL
-const absolute = db.object('https://<your-app>.firebaseio.com/item');
+const relative = db.object('item').valueChanges();
 ```
 
 ### Retrieve data
 
 To get the object in realtime, create an object binding as a property of your component or service.
-Then in your template, you can use the `async` pipe to unwrap the binding.
 
-Replace the `FirebaseListObservable` to `FirebaseObjectObservable` in your `/src/app/app.component.ts` as below.
-Also notice the templateUrl changed to inline template below:
+Then in your template, you can use the `async` pipe to unwrap the binding.
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFireDatabase, FirebaseObjectObservable } from 'angularfire2/database';
+import { AngularFireDatabase } from 'angularfire2/database';
+import { Observable } from 'rxjs/Observable';
 
 @Component({
   selector: 'app-root',
@@ -68,7 +60,7 @@ import { AngularFireDatabase, FirebaseObjectObservable } from 'angularfire2/data
 export class AppComponent {
   item: FirebaseObjectObservable<any>;
   constructor(db: AngularFireDatabase) {
-    this.item = db.object('/item');
+    this.item = db.object('item').valueChanges();
   }
 }
 ```
@@ -77,24 +69,23 @@ export class AppComponent {
 
 ### API Summary
 
-The table below highlights some of the common methods on the `FirebaseObjectObservable`.
+The table below highlights some of the common methods on the `AngularFireObject`.
 
 | method   |                    | 
 | ---------|--------------------| 
-| `set(value: any)`      | Replaces the current value in the database with the new value specified as the parameter. This is called a **destructive** update, because it deletes everything currently in place and saves the new value. | 
-| `update(value: Object)`   | Updates the current value with in the database with the new value specified as the parameter. This is called a **non-destructive** update, because it only updates the values specified. Note: Only values at the key level are non-destructive. |
+| `set(value: T)`      | Replaces the current value in the database with the new value specified as the parameter. This is called a **destructive** update, because it deletes everything currently in place and saves the new value. | 
+| `update(value: T)`   | Updates the current value with in the database with the new value specified as the parameter. This is called a **non-destructive** update, because it only updates the values specified. |
 | `remove()`   | Deletes all data present at that location. Same as calling `set(null)`. |
 
 ## Returning promises
 Each data operation method in the table above returns a promise. However,
 you should rarely need to use the completion promise to indicate success, 
 because the realtime database keeps the object in sync. 
 
-The promise can be useful to chain multiple operations, catching possible errors
-from security rules denials, or for debugging.
+The promise can be useful to chain multiple operations, catching possible errors from security rules denials, or for debugging.
 
 ```ts
-const promise = db.object('/item').remove();
+const promise = db.object('item').remove();
 promise
   .then(_ => console.log('success'))
   .catch(err => console.log(err, 'You dont have access!'));
@@ -105,17 +96,17 @@ promise
 Use the `set()` method for **destructive updates**.
 
 ```ts
-const itemObservable = db.object('/item');
-itemObservable.set({ name: 'new name!'});
+const itemRef = db.object('item');
+itemRef.set({ name: 'new name!'});
 ```
 
 ### Updating data
 
 Use the `update()` method for **non-destructive updates**.
 
 ```ts
-const itemObservable = db.object('/item');
-itemObservable.update({ age: newAge });
+const itemRef = db.object('item');
+itemRef.update({ age: newAge });
 ```
 
 **Only objects are allowed for updates, not primitives**. This is because
@@ -125,15 +116,15 @@ using an update with a primitive is the exact same as doing a `.set()` with a pr
 Use the `remove()` method to remove data at the object's location.
 
 ```ts
-const itemObservable = db.object('/item');
-itemObservable.remove();
+const itemRef = db.object('item');
+itemRef.remove();
 ```
 
 **Example app**: 
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFireDatabase, FirebaseObjectObservable } from 'angularfire2/database';
+import { AngularFireDatabase, AngularFireObject } from 'angularfire2/database';
 
 @Component({
   selector: 'app-root',
@@ -148,18 +139,20 @@ import { AngularFireDatabase, FirebaseObjectObservable } from 'angularfire2/data
   `,
 })
 export class AppComponent {
+  itemRef: AngularFireObject<any>;
   item: FirebaseObjectObservable<any>;
   constructor(db: AngularFireDatabase) {
-    this.item = db.object('/item');
+    this.itemRef = db.object('item');
+    this.item = this.itemRef.valueChanges();
   }
   save(newName: string) {
-    this.item.set({ name: newName });
+    this.itemRef.set({ name: newName });
   }
   update(newSize: string) {
-    this.item.update({ size: newSize });
+    this.itemRef.update({ size: newSize });
   }
   delete() {
-    this.item.remove();
+    this.itemRef.remove();
   }
 }
 ```
@@ -177,15 +170,16 @@ Data retrieved from the object binding contains special properties retrieved fro
 AngularFire2 unwraps the Firebase DataSnapshot by default, but you can get the data as the original snapshot by specifying the `preserveSnapshot` option. 
 
 ```ts
-this.item = db.object('/item', { preserveSnapshot: true });
-this.item.subscribe(snapshot => {
-  console.log(snapshot.key)
-  console.log(snapshot.val())
+this.itemRef = db.object('item');
+this.itemRef.snapshotChanges().subscribe(action => {
+  console.log(action.type);
+  console.log(action.snapshot.key)
+  console.log(action.snapshot.val())
 });
 ```
 
 ## Querying?
 
-Because `FirebaseObjectObservable` synchronizes objects from the realtime database, sorting will have no effect for queries that are not also limited by a range. For example, when paginating you would provide a query with a sort and filter. Both the sort operation and the filter operation affect which subset of the data is returned by the query; however, because the resulting object is simply json, the sort order will not be preseved locally. Hence, for operations that require sorting, you are probably looking for a [list](3-retrieving-data-as-lists.md)
+Because `AngularFireObject` synchronizes objects from the realtime database, sorting will have no effect for queries that are not also limited by a range. For example, when paginating you would provide a query with a sort and filter. Both the sort operation and the filter operation affect which subset of the data is returned by the query; however, because the resulting object is simply json, the sort order will not be preseved locally. Hence, for operations that require sorting, you are probably looking for a [list](3-retrieving-data-as-lists.md)
 
 ### [Next Step: Retrieving data as lists](3-retrieving-data-as-lists.md)