@pluv/react 0.5.10 → 0.6.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @pluv/react@0.5.10 build /home/runner/work/pluv/pluv/packages/react
+> @pluv/react@0.6.0 build /home/runner/work/pluv/pluv/packages/react
 > tsup src/index.ts --format esm,cjs --dts --external react
 
 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 8.65 KB
-ESM ⚡️ Build success in 130ms
-CJS dist/index.js 11.11 KB
-CJS ⚡️ Build success in 130ms
+ESM dist/index.mjs 8.63 KB
+ESM ⚡️ Build success in 185ms
+CJS dist/index.js 11.10 KB
+CJS ⚡️ Build success in 186ms
 DTS Build start
-DTS ⚡️ Build success in 4787ms
-DTS dist/index.d.ts 4.37 KB
+DTS ⚡️ Build success in 9598ms
+DTS dist/index.d.ts 4.47 KB

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @pluv/react
 
+## 0.6.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/client@0.9.0
+  - @pluv/types@0.2.1
+
+## 0.5.11
+
+### Patch Changes
+
+- 2c9c5c3: changed my-presence to be non-nullable
+- Updated dependencies [2c9c5c3]
+  - @pluv/client@0.8.1
+
 ## 0.5.10
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-import { PluvRoomDebug, WebSocketConnection, UserInfo, AbstractRoom, InferYjsSharedTypeJson, MockedRoomEvents, PluvClient } from '@pluv/client';
+import { PluvRoomAddon, PluvRoomDebug, WebSocketConnection, UserInfo, AbstractRoom, InferYjsSharedTypeJson, MockedRoomEvents, PluvClient } from '@pluv/client';
 export { AbstractType, ConnectionState, createClient, y } from '@pluv/client';
 import * as _pluv_types from '@pluv/types';
-import { JsonObject, InputZodLike, IOLike, InferIOInput, Id, InferIOOutput, IOEventMessage } from '@pluv/types';
+import { IOLike, JsonObject, InputZodLike, InferIOInput, Id, InferIOOutput, IOEventMessage } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { FC, Dispatch, ReactNode } from 'react';
 import { AbstractType } from 'yjs';
 
-interface CreateRoomBundleOptions<TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> {
+interface CreateRoomBundleOptions<TIO extends IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}> {
+    addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     initialStorage?: () => TStorage;
     presence?: InputZodLike<TPresence>;
 }
@@ -37,7 +38,7 @@ interface CreateRoomBundle<TIO extends IOLike, TPresence extends JsonObject, TSt
     usePluvConnection: <T extends unknown = WebSocketConnection>(selector: (connection: WebSocketConnection) => T, options?: SubscriptionHookOptions<Id<T>>) => Id<T>;
     usePluvEvent: <TType extends keyof InferIOOutput<TIO>>(type: TType, callback: (data: Id<IOEventMessage<TIO, TType>>) => void) => void;
     usePluvMyPresence: <T extends unknown = TPresence>(selector?: (myPresence: TPresence) => T, options?: SubscriptionHookOptions<Id<T> | null>) => [
-        myPresence: Id<T> | null,
+        myPresence: Id<T>,
         updateMyPresence: Dispatch<UpdateMyPresenceAction<TPresence>>
     ];
     usePluvMyself: <T extends unknown = UserInfo<TIO, TPresence>>(selector?: (myself: Id<UserInfo<TIO, TPresence>>) => T, options?: SubscriptionHookOptions<Id<T> | null>) => Id<T> | null;
@@ -51,7 +52,7 @@ interface PluvProviderProps {
     children?: ReactNode;
 }
 interface CreateBundle<TIO extends IOLike> {
-    createRoomBundle: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}>(options?: CreateRoomBundleOptions<TPresence, TStorage>) => CreateRoomBundle<TIO, TPresence, TStorage>;
+    createRoomBundle: <TPresence extends JsonObject = {}, TStorage extends Record<string, AbstractType<any>> = {}>(options?: CreateRoomBundleOptions<TIO, TPresence, TStorage>) => CreateRoomBundle<TIO, TPresence, TStorage>;
     PluvProvider: FC<PluvProviderProps>;
     usePluvClient: () => PluvClient<TIO>;
 }

package/dist/index.js

