Merge pull request #162 from ably/release/0.8.0

Release/0.8.0

Author: ttypic

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change Log
 
+## [0.8.0](https://github.com/ably/ably-chat-kotlin/tree/v0.8.0)
+
+[Full Changelog](https://github.com/ably/ably-chat-kotlin/compare/v0.7.0...v0.8.0)
+
+## What's Changed
+
+The following features have been added in this release:
+
+- **Protocol v4 support** Added support for Chat protocol v4, enabling enhanced message handling. [#161](https://github.com/ably/ably-chat-kotlin/pull/161)
+- **Destructuring syntax** Added destructuring syntax for subscription handling, providing more convenient API usage. [#159](https://github.com/ably/ably-chat-kotlin/pull/159)
+- **Custom JSON implementation** Replaced Gson with custom JSON implementation to reduce dependencies [#160](https://github.com/ably/ably-chat-kotlin/pull/160)
+
+### Breaking changes
+
+This release includes several breaking changes:
+
+- `Message` structure has changed.
+- Replaced `Gson` with a custom JSON interface.
+- Presence Data must be a JsonObject.
+
+For detailed migration instructions, please refer to the [Upgrading Guide](UPGRADING.md).
+
 ## [0.7.0](https://github.com/ably/ably-chat-kotlin/tree/v0.7.0)
 
 [Full Changelog](https://github.com/ably/ably-chat-kotlin/compare/v0.6.0...v0.7.0)

README.md

@@ -45,13 +45,13 @@ The Ably Chat SDK is available on the Maven Central Repository. To include the d
 For Groovy:
 
 ```groovy
-implementation 'com.ably.chat:chat:0.7.0'
+implementation 'com.ably.chat:chat:0.8.0'
 ```
 
 For Kotlin Script (`build.gradle.kts`):
 
 ```kotlin
-implementation("com.ably.chat:chat:0.7.0")
+implementation("com.ably.chat:chat:0.8.0")
 ```
 
 ## Releases

UPGRADING.md

@@ -2,6 +2,61 @@
 
 This guide provides detailed instructions on how to upgrade between versions of the Chat SDK.
 
+## 0.7.x to 0.8.x
+
+### Protocol v4 changes
+
+**Expected Impact: Medium**
+
+The Chat SDK now supports protocol v4, which introduces changes to message structure and handling.
+
+#### Message Structure Changes
+
+**Before**
+
+```kotlin
+val message: Message = getMessage()
+val versionSerial: String = message.serial
+val createdAt: Long = message.createdAt
+val updatedAt: Long = message.timestamp
+```
+
+**After**
+
+```kotlin
+val message: Message = getMessage()
+val versionSerial: String = message.version.serial
+val createdAt: Long = message.timestamp
+val updatedAt: Long = message.version.timestamp
+```
+
+### Custom JSON Implementation
+
+**Expected Impact: Low**
+
+The SDK has replaced Gson with a custom JSON interface to reduce external dependencies.
+
+Affected fields: `Message.metadata`, `RoomReaction.metadata`, `Presence.data`
+
+To build a JSON object to send, use the `jsonObject` builder from `com.ably.chat.json`:
+
+```kotlin
+presence.enter(jsonObject {
+    put("status", "active")
+    putObject("profile") {
+        put("username", "John Doe")
+        put("img", "https://example.com/img")
+    }
+})
+```
+
+### Presence Data JsonObject
+
+**Expected Impact: Low**
+
+Presence data must be a `JsonObject` rather than an arbitrary JSON value.
+The `enter()`, `leave()`, and `update()` methods now accept only a `JsonObject`.
+
 ## 0.4.x to 0.5.x
 
 ### Room Reaction Wire Protocol

gradle.properties

@@ -18,7 +18,7 @@ android.useAndroidX=true
 
 # Maven Publish properties:
 GROUP=com.ably.chat
-VERSION_NAME=0.7.0
+VERSION_NAME=0.8.0
 
 POM_INCEPTION_YEAR=2024
 POM_URL=https://github.com/ably/ably-chat-kotlin