Merge pull request #611 from dl00/develop

Add Vue 2.x typings for TypeScript

Author: steffans

docs/config.md

@@ -48,3 +48,7 @@ If your web server can't handle REST/HTTP requests like `PUT`, `PATCH` and `DELE
 ```js
 Vue.http.options.emulateHTTP = true;
 ```
+
+## Typescript Support
+
+Typescript for vue-resource should work out of the box since the type definition files are included within the npm package.

package.json

@@ -5,6 +5,7 @@
   "module": "dist/vue-resource.esm.js",
   "unpkg": "dist/vue-resource.min.js",
   "jsdelivr": "dist/vue-resource.min.js",
+  "typings": "types/index.d.ts",
   "description": "The HTTP client for Vue.js",
   "homepage": "https://github.com/pagekit/vue-resource#readme",
   "license": "MIT",

types/index.d.ts

@@ -0,0 +1,94 @@
+import _Vue = require('vue');
+
+// augment typings of Vue.js
+import './vue';
+
+export interface HttpHeaders {
+    put?: { [key: string]: string };
+    post?: { [key: string]: string };
+    patch?: { [key: string]: string };
+    delete?: { [key: string]: string };
+    common?: { [key: string]: string };
+    custom?: { [key: string]: string };
+    [key: string]: any;
+}
+
+export interface HttpResponse {
+    data: any;
+    ok: boolean;
+    status: number;
+    statusText: string;
+    headers: Function;
+    text():string;
+    json():any;
+    blob():Blob;
+}
+
+export interface HttpOptions {
+    url?: string;
+    method?: string;
+    body?: any;
+    params?: any;
+    headers?: any;
+    before?(request: any): any;
+    progress?(event: any): any;
+    credentials?:boolean;
+    emulateHTTP?: boolean;
+    emulateJSON?: boolean;
+}
+
+export interface $http {
+    (url: string, data?: any, options?: HttpOptions): PromiseLike<HttpResponse>;
+    (url: string, options?: HttpOptions): PromiseLike<HttpResponse>;
+}
+
+export interface HttpInterceptor {
+    request?(request: HttpOptions): HttpOptions;
+    response?(response: HttpResponse): HttpResponse;
+}
+
+export interface Http {
+    options: HttpOptions & { root: string };
+    headers: HttpHeaders;
+    interceptors: (HttpInterceptor | (() => HttpInterceptor))[];
+    get: $http;
+    post: $http;
+    put: $http;
+    patch: $http;
+    delete: $http;
+    jsonp: $http;
+}
+
+export interface ResourceActions {
+    get: { method: string };
+    save: { method: string };
+    query: { method: string };
+    update: { method: string };
+    remove: { method: string };
+    delete: { method: string };
+}
+
+export interface ResourceMethod {
+    (params: any, data?: any, success?: Function, error?: Function): PromiseLike<HttpResponse>;
+    (params: any, success?: Function, error?: Function): PromiseLike<HttpResponse>;
+    (success?: Function, error?: Function): PromiseLike<HttpResponse>;
+}
+
+export interface ResourceMethods {
+    get: ResourceMethod;
+    save: ResourceMethod;
+    query: ResourceMethod;
+    update: ResourceMethod;
+    remove: ResourceMethod;
+    delete: ResourceMethod;
+}
+
+export interface $resource {
+    (url: string, params?: any, actions?: any, options?: HttpOptions): ResourceMethods;
+}
+
+export interface Resource extends $resource {
+    actions: ResourceActions;
+}
+
+export declare function install(vue: typeof _Vue): void;

types/vue.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Extends interfaces in Vue.js
+ */
+
+import Vue from "vue";
+import { HttpHeaders, HttpOptions, HttpResponse, $http, $resource } from "./index";
+
+declare module "vue/types/options" {
+  interface ComponentOptions<V extends Vue> {
+    http?: (HttpOptions & { headers?: HttpHeaders } & { [key: string]: any })
+  }
+}
+
+declare module "vue/types/vue" {
+    interface Vue {
+        $http: {
+            (options: HttpOptions): PromiseLike<HttpResponse>;
+            get: $http;
+            post: $http;
+            put: $http;
+            patch: $http;
+            delete: $http;
+            jsonp: $http;
+        };
+        $resource: $resource;
+    }
+}