@pluv/io 0.40.1 → 0.41.0

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @pluv/io@0.40.1 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.41.0 build /home/runner/work/pluv/pluv/packages/io
 > pnpm run version && tsup src/index.ts --format esm,cjs --dts
 
 
-> @pluv/io@0.40.1 version /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.41.0 version /home/runner/work/pluv/pluv/packages/io
 > genversion ./src/version.generated.ts --esm
 
 CLI Building entry: src/index.ts
@@ -12,11 +12,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 44.38 KB
-ESM ⚡️ Build success in 141ms
-CJS dist/index.js 46.56 KB
-CJS ⚡️ Build success in 141ms
+CJS dist/index.js 51.27 KB
+CJS ⚡️ Build success in 95ms
+ESM dist/index.mjs 49.09 KB
+ESM ⚡️ Build success in 106ms
 DTS Build start
-DTS ⚡️ Build success in 2536ms
-DTS dist/index.d.mts 30.93 KB
-DTS dist/index.d.ts  30.93 KB
+DTS ⚡️ Build success in 2982ms
+DTS dist/index.d.mts 31.42 KB
+DTS dist/index.d.ts  31.42 KB

package/CHANGELOG.md

@@ -1,5 +1,74 @@
 # @pluv/io
 
+## 0.41.0
+
+### Minor Changes
+
+- 73adf21: **BREAKING** The `user` that is provided to `PluvServer.createToken` is now limited to be at most 512 bytes. If the `user` is any larger, `PluvServer.createToken` will now throw an error.
+- f02a430: **BREAKING** Updated the way `user` is stored and read from the websocket, so now `user` is persisted in-memory rather than from persistent storage (improves performance and lowers cost in some cases). This change primarily affects pluv platforms, which are intended for internal use only, and therefore should be mostly non-breaking.
+- 0b908b3: **BREAKING** User's presence is now limited to be at most 512 bytes. If the presence is any larger, the `PluvServer` will now throw an error.
+- 555b88d: Users can now have multiple simultaneous connections. Previously, if a user tried to open a connection to a room while already being connected to the room, the new connection would be blocked. Now, when the user opens another connection, the new connection will be opened and initialized with their latest presence.
+
+  Users can only have 1 identity and 1 presence, which means that all presence updates will sync across all of that user's connections. This means that even when a user opens multiple connections, they will only appear once in `others`.
+
+### Patch Changes
+
+- 6422f3b: In certain edge-cases, WebSocket connections can silently die in all runtimes, causing connected clients to see the presence of other connections that aren't connected anymore.
+
+  The `IORoom` now automatically garbage collects dead websockets that haven't been pinged in a long time. Garbage collection happens on WebSocket ping/pong messages every 60 seconds.
+
+  However, garbage collection does not automatically happen for Cloudflare Worker Durable Objects using websocket hiberation because ping/pong messages happen outside of the Durable Object's compute. Therefore `IORoom` now provides a method `garbageCollect` that can be called manually to clear any dead websockets whenever the user chooses.
+
+  For example, within a Cloudflare Worker Durable Object, an [alarm](https://developers.cloudflare.com/durable-objects/api/alarms/) can be set to periodically run garbage collection for you:
+
+  ```ts
+  import { InferIORoom } from "@pluv/io";
+
+  class RoomDurableObject extends DurableObject {
+    private _room: InferIORoom<typeof ioServer>;
+
+    constructor(state: DurableObjectState, env: Env) {
+      super(state, env);
+
+      this._room = io.createRoom(state.id.toString(), { env, state });
+    }
+
+    // ... WebSocket handlers here
+
+    async fetch(request: Request): Promise<Response> {
+      // ... WebSocket validation and pair creation here
+
+      const alarm = await this.ctx.storage.getAlarm();
+
+      // Start running the garbage collection interval
+      if (alarm !== null) await this.ctx.storage.setAlarm(Date.now() + 60_000);
+
+      await this._room.register(server, { env: this.env, request });
+
+      // ... Return response
+    }
+
+    async alarm(): Promise<void> {
+      await this._room.garbageCollect();
+
+      // Garbage collect every 1 minute
+      await this.ctx.storage.setAlarm(Date.now() + 60_000);
+    }
+  }
+  ```
+
+- a663c65: Update websocket session connection ids to be deterministic based on the user's id if authorization is configured (i.e. connection id will now just be the user's id with a prefix).
+- 555b88d: Added a new field `presence` to the server's event resolver context to view the message sender's currently known presence.
+  - @pluv/crdt@0.41.0
+  - @pluv/types@0.41.0
+
+## 0.40.2
+
+### Patch Changes
+
+- @pluv/crdt@0.40.2
+- @pluv/types@0.40.2
+
 ## 0.40.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, ProcedureLike, InputZodLike, IORouterLike, InferIOAuthorizeUser, BaseUser, UndefinedProps, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, InferIOInput, InferIOAuthorize } from '@pluv/types';
