Merge pull request #455 from ably/release/0.4.0

chore: 0.4.0 release

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This contains only the most important and/or user-facing changes; for a full changelog, see the commit history.
 
+## [0.4.0](https://github.com/ably/ably-chat-js/tree/0.4.0) (2025-01-20)
+
+### Breaking Changes
+
+Please see `UPGRADING.md` for full guidance on upgrading from version 0.3.1 and before.
+
+- The `@ably/chat/react` and `@ably/chat/react-native` packages have been removed. All React imports are in the base `@ably/chat` package.
+
 ## [0.3.1](https://github.com/ably/ably-chat-js/tree/0.3.1) (2025-01-14)
 
 ### Fixes

CONTRIBUTING.md

@@ -19,10 +19,10 @@
       - The second number represents a minor release, which lets users know new functionality or features have been added.
       - The third number represents a patch release, which represents bug-fixes and may be used when no action should be required from users.
    2. The commit should update `package.json` and `package-lock.json`. Running `npm install` after changing `package.json` will update `package-lock.json`.
-   3. The commit should also update `react-native/package.json` to the appropriate version.
-   4. The commit should also update `version.ts` to set the agent headers.
-   5. Update the `CHANGELOG.md` with any customer-affecting changes since the last release.
-   6. Update the README.md for any references to the new version.
+   3. The commit should also update `version.ts` to set the agent headers.
+   4. Update the `CHANGELOG.md` with any customer-affecting changes since the last release.
+   5. Update the README.md for any references to the new version.
+   6. If making breaking changes, add steps to upgrade to the `UPGRADING.md`.
 3. Merge the commit into main.
 4. Tag a release using [Github releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release). The version needs to match the one from the commit. Use the "Generate release notes" button to
    add changelog notes and update as required.

UPGRADING.md

@@ -2,6 +2,44 @@
 
 This guide provides detailed instructions on how to upgrade between major versions of the Chat SDK.
 
+## <= 0.3.1 to 0.4.0
+
+### React Package Removed
+
+**Expected Impact: High**
+
+The `@ably/chat/react` and `@ably/chat/react-native` packages have been removed. All React imports are in the base `@ably/chat` package.
+
+#### React
+
+Before:
+
+```ts
+import { Message } from '@ably/chat';
+import { useMessages } from '@ably/chat/react';
+```
+
+After:
+
+```ts
+import { Message, useMessages } from '@ably/chat';
+```
+
+#### React Native
+
+Before:
+
+```ts
+import { Message } from '@ably/chat';
+import { useMessages } from '@ably/chat-react-native';
+```
+
+After:
+
+```ts
+import { Message, useMessages } from '@ably/chat';
+```
+
 ## <= 0.2.1 to 0.3.0
 
 ### Room and Connection Status Types

demo/README.md

@@ -13,7 +13,7 @@ npm run start
 ##   Installation
 
 > [!NOTE] This demo app uses both the `ably-chat-js` core SDK and associated React hooks.
-> The latter is accessible via `@ably/chat/react` once the `@ably/chat` package has been installed.
+> This is accessible via `@ably/chat`.
 
 1. First of all, you need to build the main Chat SDK and associated React hooks from the root directory (`(cd .. && npm run build)`).
 2. Run `npm install` here.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ably/chat",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Ably Chat is a set of purpose-built APIs for a host of chat features enabling you to create 1:1, 1:Many, Many:1 and Many:Many chat rooms for any scale. It is designed to meet a wide range of chat use cases, such as livestreams, in-game communication, customer support, or social interactions in SaaS products.",
   "type": "module",
   "main": "dist/chat/ably-chat.umd.cjs",

src/core/version.ts

@@ -1,4 +1,4 @@
 // Update this when you release a new version
-export const VERSION = '0.3.1';
+export const VERSION = '0.4.0';
 export const CHANNEL_OPTIONS_AGENT_STRING = `chat-js/${VERSION}`;
 export const DEFAULT_CHANNEL_OPTIONS = { params: { agent: CHANNEL_OPTIONS_AGENT_STRING } };

typedoc.json

@@ -20,7 +20,6 @@
     "paths": {
       "@ably": ["node_modules/ably/ably.d.ts"],
       "@ably/chat": ["./src/core"],
-      "@ably/chat/react": ["./src/react"]
     }
   },
   "requiredToBeDocumented": [