@pluv/io 0.32.6 → 0.32.8

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @pluv/io@0.32.6 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.32.8 build /home/runner/work/pluv/pluv/packages/io
 > pnpm run version && tsup src/index.ts --format esm,cjs --dts
 
 
-> @pluv/io@0.32.6 version /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.32.8 version /home/runner/work/pluv/pluv/packages/io
 > genversion ./src/version.generated.ts --esm
 
 CLI Building entry: src/index.ts
@@ -12,11 +12,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 42.67 KB
-ESM ⚡️ Build success in 62ms
-CJS dist/index.js 44.85 KB
-CJS ⚡️ Build success in 71ms
+CJS dist/index.js 44.81 KB
+CJS ⚡️ Build success in 108ms
+ESM dist/index.mjs 42.64 KB
+ESM ⚡️ Build success in 126ms
 DTS Build start
-DTS ⚡️ Build success in 2294ms
-DTS dist/index.d.mts 27.20 KB
-DTS dist/index.d.ts  27.20 KB
+DTS ⚡️ Build success in 2223ms
+DTS dist/index.d.mts 27.33 KB
+DTS dist/index.d.ts  27.33 KB

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @pluv/io
 
+## 0.32.8
+
+### Patch Changes
+
+- e659f8a: Update `getInitialStorage` so that the context is made available on the `context` event property.
+
+  ```ts
+  import { createIO } from "@pluv/io";
+
+  // Before
+  const io = createIO({
+    getInitialStorage: ({ room, ...context }) => {
+      // ...
+    },
+  });
+
+  // After
+  const io = createIO({
+    // Context is now an explicit property on the event
+    getInitialStorage: ({ room, context }) => {
+      // ...
+    },
+  });
+  ```
+
+  - @pluv/crdt@0.32.8
+  - @pluv/types@0.32.8
+
+## 0.32.7
+
+### Patch Changes
+
+- @pluv/crdt@0.32.7
+- @pluv/types@0.32.7
+
 ## 0.32.6
 
 ### Patch Changes

package/dist/index.d.mts

@@ -175,10 +175,11 @@ type MergeEventRecords<TEventRecords extends EventRecord<string, any>[], TRoot e
 ] ? MergeEventRecords<ITail, Omit<TRoot, keyof IHead> & {
     [P in keyof IHead]: TRoot extends Record<P, any> ? TRoot[P] | IHead[P] : IHead[P];
 }> : Id<TRoot>;
-type GetInitialStorageEvent = {
+type GetInitialStorageEvent<TContext extends Record<string, any>> = {
+    context: TContext;
     room: string;
 };
-type GetInitialStorageFn = (event: GetInitialStorageEvent) => MaybePromise<Maybe<string>>;
+type GetInitialStorageFn<TContext extends Record<string, any>> = (event: GetInitialStorageEvent<TContext>) => MaybePromise<Maybe<string>>;
 interface PluvIOListeners<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> {
     onRoomDeleted: (event: IORoomListenerEvent<TContext>) => void;
     onRoomMessage: (event: IORoomMessageEvent<TPlatform, TAuthorize, TContext, TEvents>) => void;
@@ -373,7 +374,7 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
         doc: (value: any) => AbstractCrdtDocFactory<any>;
     };
     debug?: boolean;
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
@@ -418,7 +419,7 @@ type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IO
     platform: TPlatform;
 };
 type ServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
 declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {

package/dist/index.d.ts

@@ -175,10 +175,11 @@ type MergeEventRecords<TEventRecords extends EventRecord<string, any>[], TRoot e
 ] ? MergeEventRecords<ITail, Omit<TRoot, keyof IHead> & {
     [P in keyof IHead]: TRoot extends Record<P, any> ? TRoot[P] | IHead[P] : IHead[P];
 }> : Id<TRoot>;
