feat: migrate to rpc package (#3)

Co-authored-by: Anthony Fu <github@antfu.me>

Author: webfansplz

eslint.config.js

@@ -12,39 +12,3 @@ export default antfu({
       'no-console': 'off',
     },
   })
-  .append({
-    files: ['pnpm-workspace.yaml'],
-    name: 'antfu/yaml/pnpm-workspace',
-    rules: {
-      'yaml/sort-keys': [
-        'error',
-        {
-          order: [
-            'packages',
-            'overrides',
-            'patchedDependencies',
-            'hoistPattern',
-            'catalog',
-            'catalogs',
-
-            'allowedDeprecatedVersions',
-            'allowNonAppliedPatches',
-            'configDependencies',
-            'ignoredBuiltDependencies',
-            'ignoredOptionalDependencies',
-            'neverBuiltDependencies',
-            'onlyBuiltDependencies',
-            'onlyBuiltDependenciesFile',
-            'packageExtensions',
-            'peerDependencyRules',
-            'supportedArchitectures',
-          ],
-          pathPattern: '^$',
-        },
-        {
-          order: { type: 'asc' },
-          pathPattern: '.*',
-        },
-      ],
-    },
-  })

package.json

@@ -52,6 +52,7 @@
   },
   "resolutions": {
     "@nuxt/devtools": "catalog:devtools",
+    "@nuxt/kit": "catalog:build",
     "@rolldown/debug": "catalog:deps",
     "esbuild": "catalog:build",
     "nitropack": "catalog:build",

packages/devtools-rpc/package.json

@@ -18,7 +18,10 @@
   ],
   "sideEffects": false,
   "exports": {
-    ".": "./dist/index.mjs"
+    ".": "./dist/index.mjs",
+    "./presets/ws/server": "./dist/presets/ws/server.mjs",
+    "./presets/ws/client": "./dist/presets/ws/client.mjs",
+    "./presets": "./dist/presets/index.mjs"
   },
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
@@ -30,6 +33,11 @@
     "dev": "tsdown --watch",
     "prepack": "pnpm build"
   },
