v0.7.4-rc.1

Otherwise linting will fail if you try to run it

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

.eslintrc.js

@@ -0,0 +1,59 @@
+module.exports = {
+    parserOptions: {
+        ecmaVersion: 6,
+        sourceType: "module",
+        ecmaFeatures: {
+        }
+    },
+    env: {
+        browser: true,
+        node: true,
+    },
+    extends: ["eslint:recommended", "google"],
+    rules: {
+        // rules we've always adhered to
+        "max-len": ["error", {
+            code: 90,
+            ignoreComments: true,
+        }],
+        curly: ["error", "multi-line"],
+
+        // loosen jsdoc requirements a little
+        "require-jsdoc": ["error", {
+            require: {
+                FunctionDeclaration: false,
+            }
+        }],
+        "valid-jsdoc": ["error", {
+            requireParamDescription: false,
+            requireReturn: false,
+            requireReturnDescription: false,
+        }],
+
+        // rules we do not want from eslint-recommended
+        "no-console": ["off"],
+        "no-constant-condition": ["off"],
+        "no-empty": ["error", { "allowEmptyCatch": true }],
+
+        // rules we do not want from the google styleguide
+        "object-curly-spacing": ["off"],
+        "spaced-comment": ["off"],
+
+        // in principle we prefer single quotes, but life is too short
+        quotes: ["off"],
+
+        // rules we'd ideally like to adhere to, but the current
+        // code does not (in most cases because it's still ES5)
+        // we set these to warnings, and assert that the number
+        // of warnings doesn't exceed a given threshold
+        "no-var": ["warn"],
+        "comma-dangle": ["warn"],
+        "brace-style": ["warn"],
+        "prefer-rest-params": ["warn"],
+        "prefer-spread": ["warn"],
+        "one-var": ["warn"],
+        "padded-blocks": ["warn"],
+        "no-extend-native": ["warn"],
+        "camelcase": ["warn"],
+    }
+}

.gitignore

@@ -7,6 +7,7 @@ lib-cov
 out
 reports
 /dist
+/lib
 
 # version file and tarball created by 'npm pack'
 /git-revision.txt

.jshint

@@ -1,11 +0,0 @@
-{
-    "node": true,
-    "jasmine": true,
-
-    "nonew": true,
-    "curly": true,
-    "forin": true,
-    "freeze": false,
-    "undef": true,
-    "unused": "vars"
-}

CHANGELOG.md

