@pluv/client 0.12.0 → 0.12.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.12.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.12.1 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 42.91 KB
-ESM ⚡️ Build success in 113ms
-CJS dist/index.js 44.16 KB
-CJS ⚡️ Build success in 113ms
+CJS dist/index.js 44.05 KB
+CJS ⚡️ Build success in 109ms
+ESM dist/index.mjs 42.81 KB
+ESM ⚡️ Build success in 110ms
 DTS Build start
-DTS ⚡️ Build success in 4686ms
-DTS dist/index.d.mts 14.25 KB
-DTS dist/index.d.ts  14.25 KB
+DTS ⚡️ Build success in 4203ms
+DTS dist/index.d.mts 14.23 KB
+DTS dist/index.d.ts  14.23 KB

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @pluv/client
 
+## 0.12.1
+
+### Patch Changes
+
+- cae08aa: Updated storage from `getStorage` to never return null
+  - @pluv/crdt-yjs@0.12.1
+  - @pluv/types@0.12.1
+
 ## 0.12.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -59,7 +59,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     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] | null;
+    abstract getStorage<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
     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;
@@ -162,7 +162,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
+    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);
@@ -268,7 +268,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     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;
+    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);

package/dist/index.d.ts

@@ -59,7 +59,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     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] | null;
+    abstract getStorage<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
     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;
@@ -162,7 +162,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
+    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);
@@ -268,7 +268,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     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;
+    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);

package/dist/index.js

