@pluv/platform-node 0.32.3 → 0.32.5

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-node@0.32.3 build /home/runner/work/pluv/pluv/packages/platform-node
+> @pluv/platform-node@0.32.5 build /home/runner/work/pluv/pluv/packages/platform-node
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 7.41 KB
-ESM ⚡️ Build success in 104ms
-CJS dist/index.js 9.26 KB
-CJS ⚡️ Build success in 114ms
+ESM dist/index.mjs 8.13 KB
+ESM ⚡️ Build success in 80ms
+CJS dist/index.js 9.89 KB
+CJS ⚡️ Build success in 88ms
 DTS Build start
-DTS ⚡️ Build success in 5599ms
-DTS dist/index.d.mts 3.78 KB
-DTS dist/index.d.ts  3.78 KB
+DTS ⚡️ Build success in 5166ms
+DTS dist/index.d.mts 4.17 KB
+DTS dist/index.d.ts  4.17 KB

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @pluv/platform-node
 
+## 0.32.5
+
+### Patch Changes
+
+- 98d7585: Update `meta` type on platform contexts to allow for nested json types.
+  - @pluv/io@0.32.5
+  - @pluv/types@0.32.5
+
+## 0.32.4
+
+### Patch Changes
+
+- fd054db: Add support for adding metadata to context when creating a room.
+
+  ```ts
+  import { createIO } from "@pluv/io";
+
+  // If using Cloudflare
+  import { platformCloudflare } from "@pluv/platform-cloudflare";
+
+  const io = createIO({
+    // ...
+    platform: platformCloudflare<CloudflareEnv, { myCustomData: string }>(),
+    context: ({
+      env,
+      state,
+      // This is now available on the context function
+      meta,
+    }) => ({ env, state, meta }),
+  });
+
+  const ioServer = io.server();
+
+  ioServer.createRoom("my-room", {
+    // ...
+    // This will now be a required property when creating a room
+    meta: { myCustomData: "hello world" },
+  });
+
+  // If using Node.js
+  import { platformNode } from "@pluv/platform-node";
+
+  const io = createIO({
+    // ...
+    platform: platformNode<{ myCustomData: string }>(),
+    context: ({
+      // This is now available on the context function
+      meta,
+    }) => ({ env, state, meta }),
+  });
+
+  const ioServer = io.server();
+
+  ioServer.createRoom("my-room", {
+    // ...
+    // This will now be a required property when creating a room
+    meta: { myCustomData: "hello world" },
+  });
+  ```
+
+  - @pluv/io@0.32.4
+  - @pluv/types@0.32.4
+
 ## 0.32.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { WebSocket, Server as Server$1 } from 'ws';
 export { WebSocket } from 'ws';
 import { AbstractWebSocket, WebSocketSerializedState, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, AbstractPlatform, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
+import { JsonObject, Json, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
 import { IncomingMessage, Server, ServerResponse } from 'node:http';
 
 type NodeWebSocketConfig = AbstractWebSocketConfig;
@@ -20,7 +20,12 @@ declare class NodeWebSocket extends AbstractWebSocket<WebSocket> {
     terminate(): void;
 }
 
-type NodePlatformConfig = {
+type NodePlatformRoomContext<TMeta extends Record<string, Json>> = keyof TMeta extends never ? {
+    meta?: undefined;
+} : {
+    meta: TMeta;
+};
+type NodePlatformConfig<TMeta extends Record<string, Json>> = {
     mode?: WebSocketRegistrationMode;
 } & ({
     persistence?: undefined;
@@ -28,19 +33,21 @@ type NodePlatformConfig = {
 } | {
     persistence: AbstractPersistence;
     pubSub: AbstractPubSub;
-});
-declare class NodePlatform extends AbstractPlatform<NodeWebSocket, {
+}) & {
+    context?: NodePlatformRoomContext<TMeta>;
+};
+declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<NodeWebSocket, {
     req: IncomingMessage;
-}, {}> {
+}, NodePlatformRoomContext<TMeta>> {
     readonly _registrationMode: WebSocketRegistrationMode;
-    constructor(config?: NodePlatformConfig);
+    constructor(config?: NodePlatformConfig<TMeta>);
     acceptWebSocket(webSocket: NodeWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): NodeWebSocket;
     getLastPing(webSocket: NodeWebSocket): number | null;
     getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
-    initialize(config: AbstractPlatformConfig<{}>): this;
+    initialize(config: AbstractPlatformConfig<NodePlatformRoomContext<TMeta>>): this;
     parseData(data: string | ArrayBuffer): Record<string, any>;
     randomUUID(): string;
     setSerializedState(webSocket: NodeWebSocket, state: WebSocketSerializedState): void;
@@ -71,6 +78,6 @@ interface CreatePluvHandlerResult {
 }
 declare const createPluvHandler: <TPluvServer extends PluvServer<NodePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer>) => CreatePluvHandlerResult;
 
-declare const platformNode: (config?: NodePlatformConfig) => NodePlatform;
+declare const platformNode: <TMeta extends Record<string, Json> = {}>(config?: NodePlatformConfig<TMeta>) => NodePlatform<TMeta>;
 
 export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, NodePlatform, type NodePlatformConfig, createPluvHandler, platformNode };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { WebSocket, Server as Server$1 } from 'ws';
 export { WebSocket } from 'ws';
 import { AbstractWebSocket, WebSocketSerializedState, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, AbstractPlatform, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
+import { JsonObject, Json, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
 import { IncomingMessage, Server, ServerResponse } from 'node:http';
 
 type NodeWebSocketConfig = AbstractWebSocketConfig;
@@ -20,7 +20,12 @@ declare class NodeWebSocket extends AbstractWebSocket<WebSocket> {
     terminate(): void;
 }
 
-type NodePlatformConfig = {
+type NodePlatformRoomContext<TMeta extends Record<string, Json>> = keyof TMeta extends never ? {
+    meta?: undefined;
+} : {
+    meta: TMeta;
+};
+type NodePlatformConfig<TMeta extends Record<string, Json>> = {
     mode?: WebSocketRegistrationMode;
 } & ({
     persistence?: undefined;
@@ -28,19 +33,21 @@ type NodePlatformConfig = {
 } | {
     persistence: AbstractPersistence;
     pubSub: AbstractPubSub;
-});
-declare class NodePlatform extends AbstractPlatform<NodeWebSocket, {
+}) & {
+    context?: NodePlatformRoomContext<TMeta>;
+};
+declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<NodeWebSocket, {
     req: IncomingMessage;
-}, {}> {
+}, NodePlatformRoomContext<TMeta>> {
     readonly _registrationMode: WebSocketRegistrationMode;
-    constructor(config?: NodePlatformConfig);
+    constructor(config?: NodePlatformConfig<TMeta>);
     acceptWebSocket(webSocket: NodeWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): NodeWebSocket;
     getLastPing(webSocket: NodeWebSocket): number | null;
     getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
-    initialize(config: AbstractPlatformConfig<{}>): this;
+    initialize(config: AbstractPlatformConfig<NodePlatformRoomContext<TMeta>>): this;
     parseData(data: string | ArrayBuffer): Record<string, any>;
     randomUUID(): string;
     setSerializedState(webSocket: NodeWebSocket, state: WebSocketSerializedState): void;
@@ -71,6 +78,6 @@ interface CreatePluvHandlerResult {
 }
 declare const createPluvHandler: <TPluvServer extends PluvServer<NodePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer>) => CreatePluvHandlerResult;
 
-declare const platformNode: (config?: NodePlatformConfig) => NodePlatform;
+declare const platformNode: <TMeta extends Record<string, Json> = {}>(config?: NodePlatformConfig<TMeta>) => NodePlatform<TMeta>;
 
 export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, NodePlatform, type NodePlatformConfig, createPluvHandler, platformNode };

package/dist/index.js

@@ -3,8 +3,22 @@ var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -232,8 +246,10 @@ var NodeWebSocket = class extends import_io.AbstractWebSocket {
 // src/NodePlatform.ts
 var NodePlatform = class _NodePlatform extends import_io2.AbstractPlatform {
   constructor(config = {}) {
-    const { mode = "attached", persistence, pubSub } = config;
-    super(persistence && pubSub ? { persistence, pubSub } : {});
+    const { context, mode = "attached", persistence, pubSub } = config;
+    super(__spreadValues({
+      context
+    }, persistence && pubSub ? { persistence, pubSub } : {}));
     this._registrationMode = mode;
   }
   acceptWebSocket(webSocket) {

package/dist/index.mjs

@@ -1,3 +1,19 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -196,8 +212,10 @@ var NodeWebSocket = class extends AbstractWebSocket {
 // src/NodePlatform.ts
 var NodePlatform = class _NodePlatform extends AbstractPlatform {
   constructor(config = {}) {
-    const { mode = "attached", persistence, pubSub } = config;
-    super(persistence && pubSub ? { persistence, pubSub } : {});
+    const { context, mode = "attached", persistence, pubSub } = config;
+    super(__spreadValues({
+      context
+    }, persistence && pubSub ? { persistence, pubSub } : {}));
     this._registrationMode = mode;
   }
   acceptWebSocket(webSocket) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-node",
-  "version": "0.32.3",
+  "version": "0.32.5",
   "description": "@pluv/io adapter for node.js",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,19 +17,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/node": "^22.7.5",
+    "@types/node": "^22.7.8",
     "@types/ws": "^8.5.12",
     "path-to-regexp": "^8.2.0",
-    "@pluv/io": "^0.32.3",
-    "@pluv/types": "^0.32.3"
+    "@pluv/io": "^0.32.5",
+    "@pluv/types": "^0.32.5"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.3",
     "ws": "^8.18.0",
-    "@pluv/tsconfig": "^0.32.3",
-    "eslint-config-pluv": "^0.32.3"
+    "@pluv/tsconfig": "^0.32.5",
+    "eslint-config-pluv": "^0.32.5"
   },
   "peerDependencies": {
     "ws": "^8.0.0"

package/src/NodePlatform.ts

@@ -7,24 +7,36 @@ import type {
     WebSocketSerializedState,
 } from "@pluv/io";
 import { AbstractPlatform } from "@pluv/io";
+import type { Json } from "@pluv/types";
 import crypto from "node:crypto";
 import type { IncomingMessage } from "node:http";
 import { TextDecoder } from "node:util";
 import type { WebSocket } from "ws";
 import { NodeWebSocket } from "./NodeWebSocket";
 
-export type NodePlatformConfig = { mode?: WebSocketRegistrationMode } & (
+export type NodePlatformRoomContext<TMeta extends Record<string, Json>> = keyof TMeta extends never
+    ? { meta?: undefined }
+    : { meta: TMeta };
+
+export type NodePlatformConfig<TMeta extends Record<string, Json>> = { mode?: WebSocketRegistrationMode } & (
     | { persistence?: undefined; pubSub?: undefined }
     | { persistence: AbstractPersistence; pubSub: AbstractPubSub }
-);
+) & { context?: NodePlatformRoomContext<TMeta> };
 
-export class NodePlatform extends AbstractPlatform<NodeWebSocket, { req: IncomingMessage }, {}> {
+export class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<
+    NodeWebSocket,
+    { req: IncomingMessage },
+    NodePlatformRoomContext<TMeta>
+> {
     readonly _registrationMode: WebSocketRegistrationMode;
 
-    constructor(config: NodePlatformConfig = {}) {
-        const { mode = "attached", persistence, pubSub } = config;
+    constructor(config: NodePlatformConfig<TMeta> = {}) {
+        const { context, mode = "attached", persistence, pubSub } = config;
 
-        super(persistence && pubSub ? { persistence, pubSub } : {});
+        super({
+            context,
+            ...(persistence && pubSub ? { persistence, pubSub } : {}),
+        });
 
         this._registrationMode = mode;
     }
@@ -55,13 +67,13 @@ export class NodePlatform extends AbstractPlatform<NodeWebSocket, { req: Incomin
         return [];
     }
 
-    public initialize(config: AbstractPlatformConfig<{}>): this {
+    public initialize(config: AbstractPlatformConfig<NodePlatformRoomContext<TMeta>>): this {
         return new NodePlatform({
             context: config.context,
             mode: this._registrationMode,
             persistence: this.persistence,
             pubSub: this.pubSub,
-        } as NodePlatformConfig)._initialize() as this;
+        } as NodePlatformConfig<TMeta>)._initialize() as this;
     }
 
     public parseData(data: string | ArrayBuffer): Record<string, any> {

package/src/platformNode.ts

@@ -1,6 +1,9 @@
+import type { Json } from "@pluv/types";
 import type { NodePlatformConfig } from "./NodePlatform";
 import { NodePlatform } from "./NodePlatform";
 
-export const platformNode = (config: NodePlatformConfig = {}): NodePlatform => {
-    return new NodePlatform(config);
+export const platformNode = <TMeta extends Record<string, Json> = {}>(
+    config: NodePlatformConfig<TMeta> = {},
+): NodePlatform<TMeta> => {
+    return new NodePlatform<TMeta>(config);
 };