Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.1.0 #158

Merged
merged 1 commit into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/Spaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading