Merge tag 'v22.0.0' into sc

* Enable users to join group calls from multiple devices ([\matrix-org#2902](matrix-org#2902)). * Deprecate a function containing a typo ([\matrix-org#2904](matrix-org#2904)). * sliding sync: add receipts extension ([\matrix-org#2912](matrix-org#2912)). * Define a spec support policy for the js-sdk ([\matrix-org#2882](matrix-org#2882)). * Further improvements to e2ee logging ([\matrix-org#2900](matrix-org#2900)). * sliding sync: add support for typing extension ([\matrix-org#2893](matrix-org#2893)). * Improve logging on Olm session errors ([\matrix-org#2885](matrix-org#2885)). * Improve logging of e2ee messages ([\matrix-org#2884](matrix-org#2884)). * Fix 3pid invite acceptance not working due to mxid being sent in body ([\matrix-org#2907](matrix-org#2907)). Fixes element-hq/element-web#23823. * Don't hang up calls that haven't started yet ([\matrix-org#2898](matrix-org#2898)). * Read receipt accumulation for threads ([\matrix-org#2881](matrix-org#2881)). * Make GroupCall work better with widgets ([\matrix-org#2935](matrix-org#2935)). * Fix highlight notifications increasing when total notification is zero ([\matrix-org#2937](matrix-org#2937)). Fixes element-hq/element-web#23885. * Fix synthesizeReceipt ([\matrix-org#2916](matrix-org#2916)). Fixes element-hq/element-web#23827 element-hq/element-web#23754 and element-hq/element-web#23847.
SchildiChat · Dec 6, 2022 · 789e2bf · 789e2bf
2 parents 6128de1 + b6369cc
commit 789e2bf
Show file tree

Hide file tree

Showing 105 changed files with 2,689 additions and 1,754 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -85,5 +85,14 @@ module.exports = {
             // We use a `logger` intermediary module
             "no-console": "error",
         },
+    }, {
+        files: [
+            "spec/**/*.ts",
+        ],
+        rules: {
+            // We don't need super strict typing in test utilities
+            "@typescript-eslint/explicit-function-return-type": "off",
+            "@typescript-eslint/explicit-member-accessibility": "off",
+        },
     }],
 };
diff --git a/.github/workflows/docs-pr-netlify.yaml b/.github/workflows/docs-pr-netlify.yaml
@@ -14,7 +14,7 @@ jobs:
       # There's a 'download artifact' action, but it hasn't been updated for the workflow_run action
       # (https://github.com/actions/download-artifact/issues/60) so instead we get this mess:
       - name: 📥 Download artifact
-        uses: dawidd6/action-download-artifact@b12b127cf24433d14b4f93cee62f5465076ba82a # v2.24.1
+        uses: dawidd6/action-download-artifact@e6e25ac3a2b93187502a8be1ef9e9603afc34925 # v2.24.2
         with:
           workflow: static_analysis.yml
           run_id: ${{ github.event.workflow_run.id }}

diff --git a/.github/workflows/static_analysis.yml b/.github/workflows/static_analysis.yml
@@ -66,9 +66,44 @@ jobs:
         run: "yarn run gendoc"
 
       - name: Upload Artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: docs
           path: _docs
           # We'll only use this in a workflow_run, then we're done with it
           retention-days: 1
+
+  tsc-strict:
+    name: Typescript Strict Error Checker
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+      checks: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get diff lines
+        id: diff
+        uses: Equip-Collaboration/[email protected]
+        with:
+          include: '["\\.tsx?$"]'
+
+      - name: Detecting files changed
+        id: files
+        uses: futuratrepadeira/[email protected]
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          pattern: '^.*\.tsx?$'
+
+      - uses: t3chguy/typescript-check-action@main
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          use-check: false
+          check-fail-mode: added
+          output-behaviour: annotate
+          ts-extra-args: '--noImplicitAny'
+          files-changed: ${{ steps.files.outputs.files_updated }}
+          files-added: ${{ steps.files.outputs.files_created }}
+          files-deleted: ${{ steps.files.outputs.files_deleted }}
+          line-numbers: ${{ steps.diff.outputs.lineNumbers }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,28 @@
+Changes in [22.0.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v22.0.0) (2022-12-06)
+==================================================================================================
+
+## 🚨 BREAKING CHANGES
+ * Enable users to join group calls from multiple devices ([\#2902](https://github.com/matrix-org/matrix-js-sdk/pull/2902)).
+
+## 🦖 Deprecations
+ * Deprecate a function containing a typo ([\#2904](https://github.com/matrix-org/matrix-js-sdk/pull/2904)).
+
+## ✨ Features
+ * sliding sync: add receipts extension ([\#2912](https://github.com/matrix-org/matrix-js-sdk/pull/2912)).
+ * Define a spec support policy for the js-sdk ([\#2882](https://github.com/matrix-org/matrix-js-sdk/pull/2882)).
+ * Further improvements to e2ee logging ([\#2900](https://github.com/matrix-org/matrix-js-sdk/pull/2900)).
+ * sliding sync: add support for typing extension ([\#2893](https://github.com/matrix-org/matrix-js-sdk/pull/2893)).
+ * Improve logging on Olm session errors ([\#2885](https://github.com/matrix-org/matrix-js-sdk/pull/2885)).
+ * Improve logging of e2ee messages ([\#2884](https://github.com/matrix-org/matrix-js-sdk/pull/2884)).
+
+## 🐛 Bug Fixes
+ * Fix 3pid invite acceptance not working due to mxid being sent in body ([\#2907](https://github.com/matrix-org/matrix-js-sdk/pull/2907)). Fixes vector-im/element-web#23823.
+ * Don't hang up calls that haven't started yet ([\#2898](https://github.com/matrix-org/matrix-js-sdk/pull/2898)).
+ * Read receipt accumulation for threads ([\#2881](https://github.com/matrix-org/matrix-js-sdk/pull/2881)).
+ * Make GroupCall work better with widgets ([\#2935](https://github.com/matrix-org/matrix-js-sdk/pull/2935)).
+ * Fix highlight notifications increasing when total notification is zero ([\#2937](https://github.com/matrix-org/matrix-js-sdk/pull/2937)). Fixes vector-im/element-web#23885.
+ * Fix synthesizeReceipt ([\#2916](https://github.com/matrix-org/matrix-js-sdk/pull/2916)). Fixes vector-im/element-web#23827 vector-im/element-web#23754 and vector-im/element-web#23847.
+
 Changes in [21.2.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v21.2.0) (2022-11-22)
 ==================================================================================================
 

diff --git a/README.md b/README.md
@@ -10,8 +10,14 @@
 Matrix Javascript SDK
 =====================
 
-This is the [Matrix](https://matrix.org) Client-Server r0 SDK for
-JavaScript. This SDK can be run in a browser or in Node.js.
+This is the [Matrix](https://matrix.org) Client-Server SDK for JavaScript and TypeScript. This SDK can be run in a
+browser or in Node.js.
+
+The Matrix specification is constantly evolving - while this SDK aims for maximum backwards compatibility, it only
+guarantees that a feature will be supported for at least 4 spec releases. For example, if a feature the js-sdk supports
+is removed in v1.4 then the feature is *eligible* for removal from the SDK when v1.8 is released. This SDK has no
+guarantee on implementing all features of any particular spec release, currently. This can mean that the SDK will call
+endpoints from before Matrix 1.1, for example.
 
 Quickstart
 ==========

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "matrix-js-sdk",
-  "version": "21.2.0",
+  "version": "22.0.0",
   "description": "Matrix Client-Server SDK for Javascript",
   "engines": {
     "node": ">=16.0.0"
@@ -85,26 +85,26 @@
     "@types/content-type": "^1.1.5",
     "@types/domexception": "^4.0.0",
     "@types/jest": "^29.0.0",
-    "@types/node": "16",
+    "@types/node": "18",
     "@typescript-eslint/eslint-plugin": "^5.6.0",
     "@typescript-eslint/parser": "^5.6.0",
     "allchange": "^1.0.6",
     "babel-jest": "^29.0.0",
     "babelify": "^10.0.0",
     "better-docs": "^2.4.0-beta.9",
     "browserify": "^17.0.0",
-    "docdash": "^1.2.0",
+    "docdash": "^2.0.0",
     "domexception": "^4.0.0",
-    "eslint": "8.26.0",
+    "eslint": "8.28.0",
     "eslint-config-google": "^0.14.0",
     "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-matrix-org": "^0.7.0",
-    "eslint-plugin-unicorn": "^44.0.2",
+    "eslint-plugin-matrix-org": "^0.8.0",
+    "eslint-plugin-unicorn": "^45.0.0",
     "exorcist": "^2.0.0",
     "fake-indexeddb": "^4.0.0",
     "jest": "^29.0.0",
-    "jest-environment-jsdom": "^28.1.3",
+    "jest-environment-jsdom": "^29.0.0",
     "jest-localstorage-mock": "^2.4.6",
     "jest-mock": "^29.0.0",
     "matrix-mock-request": "^2.5.0",

diff --git a/spec/integ/matrix-client-methods.spec.ts b/spec/integ/matrix-client-methods.spec.ts
@@ -173,7 +173,9 @@ describe("MatrixClient", function() {
                 signatures: {},
             };
 
-            httpBackend!.when("POST", inviteSignUrl).respond(200, signature);
+            httpBackend!.when("POST", inviteSignUrl).check(request => {
+                expect(request.queryParams?.mxid).toEqual(client!.getUserId());
+            }).respond(200, signature);
             httpBackend!.when("POST", "/join/" + encodeURIComponent(roomId)).check(request => {
                 expect(request.data.third_party_signed).toEqual(signature);
             }).respond(200, { room_id: roomId });

diff --git a/spec/integ/matrix-client-syncing.spec.ts b/spec/integ/matrix-client-syncing.spec.ts
@@ -709,11 +709,11 @@ describe("MatrixClient syncing", () => {
                 const room = client!.getRoom(roomOne)!;
                 const stateAtStart = room.getLiveTimeline().getState(EventTimeline.BACKWARDS)!;
                 const startRoomNameEvent = stateAtStart.getStateEvents('m.room.name', '');
-                expect(startRoomNameEvent.getContent().name).toEqual('Old room name');
+                expect(startRoomNameEvent!.getContent().name).toEqual('Old room name');
 
                 const stateAtEnd = room.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
                 const endRoomNameEvent = stateAtEnd.getStateEvents('m.room.name', '');
-                expect(endRoomNameEvent.getContent().name).toEqual('A new room name');
+                expect(endRoomNameEvent!.getContent().name).toEqual('A new room name');
             });
         });
 
@@ -1599,7 +1599,7 @@ describe("MatrixClient syncing", () => {
             expect(room.roomId).toBe(roomOne);
             expect(room.getMyMembership()).toBe("leave");
             expect(room.name).toBe("Room Name");
-            expect(room.currentState.getStateEvents("m.room.name", "").getId()).toBe("$eventId");
+            expect(room.currentState.getStateEvents("m.room.name", "")?.getId()).toBe("$eventId");
             expect(room.timeline[0].getContent().body).toBe("Message 1");
             expect(room.timeline[1].getContent().body).toBe("Message 2");
             client?.stopPeeking();