Firestore Reducer Type Documentation

[uloco]

What is the feature?
Could you please add some documentation about how to use the types for the reducers?
What is FirestoreReducer.Entity for? How do I type Firestore correctly? How does the Schema look like for example?
I am trying to get this working but I really struggle in finding the proper way, because I cannot find any documentation or reference which types are designed for what.
Also an overall guide on how to setup Firestore with Typescript and redux-toolkit in general would be really helpful.
For example the firestoreReducer function (in combineReduceres) returns a different type than the FirestoreReducer.Reducer. I don't know how to make redux understand and infer the types correctly.

What version would this apply to?
0.15.0

[Gsiete]

Hey, does it help you if I tell you that I had to go from:

interface FBReduxSchema {
  companies: Company;
  users: User;
}

to

import Entity = FirestoreReducer.Entity;

interface FBReduxSchema {
  companies: Entity<Company>;
  users: Entity<User>;
}

Of course I had it in the SelectorRootObject

type FireBaseState = FirebaseReducer.Reducer<FirebaseReducer.Profile<User>, FBReduxSchema>;
type FirestoreState = FirestoreReducer.Reducer<FBReduxSchema>;
export interface SelectorRootObject {
  firebase: FireBaseState;
  firestore: FirestoreState;
  router: RouterState;
}

I know I'm skipping a lot, but I was working on it right now and the Entity thing is what I was missing

[uloco]

Thanks for the example, I'm currently working on some other issues and don't have time to elaborate, but this will help me a bit more I guess. I will come back to this next week hopefully.

I have seen the Entity thing but was not sure if my Schema got the right structure, since it also was making problems. But maybe I used it wrong, will try. Thanks a lot!

[ericettensohn]

I'm having trouble with using the reducer's types to handle an individual document lookup stored with storeAs. Example schema:

interface Schema {
  myDoc:  MyDoc;
}

interface MyDoc {
  name: string ;
  age: number
}

With a connection like this:

  useFirestoreConnect({
    collection: 'myCollection',
    doc: 'doc1',
    storeAs: 'myDoc'
  });

Selecting it like this:

  const name = useAppSelector(
    state => state.firestore.data.myDoc?.name
  );

If I type myDoc in the Schema as Entity<MyDoc>, the compiler will expect name to be Entity<MyDoc> when it should be string. If I don't wrap it in an Entity, it'll expect name to be of type MyDoc when it should be string. With the reducer setup the way it is, it doesn't seem possible to look up a single doc, store it with storeAs, and define it properly in the Schema. The closest I've come to making this work is to set myDoc in the Schema to myDoc[keyof MyDoc] so I at least have a rough idea of what the value will be. Then the compiler will expect name to be string | number but obviously that's not an ideal solution.