v3.0.0-alpha.12 (#693)

* fix(docs): remove remaining instances of getFirebase from docs - #635 (#694)
* feat(core): Start React hook API - #684 - @illuminist

SUMMARY.md

@@ -43,7 +43,6 @@
     * [dataReducer](/docs/api/reducers.md#datareducer)
     * [orderedReducer](/docs/api/reducers.md#orderedreducer)
   * [props.firebase](/docs/api/props-firebase.md)
-  * [getFirebase](/docs/api/get-firebase.md)
   * [firebaseInstance](/docs/api/firebaseInstance.md)
   * [helpers](/docs/api/helpers.md)
 * Migration Guides

docs/FAQ.md

@@ -7,7 +7,6 @@
     * `react-native` support ([web/js](http://react-redux-firebase.com/docs/recipes/react-native.html) or native modules through [`react-native-firebase`](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/react-native.html#native-modules))
     * tons of [integrations](#integrations)
     * [`profileFactory`](http://react-redux-firebase.com/docs/config) - change format of profile stored on Firebase
-    * [`getFirebase`](http://react-redux-firebase.com/docs/thunks) - access to firebase instance that fires actions when methods are called
     * [access to firebase's `storage`](http://react-redux-firebase.com/docs/storage) and `messaging` services
     * `uniqueSet` method helper for only setting if location doesn't already exist
     * Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)

docs/README.md

@@ -44,7 +44,6 @@
     * [dataReducer](/docs/api/reducers.md#datareducer)
     * [orderedReducer](/docs/api/reducers.md#orderedreducer)
   * [props.firebase](/docs/api/props-firebase.md)
-  * [getFirebase](/docs/api/get-firebase.md)
   * [firebaseInstance](/docs/api/firebaseInstance.md)
   * [helpers](/docs/api/helpers.md)
 * [FAQ](/docs/FAQ.md)

docs/api/README.md

@@ -11,7 +11,6 @@ Just like [redux](http://redux.js.org/docs/api/index.html), the react-redux-fire
 * [withFirestore](/docs/api/withFirestore.md)
 * [reducer](/docs/api/reducer.md) (also exported as `firebaseReducer`)
 * [reactReduxFirebase](/docs/api/enhancer.md)
-* [getFirebase](/docs/api/get-firebase.md)
 * [constants](/docs/api/constants.md)
 * [actionTypes](/docs/api/constants.md)
 * [helpers](/docs/api/helpers.md)

docs/auth.md

@@ -16,7 +16,7 @@ const enhance = connect(
 enhance(SomeComponent)
 ```
 
-If you need access to methods that are not available at the top level, you can access Firebase's Full Auth API using `props.firebase.auth()` or `getFirebase().auth()`.
+If you need access to methods that are not available at the top level, you can access Firebase's Full Auth API using `props.firebase.auth()`
 
 #### NOTE
 All examples below assume you have passed `firebase` from `context` to props. Wrapping your component with with the `withFirebase` or `firebaseConnect` Higher Order Components will make `props.firebase` available within your component:

docs/integrations/react-chrome-redux.md

@@ -27,13 +27,13 @@ const store = new Store({
 // Do not call firebaseConnect here
 export default connect(null, { login })(LoginForm);
 ```
-Then, create your alias in the background script, import `react-redux-firebase` as well as `redux-thunk` to wait for Firebase's reply before updating the state (see reply in [ issue #84 on react-chrome-redux](https://github.com/tshaddix/react-chrome-redux/issues/84)).
+Then, create your alias in the background script, import `react-redux-firebase` as well as `redux-thunk` to wait for Firebase's reply before updating the state (see reply in [issue #84 on react-chrome-redux](https://github.com/tshaddix/react-chrome-redux/issues/84)).
 
 ```js
 // in event (background script)
 // ...
 import thunk from 'redux-thunk'
-import { reactReduxFirebase, getFirebase } from 'react-redux-firebase'
+import { reactReduxFirebase } from 'react-redux-firebase'
 // ...
 // Add redux Firebase to compose
 const createStoreWithFirebase = compose(
@@ -49,27 +49,4 @@ const store = createStoreWithFirebase(
 wrapStore(store, {
   portName: 'example'
 });
-// ...
-const aliases = {
-  USER_LOGGING_IN: (payload) => {
-    return (dispatch) => {
-      getFirebase().login({
-        email: payload.data.email,
-        password: payload.data.password
-      })
-      .then(() => {
-        dispatch({
-          type: constants.USER_LOGGED_IN,
-          payload: "ok"
-        })
-      })
-      .catch(() => {
-        dispatch({
-          type: constants.USER_LOGGED_OUT,
-          payload: "logout"
-        })
-      })
-    }
-  }
-};
 ```

docs/integrations/react-native.md

@@ -28,7 +28,7 @@ Passing in an instance also allows for libraries with similar APIs (such as [`re
   ```js
   import { compose, createStore } from 'redux';
   import RNFirebase from 'react-native-firebase';
-  import { getFirebase, reactReduxFirebase } from 'react-redux-firebase';
+  import { reactReduxFirebase } from 'react-redux-firebase';
   import thunk from 'redux-thunk';
   import makeRootReducer from './reducers';
 

docs/integrations/redux-form.md

@@ -9,6 +9,8 @@ Examples below assume that you have setup `redux-observable` middleware so that
 Debounce writing of info that is typed to a ref on Firebase (useful for syncing changes typed into redux-form inputs).
 
 ```javascript
+import firebase from 'firebase/app'
+import 'firebase/database'
 import { actionTypes } from 'redux-form';
 import { Observable } from 'rxjs';
 import 'rxjs/add/operator/switchMap';
@@ -22,10 +24,10 @@ const blur = action$ => action$.ofType(actionTypes.BLUR);
 // Combine form input streams
 const formInput = actionStreams$ => Observable.merge(...actionStreams$);
 
-const firebaseSet$ = (getFirebase, path, payload) =>
-  Observable.fromPromise(getFirebase().ref(path).set(payload));
+const firebaseSet$ = (path, payload) =>
+  Observable.fromPromise(firebase.database().ref(path).set(payload));
 
-export const reduxFormFieldChangeEpic = (action$, { getState, dispatch }, getFirebase) =>
+export const reduxFormFieldChangeEpic = (action$, { getState, dispatch }) =>
   // create a stream of formInput actions, listen to change and blur events
   formInput([change(action$), blur(action$)])
     .do(({ meta }) => { // create a side-effect for dispatching action before update
@@ -39,7 +41,7 @@ export const reduxFormFieldChangeEpic = (action$, { getState, dispatch }, getFir
       const path = 'some/path'
 
       // make call to update firebase
-      return firebaseSet$(getFirebase, path, payload)
+      return firebaseSet$(path, payload)
        // map each promise to an action that indicates the update complete
         .mapTo(({
           type: 'FORM_FIELD_UPDATED',
@@ -53,6 +55,8 @@ export const reduxFormFieldChangeEpic = (action$, { getState, dispatch }, getFir
 Writing of info that is changed in a redux-form array to firebase.
 
 ```js
+import firebase from 'firebase/app'
+import 'firebase/database'
 import { actionTypes } from 'redux-form';
 import { get } from 'lodash';
 import { Observable } from 'rxjs';
@@ -65,12 +69,13 @@ const arrayPush = action$ => action$.ofType(actionTypes.ARRAY_PUSH);
 // Combine form array action streams
 const formArrayAction = actionStream$ => Observable.merge(...actionStream$);
 
-const firebaseSet$ = (getFirebase, path, payload) =>
-  Observable.fromPromise(getFirebase().ref(path).set(payload));
+export function firebaseSet$(path, payload) {
+  return Observable.fromPromise(firebase.database().ref(path).set(payload));
+}
 
-export const reduxFormArrayEpic = (action$, { getState }, getFirebase) =>
+export function reduxFormArrayEpic(action$, { getState }) {
   // create a stream of formArray actions, listen to add and remove events
-  formArrayAction([arrayRemove(action$), arrayPush(action$)])
+  return formArrayAction([arrayRemove(action$), arrayPush(action$)])
   // map arrayActions to an Observable which is merged in the output Observable of promises
     .mergeMap((action) => {
       const { form } = getState();
@@ -79,16 +84,12 @@ export const reduxFormArrayEpic = (action$, { getState }, getFirebase) =>
       const path = 'some/path'
 
       // make call to update firebase
-      return firebaseSet$(getFirebase, path, payload)
+      return firebaseSet$(path, payload)
        // the action indicating the action was completed
         .mapTo(({
           type: 'FORM_ARRAY_CHANGE',
           payload: meta,
         }));
     });
-
-export default {
-  reduxFormFieldChangeEpic,
-  reduxFormArrayEpic,
-};
+}
 ```

docs/integrations/redux-observable.md

@@ -1,21 +1,22 @@
 # redux-observable
-If you are using `redux-observable`, make sure to set up your redux-observable middleware so that firebase is available within your epics. Here is an example `combineEpics` function that adds `getFirebase` as third argument along with an epic that uses it:
+If you are using `redux-observable`, make sure to set up your redux-observable middleware so that firebase is available within your epics. Here is an example `combineEpics` function:
 
 ## Setup
-Examples below assume that you have setup `redux-observable` middleware so that firebase is available within your epics. Here is an example `combineEpics` function that adds `getFirebase` as the third argument along with an epic that uses it:
+Examples below assume that you have setup `redux-observable` middleware so that firebase is available within your epics.
 
 ```javascript
-import { getFirebase } from 'react-redux-firebase'
+import firebase from 'firebase/app'
+import 'firebase/database'
 import { combineEpics } from 'redux-observable'
 
 const rootEpic = (...args) =>
-  combineEpics(somethingEpic, epic2)(...args, getFirebase)
+  combineEpics(somethingEpic, epic2)(...args)
 
 // then later in your epics
-const somethingEpic = (action$, store, getFirebase) =>
+const somethingEpic = (action$, store) =>
   action$.ofType(SOMETHING)
     .map(() =>
-      getFirebase().push('somePath/onFirebase', { some: 'data' })
+      firebase.database().ref('somePath/onFirebase').push({ some: 'data' })
     )
 ```
 
@@ -31,12 +32,12 @@ Debounce is writing to a ref on Firebase such as `/notifications` (useful so tha
 ```js
 const SEND_NOTIFICATION = 'SEND_NOTIFICATION';
 
-export const notificationEpic = (action$, { getState, dispatch }, { getFirebase }) =>
+export const notificationEpic = (action$, { getState, dispatch }) =>
   action$.ofType(SEND_NOTIFICATION) // stream of notification actions
     .debounceTime(2000) // debounce SEND_NOTIFICATION actions by 2 seconds
     .do((action) => {
       // push the notification object to the notifications ref
-      return getFirebase().push('/notifications', action.payload)
+      return firebase.database().ref('notifications').push(action.payload)
     })
     .mapTo({ type: 'EMAIL_NOTIFICATION_CREATED' });
 ```

docs/integrations/redux-saga.md

@@ -1,16 +1,15 @@
 # Redux Saga Recipes
 
-In order to use `react-redux-firebase` instance within sagas, pass it as the second argument of the run function `sagaMiddleware.run(helloSaga, getFirebase)`.
-
 ### Example
 
 ```javascript
 import { applyMiddleware, compose, createStore } from 'redux'
 import { browserHistory } from 'react-router'
-import { reactReduxFirebase, getFirebase } from 'react-redux-firebase'
+import { reactReduxFirebase } from 'react-redux-firebase'
 import makeRootReducer from './reducers'
 import createSagaMiddleware from 'redux-saga'
 import firebase from 'firebase/app';
+import 'firebase/database';
 
 const firebaseConfig = {} // firebase configuration including databaseURL
 const reduxFirebase = {
@@ -20,9 +19,9 @@ const reduxFirebase = {
 
 firebase.initializeApp(firebaseConfig);
 
-function* helloSaga(getFirebase) {
+function* helloSaga() {
   try {
-    yield getFirebase().push('/some/path', { nice: 'work!' })
+    yield firebase.ref('/some/path').push({ nice: 'work!' })
   } catch(err) {
     console.log('Error in saga!:', err)
   }
@@ -46,6 +45,6 @@ export default (initialState = {}, history) => {
   return store
 }
 
-// when calling saga, pass getFirebase
-sagaMiddleware.run(helloSaga, getFirebase)
+// when calling saga
+sagaMiddleware.run(helloSaga)
 ```

docs/integrations/thunks.md

@@ -7,7 +7,7 @@ In order to get the most out of writing your thunks, make sure to set up your th
 ```javascript
 import { applyMiddleware, compose, createStore } from 'redux';
 import thunk from 'redux-thunk';
-import { reactReduxFirebase, getFirebase } from 'react-redux-firebase';
+import { reactReduxFirebase } from 'react-redux-firebase';
 import makeRootReducer from './reducers';
 
 const fbConfig = {} // your firebase config
@@ -16,9 +16,7 @@ const store = createStore(
   makeRootReducer(),
   initialState,
   compose(
-    applyMiddleware(
-      thunk.withExtraArgument(getFirebase) // Pass getFirebase function as extra argument
-    ),
+    applyMiddleware(thunk),
     reactReduxFirebase(fbConfig, { userProfile: 'users', enableLogging: false })
   )
 );
@@ -27,19 +25,17 @@ const store = createStore(
 
 ## Example Thunk
 
-After following the setup above, `getFirebase` function becomes available within your thunks as the third argument:
-
 ```javascript
 const sendNotification = (payload) => ({
   type: NOTIFICATION,
   payload
 })
 
 export const addTodo = (newTodo) =>
-  (dispatch, getState, getFirebase) => {
-    const firebase = getFirebase()
-    firebase
-      .push('todos', newTodo)
+  (dispatch, getState) => {
+    return firebase
+      .ref('todos')
+      .push(newTodo)
       .then(() => {
         dispatch(sendNotification('Todo Added'))
       })

docs/recipes/auth.md

@@ -120,7 +120,7 @@ export default compose(
 ```js
 import firebase from 'firebase'
 import { compose, createStore, applyMiddleware } from 'redux'
-import { getFirebase, reactReduxFirebase } from 'react-redux-firebase'
+import { reactReduxFirebase } from 'react-redux-firebase'
 
 // Firebase config
 const fbConfig = {
@@ -146,7 +146,7 @@ const createStore = (initialState = {}) => {
     initialState,
     compose(
       reactReduxFirebase(firebase, rrfConfig),
-      applyMiddleware(thunk.withExtraArgument(getFirebase))
+      applyMiddleware(thunk)
     )
   )
 

docs/recipes/ssr.md

@@ -9,7 +9,7 @@ Preloading data is a common step to in serverside rendering. How it is done diff
 After creating your store:
 
 ```js
-store.firebase // getFirebase can also be used
+store.firebase
   .promiseEvents([
     { path: 'todos' },
     { path: 'users' }

docs/storage.md

@@ -8,7 +8,7 @@ For Examples of how to use these methods, please visit the [recipes section](/do
 
 Upload an array of files to a location on Firebase storage. This includes the option to also write meta data for the object to Firebase database.
 
-Available on `props.firebase` if using `firebaseConnect` HOC or using `getFirebase`.
+Available on `props.firebase` if using `firebaseConnect` HOC.
 
 #### Parameters
 -   `path` [**String**][string-url] - Path within Firebase Storage at which to upload File.
@@ -24,7 +24,7 @@ Available on `props.firebase` if using `firebaseConnect` HOC or using `getFireba
 
 Upload a single file to a location.
 
-Available on `props.firebase` if using `firebaseConnect` HOC or using `getFirebase`.
+Available on `props.firebase` if using `firebaseConnect` HOC.
 
 #### Parameters
 -   `path` [**String**][string-url] - Path within Firebase Storage at which to upload File.
@@ -44,7 +44,7 @@ Available on `props.firebase` if using `firebaseConnect` HOC or using `getFireba
 
 Delete a file from Firebase storage with the option to remove metadata from real time database.
 
-Available on `props.firebase` if using `firebaseConnect` HOC or using `getFirebase`.
+Available on `props.firebase` if using `firebaseConnect` HOC.
 
 #### Parameters
 -   `path` [**String**][string-url] - Path within Firebase Storage of File to delete.