+import { JsonObject, IOAuthorize, InferIOAuthorizeUser, MaybePromise, IOEventMessage, EventRecord, ProcedureLike, InputZodLike, IORouterLike, BaseUser, UndefinedProps, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, InferIOInput, InferIOAuthorize } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { AbstractCrdtDocFactory, AbstractCrdtDoc } from '@pluv/crdt';
 
@@ -45,7 +45,7 @@ interface AbstractWebSocketConfig {
     platform: AbstractPlatform<any>;
     room: string;
 }
-declare abstract class AbstractWebSocket<TWebSocket = any> {
+declare abstract class AbstractWebSocket<TWebSocket = any, TAuthorize extends IOAuthorize<any, any> | null = null> {
     /** The connection is not yet open. */
     readonly CONNECTING = 0;
     /** The connection is open and ready to communicate. */
@@ -57,13 +57,14 @@ declare abstract class AbstractWebSocket<TWebSocket = any> {
     readonly persistence: AbstractPersistence;
     readonly room: string;
     readonly webSocket: TWebSocket;
-    private _user;
     protected readonly _platform: AbstractPlatform<this>;
     abstract set presence(presence: JsonObject | null);
     abstract get readyState(): 0 | 1 | 2 | 3;
+    abstract get session(): WebSocketSession<TAuthorize>;
     abstract get sessionId(): string;
     abstract get state(): WebSocketSerializedState;
     abstract set state(state: WebSocketSerializedState);
+    abstract set user(user: InferIOAuthorizeUser<TAuthorize>);
     constructor(webSocket: TWebSocket, config: AbstractWebSocketConfig);
     /**
      * TODO
@@ -78,7 +79,6 @@ declare abstract class AbstractWebSocket<TWebSocket = any> {
     abstract close(code?: number | undefined, reason?: string | undefined): void;
     abstract send(message: ArrayBuffer | ArrayBufferView | string): void;
     abstract terminate(): void;
-    getSession<TAuthorize extends IOAuthorize<any, any> | null>(): Promise<WebSocketSession<TAuthorize>>;
     handleError(params: AbstractWebSocketHandleErrorParams): void;
     sendMessage<TMessage extends IOEventMessage<any> = IOEventMessage<any>>(data: TMessage): void;
 }
@@ -119,12 +119,6 @@ declare class PluvRouter<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     private _isValidEventName;
 }
 
-declare global {
-    var console: {
-        error: (...data: any[]) => void;
-        log: (...data: any[]) => void;
-    };
-}
 type PluvContext<TPlatform extends AbstractPlatform, TContext extends Record<string, any>> = TContext | ((params: InferRoomContextType<TPlatform>) => TContext);
 interface CrdtLibraryType {
     doc: (value: any) => AbstractCrdtDocFactory<any>;
@@ -135,9 +129,12 @@ type EventResolver<TKind extends EventResolverKind = EventResolverKind, TPlatfor
 interface EventResolverContext<TKind extends EventResolverKind = EventResolverKind, TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null = null, TContext extends Record<string, any> = {}> {
     context: TContext;
     doc: AbstractCrdtDoc<any>;
+    garbageCollect: () => Promise<void>;
+    presence: JsonObject | null;
     room: string;
     session: TKind extends "sync" ? WebSocketSession<TAuthorize> | null : WebSocketSession<TAuthorize>;
     sessions: readonly WebSocketSession<TAuthorize>[];
+    time: number;
 }
 type SendMessageOptions = {
     type?: "broadcast";
@@ -149,6 +146,7 @@ type SendMessageOptions = {
 };
 interface WebSocketSessionTimers {
     ping: number;
+    presence: number | null;
 }
 interface WebSocketSerializedState {
     presence: JsonObject | null;
@@ -254,22 +252,22 @@ interface JWT<TUser extends BaseUser> {
     sub: string;
     user: TUser;
 }
-type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform> = {
+type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform<any, any>> = {
     maxAge?: number;
     room: string;
     user: TUser extends BaseUser ? TUser : "Error: Cannot create token without authorization!";
 } & InferInitContextType<TPlatform>;
 interface AuthorizeParams {
-    platform: AbstractPlatform;
+    platform: AbstractPlatform<any, any>;
     secret: string;
 }
 interface AuthorizeModule {
     decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
 }
 declare const authorize: (params: AuthorizeParams) => {
     decode: <TUser extends BaseUser>(jwt: string) => Promise<JWT<TUser> | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
 };
 
 type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<infer IAbstractWebSocket> ? IAbstractWebSocket : never;
@@ -284,7 +282,7 @@ type AbstractPlatformConfig<TRoomContext extends Record<string, any> = {}> = {
 interface ConvertWebSocketConfig {
     room: string;
 }
-declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = AbstractWebSocket, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}, TConfig extends PlatformConfig = PlatformConfig> {
+declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket<any, any> = AbstractWebSocket<any, any>, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}, TConfig extends PlatformConfig = PlatformConfig> {
     protected readonly _initContext: TInitContext | undefined;
     protected readonly _roomContext: TRoomContext | undefined;
     private _initialized;
@@ -296,8 +294,8 @@ declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = A
     abstract readonly _name: string;
     constructor(config?: AbstractPlatformConfig<TRoomContext>);
     abstract acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
-    abstract convertWebSocket(webSocket: InferWebSocketSource<TWebSocket>, config: ConvertWebSocketConfig): AbstractWebSocket;
-    abstract getLastPing(webSocket: AbstractWebSocket): number | null;
+    abstract convertWebSocket(webSocket: InferWebSocketSource<TWebSocket>, config: ConvertWebSocketConfig): AbstractWebSocket<any, any>;
+    abstract getLastPing(webSocket: AbstractWebSocket<any, any>): number | null;
     abstract getSerializedState(webSocket: InferWebSocketSource<TWebSocket>): WebSocketSerializedState | null;
     abstract getSessionId(webSocket: InferWebSocketSource<TWebSocket>): string | null;
     abstract getWebSockets(): readonly InferWebSocketSource<TWebSocket>[];
@@ -335,6 +333,7 @@ type WebSocketRegisterConfig<TPlatform extends AbstractPlatform<any> = AbstractP
 declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = null, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly id: string;
     private _doc;
+    private _lastGarbageCollectMs;
     private _uninitialize;
     private readonly _authorize;
     private readonly _context;
@@ -344,6 +343,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private readonly _platform;
     private readonly _router;
     private readonly _sessions;
+    private readonly _userSessionss;
     /**
      * @ignore
      * @readonly
@@ -368,6 +368,11 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
      * the room
      */
     evictAll(): Promise<void>;
+    /**
+     * @description The IORoom will garbage collect occasionally as connections ping/pong the
+     * server
+     */
+    garbageCollect(): Promise<void>;
     getSize(): number;
     onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => Promise<void>;
     onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => Promise<void>;
@@ -375,6 +380,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     register(webSocket: InferPlatformWebSocketSource<TPlatform>, ...options: keyof InferInitContextType<TPlatform> extends never ? [{
         token?: string;
     }?] : [WebSocketRegisterConfig<TPlatform>]): Promise<void>;
+    private _addUserSession;
     private _broadcast;
     private _closeWebSockets;
     private _emitQuitters;
@@ -384,6 +390,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _getAuthorizedUser;
     private _getInitialDoc;
     private _getIOAuthorize;
+    private _getLatestPresence;
     private _getProcedure;
     private _getProcedureInputs;
     private _getSession;
@@ -393,6 +400,8 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _onClose;
     private _onMessage;
     private _parseMessage;
+    private _setPresence;
+    private _removeUserSession;
     private _sendMessage;
     private _sendBroadcastMessage;
     private _sendSelfMessage;
@@ -400,7 +409,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
 }
 
 type InferIORoom<TServer extends PluvServer<any, any, any, any>> = TServer extends PluvServer<infer IPlatform, infer IAuthorize, infer IContext, infer IEvents> ? IORoom<IPlatform, IAuthorize, IContext, IEvents> : never;
-type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type PluvServerConfig<TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     authorize?: TAuthorize;
     context?: PluvContext<TPlatform, TContext>;
     crdt?: {
@@ -411,11 +420,11 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     debug?: boolean;
 };
-type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
-declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
+type CreateRoomOptions<TPlatform extends AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
+declare class PluvServer<TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly version: string;
     private readonly _authorize;
     private readonly _baseRouter;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, ProcedureLike, InputZodLike, IORouterLike, InferIOAuthorizeUser, BaseUser, UndefinedProps, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, InferIOInput, InferIOAuthorize } from '@pluv/types';
+import { JsonObject, IOAuthorize, InferIOAuthorizeUser, MaybePromise, IOEventMessage, EventRecord, ProcedureLike, InputZodLike, IORouterLike, BaseUser, UndefinedProps, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, InferIOInput, InferIOAuthorize } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { AbstractCrdtDocFactory, AbstractCrdtDoc } from '@pluv/crdt';
 
@@ -45,7 +45,7 @@ interface AbstractWebSocketConfig {
     platform: AbstractPlatform<any>;
     room: string;
 }
-declare abstract class AbstractWebSocket<TWebSocket = any> {
+declare abstract class AbstractWebSocket<TWebSocket = any, TAuthorize extends IOAuthorize<any, any> | null = null> {
     /** The connection is not yet open. */
     readonly CONNECTING = 0;
     /** The connection is open and ready to communicate. */
@@ -57,13 +57,14 @@ declare abstract class AbstractWebSocket<TWebSocket = any> {
     readonly persistence: AbstractPersistence;
     readonly room: string;
     readonly webSocket: TWebSocket;
-    private _user;
     protected readonly _platform: AbstractPlatform<this>;
     abstract set presence(presence: JsonObject | null);
     abstract get readyState(): 0 | 1 | 2 | 3;
+    abstract get session(): WebSocketSession<TAuthorize>;
     abstract get sessionId(): string;
     abstract get state(): WebSocketSerializedState;
     abstract set state(state: WebSocketSerializedState);
+    abstract set user(user: InferIOAuthorizeUser<TAuthorize>);
     constructor(webSocket: TWebSocket, config: AbstractWebSocketConfig);
     /**
      * TODO
@@ -78,7 +79,6 @@ declare abstract class AbstractWebSocket<TWebSocket = any> {
     abstract close(code?: number | undefined, reason?: string | undefined): void;
     abstract send(message: ArrayBuffer | ArrayBufferView | string): void;
     abstract terminate(): void;
-    getSession<TAuthorize extends IOAuthorize<any, any> | null>(): Promise<WebSocketSession<TAuthorize>>;
     handleError(params: AbstractWebSocketHandleErrorParams): void;
     sendMessage<TMessage extends IOEventMessage<any> = IOEventMessage<any>>(data: TMessage): void;
 }
@@ -119,12 +119,6 @@ declare class PluvRouter<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     private _isValidEventName;
 }
 
-declare global {
-    var console: {
-        error: (...data: any[]) => void;
-        log: (...data: any[]) => void;
-    };
-}
 type PluvContext<TPlatform extends AbstractPlatform, TContext extends Record<string, any>> = TContext | ((params: InferRoomContextType<TPlatform>) => TContext);
 interface CrdtLibraryType {
     doc: (value: any) => AbstractCrdtDocFactory<any>;
@@ -135,9 +129,12 @@ type EventResolver<TKind extends EventResolverKind = EventResolverKind, TPlatfor
 interface EventResolverContext<TKind extends EventResolverKind = EventResolverKind, TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null = null, TContext extends Record<string, any> = {}> {
     context: TContext;
     doc: AbstractCrdtDoc<any>;
+    garbageCollect: () => Promise<void>;
+    presence: JsonObject | null;
     room: string;
     session: TKind extends "sync" ? WebSocketSession<TAuthorize> | null : WebSocketSession<TAuthorize>;
     sessions: readonly WebSocketSession<TAuthorize>[];
+    time: number;
 }
 type SendMessageOptions = {
     type?: "broadcast";
@@ -149,6 +146,7 @@ type SendMessageOptions = {
 };
 interface WebSocketSessionTimers {
     ping: number;
+    presence: number | null;
 }
 interface WebSocketSerializedState {
     presence: JsonObject | null;
@@ -254,22 +252,22 @@ interface JWT<TUser extends BaseUser> {
     sub: string;
     user: TUser;
 }
-type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform> = {
+type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform<any, any>> = {
     maxAge?: number;
     room: string;
     user: TUser extends BaseUser ? TUser : "Error: Cannot create token without authorization!";
 } & InferInitContextType<TPlatform>;
 interface AuthorizeParams {
-    platform: AbstractPlatform;
+    platform: AbstractPlatform<any, any>;
     secret: string;
 }
 interface AuthorizeModule {
     decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
 }
 declare const authorize: (params: AuthorizeParams) => {
     decode: <TUser extends BaseUser>(jwt: string) => Promise<JWT<TUser> | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
 };
 
 type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<infer IAbstractWebSocket> ? IAbstractWebSocket : never;
@@ -284,7 +282,7 @@ type AbstractPlatformConfig<TRoomContext extends Record<string, any> = {}> = {
 interface ConvertWebSocketConfig {
     room: string;
 }
-declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = AbstractWebSocket, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}, TConfig extends PlatformConfig = PlatformConfig> {
+declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket<any, any> = AbstractWebSocket<any, any>, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}, TConfig extends PlatformConfig = PlatformConfig> {
     protected readonly _initContext: TInitContext | undefined;
     protected readonly _roomContext: TRoomContext | undefined;
     private _initialized;
@@ -296,8 +294,8 @@ declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = A
     abstract readonly _name: string;
     constructor(config?: AbstractPlatformConfig<TRoomContext>);
     abstract acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
-    abstract convertWebSocket(webSocket: InferWebSocketSource<TWebSocket>, config: ConvertWebSocketConfig): AbstractWebSocket;
-    abstract getLastPing(webSocket: AbstractWebSocket): number | null;
+    abstract convertWebSocket(webSocket: InferWebSocketSource<TWebSocket>, config: ConvertWebSocketConfig): AbstractWebSocket<any, any>;
+    abstract getLastPing(webSocket: AbstractWebSocket<any, any>): number | null;
     abstract getSerializedState(webSocket: InferWebSocketSource<TWebSocket>): WebSocketSerializedState | null;
     abstract getSessionId(webSocket: InferWebSocketSource<TWebSocket>): string | null;
     abstract getWebSockets(): readonly InferWebSocketSource<TWebSocket>[];
@@ -335,6 +333,7 @@ type WebSocketRegisterConfig<TPlatform extends AbstractPlatform<any> = AbstractP
 declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = null, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly id: string;
     private _doc;
+    private _lastGarbageCollectMs;
     private _uninitialize;
     private readonly _authorize;
     private readonly _context;
@@ -344,6 +343,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private readonly _platform;
     private readonly _router;
     private readonly _sessions;
+    private readonly _userSessionss;
     /**
      * @ignore
      * @readonly
@@ -368,6 +368,11 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
      * the room
      */
     evictAll(): Promise<void>;
+    /**
+     * @description The IORoom will garbage collect occasionally as connections ping/pong the
+     * server
+     */
+    garbageCollect(): Promise<void>;
     getSize(): number;
     onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => Promise<void>;
     onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => Promise<void>;
@@ -375,6 +380,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     register(webSocket: InferPlatformWebSocketSource<TPlatform>, ...options: keyof InferInitContextType<TPlatform> extends never ? [{
         token?: string;
     }?] : [WebSocketRegisterConfig<TPlatform>]): Promise<void>;
+    private _addUserSession;
     private _broadcast;
     private _closeWebSockets;
     private _emitQuitters;
@@ -384,6 +390,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _getAuthorizedUser;
     private _getInitialDoc;
     private _getIOAuthorize;
+    private _getLatestPresence;
     private _getProcedure;
     private _getProcedureInputs;
     private _getSession;
@@ -393,6 +400,8 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _onClose;
     private _onMessage;
     private _parseMessage;
+    private _setPresence;
+    private _removeUserSession;
     private _sendMessage;
     private _sendBroadcastMessage;
     private _sendSelfMessage;
@@ -400,7 +409,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
 }
 
 type InferIORoom<TServer extends PluvServer<any, any, any, any>> = TServer extends PluvServer<infer IPlatform, infer IAuthorize, infer IContext, infer IEvents> ? IORoom<IPlatform, IAuthorize, IContext, IEvents> : never;
-type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type PluvServerConfig<TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     authorize?: TAuthorize;
     context?: PluvContext<TPlatform, TContext>;
     crdt?: {
@@ -411,11 +420,11 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     debug?: boolean;
 };
-type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
-declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
+type CreateRoomOptions<TPlatform extends AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
+declare class PluvServer<TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly version: string;
     private readonly _authorize;
     private readonly _baseRouter;