@@ -104,6 +104,7 @@ var createRoomBundle = (client, options = {}) => {
     const { room: mockedRoom } = (0, import_react2.useContext)(MockedRoomContext);
     const [room] = (0, import_react2.useState)(() => {
       return client.createRoom(_room, {
+        addons: options.addons,
         debug,
         initialPresence,
         initialStorage: typeof initialStorage === "function" ? initialStorage : options.initialStorage,
@@ -180,9 +181,7 @@ var createRoomBundle = (client, options = {}) => {
     );
     const getSnapshot = room.getMyPresence;
     const _selector = (0, import_react2.useCallback)(
-      (snapshot) => {
-        return !snapshot ? null : selector(snapshot);
-      },
+      (snapshot) => selector(snapshot),
       [selector]
     );
     const myPresence = (0, import_with_selector.useSyncExternalStoreWithSelector)(

package/dist/index.mjs

@@ -74,6 +74,7 @@ var createRoomBundle = (client, options = {}) => {
     const { room: mockedRoom } = useContext(MockedRoomContext);
     const [room] = useState2(() => {
       return client.createRoom(_room, {
+        addons: options.addons,
         debug,
         initialPresence,
         initialStorage: typeof initialStorage === "function" ? initialStorage : options.initialStorage,
@@ -150,9 +151,7 @@ var createRoomBundle = (client, options = {}) => {
     );
     const getSnapshot = room.getMyPresence;
     const _selector = useCallback2(
-      (snapshot) => {
-        return !snapshot ? null : selector(snapshot);
-      },
+      (snapshot) => selector(snapshot),
       [selector]
     );
     const myPresence = useSyncExternalStoreWithSelector(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/react",
-  "version": "0.5.10",
+  "version": "0.6.0",
   "description": "@pluv/client React.js bindings",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,24 +17,25 @@
     "access": "public"
   },
   "dependencies": {
+    "@playwright/test": "^1.35.1",
     "@types/use-sync-external-store": "^0.0.3",
     "fast-deep-equal": "^3.1.3",
     "use-sync-external-store": "^1.2.0",
-    "@pluv/client": "^0.8.0",
-    "@pluv/types": "^0.2.0"
+    "@pluv/client": "^0.9.0",
+    "@pluv/types": "^0.2.1"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "@types/react": "18.2.6",
+    "@types/react": "18.2.13",
     "react": "18.2.0",
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.4",
-    "yjs": "^13.6.1",
-    "@pluv/tsconfig": "^0.1.6",
-    "eslint-config-pluv": "^0.1.12"
+    "tsup": "^7.0.0",
+    "typescript": "^5.1.3",
+    "yjs": "^13.6.4",
+    "@pluv/tsconfig": "^0.1.7",
+    "eslint-config-pluv": "^0.1.13"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts --external react",

package/src/createBundle.tsx

@@ -19,7 +19,7 @@ export interface CreateBundle<TIO extends IOLike> {
         TPresence extends JsonObject = {},
         TStorage extends Record<string, AbstractType<any>> = {}
     >(
-        options?: CreateRoomBundleOptions<TPresence, TStorage>
+        options?: CreateRoomBundleOptions<TIO, TPresence, TStorage>
     ) => CreateRoomBundle<TIO, TPresence, TStorage>;
 
     // components
@@ -59,7 +59,7 @@ export const createBundle = <TIO extends IOLike>(
         TPresence extends JsonObject = {},
         TStorage extends Record<string, AbstractType<any>> = {}
     >(
-        options: CreateRoomBundleOptions<TPresence, TStorage> = {}
+        options: CreateRoomBundleOptions<TIO, TPresence, TStorage> = {}
     ): CreateRoomBundle<TIO, TPresence, TStorage> =>
         _createRoomBundle(client, options);
 

package/src/createRoomBundle.tsx

@@ -4,6 +4,7 @@ import type {
     MockedRoomEvents,
     PluvClient,
     PluvRoom,
+    PluvRoomAddon,
     PluvRoomDebug,
     UserInfo,
     WebSocketConnection,
@@ -37,9 +38,11 @@ import {
 } from "./internal";
 
 export interface CreateRoomBundleOptions<
+    TIO extends IOLike,
     TPresence extends JsonObject = {},
     TStorage extends Record<string, AbstractType<any>> = {}
 > {
+    addons?: readonly PluvRoomAddon<TIO, TPresence, TStorage>[];
     initialStorage?: () => TStorage;
     presence?: InputZodLike<TPresence>;
 }
@@ -106,7 +109,7 @@ export interface CreateRoomBundle<
         selector?: (myPresence: TPresence) => T,
         options?: SubscriptionHookOptions<Id<T> | null>
     ) => [
-        myPresence: Id<T> | null,
+        myPresence: Id<T>,
         updateMyPresence: Dispatch<UpdateMyPresenceAction<TPresence>>
     ];
     usePluvMyself: <T extends unknown = UserInfo<TIO, TPresence>>(
@@ -139,7 +142,7 @@ export const createRoomBundle = <
     TStorage extends Record<string, AbstractType<any>> = {}
 >(
     client: PluvClient<TIO>,
-    options: CreateRoomBundleOptions<TPresence, TStorage> = {}
+    options: CreateRoomBundleOptions<TIO, TPresence, TStorage> = {}
 ): CreateRoomBundle<TIO, TPresence, TStorage> => {
     /**
      * !HACK
@@ -207,6 +210,7 @@ export const createRoomBundle = <
 
         const [room] = useState<PluvRoom<TIO, TPresence, TStorage>>(() => {
             return client.createRoom<TPresence, TStorage>(_room, {
+                addons: options.addons,
                 debug,
                 initialPresence,
                 initialStorage:
@@ -311,7 +315,7 @@ export const createRoomBundle = <
     const usePluvMyPresence = <T extends unknown = TPresence>(
         selector = identity as (myPresence: TPresence) => T,
         options?: SubscriptionHookOptions<Id<T> | null>
-    ): [Id<T> | null, Dispatch<UpdateMyPresenceAction<TPresence>>] => {
+    ): [Id<T>, Dispatch<UpdateMyPresenceAction<TPresence>>] => {
         const room = usePluvRoom();
 
         const subscribe = useCallback(
@@ -324,9 +328,7 @@ export const createRoomBundle = <
         const getSnapshot = room.getMyPresence;
 
         const _selector = useCallback(
-            (snapshot: TPresence | null) => {
-                return !snapshot ? null : (selector(snapshot) as Id<T>);
-            },
+            (snapshot: TPresence) => selector(snapshot) as Id<T>,
             [selector]
         );