firex-store

firex-store

• If you use this npm, you can reference firestore data, easily

• It is inspired by vuexfire

• node v8.9.4 ~

Installation

npm install --save firex-store

Example

• Nuxt SSR sample

others comming soon

Important!

• Return values or state values bounded to Firestore has docId(documentId in Firestore) property.

• A store module cannot subscribe to more than one 'collection' and 'document'

• If you want to subscribe again after unsubscribing 'collection', set the property of the store you want to subscribe to [] and then subscribe.

Usage

• Subscribe Firestore, using firex-store actions
• Subscribe Firestore, using custom actions
• Unsubscribe Firestore, using firex-store actions
• Unsubscribe Firestore, using custom actions
• Fetch at Once
• Options

Before Start...

• You have to initailize firebase

.....

firebase.initializeApp({
  apiKey: [your firebase api key],
  projectId: [your project id],
  .....
})

export const firestore = firebase.firestore()

1. Subscribe Firestore, using firex-store actions

part1. Add below mutations to namespaced Store

• method: firestoreMutations
• argments:
  • statePropName: you want to bind in the state
  • type: 'collection' or 'document'

Ex. Subscribe collection

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  .....
}

part2. Add below actions to namespaced Store

• method: firestoreSubscribeAction or firestoreSubscribeActions

  • firestoreSubscribeActions is deprecated. It will be removed at ^1.0.0~

• argments:

  • ref: firebase.firestore.DocumentReference | firebase.firestore.CollectionReference | firebase.firestore.Query
  • actionName?: action property you want to define.
  • options?: see Options

Ex. Subscribe collection

// modules: comment
export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  actions: {
    ...firestoreSubscribeAction({ ref: firestore.collection('/comments') })
  }
.....
}

part3. Call firex-store actionType to subscribe data

Ex. Subscribe collection

<script>
import { actionTypes } from 'firex-store'

export default {
  name: 'Comments',
  created() {
    this.$store.dispatch(`comment/${actionTypes.collection.SUBSCRIBE}`)
  }
}

</script>

2. Subscribe Firestore, using custom actions

part1. Add below mutations to namespaced Store

• method: firestoreMutations
• argments:
  • statePropName: you want to bind in the state
  • type: 'collection' or 'document'

Ex. Subscribe collection

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  .....
}

part2. Add subscribeFirestore in custom-actions

• method: subscribeFirestore
• argments:
  • state: State
  • commit: Commit
  • ref: firebase.firestore.DocumentReference | firebase.firestore.CollectionReference | firebase.firestore.Query
  • options?: see Options

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  actions: {
    subscribe: ({ state, commit }) => {
      subscribeFirestore({
        state,
        commit,
        ref: firestore.collection('/comments'),
        options
      })
    }
  }
.....
}

3. Unsubscribe Firestore, using firex-store actions

Ex. Unsubscribe collection

part1. Add firestoreUnsubscribeAction in actions

• method: firestoreUnsubscribeAction or firestoreUnsubscribeActions

  • firestoreUnsubscribeActions is deprecated. It will be removed at ^1.0.0~

• argments:

  • type: 'document' | 'collection'
  • actionName?: string

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  actions: {
    ...firestoreSubscribeAction({ ref: firestore.collection('/comments') }),
    ...firestoreUnsubscribeAction({ type: 'collection' })
  }
.....
}

part2. Call firex-store actionType to unsubscribe data

<script>
import { actionTypes } from 'firex-store'

export default {
  name: 'Comments',
  created() {
    this.$store.dispatch(`comment/${actionTypes.collection.UNSUBSCRIBE}`)
  }
}

</script>

4. Unsubscribe Firestore, using custom actions

• method: unsubscribeFirestore

• argments:

  • type: 'document' | 'collection'
  • state: State

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' })
  },
  actions: {
    subscribe: ({ state, commit }) => {
      subscribeFirestore({
        state,
        commit,
        ref: firestore.collection('/comments'),
        options
      })
    },
    unsubscribe: ({ state }) => {
      unsubscribeFirestore({
        state,
        type: 'collection'
      })
    }
  }
.....
}

5. Fetch at Once

• method: findFirestore

• argments:

  • ref: firebase.firestore.DocumentReference | firebase.firestore.CollectionReference | firebase.firestore.Query
  • options?: see Options

• Return null if data not found

EX. Call in Store Action, to fetch collection

export default {
  namespaced: true,
  state: {},
  getters: {},
  mutations: {},
  actions: {
    fetchComments: async ({ commit }) => {
      const ref = firestore.collection('/comments')
      const result = await findFirestore({ ref })
      commit(***, result)
    }
  }
}

Options

• Options

  • mapper:

    • Map to something. State prop bound to Firestore or return values map to something if mapper defined

  • errorHandler

    • If it defined, call it when error occured. But if not, call console.error(error)

  • CompletionHandler

    • If it defined, call it when completed

  • OnCompleted ※ It is deprecated and removed on v1.0.0~

    • If it defined, call it when completed

  • afterMutationCalled

    • subscribeFirestore and subscribeFirestoreActions only.
    • If it defined, call it when completed
    • This method called after mutation called
    • @param payload
      • type payload = {
        • data: { docId: string | null, [key: string]: any }, <-- subscribed data
        • isLast: boolean, <-- In 'document' subscribed , it undefined. In 'collection' subscribed, true or false.
          • UseCase: disappear and appear loading bar when subscribed 'collection' data at first
        • [key: string]: any }

  • notFoundHandler

    • If it defined, call it when snapshot doesn't exist
    • @param type: 'document' | 'collection'
    • @param isAll:
      • undefined when subscribe Document data
      • true when subscribe Collection data
      • false when subscribe Collection data and document in Collection is not existed

Ex.

const mapUser = (data) => ({
  id: data.id
  name: data.name
  .....
})

const errorHandler = (error) => {
  console.error(`[App Name]:  ${error}`)
}

const completionHandler = () => {
  console.log('completed!')
}

const afterMutationCalled = (payload) => {
  /**
   * payload = {
   *   data: { docId: string | null, [key: string]: any },
   *   isLast: boolean,
   *   [key: string]: any
   * }
   * */
  if (payload.isLast === false) {
    commit('SET_LOADING', true)
  } else if (payload.isLast === true) {
    commit('SET_LOADING', false)
  }
}

const notFoundHandler = (type, isAll) => {
  console.log('not found')
}

const notFoundHandler = (type, isAll) => {
  console.log('not found')
}

export default {
  namespaced: true,
  state: {
    comments: [],
    comment: null,
    isLoading: false
  },
  mutations: {
    ...firestoreMutations({ statePropName: 'comments', type: 'collection' }),
    SET_LOADING(state, isLoading) {
      state.isLoading = isLoading
    }
  },
  actions: {
    subscribe: ({ state, commit }) => {
      subscribeFirestore({
        state,
        commit,
        ref: firestore.collection('/comments'),
        options: {
          mapper: mapUser,
          errorHandler,
          completionHandler,
          // onCompleted, <- deprecated
          afterMutationCalled,
          notFoundHandler
        }
      })
    }
  }
  .....
}