v3.3.1 (#919)

* fix(types): add type for `profileFactory` config option (#917)
* fix(types): prevent type error in combineReducers by adding generic type for Schema (#906) - @rscotten 

Co-authored-by: Richard Scotten <[email protected]>

Author: prescottprue

.eslintignore

@@ -6,3 +6,4 @@ lib/**
 _book/**
 _site/**
 docs/**
+index.d.ts

docs/getting_started.md

@@ -7,6 +7,7 @@
 Install peer dependencies: `npm i --save redux react-redux`
 
 ## Install
+
 ```bash
 npm install --save react-redux-firebase
 ```
@@ -25,6 +26,62 @@ const rootReducer = combineReducers({
 })
 ```
 
+## Add Reducer using Typescript:
+
+We provide optional `Profile` and `Schema` types for additional type checking.
+
+You can add the `Profile` type if you use the [Profile option](https://react-redux-firebase.com/docs/recipes/profile.html).
+
+You can define a `Schema` that corresponds to your Firebase Redux store for `state.firebase.data` and `state.firebase.ordered`. That could be a map of your Realtime Database collections, or anything else if you use `storeAs` to name custom stores.
+
+```typescript
+import { combineReducers } from 'redux'
+import { firebaseReducer, FirebaseReducer } from 'react-redux-firebase'
+
+// Optional: If you use the user profile option
+interface Profile {
+  name: string
+  email: string
+}
+
+// If you have a todos collection, you might have this type
+interface Todo {
+  text: string
+  completed: boolean
+}
+
+// Optional: You can define the schema of your Firebase Redux store.
+// This will give you type-checking for state.firebase.data.todos and state.firebase.ordered.todos
+interface Schema {
+  todos: Todo
+}
+
+// with both reducer types
+interface RootState {
+  firebase: FirebaseReducer.Reducer<Profile, Schema>
+}
+
+// with only Profile type
+interface RootState {
+  firebase: FirebaseReducer.Reducer<Profile>
+}
+
+// with only Schema type
+interface RootState {
+  firebase: FirebaseReducer.Reducer<{}, Schema>
+}
+
+// without reducer types
+interface RootState {
+  firebase: FirebaseReducer.Reducer
+}
+
+
+const rootReducer = combineReducers<RootState>({
+  firebase: firebaseReducer
+})
+```
+
 ## Setting Up App With Store
 
 ```javascript
@@ -36,14 +93,17 @@ import 'firebase/auth'
 // import 'firebase/firestore' // <- needed if using firestore
 // import 'firebase/functions' // <- needed if using httpsCallable
 import { createStore, combineReducers, compose } from 'redux'
-import { ReactReduxFirebaseProvider, firebaseReducer } from 'react-redux-firebase'
+import {
+  ReactReduxFirebaseProvider,
+  firebaseReducer
+} from 'react-redux-firebase'
 // import { createFirestoreInstance, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
 
 const fbConfig = {}
 
 // react-redux-firebase config
 const rrfConfig = {
-  userProfile: 'users',
+  userProfile: 'users'
   // useFirestoreForProfile: true // Firestore for Profile instead of Realtime DB
   // enableClaims: true // Get custom claims along with the profile
 }
@@ -57,7 +117,7 @@ firebase.initializeApp(fbConfig)
 
 // Add firebase to reducers
 const rootReducer = combineReducers({
-  firebase: firebaseReducer,
+  firebase: firebaseReducer
   // firestore: firestoreReducer // <- needed if using firestore
 })
 
@@ -68,7 +128,7 @@ const store = createStore(rootReducer, initialState)
 const rrfProps = {
   firebase,
   config: rrfConfig,
-  dispatch: store.dispatch,
+  dispatch: store.dispatch
   // createFirestoreInstance // <- needed if using firestore
 }
 
@@ -80,8 +140,8 @@ function App() {
         <Todos />
       </ReactReduxFirebaseProvider>
     </Provider>
-  );
+  )
 }
 
-render(<App/>, document.getElementById('root'));
+render(<App />, document.getElementById('root'))
 ```

index.d.ts

@@ -804,17 +804,17 @@ export function firebaseConnect<ProfileType, TInner = {}>(
  * @param action.type - Type of Action being called
  * @param action.path - Path of action that was dispatched
  * @param action.data - Data associated with action
- * @see https://react-redux-firebase.com/docs/api/reducer.html
+ * @see https://react-redux-firebase.com/docs/getting_started.html#add-reducer
  */
 export function firebaseReducer<
-  UserType,
-  Schema extends Record<string, Record<string | number, string | number>>
->(state: any, action: any): FirebaseReducer.Reducer<UserType, Schema>
+  ProfileType extends Record<string, any> = {},
+  Schema extends Record<string, any> = {}
+>(state: any, action: any): FirebaseReducer.Reducer<ProfileType, Schema>
 
 export function makeFirebaseReducer<
-  UserType = {},
-  Schema extends Record<string, Record<string | number, string | number>> = {}
->(): (state: any, action: any) => FirebaseReducer.Reducer<UserType, Schema>
+  ProfileType extends Record<string, any> = {},
+  Schema extends Record<string, any> = {}
+>(): (state: any, action: any) => FirebaseReducer.Reducer<ProfileType, Schema>
 
 /**
  * React HOC that attaches/detaches Cloud Firestore listeners on mount/unmount
@@ -1008,6 +1008,10 @@ interface ReactReduxFirebaseConfig {
   // Use Firestore for Profile instead of Realtime DB
   useFirestoreForProfile?: boolean
   enableClaims?: boolean
+  /**
+   * Function for changing how profile is written to database (both RTDB and Firestore).
+   */
+  profileFactory?: (userData?: AuthTypes.User, profileData?: any, firebase?: any) => Promise<any> | any
 }
 
 /**
@@ -1052,7 +1056,7 @@ export interface ReduxFirestoreConfig {
 }
 
 /**
- * Props passed to ReactReduFirebaseProvider
+ * Props passed to ReactReduxFirebaseProvider
  * @see https://react-redux-firebase.com/docs/api/ReactReduxFirebaseProvider.html
  */
 export interface ReduxFirestoreProviderProps {
@@ -1130,8 +1134,8 @@ export interface Data<T extends FirestoreTypes.DocumentData> {
 
 export namespace FirebaseReducer {
   export interface Reducer<
-    ProfileType = {},
-    Schema extends Record<string, Record<string | number, string | number>> = {}
+    ProfileType extends Record<string, any> = {},
+    Schema extends Record<string, any> = {}
   > {
     auth: AuthState
     profile: Profile<ProfileType>

package-lock.json

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