@pluv/client 2.1.0 → 2.2.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { CrdtType, AbstractCrdtDocFactory, NoopCrdtDocFactory, InferStorage, InferCrdtJson } from '@pluv/crdt';
+import { AbstractCrdtDocFactory, InferDocLike, NoopCrdtDocFactory, InferStorage, InferDoc, InferCrdtJson } from '@pluv/crdt';
 export { CrdtType, InferCrdtJson } from '@pluv/crdt';
-import { IOLike, JsonObject, EventRecord, CrdtDocLike, UserInfo, MaybePromise, Id, ConnectionState, ProcedureLike, InputZodLike, IORouterLike, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, RoomLike, InferIOOutput, InferIOInput, BroadcastProxy, EventProxy, OtherSubscriptionCallback, StorageProxy, SubscribeProxy, UpdateMyPresenceAction, MergeEvents } from '@pluv/types';
-export { BaseUser, ConnectionState, EventMessage, EventNotifierSubscriptionCallback, EventRecord, IOEventMessage, MergeEvents, RoomLike, UserInfo, WebSocketState } from '@pluv/types';
+import { IOLike, JsonObject, EventRecord, CrdtDocLike, UserInfo, MaybePromise, Id, ProcedureLike, InputZodLike, IORouterLike, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, RoomLike, InferIOOutput, InferIOInput, RoomEventListenerMap, BroadcastProxy, EventProxy, WebSocketConnection, OtherSubscriptionCallback, StorageProxy, SubscribeProxy, UpdateMyPresenceAction, MergeEvents } from '@pluv/types';
+export { BaseUser, ConnectionState, EventMessage, EventNotifierSubscriptionCallback, EventRecord, IOEventMessage, MergeEvents, RoomLike, UserInfo, WebSocketConnection, WebSocketState } from '@pluv/types';
 
 declare abstract class AbstractStorageStore {
     room: string;
@@ -21,9 +21,9 @@ type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
 };
 declare const infer: <TIO extends IOLike<any, any>>(callback: InferCallback<TIO>) => InferCallback<TIO>;
 
