Improving TypeScript support

Author: jmdobry

.gitignore

@@ -8,4 +8,5 @@ coverage/
 junit/
 doc/
 node_modules/
-*.log
+*.log
+typings

.npmignore

@@ -1,3 +1,17 @@
+##### 3.0.0-beta.3 - 28 April 2016
+
+###### Breaking changes
+- js-data-http.js no longer exports a default module, you must now do:
+  - `import {HttpAdapter} from 'js-data-http'
+  - `var HttpAdapter = require('js-data-http').HttpAdapter
+  - `var adapter = new window.JSDataHttp.HttpAdapter()`
+  - `define(['js-data-http'], function (JSDataHttp) { var adapter = new window.JSDataHttp.HttpAdapter(); })
+
+###### Backwards compatible changes
+- Added `typings` field to `package.json`
+- Added `typings.json`
+- Added `dist/js-data-http.d.ts`
+
 ##### 3.0.0-beta.2 - 17 April 2016
 
 Official v3 beta release

CHANGELOG.md

@@ -1,45 +1,38 @@
-declare module JSDataHttp {
-	
-	interface IDict {
-		[key: string]: any;
-	}
-	
-	interface IActionOpts {
-		adapter?: string,
-		pathname?: string,
-		request?: Function,
-		response?: Function,
-		responseError?: Function
-	}
-	
-	interface IBaseHttpAdapter {
-		basePath?: string,
-		suffix?: string,
-		debug?: boolean,
-		forceTrailingSlash?: boolean,
-		useFetch?: boolean
-		http?: any,
-		httpConfig?: IDict	
-	}
-	
-	export class HttpAdapter implements IBaseHttpAdapter {
+import {Adapter} from 'js-data-adapter'
 
-		static version: {
-			full?: string,
-			minor?: string,
-			major?: string,
-			patch?: string,
-			alpha?: string | boolean,
-			beta?: string | boolean
-		}
-		static addAction(name: string, opts: IActionOpts): Function
-		static addActions(opts?: {[key:string]: IActionOpts}): Function
-		static extend(instanceProps?: IDict, classProps?: IDict): HttpAdapter
-
-		constructor(opts: IBaseHttpAdapter)
-	}
+interface IDict {
+  [key: string]: any;
+}
+interface IActionOpts {
+  adapter?: string,
+  pathname?: string,
+  request?: Function,
+  response?: Function,
+  responseError?: Function
+}
+interface IBaseAdapter extends IDict {
+  debug?: boolean,
+  raw?: boolean
+}
+interface IBaseHttpAdapter extends IBaseAdapter {
+  basePath?: string
+  forceTrailingSlash?: boolean
+  http?: any
+  httpConfig?: IDict
+  suffix?: string
+  useFetch?: boolean
+}
+export function addAction(name: string, opts: IActionOpts): Function
+export function addActions(opts ?: { [key:string]: IActionOpts }): Function
+export class HttpAdapter extends Adapter {
+  static version: {
+    full?: string
+    minor?: string
+    major?: string
+    patch?: string
+    alpha?: string | boolean
+    beta?: string | boolean
+  }
+  static extend(instanceProps?: IDict, classProps?: IDict): typeof HttpAdapter
+  constructor(opts?: IBaseHttpAdapter)
 }
-
-declare module 'js-data-http' {
-  export = JSDataHttp.HttpAdapter
-}

dist/js-data-http.d.ts

@@ -0,0 +1,38 @@
+import {Adapter} from 'js-data-adapter'
+
+interface IDict {
+  [key: string]: any;
+}
+interface IActionOpts {
+  adapter?: string,
+  pathname?: string,
+  request?: Function,
+  response?: Function,
+  responseError?: Function
+}
+interface IBaseAdapter extends IDict {
+  debug?: boolean,
+  raw?: boolean
+}
+interface IBaseHttpAdapter extends IBaseAdapter {
+  basePath?: string
+  forceTrailingSlash?: boolean
+  http?: any
+  httpConfig?: IDict
+  suffix?: string
+  useFetch?: boolean
+}
+export function addAction(name: string, opts: IActionOpts): Function
+export function addActions(opts ?: { [key:string]: IActionOpts }): Function
+export class HttpAdapter extends Adapter {
+  static version: {
+    full?: string
+    minor?: string
+    major?: string
+    patch?: string
+    alpha?: string | boolean
+    beta?: string | boolean
+  }
+  static extend(instanceProps?: IDict, classProps?: IDict): typeof HttpAdapter
+  constructor(opts?: IBaseHttpAdapter)
+}

fetch/.npmignore

@@ -1,7 +1,7 @@
 {
   "name": "js-data-fetch",
   "description": "HTTP adapter for js-data that uses the fetch API.",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "homepage": "https://github.com/js-data/js-data-http",
   "repository": {
     "type": "git",
@@ -10,6 +10,9 @@
   "author": "js-data-http project authors",
   "license": "MIT",
   "main": "./dist/js-data-fetch.js",
+  "files": [
+    "dist/"
+  ],
   "keywords": [
     "ajax",
     "axios",
@@ -19,6 +22,6 @@
     "fetch"
   ],
   "peerDependencies": {
-    "js-data": "^3.0.0-beta.1"
+    "js-data": "^3.0.0-beta.2"
   }
 }

fetch/dist/js-data-fetch.d.ts

@@ -0,0 +1,10 @@
+{
+  "name": "js-data-fetch",
+  "version": false,
+  "main": "./dist/js-data-fetch.d.ts",
+  "ambientDependencies": {
+    "js-data": "npm:js-data",
+    "js-data-adapter": "npm:js-data-adapter",
+    "es6-shim": "registry:dt/es6-shim#0.31.2+20160317120654"
+  }
+}

fetch/package.json

@@ -1,4 +1,4 @@
-/* global JSData:true, HttpAdapter:true, sinon:true, chai:true */
+/* global JSData:true, JSDataHttp:true, sinon:true, chai:true */
 before(function () {
   var Test = this
   Test.fail = function (msg) {
@@ -14,7 +14,7 @@ before(function () {
   }
   Test.sinon = sinon
   Test.JSData = JSData
-  Test.HttpAdapter = HttpAdapter
+  Test.HttpAdapter = JSDataHttp.HttpAdapter
   Test.User = new JSData.Mapper({
     name: 'user'
   })
@@ -29,7 +29,7 @@ before(function () {
 
 beforeEach(function () {
   var Test = this
-  Test.adapter = new HttpAdapter()
+  Test.adapter = new JSDataHttp.HttpAdapter()
   Test.User.registerAdapter('http', Test.adapter, { default: true })
   Test.Post.registerAdapter('http', Test.adapter, { default: true })