@pluv/client 0.9.1 → 0.10.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/client@0.9.1 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.10.0 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v7.1.0
+CLI tsup v7.2.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 39.02 KB
-ESM ⚡️ Build success in 135ms
-CJS dist/index.js 40.23 KB
-CJS ⚡️ Build success in 135ms
+ESM dist/index.mjs 39.21 KB
+ESM ⚡️ Build success in 139ms
+CJS dist/index.js 40.42 KB
+CJS ⚡️ Build success in 139ms
 DTS Build start
-DTS ⚡️ Build success in 4784ms
-DTS dist/index.d.mts 12.92 KB
-DTS dist/index.d.ts  12.92 KB
+DTS ⚡️ Build success in 4296ms
+DTS dist/index.d.mts 13.18 KB
+DTS dist/index.d.ts  13.18 KB

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @pluv/client
 
+## 0.10.0
+
+### Minor Changes
+
+- f43f1cc: Change packages to all be versioned together for consistency.
+
+### Patch Changes
+
+- Updated dependencies [f43f1cc]
+  - @pluv/crdt-yjs@0.10.0
+  - @pluv/types@0.10.0
+
+## 0.9.2
+
+### Patch Changes
+
+- f4317ba: \* Renamed type `unstable_YObjectValue` to `YObjectValue`;
+
+  - Renamed type `unstable_YObject` to `YObject`.
+  - Re-exported `xmlElement`, `xmlFragment` and `xmlText` from `@pluv/client`.
+
+    ```ts
+    import { y } from "@pluv/client";
+    // or
+    import { y } from "@pluv/react";
+
+    y.xmlElement("MyElement", {});
+    y.xmlFragment({});
+    y.xmlText("hello world");
+    ```
+
+- Updated dependencies [f4317ba]
+  - @pluv/crdt-yjs@0.4.2
+
 ## 0.9.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { InferYjsSharedTypeJson, array, map, object, text } from '@pluv/crdt-yjs';
+import { InferYjsSharedTypeJson, array, map, object, text, xmlElement, xmlFragment, xmlText } 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, InferIOInput, InputZodLike, InferIOAuthorizeRequired } from '@pluv/types';
@@ -261,12 +261,18 @@ declare const y_array: typeof array;
 declare const y_map: typeof map;
 declare const y_object: typeof object;
 declare const y_text: typeof text;
+declare const y_xmlElement: typeof xmlElement;
+declare const y_xmlFragment: typeof xmlFragment;
+declare const y_xmlText: typeof xmlText;
 declare namespace y {
   export {
     y_array as array,
     y_map as map,
     y_object as object,
     y_text as text,
+    y_xmlElement as xmlElement,
+    y_xmlFragment as xmlFragment,
+    y_xmlText as xmlText,
   };
 }
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { InferYjsSharedTypeJson, array, map, object, text } from '@pluv/crdt-yjs';
+import { InferYjsSharedTypeJson, array, map, object, text, xmlElement, xmlFragment, xmlText } 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, InferIOInput, InputZodLike, InferIOAuthorizeRequired } from '@pluv/types';
@@ -261,12 +261,18 @@ declare const y_array: typeof array;
 declare const y_map: typeof map;
 declare const y_object: typeof object;
 declare const y_text: typeof text;
+declare const y_xmlElement: typeof xmlElement;
+declare const y_xmlFragment: typeof xmlFragment;
+declare const y_xmlText: typeof xmlText;
 declare namespace y {
   export {
     y_array as array,
     y_map as map,
     y_object as object,
     y_text as text,
+    y_xmlElement as xmlElement,
+    y_xmlFragment as xmlFragment,
+    y_xmlText as xmlText,
   };
 }
 

package/dist/index.js

@@ -532,6 +532,7 @@ var PluvRoom = class extends AbstractRoom {
       });
       yield this._storageStore.initialize();
       yield this._applyStorageStore();
+      console.log(this._getWsEndpoint(this.id));
       const url = new URL(this._getWsEndpoint(this.id));
       let authToken = null;
       let webSocket;
@@ -1332,7 +1333,10 @@ __export(y_exports, {
   array: () => import_crdt_yjs2.array,
   map: () => import_crdt_yjs2.map,
   object: () => import_crdt_yjs2.object,
-  text: () => import_crdt_yjs2.text
+  text: () => import_crdt_yjs2.text,
+  xmlElement: () => import_crdt_yjs2.xmlElement,
+  xmlFragment: () => import_crdt_yjs2.xmlFragment,
+  xmlText: () => import_crdt_yjs2.xmlText
 });
 var import_crdt_yjs2 = require("@pluv/crdt-yjs");
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -506,6 +506,7 @@ var PluvRoom = class extends AbstractRoom {
       });
       yield this._storageStore.initialize();
       yield this._applyStorageStore();
