refactor(vuexfire): migrate to ts

Author: posva

package.json

@@ -15,6 +15,7 @@
     "@typescript-eslint/eslint-plugin": "^1.12.0",
     "@typescript-eslint/parser": "^1.12.0",
     "conventional-changelog-cli": "^2.0.21",
+    "codecov": "^3.5.0",
     "cz-conventional-changelog": "^2.1.0",
     "eslint": "^6.0.1",
     "eslint-config-prettier": "^6.0.0",

packages/@posva/vuefire-core/package.json

@@ -39,8 +39,6 @@
     "url": "https://github.com/vuejs/vuefire/issues"
   },
   "devDependencies": {
-    "@babel/core": "^7.4.5",
-    "@babel/preset-env": "^7.4.5",
     "@posva/vuefire-test-helpers": "^1.1.0",
     "@types/jest": "^24.0.15",
     "firebase": "^6.3.0",

packages/vuefire/package.json

@@ -11,7 +11,6 @@
   "files": [
     "dist",
     "src",
-    "types/*.d.ts",
     "LICENSE"
   ],
   "scripts": {

packages/vuexfire/test/index.spec.js renamed to packages/vuexfire/__tests__/firestore.spec.ts

@@ -1,45 +1,51 @@
 import Vuex from 'vuex'
 import { vuexfireMutations, firestoreAction } from '../src'
 import { db, tick, Vue, delayUpdate } from '@posva/vuefire-test-helpers'
+import { firestore } from 'firebase'
 
 Vue.use(Vuex)
 
 describe('firestoreAction', () => {
-  const store = new Vuex.Store({
+  const item: any = null,
+    items: any[] = []
+  const store = new Vuex.Store<{ item: any; items: any[] }>({
+    state: { item, items },
     mutations: vuexfireMutations,
     actions: {
-      action: firestoreAction((context, fn) => fn(context))
+      action: firestoreAction((context, fn) => fn(context)),
     },
 
     modules: {
       module: {
         namespaced: true,
         actions: {
-          action: firestoreAction((context, fn) => fn(context))
-        }
-      }
-    }
+          action: firestoreAction((context, fn) => fn(context)),
+        },
+      },
+    },
   })
 
-  const setItems = collection =>
-    store.dispatch('action', ({ bindFirestoreRef }) =>
-      bindFirestoreRef('items', collection)
-    )
-  const setItem = document =>
-    store.dispatch('action', ({ bindFirestoreRef }) =>
-      bindFirestoreRef('item', document)
-    )
+  const setItems = (collection: firestore.CollectionReference | firestore.Query) =>
+    // @ts-ignore
+    store.dispatch('action', ({ bindFirestoreRef }) => bindFirestoreRef('items', collection))
+  const setItem = (document: firestore.DocumentReference) =>
+    // @ts-ignore
+    store.dispatch('action', ({ bindFirestoreRef }) => bindFirestoreRef('item', document))
 
-  let collection, document
+  let collection: firestore.CollectionReference, document: firestore.DocumentReference
   beforeEach(async () => {
     store.replaceState({
+      // @ts-ignore
       items: null,
       item: null,
       module: {
-        items: null
-      }
+        items: [],
+      },
     })
+
+    // @ts-ignore
     collection = db.collection()
+    // @ts-ignore
     document = db.collection().doc()
     await tick()
   })
@@ -71,7 +77,8 @@ describe('firestoreAction', () => {
   it('unbinds previously bound refs', async () => {
     await setItem(document)
     expect(store.state.item).toEqual(null)
-    const doc2 = db.collection().doc()
+    // @ts-ignore
+    const doc2: firestore.DocumentReference = db.collection().doc()
     await doc2.update({ bar: 'bar' })
     await document.update({ foo: 'foo' })
     expect(store.state.item).toEqual({ foo: 'foo' })
@@ -83,21 +90,23 @@ describe('firestoreAction', () => {
 
   it('waits for all refs in document', async () => {
     const a = db.collection().doc()
-    const b = db.collection().doc()
+    // @ts-ignore
+    const b: firestore.DocumentReference = db.collection().doc()
     delayUpdate(b)
     await document.update({ a, b })
 
     await setItem(document)
 
     expect(store.state.item).toEqual({
       a: null,
-      b: null
+      b: null,
     })
   })
 
   it('waits for all refs in document with interrupting by new ref', async () => {
     const a = db.collection().doc()
-    const b = db.collection().doc()
+    // @ts-ignore
+    const b: firestore.DocumentReference = db.collection().doc()
     const c = db.collection().doc()
     delayUpdate(b)
     await document.update({ a, b })
@@ -111,14 +120,16 @@ describe('firestoreAction', () => {
     expect(store.state.item).toEqual({
       a: null,
       b: null,
-      c: null
+      c: null,
     })
   })
 
   it('waits for nested refs with data in collections', async () => {
     const a = db.collection().doc()
-    const b = db.collection().doc()
-    const c = db.collection().doc()
+    // @ts-ignore
+    const b: firestore.DocumentReference = db.collection().doc()
+    // @ts-ignore
+    const c: firestore.DocumentReference = db.collection().doc()
     await a.update({ isA: true })
     await c.update({ isC: true })
     await b.update({ c })
@@ -129,17 +140,16 @@ describe('firestoreAction', () => {
 
     await setItems(collection)
 
-    expect(store.state.items).toEqual([
-      { a: { isA: true }},
-      { b: { c: { isC: true }}}
-    ])
+    expect(store.state.items).toEqual([{ a: { isA: true } }, { b: { c: { isC: true } } }])
   })
 
   it('can unbind a reference', async () => {
     await setItems(collection)
     await collection.add({ text: 'foo' })
-    await store.dispatch('action', ({ unbindFirestoreRef }) =>
-      unbindFirestoreRef('items')
+    await store.dispatch(
+      'action',
+      // @ts-ignore
+      ({ unbindFirestoreRef }) => unbindFirestoreRef('items')
     )
 
     expect(store.state.items).toEqual([])
@@ -151,18 +161,24 @@ describe('firestoreAction', () => {
 
   it('does not throw there is nothing to unbind', async () => {
     await setItems(collection)
-    await store.dispatch('action', ({ unbindFirestoreRef }) =>
-      expect(() => {
-        unbindFirestoreRef('items')
-        unbindFirestoreRef('items')
-      }).not.toThrow()
+    await store.dispatch(
+      'action',
+      // @ts-ignore
+      ({ unbindFirestoreRef }) =>
+        expect(() => {
+          unbindFirestoreRef('items')
+          unbindFirestoreRef('items')
+        }).not.toThrow()
     )
 
-    await store.dispatch('module/action', ({ unbindFirestoreRef }) =>
-      expect(() => {
-        unbindFirestoreRef('items')
-        unbindFirestoreRef('items')
-      }).not.toThrow()
+    await store.dispatch(
+      'module/action',
+      // @ts-ignore
+      ({ unbindFirestoreRef }) =>
+        expect(() => {
+          unbindFirestoreRef('items')
+          unbindFirestoreRef('items')
+        }).not.toThrow()
     )
   })
 })

packages/vuexfire/test/mutations.spec.js renamed to packages/vuexfire/__tests__/mutations.spec.ts

@@ -2,8 +2,8 @@ import { vuexfireMutations } from '../src'
 import {
   VUEXFIRE_SET_VALUE,
   VUEXFIRE_ARRAY_ADD,
-  VUEXFIRE_ARRAY_REMOVE
-} from '../src/common/types'
+  VUEXFIRE_ARRAY_REMOVE,
+} from '../src/mutations-types'
 // import { db, tick, Vue } from '@posva/vuefire-test-helpers'
 
 describe('mutations', () => {
@@ -12,17 +12,17 @@ describe('mutations', () => {
     vuexfireMutations[VUEXFIRE_SET_VALUE](state, {
       path: 'foo',
       target: state,
-      data: 'foo'
+      data: 'foo',
     })
     expect(state.foo).toBe('foo')
   })
 
   it('sets a value with a path', () => {
-    const state = { foo: { a: { b: null }}}
+    const state = { foo: { a: { b: null } } }
     vuexfireMutations[VUEXFIRE_SET_VALUE](state, {
       path: 'foo.a.b',
       target: state,
-      data: 'foo'
+      data: 'foo',
     })
     expect(state.foo.a.b).toBe('foo')
   })
@@ -32,14 +32,14 @@ describe('mutations', () => {
     vuexfireMutations[VUEXFIRE_ARRAY_ADD](state, {
       target: state.items,
       newIndex: 0,
-      data: 'foo'
+      data: 'foo',
     })
     expect(state.items).toEqual(['foo'])
 
     vuexfireMutations[VUEXFIRE_ARRAY_ADD](state, {
       target: state.items,
       newIndex: 0,
-      data: 'bar'
+      data: 'bar',
     })
     expect(state.items).toEqual(['bar', 'foo'])
   })
@@ -48,13 +48,13 @@ describe('mutations', () => {
     const state = { items: ['foo', 'bar'] }
     vuexfireMutations[VUEXFIRE_ARRAY_REMOVE](state, {
       target: state.items,
-      oldIndex: 0
+      oldIndex: 0,
     })
     expect(state.items).toEqual(['bar'])
 
     vuexfireMutations[VUEXFIRE_ARRAY_REMOVE](state, {
       target: state.items,
-      oldIndex: 0
+      oldIndex: 0,
     })
     expect(state.items).toEqual([])
   })

packages/vuexfire/test/rtdb/index.spec.js renamed to packages/vuexfire/__tests__/rtdb.spec.ts

@@ -1,46 +1,50 @@
 import Vuex from 'vuex'
-import { firebaseAction, vuexfireMutations } from '../../src'
+import { firebaseAction, vuexfireMutations } from '../src'
 import { MockFirebase, tick, Vue } from '@posva/vuefire-test-helpers'
+import { database } from 'firebase'
 
 Vue.use(Vuex)
 
 const db = new MockFirebase().child('data')
 
 describe('RTDB: firebaseAction', () => {
-  const store = new Vuex.Store({
+  const item: any = null,
+    items: any[] = []
+  const store = new Vuex.Store<{ item: any; items: any[] }>({
+    state: { items, item },
     mutations: vuexfireMutations,
     actions: {
-      action: firebaseAction((context, fn) => fn(context))
+      action: firebaseAction((context, fn) => fn(context)),
     },
 
     modules: {
       module: {
         namespaced: true,
         actions: {
-          action: firebaseAction((context, fn) => fn(context))
-        }
-      }
-    }
+          action: firebaseAction((context, fn) => fn(context)),
+        },
+      },
+    },
   })
 
-  const setItems = collection =>
-    store.dispatch('action', ({ bindFirebaseRef }) =>
-      bindFirebaseRef('items', collection)
-    )
-  const setItem = document =>
-    store.dispatch('action', ({ bindFirebaseRef }) =>
-      bindFirebaseRef('item', document)
-    )
+  const setItems = (collection: database.Query) =>
+    // @ts-ignore
+    store.dispatch('action', ({ bindFirebaseRef }) => bindFirebaseRef('items', collection))
+  const setItem = (document: database.Reference) =>
+    // @ts-ignore
+    store.dispatch('action', ({ bindFirebaseRef }) => bindFirebaseRef('item', document))
 
-  let collection, document
+  let collection: database.Reference, document: database.Reference
   beforeEach(async () => {
     store.replaceState({
       items: [],
-      item: null
+      item: null,
     })
     collection = db.child('data')
     document = db.child('item')
+    // @ts-ignore
     collection.autoFlush()
+    // @ts-ignore
     document.autoFlush()
     await tick()
   })
@@ -71,6 +75,7 @@ describe('RTDB: firebaseAction', () => {
   it('unbinds previously bound refs', async () => {
     await setItem(document)
     const doc2 = db.child('doc2')
+    // @ts-ignore
     doc2.autoFlush()
     doc2.set({ bar: 'bar' })
     setItem(doc2)
@@ -82,8 +87,10 @@ describe('RTDB: firebaseAction', () => {
   it('can unbind a reference', async () => {
     await setItems(collection)
     collection.push({ text: 'foo' })
-    await store.dispatch('action', ({ unbindFirebaseRef }) =>
-      unbindFirebaseRef('items')
+    await store.dispatch(
+      'action',
+      // @ts-ignore
+      ({ unbindFirebaseRef }) => unbindFirebaseRef('items')
     )
 
     expect(store.state.items).toEqual([])
@@ -95,18 +102,24 @@ describe('RTDB: firebaseAction', () => {
 
   it('does not throw there is nothing to unbind', async () => {
     await setItems(collection)
-    await store.dispatch('action', ({ unbindFirebaseRef }) =>
-      expect(() => {
-        unbindFirebaseRef('items')
-        unbindFirebaseRef('items')
-      }).not.toThrow()
+    await store.dispatch(
+      'action',
+      // @ts-ignore
+      ({ unbindFirebaseRef }) =>
+        expect(() => {
+          unbindFirebaseRef('items')
+          unbindFirebaseRef('items')
+        }).not.toThrow()
     )
 
-    await store.dispatch('module/action', ({ unbindFirebaseRef }) =>
-      expect(() => {
-        unbindFirebaseRef('items')
-        unbindFirebaseRef('items')
-      }).not.toThrow()
+    await store.dispatch(
+      'module/action',
+      // @ts-ignore
+      ({ unbindFirebaseRef }) =>
+        expect(() => {
+          unbindFirebaseRef('items')
+          unbindFirebaseRef('items')
+        }).not.toThrow()
     )
   })
 })