Version v2.0.0-alpha.

* Basic Population working with new syntax (`populate`)
* Material example uses new syntax
* A firebase instance can be passed
* Unused helpers removed (populatedDataToJS, dataToJS, customToJS)

src/connect.js → src/createFirebaseConnect.js

@@ -6,48 +6,55 @@ import { watchEvents, unWatchEvents } from './actions/query'
 import { getEventsFromInput, createCallable } from './utils'
 
 /**
- * @name firebaseConnect
- * @extends React.Component
- * @description Higher Order Component that automatically listens/unListens
- * to provided firebase paths using React's Lifecycle hooks.
- * @param {Array} watchArray - Array of objects or strings for paths to sync from Firebase. Can also be a function that returns the array. The function is passed the current props and the firebase object.
- * @return {Function} - that accepts a component to wrap and returns the wrapped component
- * @example <caption>Basic</caption>
- * // this.props.firebase set on App component as firebase object with helpers
- * import { firebaseConnect } from 'react-redux-firebase'
- * export default firebaseConnect()(App)
+ * @name createFirebaseConnect
+ * @description WARNING!! Advanced feature, and only be used when needing to
+ * access a firebase instance created under a different store key
+ * @param {String} storeKey - Name of key of store to connect to (store that contains state.firebase)
+ * @return {Function} - that returns a firebaseConnect function, which is later used to wrap a component
  * @example <caption>Data</caption>
  * import { connect } from 'react-redux'
- * import { firebaseConnect, dataToJS } from 'react-redux-firebase'
+ * import { createFirebaseConnect } from 'react-redux-firebase'
  *
- * // sync /todos from firebase into redux
- * const fbWrapped = firebaseConnect([
- *   'todos'
- * ])(App)
+ * // sync /todos from firebase (in other store) into redux
+ * const fbWrapped = createFirebaseConnect('someOtherName')(['todos'])
  *
  * // pass todos list from redux as this.props.todosList
- * export default connect(({ firebase }) => ({
- *   todosList: dataToJS(firebase, 'todos'),
- *   profile: pathToJS(firebase, 'profile'), // pass profile data as this.props.profile
- *   auth: pathToJS(firebase, 'auth') // pass auth data as this.props.auth
- * }))(fbWrapped)
- * @example <caption>Data that depends on props</caption>
- * import { connect } from 'react-redux'
- * import { firebaseConnect, dataToJS } from 'react-redux-firebase'
- *
- * // sync /todos from firebase into redux
- * const fbWrapped = firebaseConnect((props, firebase) => ([
- *   `todos/${firebase.database().currentUser.uid}/${props.type}`
- * ])(App)
- *
- * // pass todos list for the specified type of todos from redux as `this.props.todosList`
- * export default connect(({ firebase, type }) => ({
- *   todosList: dataToJS(firebase, `data/todos/${firebase.getIn(['auth', 'uid'])}/${type}`),
- *   profile: pathToJS(firebase, 'profile'), // pass profile data as this.props.profile
- *   auth: pathToJS(firebase, 'auth') // pass auth data as this.props.auth
+ * export default connect(({ firebase: data: { todos }, auth, profile }) => ({
+ *   todos,
+ *   profile, // pass profile data as this.props.profile
+ *   auth // pass auth data as this.props.auth
  * }))(fbWrapped)
  */
 export const createFirebaseConnect = (storeKey = 'store') => (dataOrFn = []) => WrappedComponent => {
+  /**
+   * @name firebaseConnect
+   * @extends React.Component
+   * @description Higher Order Component that automatically listens/unListens
+   * to provided firebase paths using React's Lifecycle hooks.
+   * @param {Array} watchArray - Array of objects or strings for paths to sync
+   * from Firebase. Can also be a function that returns the array. The function
+   * is passed the current props and the firebase object.
+   * @return {Function} - that accepts a component to wrap and returns the wrapped component
+   * @example <caption>Basic</caption>
+   * // this.props.firebase set on App component as firebase object with helpers
+   * import { firebaseConnect } from 'react-redux-firebase'
+   * export default firebaseConnect()(App)
+   * @example <caption>Data</caption>
+   * import { connect } from 'react-redux'
+   * import { firebaseConnect, dataToJS } from 'react-redux-firebase'
+   *
+   * // sync /todos from firebase into redux
+   * const fbWrapped = firebaseConnect([
+   *   'todos'
+   * ])(App)
+   *
+   * // pass todos list from redux as this.props.todosList
+   * export default connect(({ firebase: data: { todos }, auth, profile }) => ({
+   *   todos,
+   *   profile, // pass profile data as this.props.profile
+   *   auth // pass auth data as this.props.auth
+   * }))(fbWrapped)
+   */
   class FirebaseConnect extends Component {
     constructor (props, context) {
       super(props, context)