@pluv/platform-cloudflare 0.32.3 → 0.32.5

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-cloudflare@0.32.3 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.32.5 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
 > 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 11.66 KB
-ESM ⚡️ Build success in 73ms
-CJS dist/index.js 12.76 KB
-CJS ⚡️ Build success in 73ms
+ESM dist/index.mjs 11.70 KB
+ESM ⚡️ Build success in 62ms
+CJS dist/index.js 12.80 KB
+CJS ⚡️ Build success in 66ms
 DTS Build start
-DTS ⚡️ Build success in 951ms
-DTS dist/index.d.mts 4.32 KB
-DTS dist/index.d.ts  4.32 KB
+DTS ⚡️ Build success in 935ms
+DTS dist/index.d.mts 4.67 KB
+DTS dist/index.d.ts  4.67 KB

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # @pluv/platform-cloudflare
 
+## 0.32.5
+
+### Patch Changes
+
+- 98d7585: Update `meta` type on platform contexts to allow for nested json types.
+  - @pluv/io@0.32.5
+  - @pluv/persistence-cloudflare-transactional-storage@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/persistence-cloudflare-transactional-storage@0.32.4
+  - @pluv/types@0.32.4
+
 ## 0.32.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { AbstractWebSocket, WebSocketSerializedState, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, AbstractPlatformConfig, WebSocketRegistrationMode, AbstractPlatform, ConvertWebSocketConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
+import { JsonObject, Json, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
 
 type CloudflareWebSocketConfig = AbstractWebSocketConfig;
 declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
@@ -15,31 +15,30 @@ declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
     terminate(): void;
 }
 
-type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}> = AbstractPlatformConfig<{
+type CloudflarePlatformRoomContext<TEnv extends Record<string, any>, TMeta extends Record<string, Json>> = {
     env: TEnv;
     state: DurableObjectState;
-}> & {
+} & (keyof TMeta extends never ? {
+    meta?: undefined;
+} : {
+    meta: TMeta;
+});
+type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}> = AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>> & {
     mode?: WebSocketRegistrationMode;
 };
-declare class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends AbstractPlatform<CloudflareWebSocket, {
+declare class CloudflarePlatform<TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}> extends AbstractPlatform<CloudflareWebSocket, {
     env: TEnv;
     request: Request;
-}, {
-    env: TEnv;
-    state: DurableObjectState;
-}> {
+}, CloudflarePlatformRoomContext<TEnv, TMeta>> {
     readonly _registrationMode: WebSocketRegistrationMode;
-    constructor(config?: CloudflarePlatformConfig<TEnv>);
+    constructor(config: CloudflarePlatformConfig<TEnv, TMeta>);
     acceptWebSocket(webSocket: CloudflareWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): CloudflareWebSocket;
     getLastPing(webSocket: CloudflareWebSocket): number | null;
     getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
-    initialize(config: AbstractPlatformConfig<{
-        env: TEnv;
-        state: DurableObjectState;
-    }>): this;
+    initialize(config: AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>>): this;
     parseData(data: string | ArrayBuffer): Record<string, any>;
     randomUUID(): string;
     setSerializedState(webSocket: CloudflareWebSocket, state: WebSocketSerializedState): void;
@@ -71,6 +70,6 @@ interface CreatePluvHandlerResult<TEnv extends Record<string, any> = {}> {
 type InferCloudflarePluvHandlerEnv<TPluvServer extends PluvServer<CloudflarePlatform, any, any, any>> = TPluvServer extends PluvServer<CloudflarePlatform<infer IEnv>, any, any, any> ? IEnv : {};
 declare const createPluvHandler: <TPluvServer extends PluvServer<CloudflarePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer, Id<InferCloudflarePluvHandlerEnv<TPluvServer>>>) => CreatePluvHandlerResult<Id<InferCloudflarePluvHandlerEnv<TPluvServer>>>;
 
-declare const platformCloudflare: <TEnv extends Record<string, any> = {}>(config?: CloudflarePlatformConfig<TEnv>) => CloudflarePlatform<TEnv>;
+declare const platformCloudflare: <TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}>(config?: CloudflarePlatformConfig<TEnv, TMeta>) => CloudflarePlatform<TEnv, TMeta>;
 
 export { type AuthorizeFunction, type AuthorizeFunctionContext, CloudflarePlatform, type CloudflarePlatformConfig, type CreatePluvHandlerConfig, type CreatePluvHandlerResult, type PluvHandlerFetch, createPluvHandler, platformCloudflare };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AbstractWebSocket, WebSocketSerializedState, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, AbstractPlatformConfig, WebSocketRegistrationMode, AbstractPlatform, ConvertWebSocketConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
+import { JsonObject, Json, MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
 
 type CloudflareWebSocketConfig = AbstractWebSocketConfig;
 declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
@@ -15,31 +15,30 @@ declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
     terminate(): void;
 }
 
