feat(server-sdk,server-shared): improved context update, renamed from context message, added output event, source

Author: nekomeowww

packages/server-sdk/src/client.ts

@@ -1,4 +1,4 @@
-import type { WebSocketBaseEvent, WebSocketEvent, WebSocketEvents } from '@proj-airi/server-shared/types'
+import type { WebSocketBaseEvent, WebSocketEvent, WebSocketEventOptionalSource, WebSocketEvents, WebSocketEventSource } from '@proj-airi/server-shared/types'
 
 import WebSocket from 'crossws/websocket'
 
@@ -212,6 +212,7 @@ export class Client<C = undefined> {
       for (const listener of listeners) {
         executions.push(Promise.resolve(listener(data as any)))
       }
+
       await Promise.allSettled(executions)
     }
     catch (err) {
@@ -252,9 +253,9 @@ export class Client<C = undefined> {
     }
   }
 
-  send(data: WebSocketEvent<C>): void {
+  send(data: WebSocketEventOptionalSource<C>): void {
     if (this.websocket && this.connected) {
-      this.websocket.send(JSON.stringify(data))
+      this.websocket.send(JSON.stringify({ source: this.opts.name as WebSocketEventSource | string, ...data } as WebSocketEvent<C>))
     }
   }
 

packages/server-sdk/src/index.ts

@@ -1,2 +1,3 @@
 export * from './client'
 export type * from '@proj-airi/server-shared/types'
+export { ContextUpdateStrategy, WebSocketEventSource } from '@proj-airi/server-shared/types'

packages/server-shared/package.json

@@ -31,5 +31,9 @@
     "dev": "pnpm run build",
     "build": "tsdown",
     "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@xsai/shared": "catalog:",
+    "@xsai/shared-chat": "catalog:"
   }
 }

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

@@ -1,3 +1,5 @@
+import type { AssistantMessage, ToolMessage } from '@xsai/shared-chat'
+
 export interface DiscordGuildMember {
   nickname: string
   displayName: string
@@ -10,48 +12,66 @@ export interface Discord {
   channelId?: string
 }
 
+export enum WebSocketEventSource {
+  Server = 'proj-airi:server-runtime',
+  StageWeb = 'proj-airi:stage-web',
+  StageTamagotchi = 'proj-airi:stage-tamagotchi',
+}
+
 interface InputSource {
-  browser: string
-  discord: Discord
+  'stage-web': string
+  'stage-tamagotchi': string
+  'discord': Discord
+}
+
+interface OutputSource {
+  'gen-ai-model-chat': string
+}
+
+export enum ContextUpdateStrategy {
+  ReplaceSelf = 'replace-self',
+  AppendSelf = 'append-self',
+}
+
+export interface ContextUpdateDestinationAll {
+  all: true
+}
+
+export interface ContextUpdateDestinationList {
+  include?: Array<string>
+  exclude?: Array<string>
 }
 
-export type ContextSource
-  = | 'text'
-    | 'stt'
-    | 'vision'
-    | 'llm'
-    | 'server-channel'
-    | 'plugin'
-    | 'system'
-
-export interface ContextMessage<Payload = unknown, Meta = Record<string, unknown>> {
-  /**
-   * Session identifier so UIs can group conversations from multiple windows/devices.
-   */
-  sessionId: string
-  /**
-   * Unix timestamp in milliseconds.
-   */
-  ts: number
-  role: 'user' | 'assistant' | 'system' | 'error' | 'tool'
-  source: ContextSource
-  /**
-   * The actual payload being carried. Keep this generic so different inputs (text, stt, vision)
-   * can share the same envelope.
-   */
-  payload: Payload
-  meta?: Meta
+export type ContextUpdateDestinationFilter
+  = | ContextUpdateDestinationAll
+    | ContextUpdateDestinationList
+
+export interface ContextUpdate<
+  Metadata extends Record<string, any> = Record<string, unknown>,
+  // eslint-disable-next-line ts/no-unnecessary-type-constraint
+  Content extends any = undefined,
+> {
+  strategy: ContextUpdateStrategy
+  text: string
+  content?: Content
+  destinations?: Array<string> | ContextUpdateDestinationFilter
+  metadata?: Metadata
 }
 
-export interface WebSocketBaseEvent<T, D> {
+export interface WebSocketBaseEvent<T, D, S extends string = string> {
   type: T
   data: D
+  source: WebSocketEventSource | S
 }
 
 export type WithInputSource<Source extends keyof InputSource> = {
   [S in Source]: InputSource[S]
 }
 
+export type WithOutputSource<Source extends keyof OutputSource> = {
+  [S in Source]: OutputSource[S]
+}
+
 // Thanks to:
 //
 // A little hack for creating extensible discriminated unions : r/typescript
@@ -80,17 +100,23 @@ export interface WebSocketEvents<C = undefined> {
   }
   'input:text': {
     text: string
-  } & Partial<WithInputSource<'browser' | 'discord'>>
+  } & Partial<WithInputSource<'stage-web' | 'stage-tamagotchi' | 'discord'>>
   'input:text:voice': {
     transcription: string
-  } & Partial<WithInputSource<'browser' | 'discord'>>
+  } & Partial<WithInputSource<'stage-web' | 'stage-tamagotchi' | 'discord'>>
   'input:voice': {
     audio: ArrayBuffer
-  } & Partial<WithInputSource<'browser' | 'discord'>>
-  'vscode:context': C
-  'context:update': ContextMessage
+  } & Partial<WithInputSource<'stage-web' | 'stage-tamagotchi' | 'discord'>>
+  'output:gen-ai:chat:message': {
+    messages: Array<AssistantMessage | ToolMessage>
+  } & Partial<WithInputSource<'stage-web' | 'stage-tamagotchi' | 'discord'>> & Partial<WithOutputSource<'gen-ai-model-chat'>>
+  'context:update': ContextUpdate
 }
 
 export type WebSocketEvent<C = undefined> = {
   [K in keyof WebSocketEvents<C>]: WebSocketBaseEvent<K, WebSocketEvents<C>[K]>;
 }[keyof WebSocketEvents<C>]
+
+export type WebSocketEventOptionalSource<C = undefined> = {
+  [K in keyof WebSocketEvents<C>]: Omit<WebSocketBaseEvent<K, WebSocketEvents<C>[K]>, 'source'> & Partial<Pick<WebSocketBaseEvent<K, WebSocketEvents<C>[K]>, 'source'>>;
+}[keyof WebSocketEvents<C>]