@pluv/io 0.4.2 → 0.6.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/io@0.4.2 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.6.0 build /home/runner/work/pluv/pluv/packages/io
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 30.12 KB
-CJS ⚡️ Build success in 109ms
-ESM dist/index.mjs 28.06 KB
-ESM ⚡️ Build success in 112ms
+ESM dist/index.mjs 28.98 KB
+ESM ⚡️ Build success in 93ms
+CJS dist/index.js 31.04 KB
+CJS ⚡️ Build success in 93ms
 DTS Build start
-DTS ⚡️ Build success in 3144ms
-DTS dist/index.d.ts 14.86 KB
+DTS ⚡️ Build success in 3311ms
+DTS dist/index.d.ts 17.03 KB

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @pluv/io
 
+## 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
+
+- ae4e1f1: added platform-specific contexts to expose env in cloudflare and req in node.js
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JsonObject, MaybePromise, IOEventMessage, EventRecord, InputZodLike, Id, IOLike, InferIOOutput, BaseUser, IOAuthorize, BaseIOAuthorize, InferIOInput, InferIOAuthorizeUser, InferIOAuthorize, Spread, InferIOOutputBroadcast, InferIOOutputSelf, InferIOOutputSync, Maybe, BaseClientEventRecord, BaseIOEventRecord } from '@pluv/types';
+import { JsonObject, MaybePromise, IOEventMessage, EventRecord, InputZodLike, Id, IOLike, InferIOOutput, IOAuthorize, BaseIOAuthorize, InferIOInput, BaseUser, InferIOAuthorizeUser, InferIOAuthorize, Spread, InferIOOutputBroadcast, InferIOOutputSelf, InferIOOutputSync, Maybe, BaseClientEventRecord, BaseIOEventRecord } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { YjsDoc } from '@pluv/crdt-yjs';
 
@@ -79,12 +79,13 @@ declare global {
         log: (...data: any[]) => void;
     };
 }
-interface EventConfig<TContext extends JsonObject = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}> {
+interface EventConfig<TPlatform extends AbstractPlatform = AbstractPlatform, TContext extends Record<string, any> = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}> {
     input?: InputZodLike<TData>;
-    resolver: EventResolver<TContext, TData, TResultBroadcast> | EventResolverObject<TContext, TData, TResultBroadcast, TResultSelf, TResultSync>;
+    resolver: EventResolver<TContext & InferPlatformRoomContextType<TPlatform> & InferPlatformEventContextType<TPlatform>, TData, TResultBroadcast> | EventResolverObject<TPlatform, TContext, TData, TResultBroadcast, TResultSelf, TResultSync>;
 }
-type EventResolver<TContext extends JsonObject = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}> = (data: TData, context: EventResolverContext<TContext>) => MaybePromise<TResultBroadcast | void>;
-interface EventResolverContext<TContext extends JsonObject = {}> {
+type SyncEventResolver<TContext extends Record<string, any> = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}> = (data: TData, context: EventResolverContext<TContext>) => MaybePromise<TResultBroadcast | void>;
+type EventResolver<TContext extends Record<string, any> = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}> = (data: TData, context: EventResolverContext<TContext>) => MaybePromise<TResultBroadcast | void>;
+interface EventResolverContext<TContext extends Record<string, any> = {}> {
     context: TContext;
     doc: YjsDoc<any>;
     room: string;
@@ -103,13 +104,13 @@ interface EventResolverContext<TContext extends JsonObject = {}> {
     session: WebSocketSession | null;
     sessions: Map<string, WebSocketSession>;
 }
-type EventResolverObject<TContext extends JsonObject = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}> = {
-    broadcast?: EventResolver<TContext, TData, TResultBroadcast>;
-    self?: EventResolver<TContext, TData, TResultSelf>;
-    sync?: EventResolver<TContext, TData, TResultSync>;
+type EventResolverObject<TPlatform extends AbstractPlatform = AbstractPlatform, TContext extends Record<string, any> = {}, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}> = {
+    broadcast?: EventResolver<TContext & InferPlatformRoomContextType<TPlatform> & InferPlatformEventContextType<TPlatform>, TData, TResultBroadcast>;
+    self?: EventResolver<TContext & InferPlatformRoomContextType<TPlatform> & InferPlatformEventContextType<TPlatform>, TData, TResultSelf>;
+    sync?: SyncEventResolver<TContext, TData, TResultSync>;
 };
