@volorio/rtm 0.2.0

package/README.md

@@ -0,0 +1,27 @@
+# @volorio/rtm
+
+Volorio Real-Time Messaging client for channel messages, presence, and low-latency app events.
+
+## Install
+
+```bash
+npm install @volorio/rtm
+```
+
+`@volorio/rtm` is built on Volorio signaling. Customer applications import Volorio packages only.
+
+## Usage
+
+```ts
+import { VolorioRtmClient } from "@volorio/rtm";
+import { VolorioSignalingClient } from "@volorio/signaling";
+
+const rtm = new VolorioRtmClient(new VolorioSignalingClient(room));
+
+await rtm.publishMessage("lobby", { text: "hello" });
+await rtm.setPresence("lobby", { status: "available" });
+
+const unsubscribe = rtm.onMessage("lobby", (message) => {
+  console.log(message.payload);
+});
+```

package/dist/src/index.d.ts

@@ -0,0 +1,23 @@
+import { VolorioSignalingClient, type VolorioSignalEnvelope, type VolorioSignalHandler } from "@volorio/signaling";
+export interface VolorioRtmMessage<TPayload = unknown> {
+    channel: string;
+    payload: TPayload;
+    clientMessageId?: string;
+}
+export interface VolorioRtmPresence {
+    identity?: string;
+    status: "online" | "away" | "busy" | "offline" | string;
+    metadata?: Record<string, unknown>;
+}
+export type VolorioRtmEvent<TPayload = unknown> = VolorioSignalEnvelope<VolorioRtmMessage<TPayload> | VolorioRtmPresence>;
+export declare class VolorioRtmClient {
+    private readonly signaling;
+    constructor(signaling: VolorioSignalingClient);
+    publishMessage<TPayload>(channel: string, payload: TPayload, clientMessageId?: string): Promise<void>;
+    setPresence(channel: string, presence: VolorioRtmPresence): Promise<void>;
+    onMessage<TPayload>(channel: string, handler: (event: VolorioSignalEnvelope<VolorioRtmMessage<TPayload>>) => void): () => void;
+    onPresence(channel: string, handler: (event: VolorioSignalEnvelope<VolorioRtmPresence>) => void): () => void;
+    subscribe<TPayload>(channel: string, type: string, handler: VolorioSignalHandler<TPayload>): () => void;
+}
+export { VolorioSignalingClient, parseVolorioSignal } from "@volorio/signaling";
+export type { VolorioSignalEnvelope, VolorioSignalHandler };

package/dist/src/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseVolorioSignal = exports.VolorioSignalingClient = exports.VolorioRtmClient = void 0;
+class VolorioRtmClient {
+    signaling;
+    constructor(signaling) {
+        this.signaling = signaling;
+    }
+    async publishMessage(channel, payload, clientMessageId) {
+        await this.signaling.publish(channel, "volorio.rtm.message", { channel, payload, clientMessageId });
+    }
+    async setPresence(channel, presence) {
+        await this.signaling.publish(channel, "volorio.rtm.presence", presence);
+    }
+    onMessage(channel, handler) {
+        return this.subscribe(channel, "volorio.rtm.message", handler);
+    }
+    onPresence(channel, handler) {
+        return this.subscribe(channel, "volorio.rtm.presence", handler);
+    }
+    subscribe(channel, type, handler) {
+        return this.signaling.subscribe(channel, (event) => {
+            if (event.type === type) {
+                handler(event);
+            }
+        });
+    }
+}
+exports.VolorioRtmClient = VolorioRtmClient;
+var signaling_1 = require("@volorio/signaling");
+Object.defineProperty(exports, "VolorioSignalingClient", { enumerable: true, get: function () { return signaling_1.VolorioSignalingClient; } });
+Object.defineProperty(exports, "parseVolorioSignal", { enumerable: true, get: function () { return signaling_1.parseVolorioSignal; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAgBA,MAAa,gBAAgB;IACE;IAA7B,YAA6B,SAAiC;QAAjC,cAAS,GAAT,SAAS,CAAwB;IAAG,CAAC;IAElE,KAAK,CAAC,cAAc,CAAW,OAAe,EAAE,OAAiB,EAAE,eAAwB;QACzF,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAwC,CAAC,CAAC;IAC5I,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,QAA4B;QAC7D,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,SAAS,CAAW,OAAe,EAAE,OAA4E;QAC/G,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED,UAAU,CAAC,OAAe,EAAE,OAAmE;QAC7F,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,SAAS,CAAW,OAAe,EAAE,IAAY,EAAE,OAAuC;QACxF,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,KAAsC,EAAE,EAAE;YAClF,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACxB,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1BD,4CA0BC;AAED,gDAAgF;AAAvE,mHAAA,sBAAsB,OAAA;AAAE,+GAAA,kBAAkB,OAAA"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@volorio/rtm",
+  "version": "0.2.0",
+  "private": false,
+  "description": "Volorio Real-Time Messaging client for channel messages, presence, and low-latency app events.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": ["dist/src", "README.md"],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "pnpm build",
+    "pack:local": "pnpm build && npm pack --pack-destination dist"
+  },
+  "dependencies": {
+    "@volorio/signaling": "^0.2.0"
+  }
+}