@pluv/platform-cloudflare 0.3.2 → 0.3.4

package/.turbo/turbo-build.log

@@ -1,17 +1,18 @@
 
-> @pluv/platform-cloudflare@0.3.2 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.3.4 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v7.0.0
+CLI tsup v7.1.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 5.63 KB
-ESM ⚡️ Build success in 141ms
-CJS dist/index.js 6.76 KB
-CJS ⚡️ Build success in 117ms
+ESM dist/index.mjs 5.76 KB
+ESM ⚡️ Build success in 120ms
+CJS dist/index.js 6.89 KB
+CJS ⚡️ Build success in 121ms
 DTS Build start
-DTS ⚡️ Build success in 7749ms
-DTS dist/index.d.ts 2.90 KB
+DTS ⚡️ Build success in 7077ms
+DTS dist/index.d.mts 2.90 KB
+DTS dist/index.d.ts  2.90 KB

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @pluv/platform-cloudflare
 
+## 0.3.4
+
+### Patch Changes
+
+- @pluv/io@0.7.2
+
+## 0.3.3
+
+### Patch Changes
+
+- 8fba48b: fix including incorrect dependency
+- 8997c65: bumped dependencies
+- Updated dependencies [8fba48b]
+- Updated dependencies [8997c65]
+  - @pluv/types@0.2.2
+  - @pluv/io@0.7.1
+
 ## 0.3.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -0,0 +1,54 @@
+import { AbstractWebSocket, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, AbstractPlatform, PluvIO } from '@pluv/io';
+import { MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired, Id } from '@pluv/types';
+
+type CloudflareWebSocketConfig = AbstractWebSocketConfig;
+declare class CloudflareWebSocket extends AbstractWebSocket {
+    webSocket: WebSocket;
+    get readyState(): 0 | 1 | 2 | 3;
+    constructor(webSocket: WebSocket, config: CloudflareWebSocketConfig);
+    addEventListener<TType extends keyof AbstractEventMap>(type: TType, handler: AbstractListener<TType>): void;
+    close(code?: number | undefined, reason?: string | undefined): void;
+    initialize(): Promise<() => undefined>;
+    send(message: string | ArrayBuffer | ArrayBufferView): void;
+    terminate(): void;
+}
+
+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;
+}
+
+interface AuthorizeFunctionContext {
+    request: Request<any, CfProperties<any>>;
+    roomId: string;
+}
+type AuthorizeFunction<TPluv extends PluvIO<CloudflarePlatform>> = (ctx: AuthorizeFunctionContext) => MaybePromise<Maybe<InferIOAuthorizeUser<InferIOAuthorize<TPluv>>>>;
+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;
+} & (InferIOAuthorizeRequired<InferIOAuthorize<TPluv>> extends true ? {
+    authorize: AuthorizeFunction<TPluv>;
+} : {
+    authorize?: undefined;
+});
+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, 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 : {};
+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: <TEnv extends Record<string, any> = {}>() => CloudflarePlatform<TEnv>;
+
+export { AuthorizeFunction, AuthorizeFunctionContext, CreatePluvHandlerConfig, CreatePluvHandlerResult, PluvHandlerFetch, createPluvHandler, platformCloudflare };

package/dist/index.js

@@ -54,6 +54,12 @@ var createPluvHandler = (config) => {
       this._env = env;
       this._io = io.getRoom(state.id.toString(), { env });
     }
