@volorio/rtm 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +16 -0
  2. package/README.md +25 -11
  3. package/package.json +23 -3
package/LICENSE ADDED
@@ -0,0 +1,16 @@
1
+ Volorio SDK Commercial License
2
+
3
+ Copyright (c) 2026 Volorio. All rights reserved.
4
+
5
+ Permission to install and use this SDK is granted only to an authorized Volorio
6
+ customer or evaluator, solely to integrate an application with Volorio services,
7
+ and subject to the Volorio Terms at https://volor.io/terms.
8
+
9
+ Except where the Volorio Terms expressly allow it, you may not redistribute,
10
+ sublicense, sell, publish, reverse engineer, or create a competing service from
11
+ this SDK or its source code. No ownership rights are transferred.
12
+
13
+ Third-party dependencies remain subject to their respective licenses.
14
+
15
+ THE SDK IS PROVIDED WITHOUT WARRANTIES EXCEPT TO THE EXTENT EXPRESSLY STATED IN
16
+ THE VOLORIO TERMS.
package/README.md CHANGED
@@ -5,23 +5,37 @@ Volorio Real-Time Messaging client for channel messages, presence, and low-laten
5
5
  ## Install
6
6
 
7
7
  ```bash
8
- npm install @volorio/rtm
8
+ npm install @volorio/rtm@0.2.1
9
9
  ```
10
10
 
11
- `@volorio/rtm` is built on Volorio signaling. Customer applications import Volorio packages only.
11
+ ## Runtime and security
12
12
 
13
- ## Usage
13
+ - Runtime: Browser application
14
+ - Source version: `0.2.1`
15
+ - Registry status: published as 0.2.1
16
+ - API base URL for server calls: `https://api.volor.io`
17
+ - License: proprietary commercial SDK; see the included `LICENSE` and [Volorio Terms](https://volor.io/terms).
18
+ - Never expose a Volorio API key in browser, React Native, or Flutter code. Create short-lived sessions in your backend.
19
+ - Capability note: Requested products must be granted to the API key and accepted by the session endpoint.
20
+
21
+ ## Public API
22
+
23
+ - `VolorioRtmMessage`
24
+ - `VolorioRtmPresence`
25
+ - `VolorioRtmEvent`
26
+ - `VolorioRtmClient`
14
27
 
15
28
  ```ts
16
29
  import { VolorioRtmClient } from "@volorio/rtm";
17
- import { VolorioSignalingClient } from "@volorio/signaling";
30
+ ```
18
31
 
19
- const rtm = new VolorioRtmClient(new VolorioSignalingClient(room));
20
32
 
21
- await rtm.publishMessage("lobby", { text: "hello" });
22
- await rtm.setPresence("lobby", { status: "available" });
33
+ ## Dependencies
23
34
 
24
- const unsubscribe = rtm.onMessage("lobby", (message) => {
25
- console.log(message.payload);
26
- });
27
- ```
35
+ - `@volorio/signaling` `^0.2.0`
36
+
37
+ ## Documentation
38
+
39
+ - [Volorio npm integration guide](https://volor.io/docs/packages/npm-overview)
40
+ - [REST and SDK documentation](https://volor.io/docs)
41
+ - [Volorio Console](https://app.volor.io)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volorio/rtm",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "private": false,
5
5
  "description": "Volorio Real-Time Messaging client for channel messages, presence, and low-latency app events.",
6
6
  "main": "dist/src/index.js",
@@ -11,7 +11,11 @@
11
11
  "default": "./dist/src/index.js"
12
12
  }
13
13
  },
14
- "files": ["dist/src", "README.md"],
14
+ "files": [
15
+ "dist/src",
16
+ "README.md",
17
+ "LICENSE"
18
+ ],
15
19
  "publishConfig": {
16
20
  "access": "public",
17
21
  "registry": "https://registry.npmjs.org/"
@@ -23,5 +27,21 @@
23
27
  },
24
28
  "dependencies": {
25
29
  "@volorio/signaling": "^0.2.0"
26
- }
30
+ },
31
+ "homepage": "https://volor.io/docs/packages/npm-overview",
32
+ "license": "SEE LICENSE IN LICENSE",
33
+ "keywords": [
34
+ "volorio",
35
+ "realtime",
36
+ "rtc",
37
+ "sdk",
38
+ "rtm",
39
+ "real-time",
40
+ "messaging",
41
+ "client",
42
+ "channel",
43
+ "messages",
44
+ "presence",
45
+ "low-latency"
46
+ ]
27
47
  }