@textrp/briij-js-sdk 41.0.0 → 42.0.0

package/CHANGELOG.md

@@ -1,7 +1,20 @@
-Changes in [41.0.0] (Unreleased - Briij JavaScript SDK)
+Changes in [42.0.0] (Unreleased - Briij JavaScript SDK)
 ==================================================================================================
 ## BREAKING CHANGES
 
+---
+Changes in [42.0.0]
+* **Xrpl/Xahau Auth**: 
+* Added initial support for Xrpl/Xahau authentication, including API entry points and data structures. Further enhancements and stability improvements are expected.
+* Migrated all documentation, file structures, and references from `Matrix` to `Briij` throughout the codebase.
+* Updated package metadata: package is now called `briij-js-sdk`, primary entry point and typings renamed accordingly.
+* Updated all relevant public APIs, internal references, and tests to use the new `Briij` naming convention.
+* Fixed inconsistencies in naming after rebrand.
+* Cleaned up legacy references, deprecated documentation, and clarified guides for SDK consumers.
+* No additional feature changes introduced post-rebrand except for initial Xrpl/Xahau Auth support.
+
+---
+Changes in [41.0.1]
 * **Rebrand**: This package has been rebranded from Matrix JavaScript SDK to Briij JavaScript SDK. All public API types and symbols have been renamed from `Matrix*` to `Briij*` (e.g. `MatrixClient` -> `BriijClient`, `MatrixEvent` -> `BriijEvent`, `createNewMatrixCall` -> `createNewBriijCall`). The main entry module is now `briij.ts` (default export `briij`). Package name is `briij-js-sdk`. Existing code must update imports and type names accordingly.
 
 ---

package/LICENSE

@@ -1,177 +1,177 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -8,32 +8,22 @@
 
 # Briij JavaScript SDK
 
-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.
-
----
-
-<picture>
-  <source srcset="contrib/element-logo-light.png" media="(prefers-color-scheme: dark)">
-  <source srcset="contrib/element-logo-dark.png" media="(prefers-color-scheme: light)">
-  <img src="contrib/element-logo-fallback.png" alt="Element logo">
-</picture>
+<p align="center">
+  <img src="contrib/textrp-logo.png" alt="TextRP logo" width="280">
+</p>
 
