@pluv/react 0.28.0 → 0.29.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/react@0.28.0 build /home/runner/work/pluv/pluv/packages/react
+> @pluv/react@0.29.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
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 11.84 KB
-ESM ⚡️ Build success in 141ms
-CJS dist/index.js 14.23 KB
-CJS ⚡️ Build success in 141ms
+CJS dist/index.js 13.92 KB
+CJS ⚡️ Build success in 71ms
+ESM dist/index.mjs 11.47 KB
+ESM ⚡️ Build success in 75ms
 DTS Build start
-DTS ⚡️ Build success in 4997ms
-DTS dist/index.d.mts 6.04 KB
-DTS dist/index.d.ts  6.04 KB
+DTS ⚡️ Build success in 4327ms
+DTS dist/index.d.mts 5.54 KB
+DTS dist/index.d.ts  5.54 KB

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # @pluv/react
 
+## 0.29.0
+
+### Minor Changes
+
+- 525aeae: **BREAKING**
+
+  Merge `createBundle` with `createRoomBundle`.
+
+  ```ts
+  // Before
+  const {
+    createRoomBundle,
+
+    // components
+    PluvProvider,
+
+    // hooks
+    useClient,
+  } = createBundle(client);
+
+  export const {
+    // components
+    MockedRoomProvider,
+    PluvRoomProvider,
+
+    // utils
+    event,
+
+    // hooks
+    useBroadcast,
+    useCanRedo,
+    useCanUndo,
+    useConnection,
+    useDoc,
+    useEvent,
+    useMyPresence,
+    useMyself,
+    useOther,
+    useOthers,
+    useRedo,
+    useRoom,
+    useStorage,
+    useTransact,
+    useUndo,
+  } = createRoomBundle({});
+
+  // After
+  const {
+    // components
+    MockedRoomProvider,
+    PluvProvider,
+    PluvRoomProvider,
+
+    // utils
+    event,
+
+    // hooks
+    useBroadcast,
+    useCanRedo,
+    useCanUndo,
+    useClient,
+    useConnection,
+    useDoc,
+    useEvent,
+    useMyPresence,
+    useMyself,
+    useOther,
+    useOthers,
+    useRedo,
+    useRoom,
+    useStorage,
+    useTransact,
+    useUndo,
+  } = createBundle(client);
+  ```
+
+### Patch Changes
+
+- @pluv/client@0.29.0
+- @pluv/crdt@0.29.0
+- @pluv/types@0.29.0
+
 ## 0.28.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,15 +1,14 @@
-import { PluvRouterEventConfig, PluvRoomAddon, PluvRouter, PluvRoomDebug, MergeEvents, WebSocketConnection, UserInfo, AbstractRoom, MockedRoomEvents, PluvClient } from '@pluv/client';
+import { PluvRoomDebug, PluvRouterEventConfig, MergeEvents, PluvClient, WebSocketConnection, UserInfo, AbstractRoom, MockedRoomEvents, PluvRoomAddon, PluvRouter } from '@pluv/client';
 export { ConnectionState, createClient } from '@pluv/client';
 import { CrdtType, AbstractCrdtDoc, InferCrdtJson } from '@pluv/crdt';
 export { CrdtType, InferCrdtJson } from '@pluv/crdt';
 import { IOLike, JsonObject, Id, InferIOOutput, IOEventMessage, InferIOInput } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { FC, Dispatch, ReactNode } from 'react';
+import { ReactNode, FC, Dispatch } from 'react';
 
-type CreateRoomBundleOptions<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
-    addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
-    router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
-};
+interface PluvProviderProps {
+    children?: ReactNode;
+}
 type BaseRoomProviderProps<TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>> = {
     children?: ReactNode;
     initialStorage?: keyof TStorage extends never ? never : () => TStorage;
@@ -42,13 +41,15 @@ type EventProxy<TIO extends IOLike> = {
         useEvent: (callback: (data: Id<IOEventMessage<TIO, event>>) => void) => void;
     };
 };
