Skip to content

Commit

Permalink
Adds changelog for 2462e9b...85b54ea
Browse files Browse the repository at this point in the history
Also change `ably/modules` to `ably/modular`
  • Loading branch information
VeskeR committed Mar 11, 2024
1 parent c40c2ce commit a9bf9e8
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Read [ably-js v2 migration guide](link TBD) for more information.

### Modular variant of the library

An ESM variant of the library is now available for browsers (but not for Node.js) at `ably/modules`. This modular variant of the library supports tree shaking, allowing for a reduction in the Ably bundle size within your application. It can also be used by Web Workers.
An ESM variant of the library is now available for browsers (but not for Node.js) at `ably/modular`. This modular variant of the library supports tree shaking, allowing for a reduction in the Ably bundle size within your application. It can also be used by Web Workers.

### First-class support for Promises

Expand Down Expand Up @@ -40,16 +40,18 @@ ___

### Breaking Changes

- Remove code that's supporting older platforms [\#1629](https://github.com/ably/ably-js/pull/1629)
- `ChannelProvider` implementation [\#1620](https://github.com/ably/ably-js/pull/1620)
- Rename `id` field to `ablyId` in React Hooks [\#1676](https://github.com/ably/ably-js/pull/1676)
- Remove code that's supporting older platforms [\#1641](https://github.com/ably/ably-js/pull/1641), [\#1633](https://github.com/ably/ably-js/pull/1633), [\#1629](https://github.com/ably/ably-js/pull/1629)
- Fix `whenState` inconsistent behavior in `Connection` and `RealtimeChannel` [\#1640](https://github.com/ably/ably-js/pull/1640)
- `ChannelProvider` implementation [\#1654](https://github.com/ably/ably-js/pull/1654), [\#1620](https://github.com/ably/ably-js/pull/1620)
- Remove `recoveryKey` in favour of `createRecoveryKey()` on `Connection` [\#1613](https://github.com/ably/ably-js/pull/1613)
- Remove duplicate type names and change public `ChannelModes` type [\#1601](https://github.com/ably/ably-js/pull/1601)
- Remove `any` from `stats()` param type [\#1561](https://github.com/ably/ably-js/pull/1561)
- Remove the dedicated Web Worker bundle `ably/build/ably-webworker` and add support for using `ably` and `ably/modules` in Web Workers [\#1550](https://github.com/ably/ably-js/pull/1550)
- Remove the dedicated Web Worker bundle `ably/build/ably-webworker` and add support for using `ably` and `ably/modular` in Web Workers [\#1550](https://github.com/ably/ably-js/pull/1550)
- Remove false class exports in type declarations [\#1524](https://github.com/ably/ably-js/pull/1524)
- Implement untyped stats API [\#1522](https://github.com/ably/ably-js/pull/1522)
- Remove the `Types` namespace [\#1518](https://github.com/ably/ably-js/pull/1518)
- Update publishing methods to accept a `Message`-shaped object [\#1515](https://github.com/ably/ably-js/pull/1515)
- Remove the existing plugins mechanism [\#1512](https://github.com/ably/ably-js/pull/1512)
- Remove `noencryption` variant of the library [\#1500](https://github.com/ably/ably-js/pull/1500)
- Remove public callbacks API [\#1358](https://github.com/ably/ably-js/pull/1358)
- Fix the type definition of `Crypto.getDefaultParams` [\#1352](https://github.com/ably/ably-js/pull/1352)
Expand All @@ -66,27 +68,30 @@ ___

### Features

- `ChannelProvider` implementation [\#1620](https://github.com/ably/ably-js/pull/1620)
- Add `publish` function to the `useChannel` hook [\#1658](https://github.com/ably/ably-js/pull/1658)
- `ChannelProvider` implementation [\#1654](https://github.com/ably/ably-js/pull/1654), [\#1620](https://github.com/ably/ably-js/pull/1620)
- Add logs to all HTTP activity [\#1581](https://github.com/ably/ably-js/pull/1581)
- Remove the dedicated Web Worker bundle `ably/build/ably-webworker` and add support for using `ably` and `ably/modules` in Web Workers [\#1550](https://github.com/ably/ably-js/pull/1550)
- Remove the dedicated Web Worker bundle `ably/build/ably-webworker` and add support for using `ably` and `ably/modular` in Web Workers [\#1550](https://github.com/ably/ably-js/pull/1550)
- Implement untyped stats API [\#1522](https://github.com/ably/ably-js/pull/1522)
- Stop using CryptoJS for signing token requests [\#1325](https://github.com/ably/ably-js/pull/1325)
- Use Web Crypto API for encrypting and decrypting [\#1299](https://github.com/ably/ably-js/pull/1299)
- Add mandatory `version` param to `Rest.request` [\#1231](https://github.com/ably/ably-js/pull/1231)

### Bug Fixes

- Fix `whenState` inconsistent behavior in `Connection` and `RealtimeChannel` [\#1640](https://github.com/ably/ably-js/pull/1640)
- Remove false class exports in type declarations [\#1524](https://github.com/ably/ably-js/pull/1524)
- Fix the type definition of `Crypto.getDefaultParams` [\#1352](https://github.com/ably/ably-js/pull/1352)

### Code Refactoring

- Remove code that's supporting older platforms [\#1629](https://github.com/ably/ably-js/pull/1629)
- Rename `id` field to `ablyId` in React Hooks [\#1676](https://github.com/ably/ably-js/pull/1676)
- Remove code that's supporting older platforms [\#1641](https://github.com/ably/ably-js/pull/1641), [\#1633](https://github.com/ably/ably-js/pull/1633), [\#1629](https://github.com/ably/ably-js/pull/1629)
- Remove `recoveryKey` in favour of `createRecoveryKey()` on `Connection` [\#1613](https://github.com/ably/ably-js/pull/1613)
- Remove duplicate type names and change public `ChannelModes` type [\#1601](https://github.com/ably/ably-js/pull/1601)
- Remove `any` from `stats()` param type [\#1561](https://github.com/ably/ably-js/pull/1561)
- Remove the `Types` namespace [\#1518](https://github.com/ably/ably-js/pull/1518)
- Update publishing methods to accept a `Message`-shaped object [\#1515](https://github.com/ably/ably-js/pull/1515)
- Remove the existing plugins mechanism [\#1512](https://github.com/ably/ably-js/pull/1512)
- Remove `noencryption` variant of the library [\#1500](https://github.com/ably/ably-js/pull/1500)
- Remove public callbacks API [\#1358](https://github.com/ably/ably-js/pull/1358)
- Change `Crypto.generateRandomKey` API to use Promises [\#1351](https://github.com/ably/ably-js/pull/1351)
Expand Down

0 comments on commit a9bf9e8

Please sign in to comment.