@pluv/io 0.5.0 → 0.7.0

package/.eslintrc.js

@@ -1,4 +1,4 @@
 module.exports = {
-  root: true,
-  extends: ["pluv"],
+    root: true,
+    extends: ["pluv"],
 };

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @pluv/io@0.5.0 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.7.0 build /home/runner/work/pluv/pluv/packages/io
 > tsup src/index.ts --format esm,cjs --dts
 
 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
-CJS dist/index.js 30.95 KB
-CJS ⚡️ Build success in 112ms
-ESM dist/index.mjs 28.88 KB
-ESM ⚡️ Build success in 129ms
+CJS dist/index.js 31.05 KB
+CJS ⚡️ Build success in 81ms
+ESM dist/index.mjs 28.99 KB
+ESM ⚡️ Build success in 84ms
 DTS Build start
-DTS ⚡️ Build success in 3722ms
-DTS dist/index.d.ts 16.78 KB
+DTS ⚡️ Build success in 4546ms
+DTS dist/index.d.ts 17.03 KB

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # @pluv/io
 
+## 0.7.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/crdt-yjs@0.4.0
+  - @pluv/types@0.2.1
+
+## 0.6.0
+
+### Minor Changes
+
+- 2e7cbfa: Updated createIO config option `initialStorage` to be renamed to `getInitialStorage` and updated the params to use an object that includes platform parameters.
+
+  Previously:
+
+  ```ts
+  createIO({
+      initialStorage(room: string): Promise<string> => {
+          // ...
+      },
+  });
+  ```
+
+  Now:
+
+  ```ts
+  createIO({
+      platform: platformCloudflare<Env>(),
+      getInitialStorage({
+          // If you're using Cloudflare, this is the Cloudflare env parameter
+          env,
+          // The name of the room
+          room,
+      }): Promise<string> => {
+          // ...
+      },
+  });
+  ```
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -238,6 +238,10 @@ interface AuthorizeModule {
 type InferIOContext<TIO extends PluvIO<any, any, any, any, any, any, any>> = TIO extends PluvIO<any, any, infer IContext, any, any, any, any> ? IContext : never;
 type InferIOPlatform<TIO extends PluvIO<any, any, any, any, any, any, any>> = TIO extends PluvIO<infer IPlatform, any, any, any, any, any, any> ? IPlatform : never;
 type InferIORoom<TIO extends PluvIO<any, any, any, any, any, any, any>> = TIO extends PluvIO<infer IPlatform, infer IAuthorize, infer IContext, infer IInput, infer IOutputBroadcast, infer IOutputSelf, infer IOutputSync> ? IORoom<IPlatform, IAuthorize, IContext, IInput, IOutputBroadcast, IOutputSelf, IOutputSync> : never;
+type GetInitialStorageEvent<TPlatform extends AbstractPlatform> = {
+    room: string;
+} & InferPlatformRoomContextType<TPlatform>;
+type GetInitialStorageFn<TPlatform extends AbstractPlatform> = (event: GetInitialStorageEvent<TPlatform>) => MaybePromise<Maybe<string>>;
 interface PluvIOListeners<TPlatform extends AbstractPlatform> {
     onRoomDeleted: (event: IORoomListenerEvent<TPlatform>) => void;
     onStorageUpdated: (event: IORoomListenerEvent<TPlatform>) => void;
@@ -247,7 +251,7 @@ type PluvIOConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any
     context?: TContext;
     debug?: boolean;
     events?: InferEventConfig<TPlatform, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
-    initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
+    getInitialStorage?: GetInitialStorageFn<TPlatform>;
     platform: TPlatform;
 };
 type GetRoomOptions<TPlatform extends AbstractPlatform> = {
@@ -255,7 +259,7 @@ type GetRoomOptions<TPlatform extends AbstractPlatform> = {
 } & InferPlatformRoomContextType<TPlatform>;
 declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any> = BaseIOAuthorize, TContext extends JsonObject = {}, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> implements IOLike<TAuthorize, TInput, TOutputBroadcast, TOutputSelf, TOutputSync> {
     private _context;
-    private _initialStorage;
+    private _getInitialStorage;
     private _rooms;
     readonly _authorize: TAuthorize | null;
     readonly _debug: boolean;
@@ -275,9 +279,9 @@ type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<a
     authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired>;
     context?: TContext;
     debug?: boolean;
-    initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
+    getInitialStorage?: GetInitialStorageFn<TPlatform>;
     platform: TPlatform;
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any, {}, {}> = AbstractPlatform<any, {}, {}>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired>, TContext, BaseClientEventRecord, BaseIOEventRecord<IOAuthorize<TAuthorizeUser, TAuthorizeRequired>>, {}, {}>;
 
-export { AbstractCloseEvent, AbstractErrorEvent, AbstractEvent, AbstractEventMap, AbstractListener, AbstractMessageEvent, AbstractPersistance, AbstractPlatform, AbstractPubSub, AbstractWebSocket, AbstractWebSocketConfig, AbstractWebSocketHandleErrorParams, AuthorizeModule, AuthorizeParams, ConvertWebSocketConfig, CreateIOParams, GetRoomOptions, IOPubSubEventMessage, IORoom, InferIORoom, InferPlatformEventContextType, InferPlatformRoomContextType, InferPlatformWebSocketType, JWT, JWTEncodeParams, PluvIO, createIO };
+export { AbstractCloseEvent, AbstractErrorEvent, AbstractEvent, AbstractEventMap, AbstractListener, AbstractMessageEvent, AbstractPersistance, AbstractPlatform, AbstractPubSub, AbstractWebSocket, AbstractWebSocketConfig, AbstractWebSocketHandleErrorParams, AuthorizeModule, AuthorizeParams, ConvertWebSocketConfig, CreateIOParams, GetRoomOptions, IOPubSubEventMessage, IORoom, InferIORoom, InferPlatformEventContextType, InferPlatformRoomContextType, InferPlatformWebSocketType, JWT, JWTEncodeParams, PluvIO, PluvIOConfig, createIO };

package/dist/index.js

@@ -727,10 +727,10 @@ var IORoom = class {
 };
 
 // src/PluvIO.ts
-var PluvIO = class {
+var PluvIO = class _PluvIO {
   constructor(options) {
     this._context = {};
-    this._initialStorage = null;
+    this._getInitialStorage = null;
     this._rooms = /* @__PURE__ */ new Map();
     this._authorize = null;
     this._events = {
@@ -770,7 +770,9 @@ var PluvIO = class {
             var _a, _b;
             const oldState = yield this._platform.persistance.getStorageState(room);
             const updates = [
-              oldState ? null : yield (_a = this._initialStorage) == null ? void 0 : _a.call(this, room),
+              oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, __spreadProps(__spreadValues({}, context), {
+                room
+              })),
               update
             ];
             if (updates.some((_update) => !!_update)) {
@@ -816,7 +818,7 @@ var PluvIO = class {
       },
       $UPDATE_STORAGE: {
         resolver: ({ origin, update }, { context, doc: doc2, room }) => {
-          if (origin === "$STORAGE_RECEIVED" && Object.keys(doc2.toJSON()).length) {
+          if (origin === "$INITIALIZED" && Object.keys(doc2.toJSON()).length) {
             return;
           }
           const updated = doc2.applyUpdate(update);
@@ -836,7 +838,7 @@ var PluvIO = class {
       context,
       debug = false,
       events,
-      initialStorage,
+      getInitialStorage,
       onRoomDeleted,
       onStorageUpdated,
       platform
@@ -849,8 +851,8 @@ var PluvIO = class {
       this._context = context;
     if (events)
       this._events = events;
-    if (initialStorage)
-      this._initialStorage = initialStorage;
+    if (getInitialStorage)
+      this._getInitialStorage = getInitialStorage;
     this._listeners = {
       onRoomDeleted: (event) => onRoomDeleted == null ? void 0 : onRoomDeleted(event),
       onStorageUpdated: (event) => onStorageUpdated == null ? void 0 : onStorageUpdated(event)
@@ -876,9 +878,9 @@ var PluvIO = class {
     const newEvent = {
       [event]: config
     };
-    return PluvIO.merge(
+    return _PluvIO.merge(
       this,
-      new PluvIO({
+      new _PluvIO({
         events: newEvent,
         platform: this._platform
       })
@@ -940,7 +942,7 @@ var PluvIO = class {
     const events2 = second._events;
     const { onRoomDeleted, onStorageUpdated } = first._listeners;
     const events = Object.assign(/* @__PURE__ */ Object.create(null), events1, events2);
-    return new PluvIO({
+    return new _PluvIO({
       authorize: authorize2,
       debug,
       events,
@@ -968,7 +970,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform
@@ -977,7 +979,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform

package/dist/index.mjs

@@ -690,10 +690,10 @@ var IORoom = class {
 };
 
 // src/PluvIO.ts
-var PluvIO = class {
+var PluvIO = class _PluvIO {
   constructor(options) {
     this._context = {};
-    this._initialStorage = null;
+    this._getInitialStorage = null;
     this._rooms = /* @__PURE__ */ new Map();
     this._authorize = null;
     this._events = {
@@ -733,7 +733,9 @@ var PluvIO = class {
             var _a, _b;
             const oldState = yield this._platform.persistance.getStorageState(room);
             const updates = [
-              oldState ? null : yield (_a = this._initialStorage) == null ? void 0 : _a.call(this, room),
+              oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, __spreadProps(__spreadValues({}, context), {
+                room
+              })),
               update
             ];
             if (updates.some((_update) => !!_update)) {
@@ -779,7 +781,7 @@ var PluvIO = class {
       },
       $UPDATE_STORAGE: {
         resolver: ({ origin, update }, { context, doc: doc2, room }) => {
-          if (origin === "$STORAGE_RECEIVED" && Object.keys(doc2.toJSON()).length) {
+          if (origin === "$INITIALIZED" && Object.keys(doc2.toJSON()).length) {
             return;
           }
           const updated = doc2.applyUpdate(update);
@@ -799,7 +801,7 @@ var PluvIO = class {
       context,
       debug = false,
       events,
-      initialStorage,
+      getInitialStorage,
       onRoomDeleted,
       onStorageUpdated,
       platform
@@ -812,8 +814,8 @@ var PluvIO = class {
       this._context = context;
     if (events)
       this._events = events;
-    if (initialStorage)
-      this._initialStorage = initialStorage;
+    if (getInitialStorage)
+      this._getInitialStorage = getInitialStorage;
     this._listeners = {
       onRoomDeleted: (event) => onRoomDeleted == null ? void 0 : onRoomDeleted(event),
       onStorageUpdated: (event) => onStorageUpdated == null ? void 0 : onStorageUpdated(event)
@@ -839,9 +841,9 @@ var PluvIO = class {
     const newEvent = {
       [event]: config
     };
-    return PluvIO.merge(
+    return _PluvIO.merge(
       this,
-      new PluvIO({
+      new _PluvIO({
         events: newEvent,
         platform: this._platform
       })
@@ -903,7 +905,7 @@ var PluvIO = class {
     const events2 = second._events;
     const { onRoomDeleted, onStorageUpdated } = first._listeners;
     const events = Object.assign(/* @__PURE__ */ Object.create(null), events1, events2);
-    return new PluvIO({
+    return new _PluvIO({
       authorize: authorize2,
       debug,
       events,
@@ -931,7 +933,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform
@@ -940,7 +942,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,21 +18,23 @@
   },
   "dependencies": {
     "@panva/hkdf": "^1.1.1",
+    "@playwright/test": "^1.35.1",
+    "@types/react": "^18.2.13",
     "jose": "^4.14.4",
     "kleur": "^4.1.5",
     "wonka": "^6.3.2",
-    "@pluv/crdt-yjs": "^0.3.8",
-    "@pluv/types": "^0.2.0"
+    "@pluv/crdt-yjs": "^0.4.0",
+    "@pluv/types": "^0.2.1"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "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",

package/src/PluvIO.ts

@@ -24,17 +24,15 @@ import type { JWTEncodeParams } from "./authorize";
 import { authorize } from "./authorize";
 import type { EventConfig, InferEventConfig } from "./types";
 
-export type InferIOContext<
-    TIO extends PluvIO<any, any, any, any, any, any, any>
-> = TIO extends PluvIO<any, any, infer IContext, any, any, any, any>
-    ? IContext
-    : never;
-
-export type InferIOPlatform<
-    TIO extends PluvIO<any, any, any, any, any, any, any>
-> = TIO extends PluvIO<infer IPlatform, any, any, any, any, any, any>
-    ? IPlatform
-    : never;
+type InferIOContext<TIO extends PluvIO<any, any, any, any, any, any, any>> =
+    TIO extends PluvIO<any, any, infer IContext, any, any, any, any>
+        ? IContext
+        : never;
+
+type InferIOPlatform<TIO extends PluvIO<any, any, any, any, any, any, any>> =
+    TIO extends PluvIO<infer IPlatform, any, any, any, any, any, any>
+        ? IPlatform
+        : never;
 
 export type InferIORoom<TIO extends PluvIO<any, any, any, any, any, any, any>> =
     TIO extends PluvIO<
@@ -57,6 +55,14 @@ export type InferIORoom<TIO extends PluvIO<any, any, any, any, any, any, any>> =
           >
         : never;
 
+type GetInitialStorageEvent<TPlatform extends AbstractPlatform> = {
+    room: string;
+} & InferPlatformRoomContextType<TPlatform>;
+
+export type GetInitialStorageFn<TPlatform extends AbstractPlatform> = (
+    event: GetInitialStorageEvent<TPlatform>
+) => MaybePromise<Maybe<string>>;
+
 export interface PluvIOListeners<TPlatform extends AbstractPlatform> {
     onRoomDeleted: (event: IORoomListenerEvent<TPlatform>) => void;
     onStorageUpdated: (event: IORoomListenerEvent<TPlatform>) => void;
@@ -82,7 +88,7 @@ export type PluvIOConfig<
         TOutputSelf,
         TOutputSync
     >;
-    initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
+    getInitialStorage?: GetInitialStorageFn<TPlatform>;
     platform: TPlatform;
 };
 
@@ -102,9 +108,7 @@ export class PluvIO<
         IOLike<TAuthorize, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>
 {
     private _context: TContext = {} as TContext;
-    private _initialStorage:
-        | ((room: string) => MaybePromise<Maybe<string>>)
-        | null = null;
+    private _getInitialStorage: GetInitialStorageFn<TPlatform> | null = null;
     private _rooms = new Map<
         string,
         IORoom<
@@ -176,7 +180,12 @@ export class PluvIO<
                         await this._platform.persistance.getStorageState(room);
 
                     const updates: readonly Maybe<string>[] = [
-                        oldState ? null : await this._initialStorage?.(room),
+                        oldState
+                            ? null
+                            : await this._getInitialStorage?.({
+                                  ...context,
+                                  room,
+                              }),
                         update,
                     ];
 
@@ -235,7 +244,7 @@ export class PluvIO<
         $UPDATE_STORAGE: {
             resolver: ({ origin, update }, { context, doc, room }) => {
                 if (
-                    origin === "$STORAGE_RECEIVED" &&
+                    origin === "$INITIALIZED" &&
                     Object.keys(doc.toJSON()).length
                 ) {
                     return;
@@ -284,7 +293,7 @@ export class PluvIO<
             context,
             debug = false,
             events,
-            initialStorage,
+            getInitialStorage,
             onRoomDeleted,
             onStorageUpdated,
             platform,
@@ -296,7 +305,7 @@ export class PluvIO<
         if (authorize) this._authorize = authorize;
         if (context) this._context = context;
         if (events) this._events = events;
-        if (initialStorage) this._initialStorage = initialStorage;
+        if (getInitialStorage) this._getInitialStorage = getInitialStorage;
 
         this._listeners = {
             onRoomDeleted: (event) => onRoomDeleted?.(event),

package/src/createIO.ts

@@ -8,7 +8,7 @@ import type {
     MaybePromise,
 } from "@pluv/types";
 import type { AbstractPlatform } from "./AbstractPlatform";
-import type { PluvIOListeners } from "./PluvIO";
+import type { GetInitialStorageFn, PluvIOListeners } from "./PluvIO";
 import { PluvIO } from "./PluvIO";
 
 export type CreateIOParams<
@@ -20,7 +20,7 @@ export type CreateIOParams<
     authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired>;
     context?: TContext;
     debug?: boolean;
-    initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
+    getInitialStorage?: GetInitialStorageFn<TPlatform>;
     platform: TPlatform;
 };
 
@@ -47,7 +47,7 @@ export const createIO = <
         authorize,
         context,
         debug,
-        initialStorage,
+        getInitialStorage,
         onRoomDeleted,
         onStorageUpdated,
         platform,
@@ -63,7 +63,7 @@ export const createIO = <
         authorize,
         context,
         debug,
-        initialStorage,
+        getInitialStorage,
         onRoomDeleted,
         onStorageUpdated,
         platform,

package/src/index.ts

@@ -26,7 +26,12 @@ export type {
     AbstractWebSocketHandleErrorParams,
 } from "./AbstractWebSocket";
 export type { IORoom } from "./IORoom";
-export type { GetRoomOptions, InferIORoom, PluvIO } from "./PluvIO";
+export type {
+    GetRoomOptions,
+    InferIORoom,
+    PluvIO,
+    PluvIOConfig,
+} from "./PluvIO";
 export type {
     AuthorizeModule,
     AuthorizeParams,