@pluv/client 0.29.0 → 0.30.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.29.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.30.0 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 46.50 KB
-ESM ⚡️ Build success in 106ms
-CJS dist/index.js 47.76 KB
+CJS dist/index.js 48.17 KB
 CJS ⚡️ Build success in 106ms
+ESM dist/index.mjs 46.91 KB
+ESM ⚡️ Build success in 111ms
 DTS Build start
-DTS ⚡️ Build success in 3547ms
-DTS dist/index.d.mts 22.06 KB
-DTS dist/index.d.ts  22.06 KB
+DTS ⚡️ Build success in 3475ms
+DTS dist/index.d.mts 22.35 KB
+DTS dist/index.d.ts  22.35 KB

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @pluv/client
 
+## 0.30.0
+
+### Patch Changes
+
+- cff933a: Add `publicKey` property to `createClient` for later usage ;)
+  - @pluv/crdt@0.30.0
+  - @pluv/types@0.30.0
+
 ## 0.29.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -184,6 +184,7 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
+    publicKey?: string;
     router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
 } & RoomEndpoints<TIO, TMetadata> & Pick<CrdtManagerOptions<TStorage>, "initialStorage"> & UsersManagerConfig<TPresence> & (keyof TMetadata extends never ? {
     metadata?: undefined;
@@ -192,23 +193,24 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
 })>;
 declare class PluvRoom<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO, TMetadata>;
-    private _crdtManager;
-    private _crdtNotifier;
-    private _debug;
-    private _eventNotifier;
-    private _intervals;
-    private _listeners;
-    private _metadata;
-    private _otherNotifier;
-    private _router;
+    private readonly _crdtManager;
+    private readonly _crdtNotifier;
+    private readonly _debug;
+    private readonly _eventNotifier;
+    private readonly _intervals;
+    private readonly _listeners;
+    private readonly _metadata;
+    private readonly _otherNotifier;
+    private readonly _publicKey;
+    private readonly _router;
+    private readonly _stateNotifier;
+    private readonly _storageStore;
+    private readonly _subscriptions;
+    private readonly _timeouts;
+    private readonly _usersManager;
     private _state;
-    private _stateNotifier;
-    private _storageStore;
-    private _subscriptions;
-    private _timeouts;
     private _windowListeners;
     private _wsListeners;
-    private _usersManager;
     constructor(room: string, options: RoomConfig<TIO, TMetadata, TPresence, TStorage, TEvents>);
     get storageLoaded(): boolean;
     get webSocket(): WebSocket | null;
@@ -297,6 +299,7 @@ type PluvClientOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
+    publicKey?: string;
 };
 type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
@@ -311,12 +314,13 @@ type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
     metadata: TMetadata;
 });
 declare class PluvClient<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
-    private _authEndpoint;
-    private _debug;
-    private _initialStorage?;
-    private _presence?;
-    private _wsEndpoint;
-    private _rooms;
+    private readonly _authEndpoint;
+    private readonly _debug;
+    private readonly _initialStorage?;
+    private readonly _presence?;
+    private readonly _publicKey;
+    private readonly _rooms;
+    private readonly _wsEndpoint;
     get _defs(): {
         initialStorage: AbstractCrdtDocFactory<TStorage> | undefined;
     };

package/dist/index.d.ts

@@ -184,6 +184,7 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
+    publicKey?: string;
     router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
 } & RoomEndpoints<TIO, TMetadata> & Pick<CrdtManagerOptions<TStorage>, "initialStorage"> & UsersManagerConfig<TPresence> & (keyof TMetadata extends never ? {
     metadata?: undefined;
@@ -192,23 +193,24 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
 })>;
 declare class PluvRoom<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO, TMetadata>;
-    private _crdtManager;
-    private _crdtNotifier;
-    private _debug;
-    private _eventNotifier;
-    private _intervals;
-    private _listeners;
-    private _metadata;
-    private _otherNotifier;
-    private _router;
+    private readonly _crdtManager;
+    private readonly _crdtNotifier;
+    private readonly _debug;
+    private readonly _eventNotifier;
+    private readonly _intervals;
+    private readonly _listeners;
+    private readonly _metadata;
+    private readonly _otherNotifier;
+    private readonly _publicKey;
+    private readonly _router;
+    private readonly _stateNotifier;
+    private readonly _storageStore;
+    private readonly _subscriptions;
+    private readonly _timeouts;
+    private readonly _usersManager;
     private _state;
-    private _stateNotifier;
-    private _storageStore;
-    private _subscriptions;
-    private _timeouts;
     private _windowListeners;
     private _wsListeners;
-    private _usersManager;
     constructor(room: string, options: RoomConfig<TIO, TMetadata, TPresence, TStorage, TEvents>);
     get storageLoaded(): boolean;
     get webSocket(): WebSocket | null;
