@textrp/briij-js-sdk 41.0.0 → 41.0.1

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-Changes in [41.0.0] (Unreleased - Briij JavaScript SDK)
+Changes in [41.0.1] (Unreleased - Briij JavaScript SDK)
 ==================================================================================================
 ## BREAKING CHANGES
 

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>
-
-<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.
+<p align="center">
+  <img src="contrib/textrp-logo.png" alt="TextRP logo" width="280">
+</p>
 
-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));
 });
@@ -111,7 +101,7 @@ Object.keys(client.store.rooms).forEach((roomId) => {
 
 ## 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 +129,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`)
@@ -205,7 +195,7 @@ As well as the primary entry point (`@textrp/briij-js-sdk`), there are several o
 | ------------------------------ | --------------------------------------------------------------------------------------------------- |
 | `@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 +208,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 +218,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 +248,7 @@ matrixClient.on(RoomEvent.Timeline, function (event, room, toStartOfTimeline) {
     );
 });
 
-matrixClient.startClient();
+client.startClient();
 ```
 
 Output:
@@ -274,8 +264,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 +277,7 @@ matrixClient.on(RoomStateEvent.Members, function (event, state, member) {
     }
 });
 
-matrixClient.startClient();
+client.startClient();
 ```
 
 Output:
@@ -323,18 +313,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 +339,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 +349,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 +369,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 +386,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 +411,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 +421,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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@textrp/briij-js-sdk",
-    "version": "41.0.0",
+    "version": "41.0.1",
     "description": "Briij Client-Server SDK for JavaScript and TypeScript",
     "engines": {
         "node": ">=22.0.0"