@pluv/client 0.15.0 → 0.16.1

package/src/PluvRoom.ts

@@ -1,18 +1,21 @@
-import { InferYjsSharedTypeJson, TrackOriginOptions } from "@pluv/crdt-yjs";
+import type {
+    AbstractCrdtDoc,
+    AbstractCrdtType,
+    InferCrdtStorageJson,
+} from "@pluv/crdt";
 import type {
     BaseIOEventRecord,
     EventMessage,
+    IOEventMessage,
+    IOLike,
     Id,
     InferIOAuthorize,
     InferIOAuthorizeRequired,
     InferIOAuthorizeUser,
     InferIOInput,
     InferIOOutput,
-    IOEventMessage,
-    IOLike,
     JsonObject,
 } from "@pluv/types";
-import type { AbstractType, Doc } from "yjs";
 import { AbstractRoom } from "./AbstractRoom";
 import { AbstractStorageStore } from "./AbstractStorageStore";
 import type { CrdtManagerOptions } from "./CrdtManager";
@@ -28,6 +31,8 @@ import type {
 } from "./StateNotifier";
 import { StateNotifier } from "./StateNotifier";
 import { StorageStore } from "./StorageStore";
+import type { UsersManagerConfig } from "./UsersManager";
+import { UsersManager } from "./UsersManager";
 import type {
     AuthorizationState,
     InternalSubscriptions,
@@ -36,8 +41,6 @@ import type {
     WebSocketState,
 } from "./types";
 import { ConnectionState } from "./types";
-import type { UsersManagerConfig } from "./UsersManager";
-import { UsersManager } from "./UsersManager";
 import { debounce } from "./utils";
 
 const ADD_TO_STORAGE_STATE_DEBOUNCE_MS = 1_000;
@@ -50,7 +53,7 @@ const ORIGIN_STORAGE_UPDATED = "$STORAGE_UPDATED";
 export const DEFAULT_PLUV_CLIENT_ADDON = <
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {},
+    TStorage extends Record<string, AbstractCrdtType<any, any>> = {},
 >(
     input: PluvRoomAddonInput<TIO, TPresence, TStorage>,
 ): PluvRoomAddonResult => ({
@@ -107,7 +110,7 @@ interface InternalListeners {
 export type PluvRoomAddon<
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {},
+    TStorage extends Record<string, AbstractCrdtType<any, any>> = {},
 > = (
     input: PluvRoomAddonInput<TIO, TPresence, TStorage>,
 ) => Partial<PluvRoomAddonResult>;
@@ -115,7 +118,7 @@ export type PluvRoomAddon<
 export interface PluvRoomAddonInput<
     TIO extends IOLike = IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {},
+    TStorage extends Record<string, AbstractCrdtType<any, any>> = {},
 > {
     room: PluvRoom<TIO, TPresence, TStorage>;
 }
@@ -132,7 +135,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, AbstractCrdtType<any, any>> = {},
 > = {
     addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
@@ -143,19 +146,16 @@ export type PluvRoomOptions<
 export type RoomConfig<
     TIO extends IOLike,
     TPresence extends JsonObject = {},
-    TStorage extends Record<string, AbstractType<any>> = {},
-> = RoomEndpoints<TIO> &
-    PluvRoomOptions<TIO, TPresence, TStorage> &
-    TrackOriginOptions;
+    TStorage extends Record<string, AbstractCrdtType<any, 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, AbstractCrdtType<any, any>> = {},
 > extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO>;
 
-    private _captureTimeout: number | null = null;
     private _crdtManager: CrdtManager<TStorage>;
     private _crdtNotifier = new CrdtNotifier<TStorage>();
     private _debug: boolean | PluvRoomDebug<TIO>;
@@ -186,7 +186,6 @@ export class PluvRoom<
         pong: null,
         reconnect: null,
     };
-    private _trackedOrigins: readonly string[] | null = null;
     private _windowListeners: WindowListeners | null = null;
     private _wsListeners: WebSocketListeners | null = null;
     private _usersManager: UsersManager<TIO, TPresence>;
@@ -195,13 +194,11 @@ export class PluvRoom<
         const {
             addons = [],
             authEndpoint,
-            captureTimeout,
             debug = false,
             initialPresence,
             initialStorage,
             onAuthorizationFail,
             presence,
-            trackedOrigins,
             wsEndpoint,
         } = options;
 
@@ -238,13 +235,12 @@ export class PluvRoom<
         });
 
         this._crdtManager = new CrdtManager<TStorage>({
-            captureTimeout,
             initialStorage,
-            trackedOrigins,
         });
+    }
 
-        this._captureTimeout = captureTimeout ?? null;
-        this._trackedOrigins = trackedOrigins ?? null;
+    public get storageLoaded(): boolean {
+        return this._crdtManager.initialized;
     }
 
     public get webSocket(): WebSocket | null {
@@ -364,8 +360,8 @@ export class PluvRoom<
         );
     }
 
