feat(all): add type annotations

build/tasks/build.js

@@ -12,7 +12,7 @@ var tools = require('aurelia-tools');
 
 gulp.task('build-index', function(){
   var importsToAdd = [];
-  var files = ['util.js', 'http-client-configuration.js', 'http-client.js'].map(function(file){
+  var files = ['util.js', 'http-client-configuration.js', 'http-client.js', 'interfaces.js'].map(function(file){
     return paths.root + file;
   });
 

package.json

@@ -36,7 +36,7 @@
   },
   "devDependencies": {
     "aurelia-tools": "^0.1.7",
-    "babel-dts-generator": "^0.2.5",
+    "babel-dts-generator": "^0.2.6",
     "babel-eslint": "^3.1.19",
     "conventional-changelog": "0.0.11",
     "del": "^1.1.0",

src/http-client-configuration.js

@@ -1,3 +1,4 @@
+import {IRequestInit, IInterceptor} from './interfaces';
 import 'core-js';
 
 /**
@@ -11,7 +12,7 @@ export class HttpClientConfiguration {
   * The base URL to be prepended to each Request's url before sending.
   * @type {String}
   */
-  baseUrl = '';
+  baseUrl: string = '';
 
   /**
   * Default values to apply to init objects when creating Requests. Note that
@@ -20,13 +21,13 @@ export class HttpClientConfiguration {
   * See also https://developer.mozilla.org/en-US/docs/Web/API/Request/Request
   * @type {Object}
   */
-  defaults = {};
+  defaults: IRequestInit = {};
 
   /**
   * Interceptors to be added to the HttpClient.
   * @type {Array}
   */
-  interceptors = [];
+  interceptors: IInterceptor[] = [];
 
   /**
   * Sets the baseUrl.
@@ -35,7 +36,7 @@ export class HttpClientConfiguration {
   * @returns {HttpClientConfiguration}
   * @chainable
   */
-  withBaseUrl(baseUrl) {
+  withBaseUrl(baseUrl: string): HttpClientConfiguration {
     this.baseUrl = baseUrl;
     return this;
   }
@@ -47,7 +48,7 @@ export class HttpClientConfiguration {
   * @returns {HttpClientConfiguration}
   * @chainable
   */
-  withDefaults(defaults) {
+  withDefaults(defaults: IRequestInit): HttpClientConfiguration {
     this.defaults = defaults;
     return this;
   }
@@ -63,7 +64,7 @@ export class HttpClientConfiguration {
   * @returns {HttpClientConfiguration}
   * @chainable
   */
-  withInterceptor(interceptor) {
+  withInterceptor(interceptor: IInterceptor): HttpClientConfiguration {
     this.interceptors.push(interceptor);
     return this;
   }
@@ -75,7 +76,7 @@ export class HttpClientConfiguration {
   * @returns {HttpClientConfiguration}
   * @chainable
   */
-  useStandardConfiguration() {
+  useStandardConfiguration(): HttpClientConfiguration {
     let standardConfig = { credentials: 'same-origin' };
     Object.assign(this.defaults, standardConfig, this.defaults);
     return this.rejectErrorResponses();
@@ -92,7 +93,7 @@ export class HttpClientConfiguration {
   * @returns {HttpClientConfiguration}
   * @chainable
   */
-  rejectErrorResponses() {
+  rejectErrorResponses(): HttpClientConfiguration {
     return this.withInterceptor({ response: rejectOnError });
   }
 }

src/http-client.js

@@ -1,20 +1,28 @@
 import {HttpClientConfiguration} from './http-client-configuration';
 import {mergeHeaders} from './util';
+import {IRequestInit, IInterceptor} from './interfaces';
 import 'core-js';
 
+type ConfigOrCallback = IRequestInit|(config: HttpClientConfiguration) => void|string;
+
 /**
 * An HTTP client based on the Fetch API.
 *
 * @class HttpClient
 * @constructor
 */
 export class HttpClient {
-  activeRequestCount = 0;
-  isRequesting = false;
-  interceptors = [];
-  isConfigured = false;
-  baseUrl = '';
-  defaults = null;
+  activeRequestCount: number = 0;
+
+  isRequesting: boolean = false;
+
+  interceptors: IInterceptor[] = [];
+
+  isConfigured: boolean = false;
+
+  baseUrl: string = '';
+
+  defaults: IRequestInit = null;
 
   /**
   * Configure this client with default settings to be used by all requests.
@@ -24,7 +32,7 @@ export class HttpClient {
   * @returns {HttpClient}
   * @chainable
   */
-  configure(config) {
+  configure(config: ConfigOrCallback): HttpClient {
     let normalizedConfig;
 
     if (typeof config === 'string') {
@@ -60,7 +68,7 @@ export class HttpClient {
   * the Request.
   * @return {Promise} - A Promise that resolves with the Response.
   */
-  fetch(input, init) {
+  fetch(input: Request|string, init?: IRequestInit): Promise<Response> {
     this::trackRequestStart();
 
     let request = Promise.resolve().then(() => this::buildRequest(input, init, this.defaults));

src/interfaces.js

@@ -0,0 +1,25 @@
+/* eslint-disable */
+
+interface IInterceptor {
+  request?: (request: Request) => Request|Response|Promise<Request|Response>;
+
+  requestError?: (error: any) => Request|Response|Promise<Request|Response>;
+
+  response?: (response: Response) => Response|Promise<Response>;
+
+  responseError?: (error: any) => Response|Promise<Response>;
+}
+
+interface IRequestInit {
+  method?: string;
+
+  headers?: Headers;
+
+  body?: Blob|BufferSource|FormData|URLSearchParams|string;
+
+  mode?: string;
+
+  credentials?: string;
+
+  cache?: string;
+}

src/util.js

@@ -5,7 +5,7 @@
 * @param {*} body - [description]
 * @return {Blob} - A blob containing the JSON-serialized body.
 */
-export function json(body) {
+export function json(body: any): Blob {
   return new Blob([JSON.stringify(body)], { type: 'application/json' });
 }
 
@@ -20,7 +20,7 @@ export function json(body) {
 * @return {Headers} - A Headers instance containing the headers from
 * both objects.
 */
-export function mergeHeaders(first, second) {
+export function mergeHeaders(first: Headers|Object, second: Headers|Object): Headers {
   let headers = new Headers(first || {});
   (new Headers(second || {})).forEach((value, name) => {
     headers.set(name, value);