@pluv/platform-node 0.3.2 → 0.3.3

package/.turbo/turbo-build.log

@@ -1,17 +1,18 @@
 
-> @pluv/platform-node@0.3.2 build /home/runner/work/pluv/pluv/packages/platform-node
+> @pluv/platform-node@0.3.3 build /home/runner/work/pluv/pluv/packages/platform-node
 > 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 6.16 KB
-ESM ⚡️ Build success in 89ms
 CJS dist/index.js 7.98 KB
-CJS ⚡️ Build success in 102ms
+CJS ⚡️ Build success in 85ms
+ESM dist/index.mjs 6.16 KB
+ESM ⚡️ Build success in 88ms
 DTS Build start
-DTS ⚡️ Build success in 9401ms
-DTS dist/index.d.ts 2.75 KB
+DTS ⚡️ Build success in 9398ms
+DTS dist/index.d.mts 2.75 KB
+DTS dist/index.d.ts  2.75 KB

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @pluv/platform-node
 
+## 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,64 @@
+import { AbstractWebSocket, AbstractEventMap, AbstractListener, AbstractWebSocketConfig, AbstractPersistance, AbstractPubSub, AbstractPlatform, ConvertWebSocketConfig, PluvIO } from '@pluv/io';
+import { MaybePromise, Maybe, InferIOAuthorizeUser, InferIOAuthorize, InferIOAuthorizeRequired } from '@pluv/types';
+import Http, { IncomingMessage } from 'http';
+import WS, { WebSocket } from 'ws';
+export { WebSocket } from 'ws';
+
+type NodeWebSocketConfig = AbstractWebSocketConfig;
+declare class NodeWebSocket extends AbstractWebSocket {
+    webSocket: WebSocket;
+    get readyState(): 0 | 1 | 2 | 3;
+    constructor(webSocket: WebSocket, config: NodeWebSocketConfig);
+    addEventListener<TType extends keyof AbstractEventMap>(type: TType, handler: AbstractListener<TType>): void;
+    close(code?: number | undefined, reason?: string | undefined): void;
+    initialize(): Promise<() => void>;
+    send(message: string | ArrayBuffer | ArrayBufferView): void;
+    terminate(): void;
+}
+
+type NodePlatformOptions = {
+    persistance?: undefined;
+    pubSub?: undefined;
+} | {
+    persistance: AbstractPersistance;
+    pubSub: AbstractPubSub;
+};
+declare class NodePlatform extends AbstractPlatform<WebSocket, {
+    req: IncomingMessage;
+}> {
+    constructor(options?: NodePlatformOptions);
+    convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): NodeWebSocket;
+    parseData(data: string | ArrayBuffer): Record<string, any>;
+    randomUUID(): string;
+}
+
+interface AuthorizeFunctionContext {
+    req: Http.IncomingMessage;
+    res: Http.ServerResponse;
+    roomId: string;
+}
+type AuthorizeFunction<TPluv extends PluvIO<NodePlatform>> = (ctx: AuthorizeFunctionContext) => MaybePromise<Maybe<InferIOAuthorizeUser<InferIOAuthorize<TPluv>>>>;
+type CreatePluvHandlerConfig<TPluv extends PluvIO<NodePlatform>> = {
+    endpoint?: string;
+    io: TPluv;
+    server: Http.Server;
+} & (InferIOAuthorizeRequired<InferIOAuthorize<TPluv>> extends true ? {
+    authorize: AuthorizeFunction<TPluv>;
+} : {
+    authorize?: undefined;
+});
+type RequestHandler = (req: Http.IncomingMessage, res: Http.ServerResponse, next?: () => void) => void;
+interface WebSocketHandlerResult {
+    matched: boolean;
+}
+type WebSocketHandler = (ws: WS.WebSocket, req: Http.IncomingMessage) => Promise<WebSocketHandlerResult>;
+interface CreatePluvHandlerResult {
+    createWsServer: () => WS.Server;
+    handler: RequestHandler;
+    wsHandler: WebSocketHandler;
+}
+declare const createPluvHandler: <TPluv extends PluvIO<NodePlatform, any, any, any, any, any, any>>(config: CreatePluvHandlerConfig<TPluv>) => CreatePluvHandlerResult;
+
+declare const platformNode: (options?: NodePlatformOptions) => NodePlatform;
+
+export { AuthorizeFunction, AuthorizeFunctionContext, CreatePluvHandlerConfig, NodePlatformOptions, createPluvHandler, platformNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-node",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "@pluv/io adapter for node.js",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,20 +17,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@playwright/test": "^1.35.1",
-    "@types/node": "^20.3.1",
-    "@types/react": "^18.2.13",
+    "@types/node": "^20.4.2",
+    "@types/react": "^18.2.15",
     "@types/ws": "^8.5.5",
     "path-to-regexp": "^6.2.1",
-    "@pluv/io": "^0.7.0",
-    "@pluv/types": "^0.2.1"
+    "@pluv/io": "^0.7.1",
+    "@pluv/types": "^0.2.2"
   },
   "devDependencies": {
-    "tsup": "^7.0.0",
-    "typescript": "^5.1.3",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
     "ws": "^8.13.0",
-    "@pluv/tsconfig": "^0.1.7",
-    "eslint-config-pluv": "^0.1.13"
+    "@pluv/tsconfig": "^0.1.8",
+    "eslint-config-pluv": "^0.1.14"
   },
   "peerDependencies": {
     "ws": "^8.0.0"

package/src/NodePlatform.ts

@@ -25,7 +25,7 @@ export class NodePlatform extends AbstractPlatform<
 
     public convertWebSocket(
         webSocket: WebSocket,
-        config: ConvertWebSocketConfig
+        config: ConvertWebSocketConfig,
     ): NodeWebSocket {
         const { room } = config;
 

package/src/NodeWebSocket.ts

@@ -34,7 +34,7 @@ export class NodeWebSocket extends AbstractWebSocket {
 
     public addEventListener<TType extends keyof AbstractEventMap>(
         type: TType,
-        handler: AbstractListener<TType>
+        handler: AbstractListener<TType>,
     ): void {
         switch (type) {
             case "close":
@@ -43,7 +43,7 @@ export class NodeWebSocket extends AbstractWebSocket {
                         (handler as AbstractListener<"close">)({
                             code,
                             reason: reason.toString("utf-8"),
-                        })
+                        }),
                     );
                 });
 
@@ -54,7 +54,7 @@ export class NodeWebSocket extends AbstractWebSocket {
                         (handler as AbstractListener<"error">)({
                             error,
                             message: error.message,
-                        })
+                        }),
                     );
                 });
 