-interface CreateRoomBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> {
+interface CreateBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> {
     MockedRoomProvider: FC<MockedRoomProviderProps<TIO, TPresence, TStorage>>;
+    PluvProvider: FC<PluvProviderProps>;
     PluvRoomProvider: FC<PluvRoomProviderProps<TIO, TMetadata, TPresence, TStorage>>;
     event: EventProxy<MergeEvents<TEvents, TIO>>;
     useBroadcast: () => BroadcastProxy<MergeEvents<TEvents, TIO>>;
     useCanRedo: () => boolean;
     useCanUndo: () => boolean;
+    useClient: () => PluvClient<TIO, TPresence, TStorage, TMetadata>;
     useConnection: <T extends unknown = WebSocketConnection>(selector: (connection: WebSocketConnection) => T, options?: SubscriptionHookOptions<Id<T>>) => Id<T>;
     useDoc: () => AbstractCrdtDoc<TStorage>;
     useEvent: <TType extends keyof InferIOOutput<MergeEvents<TEvents, TIO>>>(type: TType, callback: (data: Id<IOEventMessage<MergeEvents<TEvents, TIO>, TType>>) => void) => void;
@@ -62,16 +63,10 @@ interface CreateRoomBundle<TIO extends IOLike, TMetadata extends JsonObject, TPr
     useTransact: () => (fn: (storage: TStorage) => void, origin?: string) => void;
     useUndo: () => () => void;
 }
-type InferRoomStorage<TRoomBundle extends CreateRoomBundle<any, any, any, any, any>> = TRoomBundle extends CreateRoomBundle<any, any, any, infer IStorage> ? IStorage : never;
-
-interface PluvProviderProps {
-    children?: ReactNode;
-}
-interface CreateBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
-    createRoomBundle: <TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}>(options: CreateRoomBundleOptions<TIO, TMetadata, TPresence, TStorage, TEvents>) => CreateRoomBundle<TIO, TMetadata, TPresence, TStorage, TEvents>;
-    PluvProvider: FC<PluvProviderProps>;
-    useClient: () => PluvClient<TIO, TPresence, TStorage, TMetadata>;
-}
-declare const createBundle: <TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}>(client: PluvClient<TIO, TPresence, TStorage, TMetadata>) => CreateBundle<TIO, TMetadata, TPresence, TStorage>;
+type CreateBundleOptions<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
+    addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
+    router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
+};
+declare const createBundle: <TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}>(client: PluvClient<TIO, TPresence, TStorage, TMetadata>, options?: CreateBundleOptions<TIO, TMetadata, TPresence, TStorage, TEvents>) => CreateBundle<TIO, TMetadata, TPresence, TStorage>;
 
-export { type CreateBundle, type CreateRoomBundle, type CreateRoomBundleOptions, type InferRoomStorage, type PluvProviderProps, type PluvRoomProviderProps, type SubscriptionHookOptions, createBundle };
+export { type CreateBundle, type PluvProviderProps, type PluvRoomProviderProps, type SubscriptionHookOptions, createBundle };

package/dist/index.d.ts

@@ -1,15 +1,14 @@
-import { PluvRouterEventConfig, PluvRoomAddon, PluvRouter, PluvRoomDebug, MergeEvents, WebSocketConnection, UserInfo, AbstractRoom, MockedRoomEvents, PluvClient } from '@pluv/client';
+import { PluvRoomDebug, PluvRouterEventConfig, MergeEvents, PluvClient, WebSocketConnection, UserInfo, AbstractRoom, MockedRoomEvents, PluvRoomAddon, PluvRouter } from '@pluv/client';
 export { ConnectionState, createClient } from '@pluv/client';
 import { CrdtType, AbstractCrdtDoc, InferCrdtJson } from '@pluv/crdt';
 export { CrdtType, InferCrdtJson } from '@pluv/crdt';
 import { IOLike, JsonObject, Id, InferIOOutput, IOEventMessage, InferIOInput } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { FC, Dispatch, ReactNode } from 'react';
+import { ReactNode, FC, Dispatch } from 'react';
 
-type CreateRoomBundleOptions<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
-    addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
-    router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
-};
+interface PluvProviderProps {
+    children?: ReactNode;
+}
 type BaseRoomProviderProps<TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>> = {
     children?: ReactNode;
     initialStorage?: keyof TStorage extends never ? never : () => TStorage;
@@ -42,13 +41,15 @@ type EventProxy<TIO extends IOLike> = {
         useEvent: (callback: (data: Id<IOEventMessage<TIO, event>>) => void) => void;
     };
 };
