feat(core): typings support for delegate events

koishijs · May 6, 2021 · 3dd372d · 3dd372d
1 parent 5b56651
commit 3dd372d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 15 deletions.
diff --git a/packages/koishi-core/src/context.ts b/packages/koishi-core/src/context.ts
@@ -67,16 +67,14 @@ interface Selector<T> extends PartialSeletor<T> {
   except?: PartialSeletor<T>
 }
 
+export interface Context extends Context.Delegates {}
+
 export class Context {
   static readonly middleware = Symbol('middleware')
   static readonly current = Symbol('source')
 
   protected _bots: Bot[] & Record<string, Bot>
 
-  public database: Database
-  public assets: Assets
-  public router: Router
-
   protected constructor(public filter: Filter, public app?: App, private _plugin: Plugin = null) {}
 
   [inspect.custom]() {
@@ -526,6 +524,14 @@ Context.delegate('database')
 Context.delegate('assets')
 Context.delegate('router')
 
+export namespace Context {
+  export interface Delegates {
+    database: Database
+    assets: Assets
+    router: Router
+  }
+}
+
 type FlattenEvents<T> = {
   [K in keyof T & string]: K | `${K}/${FlattenEvents<T[K]>}`
 }[keyof T & string]
@@ -538,17 +544,19 @@ type SessionEventMap = {
     : (session: Session.Payload<K>) => void
 }
 
+type DelegateEventMap = {
+  [K in keyof Context.Delegates as `delegate/${K}`]: () => void
+}
+
 type EventName = keyof EventMap
 type OmitSubstring<S extends string, T extends string> = S extends `${infer L}${T}${infer R}` ? `${L}${R}` : never
 type BeforeEventName = OmitSubstring<EventName & string, 'before-'>
 type BeforeEventMap = { [E in EventName & string as OmitSubstring<E, 'before-'>]: EventMap[E] }
 
-export interface EventMap extends SessionEventMap {
+export interface EventMap extends SessionEventMap, DelegateEventMap {
   [Context.middleware]: Middleware
 
   // Koishi events
-  'delegate/assets'(): void
-  'delegate/database'(): void
   'appellation'(name: string, session: Session): string
   'before-parse'(content: string, session: Session): Argv
   'parse'(argv: Argv, session: Session): string

diff --git a/packages/plugin-eval/src/index.ts b/packages/plugin-eval/src/index.ts
@@ -10,8 +10,10 @@ import { WorkerResponse } from './worker'
 export * from './main'
 
 declare module 'koishi-core' {
-  interface Context {
-    worker: EvalWorker
+  namespace Context {
+    interface Delegates {
+      worker: EvalWorker
+    }
   }
 
   namespace Command {

diff --git a/packages/plugin-puppeteer/src/index.ts b/packages/plugin-puppeteer/src/index.ts
@@ -35,8 +35,10 @@ declare module 'puppeteer-core/lib/types' {
 }
 
 declare module 'koishi-core' {
-  interface Context {
-    puppeteer: Puppeteer
+  namespace Context {
+    interface Delegates {
+      puppeteer: Puppeteer
+    }
   }
 
   namespace Plugin {

diff --git a/packages/plugin-webui/src/index.ts b/packages/plugin-webui/src/index.ts
@@ -14,8 +14,10 @@ export * from './server'
 export type Activity = Record<number, number>
 
 declare module 'koishi-core' {
-  interface Context {
-    webui: WebServer
+  namespace Context {
+    interface Delegates {
+      webui: WebServer
+    }
   }
 
   interface Database {
@@ -55,6 +57,8 @@ declare module 'koishi-core' {
   }
 }
 
+Context.delegate('webui')
+
 Channel.extend(() => ({
   activity: {},
 }))

diff --git a/packages/plugin-webui/src/server.ts b/packages/plugin-webui/src/server.ts
@@ -8,8 +8,6 @@ import WebSocket from 'ws'
 import type * as Vite from 'vite'
 import type PluginVue from '@vitejs/plugin-vue'
 
-Context.delegate('webui')
-
 interface BaseConfig {
   title?: string
   devMode?: boolean