@pluv/client 0.1.2 → 0.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.1.2 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.2.0 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 30.41 KB
-CJS ⚡️ Build success in 110ms
-ESM dist/index.mjs 29.33 KB
-ESM ⚡️ Build success in 115ms
+ESM dist/index.mjs 29.38 KB
+ESM ⚡️ Build success in 86ms
+CJS dist/index.js 30.46 KB
+CJS ⚡️ Build success in 98ms
 DTS Build start
-DTS ⚡️ Build success in 3241ms
-DTS dist/index.d.ts 8.23 KB
+DTS ⚡️ Build success in 2621ms
+DTS dist/index.d.ts 8.26 KB

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @pluv/client
 
+## 0.2.0
+
+### Minor Changes
+
+- 95b5ef8: breaking: update PluvRoom.broadcast api
+
+### Patch Changes
+
+- Updated dependencies [6858682]
+  - @pluv/crdt-yjs@0.2.0
+  - @pluv/types@0.1.2
+
+## 0.1.3
+
+### Patch Changes
+
+- fe80d7b: added preview disclaimer about breaking changes in the readme
+- Updated dependencies [fe80d7b]
+  - @pluv/crdt-yjs@0.1.3
+  - @pluv/types@0.1.2
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -1,3 +1,6 @@
+> **Disclaimer:**
+> This package is currently in preview and may have breaking changes between versions. Please wait for a `v1.0.0` stable release before using this in production.
+
 <h1 align="center">
   <br>
   <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px">
@@ -23,7 +26,9 @@
   <img src="https://img.shields.io/badge/docs-coming%20soon!-blue" alt="Docs coming soon!" />
 </p>
 
-<img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
+<p align="center">
+  <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
+</p>
 
 ## `@pluv/client`
 

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { InferYjsSharedTypeJson, array, map, text, unstable__object } from '@pluv/crdt-yjs';
 export { InferYjsSharedTypeJson } from '@pluv/crdt-yjs';
 import * as _pluv_types from '@pluv/types';
-import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, InputZodLike, InferIOInput, InferEventMessage, InferIOAuthorizeRequired } from '@pluv/types';
+import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, InputZodLike, InferIOInput, InferIOAuthorizeRequired } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { AbstractType } from 'yjs';
 export { AbstractType } from 'yjs';
@@ -105,10 +105,10 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _usersManager;
     constructor(room: string, options: RoomConfig<TIO, TPresence, TStorage>);
     get webSocket(): WebSocket | null;
-    broadcast(message: Id<InferEventMessage<InferIOInput<TIO>>>): void;
+    broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     connect(): Promise<void>;
     disconnect(): void;
-    event: <TEvent extends keyof InferIOOutput<TIO>>(name: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
+    event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
     getMyPresence: () => TPresence | null;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;

package/dist/index.js

@@ -298,8 +298,8 @@ var PluvRoom = class {
     };
     this._windowListeners = null;
     this._wsListeners = null;
-    this.event = (name, callback) => {
-      return this._eventNotifier.subscribe(name, callback);
+    this.event = (event, callback) => {
+      return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
       var _a, _b;
@@ -362,12 +362,13 @@ var PluvRoom = class {
   get webSocket() {
     return this._state.webSocket;
   }
-  broadcast(message) {
+  broadcast(event, data) {
     if (!this._state.webSocket)
       return;
     if (this._state.connection.state !== "Open" /* Open */)
       return;
-    this._sendMessage(message);
+    const type = event.toString();
+    this._sendMessage({ data, type });
   }
   connect() {
     return __async(this, null, function* () {

package/dist/index.mjs

@@ -275,8 +275,8 @@ var PluvRoom = class {
     };
     this._windowListeners = null;
     this._wsListeners = null;
-    this.event = (name, callback) => {
-      return this._eventNotifier.subscribe(name, callback);
+    this.event = (event, callback) => {
+      return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
       var _a, _b;
@@ -339,12 +339,13 @@ var PluvRoom = class {
   get webSocket() {
     return this._state.webSocket;
   }
-  broadcast(message) {
+  broadcast(event, data) {
     if (!this._state.webSocket)
       return;
     if (this._state.connection.state !== "Open" /* Open */)
       return;
-    this._sendMessage(message);
+    const type = event.toString();
+    this._sendMessage({ data, type });
   }
   connect() {
     return __async(this, null, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,19 +17,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@pluv/crdt-yjs": "^0.1.2",
-    "@pluv/types": "^0.1.1",
-    "wonka": "^6.1.2"
+    "wonka": "^6.1.2",
+    "@pluv/crdt-yjs": "^0.2.0",
+    "@pluv/types": "^0.1.2"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "@pluv/tsconfig": "^0.1.1",
-    "eslint-config-pluv": "^0.1.1",
     "tsup": "^6.5.0",
     "typescript": "^4.9.4",
-    "yjs": "^13.5.44"
+    "yjs": "^13.5.44",
+    "@pluv/tsconfig": "^0.1.2",
+    "eslint-config-pluv": "^0.1.3"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvRoom.ts

@@ -201,11 +201,16 @@ export class PluvRoom<
         return this._state.webSocket;
     }
 
-    public broadcast(message: Id<InferEventMessage<InferIOInput<TIO>>>): void {
+    public broadcast<TEvent extends keyof InferIOInput<TIO>>(
+        event: TEvent,
+        data: Id<InferIOInput<TIO>[TEvent]>
+    ): void {
         if (!this._state.webSocket) return;
         if (this._state.connection.state !== ConnectionState.Open) return;
 
-        this._sendMessage(message);
+        const type = event.toString();
+
+        this._sendMessage({ data, type });
     }
 
     public async connect(): Promise<void> {
@@ -291,10 +296,10 @@ export class PluvRoom<
     }
 
     public event = <TEvent extends keyof InferIOOutput<TIO>>(
-        name: TEvent,
+        event: TEvent,
         callback: EventNotifierSubscriptionCallback<TIO, TEvent>
     ): (() => void) => {
-        return this._eventNotifier.subscribe(name, callback);
+        return this._eventNotifier.subscribe(event, callback);
     };
 
     public getConnection(): WebSocketConnection {