-interface CreateRoomBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> {
+interface CreateBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> {
     MockedRoomProvider: FC<MockedRoomProviderProps<TIO, TPresence, TStorage>>;
+    PluvProvider: FC<PluvProviderProps>;
     PluvRoomProvider: FC<PluvRoomProviderProps<TIO, TMetadata, TPresence, TStorage>>;
     event: EventProxy<MergeEvents<TEvents, TIO>>;
     useBroadcast: () => BroadcastProxy<MergeEvents<TEvents, TIO>>;
     useCanRedo: () => boolean;
     useCanUndo: () => boolean;
+    useClient: () => PluvClient<TIO, TPresence, TStorage, TMetadata>;
     useConnection: <T extends unknown = WebSocketConnection>(selector: (connection: WebSocketConnection) => T, options?: SubscriptionHookOptions<Id<T>>) => Id<T>;
     useDoc: () => AbstractCrdtDoc<TStorage>;
     useEvent: <TType extends keyof InferIOOutput<MergeEvents<TEvents, TIO>>>(type: TType, callback: (data: Id<IOEventMessage<MergeEvents<TEvents, TIO>, TType>>) => void) => void;
@@ -62,16 +63,10 @@ interface CreateRoomBundle<TIO extends IOLike, TMetadata extends JsonObject, TPr
     useTransact: () => (fn: (storage: TStorage) => void, origin?: string) => void;
     useUndo: () => () => void;
 }
-type InferRoomStorage<TRoomBundle extends CreateRoomBundle<any, any, any, any, any>> = TRoomBundle extends CreateRoomBundle<any, any, any, infer IStorage> ? IStorage : never;
-
-interface PluvProviderProps {
-    children?: ReactNode;
-}
-interface CreateBundle<TIO extends IOLike, TMetadata extends JsonObject, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}> {
-    createRoomBundle: <TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}>(options: CreateRoomBundleOptions<TIO, TMetadata, TPresence, TStorage, TEvents>) => CreateRoomBundle<TIO, TMetadata, TPresence, TStorage, TEvents>;
-    PluvProvider: FC<PluvProviderProps>;
-    useClient: () => PluvClient<TIO, TPresence, TStorage, TMetadata>;
-}
-declare const createBundle: <TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}>(client: PluvClient<TIO, TPresence, TStorage, TMetadata>) => CreateBundle<TIO, TMetadata, TPresence, TStorage>;
+type CreateBundleOptions<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
+    addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
+    router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
+};
+declare const createBundle: <TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}>(client: PluvClient<TIO, TPresence, TStorage, TMetadata>, options?: CreateBundleOptions<TIO, TMetadata, TPresence, TStorage, TEvents>) => CreateBundle<TIO, TMetadata, TPresence, TStorage>;
 
-export { type CreateBundle, type CreateRoomBundle, type CreateRoomBundleOptions, type InferRoomStorage, type PluvProviderProps, type PluvRoomProviderProps, type SubscriptionHookOptions, createBundle };
+export { type CreateBundle, type PluvProviderProps, type PluvRoomProviderProps, type SubscriptionHookOptions, createBundle };

package/dist/index.js

@@ -38,9 +38,6 @@ module.exports = __toCommonJS(src_exports);
 var import_client2 = require("@pluv/client");
 
 // src/createBundle.tsx
-var import_react5 = require("react");
-
-// src/createRoomBundle.tsx
 var import_client = require("@pluv/client");
 var import_fast_deep_equal = __toESM(require("fast-deep-equal"));
 var import_react4 = require("react");
@@ -108,9 +105,10 @@ var useSyncExternalStoreWithSelector = (subscribe, getClientSnapshot, getServerS
   return typeof window !== "undefined" ? noSsr(result, _getServerSnapshot == null ? void 0 : _getServerSnapshot()) : result;
 };
 
-// src/createRoomBundle.tsx
+// src/createBundle.tsx
 var import_jsx_runtime = require("react/jsx-runtime");
