@pluv/client 0.18.0 → 0.20.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/client@0.18.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.20.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 v8.0.2
-CLI Target: es6
-ESM Build start
-CJS Build start
-ESM dist/index.mjs 41.27 KB
-ESM ⚡️ Build success in 104ms
-CJS dist/index.js 42.53 KB
-CJS ⚡️ Build success in 104ms
-DTS Build start
-DTS ⚡️ Build success in 3547ms
-DTS dist/index.d.mts 14.14 KB
-DTS dist/index.d.ts  14.14 KB
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.1.0
+CLI Target: es6
+ESM Build start
+CJS Build start
+ESM dist/index.mjs 41.48 KB
+ESM ⚡️ Build success in 74ms
+CJS dist/index.js 42.74 KB
+CJS ⚡️ Build success in 87ms
+DTS Build start
+DTS ⚡️ Build success in 3234ms
+DTS dist/index.d.mts 14.64 KB
+DTS dist/index.d.ts  14.64 KB

package/CHANGELOG.md

@@ -1,5 +1,106 @@
 # @pluv/client
 
+## 0.20.0
+
+### Minor Changes
+
+- 9492085: **BREAKING**: `@pluv/crdt-yjs` and `@pluv/crdt-loro` have been updated so that the utilities to create shared-types/containers no-longer return a wrapper around the underlying shared-types and containers, but rather return the shared-types/containers directly.
+
+  This means that for methods such as `getStorage` from `@pluv/client` and `useStorage` from `@pluv/react`, the shared-types/containers are also returned instead of the wrapper types.
+
+  The motivation for these changes are so that pluv.io is supplementary to `yjs` and `loro-crdt`, instead of having these libraries be an internal implementation of pluv.io.
+
+  ```ts
+  // Before
+
+  import { yjs } from "@pluv/crdt-yjs";
+
+  yjs.array([]); // Returns CrdtYjsArray
+  yjs.object([]); // Returns CrdtYjsObject
+
+  const room: PluvRoom = /* ... */;
+
+  room.getStorage("messages"); // Returns AbstractCrdtType
+
+  const [, sharedType] = useStorage("messages"); // sharedType is an AbstractCrdtType
+  ```
+
+  ```ts
+  // Now
+
+  import { yjs } from "@pluv/crdt-yjs";
+
+  yjs.array([]); // Returns yjs.Array
+  yjs.object([]); // Returns yjs.Map
+
+  const room: PluvRoom = /* ... */;
+
+  room.getStorage("messages"); // Returns yjs.AbstractType
+
+  const [, sharedType] = useStorage("messages"); // sharedType is a yjs.AbstractType
+  ```
+
+  For `@pluv/crdt-loro` specifically, `@pluv/client` relies on [loro events and subscriptions](https://www.loro.dev/docs/tutorial/get_started#event) to detect changes. The `AbstractLoroCrdt` types previously called `Loro.commit` after each change as an abstraction, but now this no-longer happens. To ensure that changes to loro containers are properly handled in `@pluv/react`, make sure to commit your changes whenever possible:
+
+  ```ts
+  // Before
+
+  const [data, container] = useStorage("messages");
+
+  // This automatically called Loro.commit under the hood and rerendered the page with updated data.
+  container.push(loro.object({ name: "John Doe", age: 35 }));
+  ```
+
+  ```ts
+  // Now
+
+  const [data, container] = useStorage("messages");
+
+  const doc = useDoc();
+  const transact = useTransact();
+
+  // Updates need to be committed back to the doc whenever the changes need to be emitted to other users
+  // The returned data also will not update until the changes are commited
+
+  // The two operations below are functionally equivalent
+  transact(() => {
+    container.push(loro.object({ name: "John Doe", age: 35 }));
+  });
+
+  container.push(loro.object({ name: "John Doe", age: 35 }));
+  doc.value.commit();
+  ```
+
+### Patch Changes
+
+- Updated dependencies [9492085]
+  - @pluv/crdt@0.20.0
+  - @pluv/types@0.20.0
+
+## 0.19.0
+
+### Patch Changes
+
+- 137444b: Updated PluvRoom.updateMyPresence to allow passing in a callback function that exposes the previous presence value and returns a presence update.
+
+  ```ts
+  type Presence = {
+      selectionId: string | null;
+  };
+
+  const room: PluvRoom = /* ... */;
+  const newSelectionId: string | null = /* ... */;
+
+  room.updateMyPresence({ selectionId: newSelection });
+
+  // You can reference the previous presence and return a new presence based on it
+  room.updateMyPresence((previousPresence) => ({ selectionId: newSelection ?? previousPresence.selectionId }));
+  ```
+
+- f5e4370: Fix others' presence not getting tracked in PluvRoom when the user is unauthorized.
+  - @pluv/crdt@0.19.0
+  - @pluv/types@0.19.0
+
 ## 0.18.0
 
 ### Minor Changes

package/README.md

@@ -1,30 +1,3 @@
-> **Disclaimer:**
-> This package is currently in preview and may have breaking changes between versions. Please wait for a `v1.0.0` stable release before using this in production.
-
-<h1 align="center">
-  <br />
-  <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px" />
-  <br />
-  <a href="https://pluv.io/docs/introduction">Pluv.IO (preview)</a>
-  <br />
-</h1>
-
-<h3 align="center">Multi-platform, E2E type-safe realtime packages</h3>
-<h4 align="center">💕 Inspired by <a href="https://trpc.io">trpc</a> 💕 <a href="https://docs.yjs.dev/">yjs</a> 💕 and <a href="https://developers.cloudflare.com/">Cloudflare</a> 💕 </h4>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/@pluv/client">
-    <img src="https://img.shields.io/npm/v/@pluv/client" alt="npm @pluv/client" />
-  </a>
-  <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
-    <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
-  </a>
-  <a href="https://commitizen.github.io/cz-cli/">
-    <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
-  </a>
-  <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript" />
-</p>
-
 ## `@pluv/client`
 
 > Framework agnostic frontend client for [@pluv/io](https://www.npmjs.com/package/@pluv/io)
@@ -43,68 +16,3 @@ yarn add @pluv/client @pluv/crdt-yjs yjs
 # pnpm
 pnpm add @pluv/client @pluv/crdt-yjs yjs
 ```
-
-If you plan on using presence and/or storage, make sure to also install `zod`.
-
-## Basic Example
-
-```ts
-import { createClient } from "@pluv/client";
-import { yjs } from "@pluv/crdt-yjs";
-import { z } from "zod";
-// Import the PluvIO instance as a type from your server file
-import { type io } from "./server";
-
-// Initialize the @pluv/client client
-const client = createClient<typeof io>({
-    authEndpoint: (room) => {
-        return `https://localhost:3000/api/authorize?room=${room}`;
-    },
-    wsEndpoint: (room) => {
-        return `ws://localhost:3000/api/room/${room}`;
-    },
-});
-
-interface Presence {
-    cursor: { x: number; y: number } | null;
-}
-
-interface Storage {
-    messages: readonly { name: string; message: string }[]
-}
-
-// Create a room to join
-const room = client.createRoom<Presence, Storage>("my-room", {
-    initialPresence: { cursor: null },
-    initialStorage: yjs.doc(() => ({ messages: yjs.array([]) })),
-    onAuthorizationFail: (error) => {
-        console.log(error.message);
-    },
-    presence: z.object({
-        cursor: z.nullable(
-            z.object({
-                x: z.number(),
-                y: z.number(),
-            })
-        ),
-    }),
-});
-
-const main = async () => {
-    await client.enter(room);
-
-    const unsubscribe = client.event.RECEIVE_MESSAGE(({ data }) => {
-        console.log(data.message);
-    });
-
-    client.broadcast.SEND_MESSAGE({ message: "Hello world!" });
-
-    unsubscribe();
-
-    client.leave(room);
-};
-```
-
-## Reference
-
-Check us out on [GitHub](https://github.com/pluv-io/pluv) for more information on how to use `@pluv/io`.

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { AbstractCrdtType, AbstractCrdtDoc, InferCrdtStorageJson, AbstractCrdtDocFactory } from '@pluv/crdt';
-export { AbstractCrdtType, InferCrdtStorageJson } from '@pluv/crdt';
+import { CrdtType, AbstractCrdtDoc, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
+export { CrdtType, InferCrdtJson } 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';
@@ -18,6 +18,12 @@ declare enum ConnectionState {
     Unavailable = "Unavailable",
     Untouched = "Untouched"
 }
+type UpdateMyPresenceAction<TPresence extends JsonObject> = Partial<TPresence> | ((oldPresence: TPresence | null) => Partial<TPresence>);
+interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
+    connectionId: string;
+    presence: TPresence;
+    user: Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>;
+}
 interface WebSocketConnection {
     count: number;
     id: string | null;
@@ -28,11 +34,6 @@ interface WebSocketState<TIO extends IOLike> {
     connection: WebSocketConnection;
     webSocket: WebSocket | null;
 }
-interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
-    connectionId: string;
-    presence: TPresence;
-    user: Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>;
-}
 
 type OtherNotifierSubscriptionCallback<TIO extends IOLike> = (value: Id<UserInfo<TIO>> | null) => void;
 
@@ -46,7 +47,7 @@ interface StateNotifierSubjects<TIO extends IOLike, TPresence extends JsonObject
 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, AbstractCrdtType<any, any>> = {}> {
+declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
     readonly id: string;
     constructor(room: string);
     abstract storageLoaded: boolean;
@@ -60,17 +61,19 @@ 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>(type: TKey): TStorage[TKey] | null;
+    abstract getStorageJson(): InferCrdtJson<TStorage> | null;
+    abstract getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]> | null;
     abstract other(connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>): () => void;
     abstract redo(): void;
-    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void): () => void;
+    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void): () => void;
     abstract storageRoot(fn: (value: {
-        [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
+        [P in keyof TStorage]: InferCrdtJson<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;
     abstract undo(): void;
-    abstract updateMyPresence(presence: Partial<TPresence>): void;
+    abstract updateMyPresence(presence: UpdateMyPresenceAction<TPresence>): void;
 }
 
 declare abstract class AbstractStorageStore {
@@ -84,7 +87,7 @@ declare abstract class AbstractStorageStore {
     abstract initialize(): Promise<void>;
 }
 
-type CrdtManagerOptions<TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = {
+type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
     encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
 };
@@ -97,10 +100,10 @@ type UsersManagerConfig<TPresence extends JsonObject = {}> = {
 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>> = {}> = {
+type MockedRoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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> {
+declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     private _crdtManager;
     private _crdtNotifier;
     private _eventNotifier;
@@ -116,21 +119,23 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     canRedo: () => boolean;
     canUndo: () => boolean;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
-    getConnection(): WebSocketConnection;
+    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;
+    getStorage: <TKey extends keyof TStorage>(type: TKey) => TStorage[TKey] | null;
+    getStorageJson(): InferCrdtJson<TStorage> | null;
+    getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<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);
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtJson<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;
+    updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _observeCrdt;
 }
 
@@ -154,8 +159,8 @@ type RoomEndpoints<TIO extends IOLike> = {
 } : {
     authEndpoint?: undefined;
 });
-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>> = {}> {
+type PluvRoomAddon<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = (input: PluvRoomAddonInput<TIO, TPresence, TStorage>) => Partial<PluvRoomAddonResult>;
+interface PluvRoomAddonInput<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
     room: PluvRoom<TIO, TPresence, TStorage>;
 }
 interface PluvRoomAddonResult {
@@ -165,13 +170,13 @@ 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, AbstractCrdtType<any, any>> = {}> = {
+type PluvRoomOptions<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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, 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> {
+type RoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = RoomEndpoints<TIO> & PluvRoomOptions<TIO, TPresence, TStorage>;
+declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO>;
     private _crdtManager;
     private _crdtNotifier;
@@ -197,21 +202,23 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     event: (<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => () => void) & { [event in keyof InferIOOutput<TIO>]: (callback: EventNotifierSubscriptionCallback<TIO, event>) => () => void; };
-    getConnection(): WebSocketConnection;
-    getDoc(): AbstractCrdtDoc<TStorage>;
+    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;
+    getStorage: <TKey extends keyof TStorage>(type: TKey) => TStorage[TKey] | null;
+    getStorageJson(): InferCrdtJson<TStorage> | null;
+    getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<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);
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtJson<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;
+    updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _addToStorageStore;
     private _applyStorageStore;
     private _attachWindowListeners;
@@ -272,9 +279,9 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     private _wsEndpoint;
     private _rooms;
     constructor(options: PluvClientOptions<TIO>);
-    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}>(room: string, options: PluvRoomOptions<TIO, TPresence, TStorage>) => PluvRoom<TIO, TPresence, TStorage>;
+    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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, AbstractCrdtType<any, any>> = {}>(room: string) => PluvRoom<TIO, TPresence, TStorage> | null;
+    getRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { AbstractCrdtType, AbstractCrdtDoc, InferCrdtStorageJson, AbstractCrdtDocFactory } from '@pluv/crdt';
-export { AbstractCrdtType, InferCrdtStorageJson } from '@pluv/crdt';
+import { CrdtType, AbstractCrdtDoc, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
+export { CrdtType, InferCrdtJson } 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';
@@ -18,6 +18,12 @@ declare enum ConnectionState {
     Unavailable = "Unavailable",
     Untouched = "Untouched"
 }
+type UpdateMyPresenceAction<TPresence extends JsonObject> = Partial<TPresence> | ((oldPresence: TPresence | null) => Partial<TPresence>);
+interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
+    connectionId: string;
+    presence: TPresence;
+    user: Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>;
+}
 interface WebSocketConnection {
     count: number;
     id: string | null;
@@ -28,11 +34,6 @@ interface WebSocketState<TIO extends IOLike> {
     connection: WebSocketConnection;
     webSocket: WebSocket | null;
 }
-interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
-    connectionId: string;
-    presence: TPresence;
-    user: Id<InferIOAuthorizeUser<InferIOAuthorize<TIO>>>;
-}
 
 type OtherNotifierSubscriptionCallback<TIO extends IOLike> = (value: Id<UserInfo<TIO>> | null) => void;
 
@@ -46,7 +47,7 @@ interface StateNotifierSubjects<TIO extends IOLike, TPresence extends JsonObject
 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, AbstractCrdtType<any, any>> = {}> {
+declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
     readonly id: string;
     constructor(room: string);
     abstract storageLoaded: boolean;
@@ -60,17 +61,19 @@ 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>(type: TKey): TStorage[TKey] | null;
+    abstract getStorageJson(): InferCrdtJson<TStorage> | null;
+    abstract getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]> | null;
     abstract other(connectionId: string, callback: OtherNotifierSubscriptionCallback<TIO>): () => void;
     abstract redo(): void;
-    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtStorageJson<TStorage[TKey]>) => void): () => void;
+    abstract storage<TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void): () => void;
     abstract storageRoot(fn: (value: {
-        [P in keyof TStorage]: InferCrdtStorageJson<TStorage[P]>;
+        [P in keyof TStorage]: InferCrdtJson<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;
     abstract undo(): void;
-    abstract updateMyPresence(presence: Partial<TPresence>): void;
+    abstract updateMyPresence(presence: UpdateMyPresenceAction<TPresence>): void;
 }
 
 declare abstract class AbstractStorageStore {
@@ -84,7 +87,7 @@ declare abstract class AbstractStorageStore {
     abstract initialize(): Promise<void>;
 }
 
-type CrdtManagerOptions<TStorage extends Record<string, AbstractCrdtType<any, any>> = {}> = {
+type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
     encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
 };
@@ -97,10 +100,10 @@ type UsersManagerConfig<TPresence extends JsonObject = {}> = {
 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>> = {}> = {
+type MockedRoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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> {
+declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     private _crdtManager;
     private _crdtNotifier;
     private _eventNotifier;
@@ -116,21 +119,23 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     canRedo: () => boolean;
     canUndo: () => boolean;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
-    getConnection(): WebSocketConnection;
+    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;
+    getStorage: <TKey extends keyof TStorage>(type: TKey) => TStorage[TKey] | null;
+    getStorageJson(): InferCrdtJson<TStorage> | null;
+    getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<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);
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtJson<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;
+    updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _observeCrdt;
 }
 
@@ -154,8 +159,8 @@ type RoomEndpoints<TIO extends IOLike> = {
 } : {
     authEndpoint?: undefined;
 });
-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>> = {}> {
+type PluvRoomAddon<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = (input: PluvRoomAddonInput<TIO, TPresence, TStorage>) => Partial<PluvRoomAddonResult>;
+interface PluvRoomAddonInput<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
     room: PluvRoom<TIO, TPresence, TStorage>;
 }
 interface PluvRoomAddonResult {
@@ -165,13 +170,13 @@ 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, AbstractCrdtType<any, any>> = {}> = {
+type PluvRoomOptions<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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, 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> {
+type RoomConfig<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> = RoomEndpoints<TIO> & PluvRoomOptions<TIO, TPresence, TStorage>;
+declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> extends AbstractRoom<TIO, TPresence, TStorage> {
     readonly _endpoints: RoomEndpoints<TIO>;
     private _crdtManager;
     private _crdtNotifier;
@@ -197,21 +202,23 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     event: (<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => () => void) & { [event in keyof InferIOOutput<TIO>]: (callback: EventNotifierSubscriptionCallback<TIO, event>) => () => void; };
-    getConnection(): WebSocketConnection;
-    getDoc(): AbstractCrdtDoc<TStorage>;
+    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;
+    getStorage: <TKey extends keyof TStorage>(type: TKey) => TStorage[TKey] | null;
+    getStorageJson(): InferCrdtJson<TStorage> | null;
+    getStorageJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<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);
+    storage: <TKey extends keyof TStorage>(key: TKey, fn: (value: InferCrdtJson<TStorage[TKey]>) => void) => (() => void);
+    storageRoot: (fn: (value: { [P in keyof TStorage]: InferCrdtJson<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;
+    updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _addToStorageStore;
     private _applyStorageStore;
     private _attachWindowListeners;
@@ -272,9 +279,9 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     private _wsEndpoint;
     private _rooms;
     constructor(options: PluvClientOptions<TIO>);
-    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractCrdtType<any, any>> = {}>(room: string, options: PluvRoomOptions<TIO, TPresence, TStorage>) => PluvRoom<TIO, TPresence, TStorage>;
+    createRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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, AbstractCrdtType<any, any>> = {}>(room: string) => PluvRoom<TIO, TPresence, TStorage> | null;
+    getRoom: <TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<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;