Convert library code to TypeScript

.jshintrc

@@ -42,7 +42,7 @@
     "PresenceMessage": true,
     "ProtocolMessage": true,
     "Stats": true,
-    "ConnectionError": true,
+    "ConnectionErrors": true,
     "MessageQueue": true,
     "Protocol": true,
     "ConnectionManager": true,

Gruntfile.js

@@ -48,7 +48,9 @@ module.exports = function (grunt) {
 		dirs: dirs,
 		pkgVersion: grunt.file.readJSON('package.json').version,
 		webpack: {
-			config: webpackConfig
+			all: Object.values(webpackConfig),
+			node: webpackConfig.node,
+			browser: [webpackConfig.browser, webpackConfig.browserMin]
 		}
 	};
 
@@ -110,7 +112,17 @@ module.exports = function (grunt) {
 
 	grunt.registerTask('build', [
 		'checkGitSubmodules',
-		'webpack'
+		'webpack:all'
+	]);
+
+	grunt.registerTask('build:node', [
+		'checkGitSubmodules',
+		'webpack:node'
+	]);
+
+	grunt.registerTask('build:browser', [
+		'checkGitSubmodules',
+		'webpack:browser'
 	]);
 
 	grunt.registerTask('check-closure-compiler', [
@@ -126,12 +138,12 @@ module.exports = function (grunt) {
 	grunt.registerTask('test', ['test:node']);
 	grunt.registerTask('test:node',
 		'Build the library and run the node test suite\nOptions\n  --test [tests] e.g. --test test/rest/auth.js',
-		['build', 'mocha']
+		['build:node', 'mocha']
 	);
 
 	grunt.registerTask('test:webserver',
 		'Launch the Mocha test web server on http://localhost:3000/',
-		['build', 'checkGitSubmodules', 'mocha:webserver']
+		['build:browser', 'checkGitSubmodules', 'mocha:webserver']
 	);
 
 	grunt.registerTask('release:refresh-pkgVersion',

ably.d.ts

@@ -130,7 +130,7 @@ declare namespace Types {
 		}, callback: (shouldRecover: boolean) => void) => void);
 
 		/**
-		 * Use a non-secure connection connection. By default, a TLS connection is used to connect to Ably
+		 * Use a non-secure connection. By default, a TLS connection is used to connect to Ably
 		 */
 		tls?: boolean;
 		tlsPort?: number;
@@ -153,6 +153,7 @@ declare namespace Types {
 		httpOpenTimeout?: number;
 		httpRequestTimeout?: number;
 
+		plugins?: { vcdiff?: any };
 	}
 
 	interface AuthOptions {
@@ -178,7 +179,7 @@ declare namespace Types {
 
 		/**
 		 * Optional clientId that can be used to specify the identity for this client. In most cases
-		 * it is preferable to instead specift a clientId in the token issued to this client.
+		 * it is preferable to instead specify a clientId in the token issued to this client.
 		 */
 		clientId?: string;
 	}
@@ -265,7 +266,7 @@ declare namespace Types {
 
 	type ChannelParams = { [key: string]: string };
 
-	type ChannelMode = 'PUBLISH' | 'SUBSCRIBE' | 'PRESENCE' | 'PRESENCE_SUBSCRIBE';
+	type ChannelMode = 'PUBLISH' | 'SUBSCRIBE' | 'PRESENCE' | 'PRESENCE_SUBSCRIBE' | 'ATTACH_RESUME';
 	type ChannelModes = Array<ChannelMode>;
 
 	interface ChannelOptions {

browser/fragments/platform-browser.js → browser/fragments/platform-browser.ts

@@ -1,4 +1,8 @@
 import msgpack from '../lib/util/msgpack';
+import { TypedArray, IPlatform } from '../../common/types/IPlatform';
+
+declare var MozWebSocket: typeof WebSocket; // For Chrome 14 and Firefox 7
+declare var msCrypto: typeof crypto; // for IE11
 
 if(typeof Window === 'undefined' && typeof WorkerGlobalScope === 'undefined') {
 	console.log("Warning: this distribution of Ably is intended for browsers. On nodejs, please use the 'ably' package on npm");
@@ -8,36 +12,37 @@ function allowComet() {
 	/* xhr requests from local files are unreliable in some browsers, such as Chrome 65 and higher -- see eg
 	 * https://stackoverflow.com/questions/49256429/chrome-65-unable-to-make-post-requests-from-local-files-to-flask
 	 * So if websockets are supported, then just forget about comet transports and use that */
-	var loc = global.location;
+	const loc = global.location;
 	return (!global.WebSocket || !loc || !loc.origin || loc.origin.indexOf("http") > -1);
 }
 
-var userAgent = global.navigator && global.navigator.userAgent.toString();
-var currentUrl = global.location && global.location.href;
+const userAgent = global.navigator && global.navigator.userAgent.toString();
+const currentUrl = global.location && global.location.href;
 
-var Platform = {
-        agent: 'browser',
+const Platform: IPlatform = {
+	agent: 'browser',
 	logTimestamps: true,
 	userAgent: userAgent,
 	currentUrl: currentUrl,
-	noUpgrade: userAgent && userAgent.match(/MSIE\s8\.0/),
+	noUpgrade: userAgent && !!userAgent.match(/MSIE\s8\.0/),
 	binaryType: 'arraybuffer',
-	WebSocket: global.WebSocket || global.MozWebSocket,
+	WebSocket: global.WebSocket || MozWebSocket,
 	xhrSupported: global.XMLHttpRequest && 'withCredentials' in new XMLHttpRequest(),
 	jsonpSupported: typeof(document) !== 'undefined',
 	allowComet: allowComet(),
 	streamingSupported: true,
 	useProtocolHeartbeats: true,
 	createHmac: null,
-	msgpack: msgpack,
+	// TODO: type this properly
+	msgpack: msgpack as unknown as typeof import('@ably/msgpack-js'),
 	supportsBinary: !!global.TextDecoder,
 	preferBinary: false,
 	ArrayBuffer: global.ArrayBuffer,
 	atob: global.atob,
-	nextTick: typeof global.setImmediate !== 'undefined' ? global.setImmediate.bind(global) : function(f) { setTimeout(f, 0); },
+	nextTick: typeof global.setImmediate !== 'undefined' ? global.setImmediate.bind(global) : function(f: () => void) { setTimeout(f, 0); },
 	addEventListener: global.addEventListener,
 	inspect: JSON.stringify,
-	stringByteSize: function(str) {
+	stringByteSize: function(str: string) {
 		/* str.length will be an underestimate for non-ascii strings. But if we're
 		 * in a browser too old to support TextDecoder, not much we can do. Better
 		 * to underestimate, so if we do go over-size, the server will reject the
@@ -53,13 +58,13 @@ var Platform = {
 		if (crypto === undefined) {
 			return undefined;
 		}
-		return function(arr, callback) {
+		return function(arr: TypedArray, callback?: (error: Error | null) => void) {
 			crypto.getRandomValues(arr);
 			if(callback) {
 				callback(null);
 			}
 		};
-	})(global.crypto || global.msCrypto) // mscrypto for IE11
+	})(global.crypto || msCrypto) 
 };
 
 export default Platform;

browser/fragments/platform-reactnative.js → browser/fragments/platform-reactnative.ts

@@ -1,27 +1,29 @@
 import msgpack from '../lib/util/msgpack';
 import { parse as parseBase64 } from 'crypto-js/build/enc-base64';
+import { IPlatform } from '../../common/types/IPlatform';
 
-var Platform = {
-        agent: 'reactnative',
+const Platform: IPlatform = {
+	agent: 'reactnative',
 	logTimestamps: true,
 	noUpgrade: false,
 	binaryType: 'arraybuffer',
 	WebSocket: WebSocket,
-	xhrSupported: XMLHttpRequest,
+	xhrSupported: true,
 	allowComet: true,
 	jsonpSupported: false,
 	streamingSupported: true,
 	useProtocolHeartbeats: true,
 	createHmac: null,
-	msgpack: msgpack,
-	supportsBinary: (typeof TextDecoder !== 'undefined') && TextDecoder,
+	// TODO: type this properly
+	msgpack: msgpack as unknown as typeof import('@ably/msgpack-js'),
+	supportsBinary: ((typeof TextDecoder !== 'undefined') && TextDecoder) ? true : false,
 	preferBinary: false,
 	ArrayBuffer: (typeof ArrayBuffer !== 'undefined') && ArrayBuffer,
 	atob: global.atob,
-	nextTick: function(f) { setTimeout(f, 0); },
+	nextTick: function(f: Function) { setTimeout(f, 0); },
 	addEventListener: null,
 	inspect: JSON.stringify,
-	stringByteSize: function(str) {
+	stringByteSize: function(str: string) {
 		/* str.length will be an underestimate for non-ascii strings. But if we're
 		 * in a browser too old to support TextDecoder, not much we can do. Better
 		 * to underestimate, so if we do go over-size, the server will reject the
@@ -34,8 +36,8 @@ var Platform = {
 	TextDecoder: global.TextDecoder,
 	Promise: global.Promise,
 	getRandomWordArray: (function(RNRandomBytes) {
-		return function(byteLength, callback) {
-			RNRandomBytes.randomBytes(byteLength, function(err, base64String) {
+		return function(byteLength: number, callback: Function) {
+			RNRandomBytes.randomBytes(byteLength, function(err: Error, base64String: string) {
 				callback(err, !err && parseBase64(base64String));
 			});
 		};

browser/lib/transport/jsonptransport.js

@@ -1,11 +1,13 @@
-import Utils from '../../../common/lib/util/utils';
+import * as Utils from '../../../common/lib/util/utils';
 import CometTransport from '../../../common/lib/transport/comettransport';
 import Platform from 'platform';
 import EventEmitter from '../../../common/lib/util/eventemitter';
 import Http from 'platform-http';
 import ErrorInfo from '../../../common/lib/types/errorinfo';
 import Defaults from '../../../common/lib/util/defaults';
 import Logger from '../../../common/lib/util/logger';
+import HttpStatusCodes from '../../../common/constants/HttpStatusCodes';
+import XHRStates from '../../../common/constants/XHRStates';
 
 var JSONPTransport = function(connectionManager) {
 	var noop = function() {};
@@ -128,7 +130,7 @@ var JSONPTransport = function(connectionManager) {
 			if(message.statusCode) {
 				/* Handle as enveloped jsonp, as all jsonp transport uses should be */
 				var response = message.response;
-				if(message.statusCode == 204) {
+				if(message.statusCode == HttpStatusCodes.NoContent) {
 					self.complete(null, null, null, message.statusCode);
 				} else if(!response) {
 					self.complete(new ErrorInfo('Invalid server response: no envelope detected', null, 500));
@@ -148,7 +150,7 @@ var JSONPTransport = function(connectionManager) {
 			}
 		};
 
-		var timeout = (this.requestMode == CometTransport.REQ_SEND) ? this.timeouts.httpRequestTimeout : this.timeouts.recvTimeout;
+		var timeout = (this.requestMode == XHRStates.REQ_SEND) ? this.timeouts.httpRequestTimeout : this.timeouts.recvTimeout;
 		this.timer = setTimeout(function() { self.abort(); }, timeout);
 		head.insertBefore(script, head.firstChild);
 	};
@@ -187,7 +189,7 @@ var JSONPTransport = function(connectionManager) {
 
 	if(Platform.jsonpSupported && !Http.Request) {
 		Http.Request = function(method, rest, uri, headers, params, body, callback) {
-			var req = createRequest(uri, headers, params, body, CometTransport.REQ_SEND, rest && rest.options.timeouts, method);
+			var req = createRequest(uri, headers, params, body, XHRStates.REQ_SEND, rest && rest.options.timeouts, method);
 			req.once('complete', callback);
 			Utils.nextTick(function() {
 				req.exec();
@@ -205,7 +207,7 @@ var JSONPTransport = function(connectionManager) {
 			checksInProgress = [callback];
 			Logger.logAction(Logger.LOG_MICRO, '(JSONP)Http.checkConnectivity()', 'Sending; ' + upUrl);
 
-			var req = new Request('isTheInternetUp', upUrl, null, null, null, CometTransport.REQ_SEND, Defaults.TIMEOUTS);
+			var req = new Request('isTheInternetUp', upUrl, null, null, null, XHRStates.REQ_SEND, Defaults.TIMEOUTS);
 			req.once('complete', function(err, response) {
 				var result = !err && response;
 				Logger.logAction(Logger.LOG_MICRO, '(JSONP)Http.checkConnectivity()', 'Result: ' + result);

browser/lib/transport/xhrpollingtransport.js

@@ -1,4 +1,4 @@
-import Utils from '../../../common/lib/util/utils';
+import * as Utils from '../../../common/lib/util/utils';
 import Logger from '../../../common/lib/util/logger';
 import Platform from 'platform';
 import CometTransport from '../../../common/lib/transport/comettransport';