-var createRoomBundle = (client, options) => {
+var createBundle = (client, options = {}) => {
+  const PluvContext = (0, import_react4.createContext)(null);
   const PluvRoomContext = (0, import_react4.createContext)(null);
   const MockedRoomContext = (0, import_react4.createContext)({ room: null });
   const MockedRoomProvider = (0, import_react4.memo)((props) => {
@@ -159,6 +157,12 @@ var createRoomBundle = (client, options) => {
     return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(PluvRoomContext.Provider, { value: mockedRoom != null ? mockedRoom : room, children });
   });
   PluvRoomProvider.displayName = "PluvRoomProvider";
+  const PluvProvider = (0, import_react4.memo)((props) => {
+    const { children } = props;
+    return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(PluvContext.Provider, { value: client, children });
+  });
+  PluvProvider.displayName = "PluvProvider";
+  const useClient = () => (0, import_react4.useContext)(PluvContext);
   const useRoom = () => (0, import_react4.useContext)(PluvRoomContext);
   const useBroadcast = () => {
     const room = useRoom();
@@ -368,6 +372,7 @@ var createRoomBundle = (client, options) => {
   return {
     // components
     MockedRoomProvider,
+    PluvProvider,
     PluvRoomProvider,
     // proxies
     event,
@@ -375,6 +380,7 @@ var createRoomBundle = (client, options) => {
     useBroadcast,
     useCanRedo,
     useCanUndo,
+    useClient,
     useConnection,
     useDoc,
     useEvent,
@@ -389,24 +395,6 @@ var createRoomBundle = (client, options) => {
     useUndo
   };
 };
-
-// src/createBundle.tsx
-var import_jsx_runtime2 = require("react/jsx-runtime");
-var createBundle = (client) => {
-  const PluvContext = (0, import_react5.createContext)(null);
-  const PluvProvider = (0, import_react5.memo)((props) => {
-    const { children } = props;
-    return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(PluvContext.Provider, { value: client, children });
-  });
-  PluvProvider.displayName = "PluvProvider";
-  const useClient = () => (0, import_react5.useContext)(PluvContext);
-  const createRoomBundle2 = (options) => createRoomBundle(client, options);
-  return {
-    createRoomBundle: createRoomBundle2,
-    PluvProvider,
-    useClient
-  };
-};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ConnectionState,

package/dist/index.mjs

@@ -2,9 +2,6 @@
 import { ConnectionState, createClient } from "@pluv/client";
 
 // src/createBundle.tsx
-import { createContext as createContext2, memo as memo2, useContext as useContext2 } from "react";
-
-// src/createRoomBundle.tsx
 import { MockedRoom } from "@pluv/client";
 import fastDeepEqual from "fast-deep-equal";
 import { createContext, memo, useCallback as useCallback3, useContext, useEffect as useEffect2, useMemo, useState as useState3 } from "react";
@@ -72,9 +69,10 @@ var useSyncExternalStoreWithSelector = (subscribe, getClientSnapshot, getServerS
   return typeof window !== "undefined" ? noSsr(result, _getServerSnapshot == null ? void 0 : _getServerSnapshot()) : result;
 };
 
-// src/createRoomBundle.tsx
+// src/createBundle.tsx
 import { jsx } from "react/jsx-runtime";
-var createRoomBundle = (client, options) => {
+var createBundle = (client, options = {}) => {
+  const PluvContext = createContext(null);
   const PluvRoomContext = createContext(null);
   const MockedRoomContext = createContext({ room: null });
   const MockedRoomProvider = memo((props) => {
@@ -123,6 +121,12 @@ var createRoomBundle = (client, options) => {
     return /* @__PURE__ */ jsx(PluvRoomContext.Provider, { value: mockedRoom != null ? mockedRoom : room, children });
   });
   PluvRoomProvider.displayName = "PluvRoomProvider";
+  const PluvProvider = memo((props) => {
+    const { children } = props;
+    return /* @__PURE__ */ jsx(PluvContext.Provider, { value: client, children });
+  });
+  PluvProvider.displayName = "PluvProvider";
+  const useClient = () => useContext(PluvContext);
   const useRoom = () => useContext(PluvRoomContext);
   const useBroadcast = () => {
     const room = useRoom();
@@ -332,6 +336,7 @@ var createRoomBundle = (client, options) => {
   return {
     // components
     MockedRoomProvider,
+    PluvProvider,
     PluvRoomProvider,
     // proxies
     event,
@@ -339,6 +344,7 @@ var createRoomBundle = (client, options) => {
     useBroadcast,
     useCanRedo,
     useCanUndo,
+    useClient,
     useConnection,
     useDoc,
     useEvent,
@@ -353,24 +359,6 @@ var createRoomBundle = (client, options) => {
     useUndo
   };
 };
-
-// src/createBundle.tsx
-import { jsx as jsx2 } from "react/jsx-runtime";
-var createBundle = (client) => {
-  const PluvContext = createContext2(null);
-  const PluvProvider = memo2((props) => {
-    const { children } = props;
-    return /* @__PURE__ */ jsx2(PluvContext.Provider, { value: client, children });
-  });
-  PluvProvider.displayName = "PluvProvider";
-  const useClient = () => useContext2(PluvContext);
-  const createRoomBundle2 = (options) => createRoomBundle(client, options);
-  return {
-    createRoomBundle: createRoomBundle2,
-    PluvProvider,
-    useClient
-  };
-};
 export {
   ConnectionState,
   createBundle,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/react",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "@pluv/client React.js bindings",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,22 +18,22 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "@pluv/client": "^0.28.0",
-    "@pluv/crdt": "^0.28.0",
-    "@pluv/types": "^0.28.0"
+    "@pluv/client": "^0.29.0",
+    "@pluv/crdt": "^0.29.0",
+    "@pluv/types": "^0.29.0"
   },
   "peerDependencies": {
     "@types/react": "^18.0.0",
     "react": "^18.0.0"
   },
   "devDependencies": {
-    "@types/react": "^18.3.6",
+    "@types/react": "^18.3.8",
     "eslint": "^8.57.0",
     "react": "^18.3.1",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@pluv/tsconfig": "^0.28.0",
-    "eslint-config-pluv": "^0.28.0"
+    "@pluv/tsconfig": "^0.29.0",
+    "eslint-config-pluv": "^0.29.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts --external react",