@pluv/io 0.4.1 → 0.5.0

package/dist/index.mjs

@@ -279,9 +279,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;
@@ -300,10 +298,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
@@ -315,7 +314,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;
@@ -351,7 +350,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);
@@ -477,7 +478,10 @@ var IORoom = class {
         const encodedState = this._doc.encodeStateAsUpdate();
         this._doc.destroy();
         this._doc = doc();
-        this._listeners.onDestroy(encodedState);
+        this._listeners.onDestroy(__spreadProps(__spreadValues({}, this._context), {
+          encodedState,
+          room: this.id
+        }));
         this._uninitialize = null;
       });
     });
@@ -521,10 +525,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,
@@ -552,10 +556,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]) => {
@@ -722,7 +729,7 @@ 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 = [
@@ -730,12 +737,15 @@ var PluvIO = class {
               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
@@ -768,16 +778,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 } };
         }
       }
     };
@@ -802,12 +815,8 @@ var PluvIO = class {
     if (initialStorage)
       this._initialStorage = initialStorage;
     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) {
@@ -838,9 +847,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");
@@ -849,20 +858,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(
-          `${colors2.blue("Deleting empty room:")} ${room}`
+          `${colors2.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(`${colors2.blue("Deleted room:")} ${room}`);
+          this._logDebug(`${colors2.blue("Deleted room:")} ${room2}`);
           this._logDebug(
             `${colors2.blue("Rooms available:")} ${rooms.join(", ")}`
           );
@@ -887,11 +901,14 @@ var PluvIO = class {
     const platform = first._platform;
     const events1 = first._events;
     const events2 = second._events;
+    const { onRoomDeleted, onStorageUpdated } = first._listeners;
     const events = Object.assign(/* @__PURE__ */ Object.create(null), events1, events2);
     return new PluvIO({
       authorize: authorize2,
       debug,
       events,
+      onRoomDeleted,
+      onStorageUpdated,
       platform
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",

package/src/AbstractPlatform.ts

@@ -4,9 +4,19 @@ import type { AbstractWebSocket } from "./AbstractWebSocket";
 import { Persistance } from "./Persistance";
 import { PubSub } from "./PubSub";
 
-export type InferWebSocketType<TPlatform extends AbstractPlatform<any>> =
+export type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> =
     TPlatform extends AbstractPlatform<infer IWebSocket> ? IWebSocket : never;
 
+export type InferPlatformRoomContextType<TPlatform extends AbstractPlatform> =
+    TPlatform extends AbstractPlatform<any, infer IIOContext>
+        ? IIOContext
+        : never;
+
+export type InferPlatformEventContextType<TPlatform extends AbstractPlatform> =
+    TPlatform extends AbstractPlatform<any, any, infer IRoomContext>
+        ? IRoomContext
+        : never;
+
 export type AbstractPlatformConfig =
     | { persistance?: undefined; pubSub?: undefined }
     | {
@@ -18,7 +28,14 @@ export interface ConvertWebSocketConfig {
     room: string;
 }
 
-export abstract class AbstractPlatform<TWebSocket = any> {
+export abstract class AbstractPlatform<
+    TWebSocket = any,
+    TIOContext extends Record<string, any> = {},
+    TRoomContext extends Record<string, any> = {}
+> {
+    readonly _ioContext: TIOContext | undefined;
+    readonly _roomContext: TRoomContext | undefined;
+
     public persistance: AbstractPersistance;
     public pubSub: AbstractPubSub;
 

package/src/IORoom.ts

@@ -14,11 +14,15 @@ import type {
     IOLike,
     JsonObject,
     Maybe,
-    MaybePromise,
-    Spread,
 } from "@pluv/types";
 import colors from "kleur";
-import type { AbstractPlatform, InferWebSocketType } from "./AbstractPlatform";
+import type {
+    AbstractPlatform,
+    InferPlatformEventContextType,
+    InferPlatformRoomContextType,
+    InferPlatformWebSocketType,
+} from "./AbstractPlatform";
+import { AbstractMessageEvent } from "./AbstractWebSocket";
 import { authorize } from "./authorize";
 import type {
     EventResolver,
@@ -28,7 +32,6 @@ import type {
     SendMessageOptions,
     WebSocketSession,
 } from "./types";
-import { AbstractMessageEvent } from "./AbstractWebSocket";
 
 const PING_TIMEOUT_MS = 30_000;
 
@@ -41,8 +44,13 @@ interface BroadcastParams<TIO extends IORoom<any, any, any, any, any>> {
     senderId?: string;
 }
 
-interface IORoomListeners {
-    onDestroy: (encodedState: string) => void;
+export type IORoomListenerEvent<TPlatform extends AbstractPlatform> = {
+    room: string;
+    encodedState: string;
+} & InferPlatformRoomContextType<TPlatform>;
+
+interface IORoomListeners<TPlatform extends AbstractPlatform> {
+    onDestroy: (event: IORoomListenerEvent<TPlatform>) => void;
 }
 
 export type IORoomConfig<
@@ -53,11 +61,12 @@ export type IORoomConfig<
     TOutputBroadcast extends EventRecord<string, any> = {},
     TOutputSelf extends EventRecord<string, any> = {},
     TOutputSync extends EventRecord<string, any> = {}
-> = Partial<IORoomListeners> & {
+> = Partial<IORoomListeners<TPlatform>> & {
     authorize?: TAuthorize;
-    context: TContext;
+    context: TContext & InferPlatformRoomContextType<TPlatform>;
     debug: boolean;
     events: InferEventConfig<
+        TPlatform,
         TContext,
         TInput,
         TOutputBroadcast,
@@ -72,14 +81,15 @@ interface SendMessageSender {
     user: JsonObject | null;
 }
 
-export interface WebsocketRegisterOptions {
+export type WebsocketRegisterOptions<TPlatform extends AbstractPlatform> = {
     token?: string | null;
-}
+} & InferPlatformRoomContextType<TPlatform> &
+    InferPlatformEventContextType<TPlatform>;
 
 export class IORoom<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
     TAuthorize extends IOAuthorize<any, any> = BaseIOAuthorize,
-    TContext extends JsonObject = {},
+    TContext extends Record<string, any> = {},
     TInput extends EventRecord<string, any> = {},
     TOutputBroadcast extends EventRecord<string, any> = {},
     TOutputSelf extends EventRecord<string, any> = {},
@@ -87,17 +97,19 @@ export class IORoom<
 > implements
         IOLike<TAuthorize, TInput, TOutputBroadcast, TOutputSelf, TOutputSync>
 {
-    private readonly _context: TContext;
+    private readonly _context: TContext &
+        InferPlatformRoomContextType<TPlatform>;
     private readonly _debug: boolean;
     private readonly _platform: TPlatform;
 
     private _doc: YjsDoc<any> = doc();
-    private _listeners: IORoomListeners;
+    private _listeners: IORoomListeners<TPlatform>;
     private _sessions = new Map<string, WebSocketSession>();
     private _uninitialize: (() => Promise<void>) | null = null;
 
     readonly _authorize: TAuthorize | null = null;
     readonly _events: InferEventConfig<
+        TPlatform,
         TContext,
         TInput,
         TOutputBroadcast,
@@ -130,9 +142,7 @@ export class IORoom<
         this.id = id;
 
         this._listeners = {
-            onDestroy: (encodedState) => {
-                onDestroy?.(encodedState);
-            },
+            onDestroy: (event) => onDestroy?.(event),
         };
 
         if (authorize) this._authorize = authorize;
@@ -166,12 +176,16 @@ export class IORoom<
     }
 
     public async register(
-        webSocket: InferWebSocketType<TPlatform>,
-        options?: WebsocketRegisterOptions
+        webSocket: InferPlatformWebSocketType<TPlatform>,
+        options: WebsocketRegisterOptions<TPlatform>
     ): Promise<void> {
+        const { token, ..._platformEventContext } = options;
+        const platformEventContext =
+            _platformEventContext as InferPlatformRoomContextType<TPlatform> &
+                InferPlatformEventContextType<TPlatform>;
+
         if (!this._uninitialize) await this._initialize();
 
-        const token = options?.token;
         const sessionId = this._platform.randomUUID();
         const pluvWs = this._platform.convertWebSocket(webSocket, {
             room: this.id,
@@ -230,7 +244,9 @@ export class IORoom<
         );
 
         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);
@@ -340,6 +356,7 @@ export class IORoom<
         message: EventMessage<string, any>
     ):
         | InferEventConfig<
+              TPlatform,
               TContext,
               TInput,
               TOutputBroadcast,
@@ -373,6 +390,7 @@ export class IORoom<
     private _getEventResolverObject(
         message: EventMessage<string, any>
     ): EventResolverObject<
+        TPlatform,
         TContext,
         TInput[string],
         TOutputBroadcast,
@@ -384,8 +402,15 @@ export class IORoom<
         if (!eventConfig) return {};
 
         const resolver:
-            | EventResolver<TContext, TInput[string], TOutputBroadcast>
+            | EventResolver<
+                  TContext &
+                      InferPlatformRoomContextType<TPlatform> &
+                      InferPlatformEventContextType<TPlatform>,
+                  TInput[string],
+                  TOutputBroadcast
+              >
             | EventResolverObject<
+                  TPlatform,
                   TContext,
                   TInput[string],
                   TOutputBroadcast,
@@ -427,7 +452,11 @@ export class IORoom<
             this._doc.destroy();
             this._doc = doc();
 
-            this._listeners.onDestroy(encodedState);
+            this._listeners.onDestroy({
+                ...this._context,
+                encodedState,
+                room: this.id,
+            });
 
             this._uninitialize = null;
         };
@@ -485,10 +514,11 @@ export class IORoom<
     }
 
     private _onMessage(
-        session: WebSocketSession
+        session: WebSocketSession,
+        platformEventContext: InferPlatformEventContextType<TPlatform>
     ): (event: AbstractMessageEvent) => void {
         return (event: AbstractMessageEvent): void => {
-            const context: EventResolverContext<TContext> = {
+            const baseContext: EventResolverContext<TContext> = {
                 context: this._context,
                 doc: this._doc,
                 room: this.id,
@@ -524,10 +554,19 @@ export class IORoom<
                 return;
             }
 
+            const extendedContext: EventResolverContext<
+                TContext &
+                    InferPlatformRoomContextType<TPlatform> &
+                    InferPlatformEventContextType<TPlatform>
+            > = {
+                ...baseContext,
+                context: { ...this._context, ...platformEventContext },
+            };
+
             Promise.all([
-                resolver.broadcast?.(inputs, context),
-                resolver.self?.(inputs, context),
-                resolver.sync?.(inputs, context),
+                resolver.broadcast?.(inputs, extendedContext),
+                resolver.self?.(inputs, extendedContext),
+                resolver.sync?.(inputs, baseContext),
             ]).then(([broadcast, self, sync]) => {
                 if (broadcast) {
                     Object.entries(broadcast).forEach(([type, data]: any) => {