-type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}> = AbstractPlatformConfig<{
+type CloudflarePlatformRoomContext<TEnv extends Record<string, any>, TMeta extends Record<string, Json>> = {
     env: TEnv;
     state: DurableObjectState;
-}> & {
+} & (keyof TMeta extends never ? {
+    meta?: undefined;
+} : {
+    meta: TMeta;
+});
+type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}> = AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>> & {
     mode?: WebSocketRegistrationMode;
 };
-declare class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends AbstractPlatform<CloudflareWebSocket, {
+declare class CloudflarePlatform<TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}> extends AbstractPlatform<CloudflareWebSocket, {
     env: TEnv;
     request: Request;
-}, {
-    env: TEnv;
-    state: DurableObjectState;
-}> {
+}, CloudflarePlatformRoomContext<TEnv, TMeta>> {
     readonly _registrationMode: WebSocketRegistrationMode;
-    constructor(config?: CloudflarePlatformConfig<TEnv>);
+    constructor(config: CloudflarePlatformConfig<TEnv, TMeta>);
     acceptWebSocket(webSocket: CloudflareWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): CloudflareWebSocket;
     getLastPing(webSocket: CloudflareWebSocket): number | null;
     getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
-    initialize(config: AbstractPlatformConfig<{
-        env: TEnv;
-        state: DurableObjectState;
-    }>): this;
+    initialize(config: AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>>): this;
     parseData(data: string | ArrayBuffer): Record<string, any>;
     randomUUID(): string;
     setSerializedState(webSocket: CloudflareWebSocket, state: WebSocketSerializedState): void;
@@ -71,6 +70,6 @@ interface CreatePluvHandlerResult<TEnv extends Record<string, any> = {}> {
 type InferCloudflarePluvHandlerEnv<TPluvServer extends PluvServer<CloudflarePlatform, any, any, any>> = TPluvServer extends PluvServer<CloudflarePlatform<infer IEnv>, any, any, any> ? IEnv : {};
 declare const createPluvHandler: <TPluvServer extends PluvServer<CloudflarePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer, Id<InferCloudflarePluvHandlerEnv<TPluvServer>>>) => CreatePluvHandlerResult<Id<InferCloudflarePluvHandlerEnv<TPluvServer>>>;
 
-declare const platformCloudflare: <TEnv extends Record<string, any> = {}>(config?: CloudflarePlatformConfig<TEnv>) => CloudflarePlatform<TEnv>;
+declare const platformCloudflare: <TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}>(config?: CloudflarePlatformConfig<TEnv, TMeta>) => CloudflarePlatform<TEnv, TMeta>;
 
 export { type AuthorizeFunction, type AuthorizeFunctionContext, CloudflarePlatform, type CloudflarePlatformConfig, type CreatePluvHandlerConfig, type CreatePluvHandlerResult, type PluvHandlerFetch, createPluvHandler, platformCloudflare };

package/dist/index.js

@@ -258,7 +258,7 @@ var DEFAULT_REGISTRATION_MODE = "detached";
 
 // src/CloudflarePlatform.ts
 var CloudflarePlatform = class _CloudflarePlatform extends import_io2.AbstractPlatform {
-  constructor(config = {}) {
+  constructor(config) {
     var _a;
     super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistence: new import_persistence_cloudflare_transactional_storage.PersistenceCloudflareTransactionalStorage(config.context) } : {}));
     this._registrationMode = (_a = config.mode) != null ? _a : DEFAULT_REGISTRATION_MODE;
