CopilotKit/packages/angular/src/lib/tools.ts at main · githubali/CopilotKit · GitHub

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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
import { DestroyRef, Injector, Signal, Type, inject } from "@angular/core";
import { FrontendTool, FrontendToolHandlerContext } from "@copilotkit/core";
import type { StandardSchemaV1 } from "@copilotkit/shared";
import { CopilotKit } from "./copilotkit";

export type AngularToolCall<
  Args extends Record<string, unknown> = Record<string, unknown>,
> =
  | {
      args: Partial<Args>;
      status: "in-progress";
      result: undefined;
    }
  | {
      args: Args;
      status: "executing";
      result: undefined;
    }
  | {
      args: Args;
      status: "complete";
      result: string;
    };

export type HumanInTheLoopToolCall<
  Args extends Record<string, unknown> = Record<string, unknown>,
> =
  | {
      args: Partial<Args>;
      status: "in-progress";
      result: undefined;
      respond: (result: unknown) => void;
    }
  | {
      args: Args;
      status: "executing";
      result: undefined;
      respond: (result: unknown) => void;
    }
  | {
      args: Args;
      status: "complete";
      result: string;
      respond: (result: unknown) => void;
    };

export interface ToolRenderer<
  Args extends Record<string, unknown> = Record<string, unknown>,
> {
  toolCall: Signal<AngularToolCall<Args>>;
}

export interface HumanInTheLoopToolRenderer<
  Args extends Record<string, unknown> = Record<string, unknown>,
> {
  toolCall: Signal<HumanInTheLoopToolCall<Args>>;
}

export type ClientTool<
  Args extends Record<string, unknown> = Record<string, unknown>,
> = Omit<FrontendTool<Args>, "handler"> & {
  renderer?: Type<ToolRenderer<Args>>;
};

export interface RenderToolCallConfig<
  Args extends Record<string, unknown> = Record<string, unknown>,
> {
  name: string;
  args: StandardSchemaV1<any, Args>;
  component: Type<ToolRenderer<Args>>;
  agentId?: string;
}

export interface FrontendToolConfig<
  Args extends Record<string, unknown> = Record<string, unknown>,
> {
  name: string;
  description: string;
  parameters: StandardSchemaV1<any, Args>;
  component?: Type<ToolRenderer<Args>>;
  handler: (
    args: Args,
    context: FrontendToolHandlerContext,
  ) => Promise<unknown>;
  agentId?: string;
}

export interface HumanInTheLoopConfig<
  Args extends Record<string, unknown> = Record<string, unknown>,
> {
  name: string;
  description: string;
  parameters: StandardSchemaV1<any, Args>;
  component: Type<HumanInTheLoopToolRenderer<Args>>;
  agentId?: string;
}

export function registerRenderToolCall<
  Args extends Record<string, unknown> = Record<string, unknown>,
>(renderToolCall: RenderToolCallConfig<Args>): void {
  const copilotKit = inject(CopilotKit);
  const destroyRef = inject(DestroyRef);

  copilotKit.addRenderToolCall(renderToolCall);

  destroyRef.onDestroy(() => {
    copilotKit.removeTool(renderToolCall.name, renderToolCall.agentId);
  });
}

export function registerFrontendTool<
  Args extends Record<string, unknown> = Record<string, unknown>,
>(frontendTool: FrontendToolConfig<Args>): void {
  const injector = inject(Injector);
  const destroyRef = inject(DestroyRef);
  const copilotKit = inject(CopilotKit);

  copilotKit.addFrontendTool({
    ...(frontendTool as FrontendToolConfig),
    injector,
  });

  destroyRef.onDestroy(() => {
    copilotKit.removeTool(frontendTool.name, frontendTool.agentId);
  });
}

export function registerHumanInTheLoop<
  Args extends Record<string, unknown> = Record<string, unknown>,
>(humanInTheLoop: HumanInTheLoopConfig<Args>): void {
  const destroyRef = inject(DestroyRef);
  const copilotKit = inject(CopilotKit);

  copilotKit.addHumanInTheLoop(humanInTheLoop);

  destroyRef.onDestroy(() => {
    copilotKit.removeTool(humanInTheLoop.name, humanInTheLoop.agentId);
  });
}