Merge pull request #1416 from ably/1411-merge-main-into-v2

[SDK-3761] Merge `main` into `integration/v2`

.ably/capabilities.yaml

@@ -1,6 +1,6 @@
 %YAML 1.2
 ---
-common-version: 1.2.0
+common-version: 1.2.1
 compliance:
   Agent Identifier:
     Agents:
@@ -46,6 +46,7 @@ compliance:
       Get Identifier:
       Incremental Backoff:
       Lifecycle Control:
+      OS Connectivity Events:
       Ping:
       Recovery:
       State Events:

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 This contains only the most important and/or user-facing changes; for a full changelog, see the commit history.
 
+## [1.2.42](https://github.com/ably/ably-js/tree/1.2.42) (2023-07-24)
+
+- Auth: remain connected upon failed authorize unless returning explicit 403 [\#1385](https://github.com/ably/ably-js/pull/1385)
+- Make `Utils#inspectError` use `toString` for `Error`-like values [\#1391](https://github.com/ably/ably-js/pull/1391)
+- docs: fix description of AuthOptions.token [\#1368](https://github.com/ably/ably-js/pull/1368)
+
+## [1.2.41](https://github.com/ably/ably-js/tree/1.2.41) (2023-06-29)
+
+- add `ChannelStateChange.hasBacklog` and return state change to attach promise/callback [\#1347](https://github.com/ably/ably-js/pull/1347)
+- fix a bug where host fallback was initially skipped after falling back to the base transport [\#1357](https://github.com/ably/ably-js/pull/1357)
+
 ## [1.2.40](https://github.com/ably/ably-js/tree/1.2.40) (2023-05-26)
 
 This release adds a new experimental `channels.getDerived` method which allows you to create custom realtime data feeds by selectively subscribing to receive only part of the data from the channel. See the [announcement post](https://pages.ably.com/subscription-filters-preview) for more information.

CONTRIBUTING.md

@@ -26,6 +26,12 @@
 11. For nontrivial releases: update the ably-js submodule ref in the realtime repo
 12. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes (again, you can just copy the notes you added to the CHANGELOG)
 
+## Building the library
+
+To build the library, simply run `npm run build`. Building the library currently requires NodeJS <= v16.
+
+Since webpack builds are slow, commands are also available to only build the output for specific platforms (eg `npm run build:node`), see [package.json](./package.json) for the full list of available commands
+
 ## Test suite
 
 To run the Mocha tests, simply run the following command:
@@ -42,6 +48,14 @@ Or run just one test file
 
     npm run test:node -- --file=test/realtime/auth.test.js
 
+Or run just one test
+
+    npm run test:node -- --file=test/rest/status.test.js --grep=test_name_here 
+
+Or run test skipping the build
+
+    npm run test:node:skip-build -- --file=test/rest/status.test.js --grep=test_name_here 
+
 ### Debugging the mocha tests locally with a debugger
 
 Run the following command to launch tests with the debugger enabled. The tests will block until you attach a debugger.
@@ -64,6 +78,12 @@ Run the following command to start a local Mocha test runner web server
 
 Open your browser to [http://localhost:3000](http://localhost:3000). If you are using a remote browser, refer to https://docs.saucelabs.com/reference/sauce-connect/ for instructions on setting up a local tunnel to your Mocha runner web server.
 
+### Formatting/linting files
+
+Run the following command to fix linting/formatting issues
+
+    npm run format
+
 ### Testing environment variables for Node.js
 
 All tests are run against the sandbox environment by default. However, the following environment variables can be set before running the Karma server to change the environment the tests are run against.