-type GetInitialStorageEvent = {
+type GetInitialStorageEvent<TContext extends Record<string, any>> = {
+    context: TContext;
     room: string;
 };
-type GetInitialStorageFn = (event: GetInitialStorageEvent) => MaybePromise<Maybe<string>>;
+type GetInitialStorageFn<TContext extends Record<string, any>> = (event: GetInitialStorageEvent<TContext>) => MaybePromise<Maybe<string>>;
 interface PluvIOListeners<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> {
     onRoomDeleted: (event: IORoomListenerEvent<TContext>) => void;
     onRoomMessage: (event: IORoomMessageEvent<TPlatform, TAuthorize, TContext, TEvents>) => void;
@@ -373,7 +374,7 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
         doc: (value: any) => AbstractCrdtDocFactory<any>;
     };
     debug?: boolean;
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
@@ -418,7 +419,7 @@ type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IO
     platform: TPlatform;
 };
 type ServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
 declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {

package/dist/index.js

@@ -1002,7 +1002,7 @@ var IORoom = class {
 };
 
 // src/version.generated.ts
-var version = "0.32.6";
+var version = "0.32.8";
 
 // src/PluvServer.ts
 var PluvServer = class {
@@ -1046,7 +1046,7 @@ var PluvServer = class {
         const oldState = yield this._platform.persistence.getStorageState(room);
         const update = data == null ? void 0 : data.update;
         const updates = [
-          oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, __spreadProps(__spreadValues({}, context), { room })),
+          oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, { context, room }),
           update
         ];
         if (updates.some((_update) => !!_update)) {

package/dist/index.mjs

@@ -960,7 +960,7 @@ var IORoom = class {
 };
 
 // src/version.generated.ts
-var version = "0.32.6";
+var version = "0.32.8";
 
 // src/PluvServer.ts
 var PluvServer = class {
@@ -1004,7 +1004,7 @@ var PluvServer = class {
         const oldState = yield this._platform.persistence.getStorageState(room);
         const update = data == null ? void 0 : data.update;
         const updates = [
-          oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, __spreadProps(__spreadValues({}, context), { room })),
+          oldState ? null : yield (_a = this._getInitialStorage) == null ? void 0 : _a.call(this, { context, room }),
           update
         ];
         if (updates.some((_update) => !!_update)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.32.6",
+  "version": "0.32.8",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",
@@ -21,16 +21,16 @@
     "jose": "^5.9.6",
     "kleur": "^4.1.5",
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.32.6",
-    "@pluv/types": "^0.32.6"
+    "@pluv/crdt": "^0.32.8",
+    "@pluv/types": "^0.32.8"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
     "genversion": "^3.2.0",
     "tsup": "^8.3.5",
     "typescript": "^5.6.3",
-    "@pluv/tsconfig": "^0.32.6",
-    "eslint-config-pluv": "^0.32.6"
+    "@pluv/tsconfig": "^0.32.8",
+    "eslint-config-pluv": "^0.32.8"
   },
   "scripts": {
     "build": "pnpm run version && tsup src/index.ts --format esm,cjs --dts",

package/src/PluvIO.ts

@@ -29,7 +29,7 @@ export type ServerConfig<
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
 > = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
 

package/src/PluvServer.ts

@@ -38,7 +38,7 @@ export type PluvServerConfig<
     context?: PluvContext<TPlatform, TContext>;
     crdt?: { doc: (value: any) => AbstractCrdtDocFactory<any> };
     debug?: boolean;
-    getInitialStorage?: GetInitialStorageFn;
+    getInitialStorage?: GetInitialStorageFn<TContext>;
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
@@ -125,7 +125,7 @@ export class PluvServer<
                 const update = (data as any)?.update as Maybe<string>;
 
                 const updates: readonly Maybe<string>[] = [
-                    oldState ? null : await this._getInitialStorage?.({ ...context, room }),
+                    oldState ? null : await this._getInitialStorage?.({ context, room }),
                     update,
                 ];
 
@@ -197,7 +197,7 @@ export class PluvServer<
     private readonly _context: PluvContext<TPlatform, TContext> = {} as PluvContext<TPlatform, TContext>;
     private readonly _crdt: { doc: (value: any) => AbstractCrdtDocFactory<any> };
     private readonly _debug: boolean;
-    private readonly _getInitialStorage: GetInitialStorageFn | null = null;
+    private readonly _getInitialStorage: GetInitialStorageFn<TContext> | null = null;
     private readonly _platform: TPlatform;
     private readonly _router: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 

package/src/types.ts

@@ -106,11 +106,14 @@ export type MergeEventRecords<
       >
     : Id<TRoot>;
 
-export type GetInitialStorageEvent = {
+export type GetInitialStorageEvent<TContext extends Record<string, any>> = {
+    context: TContext;
     room: string;
 };
 
-export type GetInitialStorageFn = (event: GetInitialStorageEvent) => MaybePromise<Maybe<string>>;
+export type GetInitialStorageFn<TContext extends Record<string, any>> = (
+    event: GetInitialStorageEvent<TContext>,
+) => MaybePromise<Maybe<string>>;
 
 export interface PluvIOListeners<
     TPlatform extends AbstractPlatform<any>,

package/src/version.generated.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '0.32.6'
+export const version = '0.32.8'