@pluv/client 0.8.0 → 0.9.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @pluv/client@0.8.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.9.0 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v6.7.0
+CLI tsup v7.0.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 35.24 KB
-ESM ⚡️ Build success in 95ms
-CJS dist/index.js 36.38 KB
-CJS ⚡️ Build success in 96ms
+CJS dist/index.js 40.23 KB
+CJS ⚡️ Build success in 98ms
+ESM dist/index.mjs 39.02 KB
+ESM ⚡️ Build success in 100ms
 DTS Build start
-DTS ⚡️ Build success in 4360ms
-DTS dist/index.d.ts 11.75 KB
+DTS ⚡️ Build success in 4765ms
+DTS dist/index.d.ts 12.92 KB

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # @pluv/client
 
+## 0.9.0
+
+### Minor Changes
+
+- 829d31b: Added support for defining persistant frontend storage for rooms via a new `addons` option on rooms.
+
+  This also introduces the first new addon `@pluv/addon-indexeddb`, which is more-or-less the equivalent to `y-indexeddb` which you can install like so:
+
+  ```
+  npm install @pluv/addon-indexeddb
+  ```
+
+  To use this new addon, simply pass it to options when creating a room:
+
+  ```ts
+  import { addonIndexedDB } from "@pluv/addon-indexeddb";
+  import { createClient } from "@pluv/client";
+
+  const client = createClient({
+    // ...
+  });
+
+  const room = client.createRoom("my-new-room", {
+    addons: [
+      // Define your addons in an array like so
+      addonIndexedDB(),
+    ],
+  });
+  ```
+
+  Or when using `@pluv/react`:
+
+  ```ts
+  const PluvRoom = createRoomBundle({
+    // ...
+    addons: [
+      // Define your addons in an array like so
+      addonIndexedDB(),
+    ],
+  });
+  ```
+
+### Patch Changes
+
+- 8d11672: bumped dependencies to latest
+- Updated dependencies [8d11672]
+- Updated dependencies [829d31b]
+  - @pluv/crdt-yjs@0.4.0
+  - @pluv/types@0.2.1
+
+## 0.8.1
+
+### Patch Changes
+
+- 2c9c5c3: changed my-presence to be non-nullable
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -53,7 +53,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     abstract event<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>): () => void;
     abstract getConnection(): WebSocketConnection;
-    abstract getMyPresence(): TPresence | null;
+    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>>[];
@@ -64,6 +64,17 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     abstract updateMyPresence(presence: Partial<TPresence>): void;
 }
 
+declare abstract class AbstractStorageStore {
+    room: string;
+    constructor(room: string);
+    abstract addUpdate(update: string): Promise<void>;
+    abstract destroy(): Promise<void>;
+    abstract flatten(encodedState: string): Promise<void>;
+    abstract getShouldFlatten(): Promise<boolean>;
+    abstract getUpdates(start?: number): Promise<readonly string[]>;
+    abstract initialize(): Promise<void>;
+}
+
 interface CrdtManagerOptions<TStorage extends Record<string, AbstractType<any>> = {}> {
     encodedState?: string | Uint8Array | null;
     initialStorage?: () => TStorage;
@@ -94,11 +105,19 @@ 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>> = {}> {
+    room: PluvRoom<TIO, TPresence, TStorage>;
+}
+interface PluvRoomAddonResult {
+    storage: AbstractStorageStore;
+}
 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>> = {}> = {
+    addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
 } & Omit<CrdtManagerOptions<TStorage>, "encodedState"> & UsersManagerConfig<TPresence>;
@@ -109,12 +128,12 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _crdtNotifier;
     private _debug;
     private _eventNotifier;
-    private _initialStorage;
     private _intervals;
     private _listeners;
     private _otherNotifier;
     private _state;
     private _stateNotifier;
+    private _storageStore;
     private _subscriptions;
     private _timeouts;
     private _windowListeners;
@@ -124,10 +143,10 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     get webSocket(): WebSocket | null;
     broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     connect(): Promise<void>;
-    disconnect(): void;
+    disconnect(): Promise<void>;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
-    getMyPresence: () => TPresence | null;
+    getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
     getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
@@ -136,6 +155,8 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferYjsSharedTypeJson<TStorage[TKey]>) => void) => (() => void);
     subscribe: <TSubject extends keyof StateNotifierSubjects<TIO, TPresence>>(name: TSubject, callback: SubscriptionCallback<TIO, TPresence, TSubject>) => (() => void);
     updateMyPresence: (presence: Partial<TPresence>) => void;
+    private _addToStorageStore;
+    private _applyStorageStore;
     private _attachWindowListeners;
     private _attachWsListeners;
     private _clearInterval;
@@ -143,8 +164,11 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _closeWs;
     private _detachWindowListeners;
     private _detachWsListeners;
-    private _getAuthorization;
+    private _emitSharedTypes;
+    private _flattenStorageStore;
+    private _getAddon;
     private _getAuthFetchOptions;
+    private _getAuthorization;
     private _getWsEndpoint;
     private _handleExit;
     private _handlePresenceUpdatedMessage;
@@ -195,7 +219,7 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     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;
     getRooms: () => readonly PluvRoom<TIO, JsonObject, any>[];
-    leave: (room: string | PluvRoom<TIO, any, any>) => void;
+    leave: (room: string | PluvRoom<TIO, any, any>) => Promise<void>;
     private _logDebug;
 }
 
@@ -221,7 +245,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
-    getMyPresence: () => TPresence | null;
+    getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
     getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
@@ -246,4 +270,4 @@ declare namespace y {
   };
 }
 
-export { AbstractRoom, ConnectionState, MockedRoom, MockedRoomConfig, MockedRoomEvents, PluvClient, PluvClientOptions, PluvRoom, PluvRoomDebug, UserInfo, WebSocketConnection, WebSocketState, createClient, y };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, MockedRoom, MockedRoomConfig, MockedRoomEvents, PluvClient, PluvClientOptions, PluvRoom, PluvRoomAddon, PluvRoomAddonInput, PluvRoomAddonResult, PluvRoomDebug, UserInfo, WebSocketConnection, WebSocketState, createClient, y };