+  "peerDependenciesMeta": {
+    "ws": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "birpc": "catalog:deps",
     "structured-clone-es": "catalog:deps"

packages/devtools-rpc/src/client.ts

@@ -8,7 +8,7 @@ export function createRpcClient<
   functions: ClientFunctions,
   options: {
     preset: BirpcOptions<ServerFunctions>
-    rpcOptions?: BirpcOptions<ServerFunctions>
+    rpcOptions?: Partial<BirpcOptions<ServerFunctions>>
   },
 ) {
   const { preset, rpcOptions = {} } = options

packages/devtools-rpc/src/presets/index.ts

@@ -0,0 +1,17 @@
+import type { BirpcGroup, BirpcOptions, ChannelOptions } from 'birpc'
+
+export type RpcServerPresetReturnType = <ClientFunctions, ServerFunctions>(rpc: BirpcGroup<ClientFunctions, ServerFunctions>, options?: Pick<BirpcOptions<ClientFunctions>, 'serialize' | 'deserialize'>) => void
+export type RpcServerPresetBasicType = (...args: any[]) => RpcServerPresetReturnType
+export type RpcServerPreset<T extends RpcServerPresetBasicType> = (...args: Parameters<T>) => RpcServerPresetReturnType
+
+export function defineRpcServerPreset<T extends RpcServerPresetBasicType>(preset: T): RpcServerPreset<T> {
+  return preset
+}
+
+export type RpcClientPresetReturnType = Omit<ChannelOptions, 'bind'>
+export type RpcClientPresetBasicType = (...args: any[]) => RpcClientPresetReturnType
+export type RpcClientPreset<T extends RpcClientPresetBasicType> = (...args: Parameters<T>) => RpcClientPresetReturnType
+
+export function defineRpcClientPreset<T extends RpcClientPresetBasicType>(preset: T): RpcClientPreset<T> {
+  return preset
+}

packages/devtools-rpc/src/presets/ws/client.ts

@@ -1,11 +1,36 @@
 import { parse, stringify } from 'structured-clone-es'
+import { defineRpcClientPreset } from '..'
 
 export interface WebSocketRpcClientOptions {
   url: string
+  onConnected?: (e: Event) => void
+  onError?: (e: Error) => void
+  onDisconnected?: (e: CloseEvent) => void
 }
 
-export function createWsRpcPreset(options: WebSocketRpcClientOptions) {
+function NOOP() {}
+
+export const createWsRpcPreset = defineRpcClientPreset((options: WebSocketRpcClientOptions) => {
   const ws = new WebSocket(options.url)
+  const {
+    onConnected = NOOP,
+    onError = NOOP,
+    onDisconnected = NOOP,
+  } = options
+
+  ws.addEventListener('open', (e) => {
+    onConnected(e)
+  })
+
+  ws.addEventListener('error', (e) => {
+    const _e = e instanceof Error ? e : new Error(e.type)
+    onError(_e)
+  })
+
+  ws.addEventListener('close', (e) => {
+    onDisconnected(e)
+  })
+
   return {
     on: (handler: (data: string) => void) => {
       ws.addEventListener('message', (e) => {
@@ -27,4 +52,4 @@ export function createWsRpcPreset(options: WebSocketRpcClientOptions) {
     serialize: stringify,
     deserialize: parse,
   }
-}
+})

packages/devtools-rpc/src/presets/ws/server.ts

@@ -1,14 +1,22 @@
 import type { BirpcGroup, BirpcOptions, ChannelOptions } from 'birpc'
+import type { WebSocket } from 'ws'
 import { parse, stringify } from 'structured-clone-es'
 import { WebSocketServer } from 'ws'
+import { defineRpcServerPreset } from '..'
 
 export interface WebSocketRpcServerOptions {
   port: number
+  onConnected?: (ws: WebSocket) => void
+  onDisconnected?: (ws: WebSocket) => void
 }
 
-export function createWsRpcPreset(options: WebSocketRpcServerOptions) {
+function NOOP() {}
+
+export const createWsRpcPreset = defineRpcServerPreset((options: WebSocketRpcServerOptions) => {
   const {
     port,
+    onConnected = NOOP,
+    onDisconnected = NOOP,
   } = options
   const wss = new WebSocketServer({
     port,
@@ -44,7 +52,9 @@ export function createWsRpcPreset(options: WebSocketRpcServerOptions) {
           if (index >= 0)
             channels.splice(index, 1)
         })
+        onDisconnected(ws)
       })
+      onConnected(ws)
     })
   }
-}
+})

packages/devtools-rpc/src/server.ts

@@ -1,4 +1,4 @@
-import type { BirpcGroup, BirpcOptions } from 'birpc'
+import type { BirpcGroup, EventOptions } from 'birpc'
 import { createBirpcGroup } from 'birpc'
 
 export function createRpcServer<
@@ -8,7 +8,7 @@ export function createRpcServer<
   functions: ServerFunctions,
   options: {
     preset: (rpc: BirpcGroup<ClientFunctions, ServerFunctions>) => void
-    rpcOptions?: BirpcOptions<ClientFunctions>
+    rpcOptions?: EventOptions<ClientFunctions>
   },
 ) {
   const rpc = createBirpcGroup<ClientFunctions, ServerFunctions>(functions, [], options?.rpcOptions ?? {})

packages/devtools-rpc/tsdown.config.ts

@@ -1,9 +1,14 @@
 import { defineConfig } from 'tsdown'
 
-export default defineConfig({
+export default defineConfig([{
   entry: [
     'src/index.ts',
   ],
   clean: true,
   fixedExtension: true,
-})
+}, {
+  entry: ['src/presets/ws/client.ts', 'src/presets/ws/server.ts', 'src/presets/index.ts'],
+  clean: true,
+  fixedExtension: true,
+  outDir: 'dist/presets',
+}])

packages/devtools/package.json

@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "@rolldown/debug": "catalog:deps",
+    "@vitejs/devtools-rpc": "workspace:*",
     "ansis": "catalog:deps",
     "birpc": "catalog:deps",
     "cac": "catalog:deps",