-<br>
-
-Development and maintenance is proudly sponsored by [Element](https://element.io). Element uses the SDK in their flagship [web](https://github.com/element-hq/element-web) and [desktop](https://github.com/element-hq/element-desktop) clients.
-
-The SDK is also the basis for multiple Matrix projects and we welcome contributions from all.
+This is the Briij Client-Server SDK for JavaScript and TypeScript. This SDK can be run in a
+browser or in Node.js.
 
 ---
 
-#### Minimum Matrix server version: v1.1
+#### Minimum server version: v1.1
 
-The Matrix specification is constantly evolving - while this SDK aims for maximum backwards compatibility, it only
+The client-server 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.
+endpoints from before v1.1, for example.
 
 # Quickstart
 
@@ -48,7 +38,7 @@ guide](https://pnpm.io/installation#using-corepack) if you do not have it alread
 
 ```javascript
 import * as sdk from "@textrp/briij-js-sdk";
-const client = sdk.createClient({ baseUrl: "https://matrix.org" });
+const client = sdk.createClient({ baseUrl: "https://your-server.example.org" });
 client.publicRooms(function (err, data) {
     console.log("Public Rooms: %s", JSON.stringify(data));
 });
@@ -109,9 +99,20 @@ Object.keys(client.store.rooms).forEach((roomId) => {
 });
 ```
 
+## XRPL NFT trust verification
+
+`requestVerification(targetXrplAddress)` and `acceptVerification(issuerXrplAddress)` keep the same signatures, but now use mutable identity-NFT metadata (URI JSON `verifiers`) instead of XRPL Credential objects.
+
+For `acceptVerification()`, configure either:
+
+- `pinJsonToIpfs(payload)` callback, or
+- `pinataJwt` to use Pinata's `pinJSONToIPFS` API.
+
+The SDK signs `NFTokenModify` via Xaman and emits Matrix verification events with the resulting transaction hash.
+
 ## Authenticated media
 
-Servers supporting [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916) (Matrix 1.11) will require clients, like
+Servers supporting [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916) (spec 1.11) will require clients, like
 yours, to include an `Authorization` header when `/download`ing or `/thumbnail`ing media. For NodeJS environments this
 may be as easy as the following code snippet, though web browsers may need to use [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API)
 to append the header when using the endpoints in `<img />` elements and similar.
@@ -139,7 +140,7 @@ const img = await fetch(downloadUrl, {
 
 ## What does this SDK do?
 
-This SDK provides a full object model around the Matrix Client-Server API and emits
+This SDK provides a full object model around the client-server API and emits
 events for incoming data and state changes. Aside from wrapping the HTTP API, it:
 
 - Handles syncing (via `/sync`)
@@ -201,11 +202,11 @@ client.startClient();
 
 As well as the primary entry point (`@textrp/briij-js-sdk`), there are several other entry points which may be useful:
 
-| Entry point                    | Description                                                                                         |
-| ------------------------------ | --------------------------------------------------------------------------------------------------- |
+| Entry point                           | Description                                                                                         |
+| ------------------------------------- | --------------------------------------------------------------------------------------------------- |
 | `@textrp/briij-js-sdk`                | Primary entry point. High-level functionality, and lots of historical clutter in need of a cleanup. |
 | `@textrp/briij-js-sdk/lib/crypto-api` | Cryptography functionality.                                                                         |
-| `@textrp/briij-js-sdk/lib/types`      | Low-level types, reflecting data structures defined in the Matrix spec.                             |
+| `@textrp/briij-js-sdk/lib/types`      | Low-level types, reflecting data structures defined in the client-server spec.                      |
 | `@textrp/briij-js-sdk/lib/testing`    | Test utilities, which may be useful in test code but should not be used in production code.         |
 | `@textrp/briij-js-sdk/lib/utils/*.js` | A set of modules exporting standalone functions (and their types).                                  |
 
@@ -218,7 +219,7 @@ core functionality of the SDK. These examples assume the SDK is set up like this
 import * as sdk from "@textrp/briij-js-sdk";
 const myUserId = "@example:localhost";
 const myAccessToken = "QGV4YW1wbGU6bG9jYWxob3N0.qPEvLuYfNBjxikiCjP";
-const matrixClient = sdk.createClient({
+const client = sdk.createClient({
     baseUrl: "http://localhost:8008",
     accessToken: myAccessToken,
     userId: myUserId,
@@ -228,21 +229,21 @@ const matrixClient = sdk.createClient({
 ### Automatically join rooms when invited
 
 ```javascript
-matrixClient.on(RoomEvent.MyMembership, function (room, membership, prevMembership) {
+client.on(RoomEvent.MyMembership, function (room, membership, prevMembership) {
     if (membership === KnownMembership.Invite) {
-        matrixClient.joinRoom(room.roomId).then(function () {
+        client.joinRoom(room.roomId).then(function () {
             console.log("Auto-joined %s", room.roomId);
         });
     }
 });
 
-matrixClient.startClient();
+client.startClient();
 ```
 
 ### Print out messages for all rooms
 
 ```javascript
-matrixClient.on(RoomEvent.Timeline, function (event, room, toStartOfTimeline) {
+client.on(RoomEvent.Timeline, function (event, room, toStartOfTimeline) {
     if (toStartOfTimeline) {
         return; // don't print paginated results
     }
@@ -258,7 +259,7 @@ matrixClient.on(RoomEvent.Timeline, function (event, room, toStartOfTimeline) {
     );
 });
 
-matrixClient.startClient();
+client.startClient();
 ```
 
 Output:
@@ -274,8 +275,8 @@ Output:
 ### Print out membership lists whenever they are changed
 
 ```javascript
-matrixClient.on(RoomStateEvent.Members, function (event, state, member) {
-    const room = matrixClient.getRoom(state.roomId);
+client.on(RoomStateEvent.Members, function (event, state, member) {
+    const room = client.getRoom(state.roomId);
     if (!room) {
         return;
     }
@@ -287,7 +288,7 @@ matrixClient.on(RoomStateEvent.Members, function (event, state, member) {
     }
 });
 
-matrixClient.startClient();
+client.startClient();
 ```
 
 Output:
@@ -323,18 +324,18 @@ Then visit `http://localhost:8005` to see the API docs.
 
 ## Initialization
 
-To initialize the end-to-end encryption support in the matrix client:
+To initialize the end-to-end encryption support in the client:
 
 ```javascript
-// Create a new matrix client
-const matrixClient = sdk.createClient({
+// Create a new client
+const client = sdk.createClient({
     baseUrl: "http://localhost:8008",
     accessToken: myAccessToken,
     userId: myUserId,
 });
 
 // Initialize to enable end-to-end encryption support.
-await matrixClient.initRustCrypto();
+await client.initRustCrypto();
 ```
 
 Note that by default it will attempt to use the Indexed DB provided by the browser as a crypto store. If running outside the browser, you will need to pass [an options object](https://briij.github.io/@textrp/briij-js-sdk/classes/briij.BriijClient.html#initrustcrypto) which includes `useIndexedDB: false`, to use an ephemeral in-memory store instead. Note that without a persistent store, you'll need to create a new device on the server side (with [`BriijClient.loginRequest`](https://briij.github.io/@textrp/briij-js-sdk/classes/briij.BriijClient.html#loginrequest)) each time your application starts.
@@ -349,7 +350,7 @@ You should normally set up [secret storage](https://spec.matrix.org/v1.12/client
 `bootstrapSecretStorage` can be called unconditionally: it will only set up the secret storage if it is not already set up (unless you use the `setupNewSecretStorage` parameter).
 
 ```javascript
-const matrixClient = sdk.createClient({
+const client = sdk.createClient({
     ...,
     cryptoCallbacks: {
         getSecretStorageKey: async (keys) => {
@@ -359,7 +360,7 @@ const matrixClient = sdk.createClient({
     },
 });
 
-matrixClient.getCrypto().bootstrapSecretStorage({
+client.getCrypto().bootstrapSecretStorage({
     // This function will be called if a new secret storage key (aka recovery key) is needed.
     // You should prompt the user to save the key somewhere, because they will need it to unlock secret storage in future.
     createSecretStorageKey: async () => {
@@ -379,7 +380,7 @@ To set up cross-signing to verify devices and other users, call
 [`CryptoApi.bootstrapCrossSigning`](https://briij.github.io/@textrp/briij-js-sdk/interfaces/crypto_api.CryptoApi.html#bootstrapCrossSigning):
 
 ```javascript
-matrixClient.getCrypto().bootstrapCrossSigning({
+client.getCrypto().bootstrapCrossSigning({
     authUploadDeviceSigningKeys: async (makeRequest) => {
         return makeRequest(authDict);
     },
@@ -396,10 +397,10 @@ If the user doesn't already have a [key backup](https://spec.matrix.org/v1.12/cl
 ```javascript
 // Check if we have a key backup.
 // If checkKeyBackupAndEnable returns null, there is no key backup.
-const hasKeyBackup = (await matrixClient.getCrypto().checkKeyBackupAndEnable()) !== null;
+const hasKeyBackup = (await client.getCrypto().checkKeyBackupAndEnable()) !== null;
 
 // Create the key backup
-await matrixClient.getCrypto().resetKeyBackup();
+await client.getCrypto().resetKeyBackup();
 ```
 
 ## Verify a new device
@@ -421,8 +422,8 @@ This migration happens automatically when you call `initRustCrypto()` instead of
 but you need to provide the legacy [`cryptoStore`](https://briij.github.io/@textrp/briij-js-sdk/interfaces/briij.ICreateClientOpts.html#cryptoStore) and [`pickleKey`](https://briij.github.io/@textrp/briij-js-sdk/interfaces/briij.ICreateClientOpts.html#pickleKey) to [`createClient`](https://briij.github.io/@textrp/briij-js-sdk/functions/briij.createClient.html):
 
 ```javascript
-// You should provide the legacy crypto store and the pickle key to the matrix client in order to migrate the data.
-const matrixClient = sdk.createClient({
+// You should provide the legacy crypto store and the pickle key to the client in order to migrate the data.
+const client = sdk.createClient({
     cryptoStore: myCryptoStore,
     pickleKey: myPickleKey,
     baseUrl: "http://localhost:8008",
@@ -431,14 +432,14 @@ const matrixClient = sdk.createClient({
 });
 
 // The migration will be done automatically when you call `initRustCrypto`.
-await matrixClient.initRustCrypto();
+await client.initRustCrypto();
 ```
 
 To follow the migration progress, you can listen to the [`CryptoEvent.LegacyCryptoStoreMigrationProgress`](https://briij.github.io/@textrp/briij-js-sdk/enums/crypto_api.CryptoEvent.html#LegacyCryptoStoreMigrationProgress) event:
 
 ```javascript
 // When progress === total === -1, the migration is finished.
-matrixClient.on(CryptoEvent.LegacyCryptoStoreMigrationProgress, (progress, total) => {
+client.on(CryptoEvent.LegacyCryptoStoreMigrationProgress, (progress, total) => {
     ...
 });
 ```

package/lib/@types/AESEncryptedSecretStoragePayload.js.map

@@ -1 +1 @@
-{"version":3,"file":"AESEncryptedSecretStoragePayload.js","names":[],"sources":["../../src/@types/AESEncryptedSecretStoragePayload.ts"],"sourcesContent":["/*\r\n * Copyright 2024 The Matrix.org Foundation C.I.C.\r\n *\r\n * Licensed under the Apache License, Version 2.0 (the \"License\");\r\n * you may not use this file except in compliance with the License.\r\n * You may obtain a copy of the License at\r\n *\r\n *     http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n * Unless required by applicable law or agreed to in writing, software\r\n * distributed under the License is distributed on an \"AS IS\" BASIS,\r\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n * See the License for the specific language governing permissions and\r\n * limitations under the License.\r\n */\r\n\r\n/**\r\n * An AES-encrypted secret storage payload.\r\n * See https://spec.matrix.org/v1.11/client-server-api/#msecret_storagev1aes-hmac-sha2-1\r\n */\r\nexport interface AESEncryptedSecretStoragePayload {\r\n    [key: string]: any; // extensible\r\n    /** the initialization vector in base64 */\r\n    iv: string;\r\n    /** the ciphertext in base64 */\r\n    ciphertext: string;\r\n    /** the HMAC in base64 */\r\n    mac: string;\r\n}\r\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"AESEncryptedSecretStoragePayload.js","names":[],"sources":["../../src/@types/AESEncryptedSecretStoragePayload.ts"],"sourcesContent":["/*\n * Copyright 2024 The Matrix.org Foundation C.I.C.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * An AES-encrypted secret storage payload.\n * See https://spec.matrix.org/v1.11/client-server-api/#msecret_storagev1aes-hmac-sha2-1\n */\nexport interface AESEncryptedSecretStoragePayload {\n    [key: string]: any; // extensible\n    /** the initialization vector in base64 */\n    iv: string;\n    /** the ciphertext in base64 */\n    ciphertext: string;\n    /** the HMAC in base64 */\n    mac: string;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/@types/IIdentityServerProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"IIdentityServerProvider.js","names":[],"sources":["../../src/@types/IIdentityServerProvider.ts"],"sourcesContent":["/*\r\nCopyright 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nexport interface IIdentityServerProvider {\r\n    /**\r\n     * Gets an access token for use against the identity server,\r\n     * for the associated client.\r\n     * @returns Promise which resolves to the access token.\r\n     */\r\n    getAccessToken(): Promise<string | null>;\r\n}\r\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"IIdentityServerProvider.js","names":[],"sources":["../../src/@types/IIdentityServerProvider.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nexport interface IIdentityServerProvider {\n    /**\n     * Gets an access token for use against the identity server,\n     * for the associated client.\n     * @returns Promise which resolves to the access token.\n     */\n    getAccessToken(): Promise<string | null>;\n}\n"],"mappings":"","ignoreList":[]}