@pluv/client 0.17.3 → 0.19.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/client@0.17.3 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.19.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
-CJS dist/index.js 42.79 KB
-CJS ⚡️ Build success in 125ms
-ESM dist/index.mjs 41.52 KB
-ESM ⚡️ Build success in 127ms
-DTS Build start
-DTS ⚡️ Build success in 3588ms
-DTS dist/index.d.mts 13.95 KB
-DTS dist/index.d.ts  13.95 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 40.97 KB
+ESM ⚡️ Build success in 85ms
+CJS dist/index.js 42.24 KB
+CJS ⚡️ Build success in 108ms
+DTS Build start
+DTS ⚡️ Build success in 3379ms
+DTS dist/index.d.mts 14.33 KB
+DTS dist/index.d.ts  14.33 KB

package/CHANGELOG.md

@@ -1,5 +1,181 @@
 # @pluv/client
 
+## 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
+
+- 99b5ca9: ## Breaking Changes
+
+  - `@pluv/io` has been updated to introduce `PluvProcedure`, `PluvRouter` and `PluvServer`. This change is intended to improve the ergonomics of declaring events and simplifying inferences of event types.
+
+  ### Before:
+
+  ```ts
+  // backend/io.ts
+
+  import { createIO } from "@pluv/io";
+  import { createPluvHandler, platformNode } from "@pluv/platform-node";
+  import { z } from "zod";
+
+  export const io = createIO({
+    platform: platformNode(),
+  })
+    .event("SEND_MESSAGE", {
+      input: z.object({ message: z.string() }),
+      resolver: ({ message }) => ({ RECEIVE_MESSAGE: { message } }),
+    })
+    .event("DOUBLE_VALUE", {
+      input: z.object({ value: z.number() }),
+      resolver: ({ value }) => ({ VALUE_DOUBLED: { value: value * 2 } }),
+    });
+
+  const Pluv = createPluvHandler({
+    io,
+    /* ... */
+  });
+  ```
+
+  ```ts
+  // frontend/pluv.ts
+
+  import { createClient } from "@pluv/react";
+  import type { io } from "../backend/io";
+
+  const client = createClient<typeof io>({
+    /* ... */
+  });
+  ```
+
+  ### Now:
+
+  ```ts
+  import { createIO } from "@pluv/io";
+  import { createPluvHandler, platformNode } from "@pluv/platform-node";
+  import { z } from "zod";
+
+  const io = createIO({
+    platform: platformNode(),
+  });
+
+  const router = io.router({
+    SEND_MESSAGE: io.procedure
+      .input(z.object({ message: z.string() }))
+      .broadcast(({ message }) => ({
+        RECEIVE_MESSAGE: { message },
+      })),
+    DOUBLE_VALUE: io.procedure
+      .input(z.object({ value: z.number() }))
+      .broadcast(({ value }) => ({
+        VALUE_DOUBLED: { value: value * 2 },
+      })),
+  });
+
+  export const ioServer = io.server({ router });
+
+  const Pluv = createPluvHandler({
+    io: ioServer, // <- This uses the PluvServer now
+    /* ... */
+  });
+  ```
+
+  ```ts
+  // frontend/pluv.ts
+
+  import { createClient } from "@pluv/react";
+  import type { ioServer } from "../backend/io";
+
+  // This users the PluvServer type now
+  const client = createClient<typeof ioServer>({
+    /* ... */
+  });
+  ```
+
+  - `PluvRouter` instances can also be merged via the `mergeRouters` method, which effectively performs an `Object.assign` of the events object and returns a new `PluvRouter` with the correct types:
+
+  ```ts
+  const router = io.mergeRouters(router1, router2);
+  ```
+
+### Patch Changes
+
+- 06c67be: Added broadcast proxy as a new way to broadcast events.
+
+  ```ts
+  // backend
+
+  const router = io.router({
+    SEND_MESSAGE: io.procedure
+      .input(z.object({ message: z.string() }))
+      .broadcast(({ message }) => ({ RECEIVE_MESSAGE: { message } })),
+  });
+
+  // frontend
+  const client = createClient(/* ... */);
+
+  // Both of the examples below are equivalent.
+
+  client.broadcast("SEND_MESSAGE", { message: "Hello world~!" });
+
+  client.broadcast.SEND_MESSAGE({ message: "Hello world~!" });
+  ```
+
+- df1342c: Added event proxy as a new way to listen to events.
+
+  ```ts
+  // backend
+
+  const router = io.router({
+    SEND_MESSAGE: io.procedure
+      .input(z.object({ message: z.string() }))
+      .broadcast(({ message }) => ({ RECEIVE_MESSAGE: { message } })),
+  });
+
+  // frontend
+  const client = createClient(/* ... */);
+
+  // Both of the examples below are equivalent.
+
+  client.event("RECEIVE_MESSAGE", ({ data }) => {
+    const { message } = data;
+
+    console.log(message);
+  });
+
+  client.event.RECEIVE_MESSAGE(({ data }) => {
+    const { message } = data;
+
+    console.log(message);
+  });
+  ```
+
+- Updated dependencies [99b5ca9]
+  - @pluv/types@0.18.0
+  - @pluv/crdt@0.18.0
+
 ## 0.17.3
 
 ### Patch Changes