+    webSocketClose(ws, code, reason, wasClean) {
+    }
+    webSocketError(ws, error) {
+    }
+    webSocketMessage(ws, message) {
+    }
     fetch(request) {
       return __async(this, null, function* () {
         const isWSRequest = request.headers.get("Upgrade") === "websocket";

package/dist/index.mjs

@@ -28,6 +28,12 @@ var createPluvHandler = (config) => {
       this._env = env;
       this._io = io.getRoom(state.id.toString(), { env });
     }
+    webSocketClose(ws, code, reason, wasClean) {
+    }
+    webSocketError(ws, error) {
+    }
+    webSocketMessage(ws, message) {
+    }
     fetch(request) {
       return __async(this, null, function* () {
         const isWSRequest = request.headers.get("Upgrade") === "websocket";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-cloudflare",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "@pluv/io adapter for cloudflare workers",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,18 +17,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@playwright/test": "^1.35.1",
-    "@types/react": "^18.2.13",
+    "@types/react": "^18.2.15",
     "path-to-regexp": "^6.2.1",
-    "@pluv/io": "^0.7.0",
-    "@pluv/types": "^0.2.1"
+    "@pluv/io": "^0.7.2",
+    "@pluv/types": "^0.2.2"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20230518.0",
-    "tsup": "^7.0.0",
-    "typescript": "^5.1.3",
-    "@pluv/tsconfig": "^0.1.7",
-    "eslint-config-pluv": "^0.1.13"
+    "@cloudflare/workers-types": "^4.20230717.1",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "@pluv/tsconfig": "^0.2.0",
+    "eslint-config-pluv": "^0.1.14"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/CloudflarePlatform.ts

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

package/src/CloudflareWebSocket.ts

@@ -31,14 +31,14 @@ export class CloudflareWebSocket extends AbstractWebSocket {
 
     public addEventListener<TType extends keyof AbstractEventMap>(
         type: TType,
-        handler: AbstractListener<TType>
+        handler: AbstractListener<TType>,
     ) {
         this.webSocket.addEventListener(type, handler as any);
     }
 
     public close(code?: number | undefined, reason?: string | undefined): void {
         const canClose = [this.CONNECTING, this.OPEN].some(
-            (readyState) => readyState === this.readyState
+            (readyState) => readyState === this.readyState,
         );
 
         if (!canClose) return;

package/src/createPluvHandler.ts

@@ -15,19 +15,19 @@ export interface AuthorizeFunctionContext {
     roomId: string;
 }
 export type AuthorizeFunction<TPluv extends PluvIO<CloudflarePlatform>> = (
-    ctx: AuthorizeFunctionContext
+    ctx: AuthorizeFunctionContext,
 ) => MaybePromise<Maybe<InferIOAuthorizeUser<InferIOAuthorize<TPluv>>>>;
 
 export type CreatePluvHandlerConfig<
     TPluv extends PluvIO<CloudflarePlatform>,
-    TEnv extends Record<string, any>
+    TEnv extends Record<string, any>,
 > = {
     binding: string;
     endpoint?: string;
     modify?: (
         request: Request,
         response: Response,
-        env: TEnv
+        env: TEnv,
     ) => MaybePromise<Response>;
     io: TPluv;
 } & (InferIOAuthorizeRequired<InferIOAuthorize<TPluv>> extends true
@@ -36,11 +36,11 @@ export type CreatePluvHandlerConfig<
 
 export type PluvHandlerFetch<TEnv extends Record<string, any> = {}> = (
     request: Request,
-    env: TEnv
+    env: TEnv,
 ) => Promise<Response | null>;
 
 export interface CreatePluvHandlerResult<
-    TEnv extends Record<string, any> = {}
+    TEnv extends Record<string, any> = {},
 > {
     DurableObject: {
         new (state: DurableObjectState, env: TEnv): DurableObject;
@@ -50,7 +50,7 @@ export interface CreatePluvHandlerResult<
 }
 
 type InferCloudflarePluvHandlerEnv<
-    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>
+    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>,
 > = TPluv extends PluvIO<
     CloudflarePlatform<infer IEnv>,
     any,
@@ -64,12 +64,12 @@ type InferCloudflarePluvHandlerEnv<
     : {};
 
 export const createPluvHandler = <
-    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>
+    TPluv extends PluvIO<CloudflarePlatform, any, any, any, any, any, any>,
 >(
     config: CreatePluvHandlerConfig<
         TPluv,
         Id<InferCloudflarePluvHandlerEnv<TPluv>>
-    >
+    >,
 ): CreatePluvHandlerResult<Id<InferCloudflarePluvHandlerEnv<TPluv>>> => {
     const { authorize, binding, endpoint = "/api/pluv", modify, io } = config;
 
@@ -79,14 +79,28 @@ export const createPluvHandler = <
 
         constructor(
             state: DurableObjectState,
-            env: Id<InferCloudflarePluvHandlerEnv<TPluv>>
+            env: Id<InferCloudflarePluvHandlerEnv<TPluv>>,
         ) {
             this._env = env;
             this._io = io.getRoom(state.id.toString(), { env });
         }
 
+        webSocketClose(
+            ws: WebSocket,
+            code: number,
+            reason: string,
+            wasClean: boolean,
+        ): void | Promise<void> {}
+
+        webSocketError(ws: WebSocket, error: unknown): void | Promise<void> {}
+
+        webSocketMessage(
+            ws: WebSocket,
+            message: string | ArrayBuffer,
+        ): void | Promise<void> {}
+
         async fetch(
-            request: Request<any, CfProperties<any>>
+            request: Request<any, CfProperties<any>>,
         ): Promise<Response> {
             const isWSRequest = request.headers.get("Upgrade") === "websocket";
 
@@ -109,7 +123,7 @@ export const createPluvHandler = <
     };
 
     const getDurableObjectNamespace = (
-        env: Id<InferCloudflarePluvHandlerEnv<TPluv>>
+        env: Id<InferCloudflarePluvHandlerEnv<TPluv>>,
     ): DurableObjectNamespace => {
         const namespace = env[
             binding as keyof typeof env
@@ -165,7 +179,7 @@ export const createPluvHandler = <
                 {
                     headers: { "Content-Type": "text/plain" },
                     status: 403,
-                }
+                },
             );
         }
     };

package/src/platformCloudflare.ts

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