refactor: better typing

Author: nekomeowww

packages/server-runtime/src/index.ts

@@ -24,7 +24,7 @@ router.get('/ws', defineWebSocketHandler({
 
     websocketLogger.withFields({ peer: peer.id, message: event }).log('received message')
     switch (event.type) {
-      case 'input:voice:discord:transcription':
+      case 'input:text:voice':
         websocketLogger.withFields({ message: event }).log('transcribed')
         break
     }

packages/server-sdk/package.json

@@ -38,6 +38,7 @@
   },
   "dependencies": {
     "@proj-airi/server-shared": "workspace:^",
-    "crossws": "^0.3.1"
+    "crossws": "^0.3.1",
+    "defu": "^6.1.4"
   }
 }

packages/server-sdk/src/client.ts

@@ -1,12 +1,28 @@
-import type { WebSocketEvent } from '@proj-airi/server-shared/types'
+import type { WebSocketEvent, WebSocketEvents } from '@proj-airi/server-shared/types'
 import type { Blob } from 'node:buffer'
 import WebSocket from 'crossws/websocket'
+import { defu } from 'defu'
+
+export interface ClientOptions {
+  url?: string
+  name: string
+  possibleEvents?: Array<(keyof WebSocketEvents)>
+}
 
 export class Client {
   private websocket: WebSocket
 
-  constructor(url: string) {
-    this.websocket = new WebSocket(url)
+  constructor(options: ClientOptions) {
+    const opts = defu<Required<ClientOptions>, Required<Omit<ClientOptions, 'name'>>[]>(options, { url: 'ws://localhost:6121/ws', possibleEvents: [] })
+
+    this.websocket = new WebSocket(opts.url)
+    this.send({
+      type: 'module:announce',
+      data: {
+        name: opts.name,
+        possibleEvents: opts.possibleEvents,
+      },
+    })
   }
 
   send(data: WebSocketEvent): void {

packages/server-shared/src/types/websocket/events.ts

@@ -1,22 +1,47 @@
+export interface DiscordGuildMember {
+  nickname: string
+  displayName: string
+  id: string
+}
+
+export interface Discord {
+  guildMember?: DiscordGuildMember
+  guildId?: string
+  channelId?: string
+}
+
+interface InputSource {
+  browser: string
+  discord: Discord
+}
+
 export interface WebSocketBaseEvent<T, D> {
   type: T
   data: D
 }
 
+export type WithInputSource<Source extends keyof InputSource> = {
+  [S in Source]: InputSource[S]
+}
+
 // Thanks to:
 //
 // A little hack for creating extensible discriminated unions : r/typescript
 // https://www.reddit.com/r/typescript/comments/1064ibt/a_little_hack_for_creating_extensible/
 export interface WebSocketEvents {
   'module:announce': {
     name: string
+    possibleEvents: Array<(keyof WebSocketEvents)>
   }
-  'input:voice:discord:transcription': {
+  'input:text': {
     text: string
-    username: string
-    userDisplayName: string
-    userId: string
-  }
+  } & Partial<WithInputSource<'browser' | 'discord'>>
+  'input:text:voice': {
+    transcription: string
+  } & Partial<WithInputSource<'browser' | 'discord'>>
+  'input:voice': {
+    audio: ArrayBuffer
+  } & Partial<WithInputSource<'browser' | 'discord'>>
 }
 
 export type WebSocketEvent = {

packages/stage-web/src/typed-router.d.ts

@@ -18,14 +18,5 @@ declare module 'vue-router/auto-routes' {
    * Route name map generated by unplugin-vue-router
    */
   export interface RouteNamedMap {
-    '/': RouteRecordInfo<'/', '/', Record<never, never>, Record<never, never>>,
-    '/[...all]': RouteRecordInfo<'/[...all]', '/:all(.*)', { all: ParamValue<true> }, { all: ParamValue<false> }>,
-    '/audio': RouteRecordInfo<'/audio', '/audio', Record<never, never>, Record<never, never>>,
-    '/devtools/image': RouteRecordInfo<'/devtools/image', '/devtools/image', Record<never, never>, Record<never, never>>,
-    '/queue': RouteRecordInfo<'/queue', '/queue', Record<never, never>, Record<never, never>>,
-    '/test/filter-message': RouteRecordInfo<'/test/filter-message', '/test/filter-message', Record<never, never>, Record<never, never>>,
-    '/test/queues/delays': RouteRecordInfo<'/test/queues/delays', '/test/queues/delays', Record<never, never>, Record<never, never>>,
-    '/test/queues/emotions': RouteRecordInfo<'/test/queues/emotions', '/test/queues/emotions', Record<never, never>, Record<never, never>>,
-    '/test/queues/messages': RouteRecordInfo<'/test/queues/messages', '/test/queues/messages', Record<never, never>, Record<never, never>>,
   }
 }

pnpm-lock.yaml

@@ -42,7 +42,6 @@
     "@xsai/generate-text": "catalog:",
     "@xsai/providers": "catalog:",
     "@xsai/shared-chat": "catalog:",
-    "crossws": "^0.3.1",
     "discord.js": "^14.17.3",
     "libsodium-wrappers": "^0.7.15",
     "opusscript": "^0.1.1",

services/discord-voice-bot/package.json

@@ -122,11 +122,17 @@ export async function handleSummon(log: ReturnType<typeof useLogg>, interaction:
         const speakingUser = await interaction.guild.members.fetch(userId)
         const result = await transcribeTextFromAudioReceiveStream(listenStream)
 
-        airiClient.send({ type: 'input:voice:discord:transcription', data: {
-          text: result,
-          userDisplayName: speakingUser.displayName,
-          userId,
-          username: speakingUser.nickname,
+        airiClient.send({ type: 'input:text:voice', data: {
+          transcription: result,
+          discord: {
+            guildId: interaction.guild.id,
+            channelId: currVoiceChannel.id,
+            guildMember: {
+              id: userId,
+              nickname: speakingUser.nickname,
+              displayName: speakingUser.displayName,
+            },
+          },
         } })
       }
       catch (err) {

services/discord-voice-bot/src/bots/discord/commands/summon.ts

@@ -17,9 +17,7 @@ async function main() {
   await WhisperLargeV3Pipeline.getInstance()
 
   const client = new Client({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildVoiceStates] })
-  const airiClient = new AiriClient('ws://localhost:6121/ws')
-
-  airiClient.send({ type: 'module:announce', data: { name: 'input:voice:discord' } })
+  const airiClient = new AiriClient({ name: 'discord-voice-bot', possibleEvents: ['input:text', 'input:text:voice', 'input:voice'] })
 
   // When the client is ready, run this code (only once).
   // The distinction between `client: Client<boolean>` and `readyClient: Client<true>` is important for TypeScript developers.