@@ -1,3 +1,31 @@
+Changes in [0.7.4-rc.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.4-rc.1) (2017-01-13)
+==========================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.3...v0.7.4-rc.1)
+
+ * Remove babel-polyfill
+   [\#321](https://github.com/matrix-org/matrix-js-sdk/pull/321)
+ * Update build process for ES6
+   [\#320](https://github.com/matrix-org/matrix-js-sdk/pull/320)
+ * 'babel' is not a babel package anymore
+   [\#319](https://github.com/matrix-org/matrix-js-sdk/pull/319)
+ * Add Babel for ES6 support
+   [\#318](https://github.com/matrix-org/matrix-js-sdk/pull/318)
+ * Move screen sharing check/error
+   [\#317](https://github.com/matrix-org/matrix-js-sdk/pull/317)
+ * release.sh: Bail early if there are uncommitted changes
+   [\#316](https://github.com/matrix-org/matrix-js-sdk/pull/316)
+
+Changes in [0.7.3](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.3) (2017-01-04)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.2...v0.7.3)
+
+ * User presence list feature
+   [\#310](https://github.com/matrix-org/matrix-js-sdk/pull/310)
+ * Allow clients the ability to set a default local timeout
+   [\#313](https://github.com/matrix-org/matrix-js-sdk/pull/313)
+ * Add API to delete threepid
+   [\#312](https://github.com/matrix-org/matrix-js-sdk/pull/312)
+
 Changes in [0.7.2](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.2) (2016-12-15)
 ================================================================================================
 [Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.1...v0.7.2)

RELEASING.md

@@ -1,14 +0,0 @@
-There is a script `release.sh` which does the following, but if you need to do
-a release manually, here are the steps:
-
-- `git checkout -b release-v0.x.x`
-- Update `CHANGELOG.md`
-- `npm version 0.x.x`
-- Merge `release-v0.x.x` onto `master`.
-- Push `master`.
-- Push the tag: `git push --tags`
-- `npm publish`
-- Generate documentation: `npm run gendoc` (this outputs HTML to `.jsdoc`)
-- Copy the documentation from `.jsdoc` to the `gh-pages` branch and update `index.html`
-- Merge `master` onto `develop`.
-- Push `develop`.

jenkins.sh

@@ -2,7 +2,7 @@
 
 export NVM_DIR="/home/jenkins/.nvm"
 [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
-nvm use 0.10
+nvm use 4
 npm install
 
 RC=0
@@ -14,13 +14,8 @@ function fail {
 
 npm test || fail "npm test finished with return code $?"
 
-jshint --reporter=checkstyle -c .jshint lib spec > jshint.xml ||
-    fail "jshint finished with return code $?"
-
-gjslint --unix_mode --disable 0131,0211,0200,0222,0212 \
-        --max_line_length 90 \
-        -r lib/ -r spec/ > gjslint.log ||
-    fail "gjslint finished with return code $?"
+npm run -s lint -- -f checkstyle > eslint.xml ||
+    fail "eslint finished with return code $?"
 
 # delete the old tarball, if it exists
 rm -f matrix-js-sdk-*.tgz

package.json

@@ -1,17 +1,18 @@
 {
   "name": "matrix-js-sdk",
-  "version": "0.7.2",
+  "version": "0.7.4-rc.1",
   "description": "Matrix Client-Server SDK for Javascript",
   "main": "index.js",
   "scripts": {
     "test": "istanbul cover --report cobertura --config .istanbul.yml -i \"lib/**/*.js\" jasmine-node -- spec --verbose --junitreport --captureExceptions",
     "check": "jasmine-node spec --verbose --junitreport --captureExceptions",
     "gendoc": "jsdoc -r lib -P package.json -R README.md -d .jsdoc",
-    "build": "jshint -c .jshint lib/ && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
+    "start": "babel -s -w -d lib src",
+    "build": "babel -s -d lib src && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
     "dist": "npm run build",
     "watch": "watchify --exclude olm browser-index.js -o dist/browser-matrix-dev.js -v",
-    "lint": "jshint -c .jshint lib spec && gjslint --unix_mode --disable 0131,0211,0200,0222,0212 --max_line_length 90 -r spec/ -r lib/",
-    "prepublish": "git rev-parse HEAD > git-revision.txt"
+    "lint": "eslint --max-warnings 3480 src spec",
+    "prepublish": "npm run lint && npm run build && git rev-parse HEAD > git-revision.txt"
   },
   "repository": {
     "url": "https://github.com/matrix-org/matrix-js-sdk"
@@ -23,6 +24,8 @@
   "author": "matrix.org",
   "license": "Apache-2.0",
   "files": [
+    ".eslintrc.js",
+    "spec/.eslintrc.js",
     "CHANGELOG.md",
     "CONTRIBUTING.rst",
     "LICENSE",
@@ -37,7 +40,8 @@
     "lib",
     "package.json",
     "release.sh",
-    "spec"
+    "spec",
+    "src"
   ],
   "dependencies": {
     "another-json": "^0.2.0",
@@ -47,15 +51,18 @@
     "request": "^2.53.0"
   },
   "devDependencies": {
+    "babel-cli": "^6.18.0",
+    "babel-preset-es2015": "^6.18.0",
+    "eslint": "^3.13.1",
+    "eslint-config-google": "^0.7.1",
     "istanbul": "^0.3.13",
     "jasmine-node": "^1.14.5",
     "jsdoc": "^3.4.0",
-    "jshint": "^2.8.0",
     "rimraf": "^2.5.4",
     "uglifyjs": "^2.4.10",
     "watchify": "^3.2.1"
   },
   "optionalDependencies": {
-    "olm": "https://matrix.org/packages/npm/olm/olm-2.0.0.tgz"
+    "olm": "https://matrix.org/packages/npm/olm/olm-2.1.0.tgz"
   }
 }

release.sh

@@ -1,12 +1,12 @@
 #!/bin/bash
 #
-# Script to perform a release of matrix-js-sdk. Performs the steps documented
-# in RELEASING.md
+# Script to perform a release of matrix-js-sdk.
 #
 # Requires:
-#   github-changelog-generator; to install, do
+#   github-changelog-generator; install via:
 #     pip install git+https://github.com/matrix-org/github-changelog-generator.git
-#   jq; install from your distibution's package manager (https://stedolan.github.io/jq/)
+#   jq; install from your distribution's package manager (https://stedolan.github.io/jq/)
+#   hub; install via brew (OSX) or source/pre-compiled binaries (debian) (https://github.com/github/hub) - Tested on v2.2.9
 
 set -e
 
@@ -32,6 +32,16 @@ if [ "$ret" -eq 0 ]; then
     exit
 fi
 
+if ! git diff-index --quiet --cached HEAD; then
+    echo "this git checkout has staged (uncommitted) changes. Refusing to release."
+    exit
+fi
+
+if ! git diff-files --quiet; then
+    echo "this git checkout has uncommitted changes. Refusing to release."
+    exit
+fi
+
 skip_changelog=
 skip_jsdoc=
 changelog_file="CHANGELOG.md"
@@ -63,8 +73,6 @@ if [ -z "$skip_changelog" ]; then
     # update_changelog doesn't have a --version flag
     update_changelog -h > /dev/null || (echo "github-changelog-generator is required: please install it"; exit)
 fi
-latest_changes=`mktemp`
-cat "${changelog_file}" | `dirname $0`/scripts/changelog_head.py > "${latest_changes}"
 
 # ignore leading v on release
 release="${1#v}"
@@ -113,6 +121,8 @@ if [ -z "$skip_changelog" ]; then
         git commit "$changelog_file" -m "Prepare changelog for $tag"
     fi
 fi
+latest_changes=`mktemp`
+cat "${changelog_file}" | `dirname $0`/scripts/changelog_head.py > "${latest_changes}"
 
 set -x
 

spec/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+    env: {
+        jasmine: true,
+    },
+}

spec/integ/matrix-client-crypto.spec.js

@@ -463,7 +463,7 @@ describe("MatrixClient crypto", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         aliStorage = new sdk.WebStorageSessionStore(new test_utils.MockStorageApi());
         aliHttpBackend = new HttpBackend();

spec/integ/matrix-client-event-emitter.spec.js

@@ -10,7 +10,7 @@ describe("MatrixClient events", function() {
     var selfAccessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-event-timeline.spec.js

@@ -100,7 +100,7 @@ describe("getEventTimeline support", function() {
     var client;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
     });
@@ -221,7 +221,7 @@ describe("MatrixClient event timelines", function() {
     var client, httpBackend;
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
 
@@ -415,7 +415,7 @@ describe("MatrixClient event timelines", function() {
                     };
                 });
 
-            var tl0, tl2, tl3;
+            var tl0, tl3;
             client.getEventTimeline(timelineSet, EVENTS[0].event_id
             ).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
@@ -423,7 +423,6 @@ describe("MatrixClient event timelines", function() {
                 return client.getEventTimeline(timelineSet, EVENTS[2].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
-                tl2 = tl;
                 return client.getEventTimeline(timelineSet, EVENTS[3].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);

spec/integ/matrix-client-methods.spec.js

@@ -15,7 +15,7 @@ describe("MatrixClient", function() {
     var accessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         store = new MatrixInMemoryStore();
 
@@ -363,7 +363,7 @@ describe("MatrixClient", function() {
 
                 assertObjectContains(res.chaz.dev2, {
                     verified: 0, // DeviceVerification.UNVERIFIED
-                    keys: { "ed25519:dev2" : ed25519key },
+                    keys: { "ed25519:dev2": ed25519key },
                     algorithms: ["2"],
                     unsigned: { "ghi": "def" },
                 });

spec/integ/matrix-client-opts.spec.js

@@ -53,7 +53,7 @@ describe("MatrixClient opts", function() {
     };
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
     });
 

spec/integ/matrix-client-retrying.spec.js

@@ -14,7 +14,7 @@ describe("MatrixClient retrying", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         scheduler = new sdk.MatrixScheduler();

spec/integ/matrix-client-room-timeline.spec.js

@@ -101,7 +101,7 @@ describe("MatrixClient room timelines", function() {
     }
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-syncing.spec.js

@@ -18,7 +18,7 @@ describe("MatrixClient syncing", function() {
     var roomTwo = "!bar:localhost";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/megolm.spec.js

@@ -61,7 +61,7 @@ function TestClient(userId, deviceId, accessToken) {
 /**
  * start the client, and wait for it to initialise.
  *
- * @param {object?} deviceQueryResponse  the list of our existing devices to return from
+ * @param {object?} existingDevices  the list of our existing devices to return from
  *    the /query request. Defaults to empty device list
  * @return {Promise}
  */
@@ -313,6 +313,9 @@ describe("megolm", function() {
     /**
      * Get the device keys for testOlmAccount in a format suitable for a
      * response to /keys/query
+     *
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake query response
      */
     function getTestKeysQueryResponse(userId) {
         var testE2eKeys = JSON.parse(testOlmAccount.identity_keys());
@@ -346,6 +349,9 @@ describe("megolm", function() {
     /**
      * Get a one-time key for testOlmAccount in a format suitable for a
      * response to /keys/claim
+
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake key claim response
      */
     function getTestKeysClaimResponse(userId) {
         testOlmAccount.generate_one_time_keys(1);
@@ -374,7 +380,7 @@ describe("megolm", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         aliceTestClient = new TestClient(
             "@alice:localhost", "xzcvb", "akjgkrgjs"

spec/test-utils.js

@@ -28,7 +28,7 @@ module.exports.mock = function(constr, name) {
     result.jasmineToString = function() {
         return "mock" + (name ? " of " + name : "");
     };
-    for (var key in constr.prototype) { // jshint ignore:line
+    for (var key in constr.prototype) { // eslint-disable-line guard-for-in
         try {
             if (constr.prototype[key] instanceof Function) {
                 result[key] = jasmine.createSpy((name || "mock") + '.' + key);

spec/unit/content-repo.spec.js

@@ -6,7 +6,7 @@ describe("ContentRepo", function() {
     var baseUrl = "https://my.home.server";
 
     beforeEach(function() {
-        testUtils.beforeEach(this);
+        testUtils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("getHttpUriForMxc", function() {

spec/unit/crypto.spec.js

@@ -9,6 +9,6 @@ describe("Crypto", function() {
     }
 
     it("Crypto exposes the correct olm library version", function() {
-        expect(Crypto.getOlmVersion()).toEqual([2, 0, 0]);
+        expect(Crypto.getOlmVersion()[0]).toEqual(2);
     });
 });

spec/unit/event-timeline.spec.js

@@ -15,7 +15,7 @@ describe("EventTimeline", function() {
     var timeline;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         // XXX: this is a horrid hack; should use sinon or something instead to mock
         var timelineSet = { room: { roomId: roomId }};

spec/unit/filter.spec.js

@@ -9,7 +9,7 @@ describe("Filter", function() {
     var filter;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         filter = new Filter(userId);
     });
 

spec/unit/interactive-auth.spec.js

@@ -24,7 +24,7 @@ var MatrixError = sdk.MatrixError;
 
 describe("InteractiveAuth", function() {
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     it("should start an auth stage and complete it", function(done) {

spec/unit/matrix-client.spec.js

@@ -117,7 +117,7 @@ describe("MatrixClient", function() {
     }
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = jasmine.createSpyObj("scheduler", [
             "getQueueForEvent", "queueEvent", "removeEventFromQueue",

spec/unit/realtime-callbacks.spec.js

@@ -14,7 +14,7 @@ describe("realtime-callbacks", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
         clock.useMock();
         fakeDate = Date.now();
         callbacks.setNow(function() { return fakeDate; });
@@ -54,8 +54,8 @@ describe("realtime-callbacks", function() {
         it("should set 'this' to the global object", function() {
             var callback = jasmine.createSpy();
             callback.andCallFake(function() {
-                expect(this).toBe(global);
-                expect(this.console).toBeDefined();
+                expect(this).toBe(global); // eslint-disable-line no-invalid-this
+                expect(this.console).toBeDefined(); // eslint-disable-line no-invalid-this
             });
             callbacks.setTimeout(callback);
             tick(0);

spec/unit/room-member.spec.js

@@ -11,7 +11,7 @@ describe("RoomMember", function() {
     var member;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         member = new RoomMember(roomId, userA);
     });
 

spec/unit/room-state.spec.js

@@ -11,7 +11,7 @@ describe("RoomState", function() {
     var state;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         state = new RoomState(roomId);
         state.setStateEvents([
             utils.mkMembership({  // userA joined

spec/unit/room.spec.js

@@ -16,7 +16,7 @@ describe("Room", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         room = new Room(roomId);
         // mock RoomStates
         room.oldState = room.getLiveTimeline()._startState =
@@ -1110,7 +1110,7 @@ describe("Room", function() {
     describe("tags", function() {
 
         function mkTags(roomId, tags) {
-            var content = { "tags" : tags };
+            var content = { "tags": tags };
             return new MatrixEvent({
                 content: content,
                 room_id: roomId,

spec/unit/scheduler.spec.js

@@ -1,4 +1,6 @@
-"use strict";
+// This file had a function whose name is all caps, which displeases eslint
+/* eslint new-cap: "off" */
+
 var q = require("q");
 var sdk = require("../..");
 var MatrixScheduler = sdk.MatrixScheduler;
@@ -18,7 +20,7 @@ describe("MatrixScheduler", function() {
     });
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = new MatrixScheduler(function(ev, attempts, err) {
             if (retryFn) {

spec/unit/timeline-window.spec.js

@@ -60,7 +60,7 @@ function createLinkedTimelines() {
 
 describe("TimelineIndex", function() {
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("minIndex", function() {
@@ -153,7 +153,7 @@ describe("TimelineWindow", function() {
     }
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("load", function() {

spec/unit/user.spec.js

@@ -8,7 +8,7 @@ describe("User", function() {
     var user;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         user = new User(userId);
     });
 

spec/unit/utils.spec.js

@@ -4,7 +4,7 @@ var testUtils = require("../test-utils");
 
 describe("utils", function() {
     beforeEach(function() {
-        testUtils.beforeEach(this);
+        testUtils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("encodeParams", function() {

spec/unit/webstorage.spec.js

@@ -33,7 +33,7 @@ describe("WebStorageStore", function() {
     );
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         mockStorageApi = new MockStorageApi();
         store = new WebStorageStore(mockStorageApi, batchNum);
         room = new Room(roomId);

src/base-apis.js

@@ -45,6 +45,10 @@ var utils = require("./utils");
  *
  * @param {string} opts.accessToken The access_token for this user.
  *
+ * @param {Number=} opts.localTimeoutMs Optional. The default maximum amount of
+ * time to wait before timing out HTTP requests. If not specified, there is no
+ * timeout.
+ *
  * @param {Object} opts.queryParams Optional. Extra query parameters to append
  * to all requests with this client. Useful for application services which require
  * <code>?user_id=</code>.
@@ -63,7 +67,8 @@ function MatrixBaseApis(opts) {
         request: opts.request,
         prefix: httpApi.PREFIX_R0,
         onlyData: true,
-        extraParams: opts.queryParams
+        extraParams: opts.queryParams,
+        localTimeoutMs: opts.localTimeoutMs
     };
     this._http = new httpApi.MatrixHttpApi(this, httpOpts);
 
@@ -434,6 +439,7 @@ MatrixBaseApis.prototype.roomInitialSync = function(roomId, limit, callback) {
 // =========================
 
 /**
+ * @param {Object} options Options for this request
  * @param {string} options.server The remote server to query for the room list.
  *                                Optional. If unspecified, get the local home
  *                                server's public room list.
@@ -712,6 +718,25 @@ MatrixBaseApis.prototype.addThreePid = function(creds, bind, callback) {
     );
 };
 
+/**
+ * @param {string} medium The threepid medium (eg. 'email')
+ * @param {string} address The threepid address (eg. 'bob@example.com')
+ *        this must be as returned by getThreePids.
+ * @return {module:client.Promise} Resolves: The server response on success
+ *     (generally the empty JSON object)
+ * @return {module:http-api.MatrixError} Rejects: with an error response.
+ */
+MatrixBaseApis.prototype.deleteThreePid = function(medium, address) {
+    var path = "/account/3pid/delete";
+    var data = {
+        'medium': medium,
+        'address': address
+    };
+    return this._http.authedRequestWithPrefix(
+        undefined, "POST", path, null, data, httpApi.PREFIX_UNSTABLE
+    );
+};
+
 /**
  * Make a request to change your password.
  * @param {Object} authDict
@@ -998,7 +1023,7 @@ MatrixBaseApis.prototype.downloadKeysForUsers = function(userIds, callback) {
 /**
  * Claim one-time keys
  *
- * @param {string[][]} devices  a list of [userId, deviceId] pairs
+ * @param {string[]} devices  a list of [userId, deviceId] pairs
  *
  * @param {string} [key_algorithm = signed_curve25519]  desired key type
  *

src/client.js

@@ -94,6 +94,9 @@ try {
  * to all requests with this client. Useful for application services which require
  * <code>?user_id=</code>.
  *
+ * @param {Number=} opts.localTimeoutMs Optional. The default maximum amount of
+ * time to wait before timing out HTTP requests. If not specified, there is no timeout.
+ *
  * @param {boolean} [opts.timelineSupport = false] Set to true to enable
  * improved timeline support ({@link
  * module:client~MatrixClient#getEventTimeline getEventTimeline}). It is
@@ -354,8 +357,6 @@ MatrixClient.prototype.getStoredDevicesForUser = function(userId) {
     return this._crypto.getStoredDevicesForUser(userId) || [];
 };
 
-
-
 /**
  * Mark the given device as verified
  *
@@ -374,7 +375,6 @@ MatrixClient.prototype.setDeviceVerified = function(userId, deviceId, verified)
     _setDeviceVerification(this, userId, deviceId, verified, null);
 };
 
-
 /**
  * Mark the given device as blocked/unblocked
  *
@@ -539,7 +539,7 @@ MatrixClient.prototype.getUsers = function() {
 /**
  * Set account data event for the current user.
  * @param {string} eventType The event type
- * @param {Object} content the contents object for the event
+ * @param {Object} contents the contents object for the event
  * @param {module:client.callback} callback Optional.
  * @return {module:client.Promise} Resolves: TODO
  * @return {module:http-api.MatrixError} Rejects: with an error response.
@@ -1472,6 +1472,47 @@ MatrixClient.prototype.setPresence = function(opts, callback) {
     );
 };
 
+function _presenceList(callback, client, opts, method) {
+  var path = utils.encodeUri("/presence/list/$userId", {
+      $userId: client.credentials.userId
+  });
+  return client._http.authedRequest(callback, method, path, undefined, opts);
+}
+
+/**
+* Retrieve current user presence list.
+* @param {module:client.callback} callback Optional.
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+*/
+MatrixClient.prototype.getPresenceList = function(callback) {
+  return _presenceList(callback, this, undefined, "GET");
+};
+
+/**
+* Add users to the current user presence list.
+* @param {module:client.callback} callback Optional.
+* @param {string[]} userIds
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+*/
+MatrixClient.prototype.inviteToPresenceList = function(callback, userIds) {
+  var opts = {"invite": userIds};
+  return _presenceList(callback, this, opts, "POST");
+};
+
+/**
+* Drop users from the current user presence list.
+* @param {module:client.callback} callback Optional.
+* @param {string[]} userIds
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+**/
+MatrixClient.prototype.dropFromPresenceList = function(callback, userIds) {
+  var opts = {"drop": userIds};
+  return _presenceList(callback, this, opts, "POST");
+};
+
 /**
  * Retrieve older messages from the given room and put them in the timeline.
  *

src/crypto/OlmDevice.js

@@ -467,7 +467,6 @@ OlmDevice.prototype.matchesSession = function(
 };
 
 
-
 // Outbound group session
 // ======================
 

src/crypto/algorithms/base.js

@@ -130,7 +130,7 @@ module.exports.DecryptionAlgorithm = DecryptionAlgorithm;
  *
  * @method module:crypto/algorithms/base.DecryptionAlgorithm#onRoomKeyEvent
  *
- * @param {module:models/event.MatrixEvent} event key event
+ * @param {module:models/event.MatrixEvent} params event key event
  */
 DecryptionAlgorithm.prototype.onRoomKeyEvent = function(params) {
     // ignore by default

src/crypto/algorithms/megolm.js

@@ -150,7 +150,7 @@ utils.inherits(MegolmEncryption, base.EncryptionAlgorithm);
 /**
  * @private
  *
- * @param {module:models/room} room
+ * @param {Object} devicesInRoom The devices in this room, indexed by user ID
  *
  * @return {module:client.Promise} Promise which resolves to the
  *    OutboundSessionInfo when setup is complete.
@@ -378,7 +378,7 @@ MegolmEncryption.prototype._shareKeyWithDevices = function(session, devicesByUse
  *
  * @param {module:models/room} room
  * @param {string} eventType
- * @param {object} plaintext event content
+ * @param {object} content plaintext event content
  *
  * @return {module:client.Promise} Promise which resolves to the new event body
  */
@@ -475,9 +475,6 @@ utils.inherits(MegolmDecryption, base.DecryptionAlgorithm);
  *
  * @param {MatrixEvent} event
  *
- * @return {null} The event referred to an unknown megolm session
- * @return {module:crypto.DecryptionResult} decryption result
- *
  * @throws {module:crypto/algorithms/base.DecryptionError} if there is a
  *   problem decrypting the event
  */

src/crypto/algorithms/olm.js

@@ -79,7 +79,7 @@ OlmEncryption.prototype._ensureSession = function(roomMembers) {
  *
  * @param {module:models/room} room
  * @param {string} eventType
- * @param {object} plaintext event content
+ * @param {object} content plaintext event content
  *
  * @return {module:client.Promise} Promise which resolves to the new event body
  */

src/crypto/index.js

@@ -348,7 +348,7 @@ Crypto.prototype._getDevicesFromStore = function(userIds) {
 /**
  * @param {string[]} downloadUsers list of userIds
  *
- * @return {Object a map from userId to a promise for a result for that user
+ * @return {Object} a map from userId to a promise for a result for that user
  */
 Crypto.prototype._doKeyDownloadForUsers = function(downloadUsers) {
     var self = this;
@@ -546,7 +546,7 @@ function _storeDeviceKeys(_olmDevice, userStore, deviceResult) {
  *
  * @param {string} userId the user to list keys for.
  *
- * @return {module:crypto/deviceinfo[]?} list of devices, or null if we haven't
+ * @return {module:crypto/deviceinfo[]|null} list of devices, or null if we haven't
  * managed to get a list of devices for this user yet.
  */
 Crypto.prototype.getStoredDevicesForUser = function(userId) {

src/filter-component.js

@@ -44,7 +44,7 @@ function _matches_wildcard(actual_value, filter_value) {
  * 'Filters' are referred to as 'FilterCollections'.
  *
  * @constructor
- * @param {Object} the definition of this filter JSON, e.g. { 'contains_url': true }
+ * @param {Object} filter_json the definition of this filter JSON, e.g. { 'contains_url': true }
  */
 function FilterComponent(filter_json) {
     this.filter_json = filter_json;

src/http-api.js

@@ -70,8 +70,10 @@ module.exports.PREFIX_MEDIA_R0 = "/_matrix/media/r0";
  *
  * @param {string} opts.accessToken The access_token to send with requests. Can be
  * null to not send an access token.
- * @param {Object} opts.extraParams Optional. Extra query parameters to send on
+ * @param {Object=} opts.extraParams Optional. Extra query parameters to send on
  * requests.
+ * @param {Number=} opts.localTimeoutMs The default maximum amount of time to wait
+ * before timing out the request. If not specified, there is no timeout.
  */
 module.exports.MatrixHttpApi = function MatrixHttpApi(event_emitter, opts) {
     utils.checkObjectHasKeys(opts, ["baseUrl", "request", "prefix"]);
@@ -594,7 +596,7 @@ module.exports.MatrixHttpApi.prototype = {
      * @param {object=} opts.headers  extra request headers
      *
      * @param {number=} opts.localTimeoutMs client-side timeout for the
-     *    request. No timeout if undefined.
+     *    request. Default timeout if falsy.
      *
      * @param {function=} opts.bodyParser function to parse the body of the
      *    response before passing it to the promise and callback.
@@ -626,7 +628,7 @@ module.exports.MatrixHttpApi.prototype = {
         var timeoutId;
         var timedOut = false;
         var req;
-        var localTimeoutMs = opts.localTimeoutMs;
+        var localTimeoutMs = opts.localTimeoutMs || this.opts.localTimeoutMs;
         if (localTimeoutMs) {
             timeoutId = callbacks.setTimeout(function() {
                 timedOut = true;

src/interactive-auth.js

@@ -89,8 +89,8 @@ InteractiveAuth.prototype = {
     /**
      * get the server params for a given stage
      *
-     * @param {string}  login type for the stage
-     * @return {object?}  any parameters from the server for this stage
+     * @param {string} loginType login type for the stage
+     * @return {object?} any parameters from the server for this stage
      */
     getStageParams: function(loginType) {
         var params = {};

src/models/event-timeline-set.js

@@ -24,11 +24,12 @@ var EventTimeline = require("./event-timeline");
 // var DEBUG = false;
 var DEBUG = true;
 
+var debuglog;
 if (DEBUG) {
     // using bind means that we get to keep useful line numbers in the console
-    var debuglog = console.log.bind(console);
+    debuglog = console.log.bind(console);
 } else {
-    var debuglog = function() {};
+    debuglog = function() {};
 }
 
 /**

src/models/event.js

@@ -78,6 +78,8 @@ module.exports.MatrixEvent = function MatrixEvent(
     this.status = null;
     this.forwardLooking = true;
     this._pushActions = null;
+    this._date = this.event.origin_server_ts ?
+        new Date(this.event.origin_server_ts) : null;
 
     this._clearEvent = {};
     this._keysProved = {};
@@ -142,6 +144,14 @@ utils.extend(module.exports.MatrixEvent.prototype, {
         return this.event.origin_server_ts;
     },
 
+    /**
+     * Get the timestamp of this event, as a Date object.
+     * @return {Date} The event date, e.g. <code>new Date(1433502692297)</code>
+     */
+    getDate: function() {
+        return this._date;
+    },
+
     /**
      * Get the (decrypted, if necessary) event content JSON.
      *
@@ -374,6 +384,17 @@ utils.extend(module.exports.MatrixEvent.prototype, {
      setPushActions: function(pushActions) {
         this._pushActions = pushActions;
      },
+
+     /**
+      * Replace the `event` property and recalculate any properties based on it.
+      * @param {Object} event the object to assign to the `event` property
+      */
+     handleRemoteEcho: function(event) {
+        this.event = event;
+        // successfully sent.
+        this.status = null;
+        this._date = new Date(this.event.origin_server_ts);
+     }
 });
 
 
@@ -417,8 +438,6 @@ var _REDACT_KEEP_CONTENT_MAP = {
 };
 
 
-
-
 /**
  * Fires when an event is decrypted
  *

src/models/room-state.js

@@ -253,7 +253,7 @@ RoomState.prototype.maySendMessage = function(userId) {
 /**
  * Returns true if the given user ID has permission to send a normal
  * event of type `eventType` into this room.
- * @param {string} type The type of event to test
+ * @param {string} eventType The type of event to test
  * @param {string} userId The user ID of the user to test permission for
  * @return {boolean} true if the given user ID should be permitted to send
  *                        the given type of event into this room,
@@ -267,8 +267,8 @@ RoomState.prototype.maySendEvent = function(eventType, userId) {
 /**
  * Returns true if the given MatrixClient has permission to send a state
  * event of type `stateEventType` into this room.
- * @param {string} type The type of state events to test
- * @param {MatrixClient}  The client to test permission for
+ * @param {string} stateEventType The type of state events to test
+ * @param {MatrixClient} cli The client to test permission for
  * @return {boolean} true if the given client should be permitted to send
  *                        the given type of state event into this room,
  *                        according to the room's state.
@@ -283,7 +283,7 @@ RoomState.prototype.mayClientSendStateEvent = function(stateEventType, cli) {
 /**
  * Returns true if the given user ID has permission to send a state
  * event of type `stateEventType` into this room.
- * @param {string} type The type of state events to test
+ * @param {string} stateEventType The type of state events to test
  * @param {string} userId The user ID of the user to test permission for
  * @return {boolean} true if the given user ID should be permitted to send
  *                        the given type of state event into this room,
@@ -296,7 +296,7 @@ RoomState.prototype.maySendStateEvent = function(stateEventType, userId) {
 /**
  * Returns true if the given user ID has permission to send a normal or state
  * event of type `eventType` into this room.
- * @param {string} type The type of event to test
+ * @param {string} eventType The type of event to test
  * @param {string} userId The user ID of the user to test permission for
  * @param {boolean} state If true, tests if the user may send a state
                           event of this type. Otherwise tests whether
@@ -314,18 +314,12 @@ RoomState.prototype._maySendEventOfType = function(eventType, userId, state) {
     var power_levels;
     var events_levels = {};
 
-    var default_user_level = 0;
-    var user_levels = [];
-
     var state_default = 0;
     var events_default = 0;
     if (power_levels_event) {
         power_levels = power_levels_event.getContent();
         events_levels = power_levels.events || {};
 
-        default_user_level = parseInt(power_levels.users_default || 0);
-        user_levels = power_levels.users || {};
-
         if (power_levels.state_default !== undefined) {
             state_default = power_levels.state_default;
         } else {

src/models/room.js

@@ -674,10 +674,7 @@ Room.prototype._handleRemoteEcho = function(remoteEvent, localEvent) {
 
     // replace the event source (this will preserve the plaintext payload if
     // any, which is good, because we don't want to try decoding it again).
-    localEvent.event = remoteEvent.event;
-
-    // successfully sent.
-    localEvent.status = null;
+    localEvent.handleRemoteEcho(remoteEvent.event);
 
     for (var i = 0; i < this._timelineSets.length; i++) {
         var timelineSet = this._timelineSets[i];
@@ -909,8 +906,6 @@ Room.prototype.recalculate = function(userId) {
         });
     }
 
-
-
     var oldName = this.name;
     this.name = calculateRoomName(this, userId);
     this.summary = new RoomSummary(this.roomId, {

src/store/session/webstorage.js

@@ -92,7 +92,7 @@ WebStorageSessionStore.prototype = {
      * @param {string} userId The user's ID.
      * @return {object} A map from device ID to keys for the device.
      */
-    getEndToEndDevicesForUser: function(userId)  {
+    getEndToEndDevicesForUser: function(userId) {
         return getJsonItem(this.store, keyEndToEndDevicesForUser(userId));
     },
 

src/sync.js

@@ -1016,7 +1016,7 @@ SyncApi.prototype._resolveInvites = function(room) {
  * @param {Room} room
  * @param {MatrixEvent[]} stateEventList A list of state events. This is the state
  * at the *START* of the timeline list if it is supplied.
- * @param {?MatrixEvent[]} timelineEventList A list of timeline events. Lower index
+ * @param {MatrixEvent[]} [timelineEventList] A list of timeline events. Lower index
  * is earlier in time. Higher index is later.
  */
 SyncApi.prototype._processRoomEvents = function(room, stateEventList,

src/utils.js

@@ -348,16 +348,12 @@ var deepCompare = module.exports.deepCompare = function(x, y) {
  */
 module.exports.extend = function() {
     var target = arguments[0] || {};
-    // disable jshint "The body of a for in should be wrapped in an if
-    // statement"
-    /* jshint -W089 */
     for (var i = 1; i < arguments.length; i++) {
         var source = arguments[i];
-        for (var propName in source) {
+        for (var propName in source) { // eslint-disable-line guard-for-in
             target[propName] = source[propName];
         }
     }
-    /* jshint +W089 */
     return target;
 };
 

src/webrtc/call.js

@@ -153,7 +153,7 @@ MatrixCall.prototype.placeScreenSharingCall =
 /**
  * Play the given HTMLMediaElement, serialising the operation into a chain
  * of promises to avoid racing access to the element
- * @param {Element} HTMLMediaElement element to play
+ * @param {Element} element HTMLMediaElement element to play
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
 MatrixCall.prototype.playElement = function(element, queueId) {
@@ -183,7 +183,7 @@ MatrixCall.prototype.playElement = function(element, queueId) {
 /**
  * Pause the given HTMLMediaElement, serialising the operation into a chain
  * of promises to avoid racing access to the element
- * @param {Element} HTMLMediaElement element to pause
+ * @param {Element} element HTMLMediaElement element to pause
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
 MatrixCall.prototype.pauseElement = function(element, queueId) {
@@ -209,7 +209,7 @@ MatrixCall.prototype.pauseElement = function(element, queueId) {
  * Assign the given HTMLMediaElement by setting the .src attribute on it,
  * serialising the operation into a chain of promises to avoid racing access
  * to the element
- * @param {Element} HTMLMediaElement element to pause
+ * @param {Element} element HTMLMediaElement element to pause
  * @param {string} src the src attribute value to assign to the element
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
@@ -522,17 +522,14 @@ MatrixCall.prototype._gotUserMediaForInvite = function(stream) {
         }, 0);
     }
 
+    this.screenSharingStream.addTrack(stream.getAudioTracks()[0]);
+    stream = this.screenSharingStream;
+
     this.localAVStream = stream;
     // why do we enable audio (and only audio) tracks here? -- matthew
     setTracksEnabled(stream.getAudioTracks(), true);
     this.peerConn = _createPeerConnection(this);
     this.peerConn.addStream(stream);
-    if (this.screenSharingStream) {
-        console.log("Adding screen-sharing stream to peer connection");
-        this.peerConn.addStream(this.screenSharingStream);
-        // let's use this for the local preview...
-        this.localAVStream = this.screenSharingStream;
-    }
     this.peerConn.createOffer(
         hookCallback(self, self._gotLocalOffer),
         hookCallback(self, self._getLocalOfferFailed)
@@ -1144,14 +1141,6 @@ var _getChromeScreenSharingConstraints = function(call) {
         ));
         return;
     }
-    // it won't work at all if you're not on HTTPS so whine whine whine
-    if (!global.window || global.window.location.protocol !== "https:") {
-        call.emit("error", callError(
-            MatrixCall.ERR_NO_USER_MEDIA,
-            "You need to be using HTTPS to place a screen-sharing call."
-        ));
-        return;
-    }
 
     return {
         video: {