+      console.log(this._getWsEndpoint(this.id));
       const url = new URL(this._getWsEndpoint(this.id));
       let authToken = null;
       let webSocket;
@@ -1306,9 +1307,20 @@ __export(y_exports, {
   array: () => array,
   map: () => map,
   object: () => object,
-  text: () => text
+  text: () => text,
+  xmlElement: () => xmlElement,
+  xmlFragment: () => xmlFragment,
+  xmlText: () => xmlText
 });
-import { array, map, text, object } from "@pluv/crdt-yjs";
+import {
+  array,
+  map,
+  object,
+  text,
+  xmlElement,
+  xmlFragment,
+  xmlText
+} from "@pluv/crdt-yjs";
 export {
   AbstractRoom,
   AbstractStorageStore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,20 +17,20 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/react": "^18.2.15",
-    "wonka": "^6.3.2",
-    "@pluv/crdt-yjs": "^0.4.1",
-    "@pluv/types": "^0.2.2"
+    "@types/react": "^18.2.20",
+    "wonka": "^6.3.4",
+    "@pluv/crdt-yjs": "^0.10.0",
+    "@pluv/types": "^0.10.0"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "tsup": "^7.1.0",
+    "tsup": "^7.2.0",
     "typescript": "^5.1.6",
-    "yjs": "^13.6.6",
-    "@pluv/tsconfig": "^0.1.8",
-    "eslint-config-pluv": "^0.1.14"
+    "yjs": "^13.6.7",
+    "@pluv/tsconfig": "^0.10.0",
+    "eslint-config-pluv": "^0.2.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvRoom.ts

@@ -49,9 +49,9 @@ const Y_ORIGIN_INITIALIZED = "$INITIALIZED";
 export const DEFAULT_PLUV_CLIENT_ADDON = <
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 >(
-    input: PluvRoomAddonInput<TIO, TPresence, TStorage>
+    input: PluvRoomAddonInput<TIO, TPresence, TStorage>,
 ): PluvRoomAddonResult => ({
     storage: new StorageStore(input.room.id),
 });
@@ -106,15 +106,15 @@ interface InternalListeners {
 export type PluvRoomAddon<
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 > = (
-    input: PluvRoomAddonInput<TIO, TPresence, TStorage>
+    input: PluvRoomAddonInput<TIO, TPresence, TStorage>,
 ) => Partial<PluvRoomAddonResult>;
 
 export interface PluvRoomAddonInput<
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 > {
     room: PluvRoom<TIO, TPresence, TStorage>;
 }
@@ -131,7 +131,7 @@ export type PluvRoomDebug<TIO extends IOLike> = Id<{
 export type PluvRoomOptions<
     TIO extends IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 > = {
     addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
@@ -142,13 +142,13 @@ export type PluvRoomOptions<
 export type RoomConfig<
     TIO extends IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 > = RoomEndpoints<TIO> & PluvRoomOptions<TIO, TPresence, TStorage>;
 
 export class PluvRoom<
     TIO extends IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {}
+    TStorage extends Record<string, AbstractType<any>> = {},
 > extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO>;
 
@@ -218,7 +218,7 @@ export class PluvRoom<
                 this._clearTimeout(this._timeouts.reconnect);
                 this._timeouts.reconnect = setTimeout(
                     this._reconnect.bind(this),
-                    RECONNECT_TIMEOUT_MS
+                    RECONNECT_TIMEOUT_MS,
                 );
 
                 onAuthorizationFail?.(error);
@@ -239,7 +239,7 @@ export class PluvRoom<
 
     public broadcast<TEvent extends keyof InferIOInput<TIO>>(
         event: TEvent,
-        data: Id<InferIOInput<TIO>[TEvent]>
+        data: Id<InferIOInput<TIO>[TEvent]>,
     ): void {
         if (!this._state.webSocket) return;
         if (this._state.connection.state !== ConnectionState.Open) return;
@@ -272,6 +272,8 @@ export class PluvRoom<
         await this._storageStore.initialize();
         await this._applyStorageStore();
 
+        console.log(this._getWsEndpoint(this.id));
+
         const url = new URL(this._getWsEndpoint(this.id));
 
         let authToken: string | null = null;
@@ -330,7 +332,7 @@ export class PluvRoom<
 
     public event = <TEvent extends keyof InferIOOutput<TIO>>(
         event: TEvent,
-        callback: EventNotifierSubscriptionCallback<TIO, TEvent>
+        callback: EventNotifierSubscriptionCallback<TIO, TEvent>,
     ): (() => void) => {
         return this._eventNotifier.subscribe(event, callback);
     };
@@ -338,7 +340,7 @@ export class PluvRoom<
     public getConnection(): WebSocketConnection {
         // Create a read-only clone of the connection state
         return Object.freeze(
-            JSON.parse(JSON.stringify(this._state.connection))
+            JSON.parse(JSON.stringify(this._state.connection)),
         );
     }
 
@@ -351,7 +353,7 @@ export class PluvRoom<
     };
 
     public getOther = (
-        connectionId: string
+        connectionId: string,
     ): Id<UserInfo<TIO, TPresence>> | null => {
         return this._usersManager.getOther(connectionId);
     };
@@ -361,30 +363,30 @@ export class PluvRoom<
     };
 
     public getStorage = <TKey extends keyof TStorage>(
-        key: TKey
+        key: TKey,
     ): TStorage[TKey] | null => {
         return this._crdtManager?.get(key) ?? null;
     };
 
     public other = (
         connectionId: string,
-        callback: OtherNotifierSubscriptionCallback<TIO>
+        callback: OtherNotifierSubscriptionCallback<TIO>,
     ): (() => void) => {
         return this._otherNotifier.subscribe(connectionId, callback);
     };
 
     public storage = <TKey extends keyof TStorage>(
         key: TKey,
-        fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void
+        fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void,
     ): (() => void) => {
         return this._crdtNotifier.subscribe(key, fn);
     };
 
     public subscribe = <
-        TSubject extends keyof StateNotifierSubjects<TIO, TPresence>
+        TSubject extends keyof StateNotifierSubjects<TIO, TPresence>,
     >(
         name: TSubject,
-        callback: SubscriptionCallback<TIO, TPresence, TSubject>
+        callback: SubscriptionCallback<TIO, TPresence, TSubject>,
     ): (() => void) => {
         return this._stateNotifier.subscribe(name, callback);
     };
@@ -400,7 +402,7 @@ export class PluvRoom<
 
         this.broadcast(
             "$UPDATE_PRESENCE" as keyof InferIOInput<TIO>,
-            { presence } as any
+            { presence } as any,
         );
     };
 
@@ -435,11 +437,11 @@ export class PluvRoom<
 
         window.addEventListener(
             "online",
-            this._windowListeners.onNavigatorOnline
+            this._windowListeners.onNavigatorOnline,
         );
         document.addEventListener(
             "visibilitychange",
-            this._windowListeners.onVisibilityChange
+            this._windowListeners.onVisibilityChange,
         );
     }
 
@@ -455,19 +457,19 @@ export class PluvRoom<
 
         this._state.webSocket.addEventListener(
             "close",
-            this._wsListeners.onClose
+            this._wsListeners.onClose,
         );
         this._state.webSocket.addEventListener(
             "error",
-            this._wsListeners.onError
+            this._wsListeners.onError,
         );
         this._state.webSocket.addEventListener(
             "message",
-            this._wsListeners.onMessage
+            this._wsListeners.onMessage,
         );
         this._state.webSocket.addEventListener(
             "open",
-            this._wsListeners.onOpen
+            this._wsListeners.onOpen,
         );
     }
 