-type EventResolver<TIO extends IOLike = IOLike, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = (data: TInput, context: EventResolverContext<TIO, TPresence, TStorage>) => MaybePromise<TOutput | void>;
-interface EventResolverContext<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
-    doc: CrdtDocLike<TStorage>;
+type EventResolver<TIO extends IOLike, TInput extends JsonObject, TOutput extends EventRecord<string, any>, TPresence extends Record<string, any>, TDocLike extends CrdtDocLike<any, any>> = (data: TInput, context: EventResolverContext<TIO, TPresence, TDocLike>) => MaybePromise<TOutput | void>;
+interface EventResolverContext<TIO extends IOLike, TPresence extends Record<string, any>, TDocLike extends CrdtDocLike<any, any>> {
+    doc: TDocLike;
     others: readonly UserInfo<TIO, TPresence>[];
     room: string;
     user: UserInfo<TIO, TPresence>;
@@ -45,65 +45,47 @@ interface PublicKeyParams<TMetadata extends JsonObject> {
     metadata: TMetadata;
 }
 type PublicKey<TMetadata extends JsonObject> = string | ((params: PublicKeyParams<TMetadata>) => string);
-interface WebSocketConnection {
-    /**
-     * @description How many times a connection attempt was made. This will increment upon each
-     * unsuccessful attempt, and will reset upon a successful connection.
-     * @date April 13, 2025
-     */
-    attempts: number;
-    /**
-     * @description How many times the user has connected to the room. This can be more than 1 in
-     * the case of reconnects. This is tracked because on the very first connection (i.e. when
-     * count is 0) we don't want to send the storage state as an update to the room and overwrite
-     * the upstream state.
-     * @date April 13, 2025
-     */
-    count: number;
-    id: string | null;
-    state: ConnectionState;
-}
 type WithMetadata<TMetadata extends JsonObject = {}> = keyof TMetadata extends never ? {
     metadata?: undefined;
 } : {
     metadata: TMetadata;
 };
 
-interface PluvProcedureConfig<TIO extends IOLike = IOLike, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
-    broadcast?: EventResolver<TIO, TInput, TOutput, TPresence, TStorage> | null;
+interface PluvProcedureConfig<TIO extends IOLike, TInput extends JsonObject, TOutput extends EventRecord<string, any>, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>> {
+    broadcast?: EventResolver<TIO, TInput, TOutput, TPresence, InferDocLike<TCrdt>> | null;
     input?: InputZodLike<TInput>;
 }
-declare class PluvProcedure<TIO extends IOLike = IOLike, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TFilled extends "input" | "broadcast" | "" = ""> implements ProcedureLike<TInput, TOutput> {
+declare class PluvProcedure<TIO extends IOLike, TInput extends JsonObject, TOutput extends EventRecord<string, any>, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TFilled extends "input" | "broadcast" | ""> implements ProcedureLike<TInput, TOutput> {
     private _broadcast;
     private _input;
     get config(): ProcedureLike<TInput, TOutput>["config"];
-    constructor(config?: PluvProcedureConfig<TIO, TInput, TOutput, TPresence, TStorage>);
-    broadcast<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<TIO, TInput, TResult, TPresence, TStorage>): Omit<PluvProcedure<TIO, TInput, MergeEventRecords<[TOutput, TResult]>, TPresence, TStorage, TFilled | "input" | "broadcast">, TFilled | "input" | "broadcast">;
-    input<TData extends JsonObject>(input: InputZodLike<TData>): Omit<PluvProcedure<TIO, TData, {}, TPresence, TStorage, TFilled | "input">, TFilled | "input">;
+    constructor(config?: PluvProcedureConfig<TIO, TInput, TOutput, TPresence, TCrdt>);
+    broadcast<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<TIO, TInput, TResult, TPresence, InferDocLike<TCrdt>>): Omit<PluvProcedure<TIO, TInput, MergeEventRecords<[TOutput, TResult]>, TPresence, TCrdt, TFilled | "input" | "broadcast">, TFilled | "input" | "broadcast">;
+    input<TData extends JsonObject>(input: InputZodLike<TData>): Omit<PluvProcedure<TIO, TData, {}, TPresence, TCrdt, TFilled | "input">, TFilled | "input">;
     private _resolver;
 }
 