package/README.md

@@ -93,14 +93,11 @@ const room = client.createRoom<Presence, Storage>("my-room", {
 const main = async () => {
     await client.enter(room);
 
-    const unsubscribe = client.event("RECEIVE_MESSAGE", ({ data }) => {
+    const unsubscribe = client.event.RECEIVE_MESSAGE(({ data }) => {
         console.log(data.message);
     });
 
-    client.broadcast({
-        type: "SEND_MESSAGE",
-        data: { message: "Hello world!" },
-    });
+    client.broadcast.SEND_MESSAGE({ message: "Hello world!" });
 
     unsubscribe();
 

package/dist/index.d.mts

@@ -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;
 
@@ -70,7 +71,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     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 {
@@ -116,7 +117,7 @@ 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;
@@ -130,7 +131,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     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;
 }
 
@@ -191,14 +192,14 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
+    broadcast: (<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>) => void) & { [event in keyof InferIOInput<TIO>]: (data: Id<InferIOInput<TIO>[event]>) => void; };
     canRedo: () => boolean;
     canUndo: () => boolean;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
-    event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
-    getConnection(): WebSocketConnection;
-    getDoc(): AbstractCrdtDoc<TStorage>;
+    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>;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -211,7 +212,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
@@ -280,6 +281,6 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     private _logDebug;
 }
 
-declare const createClient: <TIO extends IOLike<_pluv_types.IOAuthorize<any, any, any>, {}, {}, {}, {}> = IOLike<_pluv_types.IOAuthorize<any, any, any>, {}, {}, {}, {}>>(options: PluvClientOptions<TIO>) => PluvClient<TIO>;
+declare const createClient: <TIO extends IOLike<_pluv_types.IOAuthorize<any, any, any>, {}> = IOLike<_pluv_types.IOAuthorize<any, any, any>, {}>>(options: PluvClientOptions<TIO>) => PluvClient<TIO>;
 
 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 };

package/dist/index.d.ts

@@ -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;
 
@@ -70,7 +71,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     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 {
@@ -116,7 +117,7 @@ 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;
@@ -130,7 +131,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     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;
 }
 
@@ -191,14 +192,14 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
+    broadcast: (<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>) => void) & { [event in keyof InferIOInput<TIO>]: (data: Id<InferIOInput<TIO>[event]>) => void; };
     canRedo: () => boolean;
     canUndo: () => boolean;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
-    event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
-    getConnection(): WebSocketConnection;
-    getDoc(): AbstractCrdtDoc<TStorage>;
+    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>;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -211,7 +212,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     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;
@@ -280,6 +281,6 @@ declare class PluvClient<TIO extends IOLike = IOLike> {
     private _logDebug;
 }
 
-declare const createClient: <TIO extends IOLike<_pluv_types.IOAuthorize<any, any, any>, {}, {}, {}, {}> = IOLike<_pluv_types.IOAuthorize<any, any, any>, {}, {}, {}, {}>>(options: PluvClientOptions<TIO>) => PluvClient<TIO>;
+declare const createClient: <TIO extends IOLike<_pluv_types.IOAuthorize<any, any, any>, {}> = IOLike<_pluv_types.IOAuthorize<any, any, any>, {}>>(options: PluvClientOptions<TIO>) => PluvClient<TIO>;
 
 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 };