@pluv/client 0.15.0 → 0.16.0

package/dist/index.d.ts

@@ -1,10 +1,8 @@
-import { InferYjsSharedTypeJson, TrackOriginOptions, array, map, object, text, xmlElement, xmlFragment, xmlText } from '@pluv/crdt-yjs';
-export { InferYjsSharedTypeJson, TrackOriginOptions } from '@pluv/crdt-yjs';
+import { AbstractCrdtType, AbstractCrdtDoc, InferCrdtStorageJson, AbstractCrdtDocFactory } from '@pluv/crdt';
+export { AbstractCrdtType, InferCrdtStorageJson } from '@pluv/crdt';
 import * as _pluv_types from '@pluv/types';
 import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, InferIOInput, InputZodLike, InferIOAuthorizeRequired } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { AbstractType, Doc } from 'yjs';
-export { AbstractType } from 'yjs';
 import { Subject } from 'wonka';
 
 type EventNotifierSubscriptionCallback<TIO extends IOLike, TEvent extends keyof InferIOOutput<TIO>> = (value: Id<IOEventMessage<TIO, TEvent>>) => void;
@@ -43,29 +41,31 @@ interface StateNotifierSubjects<TIO extends IOLike, TPresence extends JsonObject
     "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;
 type SubscriptionCallback<TIO extends IOLike, TPresence extends JsonObject, TSubject extends keyof StateNotifierSubjects<TIO, TPresence>> = (value: InferSubjectValue<TIO, TPresence, TSubject>) => void;
 
-declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> {
+declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> {
     readonly id: string;
     constructor(room: string);
+    abstract storageLoaded: boolean;
     abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     abstract canRedo(): boolean;
     abstract canUndo(): boolean;
-    abstract getDoc(): Doc;
+    abstract getDoc(): AbstractCrdtDoc<TStorage>;
     abstract event<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>): () => void;
     abstract getConnection(): WebSocketConnection;
     abstract getMyPresence(): TPresence;
     abstract getMyself(): Id<UserInfo<TIO, TPresence>> | null;
     abstract getOther(connectionId: string): Id<UserInfo<TIO, TPresence>> | null;
     abstract getOthers(): readonly Id<UserInfo<TIO, TPresence>>[];
-    abstract getStorage<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
+    abstract getStorage<TKey extends keyof TStorage>(key: TKey): TStorage[TKey] | null;
     abstract other(connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>): () => void;
     abstract redo(): void;
-    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void): () => void;
+    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void): () => void;
     abstract storageRoot(fn: (value: {
-        [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>;
+        [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
     }) => void): () => void;
     abstract subscribe<TSubject extends keyof StateNotifierSubjects<TIO, TPresence>>(name: TSubject, callback: SubscriptionCallback<TIO, TPresence, TSubject>): () => void;
     abstract transact(fn: (storage: TStorage) => void, origin?: string): void;
@@ -84,16 +84,56 @@ declare abstract class AbstractStorageStore {
     abstract initialize(): Promise<void>;
 }
 
-type CrdtManagerOptions<TStorage extends Record<string, AbstractType<any>> = {}> = {
+type CrdtManagerOptions<TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = {
     encodedState?: string | Uint8Array | null;
-    initialStorage?: () => TStorage;
-} & TrackOriginOptions;
+    initialStorage?: AbstractCrdtDocFactory<TStorage>;
+};
 
 type UsersManagerConfig<TPresence extends JsonObject = {}> = {
     initialPresence?: TPresence;
     presence?: InputZodLike<TPresence>;
 };
 
+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 = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = {
+    events?: MockedRoomEvents<TIO>;
+} & Omit<CrdtManagerOptions<TStorage>, "encodedState"> & UsersManagerConfig<TPresence>;
+declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
+    private _crdtManager;
+    private _crdtNotifier;
+    private _eventNotifier;
+    private _events?;
+    private _otherNotifier;
+    private _state;
+    private _stateNotifier;
+    private _subscriptions;
+    private _usersManager;
+    constructor(room: string, options: MockedRoomConfig<TIO, TPresence, TStorage>);
+    get storageLoaded(): boolean;
+    broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
+    canRedo: () => boolean;
+    canUndo: () => boolean;
+    event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
+    getConnection(): WebSocketConnection;
+    getDoc(): AbstractCrdtDoc<TStorage>;
+    getMyPresence: () => TPresence;
+    getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
+    getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
+    getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
+    getStorage: <TKey extends keyof TStorage>(key: TKey) => TStorage[TKey] | null;
+    other: (connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>) => (() => void);
+    redo: () => void;
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>; }) => void) => (() => void);
+    subscribe: <TSubject extends keyof StateNotifierSubjects<TIO, TPresence>>(name: TSubject, callback: SubscriptionCallback<TIO, TPresence, TSubject>) => (() => void);
+    transact: (fn: (storage: TStorage) => void, origin?: string) => void;
+    undo: () => void;
+    updateMyPresence: (presence: Partial<TPresence>) => void;
+    private _observeCrdt;
+}
+
 declare global {
     var process: {
         env: {
@@ -114,8 +154,8 @@ type RoomEndpoints<TIO extends IOLike> = {
 } : {
     authEndpoint?: undefined;
 });
-type PluvRoomAddon<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> = (input: PluvRoomAddonInput<TIO, TPresence, TStorage>) => Partial<PluvRoomAddonResult>;
-interface PluvRoomAddonInput<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> {
+type PluvRoomAddon<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = (input: PluvRoomAddonInput<TIO, TPresence, TStorage>) => Partial<PluvRoomAddonResult>;
+interface PluvRoomAddonInput<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> {
     room: PluvRoom<TIO, TPresence, TStorage>;
 }
 interface PluvRoomAddonResult {
@@ -125,15 +165,14 @@ type PluvRoomDebug<TIO extends IOLike> = Id<{
     output: readonly (keyof InferIOOutput<TIO>)[];
     input: readonly (keyof InferIOInput<TIO>)[];
 }>;
-type PluvRoomOptions<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> = {
+type PluvRoomOptions<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
 } & Omit<CrdtManagerOptions<TStorage>, "encodedState"> & UsersManagerConfig<TPresence>;
-type RoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> = RoomEndpoints<TIO> & PluvRoomOptions<TIO, TPresence, TStorage> & TrackOriginOptions;
-declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
+type RoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = RoomEndpoints<TIO> & PluvRoomOptions<TIO, TPresence, TStorage>;
+declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO>;
-    private _captureTimeout;
     private _crdtManager;
     private _crdtNotifier;
     private _debug;
@@ -146,11 +185,11 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _storageStore;
     private _subscriptions;
     private _timeouts;
-    private _trackedOrigins;
     private _windowListeners;
     private _wsListeners;
     private _usersManager;
     constructor(room: string, options: RoomConfig<TIO, TPresence, TStorage>);
+    get storageLoaded(): boolean;
     get webSocket(): WebSocket | null;
     broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     canRedo: () => boolean;
@@ -159,16 +198,16 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     disconnect(): Promise<void>;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
-    getDoc(): Doc;
+    getDoc(): AbstractCrdtDoc<TStorage>;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
     getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
-    getStorage: <TKey extends keyof TStorage>(key: TKey) => TStorage[TKey];
+    getStorage: <TKey extends keyof TStorage>(key: TKey) => TStorage[TKey] | null;
     other: (connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>) => (() => void);
     redo: () => void;
-    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void) => (() => void);
-    storageRoot: (fn: (value: { [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>; }) => void) => (() => void);
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>; }) => void) => (() => void);
     subscribe: <TSubject extends keyof StateNotifierSubjects<TIO, TPresence>>(name: TSubject, callback: SubscriptionCallback<TIO, TPresence, TSubject>) => (() => void);
     transact: (fn: (storage: TStorage) => void, origin?: string) => void;
     undo: () => void;
@@ -187,7 +226,6 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _getAddon;
     private _getAuthFetchOptions;
     private _getAuthorization;
-    private _getTrackedOrigins;
     private _getWsEndpoint;
     private _handleExit;
     private _handlePresenceUpdatedMessage;
@@ -234,9 +272,9 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     private _wsEndpoint;
     private _rooms;
     constructor(options: PluvClientOptions<TIO>);
-    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}>(room: string, options?: PluvRoomOptions<TIO, TPresence, TStorage>) => PluvRoom<TIO, TPresence, TStorage>;
+    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}>(room: string, options: PluvRoomOptions<TIO, TPresence, TStorage>) => PluvRoom<TIO, TPresence, TStorage>;
     enter: (room: string | PluvRoom<TIO, any, any>) => Promise<PluvRoom<TIO, JsonObject, any>>;