-    public getDoc(): Doc {
-        return this._crdtManager.doc.value;
+    public getDoc(): AbstractCrdtDoc<TStorage> {
+        return this._crdtManager.doc;
     }
 
     public getMyPresence = (): TPresence => {
@@ -388,12 +384,10 @@ export class PluvRoom<
 
     public getStorage = <TKey extends keyof TStorage>(
         key: TKey,
-    ): TStorage[TKey] => {
+    ): TStorage[TKey] | null => {
         const sharedType = this._crdtManager.get(key);
 
-        if (typeof sharedType === "undefined") {
-            throw new Error(`Could not find storege: ${key.toString()}`);
-        }
+        if (typeof sharedType === "undefined") return null;
 
         return sharedType;
     };
@@ -411,14 +405,14 @@ export class PluvRoom<
 
     public storage = <TKey extends keyof TStorage>(
         key: TKey,
-        fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void,
+        fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void,
     ): (() => void) => {
         return this._crdtNotifier.subscribe(key, fn);
     };
 
     public storageRoot = (
         fn: (value: {
-            [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>;
+            [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
         }) => void,
     ): (() => void) => {
         return this._crdtNotifier.subcribeRoot(fn);
@@ -449,7 +443,9 @@ export class PluvRoom<
         if (typeof _origin !== "string") return;
 
         this._crdtManager.doc.transact(() => {
-            fn(this._crdtManager.doc.storage);
+            const storage = this._crdtManager.doc.get();
+
+            fn(storage);
         }, _origin);
     };
 
@@ -480,15 +476,14 @@ export class PluvRoom<
 
     private async _applyStorageStore(): Promise<void> {
         const updates = await this._storageStore.getUpdates();
-        const trackedOrigins = this._getTrackedOrigins();
 
         this._crdtManager.initialize({
-            captureTimeout: this._captureTimeout ?? undefined,
             onInitialized: () => {
+                this._stateNotifier.subjects["storage-loaded"].next(true);
+
                 this._observeCrdt();
             },
             origin: ORIGIN_INITIALIZED,
-            trackedOrigins: trackedOrigins ?? undefined,
             update: updates,
         });
 
@@ -615,18 +610,18 @@ export class PluvRoom<
     }
 
     private _emitSharedTypes(): void {
-        const sharedTypes = this._crdtManager.doc.getSharedTypes();
+        const sharedTypes = this._crdtManager.doc.get();
 
         const storageRoot = Object.entries(sharedTypes).reduce(
             (acc, [prop, sharedType]) => {
-                const serialized = sharedType.toJSON();
+                const serialized = sharedType.toJson();
 
                 this._crdtNotifier.subject(prop).next(serialized);
 
                 return { ...acc, [prop]: serialized };
             },
             {} as {
-                [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>;
+                [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
             },
         );
 
@@ -643,7 +638,7 @@ export class PluvRoom<
 
             this._crdtManager.applyUpdate(updates, this);
 
-            const encodedState = this._crdtManager.doc.encodeStateAsUpdate();
+            const encodedState = this._crdtManager.doc.getEncodedState();
 
             await this._storageStore.flatten(encodedState);
         },
@@ -708,14 +703,6 @@ export class PluvRoom<
         }
     }
 
-    private _getTrackedOrigins(): readonly string[] | null {
-        const connectionId = this._state.connection.id;
-
-        return !connectionId
-            ? this._trackedOrigins
-            : [connectionId, ...(this._trackedOrigins ?? [])];
-    }
-
     private _getWsEndpoint(room: string): string {
         switch (typeof this._endpoints.wsEndpoint) {
             case "undefined":
@@ -836,7 +823,7 @@ export class PluvRoom<
 
         const update =
             this._state.connection.count > 1
-                ? this._crdtManager.doc.encodeStateAsUpdate() ?? null
+                ? this._crdtManager.doc.getEncodedState() ?? null
                 : null;
 
         this._sendMessage({
@@ -858,25 +845,25 @@ export class PluvRoom<
             InferIOAuthorize<TIO>
         >["$STORAGE_RECEIVED"];
 
-        const trackedOrigins = this._getTrackedOrigins();
-
         this._crdtManager.initialize({
-            captureTimeout: this._captureTimeout ?? undefined,
-            onInitialized: async () => {
+            onInitialized: async (update) => {
+                this._addToStorageStore(update);
+                this._emitSharedTypes();
+
                 this._observeCrdt();
+                this._stateNotifier.subjects["storage-loaded"].next(true);
             },
             origin: ORIGIN_INITIALIZED,
-            trackedOrigins: trackedOrigins ?? undefined,
             update: data.state,
         });
 
-        const encodedState = this._crdtManager.doc.encodeStateAsUpdate();
+        const encodedState = this._crdtManager.doc.getEncodedState();
 
         await this._storageStore.addUpdate(encodedState);
 
         this._emitSharedTypes();
 
-        const update = this._crdtManager.doc.encodeStateAsUpdate();
+        const update = this._crdtManager.doc.getEncodedState();
 
         this._sendMessage({
             type: "$UPDATE_STORAGE",
@@ -897,22 +884,25 @@ export class PluvRoom<
 
         if (!this._crdtManager) return;
 
-        this._crdtManager.doc.applyUpdate(data.state, ORIGIN_STORAGE_UPDATED);
+        this._crdtManager.doc.applyEncodedState({
+            origin: ORIGIN_STORAGE_UPDATED,
+            update: data.state,
+        });
 
-        const sharedTypes = this._crdtManager.doc.getSharedTypes();
+        const sharedTypes = this._crdtManager.doc.get();
 
         const storageRoot = Object.entries(sharedTypes).reduce(
             (acc, [prop, sharedType]) => {
                 if (!this._crdtManager) return acc;
 
-                const serialized = sharedType.toJSON();
+                const serialized = sharedType.toJson();
 
                 this._crdtNotifier.subject(prop).next(serialized);
 
                 return { ...acc, [prop]: serialized };
             },
             {} as {
-                [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>;
+                [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
             },
         );
 
@@ -972,27 +962,28 @@ export class PluvRoom<
 
         if (!this._crdtManager) return;
 
-        const unsubscribe = this._crdtManager.doc.subscribe(
-            (update, _origin) => {
-                const origin = _origin ?? null;
+        const unsubscribe = this._crdtManager.doc.subscribe((event) => {
+            const origin = event.origin ?? null;
 
-                this._addToStorageStore(update);
-                this._emitSharedTypes();
-
-                if (origin === ORIGIN_INITIALIZED || origin === this) return;
+            this._addToStorageStore(event.update);
+            this._emitSharedTypes();
 
-                if (!this._state.webSocket) return;
-                if (!this._state.connection.id) return;
-                if (this._state.webSocket.readyState !== WebSocket.OPEN) return;
+            if (
+                origin === ORIGIN_INITIALIZED ||
+                origin === ORIGIN_STORAGE_UPDATED
+            ) {
+                return;
+            }
 
-                if (origin === ORIGIN_STORAGE_UPDATED) return;
+            if (!this._state.webSocket) return;
+            if (!this._state.connection.id) return;
+            if (this._state.webSocket.readyState !== WebSocket.OPEN) return;
 
-                this._sendMessage({
-                    type: "$UPDATE_STORAGE",
-                    data: { origin, update },
-                });
-            },
-        );
+            this._sendMessage({
+                type: "$UPDATE_STORAGE",
+                data: { origin, update: event.update },
+            });
+        });
 
         this._subscriptions.observeCrdt = unsubscribe;
     }

package/src/StateNotifier.ts

@@ -11,17 +11,19 @@ export interface StateNotifierSubjects<
     "my-presence": Subject<TPresence | null>;
     myself: Subject<Readonly<Id<UserInfo<TIO>>> | null>;
     others: Subject<readonly Id<UserInfo<TIO>>[]>;
+    "storage-loaded": Subject<boolean>;
 }
 
 type InferSubjectValue<
     TIO extends IOLike,
     TPresence extends JsonObject,
     TSubject extends keyof StateNotifierSubjects<TIO, TPresence>,
-> = StateNotifierSubjects<TIO, TPresence>[TSubject] extends Subject<
-    infer IValue
->
-    ? Id<IValue>
-    : never;
+> =
+    StateNotifierSubjects<TIO, TPresence>[TSubject] extends Subject<
+        infer IValue
+    >
+        ? Id<IValue>
+        : never;
 
 export type SubscriptionCallback<
     TIO extends IOLike,
@@ -38,6 +40,7 @@ export class StateNotifier<
         "my-presence": makeSubject<TPresence>(),
         myself: makeSubject<Readonly<Id<UserInfo<TIO>>> | null>(),
         others: makeSubject<readonly Id<UserInfo<TIO>>[]>(),
+        "storage-loaded": makeSubject<true>(),
     };
 
     public subscribe<

package/src/index.ts

@@ -1,28 +1,23 @@
-export type {
-    InferYjsSharedTypeJson,
-    TrackOriginOptions,
-} from "@pluv/crdt-yjs";
+export type { AbstractCrdtType, InferCrdtStorageJson } from "@pluv/crdt";
 export type {
     BaseUser,
     EventMessage,
     EventRecord,
     IOEventMessage,
 } from "@pluv/types";
-export type { AbstractType } from "yjs";
 export { AbstractRoom } from "./AbstractRoom";
 export { AbstractStorageStore } from "./AbstractStorageStore";
-export { createClient } from "./createClient";
-export type { MockedRoomConfig, MockedRoomEvents } from "./MockedRoom";
 export { MockedRoom } from "./MockedRoom";
-export type { PluvClientOptions } from "./PluvClient";
+export type { MockedRoomConfig, MockedRoomEvents } from "./MockedRoom";
 export { PluvClient } from "./PluvClient";
+export type { PluvClientOptions } from "./PluvClient";
+export { PluvRoom } from "./PluvRoom";
 export type {
     PluvRoomAddon,
     PluvRoomAddonInput,
     PluvRoomAddonResult,
     PluvRoomDebug,
 } from "./PluvRoom";
-export { PluvRoom } from "./PluvRoom";
-export type { WebSocketConnection, UserInfo, WebSocketState } from "./types";
+export { createClient } from "./createClient";
 export { ConnectionState } from "./types";
-export * as y from "./y";
+export type { UserInfo, WebSocketConnection, WebSocketState } from "./types";

package/src/y.ts

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