feat(@dobsjs/websocket): websocket client

Author: do4ng

packages/dobs-ws/README.md

@@ -0,0 +1,23 @@
+# @dobsjs/websocket
+
+Simplest WebSocket Plugin for [dobs](https://dobs.vercel.app)
+
+## Usage
+
+```ts
+import { websocket } from '@dobsjs/websocket';
+import { defineConfig } from 'dobs';
+
+export default defineConfig({
+  plugins: [
+    websocket({
+      open(ws) {
+        console.log('[ws] connected');
+      },
+      message(ws, message) {
+        console.log('[ws] message ' + message.toString());
+      },
+    }),
+  ],
+});
+```

packages/dobs-ws/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dobsjs/websocket",
+  "version": "0.1.0-beta.2",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/zely-js/dobs",
+  "description": "WebSocket for dobs",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "dependencies": {
+    "ws": "^8.18.3"
+  },
+  "devDependencies": {
+    "@types/ws": "^8"
+  }
+}

packages/dobs-ws/src/index.ts

@@ -0,0 +1,31 @@
+import WebSocket, { WebSocketServer } from 'ws';
+import type { Plugin } from 'dobs';
+import type { Promisable } from '~/dobs/_types';
+
+export interface WebSocketOptions {
+  open?(ws: WebSocket): Promisable<void>;
+  message?(ws: WebSocket, data: WebSocket.RawData): Promisable<void>;
+  error?(err: Error): Promisable<void>;
+}
+
+export function websocket(websocketOptions: WebSocketOptions): Plugin {
+  return {
+    name: '@dobsjs/websocket',
+
+    server(server) {
+      const wss = new WebSocketServer({ server: server.server });
+
+      wss.on('connection', async (ws) => {
+        if (websocketOptions?.open) await websocketOptions.open(ws);
+
+        ws.on('message', async (data) => {
+          if (websocketOptions?.message) await websocketOptions.message(ws, data);
+        });
+
+        ws.on('error', async (err) => {
+          if (websocketOptions?.error) await websocketOptions.error(err);
+        });
+      });
+    },
+  };
+}

packages/dobs-ws/tsdown.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: './src/index.ts',
+  platform: 'node',
+  format: ['cjs', 'esm'],
+});

packages/dobs/src/index.ts

@@ -3,3 +3,4 @@ export * from './config';
 export * from './types';
 export * from './builder';
 export * from './defineRoutes';
+export type { Plugin, ErrorContext } from './plugin';

playgrounds/default/dobs.config.ts

@@ -1,6 +1,18 @@
+import { websocket } from '@dobsjs/websocket';
+
 import { cachePlugin } from 'dobs/experimental';
 
 export default {
   port: 3000,
-  plugins: [cachePlugin({ ttl: 1000 })],
+  plugins: [
+    cachePlugin({ ttl: 1000 }),
+    websocket({
+      open(ws) {
+        console.log('[ws] connected');
+      },
+      message(ws, message) {
+        console.log('[ws] message ' + message.toString());
+      },
+    }),
+  ],
 } satisfies import('dobs').ServerConfig;

playgrounds/default/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1-alpha.2",
   "private": true,
   "dependencies": {
+    "@dobsjs/websocket": "workspace:*",
     "dobs": "workspace:*"
   },
   "scripts": {

yarn.lock

@@ -113,6 +113,15 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@dobsjs/websocket@workspace:*, @dobsjs/websocket@workspace:packages/dobs-ws":
+  version: 0.0.0-use.local
+  resolution: "@dobsjs/websocket@workspace:packages/dobs-ws"
+  dependencies:
+    "@types/ws": "npm:^8"
+    ws: "npm:^8.18.3"
+  languageName: unknown
+  linkType: soft
+
 "@emnapi/core@npm:^1.4.3, @emnapi/core@npm:^1.5.0":
   version: 1.7.0
   resolution: "@emnapi/core@npm:1.7.0"
@@ -1535,6 +1544,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@playgrounds/default@workspace:playgrounds/default"
   dependencies:
+    "@dobsjs/websocket": "workspace:*"
     dobs: "workspace:*"
   languageName: unknown
   linkType: soft
@@ -2328,6 +2338,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/ws@npm:^8":
+  version: 8.18.1
+  resolution: "@types/ws@npm:8.18.1"
+  dependencies:
+    "@types/node": "npm:*"
+  checksum: 10c0/61aff1129143fcc4312f083bc9e9e168aa3026b7dd6e70796276dcfb2c8211c4292603f9c4864fae702f2ed86e4abd4d38aa421831c2fd7f856c931a481afbab
+  languageName: node
+  linkType: hard
+
 "@typescript-eslint/eslint-plugin@npm:8.46.3":
   version: 8.46.3
   resolution: "@typescript-eslint/eslint-plugin@npm:8.46.3"
@@ -8059,6 +8078,21 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ws@npm:^8.18.3":
+  version: 8.18.3
+  resolution: "ws@npm:8.18.3"
+  peerDependencies:
+    bufferutil: ^4.0.1
+    utf-8-validate: ">=5.0.2"
+  peerDependenciesMeta:
+    bufferutil:
+      optional: true
+    utf-8-validate:
+      optional: true
+  checksum: 10c0/eac918213de265ef7cb3d4ca348b891a51a520d839aa51cdb8ca93d4fa7ff9f6ccb339ccee89e4075324097f0a55157c89fa3f7147bde9d8d7e90335dc087b53
+  languageName: node
+  linkType: hard
+
 "y18n@npm:^5.0.5":
   version: 5.0.8
   resolution: "y18n@npm:5.0.8"