@@ -495,7 +497,7 @@ export class PluvRoom<
         this._usersManager.removeMyself();
 
         const canClose = [WebSocket.CONNECTING, WebSocket.OPEN].some(
-            (readyState) => readyState === this._state.webSocket?.readyState
+            (readyState) => readyState === this._state.webSocket?.readyState,
         );
 
         if (canClose) this._state.webSocket.close();
@@ -510,11 +512,11 @@ export class PluvRoom<
 
         window.removeEventListener(
             "online",
-            this._windowListeners.onNavigatorOnline
+            this._windowListeners.onNavigatorOnline,
         );
         document.removeEventListener(
             "visibilitychange",
-            this._windowListeners.onVisibilityChange
+            this._windowListeners.onVisibilityChange,
         );
 
         this._windowListeners = null;
@@ -525,19 +527,19 @@ export class PluvRoom<
 
         this._state.webSocket.removeEventListener(
             "close",
-            this._wsListeners.onClose
+            this._wsListeners.onClose,
         );
         this._state.webSocket.removeEventListener(
             "error",
-            this._wsListeners.onError
+            this._wsListeners.onError,
         );
         this._state.webSocket.removeEventListener(
             "message",
-            this._wsListeners.onMessage
+            this._wsListeners.onMessage,
         );
         this._state.webSocket.removeEventListener(
             "open",
-            this._wsListeners.onOpen
+            this._wsListeners.onOpen,
         );
 
         this._wsListeners = null;