@@ -474,8 +474,11 @@ var PluvRoom = class extends AbstractRoom {
       return this._usersManager.getOthers();
     };
     this.getStorage = (key) => {
-      var _a, _b;
-      return (_b = (_a = this._crdtManager) == null ? void 0 : _a.get(key)) != null ? _b : null;
+      const sharedType = this._crdtManager.get(key);
+      if (typeof sharedType === "undefined") {
+        throw new Error(`Could not find storege: ${key.toString()}`);
+      }
+      return sharedType;
     };
     this.other = (connectionId, callback) => {
       return this._otherNotifier.subscribe(connectionId, callback);
@@ -612,7 +615,6 @@ var PluvRoom = class extends AbstractRoom {
   }
   disconnect() {
     return __async(this, null, function* () {
-      var _a;
       if (!this._endpoints.wsEndpoint) {
         throw new Error("Must provide an wsEndpoint.");
       }
@@ -627,7 +629,7 @@ var PluvRoom = class extends AbstractRoom {
       this._clearInterval(this._intervals.heartbeat);
       this._closeWs();
       yield this._storageStore.destroy();
-      (_a = this._crdtManager) == null ? void 0 : _a.destroy();
+      this._crdtManager.destroy();
       this._stateNotifier.subjects["my-presence"].next(null);
     });
   }
@@ -892,7 +894,7 @@ var PluvRoom = class extends AbstractRoom {
     this._stateNotifier.subjects["others"].next(others);
   }
   _handleRegisteredMessage(message) {
-    var _a, _b, _c;
+    var _a, _b;
     const { connectionId, user } = message;
     if (!connectionId)
       return;
@@ -912,7 +914,7 @@ var PluvRoom = class extends AbstractRoom {
     const myself = (_a = this._usersManager.myself) != null ? _a : null;
     this._stateNotifier.subjects["my-presence"].next(presence);
     this._stateNotifier.subjects["myself"].next(myself);
-    const update = this._state.connection.count > 1 ? (_c = (_b = this._crdtManager) == null ? void 0 : _b.doc.encodeStateAsUpdate()) != null ? _c : null : null;
+    const update = this._state.connection.count > 1 ? (_b = this._crdtManager.doc.encodeStateAsUpdate()) != null ? _b : null : null;
     this._sendMessage({
       type: "$INITIALIZE_SESSION",
       data: { presence, update }
@@ -1295,7 +1297,6 @@ var MockedRoom = class extends AbstractRoom {
   constructor(room, options) {
     const { events, initialPresence, initialStorage, presence } = options;
     super(room);
-    this._crdtManager = null;
     this._crdtNotifier = new CrdtNotifier();
     this._eventNotifier = new EventNotifier();
     this._otherNotifier = new OtherNotifier();
@@ -1316,12 +1317,10 @@ var MockedRoom = class extends AbstractRoom {
       observeCrdt: null
     };
     this.canRedo = () => {
-      var _a;
-      return !!((_a = this._crdtManager) == null ? void 0 : _a.doc.canRedo());
+      return !!this._crdtManager.doc.canRedo();
     };
     this.canUndo = () => {
-      var _a;
-      return !!((_a = this._crdtManager) == null ? void 0 : _a.doc.canUndo());
+      return !!this._crdtManager.doc.canUndo();
     };
     this.event = (event, callback) => {
       return this._eventNotifier.subscribe(event, callback);
@@ -1339,15 +1338,17 @@ var MockedRoom = class extends AbstractRoom {
       return this._usersManager.getOthers();
     };
     this.getStorage = (key) => {
-      var _a, _b;
-      return (_b = (_a = this._crdtManager) == null ? void 0 : _a.get(key)) != null ? _b : null;
+      const sharedType = this._crdtManager.get(key);
+      if (typeof sharedType === "undefined") {
+        throw new Error(`Could not find storege: ${key.toString()}`);
+      }
+      return sharedType;
     };
     this.other = (connectionId, callback) => {
       return this._otherNotifier.subscribe(connectionId, callback);
     };
     this.redo = () => {
-      var _a;
-      (_a = this._crdtManager) == null ? void 0 : _a.doc.redo();
+      this._crdtManager.doc.redo();
     };
     this.storage = (key, fn) => {
       return this._crdtNotifier.subscribe(key, fn);
@@ -1370,8 +1371,7 @@ var MockedRoom = class extends AbstractRoom {
       }, _origin);
     };
     this.undo = () => {
-      var _a;
-      (_a = this._crdtManager) == null ? void 0 : _a.doc.undo();
+      this._crdtManager.doc.undo();
     };
     this.updateMyPresence = (presence) => {
       var _a;

package/dist/index.mjs

@@ -448,8 +448,11 @@ var PluvRoom = class extends AbstractRoom {
       return this._usersManager.getOthers();
     };
     this.getStorage = (key) => {
-      var _a, _b;
-      return (_b = (_a = this._crdtManager) == null ? void 0 : _a.get(key)) != null ? _b : null;
+      const sharedType = this._crdtManager.get(key);
+      if (typeof sharedType === "undefined") {
+        throw new Error(`Could not find storege: ${key.toString()}`);
+      }
+      return sharedType;
     };
     this.other = (connectionId, callback) => {
       return this._otherNotifier.subscribe(connectionId, callback);
@@ -586,7 +589,6 @@ var PluvRoom = class extends AbstractRoom {
   }
   disconnect() {
     return __async(this, null, function* () {
-      var _a;
       if (!this._endpoints.wsEndpoint) {
         throw new Error("Must provide an wsEndpoint.");
       }
@@ -601,7 +603,7 @@ var PluvRoom = class extends AbstractRoom {
       this._clearInterval(this._intervals.heartbeat);
       this._closeWs();
       yield this._storageStore.destroy();
-      (_a = this._crdtManager) == null ? void 0 : _a.destroy();
+      this._crdtManager.destroy();
       this._stateNotifier.subjects["my-presence"].next(null);
     });
   }
@@ -866,7 +868,7 @@ var PluvRoom = class extends AbstractRoom {
     this._stateNotifier.subjects["others"].next(others);
   }
   _handleRegisteredMessage(message) {
-    var _a, _b, _c;
+    var _a, _b;
     const { connectionId, user } = message;
     if (!connectionId)
       return;
@@ -886,7 +888,7 @@ var PluvRoom = class extends AbstractRoom {
     const myself = (_a = this._usersManager.myself) != null ? _a : null;
     this._stateNotifier.subjects["my-presence"].next(presence);
     this._stateNotifier.subjects["myself"].next(myself);
-    const update = this._state.connection.count > 1 ? (_c = (_b = this._crdtManager) == null ? void 0 : _b.doc.encodeStateAsUpdate()) != null ? _c : null : null;
+    const update = this._state.connection.count > 1 ? (_b = this._crdtManager.doc.encodeStateAsUpdate()) != null ? _b : null : null;
     this._sendMessage({
       type: "$INITIALIZE_SESSION",
       data: { presence, update }
@@ -1269,7 +1271,6 @@ var MockedRoom = class extends AbstractRoom {
   constructor(room, options) {
     const { events, initialPresence, initialStorage, presence } = options;
     super(room);
-    this._crdtManager = null;
     this._crdtNotifier = new CrdtNotifier();
     this._eventNotifier = new EventNotifier();
     this._otherNotifier = new OtherNotifier();
@@ -1290,12 +1291,10 @@ var MockedRoom = class extends AbstractRoom {
       observeCrdt: null
     };
     this.canRedo = () => {
-      var _a;
-      return !!((_a = this._crdtManager) == null ? void 0 : _a.doc.canRedo());
+      return !!this._crdtManager.doc.canRedo();
     };
     this.canUndo = () => {
-      var _a;
-      return !!((_a = this._crdtManager) == null ? void 0 : _a.doc.canUndo());
+      return !!this._crdtManager.doc.canUndo();
     };
     this.event = (event, callback) => {
       return this._eventNotifier.subscribe(event, callback);
@@ -1313,15 +1312,17 @@ var MockedRoom = class extends AbstractRoom {
       return this._usersManager.getOthers();
     };
     this.getStorage = (key) => {
-      var _a, _b;
-      return (_b = (_a = this._crdtManager) == null ? void 0 : _a.get(key)) != null ? _b : null;
+      const sharedType = this._crdtManager.get(key);
+      if (typeof sharedType === "undefined") {
+        throw new Error(`Could not find storege: ${key.toString()}`);
+      }
+      return sharedType;
     };
     this.other = (connectionId, callback) => {
       return this._otherNotifier.subscribe(connectionId, callback);
     };
     this.redo = () => {
-      var _a;
-      (_a = this._crdtManager) == null ? void 0 : _a.doc.redo();
+      this._crdtManager.doc.redo();
     };
     this.storage = (key, fn) => {
       return this._crdtNotifier.subscribe(key, fn);
@@ -1344,8 +1345,7 @@ var MockedRoom = class extends AbstractRoom {
       }, _origin);
     };
     this.undo = () => {
-      var _a;
-      (_a = this._crdtManager) == null ? void 0 : _a.doc.undo();
+      this._crdtManager.doc.undo();
     };
     this.updateMyPresence = (presence) => {
       var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,8 +18,8 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt-yjs": "^0.12.0",
-    "@pluv/types": "^0.12.0"
+    "@pluv/crdt-yjs": "^0.12.1",
+    "@pluv/types": "^0.12.1"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
@@ -29,8 +29,8 @@
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "yjs": "^13.6.8",
-    "@pluv/tsconfig": "^0.12.0",
-    "eslint-config-pluv": "^0.12.0"
+    "@pluv/tsconfig": "^0.12.1",
+    "eslint-config-pluv": "^0.12.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/AbstractRoom.ts

@@ -54,7 +54,7 @@ export abstract class AbstractRoom<
 
     public abstract getStorage<TKey extends keyof TStorage>(
         key: TKey,
-    ): TStorage[TKey] | null;
+    ): TStorage[TKey];
 
     public abstract other(
         connectionId: string,

package/src/MockedRoom.ts

@@ -50,7 +50,7 @@ export class MockedRoom<
     TPresence extends JsonObject = {},
     TStorage extends Record<string, AbstractType<any>> = {},
 > extends AbstractRoom<TIO, TPresence, TStorage> {
-    private _crdtManager: CrdtManager<TStorage> | null = null;
+    private _crdtManager: CrdtManager<TStorage>;
     private _crdtNotifier = new CrdtNotifier<TStorage>();
     private _eventNotifier = new EventNotifier<TIO>();
     private _events?: MockedRoomEvents<TIO>;
@@ -118,11 +118,11 @@ export class MockedRoom<
     }
 
     public canRedo = (): boolean => {
-        return !!this._crdtManager?.doc.canRedo();
+        return !!this._crdtManager.doc.canRedo();
     };
 
     public canUndo = (): boolean => {
-        return !!this._crdtManager?.doc.canUndo();
+        return !!this._crdtManager.doc.canUndo();
     };
 
     public event = <TEvent extends keyof InferIOOutput<TIO>>(
@@ -159,8 +159,14 @@ export class MockedRoom<
 
     public getStorage = <TKey extends keyof TStorage>(
         key: TKey,
-    ): TStorage[TKey] | null => {
-        return this._crdtManager?.get(key) ?? null;
+    ): TStorage[TKey] => {
+        const sharedType = this._crdtManager.get(key);
+
+        if (typeof sharedType === "undefined") {
+            throw new Error(`Could not find storege: ${key.toString()}`);
+        }
+
+        return sharedType;
     };
 
     public other = (
@@ -171,7 +177,7 @@ export class MockedRoom<
     };
 
     public redo = (): void => {
-        this._crdtManager?.doc.redo();
+        this._crdtManager.doc.redo();
     };
 
     public storage = <TKey extends keyof TStorage>(
@@ -221,7 +227,7 @@ export class MockedRoom<
     };
 
     public undo = (): void => {
-        this._crdtManager?.doc.undo();
+        this._crdtManager.doc.undo();
     };
 
     public updateMyPresence = (presence: Partial<TPresence>): void => {

package/src/PluvRoom.ts

@@ -345,7 +345,7 @@ export class PluvRoom<
 
         await this._storageStore.destroy();
 
-        this._crdtManager?.destroy();
+        this._crdtManager.destroy();
 
         this._stateNotifier.subjects["my-presence"].next(null);
     }
@@ -384,8 +384,14 @@ export class PluvRoom<
 
     public getStorage = <TKey extends keyof TStorage>(
         key: TKey,
-    ): TStorage[TKey] | null => {
-        return this._crdtManager?.get(key) ?? null;
+    ): TStorage[TKey] => {
+        const sharedType = this._crdtManager.get(key);
+
+        if (typeof sharedType === "undefined") {
+            throw new Error(`Could not find storege: ${key.toString()}`);
+        }
+
+        return sharedType;
     };
 
     public other = (
@@ -826,7 +832,7 @@ export class PluvRoom<
 
         const update =
             this._state.connection.count > 1
-                ? this._crdtManager?.doc.encodeStateAsUpdate() ?? null
+                ? this._crdtManager.doc.encodeStateAsUpdate() ?? null
                 : null;
 
         this._sendMessage({