v3.0.1

* fix(types): update see links to point to base docs site
* fix(docs): update see links to point to base docs site
* fix(docs): update README to include old versions section instead of note about `next`

Author: prescottprue

README.md

@@ -23,7 +23,7 @@ The [Material Example](https://github.com/prescottprue/react-redux-firebase/tree
 
 * Out of the box support for authentication (with auto load user profile)
 * Full Firebase Platform Support Including Real Time Database, Firestore, and Storage
-* Automatic binding/unbinding of listeners through React Higher Order Components (`firebaseConnect` and `firestoreConnect`)
+* Automatic binding/unbinding of listeners through React Hooks (`useFirebaseConnect`, `useFirestoreConnect`) or Higher Order Components (`firebaseConnect` and `firestoreConnect`)
 * [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
 * Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
 * Multiple queries types supported including `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo`
@@ -33,8 +33,6 @@ The [Material Example](https://github.com/prescottprue/react-redux-firebase/tree
 
 ## Installation
 
-Interested in support for [`react-redux@^6`](https://github.com/reduxjs/react-redux) or the [new react context API](https://reactjs.org/docs/context.html)? Checkout [the `next` branch which contains the next upcoming major version](https://github.com/prescottprue/react-redux-firebase/tree/next) (installed through `npm i --save react-redux-firebase@next`).
-
 ```bash
 npm install --save react-redux-firebase
 ```
@@ -43,6 +41,10 @@ This assumes you are using [npm](https://www.npmjs.com/) as your package manager
 
 If you're not, you can access the library on [unpkg](https://unpkg.com/redux-firestore@latest/dist/redux-firestore.min.js), download it, or point your package manager to it. Theres more on this in the [Builds section below](#builds).
 
+### Older Versions
+
+Interested in support for versions of [`react-redux`](https://github.com/reduxjs/react-redux) before v6 or the [new react context API](https://reactjs.org/docs/context.html)? Checkout the `v2.*.*` versions (installed through `npm i --save react-redux-firebase^@2.5.0`).
+
 ## Use
 
 Include `firebaseReducer` (reducer) while creating your redux store then pass dispatch and your firebase instance to `ReactReduxFirebaseProvider` (context provider):

index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Redux integration for Firebase. Comes with a Higher Order Components for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",

package-lock.json

@@ -15,7 +15,7 @@ import ReduxFirestoreProvider from './ReduxFirestoreProvider'
  * @param {Function} props.createFirestoreInstance - Function for creating
  * extended firestore instance
  * @returns {React.Context.Provider} Provider for react-redux-firebase context
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/ReactReduxFirebaseProvider.html
+ * @see https://react-redux-firebase.com/api/ReactReduxFirebaseProvider.html
  */
 function ReactReduxFirebaseProvider(props = {}) {
   const {

package.json

@@ -14,7 +14,7 @@ import createFirebaseInstance from './createFirebaseInstance'
  * @param {Function} props.createFirestoreInstance - Function for creating
  * extended firestore instance
  * @returns {React.Context.Provider} Provider for redux-firestore context
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/ReduxFirestoreProvider.html
+ * @see https://react-redux-firebase.com/api/ReduxFirestoreProvider.html
  */
 function ReduxFirestoreProvider(props = {}) {
   const {

src/ReactReduxFirebaseProvider.js

@@ -71,13 +71,13 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
 
   /**
    * Sets data to Firebase. More info available in
-   * [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#set).
+   * [the docs](https://react-redux-firebase.com/api/props-firebase.html#set).
    * @param {string} path - Path to location on Firebase which to set
    * @param {object|string|boolean|number} value - Value to write to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
    * @returns {Promise} Containing reference snapshot
    * @example <caption>Basic</caption>
-   * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/firebaseInstance.html#set
+   * @see https://react-redux-firebase.com/api/firebaseInstance.html#set
    * import React, { Component } from 'react'
    * import PropTypes from 'prop-types'
    * import { firebaseConnect } from 'react-redux-firebase'
@@ -100,7 +100,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
    * Sets data to Firebase along with meta data. Currently,
    * this includes createdAt and createdBy. *Warning* using this function
    * may have unintented consequences (setting createdAt even if data already
-   * exists). More info available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#update).
+   * exists). More info available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#update).
    * @param {string} path - Path to location on Firebase which to set
    * @param {object|string|boolean|number} value - Value to write to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -111,7 +111,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
 
   /**
    * Pushes data to Firebase. More info
-   * available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#push).
+   * available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#push).
    * @param {string} path - Path to location on Firebase which to push
    * @param {object|string|boolean|number} value - Value to push to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -139,7 +139,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Pushes data to Firebase along with meta data. Currently,
    * this includes createdAt and createdBy. More info
-   * available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#pushWithMeta).
+   * available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#pushWithMeta).
    * @param {string} path - Path to location on Firebase which to set
    * @param {object|string|boolean|number} value - Value to write to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -150,7 +150,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
 
   /**
    * Updates data on Firebase and sends new data. More info
-   * available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#update).
+   * available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#update).
    * @param {string} path - Path to location on Firebase which to update
    * @param {object|string|boolean|number} value - Value to update to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -183,7 +183,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
    * Updates data on Firebase along with meta. *Warning*
    * using this function may have unintented consequences (setting
    * createdAt even if data already exists). More info available
-   * in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#updateWithMeta).
+   * in [the docs](https://react-redux-firebase.com/api/props-firebase.html#updateWithMeta).
    * @param {string} path - Path to location on Firebase which to update
    * @param {object|string|boolean|number} value - Value to update to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -197,7 +197,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
    * seperate action is not dispatched unless `dispatchRemoveAction: true` is
    * provided to config on store creation. That means that a listener must
    * be attached in order for state to be updated when calling remove.
-   * More info available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#remove).
+   * More info available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#remove).
    * @param {string} path - Path to location on Firebase which to remove
    * @param {Function} onComplete - Function to run on complete (`not required`)
    * @param {Function} options - Options object
@@ -226,7 +226,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
    * Sets data to Firebase only if the path does not already
    * exist, otherwise it rejects. Internally uses a Firebase transaction to
    * prevent a race condition between seperate clients calling uniqueSet.
-   * More info available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#uniqueSet).
+   * More info available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#uniqueSet).
    * @param {string} path - Path to location on Firebase which to set
    * @param {object|string|boolean|number} value - Value to write to Firebase
    * @param {Function} onComplete - Function to run on complete (`not required`)
@@ -263,7 +263,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Upload a file to Firebase Storage with the option to store
    * its metadata in Firebase Database. More info available
-   * in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#uploadFile).
+   * in [the docs](https://react-redux-firebase.com/api/props-firebase.html#uploadFile).
    * @param {string} path - Path to location on Firebase which to set
    * @param {File} file - File object to upload (usually first element from
    * array output of select-file or a drag/drop `onDrop`)
@@ -285,7 +285,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Upload multiple files to Firebase Storage with the option
    * to store their metadata in Firebase Database. More info available
-   * in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#uploadFiles).
+   * in [the docs](https://react-redux-firebase.com/api/props-firebase.html#uploadFiles).
    * @param {string} path - Path to location on Firebase which to set
    * @param {Array} files - Array of File objects to upload (usually from
    * a select-file or a drag/drop `onDrop`)
@@ -305,7 +305,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Delete a file from Firebase Storage with the option to
    * remove its metadata in Firebase Database. More info available
-   * in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#deleteFile).
+   * in [the docs](https://react-redux-firebase.com/api/props-firebase.html#deleteFile).
    * @param {string} path - Path to location on Firebase which to set
    * @param {string} dbPath - Database path to place uploaded file metadata
    * @returns {Promise} Containing the File object
@@ -316,7 +316,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Watch event. **Note:** this method is used internally
    * so examples have not yet been created, and it may not work as expected.
-   * More info available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#watchEvent).
+   * More info available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#watchEvent).
    * @param {string} type - Type of watch event
    * @param {string} path - Path to location on Firebase which to set listener
    * @param {string} storeAs - Name of listener results within redux store
@@ -336,7 +336,7 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
   /**
    * Unset a listener watch event. **Note:** this method is used
    * internally so examples have not yet been created, and it may not work
-   * as expected. More info available in [the docs](http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/props-firebase.html#unwatchevent).
+   * as expected. More info available in [the docs](https://react-redux-firebase.com/api/props-firebase.html#unwatchevent).
    * @param {string} type - Type of watch event
    * @param {string} path - Path to location on Firebase which to unset listener
    * @param {string} queryId - Id of the listener

src/ReduxFirestoreProvider.js

@@ -10,7 +10,7 @@ import ReactReduxFirebaseContext from './ReactReduxFirebaseContext'
  * and functionality which give it it's capabilities such as dispatching
  * actions.
  * @returns {object} - Extended Firebase instance
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirebase.html
+ * @see https://react-redux-firebase.com/api/useFirebase.html
  * @example <caption>Basic</caption>
  * import { useFirebase } from 'react-redux-firebase'
  *

src/createFirebaseInstance.js

@@ -11,7 +11,7 @@ import useFirebase from './useFirebase'
  * array contains object or string for path to sync from Firebase or null if
  * hook doesn't need to sync. Can also be a function that returns an object,
  * a path string, or array of an object or a path string.
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirebaseConnect.html
+ * @see https://react-redux-firebase.com/api/useFirebaseConnect.html
  * @example <caption>Ordered Data</caption>
  * import { useSelector } from 'react-redux'
  * import { useFirebaseConnect } from 'react-redux-firebase'

src/useFirebase.js

@@ -8,7 +8,7 @@ import ReduxFirestoreContext from './ReduxFirestoreContext'
  * to store by the store enhancer (`reduxFirestore`) during setup of
  * [`redux-firestore`](https://github.com/prescottprue/redux-firestore)
  * @returns {object} - Extended Firestore instance
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirestore.html
+ * @see https://react-redux-firebase.com/api/useFirestore.html
  * @example <caption>Basic</caption>
  * import React from 'react'
  * import { useFirestore } from 'react-redux-firebase'

src/useFirebaseConnect.js

@@ -11,7 +11,7 @@ import useFirestore from './useFirestore'
  * @param {object|string|Array|Function} queriesConfigs - An object, string,
  * or array of object or string for paths to sync from firestore. Can also be
  * a function that returns the object, string, or array of object or string.
- * @see http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirestoreConnect.html
+ * @see https://react-redux-firebase.com/api/useFirestoreConnect.html
  * @example <caption>Basic</caption>
  * import React from 'react'
  * import { map } from 'lodash'