Add Type declaration file (#57)

* typing file skeleton

* add initial typing

* add type tests

* update package.json

* address code review and improve types

Author: HerringtonDarkholme

Diff for: package-lock.json

@@ -25,7 +25,9 @@
     "dev": "rollup -c rollup.config.js -w",
     "build": "rollup -c rollup.config.js",
     "lint": "eslint src test example --fix",
-    "test": "jest",
+    "test": "npm run test:unit && npm run test:types",
+    "test:unit": "jest",
+    "test:types": "tsc -p types/test",
     "dev:test": "jest --watch",
     "prebuild": "npm run lint",
     "pretest": "npm run build",
@@ -41,6 +43,7 @@
     "rollup-plugin-buble": "^0.15.0",
     "rollup-watch": "^3.2.2",
     "rxjs": "^5.2.0",
+    "typescript": "^2.5.2",
     "vue": "^2.2.4"
   },
   "eslintConfig": {

Diff for: package.json

@@ -0,0 +1,34 @@
+import Vue = require('vue')
+import { WatchOptions } from 'vue'
+import { Observable } from 'rxjs/Observable'
+
+export type Observables = Record<string, Observable<any>>
+declare module 'vue/types/options' {
+  interface ComponentOptions<V extends Vue> {
+    subscriptions?: Observables | ((this: V) => Observables)
+    domStreams?: string[]
+    observableMethods?: string[] | Record<string, string>
+  }
+}
+
+export interface WatchObservable<T> {
+  newValue: T
+  oldValue: T
+}
+declare module "vue/types/vue" {
+  interface Vue {
+    $observables: Observables;
+    $watchAsObservable(expr: string, options?: WatchOptions): Observable<WatchObservable<any>>
+    $watchAsObservable<T>(fn: (this: this) => T, options?: WatchOptions): Observable<WatchObservable<T>>
+    $eventToObservable(event: string): Observable<{name: string, msg: any}>
+    $subscribeTo<T>(
+      observable: Observable<T>,
+      next: (t: T) => void,
+      error?: (e: any) => void,
+      complete?: () => void): void
+    $fromDOMEvent(selector: string | null, event: string): Observable<Event>
+    $createObservableMethod(methodName: string): Observable<any>
+  }
+}
+
+export declare function install(V: typeof Vue): void

Diff for: types/index.d.ts

@@ -0,0 +1,90 @@
+import Vue = require('vue')
+import * as VueRX from '../index'
+import * as Rx from 'rxjs/Rx'
+
+Vue.use(VueRX, Rx)
+
+var vm = new Vue({
+  el: '#app',
+  subscriptions: {
+    msg: Rx.Observable.interval(100)
+  }
+})
+
+vm.$observables.msg.subscribe(msg => console.log(msg))
+
+Vue.component('foo', {
+  subscriptions: function () {
+    return {
+      msg: Rx.Observable.interval(100)
+    }
+  }
+})
+
+new Vue({
+  domStreams: ['plus$']
+})
+
+var vm = new Vue({
+  data: {
+    a: 1
+  },
+  subscriptions () {
+    // declaratively map to another property with Rx operators
+    return {
+      aPlusOne: this.$watchAsObservable('a')
+        .pluck('newValue')
+        .map((a: number) => a + 1)
+    }
+  }
+})
+
+// or produce side effects...
+vm.$watchAsObservable('a')
+  .subscribe(
+    ({ newValue, oldValue }) => console.log('stream value', newValue, oldValue),
+    err => console.error(err),
+    () => console.log('complete')
+  )
+
+
+var vm = new Vue({
+  created () {
+    this.$eventToObservable('customEvent')
+    .subscribe((event) => console.log(event.name,event.msg))
+  }
+})
+
+var vm = new Vue({
+  mounted () {
+    this.$subscribeTo(Rx.Observable.interval(1000), function (count) {
+      console.log(count)
+    })
+  }
+})
+
+var vm = new Vue({
+  subscriptions () {
+    return {
+      inputValue: this.$fromDOMEvent('input', 'keyup').pluck('target', 'value')
+    }
+  }
+})
+
+var vm = new Vue({
+  subscriptions () {
+    return {
+      // requires `share` operator
+      formData: this.$createObservableMethod('submitHandler')
+    }
+  }
+})
+
+var vm = new Vue({
+  subscriptions () {
+    return {
+      // requires `share` operator
+      formData: this.$createObservableMethod('submitHandler')
+    }
+  }
+})

Diff for: types/test/index.ts

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.promise",
+      "es2015.core"
+    ],
+    "strict": true,
+    "noEmit": true
+  }
+}

Diff for: types/test/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.promise"
+    ],
+    "strict": true,
+    "noEmit": true
+  },
+  "include": [
+    "*.d.ts"
+  ]
+}

Diff for: types/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "name": "vue-rx",
+  "main": "index.d.ts"
+}