feat(vuexfire): rename exports

BREAKING CHANGE: Rename `firebaseMutations` into `vuefireMutations`. Rename `firebaseAction` into
`firestoreAction` since we want to allow using RTDB as well and that name will be used for the
firebaseAction as well

Author: posva

packages/vuexfire/src/index.js

@@ -1,13 +1,17 @@
 import mutations from './mutations'
-import { VUEXFIRE_SET_VALUE, VUEXFIRE_ARRAY_ADD, VUEXFIRE_ARRAY_REMOVE } from './types'
+import {
+  VUEXFIRE_SET_VALUE,
+  VUEXFIRE_ARRAY_ADD,
+  VUEXFIRE_ARRAY_REMOVE
+} from './types'
 
 import { bindCollection, bindDocument } from '@posva/vuefire-core'
-export const firebaseMutations = {}
+export const vuefireMutations = {}
 const commitOptions = { root: true }
 
 Object.keys(mutations).forEach(type => {
   // the { commit, state, type, ...payload } syntax is not supported by buble...
-  firebaseMutations[type] = (_, context) => {
+  vuefireMutations[type] = (_, context) => {
     mutations[type](context.state, context)
   }
 })
@@ -64,7 +68,7 @@ function unbind ({ commit, key }) {
   delete sub[key]
 }
 
-export function firebaseAction (action) {
+export function firestoreAction (action) {
   return function firebaseEnhancedActionFn (context, payload) {
     // get the local state and commit. These may be bound to a module
     const { state, commit } = context

packages/vuexfire/test/index.spec.js

@@ -1,14 +1,14 @@
 import Vuex from 'vuex'
-import { firebaseMutations, firebaseAction } from '../src'
+import { vuefireMutations, firestoreAction } from '../src'
 import { db, tick, Vue, delayUpdate } from '@posva/vuefire-test-helpers'
 
 Vue.use(Vuex)
 
 describe('firebaseAction', () => {
   const store = new Vuex.Store({
-    mutations: firebaseMutations,
+    mutations: vuefireMutations,
     actions: {
-      action: firebaseAction((context, fn) => fn(context))
+      action: firestoreAction((context, fn) => fn(context))
     }
   })
 

packages/vuexfire/test/mutations.spec.js

@@ -1,4 +1,4 @@
-import { firebaseMutations } from '../src'
+import { vuefireMutations } from '../src'
 import {
   VUEXFIRE_SET_VALUE,
   VUEXFIRE_ARRAY_ADD,
@@ -9,7 +9,7 @@ import {
 describe('mutations', () => {
   it('sets a value', () => {
     const state = { foo: null }
-    firebaseMutations[VUEXFIRE_SET_VALUE](state, {
+    vuefireMutations[VUEXFIRE_SET_VALUE](state, {
       path: 'foo',
       target: state,
       data: 'foo'
@@ -19,7 +19,7 @@ describe('mutations', () => {
 
   it('sets a value with a path', () => {
     const state = { foo: { a: { b: null }}}
-    firebaseMutations[VUEXFIRE_SET_VALUE](state, {
+    vuefireMutations[VUEXFIRE_SET_VALUE](state, {
       path: 'foo.a.b',
       target: state,
       data: 'foo'
@@ -29,14 +29,14 @@ describe('mutations', () => {
 
   it('adds to arrays', () => {
     const state = { items: [] }
-    firebaseMutations[VUEXFIRE_ARRAY_ADD](state, {
+    vuefireMutations[VUEXFIRE_ARRAY_ADD](state, {
       target: state.items,
       newIndex: 0,
       data: 'foo'
     })
     expect(state.items).toEqual(['foo'])
 
-    firebaseMutations[VUEXFIRE_ARRAY_ADD](state, {
+    vuefireMutations[VUEXFIRE_ARRAY_ADD](state, {
       target: state.items,
       newIndex: 0,
       data: 'bar'
@@ -46,13 +46,13 @@ describe('mutations', () => {
 
   it('removes from arrays', () => {
     const state = { items: ['foo', 'bar'] }
-    firebaseMutations[VUEXFIRE_ARRAY_REMOVE](state, {
+    vuefireMutations[VUEXFIRE_ARRAY_REMOVE](state, {
       target: state.items,
       oldIndex: 0
     })
     expect(state.items).toEqual(['bar'])
 
-    firebaseMutations[VUEXFIRE_ARRAY_REMOVE](state, {
+    vuefireMutations[VUEXFIRE_ARRAY_REMOVE](state, {
       target: state.items,
       oldIndex: 0
     })

packages/vuexfire/types/index.d.ts

@@ -1,12 +1,20 @@
 import { MutationTree, ActionContext, Action } from 'vuex'
 import { firestore } from 'firebase'
 
-export declare const firebaseMutations: MutationTree<any>
+export declare const vuefireMutations: MutationTree<any>
 
-interface FirebaseActionContext<S, R> extends ActionContext<S, R> {
-  bindFirebaseRef(key: string, ref: firestore.Query): Promise<firestore.DocumentData[]>
-  bindFirebaseRef(key: string, ref: firestore.DocumentReference): Promise<firestore.DocumentData>
+interface FirestoreActionContext<S, R> extends ActionContext<S, R> {
+  bindFirebaseRef(
+    key: string,
+    ref: firestore.Query
+  ): Promise<firestore.DocumentData[]>
+  bindFirebaseRef(
+    key: string,
+    ref: firestore.DocumentReference
+  ): Promise<firestore.DocumentData>
   unbindFirebaseRef(key: string): void
 }
 
-export declare function firebaseAction<S, R>(cb: (context: FirebaseActionContext<S, R>, payload: any) => any): Action<S, R>
+export declare function firestoreAction<S, R>(
+  cb: (context: FirestoreActionContext<S, R>, payload: any) => any
+): Action<S, R>

packages/vuexfire/types/test/index.ts

@@ -1,5 +1,5 @@
 import Vuex from 'vuex'
-import { firebaseMutations, firebaseAction } from '../'
+import { vuefireMutations, firestoreAction } from '../'
 import { firestore } from 'firebase'
 
 interface Payload {
@@ -16,31 +16,37 @@ new Vuex.Store({
   },
   mutations: {
     // your mutations
-    ...firebaseMutations
+    ...vuefireMutations
   },
   actions: {
-    init: firebaseAction(({ bindFirebaseRef, unbindFirebaseRef, commit }, payload: Payload) => {
-      // this will unbind any previously bound ref to 'todos'
-      bindFirebaseRef('todos', payload.todos).then(todos => {
-        todos.length
-        commit('setTodosLoaded', true)
-      }).catch((err) => {
-        console.log(err)
-      })
-      bindFirebaseRef('sortedTodos', payload.sortedTodos).then(todos => {
-        todos.length
-        commit('setSortedTodosLoaded', true)
-      }).catch((err) => {
-        console.log(err)
-      })
+    init: firestoreAction(
+      ({ bindFirebaseRef, unbindFirebaseRef, commit }, payload: Payload) => {
+        // this will unbind any previously bound ref to 'todos'
+        bindFirebaseRef('todos', payload.todos)
+          .then(todos => {
+            todos.length
+            commit('setTodosLoaded', true)
+          })
+          .catch(err => {
+            console.log(err)
+          })
+        bindFirebaseRef('sortedTodos', payload.sortedTodos)
+          .then(todos => {
+            todos.length
+            commit('setSortedTodosLoaded', true)
+          })
+          .catch(err => {
+            console.log(err)
+          })
 
-      bindFirebaseRef('user', payload.user).then(doc => {
-        doc.something
-      })
+        bindFirebaseRef('user', payload.user).then(doc => {
+          doc.something
+        })
 
-      // you can unbind any ref easily
-      unbindFirebaseRef('user')
-    })
+        // you can unbind any ref easily
+        unbindFirebaseRef('user')
+      }
+    )
   },
   plugins: [
     store => {