Resolve create() with WriteResult

API.md

@@ -19,6 +19,10 @@ Only `MockFirebase` methods are included here. For details on normal Firebase AP
 - [Server Timestamps](#server-timestamps)
   - [`setClock(fn)`](#firebasesetclockfn---undefined)
   - [`restoreClock()`](#firebasesetclockfn---undefined)
+- [Messaging](#messaging)
+  - [`respondNext(methodName, result)`](#respondnextmethodname-result---undefined)
+  - [`failNext(methodName, err)`](#failnextmethodname-err---undefined)
+  - [`on(methodName, callback)`](#onmethodname-callback---undefined)
 
 ## Core
 
@@ -175,8 +179,9 @@ Authentication methods for simulating changes to the auth state of a Firebase re
 Changes the active authentication credentials to the `authData` object.
 Before changing the authentication state, `changeAuthState` checks the
 `user` object against the current authentication data.
-`onAuthStateChanged` listeners will only be triggered if the data is not
-deeply equal.
+`onIdTokenChanged` listeners will be triggered if the data is not
+deeply equal. `onAuthStateChanged` listeners will be triggered if the
+data is deeply equal but with different ID token validity.
 
 `user` should be a `MockUser` object or an object with the same fields
 as `MockUser`. To simulate no user being authenticated, pass `null` for
@@ -225,9 +230,13 @@ Finds a user previously created with [`createUser`](https://www.firebase.com/doc
 ##### `updateUser(user)` -> `Promise<MockUser>`
 
 Replace the existing user with a new one, by matching uid. Throws an
-error if no user exists whose uid matches the given user's uid. Resolves
-with the updated user when complete. This operation is queued until the
-next flush.
+error if no user exists whose uid matches the given user's uid.
+Appropriate `onAuthStateChanged` and `onIdTokenChanged` listeners will
+be triggered if the new user has the same `uid` as the current
+authenticated user.
+
+Resolves with the updated user when complete. This operation is queued
+until the next flush.
 
 ## Server Timestamps
 
@@ -242,3 +251,31 @@ Instead of using `Date.now()`, MockFirebase will call the `fn` you provide to ge
 ##### `Firebase.restoreClock()` -> `undefined`
 
 After calling `Firebase.setClock`, calling `Firebase.restoreClock` will restore the default timestamp behavior.
+
+## Messaging
+
+API reference of `MockMessaging`.
+
+##### `respondNext(methodName, result)` -> `undefined`
+
+When `methodName` is next invoked, the `Promise` (that is returned from the `methodName`) will be resolved with the specified `result`. This is useful for testing specific results of firebase messaging (e. g. partial success of sending messaging). The result will be triggered with the next `flush`.
+
+If no result is specified, `methodName` will resolve a default response.
+
+`result` must not be undefined.
+
+<hr>
+
+##### `failNext(methodName, err)` -> `undefined`
+
+When `methodName` is next invoked, the `Promise` will be rejected with the specified `err`. This is useful for simulating validation or any other errors. The error will be triggered with the next `flush`.
+
+`err` must be a proper `Error` object and not a string or any other primitive.
+
+<hr>
+
+##### `on(methodName, callback)` -> `undefined`
+
+When `methodName` is next invoked, the `callback` will be triggered. The callback gets an array as argument. The array contains all arguments, that were passed on invoking `methodName`. This is useful to assert the input arguments of `methodName`.
+
+See [docs.js](/test/unit/docs.js) for an example.

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Changelog
+- Mock `auth.Auth.onIdTokenChanged()` method, matching the previous
+  behavior of `onAuthStateChanged()` (see below)
+- Support for Firebase Messaging (Admin API)
+
+### Changed
+- (Breaking) Consistent with Firebase SDK [version 4.0.0](https://firebase.google.com/support/release-notes/js#version_500_-_may_8_2018) and later,
+  and later, `onAuthStateChanged` no longer issues an event when a new
+  ID token is issued for the same user. The `onIdTokenChanged` method is
+  now mocked, keeping the previous behavior.
+- `MockStorageFile.download()` now allows omitting the destination arg;
+  in that case, it simply resolves the `Promise` with the file contents
+  and does not write it anywhere else.
+
+### Fixed
+- `onAuthStateChanged` now correctly calls its callback immediately with
+  the current auth state.  
+- `MockStorage.bucket()` and `MockStorageBucket.file()` now return the
+  existing artifact if one exists, rather than overwriting it with a new
+  one.
+- `DataSnapshot.child` now correctly splits child paths by '/'
+  characters
+- Boolean values are now allowed in RTDB priority fields and as
+  arguments to `Query.startAt`, `Query.endAt`, and `Query.equalTo`.
+
+
+[Unreleased]: https://github.com/dmurvihill/firebase-mock/compare/v2.2.10...HEAD

README.md

@@ -35,6 +35,7 @@ Firebase Mock supports the client-side [JavaScript API](https://firebase.google.
 * Authentication
   * [Basic](tutorials/admin/authentication.md)
   * [JWT Tokens](tutorials/admin/tokens.md)
+* [Messaging](tutorials/admin/messaging.md)
 * [Realtime Database](tutorials/admin/rtdb.md)
 * [Firestore](tutorials/admin/firestore.md)
 * [Storage](tutorials/admin/storage.md)