-type InferEventConfig<TContext extends JsonObject = {}, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> = {
-    [P in keyof TInput]: P extends string ? Id<EventConfig<TContext, TInput[P], TOutputBroadcast, TOutputSelf, TOutputSync>> : never;
+type InferEventConfig<TPlatform extends AbstractPlatform = AbstractPlatform, TContext extends Record<string, any> = {}, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> = {
+    [P in keyof TInput]: P extends string ? Id<EventConfig<TPlatform, TContext, TInput[P], TOutputBroadcast, TOutputSelf, TOutputSync>> : never;
 };
 type SendMessageOptions = {
     type?: "broadcast";
@@ -141,7 +142,9 @@ declare abstract class AbstractPubSub {
     abstract unsubscribe(subscriptionId: number): void;
 }
 
-type InferWebSocketType<TPlatform extends AbstractPlatform<any>> = TPlatform extends AbstractPlatform<infer IWebSocket> ? IWebSocket : never;
+type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<infer IWebSocket> ? IWebSocket : never;
+type InferPlatformRoomContextType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<any, infer IIOContext> ? IIOContext : never;
+type InferPlatformEventContextType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<any, any, infer IRoomContext> ? IRoomContext : never;
 type AbstractPlatformConfig = {
     persistance?: undefined;
     pubSub?: undefined;
@@ -152,7 +155,9 @@ type AbstractPlatformConfig = {
 interface ConvertWebSocketConfig {
     room: string;
 }
-declare abstract class AbstractPlatform<TWebSocket = any> {
+declare abstract class AbstractPlatform<TWebSocket = any, TIOContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}> {
+    readonly _ioContext: TIOContext | undefined;
+    readonly _roomContext: TRoomContext | undefined;
     persistance: AbstractPersistance;
     pubSub: AbstractPubSub;
     constructor(config?: AbstractPlatformConfig);
@@ -161,39 +166,24 @@ declare abstract class AbstractPlatform<TWebSocket = any> {
     abstract randomUUID(): string;
 }
 
-interface JWT<TUser extends BaseUser> {
+type IORoomListenerEvent<TPlatform extends AbstractPlatform> = {
     room: string;
-    sub: string;
-    user: TUser;
+    encodedState: string;
+} & InferPlatformRoomContextType<TPlatform>;
+interface IORoomListeners<TPlatform extends AbstractPlatform> {
+    onDestroy: (event: IORoomListenerEvent<TPlatform>) => void;
 }
-interface JWTEncodeParams<TUser extends BaseUser> {
-    maxAge?: number;
-    room: string;
-    user: TUser;
-}
-interface AuthorizeParams {
-    platform: AbstractPlatform;
-    secret: string;
-}
-interface AuthorizeModule {
-    decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
-    encode: <TUser extends BaseUser>(params: JWTEncodeParams<TUser>) => Promise<string>;
-}
-
-interface IORoomListeners {
-    onDestroy: (encodedState: string) => void;
-}
-type IORoomConfig<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> = {}> = Partial<IORoomListeners> & {
+type IORoomConfig<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> = {}> = Partial<IORoomListeners<TPlatform>> & {
     authorize?: TAuthorize;
-    context: TContext;
+    context: TContext & InferPlatformRoomContextType<TPlatform>;
     debug: boolean;
-    events: InferEventConfig<TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
+    events: InferEventConfig<TPlatform, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
     platform: TPlatform;
 };
-interface WebsocketRegisterOptions {
+type WebsocketRegisterOptions<TPlatform extends AbstractPlatform> = {
     token?: string | null;
-}
-declare class IORoom<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> {
+} & InferPlatformRoomContextType<TPlatform> & InferPlatformEventContextType<TPlatform>;
+declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any> = BaseIOAuthorize, TContext extends Record<string, any> = {}, 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 readonly _context;
     private readonly _debug;
     private readonly _platform;
@@ -202,12 +192,12 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _sessions;
     private _uninitialize;
     readonly _authorize: TAuthorize | null;
-    readonly _events: InferEventConfig<TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
+    readonly _events: InferEventConfig<TPlatform, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
     readonly id: string;
     constructor(id: string, config: IORoomConfig<TPlatform, TAuthorize, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>);
     broadcast<TEvent extends keyof InferIOInput<this>>(event: TEvent, data: Id<InferIOInput<this>[TEvent]>): Promise<void>;
     getSize(): number;
-    register(webSocket: InferWebSocketType<TPlatform>, options?: WebsocketRegisterOptions): Promise<void>;
+    register(webSocket: InferPlatformWebSocketType<TPlatform>, options: WebsocketRegisterOptions<TPlatform>): Promise<void>;
     private _broadcast;
     private _emitQuitters;
     private _emitRegistered;
@@ -226,49 +216,72 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _sendSyncMessage;
 }
 
+interface JWT<TUser extends BaseUser> {
+    room: string;
+    sub: string;
+    user: TUser;
+}
+interface JWTEncodeParams<TUser extends BaseUser> {
+    maxAge?: number;
+    room: string;
+    user: TUser;
+}
+interface AuthorizeParams {
+    platform: AbstractPlatform;
+    secret: string;
+}
+interface AuthorizeModule {
+    decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
+    encode: <TUser extends BaseUser>(params: JWTEncodeParams<TUser>) => Promise<string>;
+}
+
 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;
-interface PluvIOListeners {
-    onRoomDeleted: (room: string, encodedState: string) => void;
-    onStorageUpdated: (room: string, encodedState: string) => void;
+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;
 }
-type PluvIOConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any> | null = null, TContext extends JsonObject = {}, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> = Partial<PluvIOListeners> & {
+type PluvIOConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any> | null = null, TContext extends JsonObject = {}, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> = Partial<PluvIOListeners<TPlatform>> & {
     authorize?: TAuthorize;
     context?: TContext;
     debug?: boolean;
-    events?: InferEventConfig<TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
-    initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
+    events?: InferEventConfig<TPlatform, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
+    getInitialStorage?: GetInitialStorageFn<TPlatform>;
     platform: TPlatform;
 };
-interface GetRoomOptions {
+type GetRoomOptions<TPlatform extends AbstractPlatform> = {
     debug?: boolean;
-}
+} & 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;
-    readonly _events: InferEventConfig<TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
-    readonly _listeners: PluvIOListeners;
+    readonly _events: InferEventConfig<TPlatform, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
+    readonly _listeners: PluvIOListeners<TPlatform>;
     readonly _platform: TPlatform;
     constructor(options: PluvIOConfig<TPlatform, TAuthorize, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>);
     createToken(params: JWTEncodeParams<InferIOAuthorizeUser<InferIOAuthorize<this>>>): Promise<string>;
-    event<TEvent extends string, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}>(event: TEvent, config: EventConfig<TContext, TData, TResultBroadcast, TResultSelf, TResultSync>): PluvIO<TPlatform, TAuthorize, TContext, Spread<[TInput, EventRecord<TEvent, TData>]>, Spread<[TOutputBroadcast, TResultBroadcast]>, Spread<[TOutputSelf, TResultSelf]>, Spread<[TOutputSync, TResultSync]>>;
-    getRoom(room: string, options?: GetRoomOptions): IORoom<TPlatform, TAuthorize, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
+    event<TEvent extends string, TData extends JsonObject = {}, TResultBroadcast extends EventRecord<string, any> = {}, TResultSelf extends EventRecord<string, any> = {}, TResultSync extends EventRecord<string, any> = {}>(event: TEvent, config: EventConfig<TPlatform, TContext, TData, TResultBroadcast, TResultSelf, TResultSync>): PluvIO<TPlatform, TAuthorize, TContext, Spread<[TInput, EventRecord<TEvent, TData>]>, Spread<[TOutputBroadcast, TResultBroadcast]>, Spread<[TOutputSelf, TResultSelf]>, Spread<[TOutputSync, TResultSync]>>;
+    getRoom(room: string, options: GetRoomOptions<TPlatform>): IORoom<TPlatform, TAuthorize, TContext, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>;
     static merge<TIO1 extends PluvIO, TIO2 extends PluvIO>(first: TIO1, second: TIO2): PluvIO<InferIOPlatform<TIO1>, InferIOAuthorize<TIO1>, InferIOContext<TIO1>, Spread<[InferIOInput<TIO1>, InferIOInput<TIO2>]>, Spread<[InferIOOutputBroadcast<TIO1>, InferIOOutputBroadcast<TIO2>]>, Spread<[InferIOOutputSelf<TIO1>, InferIOOutputSelf<TIO2>]>, Spread<[InferIOOutputSync<TIO1>, InferIOOutputSync<TIO2>]>>;
     private _logDebug;
     private _purgeEmptyRooms;
 }
 
-type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false> = Partial<PluvIOListeners> & {
+type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false> = Partial<PluvIOListeners<TPlatform>> & {
     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>>, {}, {}>;
+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, InferWebSocketType, 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

@@ -316,9 +316,7 @@ var IORoom = class {
     this._platform = platform;
     this.id = id;
     this._listeners = {
-      onDestroy: (encodedState) => {
-        onDestroy == null ? void 0 : onDestroy(encodedState);
-      }
+      onDestroy: (event) => onDestroy == null ? void 0 : onDestroy(event)
     };
     if (authorize2)
       this._authorize = authorize2;
@@ -337,10 +335,11 @@ var IORoom = class {
   }
   register(webSocket, options) {
     return __async(this, null, function* () {
-      var _a;
+      var _b;
+      const _a = options, { token } = _a, _platformEventContext = __objRest(_a, ["token"]);
+      const platformEventContext = _platformEventContext;
       if (!this._uninitialize)
         yield this._initialize();
-      const token = options == null ? void 0 : options.token;
       const sessionId = this._platform.randomUUID();
       const pluvWs = this._platform.convertWebSocket(webSocket, {
         room: this.id
@@ -352,7 +351,7 @@ var IORoom = class {
       );
       const uninitializeWs = yield pluvWs.initialize();
       const user = yield this._getAuthorizedUser(token);
-      const isUnauthorized = !!((_a = this._authorize) == null ? void 0 : _a.required) && !user;
+      const isUnauthorized = !!((_b = this._authorize) == null ? void 0 : _b.required) && !user;
       const isTokenInUse = !!user && Array.from(this._sessions.values()).some(
         (session2) => {
           var _a2;
@@ -388,7 +387,9 @@ var IORoom = class {
         user != null ? user : {}
       );
       const onClose = this._onClose(session, uninitializeWs).bind(this);
-      const onMessage = this._onMessage(session).bind(this);
+      const onMessage = this._onMessage(session, platformEventContext).bind(
+        this
+      );
       pluvWs.addEventListener("close", onClose);
       pluvWs.addEventListener("error", onClose);
       pluvWs.addEventListener("message", onMessage);
@@ -514,7 +515,10 @@ var IORoom = class {
         const encodedState = this._doc.encodeStateAsUpdate();
         this._doc.destroy();
         this._doc = (0, import_crdt_yjs.doc)();
-        this._listeners.onDestroy(encodedState);
+        this._listeners.onDestroy(__spreadProps(__spreadValues({}, this._context), {
+          encodedState,
+          room: this.id
+        }));
         this._uninitialize = null;
       });
     });
@@ -558,10 +562,10 @@ var IORoom = class {
       });
     };
   }
-  _onMessage(session) {
+  _onMessage(session, platformEventContext) {
     return (event) => {
       var _a, _b, _c;
-      const context = {
+      const baseContext = {
         context: this._context,
         doc: this._doc,
         room: this.id,
@@ -589,10 +593,13 @@ var IORoom = class {
         });
         return;
       }
+      const extendedContext = __spreadProps(__spreadValues({}, baseContext), {
+        context: __spreadValues(__spreadValues({}, this._context), platformEventContext)
+      });
       Promise.all([
-        (_a = resolver.broadcast) == null ? void 0 : _a.call(resolver, inputs, context),
-        (_b = resolver.self) == null ? void 0 : _b.call(resolver, inputs, context),
-        (_c = resolver.sync) == null ? void 0 : _c.call(resolver, inputs, context)
+        (_a = resolver.broadcast) == null ? void 0 : _a.call(resolver, inputs, extendedContext),
+        (_b = resolver.self) == null ? void 0 : _b.call(resolver, inputs, extendedContext),
+        (_c = resolver.sync) == null ? void 0 : _c.call(resolver, inputs, baseContext)
       ]).then(([broadcast, self, sync]) => {
         if (broadcast) {
           Object.entries(broadcast).forEach(([type, data]) => {
@@ -723,7 +730,7 @@ var IORoom = class {
 var PluvIO = class {
   constructor(options) {
     this._context = {};
-    this._initialStorage = null;
+    this._getInitialStorage = null;
     this._rooms = /* @__PURE__ */ new Map();
     this._authorize = null;
     this._events = {
@@ -759,20 +766,25 @@ var PluvIO = class {
               }
             };
           },
-          self: (_0, _1) => __async(this, [_0, _1], function* ({ update }, { doc: doc2, room }) {
+          self: (_0, _1) => __async(this, [_0, _1], function* ({ update }, { context, doc: doc2, room }) {
             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)) {
-              const state2 = updates.reduce((_doc, _up) => _doc.applyUpdate(_up), doc2).encodeStateAsUpdate();
+              const encodedState = updates.reduce((_doc, _up) => _doc.applyUpdate(_up), doc2).encodeStateAsUpdate();
               yield this._platform.persistance.setStorageState(
                 room,
-                state2
+                encodedState
               );
-              this._listeners.onStorageUpdated(room, state2);
+              this._listeners.onStorageUpdated(__spreadProps(__spreadValues({}, context), {
+                encodedState,
+                room
+              }));
             }
             const state = (_b = yield this._platform.persistance.getStorageState(
               room
@@ -805,16 +817,19 @@ var PluvIO = class {
         }
       },
       $UPDATE_STORAGE: {
-        resolver: ({ origin, update }, { doc: doc2, room }) => {
+        resolver: ({ origin, update }, { context, doc: doc2, room }) => {
           if (origin === "$STORAGE_RECEIVED" && Object.keys(doc2.toJSON()).length) {
             return;
           }
           const updated = doc2.applyUpdate(update);
-          const state = updated.encodeStateAsUpdate();
-          this._platform.persistance.setStorageState(room, state).then(() => {
-            this._listeners.onStorageUpdated(room, state);
+          const encodedState = updated.encodeStateAsUpdate();
+          this._platform.persistance.setStorageState(room, encodedState).then(() => {
+            this._listeners.onStorageUpdated(__spreadProps(__spreadValues({}, context), {
+              encodedState,
+              room
+            }));
           });
-          return { $STORAGE_UPDATED: { state } };
+          return { $STORAGE_UPDATED: { state: encodedState } };
         }
       }
     };
@@ -823,7 +838,7 @@ var PluvIO = class {
       context,
       debug = false,
       events,
-      initialStorage,
+      getInitialStorage,
       onRoomDeleted,
       onStorageUpdated,
       platform
@@ -836,15 +851,11 @@ var PluvIO = class {
       this._context = context;
     if (events)
       this._events = events;
-    if (initialStorage)
-      this._initialStorage = initialStorage;
+    if (getInitialStorage)
+      this._getInitialStorage = getInitialStorage;
     this._listeners = {
-      onRoomDeleted: (room, encodedState) => {
-        return onRoomDeleted == null ? void 0 : onRoomDeleted(room, encodedState);
-      },
-      onStorageUpdated: (room, encodedState) => {
-        return onStorageUpdated == null ? void 0 : onStorageUpdated(room, encodedState);
-      }
+      onRoomDeleted: (event) => onRoomDeleted == null ? void 0 : onRoomDeleted(event),
+      onStorageUpdated: (event) => onStorageUpdated == null ? void 0 : onStorageUpdated(event)
     };
   }
   createToken(params) {
@@ -875,9 +886,9 @@ var PluvIO = class {
       })
     );
   }
-  getRoom(room, options = {}) {
-    var _a;
-    const { debug } = options;
+  getRoom(room, options) {
+    var _b;
+    const _a = options, { debug } = _a, platformRoomContext = __objRest(_a, ["debug"]);
     this._purgeEmptyRooms();
     if (!/^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$/i.test(room)) {
       throw new Error("Unsupported room name");
@@ -886,20 +897,25 @@ var PluvIO = class {
     const oldRoom = this._rooms.get(room);
     if (oldRoom)
       return oldRoom;
+    const roomContext = __spreadValues(__spreadValues({}, this._context), platformRoomContext);
     const newRoom = new IORoom(room, {
-      authorize: (_a = this._authorize) != null ? _a : void 0,
-      context: this._context,
+      authorize: (_b = this._authorize) != null ? _b : void 0,
+      context: roomContext,
       debug: debug != null ? debug : this._debug,
       events: this._events,
-      onDestroy: (encodedState) => {
+      onDestroy: ({ encodedState, room: room2 }) => {
         this._logDebug(
-          `${import_kleur2.default.blue("Deleting empty room:")} ${room}`
+          `${import_kleur2.default.blue("Deleting empty room:")} ${room2}`
         );
-        this._rooms.delete(room);
-        this._listeners.onRoomDeleted(room, encodedState);
+        const roomContext2 = __spreadValues({
+          room: room2,
+          encodedState
+        }, platformRoomContext);
+        this._rooms.delete(room2);
+        this._listeners.onRoomDeleted(roomContext2);
         if (this._debug) {
           const rooms = Array.from(this._rooms.keys());
-          this._logDebug(`${import_kleur2.default.blue("Deleted room:")} ${room}`);
+          this._logDebug(`${import_kleur2.default.blue("Deleted room:")} ${room2}`);
           this._logDebug(
             `${import_kleur2.default.blue("Rooms available:")} ${rooms.join(", ")}`
           );
@@ -954,7 +970,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform
@@ -963,7 +979,7 @@ var createIO = (params) => {
     authorize: authorize2,
     context,
     debug,
-    initialStorage,
+    getInitialStorage,
     onRoomDeleted,
     onStorageUpdated,
     platform