@@ -64,7 +64,7 @@ export class NodeWebSocket extends AbstractWebSocket {
                     await Promise.resolve(
                         (handler as AbstractListener<"message">)({
                             data,
-                        })
+                        }),
                     );
                 });
 
@@ -75,7 +75,7 @@ export class NodeWebSocket extends AbstractWebSocket {
 
     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

@@ -18,7 +18,7 @@ export interface AuthorizeFunctionContext {
     roomId: string;
 }
 export type AuthorizeFunction<TPluv extends PluvIO<NodePlatform>> = (
-    ctx: AuthorizeFunctionContext
+    ctx: AuthorizeFunctionContext,
 ) => MaybePromise<Maybe<InferIOAuthorizeUser<InferIOAuthorize<TPluv>>>>;
 
 export type CreatePluvHandlerConfig<TPluv extends PluvIO<NodePlatform>> = {
@@ -50,7 +50,7 @@ const handle = (ws: WS.WebSocket) => ({
 export type RequestHandler = (
     req: Http.IncomingMessage,
     res: Http.ServerResponse,
-    next?: () => void
+    next?: () => void,
 ) => void;
 
 export interface WebSocketHandlerResult {
@@ -59,7 +59,7 @@ export interface WebSocketHandlerResult {
 
 export type WebSocketHandler = (
     ws: WS.WebSocket,
-    req: Http.IncomingMessage
+    req: Http.IncomingMessage,
 ) => Promise<WebSocketHandlerResult>;
 
 export interface CreatePluvHandlerResult {
@@ -69,9 +69,9 @@ export interface CreatePluvHandlerResult {
 }
 
 export const createPluvHandler = <
-    TPluv extends PluvIO<NodePlatform, any, any, any, any, any, any>
+    TPluv extends PluvIO<NodePlatform, any, any, any, any, any, any>,
 >(
-    config: CreatePluvHandlerConfig<TPluv>
+    config: CreatePluvHandlerConfig<TPluv>,
 ): CreatePluvHandlerResult => {
     const { authorize, endpoint = "/api/pluv", io, server } = config;
 
@@ -79,7 +79,7 @@ export const createPluvHandler = <
 
     const wsHandler = async (
         ws: WS.WebSocket,
-        req: Http.IncomingMessage
+        req: Http.IncomingMessage,
     ): Promise<WebSocketHandlerResult> => {
         const url = req.url;
         const onError = handle(ws);
@@ -124,7 +124,7 @@ export const createPluvHandler = <
     const handler = async (
         req: Http.IncomingMessage,
         res: Http.ServerResponse,
-        next?: () => void
+        next?: () => void,
     ): Promise<Http.ServerResponse | null> => {
         if (!authorize) return next?.() ?? null;
         if (req.method !== "GET") return next?.() ?? null;

package/src/platformNode.ts

@@ -2,7 +2,7 @@ import type { NodePlatformOptions } from "./NodePlatform";
 import { NodePlatform } from "./NodePlatform";
 
 export const platformNode = (
-    options: NodePlatformOptions = {}
+    options: NodePlatformOptions = {},
 ): NodePlatform => {
     return new NodePlatform(options);
 };