-    getRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}>(room: string) => PluvRoom<TIO, TPresence, TStorage> | null;
+    getRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}>(room: string) => PluvRoom<TIO, TPresence, TStorage> | null;
     getRooms: () => readonly PluvRoom<TIO, JsonObject, any>[];
     leave: (room: string | PluvRoom<TIO, any, any>) => Promise<void>;
     private _logDebug;
@@ -244,54 +282,4 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
 
 declare const createClient: <TIO extends IOLike<_pluv_types.IOAuthorize<any, any>, {}, {}, {}, {}> = IOLike<_pluv_types.IOAuthorize<any, any>, {}, {}, {}, {}>>(options: PluvClientOptions<TIO>) => PluvClient<TIO>;
 
-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 = {}, TStorage extends Record<string, AbstractType<any>> = {}> = {
-    events?: MockedRoomEvents<TIO>;
-} & Omit<CrdtManagerOptions<TStorage>, "encodedState"> & UsersManagerConfig<TPresence>;
-declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
-    private _crdtManager;
-    private _crdtNotifier;
-    private _eventNotifier;
-    private _events?;
-    private _otherNotifier;
-    private _state;
-    private _stateNotifier;
-    private _subscriptions;
-    private _usersManager;
-    constructor(room: string, options: MockedRoomConfig<TIO, TPresence, TStorage>);
-    broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
-    canRedo: () => boolean;
-    canUndo: () => boolean;
-    event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
-    getConnection(): WebSocketConnection;
-    getDoc(): Doc;
-    getMyPresence: () => TPresence;
-    getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
-    getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
-    getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
-    getStorage: <TKey extends keyof TStorage>(key: TKey) => TStorage[TKey];
-    other: (connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>) => (() => void);
-    redo: () => void;
-    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void) => (() => void);
-    storageRoot: (fn: (value: { [P in keyof TStorage]: InferYjsSharedTypeJson<TStorage[P]>; }) => void) => (() => void);
-    subscribe: <TSubject extends keyof StateNotifierSubjects<TIO, TPresence>>(name: TSubject, callback: SubscriptionCallback<TIO, TPresence, TSubject>) => (() => void);
-    transact: (fn: (storage: TStorage) => void, origin?: string) => void;
-    undo: () => void;
-    updateMyPresence: (presence: Partial<TPresence>) => void;
-    private _observeCrdt;
-}
-
-declare const y_array: typeof array;
-declare const y_map: typeof map;
-declare const y_object: typeof object;
-declare const y_text: typeof text;
-declare const y_xmlElement: typeof xmlElement;
-declare const y_xmlFragment: typeof xmlFragment;
-declare const y_xmlText: typeof xmlText;
-declare namespace y {
-  export { y_array as array, y_map as map, y_object as object, y_text as text, y_xmlElement as xmlElement, y_xmlFragment as xmlFragment, y_xmlText as xmlText };
-}
-
-export { AbstractRoom, AbstractStorageStore, ConnectionState, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, y };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, type UserInfo, type WebSocketConnection, type WebSocketState, createClient };