@pluv/platform-cloudflare 0.2.1 → 0.3.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-cloudflare@0.2.1 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.3.1 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
 > 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
-ESM dist/index.mjs 5.53 KB
-ESM ⚡️ Build success in 98ms
-CJS dist/index.js 6.66 KB
-CJS ⚡️ Build success in 100ms
+CJS dist/index.js 6.76 KB
+CJS ⚡️ Build success in 101ms
+ESM dist/index.mjs 5.63 KB
+ESM ⚡️ Build success in 102ms
 DTS Build start
-DTS ⚡️ Build success in 5163ms
-DTS dist/index.d.ts 2.57 KB
+DTS ⚡️ Build success in 5082ms
+DTS dist/index.d.ts 2.90 KB

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @pluv/platform-cloudflare
 
+## 0.3.1
+
+### Patch Changes
+
+- Updated dependencies [2e7cbfa]
+  - @pluv/io@0.6.0
+
+## 0.3.0
+
+### Minor Changes
+
+- ae4e1f1: added platform-specific contexts to expose env in cloudflare and req in node.js
+
+### Patch Changes
+
+- Updated dependencies [ae4e1f1]
+  - @pluv/io@0.5.0
+
 ## 0.2.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AbstractWebSocket, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, AbstractPlatform, PluvIO } from '@pluv/io';
