@pluv/io 0.2.2 → 0.2.4

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @pluv/io@0.2.2 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.2.4 build /home/runner/work/pluv/pluv/packages/io
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v6.5.0
+CLI tsup v6.6.3
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 26.79 KB
-ESM ⚡️ Build success in 104ms
-CJS dist/index.js 28.59 KB
-CJS ⚡️ Build success in 106ms
+CJS dist/index.js 29.22 KB
+CJS ⚡️ Build success in 97ms
+ESM dist/index.mjs 27.14 KB
+ESM ⚡️ Build success in 99ms
 DTS Build start
-DTS ⚡️ Build success in 2852ms
+DTS ⚡️ Build success in 2738ms
 DTS dist/index.d.ts 12.86 KB

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @pluv/io
 
+## 0.2.4
+
+### Patch Changes
+
+- 8bf62cb: bumped dependencies
+- 7e52685: Bumped dependencies
+- 3b7b17a: docs: corrected readme typos
+- b1cb325: Updated dependencies
+- 8e97fb2: Updated dependencies
+- Updated dependencies [8bf62cb]
+- Updated dependencies [7e52685]
+- Updated dependencies [b1cb325]
+- Updated dependencies [327a6ef]
+- Updated dependencies [8e97fb2]
+  - @pluv/crdt-yjs@0.3.0
+  - @pluv/types@0.1.3
+
+## 0.2.3
+
+### Patch Changes
+
+- 95b5ef8: breaking: update PluvRoom.broadcast api
+- e23fbbe: update demo gif in README
+- Updated dependencies [6858682]
+  - @pluv/crdt-yjs@0.2.0
+  - @pluv/types@0.1.2
+
 ## 0.2.2
 
 ### Patch Changes

package/README.md

@@ -19,13 +19,19 @@
   <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
     <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
   </a>
-  <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
   <a href="https://commitizen.github.io/cz-cli/">
     <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
   </a>
   <img src="https://img.shields.io/badge/website-coming%20soon!-blue" alt="Website coming soon!" />
 </p>
 
+<p align="center">
+  <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
+  <a href="https://openbase.com/js/@pluv/io?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge">
+    <img src="https://badges.openbase.com/js/featured/@pluv/io.svg?token=FdWfpo90mCUb7InAjDG0KeXM/uH+KdHK3us2pNRgWf0=" alt="Featured on Openbase" />
+  </a>
+</p>
+
 <p align="center">
   <a href="#intro">Intro</a> •
   <a href="#usage">Usage</a> •
@@ -34,31 +40,32 @@
   <a href="#license">License</a>
 </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>
 
 ## Intro
 
