summaryrefslogtreecommitdiffhomepage
path: root/packages/plugin/src/index.ts
blob: 9040fb5173ec163fa857657b69eb55defff62c1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
import type { Event, createOpencodeClient, App, Model, Provider, Permission, UserMessage, Part } from "@opencode-ai/sdk"
import { $ } from "bun"

export type PluginInput = {
  client: ReturnType<typeof createOpencodeClient>
  app: App
  $: $
}
export type Plugin = (input: PluginInput) => Promise<Hooks>

export interface Hooks {
  event?: (input: { event: Event }) => Promise<void>
  chat?: {
    /**
     * Called when a new message is received
     */
    message?: (input: {}, output: { message: UserMessage; parts: Part[] }) => Promise<void>
    /**
     * Modify parameters sent to LLM
     */
    params?: (
      input: { model: Model; provider: Provider; message: UserMessage },
      output: { temperature: number; topP: number },
    ) => Promise<void>
  }
  permission?: {
    /**
     * Called when a permission is asked
     */
    ask?: (input: Permission, output: { status: "ask" | "deny" | "allow" }) => Promise<void>
  }
  tool?: {
    execute?: {
      /**
       * Called before a tool is executed
       */
      before?: (
        input: { tool: string; sessionID: string; callID: string },
        output: {
          args: any
        },
      ) => Promise<void>
      /**
       * Called after a tool is executed
       */
      after?: (
        input: { tool: string; sessionID: string; callID: string },
        output: {
          title: string
          output: string
          metadata: any
        },
      ) => Promise<void>
    }
  }
}