@@ -297,6 +299,7 @@ type PluvClientOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
+    publicKey?: string;
 };
 type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
@@ -311,12 +314,13 @@ type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
     metadata: TMetadata;
 });
 declare class PluvClient<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
-    private _authEndpoint;
-    private _debug;
-    private _initialStorage?;
-    private _presence?;
-    private _wsEndpoint;
-    private _rooms;
+    private readonly _authEndpoint;
+    private readonly _debug;
+    private readonly _initialStorage?;
+    private readonly _presence?;
+    private readonly _publicKey;
+    private readonly _rooms;
+    private readonly _wsEndpoint;
     get _defs(): {
         initialStorage: AbstractCrdtDocFactory<TStorage> | undefined;
     };

package/dist/index.js

@@ -446,6 +446,7 @@ var PluvRoom = class extends AbstractRoom {
       metadata,
       onAuthorizationFail,
       presence,
+      publicKey,
       router,
       wsEndpoint
     } = options;
@@ -457,6 +458,15 @@ var PluvRoom = class extends AbstractRoom {
     };
     this._metadata = {};
     this._otherNotifier = new OtherNotifier();
+    this._publicKey = null;
+    this._stateNotifier = new StateNotifier();
+    this._subscriptions = {
+      observeCrdt: null
+    };
+    this._timeouts = {
+      pong: null,
+      reconnect: null
+    };
     this._state = {
       authorization: {
         token: null,
@@ -469,14 +479,6 @@ var PluvRoom = class extends AbstractRoom {
       },
       webSocket: null
     };
-    this._stateNotifier = new StateNotifier();
-    this._subscriptions = {
-      observeCrdt: null
-    };
-    this._timeouts = {
-      pong: null,
-      reconnect: null
-    };
     this._windowListeners = null;
     this._wsListeners = null;
     this.broadcast = new Proxy(
@@ -612,7 +614,8 @@ var PluvRoom = class extends AbstractRoom {
     this._debug = debug;
     this._endpoints = { authEndpoint, wsEndpoint };
     this._storageStore = storage;
-    if (!!metadata) this._metadata = metadata;
+    if (typeof metadata !== "undefined") this._metadata = metadata;
+    if (typeof publicKey === "string") this._publicKey = publicKey;
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -652,6 +655,7 @@ var PluvRoom = class extends AbstractRoom {
       try {
         authToken = yield this._getAuthorization(this.id);
         authToken && url.searchParams.set("token", encodeURIComponent(authToken));
+        this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
         webSocket = new WebSocket(url.toString());
       } catch (err) {
         yield this._storageStore.destroy();
@@ -1180,8 +1184,10 @@ var PluvRoom = class extends AbstractRoom {
 // src/PluvClient.ts
 var PluvClient = class {
   constructor(options) {
+    this._publicKey = null;
     this._rooms = /* @__PURE__ */ new Map();
     this.createRoom = (room, options) => {
+      var _a;
       const oldRoom = this.getRoom(room);
       if (oldRoom) return oldRoom;
       const newRoom = new PluvRoom(room, {
@@ -1193,6 +1199,7 @@ var PluvClient = class {
         metadata: options.metadata,
         onAuthorizationFail: options.onAuthorizationFail,
         presence: this._presence,
+        publicKey: (_a = this._publicKey) != null ? _a : void 0,
         router: options.router,
         wsEndpoint: this._wsEndpoint
       });
@@ -1222,12 +1229,13 @@ var PluvClient = class {
       this._rooms.delete(toLeave.id);
       this._logDebug(`Left and deleted room: ${room}`);
     });
-    const { authEndpoint, debug = false, initialStorage, presence, wsEndpoint } = options;
+    const { authEndpoint, debug = false, initialStorage, presence, publicKey, wsEndpoint } = options;
     this._authEndpoint = authEndpoint;
     this._debug = debug;
     this._initialStorage = initialStorage;
     this._presence = presence;
     this._wsEndpoint = wsEndpoint;
+    if (typeof publicKey === "string") this._publicKey = publicKey;
   }
   get _defs() {
     return {

package/dist/index.mjs

@@ -417,6 +417,7 @@ var PluvRoom = class extends AbstractRoom {
       metadata,
       onAuthorizationFail,
       presence,
+      publicKey,
       router,
       wsEndpoint
     } = options;
@@ -428,6 +429,15 @@ var PluvRoom = class extends AbstractRoom {
     };
     this._metadata = {};
     this._otherNotifier = new OtherNotifier();
+    this._publicKey = null;
+    this._stateNotifier = new StateNotifier();
+    this._subscriptions = {
+      observeCrdt: null
+    };
+    this._timeouts = {
+      pong: null,
+      reconnect: null
+    };
     this._state = {
       authorization: {
         token: null,
@@ -440,14 +450,6 @@ var PluvRoom = class extends AbstractRoom {
       },
       webSocket: null
     };
-    this._stateNotifier = new StateNotifier();
-    this._subscriptions = {
-      observeCrdt: null
-    };
-    this._timeouts = {
-      pong: null,
-      reconnect: null
-    };
     this._windowListeners = null;
     this._wsListeners = null;
     this.broadcast = new Proxy(
@@ -583,7 +585,8 @@ var PluvRoom = class extends AbstractRoom {
     this._debug = debug;
     this._endpoints = { authEndpoint, wsEndpoint };
     this._storageStore = storage;
-    if (!!metadata) this._metadata = metadata;
+    if (typeof metadata !== "undefined") this._metadata = metadata;
+    if (typeof publicKey === "string") this._publicKey = publicKey;
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -623,6 +626,7 @@ var PluvRoom = class extends AbstractRoom {
       try {
         authToken = yield this._getAuthorization(this.id);
         authToken && url.searchParams.set("token", encodeURIComponent(authToken));
+        this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
         webSocket = new WebSocket(url.toString());
       } catch (err) {
         yield this._storageStore.destroy();
@@ -1151,8 +1155,10 @@ var PluvRoom = class extends AbstractRoom {
 // src/PluvClient.ts
 var PluvClient = class {
   constructor(options) {
+    this._publicKey = null;
     this._rooms = /* @__PURE__ */ new Map();
     this.createRoom = (room, options) => {
+      var _a;
       const oldRoom = this.getRoom(room);
       if (oldRoom) return oldRoom;
       const newRoom = new PluvRoom(room, {
@@ -1164,6 +1170,7 @@ var PluvClient = class {
         metadata: options.metadata,
         onAuthorizationFail: options.onAuthorizationFail,
         presence: this._presence,
+        publicKey: (_a = this._publicKey) != null ? _a : void 0,
         router: options.router,
         wsEndpoint: this._wsEndpoint
       });
@@ -1193,12 +1200,13 @@ var PluvClient = class {
       this._rooms.delete(toLeave.id);
       this._logDebug(`Left and deleted room: ${room}`);
     });
-    const { authEndpoint, debug = false, initialStorage, presence, wsEndpoint } = options;
+    const { authEndpoint, debug = false, initialStorage, presence, publicKey, wsEndpoint } = options;
     this._authEndpoint = authEndpoint;
     this._debug = debug;
     this._initialStorage = initialStorage;
     this._presence = presence;
     this._wsEndpoint = wsEndpoint;
+    if (typeof publicKey === "string") this._publicKey = publicKey;
   }
   get _defs() {
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,15 +18,15 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.29.0",
-    "@pluv/types": "^0.29.0"
+    "@pluv/crdt": "^0.30.0",
+    "@pluv/types": "^0.30.0"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@pluv/tsconfig": "^0.29.0",
-    "eslint-config-pluv": "^0.29.0"
+    "@pluv/tsconfig": "^0.30.0",
+    "eslint-config-pluv": "^0.30.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvClient.ts

@@ -22,6 +22,7 @@ export type PluvClientOptions<
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
+    publicKey?: string;
 };
 
 export type CreateRoomOptions<
@@ -45,13 +46,13 @@ export class PluvClient<
     TStorage extends Record<string, CrdtType<any, any>> = {},
     TMetadata extends JsonObject = {},
 > {
-    private _authEndpoint: AuthEndpoint<TMetadata> | undefined;
-    private _debug: boolean;
-    private _initialStorage?: AbstractCrdtDocFactory<TStorage>;
-    private _presence?: InputZodLike<TPresence>;
-    private _wsEndpoint: WsEndpoint<TMetadata> | undefined;
-
-    private _rooms = new Map<string, PluvRoom<TIO, TMetadata, TPresence, TStorage, any>>();
+    private readonly _authEndpoint: AuthEndpoint<TMetadata> | undefined;
+    private readonly _debug: boolean;
+    private readonly _initialStorage?: AbstractCrdtDocFactory<TStorage>;
+    private readonly _presence?: InputZodLike<TPresence>;
+    private readonly _publicKey: string | null = null;
+    private readonly _rooms = new Map<string, PluvRoom<TIO, TMetadata, TPresence, TStorage, any>>();
+    private readonly _wsEndpoint: WsEndpoint<TMetadata> | undefined;
 
     public get _defs() {
         return {
@@ -64,13 +65,15 @@ export class PluvClient<
     }
 
     constructor(options: PluvClientOptions<TIO, TPresence, TStorage, TMetadata>) {
-        const { authEndpoint, debug = false, initialStorage, presence, wsEndpoint } = options;
+        const { authEndpoint, debug = false, initialStorage, presence, publicKey, wsEndpoint } = options;
 
         this._authEndpoint = authEndpoint as AuthEndpoint<TMetadata>;
         this._debug = debug;
         this._initialStorage = initialStorage;
         this._presence = presence;
         this._wsEndpoint = wsEndpoint;
+
+        if (typeof publicKey === "string") this._publicKey = publicKey;
     }
 
     public createRoom = <TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}>(
@@ -90,6 +93,7 @@ export class PluvClient<
             metadata: options.metadata,
             onAuthorizationFail: options.onAuthorizationFail,
             presence: this._presence,
+            publicKey: this._publicKey ?? undefined,
             router: options.router,
             wsEndpoint: this._wsEndpoint,
         } as RoomConfig<TIO, TMetadata, TPresence, TStorage, TEvents>);

package/src/PluvRoom.ts

@@ -147,6 +147,7 @@ export type RoomConfig<
         addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
         debug?: boolean | PluvRoomDebug<TIO>;
         onAuthorizationFail?: (error: Error) => void;
+        publicKey?: string;
         router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
     } & RoomEndpoints<TIO, TMetadata> &
         Pick<CrdtManagerOptions<TStorage>, "initialStorage"> &
@@ -163,17 +164,29 @@ export class PluvRoom<
 > extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO, TMetadata>;
 
-    private _crdtManager: CrdtManager<TStorage>;
-    private _crdtNotifier = new CrdtNotifier<TStorage>();
-    private _debug: boolean | PluvRoomDebug<TIO>;
-    private _eventNotifier = new EventNotifier<MergeEvents<TEvents, TIO>>();
-    private _intervals: IntervalIds = {
+    private readonly _crdtManager: CrdtManager<TStorage>;
+    private readonly _crdtNotifier = new CrdtNotifier<TStorage>();
+    private readonly _debug: boolean | PluvRoomDebug<TIO>;
+    private readonly _eventNotifier = new EventNotifier<MergeEvents<TEvents, TIO>>();
+    private readonly _intervals: IntervalIds = {
         heartbeat: null,
     };
-    private _listeners: InternalListeners;
-    private _metadata: TMetadata = {} as TMetadata;
-    private _otherNotifier = new OtherNotifier<TIO>();
-    private _router: PluvRouter<TIO, TPresence, TStorage, TEvents>;
+    private readonly _listeners: InternalListeners;
+    private readonly _metadata: TMetadata = {} as TMetadata;
+    private readonly _otherNotifier = new OtherNotifier<TIO>();
+    private readonly _publicKey: string | null = null;
+    private readonly _router: PluvRouter<TIO, TPresence, TStorage, TEvents>;
+    private readonly _stateNotifier = new StateNotifier<TIO, TPresence>();
+    private readonly _storageStore: AbstractStorageStore;
+    private readonly _subscriptions: InternalSubscriptions = {
+        observeCrdt: null,
+    };
+    private readonly _timeouts: TimeoutIds = {
+        pong: null,
+        reconnect: null,
+    };
+    private readonly _usersManager: UsersManager<TIO, TPresence>;
+
     private _state: WebSocketState<TIO> = {
         authorization: {
             token: null,
@@ -186,18 +199,8 @@ export class PluvRoom<
         },
         webSocket: null,
     };
-    private _stateNotifier = new StateNotifier<TIO, TPresence>();
-    private _storageStore: AbstractStorageStore;
-    private _subscriptions: InternalSubscriptions = {
-        observeCrdt: null,
-    };
-    private _timeouts: TimeoutIds = {
-        pong: null,
-        reconnect: null,
-    };
     private _windowListeners: WindowListeners | null = null;
     private _wsListeners: WebSocketListeners | null = null;
-    private _usersManager: UsersManager<TIO, TPresence>;
 
     constructor(room: string, options: RoomConfig<TIO, TMetadata, TPresence, TStorage, TEvents>) {
         const {
@@ -209,6 +212,7 @@ export class PluvRoom<
             metadata,
             onAuthorizationFail,
             presence,
+            publicKey,
             router,
             wsEndpoint,
         } = options;
@@ -226,7 +230,8 @@ export class PluvRoom<
         this._endpoints = { authEndpoint, wsEndpoint } as RoomEndpoints<TIO, TMetadata>;
         this._storageStore = storage;
 
-        if (!!metadata) this._metadata = metadata;
+        if (typeof metadata !== "undefined") this._metadata = metadata;
+        if (typeof publicKey === "string") this._publicKey = publicKey;
 
         this._listeners = {
             onAuthorizationFail: (error) => {
@@ -348,6 +353,7 @@ export class PluvRoom<
             authToken = await this._getAuthorization(this.id);
 
             authToken && url.searchParams.set("token", encodeURIComponent(authToken));
+            this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
 
             webSocket = new WebSocket(url.toString());
         } catch (err) {