feat(types): complete typings as much as possible

Author: posva

package.json

@@ -6,9 +6,11 @@
   "module": "dist/vuefire.esm.js",
   "unpkg": "dist/vuefire.js",
   "browser": "dist/vuefire.esm.js",
-  "types": "./types/index.d.ts",
+  "types": "types/index.d.ts",
   "files": [
-    "dist/**",
+    "dist/*.js",
+    "src",
+    "types/*.d.ts",
     "LICENSE",
     "README.md"
   ],

types/index.d.ts

@@ -1,4 +1,7 @@
 import * as firebase from 'firebase'
 import { PluginFunction } from 'vue'
+import './vue'
 
-export declare const install: PluginFunction<never>
+declare const Vuefire: PluginFunction<never>
+
+export default Vuefire

types/test/index.ts

@@ -0,0 +1,49 @@
+import Vue from 'vue'
+import * as firebase from 'firebase'
+import Vuefire from '../index'
+
+const db = firebase.firestore()
+
+Vue.use(Vuefire)
+
+const app = new Vue({
+  firestore: {
+    todos: db.collection('todos'),
+    doc: db.collection('todos').doc('2')
+  }
+})
+
+new Vue({
+  firestore() {
+    return {
+      todos: db.collection('todos'),
+      doc: db.collection('todos').doc('2')
+    }
+  }
+})
+
+app.$firestoreRefs.todos.id
+
+app.$bind('document', db.collection('todos').doc('1')).then(doc => {
+  doc.something
+})
+
+app.$bind('collection', db.collection('todos')).then(todos => {
+  todos.length
+})
+
+app.$unbind('document')
+app.$unbind('collection')
+
+Vue.component('firestore-component', {
+  firestore: {
+    todos: db.collection('todos'),
+    doc: db.collection('todos').doc('2')
+  },
+  methods: {
+    doSomething() {
+      // TODO not sure if making this work is possible
+      // this.todos.map(todo => todo.id)
+    }
+  }
+})

types/test/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "es5",
-    "lib": ["es2015"],
+    "lib": ["dom", "es2015"],
     "module": "commonjs",
     "strict": true,
     "noEmit": true,
@@ -10,6 +10,6 @@
       "vuefire": ["../index.d.ts"]
     }
   },
-  "files": ["../index.d.ts", "../vue.d.ts"],
+  "files": ["index.ts", "../index.d.ts", "../vue.d.ts"],
   "compileOnSave": false
 }

types/vue.d.ts

@@ -3,16 +3,37 @@
  */
 
 import Vue from 'vue'
+import { firestore } from 'firebase'
+
+declare function bindCollection(
+  name: string,
+  reference: firestore.CollectionReference
+): Promise<firestore.DocumentData[]>
+
+declare function bindDocument(
+  name: string,
+  reference: firestore.DocumentReference
+): Promise<firestore.DocumentData>
 
 declare module 'vue/types/vue' {
   interface Vue {
-    $bind: any
-    $unbind: any
+    $bind: typeof bindCollection & typeof bindDocument
+    $unbind: (name: string) => void
+    $firestoreRefs: Readonly<
+      Record<string, firestore.DocumentReference | firestore.CollectionReference>
+    >
   }
 }
 
+type VueFirestoreObject = Record<
+  string,
+  firestore.DocumentReference | firestore.CollectionReference
+>
+
+type FirestoreOption<V> = VueFirestoreObject | ((this: V) => VueFirestoreObject)
+
 declare module 'vue/types/options' {
   interface ComponentOptions<V extends Vue> {
-    firestore?: any
+    firestore?: FirestoreOption<V>
   }
 }