-Pluv.IO allows you to build real-time collaborate features with a fully end-to-end type-safe api.
+Pluv.IO allows you to build real-time collaborative features with a fully end-to-end type-safe api.
 
 ### Why?
 
 So you can do this:
 
 ```tsx
+const broadcast = usePluvBroadcast();
+
 usePluvEvent("RECEIVE_MESSAGE", ({ data }) => {
   setMessages([...messages, data.message]);
 });
 
-usePluvBroadcast({
-  type: "SEND_MESSAGE",
-  data: { message: "Hello world!" },
-});
+broadcast("SEND_MESSAGE", { message: "Hello world!" });
 ```
 
 And this:
 
 ```tsx
-const [myCursor, updatePresence] = usePluvMyPresence((me) => me.presence.cursor);
+const [myCursor, updatePresence] = usePluvMyPresence((me) => me.cursor);
 const cursors = usePluvOthers((others) => {
   return others.map((other) => other.presence.cursor);
 });
@@ -116,9 +123,9 @@ And more. With **E2E type-safety**, **great intellisense** and the **[yjs](https
     - ✅ [Map](https://docs.yjs.dev/api/shared-types/y.map)
     - ✅ [Array](https://docs.yjs.dev/api/shared-types/y.array)
     - ✅ [Text](https://docs.yjs.dev/api/shared-types/y.text)
-    - ⬜ [XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment)
-    - ⬜ [XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement)
-    - ⬜ [XmlText](https://docs.yjs.dev/api/shared-types/y.xmltext)
+    - ✅ [XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment)
+    - ✅ [XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement)
+    - ✅ [XmlText](https://docs.yjs.dev/api/shared-types/y.xmltext)
 - ⬜ Studio (admin & developer panel)
 
 ### Runtimes

package/dist/index.js

@@ -47,6 +47,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -160,8 +164,11 @@ var PubSub = class extends AbstractPubSub {
   constructor() {
     super(...arguments);
     this._currentSubscriptionId = 0;
+    // Map of roomName to subjects
     this._subjects = /* @__PURE__ */ new Map();
+    // Map of roomName to subscription ids
     this._subscriptionsRefs = /* @__PURE__ */ new Map();
+    // Map of
     this._unsubscriptions = /* @__PURE__ */ new Map();
   }
   publish(roomName, payload) {
@@ -219,9 +226,13 @@ var AbstractPlatform = class {
 // src/AbstractWebSocket.ts
 var AbstractWebSocket = class {
   constructor(config) {
+    /** The connection is not yet open. */
     this.CONNECTING = 0;
+    /** The connection is open and ready to communicate. */
     this.OPEN = 1;
+    /** The connection is in the process of closing. */
     this.CLOSING = 2;
+    /** The connection is closed. */
     this.CLOSED = 3;
     const { room } = config;
     this.room = room;
@@ -356,7 +367,7 @@ var IORoom = class {
         pluvWs.close(3e3, "WebSocket unauthorized.");
         return;
       }
-      const currentTime = new Date().getTime();
+      const currentTime = (/* @__PURE__ */ new Date()).getTime();
       const session = {
         id: sessionId,
         presence: null,
@@ -481,7 +492,7 @@ var IORoom = class {
   _broadcast(params) {
     var _a;
     const { message, senderId } = params;
-    const currentTime = new Date().getTime();
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
     const sender = senderId ? this._sessions.get(senderId) : null;
     const quitters = Array.from(this._sessions.values()).filter(
       (session) => session.quit || currentTime - session.timers.ping > PING_TIMEOUT_MS
@@ -577,7 +588,7 @@ var IORoom = class {
     });
   }
   _getSessionsSize() {
-    const currentTime = new Date().getTime();
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
     return Array.from(this._sessions.values()).reduce((count, session) => {
       if (session.quit)
         return count;
@@ -741,7 +752,7 @@ var PluvIO = class {
         resolver: (data, { session }) => {
           if (!session)
             return {};
-          const currentTime = new Date().getTime();
+          const currentTime = (/* @__PURE__ */ new Date()).getTime();
           session.timers.ping = currentTime;
           return { $PONG: {} };
         },

package/dist/index.mjs

@@ -127,8 +127,11 @@ var PubSub = class extends AbstractPubSub {
   constructor() {
     super(...arguments);
     this._currentSubscriptionId = 0;
+    // Map of roomName to subjects
     this._subjects = /* @__PURE__ */ new Map();
+    // Map of roomName to subscription ids
     this._subscriptionsRefs = /* @__PURE__ */ new Map();
+    // Map of
     this._unsubscriptions = /* @__PURE__ */ new Map();
   }
   publish(roomName, payload) {
@@ -186,9 +189,13 @@ var AbstractPlatform = class {
 // src/AbstractWebSocket.ts
 var AbstractWebSocket = class {
   constructor(config) {
+    /** The connection is not yet open. */
     this.CONNECTING = 0;
+    /** The connection is open and ready to communicate. */
     this.OPEN = 1;
+    /** The connection is in the process of closing. */
     this.CLOSING = 2;
+    /** The connection is closed. */
     this.CLOSED = 3;
     const { room } = config;
     this.room = room;
@@ -323,7 +330,7 @@ var IORoom = class {
         pluvWs.close(3e3, "WebSocket unauthorized.");
         return;
       }
-      const currentTime = new Date().getTime();
+      const currentTime = (/* @__PURE__ */ new Date()).getTime();
       const session = {
         id: sessionId,
         presence: null,
@@ -448,7 +455,7 @@ var IORoom = class {
   _broadcast(params) {
     var _a;
     const { message, senderId } = params;
-    const currentTime = new Date().getTime();
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
     const sender = senderId ? this._sessions.get(senderId) : null;
     const quitters = Array.from(this._sessions.values()).filter(
       (session) => session.quit || currentTime - session.timers.ping > PING_TIMEOUT_MS
@@ -544,7 +551,7 @@ var IORoom = class {
     });
   }
   _getSessionsSize() {
-    const currentTime = new Date().getTime();
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
     return Array.from(this._sessions.values()).reduce((count, session) => {
       if (session.quit)
         return count;
@@ -708,7 +715,7 @@ var PluvIO = class {
         resolver: (data, { session }) => {
           if (!session)
             return {};
-          const currentTime = new Date().getTime();
+          const currentTime = (/* @__PURE__ */ new Date()).getTime();
           session.timers.ping = currentTime;
           return { $PONG: {} };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,22 +17,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@panva/hkdf": "^1.0.2",
+    "@panva/hkdf": "^1.0.4",
     "chalk": "^4.1.2",
-    "jose": "^4.11.2",
-    "wonka": "^6.1.2",
-    "@pluv/crdt-yjs": "^0.1.3",
-    "@pluv/types": "^0.1.2"
+    "jose": "^4.13.1",
+    "wonka": "^6.2.3",
+    "@pluv/crdt-yjs": "^0.3.0",
+    "@pluv/types": "^0.1.3"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "tsup": "^6.5.0",
-    "typescript": "^4.9.4",
-    "yjs": "^13.5.44",
-    "@pluv/tsconfig": "^0.1.2",
-    "eslint-config-pluv": "^0.1.2"
+    "tsup": "^6.6.3",
+    "typescript": "^4.9.5",
+    "yjs": "^13.5.49",
+    "@pluv/tsconfig": "^0.1.3",
+    "eslint-config-pluv": "^0.1.4"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",