-import { MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
+import { MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
 
 type CloudflareWebSocketConfig = AbstractWebSocketConfig;
 declare class CloudflareWebSocket extends AbstractWebSocket {
@@ -13,7 +13,11 @@ declare class CloudflareWebSocket extends AbstractWebSocket {
     terminate(): void;
 }
 
-declare class CloudflarePlatform extends AbstractPlatform<WebSocket> {
+declare class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends AbstractPlatform<WebSocket, {
+    env: TEnv;
+}, {
+    request: Request;
+}> {
     convertWebSocket(webSocket: WebSocket, config: AbstractWebSocketConfig): CloudflareWebSocket;
     parseData(data: string | ArrayBuffer): Record<string, any>;
     randomUUID(): string;
@@ -24,8 +28,8 @@ interface AuthorizeFunctionContext {
     roomId: string;
 }
 type AuthorizeFunction<TPluv extends PluvIO<CloudflarePlatform>> = (ctx: AuthorizeFunctionContext) => MaybePromise<Maybe<InferIOAuthorizeUser<InferIOAuthorize<TPluv>>>>;
-type CreatePluvHandlerConfig<TPluv extends PluvIO<CloudflarePlatform>, TBinding extends string, TEnv extends Record<string, any>> = {
-    binding: TBinding;
+type CreatePluvHandlerConfig<TPluv extends PluvIO<CloudflarePlatform>, TEnv extends Record<string, any>> = {
+    binding: string;
     endpoint?: string;
     modify?: (request: Request, response: Response, env: TEnv) => MaybePromise<Response>;
     io: TPluv;
@@ -37,13 +41,14 @@ type CreatePluvHandlerConfig<TPluv extends PluvIO<CloudflarePlatform>, TBinding
 type PluvHandlerFetch<TEnv extends Record<string, any> = {}> = (request: Request, env: TEnv) => Promise<Response | null>;
 interface CreatePluvHandlerResult<TEnv extends Record<string, any> = {}> {
     DurableObject: {
-        new (state: DurableObjectState): DurableObject;
+        new (state: DurableObjectState, env: TEnv): DurableObject;
     };
     fetch: PluvHandlerFetch<TEnv>;
     handler: ExportedHandler<TEnv>;
 }
-declare const createPluvHandler: <TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>, TBinding extends string, TEnv extends Record<string, any>>(config: CreatePluvHandlerConfig<TPluv, TBinding, TEnv>) => CreatePluvHandlerResult<TEnv>;
+type InferCloudflarePluvHandlerEnv<TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>> = TPluv extends PluvIO<CloudflarePlatform<infer IEnv>, any, any, any, any, any, any> ? IEnv : {};
+declare const createPluvHandler: <TPluv extends PluvIO<CloudflarePlatform<{}>, any, any, any, any, any, any>>(config: CreatePluvHandlerConfig<TPluv, Id<InferCloudflarePluvHandlerEnv<TPluv>>>) => CreatePluvHandlerResult<Id<InferCloudflarePluvHandlerEnv<TPluv>>>;
 
-declare const platformCloudflare: () => CloudflarePlatform;
+declare const platformCloudflare: <TEnv extends Record<string, any> = {}>() => CloudflarePlatform<TEnv>;
 
 export { AuthorizeFunction, AuthorizeFunctionContext, CreatePluvHandlerConfig, CreatePluvHandlerResult, PluvHandlerFetch, createPluvHandler, platformCloudflare };

package/dist/index.js

@@ -50,8 +50,9 @@ var import_path_to_regexp = require("path-to-regexp");
 var createPluvHandler = (config) => {
   const { authorize, binding, endpoint = "/api/pluv", modify, io } = config;
   const DurableObject = class {
-    constructor(state) {
-      this._io = io.getRoom(state.id.toString());
+    constructor(state, env) {
+      this._env = env;
+      this._io = io.getRoom(state.id.toString(), { env });
     }
     fetch(request) {
       return __async(this, null, function* () {
@@ -61,7 +62,11 @@ var createPluvHandler = (config) => {
         }
         const { 0: client, 1: server } = new WebSocketPair();
         const token = new URL(request.url).searchParams.get("token");
-        yield this._io.register(server, { token });
+        yield this._io.register(server, {
+          env: this._env,
+          request,
+          token
+        });
         return new Response(null, { status: 101, webSocket: client });
       });
     }

package/dist/index.mjs

@@ -24,8 +24,9 @@ import { match } from "path-to-regexp";
 var createPluvHandler = (config) => {
   const { authorize, binding, endpoint = "/api/pluv", modify, io } = config;
   const DurableObject = class {
-    constructor(state) {
-      this._io = io.getRoom(state.id.toString());
+    constructor(state, env) {
+      this._env = env;
+      this._io = io.getRoom(state.id.toString(), { env });
     }
     fetch(request) {
       return __async(this, null, function* () {
@@ -35,7 +36,11 @@ var createPluvHandler = (config) => {
         }
         const { 0: client, 1: server } = new WebSocketPair();
         const token = new URL(request.url).searchParams.get("token");
-        yield this._io.register(server, { token });
+        yield this._io.register(server, {
+          env: this._env,
+          request,
+          token
+        });
         return new Response(null, { status: 101, webSocket: client });
       });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-cloudflare",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "@pluv/io adapter for cloudflare workers",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "path-to-regexp": "^6.2.1",
-    "@pluv/io": "^0.4.2",
+    "@pluv/io": "^0.6.0",
     "@pluv/types": "^0.2.0"
   },
   "devDependencies": {

package/src/CloudflarePlatform.ts

@@ -2,7 +2,9 @@ import type { AbstractWebSocketConfig } from "@pluv/io";
 import { AbstractPlatform } from "@pluv/io";
 import { CloudflareWebSocket } from "./CloudflareWebSocket";
 
-export class CloudflarePlatform extends AbstractPlatform<WebSocket> {
+export class CloudflarePlatform<
+    TEnv extends Record<string, any> = {}
+> extends AbstractPlatform<WebSocket, { env: TEnv }, { request: Request }> {
     public convertWebSocket(
         webSocket: WebSocket,
         config: AbstractWebSocketConfig

package/src/createPluvHandler.ts

@@ -1,5 +1,6 @@
 import { IORoom, PluvIO } from "@pluv/io";
 import {
+    Id,
     InferIOAuthorize,
     InferIOAuthorizeRequired,
     InferIOAuthorizeUser,
@@ -19,10 +20,9 @@ export type AuthorizeFunction<TPluv extends PluvIO<CloudflarePlatform>> = (
 
 export type CreatePluvHandlerConfig<
     TPluv extends PluvIO<CloudflarePlatform>,
-    TBinding extends string,
     TEnv extends Record<string, any>
 > = {
-    binding: TBinding;
+    binding: string;
     endpoint?: string;
     modify?: (
         request: Request,
@@ -42,25 +42,47 @@ export type PluvHandlerFetch<TEnv extends Record<string, any> = {}> = (
 export interface CreatePluvHandlerResult<
     TEnv extends Record<string, any> = {}
 > {
-    DurableObject: { new (state: DurableObjectState): DurableObject };
+    DurableObject: {
+        new (state: DurableObjectState, env: TEnv): DurableObject;
+    };
     fetch: PluvHandlerFetch<TEnv>;
     handler: ExportedHandler<TEnv>;
 }
 
+type InferCloudflarePluvHandlerEnv<
+    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>
+> = TPluv extends PluvIO<
+    CloudflarePlatform<infer IEnv>,
+    any,
+    any,
+    any,
+    any,
+    any,
+    any
+>
+    ? IEnv
+    : {};
+
 export const createPluvHandler = <
-    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>,
-    TBinding extends string,
-    TEnv extends Record<string, any>
+    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>
 >(
-    config: CreatePluvHandlerConfig<TPluv, TBinding, TEnv>
-): CreatePluvHandlerResult<TEnv> => {
+    config: CreatePluvHandlerConfig<
+        TPluv,
+        Id<InferCloudflarePluvHandlerEnv<TPluv>>
+    >
+): CreatePluvHandlerResult<Id<InferCloudflarePluvHandlerEnv<TPluv>>> => {
     const { authorize, binding, endpoint = "/api/pluv", modify, io } = config;
 
     const DurableObject = class implements DurableObject {
+        private _env: Id<InferCloudflarePluvHandlerEnv<TPluv>>;
         private _io: IORoom<CloudflarePlatform>;
 
-        constructor(state: DurableObjectState) {
-            this._io = io.getRoom(state.id.toString());
+        constructor(
+            state: DurableObjectState,
+            env: Id<InferCloudflarePluvHandlerEnv<TPluv>>
+        ) {
+            this._env = env;
+            this._io = io.getRoom(state.id.toString(), { env });
         }
 
         async fetch(
@@ -76,14 +98,22 @@ export const createPluvHandler = <
 
             const token = new URL(request.url).searchParams.get("token");
 
-            await this._io.register(server, { token });
+            await this._io.register(server, {
+                env: this._env,
+                request,
+                token,
+            });
 
             return new Response(null, { status: 101, webSocket: client });
         }
     };
 
-    const getDurableObjectNamespace = (env: TEnv): DurableObjectNamespace => {
-        const namespace = env[binding];
+    const getDurableObjectNamespace = (
+        env: Id<InferCloudflarePluvHandlerEnv<TPluv>>
+    ): DurableObjectNamespace => {
+        const namespace = env[
+            binding as keyof typeof env
+        ] as DurableObjectNamespace;
 
         if (!namespace) {
             throw new Error(`Could not find DurableObject binding: ${binding}`);
@@ -92,7 +122,9 @@ export const createPluvHandler = <
         return namespace;
     };
 
-    const authHandler: PluvHandlerFetch<TEnv> = async (request, env) => {
+    const authHandler: PluvHandlerFetch<
+        Id<InferCloudflarePluvHandlerEnv<TPluv>>
+    > = async (request, env) => {
         if (!authorize) return null;
 
         const { pathname, searchParams } = new URL(request.url);
@@ -138,7 +170,9 @@ export const createPluvHandler = <
         }
     };
 
-    const roomHandler: PluvHandlerFetch<TEnv> = async (request, env) => {
+    const roomHandler: PluvHandlerFetch<
+        Id<InferCloudflarePluvHandlerEnv<TPluv>>
+    > = async (request, env) => {
         const { pathname } = new URL(request.url);
         const matcher = match<{ roomId: string }>(`${endpoint}/room/:roomId`);
         const matched = matcher(pathname);
@@ -161,13 +195,15 @@ export const createPluvHandler = <
         return room.fetch(request);
     };
 
-    const fetch: PluvHandlerFetch<TEnv> = async (request, env) => {
+    const fetch: PluvHandlerFetch<
+        Id<InferCloudflarePluvHandlerEnv<TPluv>>
+    > = async (request, env) => {
         return [authHandler, roomHandler].reduce((promise, current) => {
             return promise.then((value) => value ?? current(request, env));
         }, Promise.resolve<Response | null>(null));
     };
 
-    const handler: ExportedHandler<TEnv> = {
+    const handler: ExportedHandler<Id<InferCloudflarePluvHandlerEnv<TPluv>>> = {
         fetch: async (request, env) => {
             const response =
                 (await fetch(request, env)) ??

package/src/platformCloudflare.ts

@@ -1,5 +1,7 @@
 import { CloudflarePlatform } from "./CloudflarePlatform";
 
-export const platformCloudflare = (): CloudflarePlatform => {
-    return new CloudflarePlatform();
+export const platformCloudflare = <
+    TEnv extends Record<string, any> = {}
+>(): CloudflarePlatform<TEnv> => {
+    return new CloudflarePlatform<TEnv>();
 };