@@ -314,7 +314,11 @@ var CloudflarePlatform = class _CloudflarePlatform extends import_io2.AbstractPl
       throw new Error("Could not derive platform context");
     }
     return new _CloudflarePlatform({
-      context: { env: context.env, state: context.state },
+      context: {
+        env: context.env,
+        meta: context.meta,
+        state: context.state
+      },
       mode: this._registrationMode,
       persistence: this.persistence,
       pubSub: this.pubSub

package/dist/index.mjs

@@ -234,7 +234,7 @@ var DEFAULT_REGISTRATION_MODE = "detached";
 
 // src/CloudflarePlatform.ts
 var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
-  constructor(config = {}) {
+  constructor(config) {
     var _a;
     super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistence: new PersistenceCloudflareTransactionalStorage(config.context) } : {}));
     this._registrationMode = (_a = config.mode) != null ? _a : DEFAULT_REGISTRATION_MODE;
@@ -290,7 +290,11 @@ var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
       throw new Error("Could not derive platform context");
     }
     return new _CloudflarePlatform({
-      context: { env: context.env, state: context.state },
+      context: {
+        env: context.env,
+        meta: context.meta,
+        state: context.state
+      },
       mode: this._registrationMode,
       persistence: this.persistence,
       pubSub: this.pubSub

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-cloudflare",
-  "version": "0.32.3",
+  "version": "0.32.5",
   "description": "@pluv/io adapter for cloudflare workers",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,17 +18,17 @@
   },
   "dependencies": {
     "path-to-regexp": "^8.2.0",
-    "@pluv/io": "^0.32.3",
-    "@pluv/persistence-cloudflare-transactional-storage": "^0.32.3",
-    "@pluv/types": "^0.32.3"
+    "@pluv/io": "^0.32.5",
+    "@pluv/persistence-cloudflare-transactional-storage": "^0.32.5",
+    "@pluv/types": "^0.32.5"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20241011.0",
+    "@cloudflare/workers-types": "^4.20241018.0",
     "eslint": "^8.57.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.3",
-    "@pluv/tsconfig": "^0.32.3",
-    "eslint-config-pluv": "^0.32.3"
+    "@pluv/tsconfig": "^0.32.5",
+    "eslint-config-pluv": "^0.32.5"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/CloudflarePlatform.ts

@@ -1,28 +1,36 @@
 import type {
     AbstractPlatformConfig,
     ConvertWebSocketConfig,
-    InferInitContextType,
     WebSocketRegistrationMode,
     WebSocketSerializedState,
 } from "@pluv/io";
 import { AbstractPlatform } from "@pluv/io";
 import { PersistenceCloudflareTransactionalStorage } from "@pluv/persistence-cloudflare-transactional-storage";
+import type { Json } from "@pluv/types";
 import { CloudflareWebSocket } from "./CloudflareWebSocket";
 import { DEFAULT_REGISTRATION_MODE } from "./constants";
 
-export type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}> = AbstractPlatformConfig<{
+export type CloudflarePlatformRoomContext<TEnv extends Record<string, any>, TMeta extends Record<string, Json>> = {
     env: TEnv;
     state: DurableObjectState;
-}> & { mode?: WebSocketRegistrationMode };
+} & (keyof TMeta extends never ? { meta?: undefined } : { meta: TMeta });
 
-export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends AbstractPlatform<
+export type CloudflarePlatformConfig<
+    TEnv extends Record<string, any> = {},
+    TMeta extends Record<string, Json> = {},
+> = AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>> & { mode?: WebSocketRegistrationMode };
+
+export class CloudflarePlatform<
+    TEnv extends Record<string, any> = {},
+    TMeta extends Record<string, Json> = {},
+> extends AbstractPlatform<
     CloudflareWebSocket,
     { env: TEnv; request: Request },
-    { env: TEnv; state: DurableObjectState }
+    CloudflarePlatformRoomContext<TEnv, TMeta>
 > {
     readonly _registrationMode: WebSocketRegistrationMode;
 
-    constructor(config: CloudflarePlatformConfig<TEnv> = {}) {
+    constructor(config: CloudflarePlatformConfig<TEnv, TMeta>) {
         super({
             ...config,
             ...(config.context && config.mode === "detached"
@@ -92,15 +100,19 @@ export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends A
         return detachedState.getWebSockets() ?? [];
     }
 
-    public initialize(config: AbstractPlatformConfig<{ env: TEnv; state: DurableObjectState }>): this {
+    public initialize(config: AbstractPlatformConfig<CloudflarePlatformRoomContext<TEnv, TMeta>>): this {
         const context = config.context ?? { ...this._roomContext };
 
         if (!context.env || !context.state) {
             throw new Error("Could not derive platform context");
         }
 
-        return new CloudflarePlatform<TEnv>({
-            context: { env: context.env, state: context.state },
+        return new CloudflarePlatform<TEnv, TMeta>({
+            context: {
+                env: context.env,
+                meta: context.meta,
+                state: context.state,
+            } as CloudflarePlatformRoomContext<TEnv, TMeta>,
             mode: this._registrationMode,
             persistence: this.persistence,
             pubSub: this.pubSub,

package/src/platformCloudflare.ts

@@ -1,8 +1,9 @@
+import type { Json } from "@pluv/types";
 import type { CloudflarePlatformConfig } from "./CloudflarePlatform";
 import { CloudflarePlatform } from "./CloudflarePlatform";
 
-export const platformCloudflare = <TEnv extends Record<string, any> = {}>(
-    config: CloudflarePlatformConfig<TEnv> = {},
-): CloudflarePlatform<TEnv> => {
-    return new CloudflarePlatform<TEnv>(config);
+export const platformCloudflare = <TEnv extends Record<string, any> = {}, TMeta extends Record<string, Json> = {}>(
+    config: CloudflarePlatformConfig<TEnv, TMeta> = {},
+): CloudflarePlatform<TEnv, TMeta> => {
+    return new CloudflarePlatform<TEnv, TMeta>(config);
 };