-type CrdtManagerOptions<TCrdt extends AbstractCrdtDocFactory<any>> = {
+type CrdtManagerOptions<TCrdt extends AbstractCrdtDocFactory<any, any>> = {
     initialStorage?: TCrdt;
 };
 
-type PluvRouterEventConfig<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = {
-    [P: string]: Pick<PluvProcedure<TIO, any, any, TPresence, TStorage>, "config">;
+type PluvRouterEventConfig<TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>> = {
+    [P: string]: Pick<PluvProcedure<TIO, any, any, TPresence, TCrdt, "">, "config">;
 };
-type MergedRouter<TRouters extends PluvRouter<TIO, TPresence, TStorage, any>[] = [], TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TRoot extends TRouters[0]["_defs"]["events"] = {}> = TRouters extends [
-    infer IHead extends PluvRouter<TIO, TPresence, TStorage, any>,
-    ...infer ITail extends PluvRouter<TIO, TPresence, TStorage, any>[]
-] ? MergedRouter<ITail, TIO, TPresence, TStorage, TRoot & IHead["_defs"]["events"]> : PluvRouter<TIO, TPresence, TStorage, TRoot>;
-declare class PluvRouter<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> implements IORouterLike<TEvents> {
+type MergedRouter<TRouters extends PluvRouter<TIO, TPresence, TCrdt, any>[], TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TRoot extends TRouters[0]["_defs"]["events"]> = TRouters extends [
+    infer IHead extends PluvRouter<TIO, TPresence, TCrdt, any>,
+    ...infer ITail extends PluvRouter<TIO, TPresence, TCrdt, any>[]
+] ? MergedRouter<ITail, TIO, TPresence, TCrdt, TRoot & IHead["_defs"]["events"]> : PluvRouter<TIO, TPresence, TCrdt, TRoot>;
+declare class PluvRouter<TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, TCrdt> = {}> implements IORouterLike<TEvents> {
     readonly _defs: {
         events: TEvents;
     };
     constructor(events: TEvents);
-    static merge<TRouters extends PluvRouter<any, any, any, any>[]>(...routers: TRouters): MergedRouter<TRouters>;
+    static merge<TRouters extends PluvRouter<TIO, TPresence, TCrdt, any>[], TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>>(...routers: TRouters): MergedRouter<TRouters, TIO, TPresence, TCrdt, {}>;
     private _isValidEventName;
 }
 
-type UsersManagerConfig<TPresence extends JsonObject = {}> = {
+type UsersManagerConfig<TPresence extends Record<string, any> = {}> = {
     initialPresence?: TPresence;
     limits: PluvClientLimits;
     presence?: InputZodLike<TPresence>;
@@ -133,8 +115,8 @@ type RoomEndpoints<TIO extends IOLike<any, any>, TMetadata extends JsonObject> =
 } : {
     authEndpoint?: undefined;
 });
-type PluvRoomAddon<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>> = (input: PluvRoomAddonInput<TIO, TMetadata, TPresence, TCrdt>) => Partial<PluvRoomAddonResult>;
-interface PluvRoomAddonInput<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>> {
+type PluvRoomAddon<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>> = (input: PluvRoomAddonInput<TIO, TMetadata, TPresence, TCrdt>) => Partial<PluvRoomAddonResult>;
+interface PluvRoomAddonInput<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>> {
     room: PluvRoom<TIO, TMetadata, TPresence, TCrdt>;
 }
 interface PluvRoomAddonResult {
@@ -149,7 +131,7 @@ interface ReconnectTimeoutMsParams {
     attempts: number;
 }
 type ReconnectTimeoutMs = number | ((params: ReconnectTimeoutMsParams) => number);
-type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> = Id<{
+type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> = Id<{
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TCrdt>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     limits: PluvClientLimits;
@@ -159,7 +141,7 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject, TPresence exte
     reconnectTimeoutMs?: ReconnectTimeoutMs;
     router?: PluvRouter<TIO, TPresence, InferStorage<TCrdt>, TEvents>;
 } & RoomEndpoints<TIO, TMetadata> & Pick<CrdtManagerOptions<TCrdt>, "initialStorage"> & UsersManagerConfig<TPresence>>;
-declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TCrdt extends AbstractCrdtDocFactory<any> = NoopCrdtDocFactory, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>> = {}> implements RoomLike<TIO, TPresence, InferStorage<TCrdt>> {
+declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObject = {}, TPresence extends Record<string, any> = {}, TCrdt extends AbstractCrdtDocFactory<any, any> = NoopCrdtDocFactory, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>> = {}> implements RoomLike<TIO, InferDoc<TCrdt>, TPresence, InferStorage<TCrdt>> {
     readonly _endpoints: RoomEndpoints<TIO, TMetadata>;
     readonly id: string;
     readonly metadata?: InputZodLike<TMetadata>;
@@ -169,6 +151,7 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private readonly _eventNotifier;
     private readonly _intervals;
     private readonly _limits;
+    private readonly _listenerManager;
     private readonly _listeners;
     private readonly _publicKey;
     private readonly _reconnectTimeoutMs;
@@ -184,8 +167,12 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _windowListeners;
     private _wsListeners;
     constructor(room: string, options: RoomConfig<TIO, TMetadata, TPresence, TCrdt, TEvents>);
+    /**
+     * @deprecated To be removed in v3. Use `getStorageLoaded` instead.
+     */
     get storageLoaded(): boolean;
     get webSocket(): WebSocket | null;
+    addEventListener<TKind extends keyof RoomEventListenerMap>(kind: TKind, handler: RoomEventListenerMap[TKind]): () => void;
     broadcast: BroadcastProxy<TIO, TEvents>;
     canRedo: () => boolean;
     canUndo: () => boolean;
@@ -196,7 +183,7 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
      */
     event: EventProxy<TIO, TEvents>;
     getConnection: () => WebSocketConnection;
-    getDoc: () => CrdtDocLike<InferStorage<TCrdt>>;
+    getDoc: () => CrdtDocLike<InferDoc<TCrdt>, InferStorage<TCrdt>>;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -204,13 +191,14 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     getStorage: <TKey extends keyof InferStorage<TCrdt>>(type: TKey) => InferStorage<TCrdt>[TKey] | null;
     getStorageJson(): InferCrdtJson<InferStorage<TCrdt>> | null;
     getStorageJson<TKey extends keyof InferStorage<TCrdt>>(type: TKey): InferCrdtJson<InferStorage<TCrdt>[TKey]> | null;
+    getStorageLoaded: () => boolean;
     /**
      * @deprecated To be removed in v3. Use PluvRoom.subscribe.other instead
      */
     other: (connectionId: string, callback: OtherSubscriptionCallback<TIO, TPresence>) => (() => void);
     redo: () => void;
     /**
-     * @deprecated To be removed in v3. To be removed in v3. Use PluvRoom.subscribe.storage instead
+     * @deprecated To be removed in v3. Use PluvRoom.subscribe.storage instead
      */
     storage: StorageProxy<InferStorage<TCrdt>>;
     /**
@@ -270,7 +258,7 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _updateState;
 }
 
-type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>, TMetadata extends JsonObject> = RoomEndpoints<TIO, TMetadata> & {
+type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TMetadata extends JsonObject> = RoomEndpoints<TIO, TMetadata> & {
     debug?: boolean;
     initialStorage?: TCrdt;
     /**
@@ -283,7 +271,7 @@ type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObjec
     publicKey?: PublicKey<TMetadata>;
     types: InferCallback<TIO>;
 };
-type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>> = {}> = {
+type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, InferStorage<TCrdt>>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     initialPresence?: TPresence;
@@ -293,7 +281,7 @@ type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObjec
     router?: PluvRouter<TIO, TPresence, InferStorage<TCrdt>, TEvents>;
 };
 type EnterRoomParams<TMetadata extends JsonObject = {}> = keyof TMetadata extends never ? [] : [WithMetadata<TMetadata>];
-declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends JsonObject = {}, TCrdt extends AbstractCrdtDocFactory<any> = NoopCrdtDocFactory, TMetadata extends JsonObject = {}> {
+declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends Record<string, any> = {}, TCrdt extends AbstractCrdtDocFactory<any, any> = NoopCrdtDocFactory, TMetadata extends JsonObject = {}> {
     readonly metadata?: InputZodLike<TMetadata>;
     private readonly _authEndpoint;
     private readonly _debug;
@@ -306,7 +294,7 @@ declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends JsonObj
     get _defs(): {
         initialStorage: TCrdt | undefined;
     };
-    get procedure(): PluvProcedure<TIO, {}, {}, TPresence, InferStorage<TCrdt>>;
+    get procedure(): PluvProcedure<TIO, {}, {}, TPresence, TCrdt, "">;
     constructor(options: PluvClientOptions<TIO, TPresence, TCrdt, TMetadata>);
     createRoom: <TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>> = {}>(room: string, options?: CreateRoomOptions<TIO, TPresence, TCrdt, TMetadata, TEvents>) => PluvRoom<TIO, TMetadata, TPresence, TCrdt, TEvents>;
     enter: (room: string | PluvRoom<TIO, TMetadata, any, any, any>, ...args: EnterRoomParams<TMetadata>) => Promise<PluvRoom<TIO, TMetadata, TPresence, TCrdt, any>>;
@@ -317,18 +305,22 @@ declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends JsonObj
     private _logDebug;
 }
 
-declare const createClient: <TIO extends IOLike<any, any>, TPresence extends JsonObject = {}, TCrdt extends AbstractCrdtDocFactory<any> = NoopCrdtDocFactory, TMetadata extends JsonObject = {}>(options: PluvClientOptions<TIO, TPresence, TCrdt, TMetadata>) => PluvClient<TIO, TPresence, TCrdt, TMetadata>;
+declare const createClient: <TIO extends IOLike<any, any>, TPresence extends Record<string, any> = {}, TCrdt extends AbstractCrdtDocFactory<any, any> = NoopCrdtDocFactory, TMetadata extends JsonObject = {}>(options: PluvClientOptions<TIO, TPresence, TCrdt, TMetadata>) => PluvClient<TIO, TPresence, TCrdt, TMetadata>;
 
 type MockedRoomEvents<TIO extends IOLike> = Partial<{
     [P in keyof InferIOInput<TIO>]: (data: Id<InferIOInput<TIO>[P]>) => Partial<InferIOOutput<TIO>>;
 }>;
-type MockedRoomConfig<TIO extends IOLike, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> = {
+type MockedRoomConfig<TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> = {
     events?: MockedRoomEvents<MergeEvents<TEvents, TIO>>;
     limits?: PluvClientLimits;
     router?: PluvRouter<TIO, TPresence, InferStorage<TCrdt>, TEvents>;
 } & Pick<CrdtManagerOptions<TCrdt>, "initialStorage"> & Omit<UsersManagerConfig<TPresence>, "limits">;
-declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject, TCrdt extends AbstractCrdtDocFactory<any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> implements RoomLike<TIO, TPresence, InferStorage<TCrdt>> {
+declare class MockedRoom<TIO extends IOLike, TPresence extends Record<string, any>, TCrdt extends AbstractCrdtDocFactory<any, any>, TEvents extends PluvRouterEventConfig<TIO, TPresence, InferStorage<TCrdt>>> implements RoomLike<TIO, InferDoc<TCrdt>, TPresence, InferStorage<TCrdt>> {
     readonly id: string;
+    /**
+     * @deprecated To be removed in v3. Use `getStorageLoaded` instead.
+     */
+    readonly storageLoaded: boolean;
     private readonly _crdtManager;
     private readonly _crdtNotifier;
     private readonly _eventNotifier;
@@ -341,13 +333,13 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject, TCrdt
     private readonly _subscriptions;
     private readonly _usersManager;
     constructor(room: string, options: MockedRoomConfig<TIO, TPresence, TCrdt, TEvents>);
-    get storageLoaded(): boolean;
+    addEventListener<TKind extends keyof RoomEventListenerMap>(kind: TKind, handler: RoomEventListenerMap[TKind]): () => void;
     broadcast: BroadcastProxy<TIO, TEvents>;
     canRedo: () => boolean;
     canUndo: () => boolean;
     event: EventProxy<TIO, TEvents>;
     getConnection: () => WebSocketConnection;
-    getDoc(): CrdtDocLike<InferStorage<TCrdt>>;
+    getDoc(): CrdtDocLike<InferDoc<TCrdt>, InferStorage<TCrdt>>;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -355,6 +347,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject, TCrdt
     getStorage: <TKey extends keyof InferStorage<TCrdt>>(type: TKey) => InferStorage<TCrdt>[TKey] | null;
     getStorageJson(): InferCrdtJson<InferStorage<TCrdt>> | null;
     getStorageJson<TKey extends keyof InferStorage<TCrdt>>(type: TKey): InferCrdtJson<InferStorage<TCrdt>[TKey]> | null;
+    getStorageLoaded(): boolean;
     other: (connectionId: string, callback: OtherSubscriptionCallback<TIO, TPresence>) => (() => void);
     redo: () => void;
     storage: StorageProxy<InferStorage<TCrdt>>;
@@ -377,4 +370,4 @@ declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TM
     wsEndpoint: (params: EndpointParams<TMetadata>) => string;
 };
 
-export { AbstractStorageStore, type CreateRoomOptions, type EnterRoomParams, type InferCallback, type InferMetadata, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type PublicKey, type PublicKeyParams, type RegisterParams, type RoomConnectParams, type RoomEndpoints, type WebSocketConnection, createClient, infer, register };
+export { AbstractStorageStore, type CreateRoomOptions, type EnterRoomParams, type InferCallback, type InferMetadata, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type PublicKey, type PublicKeyParams, type RegisterParams, type RoomConnectParams, type RoomEndpoints, createClient, infer, register };

package/dist/index.js

@@ -78,6 +78,7 @@ var AbstractStorageStore = class {
 
 // src/constants.ts
 var MAX_PRESENCE_SIZE_BYTES = 512;
+var PLUV_PRESENCE_META_KEY = "__pluv";
 
 // src/PluvProcedure.ts
 var PluvProcedure = class _PluvProcedure {
@@ -124,7 +125,7 @@ var CrdtManager = class {
     this.initialized = false;
     const { initialStorage = import_crdt.noop.doc({}) } = options;
     this._docFactory = initialStorage;
-    this.doc = initialStorage.getEmpty();
+    this.doc = this._docFactory.getEmpty();
   }
   /**
    * !HACK
@@ -164,11 +165,7 @@ var CrdtManager = class {
     if (!updates.length) return this;
     const initialized = this._docFactory.getInitialized();
     const reference = initialized.get();
-    this.doc = this._applyDocUpdates(
-      this._docFactory.getEmpty(),
-      updates,
-      origin
-    ).rebuildStorage(reference);
+    this.doc = this._applyDocUpdates(this.doc, updates, origin).rebuildStorage(reference);
     this.initialized = true;
     initialized.destroy();
     return this;
@@ -228,6 +225,25 @@ var EventNotifier = class {
   }
 };
 
+// src/ListenerManager.ts
+var import_wonka3 = require("wonka");
+var ListenerManager = class {
+  constructor() {
+    this.subjects = {
+      close: (0, import_wonka3.makeSubject)(),
+      error: (0, import_wonka3.makeSubject)(),
+      message: (0, import_wonka3.makeSubject)(),
+      open: (0, import_wonka3.makeSubject)()
+    };
+  }
+  subscribe(kind, callback) {
+    var _a;
+    const source = (_a = this.subjects[kind]) == null ? void 0 : _a.source;
+    if (!source) return () => void 0;
+    return (0, import_wonka3.subscribe)(callback)(source).unsubscribe;
+  }
+};
+
 // src/PluvRouter.ts
 var PluvRouter = class _PluvRouter {
   constructor(events) {
@@ -256,22 +272,22 @@ var PluvRouter = class _PluvRouter {
 };
 
 // src/StateNotifier.ts
-var import_wonka3 = require("wonka");
+var import_wonka4 = require("wonka");
 var StateNotifier = class {
   constructor() {
     this.subjects = {
-      connection: (0, import_wonka3.makeSubject)(),
-      "my-presence": (0, import_wonka3.makeSubject)(),
-      myself: (0, import_wonka3.makeSubject)(),
-      others: (0, import_wonka3.makeSubject)(),
-      "storage-loaded": (0, import_wonka3.makeSubject)()
+      connection: (0, import_wonka4.makeSubject)(),
+      "my-presence": (0, import_wonka4.makeSubject)(),
+      myself: (0, import_wonka4.makeSubject)(),
+      others: (0, import_wonka4.makeSubject)(),
+      "storage-loaded": (0, import_wonka4.makeSubject)()
     };
   }
   subscribe(name, callback) {
     var _a;
     const source = (_a = this.subjects[name]) == null ? void 0 : _a.source;
     if (!source) throw new Error(`Could not subscribe to source: ${name}`);
-    return (0, import_wonka3.subscribe)(callback)(source).unsubscribe;
+    return (0, import_wonka4.subscribe)(callback)(source).unsubscribe;
   }
 };
 
@@ -444,6 +460,9 @@ var UsersManager = class {
     );
     const presence = __spreadValues(__spreadValues(__spreadValues({}, this.initialPresence), cleanedPresence), cleanedPatch);
     const validated = this._presence ? this._presence.parse(presence) : presence;
+    if (!!presence[PLUV_PRESENCE_META_KEY]) {
+      validated[PLUV_PRESENCE_META_KEY] = presence[PLUV_PRESENCE_META_KEY];
+    }
     this._others.set(clientId, __spreadProps(__spreadValues({}, other), { presence: validated }));
     return validated;
   }
@@ -522,10 +541,10 @@ var UsersManager = class {
 };
 
 // src/UsersNotifier.ts
-var import_wonka4 = require("wonka");
+var import_wonka5 = require("wonka");
 var UsersNotifier = class {
   constructor() {
-    this.others = (0, import_wonka4.makeSubject)();
+    this.others = (0, import_wonka5.makeSubject)();
     this._otherSubjects = /* @__PURE__ */ new Map();
   }
   clear() {
@@ -541,17 +560,17 @@ var UsersNotifier = class {
   other(clientId) {
     const subject = this._otherSubjects.get(clientId);
     if (subject) return subject;
-    const newSubject = (0, import_wonka4.makeSubject)();
+    const newSubject = (0, import_wonka5.makeSubject)();
     this._otherSubjects.set(clientId, newSubject);
     return newSubject;
   }
   subscribeOther(clientId, callback) {
     const source = this.other(clientId).source;
-    const subscription = (0, import_wonka4.subscribe)(callback)(source);
+    const subscription = (0, import_wonka5.subscribe)(callback)(source);
     return subscription.unsubscribe;
   }
   subscribeOthers(callback) {
-    const subscription = (0, import_wonka4.subscribe)(
+    const subscription = (0, import_wonka5.subscribe)(
       ({ others, event }) => callback(others, event)
     )(this.others.source);
     return subscription.unsubscribe;
@@ -577,6 +596,7 @@ var PluvRoom = class {
     this._intervals = {
       heartbeat: null
     };
+    this._listenerManager = new ListenerManager();
     this._publicKey = null;
     this._stateNotifier = new StateNotifier();
     this._subscriptions = {
@@ -595,10 +615,12 @@ var PluvRoom = class {
       },
       connection: {
         attempts: 0,
-        count: 0,
         id: null,
         state: import_types.ConnectionState.Untouched
       },
+      storage: {
+        state: import_types.StorageState.Unavailable
+      },
       webSocket: null
     };
     this._windowListeners = null;
@@ -675,6 +697,9 @@ var PluvRoom = class {
       if (typeof sharedType === "undefined") return null;
       return sharedType;
     };
+    this.getStorageLoaded = () => {
+      return this._state.storage.state === import_types.StorageState.Offline || this._state.storage.state === import_types.StorageState.Synced;
+    };
     /**
      * @deprecated To be removed in v3. Use PluvRoom.subscribe.other instead
      */
@@ -687,7 +712,7 @@ var PluvRoom = class {
       this._crdtManager.doc.redo();
     };
     /**
-     * @deprecated To be removed in v3. To be removed in v3. Use PluvRoom.subscribe.storage instead
+     * @deprecated To be removed in v3. Use PluvRoom.subscribe.storage instead
      */
     this.storage = new Proxy(
       (key, callback) => this._crdtNotifier.subscribe(key, callback),
@@ -825,12 +850,18 @@ var PluvRoom = class {
     });
     this._crdtManager = new CrdtManager({ initialStorage });
   }
+  /**
+   * @deprecated To be removed in v3. Use `getStorageLoaded` instead.
+   */
   get storageLoaded() {
-    return this._crdtManager.initialized;
+    return this.getStorageLoaded();
   }
   get webSocket() {
     return this._state.webSocket;
   }
+  addEventListener(kind, handler) {
+    return this._listenerManager.subscribe(kind, handler);
+  }
   connect(...args) {
     return __async(this, null, function* () {
       var _a;
@@ -872,6 +903,7 @@ var PluvRoom = class {
       this._updateState((oldState) => {
         oldState.connection.attempts = 0;
         oldState.authorization.token = authToken;
+        oldState.storage.state = import_types.StorageState.Loading;
         oldState.webSocket = webSocket;
         return oldState;
       });
@@ -892,6 +924,7 @@ var PluvRoom = class {
       this._updateState((oldState) => {
         oldState.authorization.token = null;
         oldState.connection.state = import_types.ConnectionState.Closed;
+        oldState.storage.state = oldState.storage.state === import_types.StorageState.Synced ? import_types.StorageState.Offline : import_types.StorageState.Unavailable;
         oldState.webSocket = null;
         return oldState;
       });
@@ -1138,7 +1171,6 @@ var PluvRoom = class {
       const data = message.data;
       const state = data.state;
       this._updateState((oldState) => {
-        oldState.connection.count += 1;
         oldState.connection.id = connectionId;
         oldState.authorization.user = user != null ? user : null;
         return oldState;
@@ -1190,6 +1222,10 @@ var PluvRoom = class {
       const encodedState = this._crdtManager.doc.getEncodedState();
       this._emitSharedTypes();
       this._observeCrdt();
+      this._updateState((oldState) => {
+        oldState.storage.state = import_types.StorageState.Synced;
+        return oldState;
+      });
       this._stateNotifier.subjects["storage-loaded"].next(true);
       this._sendMessage({
         type: "$updateStorage",
@@ -1302,11 +1338,13 @@ var PluvRoom = class {
     this._listeners.onAuthorizationFail(authError);
     this._updateState((oldState) => {
       oldState.connection.state = import_types.ConnectionState.Unavailable;
+      oldState.storage.state = import_types.StorageState.Unavailable;
       return oldState;
     });
   }
   _onClose(event) {
     return __async(this, null, function* () {
+      this._listenerManager.subjects.close.next(event);
       this._logDebug("WebSocket closed");
       if (!!event.reason) this._logDebug(event.reason);
       const shouldRetry = [
@@ -1334,6 +1372,7 @@ var PluvRoom = class {
            */
           import_types.ConnectionState.Closed
         );
+        oldState.storage.state = oldState.storage.state === import_types.StorageState.Synced ? import_types.StorageState.Offline : import_types.StorageState.Unavailable;
         oldState.webSocket = null;
         return oldState;
       });
@@ -1350,9 +1389,11 @@ var PluvRoom = class {
    * @description Handle websocket errors in a meaningful way, should they occur
    * @date August 19, 2022
    */
-  _onError() {
+  _onError(event) {
+    this._listenerManager.subjects.error.next(event);
   }
   _onMessage(event) {
+    this._listenerManager.subjects.message.next(event);
     const message = this._parseMessage(event);
     if (!message) return;
     const shouldLog = typeof this._debug === "boolean" ? this._debug : this._debug.output.find((value) => value === message.type);
@@ -1400,7 +1441,8 @@ var PluvRoom = class {
       default:
     }
   }
-  _onOpen() {
+  _onOpen(event) {
+    this._listenerManager.subjects.open.next(event);
     if (this._state.connection.state !== import_types.ConnectionState.Connecting) return;
     this._logDebug("WebSocket connected");
     this._updateState((oldState) => {
@@ -1418,6 +1460,7 @@ var PluvRoom = class {
       if (this._state.connection.state === import_types.ConnectionState.Closed) return;
       this._updateState((oldState) => {
         oldState.connection.state = import_types.ConnectionState.Unavailable;
+        oldState.storage.state = oldState.storage.state === import_types.StorageState.Synced ? import_types.StorageState.Offline : import_types.StorageState.Unavailable;
         return oldState;
       });
     });
@@ -1517,6 +1560,7 @@ var PluvRoom = class {
     const oldState = __spreadProps(__spreadValues({}, this._state), {
       authorization,
       connection: JSON.parse(JSON.stringify(this._state.connection)),
+      storage: JSON.parse(JSON.stringify(this._state.storage)),
       webSocket: this._state.webSocket
     });
     const newState = updater(oldState);
@@ -1633,6 +1677,10 @@ var infer = (callback) => callback;
 var import_types2 = require("@pluv/types");
 var MockedRoom = class {
   constructor(room, options) {
+    /**
+     * @deprecated To be removed in v3. Use `getStorageLoaded` instead.
+     */
+    this.storageLoaded = true;
     this._crdtNotifier = new CrdtNotifier();
     this._eventNotifier = new EventNotifier();
     this._usersNotifier = new UsersNotifier();
@@ -1643,10 +1691,12 @@ var MockedRoom = class {
       },
       connection: {
         attempts: 0,
-        count: 1,
         id: null,
         state: import_types2.ConnectionState.Untouched
       },
+      storage: {
+        state: import_types2.StorageState.Unavailable
+      },
       webSocket: null
     };
     this._stateNotifier = new StateNotifier();
@@ -1821,8 +1871,8 @@ var MockedRoom = class {
     });
     this._observeCrdt();
   }
-  get storageLoaded() {
-    return true;
+  addEventListener(kind, handler) {
+    return () => void 0;
   }
   getDoc() {
     return this._crdtManager.doc;
@@ -1832,6 +1882,9 @@ var MockedRoom = class {
     if (typeof type === "undefined") return this._crdtManager.doc.toJson();
     return this._crdtManager.doc.toJson(type);
   }
+  getStorageLoaded() {
+    return true;
+  }
   _observeCrdt() {
     var _a, _b;
     (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);