@@ -567,18 +569,18 @@ export class PluvRoom<
 
             await this._storageStore.flatten(encodedState);
         },
-        { wait: ADD_TO_STORAGE_STATE_DEBOUNCE_MS }
+        { wait: ADD_TO_STORAGE_STATE_DEBOUNCE_MS },
     );
 
     private _getAddon = (
-        addons: readonly PluvRoomAddon<TIO, TPresence, TStorage>[]
+        addons: readonly PluvRoomAddon<TIO, TPresence, TStorage>[],
     ): PluvRoomAddon<TIO, TPresence, TStorage> => {
         return addons.reduce<PluvRoomAddon<TIO, TPresence, TStorage>>(
             (acc, addon) => () => ({
                 ...acc({ room: this }),
                 ...addon({ room: this }),
             }),
-            DEFAULT_PLUV_CLIENT_ADDON
+            DEFAULT_PLUV_CLIENT_ADDON,
         );
     };
 
@@ -623,7 +625,7 @@ export class PluvRoom<
             return await res.text().then((text) => text.trim());
         } catch (err) {
             throw new Error(
-                err instanceof Error ? err.message : "Room is unauthorized"
+                err instanceof Error ? err.message : "Room is unauthorized",
             );
         }
     }
@@ -668,7 +670,7 @@ export class PluvRoom<
 
         this._usersManager.patchPresence(
             connectionId,
-            data.presence as TPresence
+            data.presence as TPresence,
         );
 
         const myPresence = this._usersManager.myPresence;
@@ -709,7 +711,7 @@ export class PluvRoom<
             !!presence &&
                 this._usersManager.patchPresence(
                     connectionId,
-                    presence as TPresence
+                    presence as TPresence,
                 );
 
             this._otherNotifier.subject(connectionId).next(other);
@@ -737,7 +739,7 @@ export class PluvRoom<
 
         this._usersManager.setMyself(
             connectionId,
-            user as Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>
+            user as Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>,
         );
 
         const presence = this._usersManager.myPresence;
@@ -758,7 +760,7 @@ export class PluvRoom<
     }
 
     private async _handleStorageReceivedMessage(
-        message: IOEventMessage<TIO>
+        message: IOEventMessage<TIO>,
     ): Promise<void> {
         const { connectionId } = message;
 
@@ -839,7 +841,7 @@ export class PluvRoom<
         this._usersManager.setUser(
             connectionId,
             data.user,
-            data.presence as TPresence
+            data.presence as TPresence,
         );
 
         const other = this._usersManager.getOther(connectionId);
@@ -853,7 +855,7 @@ export class PluvRoom<
         this._clearTimeout(this._timeouts.pong);
         this._timeouts.pong = setTimeout(
             this._reconnect.bind(this),
-            PONG_TIMEOUT_MS
+            PONG_TIMEOUT_MS,
         );
 
         this._sendMessage({ type: "$PING", data: {} });
@@ -890,7 +892,7 @@ export class PluvRoom<
                     type: "$UPDATE_STORAGE",
                     data: { origin, update },
                 });
-            }
+            },
         );
 
         this._subscriptions.observeCrdt = unsubscribe;
@@ -1015,7 +1017,7 @@ export class PluvRoom<
         this._clearInterval(this._intervals.heartbeat);
         this._intervals.heartbeat = setInterval(
             this._heartbeat.bind(this),
-            HEARTBEAT_INTERVAL_MS
+            HEARTBEAT_INTERVAL_MS,
         );
     }
 
@@ -1090,7 +1092,7 @@ export class PluvRoom<
     }
 
     private _sendMessage<
-        TMessage extends EventMessage<string, any> = EventMessage<string, any>
+        TMessage extends EventMessage<string, any> = EventMessage<string, any>,
     >(data: TMessage): void {
         const webSocket = this._state.webSocket;
 
@@ -1109,13 +1111,13 @@ export class PluvRoom<
     }
 
     private _updateState(
-        updater: (oldState: WebSocketState<TIO>) => WebSocketState<TIO>
+        updater: (oldState: WebSocketState<TIO>) => WebSocketState<TIO>,
     ): WebSocketState<TIO> {
         let authorization: AuthorizationState<TIO>;
 
         try {
             authorization = JSON.parse(
-                JSON.stringify(this._state.authorization)
+                JSON.stringify(this._state.authorization),
             );
         } catch {
             throw new Error("User is not JSON serializable");

package/src/y.ts

@@ -1 +1,9 @@
-export { array, map, text, object } from "@pluv/crdt-yjs";
+export {
+    array,
+    map,
+    object,
+    text,
+    xmlElement,
+    xmlFragment,
+    xmlText,
+} from "@pluv/crdt-yjs";