diff --git a/CHANGELOG.md b/CHANGELOG.md index df536080..52855dae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,20 @@ # CHANGELOG -The Collaborative Spaces SDK is currently under development, see [Github releases](https://github.com/ably-labs/spaces/releases) for our alpha releases. +## v0.1.0 -## 0.0.13 - 2023-08-24 +In this release, we're advancing Spaces from alpha to beta. Along with introducing this library to a wider audience, we've decided to move it to the `ably` organisation as Spaces is no longer an experiment, it's something we see as an excellent supplement to our core SDKs to help developers build collaborative environments in their apps. We are committed to grow and officially maintain it. -### Added +If you are one of our early adopters, this means you need to update your `package.json` from `@ably-labs/spaces` to `@ably/spaces`. -- Component locking -- Members namespace -- getSelf() and getOthers() methods for cursors +Visit [official documentation on Ably's website](https://ably.com/docs/spaces) to learn more about Spaces and understand what the beta status means for you. -### Changed +The following APIs are currently available: +- **Space** - a virtual area of your application in which realtime collaboration between users can take place. +- **Avatar stack** - the most common way of showing the online status of users in an application. +- **Member locations** - track where users are to see which part of your application they're interacting with. +- **Live cursors** - track the cursor positions of users in realtime. +- **Component locking** - optimistically lock stateful UI components before editing them. -- Cursor replay intervals +Your feedback will help prioritize improvements and fixes in subsequent releases. Spaces features have been validated for a set of use-cases, but breaking changes may still occur between minor releases until we reach 1.0.0. The beta is implemented based on real world situations and loads, but we'd advise to take caution when adding it to production environments. + +Please reach out to [beta@ably.com](mailto:beta@ably.com) for any questions or share feedback through [this form]( https://go.ably.com/spaces-feedback). diff --git a/demo/package.json b/demo/package.json index 80b8e080..95676f83 100644 --- a/demo/package.json +++ b/demo/package.json @@ -13,7 +13,7 @@ }, "dependencies": { "@ably-labs/react-hooks": "^3.0.0-canary.1", - "@ably-labs/spaces": "^0.0.13", + "@ably/spaces": "^0.1.0", "ably": "^1.2.43", "classnames": "^2.3.2", "dayjs": "^1.11.9", diff --git a/package-lock.json b/package-lock.json index 904b1d89..c4e888d7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@ably/spaces", - "version": "0.0.13", + "version": "0.1.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@ably/spaces", - "version": "0.0.13", + "version": "0.1.0", "license": "ISC", "dependencies": { "nanoid": "^4.0.2" diff --git a/package.json b/package.json index 34589e41..e236842a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ably/spaces", - "version": "0.0.13", + "version": "0.1.0", "description": "", "main": "dist/cjs/index.js", "module": "dist/mjs/index.js", diff --git a/src/Spaces.ts b/src/Spaces.ts index bd9a5f8a..a9b36949 100644 --- a/src/Spaces.ts +++ b/src/Spaces.ts @@ -17,7 +17,7 @@ class Spaces { client: Types.RealtimePromise; connection: Types.ConnectionPromise; - readonly version = '0.0.13'; + readonly version = '0.1.0'; constructor(client: Types.RealtimePromise) { this.client = client;