agents 0.0.0-fb4d0a6 → 0.0.0-fb62d22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +257 -33
- package/dist/_esm-LV5FJ3HK.js +3922 -0
- package/dist/_esm-LV5FJ3HK.js.map +1 -0
- package/dist/ai-chat-agent.d.ts +56 -6
- package/dist/ai-chat-agent.js +580 -98
- package/dist/ai-chat-agent.js.map +1 -1
- package/dist/ai-chat-v5-migration.d.ts +152 -0
- package/dist/ai-chat-v5-migration.js +20 -0
- package/dist/ai-react.d.ts +77 -65
- package/dist/ai-react.js +287 -120
- package/dist/ai-react.js.map +1 -1
- package/dist/ai-types.d.ts +41 -18
- package/dist/ai-types.js +7 -0
- package/dist/ccip-CMBYN64O.js +15 -0
- package/dist/ccip-CMBYN64O.js.map +1 -0
- package/dist/chunk-5Y6BEZDY.js +276 -0
- package/dist/chunk-5Y6BEZDY.js.map +1 -0
- package/dist/chunk-BER7KXUJ.js +18 -0
- package/dist/chunk-BER7KXUJ.js.map +1 -0
- package/dist/chunk-JJBFIGUC.js +5202 -0
- package/dist/chunk-JJBFIGUC.js.map +1 -0
- package/dist/chunk-PR4QN5HX.js +43 -0
- package/dist/chunk-PR4QN5HX.js.map +1 -0
- package/dist/chunk-QEPGNUG6.js +650 -0
- package/dist/chunk-QEPGNUG6.js.map +1 -0
- package/dist/chunk-QEVM4BVL.js +116 -0
- package/dist/chunk-QEVM4BVL.js.map +1 -0
- package/dist/chunk-RS5OCNEQ.js +1323 -0
- package/dist/chunk-RS5OCNEQ.js.map +1 -0
- package/dist/chunk-TYAY6AU6.js +159 -0
- package/dist/chunk-TYAY6AU6.js.map +1 -0
- package/dist/chunk-UJVEAURM.js +150 -0
- package/dist/chunk-UJVEAURM.js.map +1 -0
- package/dist/chunk-XFS5ERG3.js +127 -0
- package/dist/chunk-XFS5ERG3.js.map +1 -0
- package/dist/client-DNEb-lf3.d.ts +5041 -0
- package/dist/client.d.ts +16 -2
- package/dist/client.js +8 -133
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +291 -22
- package/dist/index.js +16 -4
- package/dist/mcp/client.d.ts +11 -0
- package/dist/mcp/client.js +10 -0
- package/dist/mcp/client.js.map +1 -0
- package/dist/mcp/do-oauth-client-provider.d.ts +50 -0
- package/dist/mcp/do-oauth-client-provider.js +8 -0
- package/dist/mcp/do-oauth-client-provider.js.map +1 -0
- package/dist/mcp/index.d.ts +78 -0
- package/dist/mcp/index.js +1099 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/x402.d.ts +39 -0
- package/dist/mcp/x402.js +3195 -0
- package/dist/mcp/x402.js.map +1 -0
- package/dist/observability/index.d.ts +46 -0
- package/dist/observability/index.js +12 -0
- package/dist/observability/index.js.map +1 -0
- package/dist/react.d.ts +89 -5
- package/dist/react.js +54 -32
- package/dist/react.js.map +1 -1
- package/dist/schedule.d.ts +81 -7
- package/dist/schedule.js +20 -7
- package/dist/schedule.js.map +1 -1
- package/dist/secp256k1-M22GZP2U.js +2193 -0
- package/dist/secp256k1-M22GZP2U.js.map +1 -0
- package/dist/serializable.d.ts +32 -0
- package/dist/serializable.js +1 -0
- package/dist/serializable.js.map +1 -0
- package/package.json +100 -43
- package/src/index.ts +1283 -184
- package/dist/chunk-HMLY7DHA.js +0 -16
- package/dist/chunk-X6BBKLSC.js +0 -568
- package/dist/chunk-X6BBKLSC.js.map +0 -1
- /package/dist/{chunk-HMLY7DHA.js.map → ai-chat-v5-migration.js.map} +0 -0
package/dist/client.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
PartySocketOptions,
|
|
3
3
|
PartyFetchOptions,
|
|
4
|
-
PartySocket
|
|
4
|
+
PartySocket
|
|
5
5
|
} from "partysocket";
|
|
6
|
+
import { SerializableReturnValue, SerializableValue } from "./serializable.js";
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* Options for creating an AgentClient
|
|
@@ -38,17 +39,24 @@ type AgentClientFetchOptions = Omit<PartyFetchOptions, "party" | "room"> & {
|
|
|
38
39
|
/** Name of the specific Agent instance */
|
|
39
40
|
name?: string;
|
|
40
41
|
};
|
|
42
|
+
/**
|
|
43
|
+
* Convert a camelCase string to a kebab-case string
|
|
44
|
+
* @param str The string to convert
|
|
45
|
+
* @returns The kebab-case string
|
|
46
|
+
*/
|
|
47
|
+
declare function camelCaseToKebabCase(str: string): string;
|
|
41
48
|
/**
|
|
42
49
|
* WebSocket client for connecting to an Agent
|
|
43
50
|
*/
|
|
44
51
|
declare class AgentClient<State = unknown> extends PartySocket {
|
|
45
|
-
#private;
|
|
46
52
|
/**
|
|
47
53
|
* @deprecated Use agentFetch instead
|
|
48
54
|
*/
|
|
49
55
|
static fetch(_opts: PartyFetchOptions): Promise<Response>;
|
|
50
56
|
agent: string;
|
|
51
57
|
name: string;
|
|
58
|
+
private options;
|
|
59
|
+
private _pendingCalls;
|
|
52
60
|
constructor(options: AgentClientOptions<State>);
|
|
53
61
|
setState(state: State): void;
|
|
54
62
|
/**
|
|
@@ -58,6 +66,11 @@ declare class AgentClient<State = unknown> extends PartySocket {
|
|
|
58
66
|
* @param streamOptions Options for handling streaming responses
|
|
59
67
|
* @returns Promise that resolves with the method's return value
|
|
60
68
|
*/
|
|
69
|
+
call<T extends SerializableReturnValue>(
|
|
70
|
+
method: string,
|
|
71
|
+
args?: SerializableValue[],
|
|
72
|
+
streamOptions?: StreamOptions
|
|
73
|
+
): Promise<T>;
|
|
61
74
|
call<T = unknown>(
|
|
62
75
|
method: string,
|
|
63
76
|
args?: unknown[],
|
|
@@ -81,4 +94,5 @@ export {
|
|
|
81
94
|
type AgentClientOptions,
|
|
82
95
|
type StreamOptions,
|
|
83
96
|
agentFetch,
|
|
97
|
+
camelCaseToKebabCase
|
|
84
98
|
};
|
package/dist/client.js
CHANGED
|
@@ -1,138 +1,13 @@
|
|
|
1
1
|
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
} from "./chunk-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import {
|
|
9
|
-
PartySocket
|
|
10
|
-
} from "partysocket";
|
|
11
|
-
var _options, _pendingCalls;
|
|
12
|
-
var AgentClient = class extends PartySocket {
|
|
13
|
-
constructor(options) {
|
|
14
|
-
super({
|
|
15
|
-
prefix: "agents",
|
|
16
|
-
party: options.agent,
|
|
17
|
-
room: options.name || "default",
|
|
18
|
-
...options
|
|
19
|
-
});
|
|
20
|
-
__privateAdd(this, _options);
|
|
21
|
-
__privateAdd(this, _pendingCalls, /* @__PURE__ */ new Map());
|
|
22
|
-
this.agent = options.agent;
|
|
23
|
-
this.name = options.name || "default";
|
|
24
|
-
__privateSet(this, _options, options);
|
|
25
|
-
if (this.agent !== this.agent.toLowerCase()) {
|
|
26
|
-
console.warn(
|
|
27
|
-
`Agent name: ${this.agent} should probably be in lowercase. Received: ${this.agent}`
|
|
28
|
-
);
|
|
29
|
-
}
|
|
30
|
-
if (this.name !== this.name.toLowerCase()) {
|
|
31
|
-
console.warn(
|
|
32
|
-
`Agent instance name: ${this.name} should probably be in lowercase. Received: ${this.name}`
|
|
33
|
-
);
|
|
34
|
-
}
|
|
35
|
-
this.addEventListener("message", (event) => {
|
|
36
|
-
if (typeof event.data === "string") {
|
|
37
|
-
let parsedMessage;
|
|
38
|
-
try {
|
|
39
|
-
parsedMessage = JSON.parse(event.data);
|
|
40
|
-
} catch (error) {
|
|
41
|
-
return;
|
|
42
|
-
}
|
|
43
|
-
if (parsedMessage.type === "cf_agent_state") {
|
|
44
|
-
__privateGet(this, _options).onStateUpdate?.(parsedMessage.state, "server");
|
|
45
|
-
return;
|
|
46
|
-
}
|
|
47
|
-
if (parsedMessage.type === "rpc") {
|
|
48
|
-
const response = parsedMessage;
|
|
49
|
-
const pending = __privateGet(this, _pendingCalls).get(response.id);
|
|
50
|
-
if (!pending) return;
|
|
51
|
-
if (!response.success) {
|
|
52
|
-
pending.reject(new Error(response.error));
|
|
53
|
-
__privateGet(this, _pendingCalls).delete(response.id);
|
|
54
|
-
pending.stream?.onError?.(response.error);
|
|
55
|
-
return;
|
|
56
|
-
}
|
|
57
|
-
if ("done" in response) {
|
|
58
|
-
if (response.done) {
|
|
59
|
-
pending.resolve(response.result);
|
|
60
|
-
__privateGet(this, _pendingCalls).delete(response.id);
|
|
61
|
-
pending.stream?.onDone?.(response.result);
|
|
62
|
-
} else {
|
|
63
|
-
pending.stream?.onChunk?.(response.result);
|
|
64
|
-
}
|
|
65
|
-
} else {
|
|
66
|
-
pending.resolve(response.result);
|
|
67
|
-
__privateGet(this, _pendingCalls).delete(response.id);
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* @deprecated Use agentFetch instead
|
|
75
|
-
*/
|
|
76
|
-
static fetch(_opts) {
|
|
77
|
-
throw new Error(
|
|
78
|
-
"AgentClient.fetch is not implemented, use agentFetch instead"
|
|
79
|
-
);
|
|
80
|
-
}
|
|
81
|
-
setState(state) {
|
|
82
|
-
this.send(JSON.stringify({ type: "cf_agent_state", state }));
|
|
83
|
-
__privateGet(this, _options).onStateUpdate?.(state, "client");
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Call a method on the Agent
|
|
87
|
-
* @param method Name of the method to call
|
|
88
|
-
* @param args Arguments to pass to the method
|
|
89
|
-
* @param streamOptions Options for handling streaming responses
|
|
90
|
-
* @returns Promise that resolves with the method's return value
|
|
91
|
-
*/
|
|
92
|
-
async call(method, args = [], streamOptions) {
|
|
93
|
-
return new Promise((resolve, reject) => {
|
|
94
|
-
const id = Math.random().toString(36).slice(2);
|
|
95
|
-
__privateGet(this, _pendingCalls).set(id, {
|
|
96
|
-
resolve: (value) => resolve(value),
|
|
97
|
-
reject,
|
|
98
|
-
stream: streamOptions,
|
|
99
|
-
type: null
|
|
100
|
-
});
|
|
101
|
-
const request = {
|
|
102
|
-
type: "rpc",
|
|
103
|
-
id,
|
|
104
|
-
method,
|
|
105
|
-
args
|
|
106
|
-
};
|
|
107
|
-
this.send(JSON.stringify(request));
|
|
108
|
-
});
|
|
109
|
-
}
|
|
110
|
-
};
|
|
111
|
-
_options = new WeakMap();
|
|
112
|
-
_pendingCalls = new WeakMap();
|
|
113
|
-
function agentFetch(opts, init) {
|
|
114
|
-
if (opts.agent !== opts.agent.toLowerCase()) {
|
|
115
|
-
console.warn(
|
|
116
|
-
`Agent name: ${opts.agent} should probably be in lowercase. Received: ${opts.agent}`
|
|
117
|
-
);
|
|
118
|
-
}
|
|
119
|
-
if (opts.name && opts.name !== opts.name.toLowerCase()) {
|
|
120
|
-
console.warn(
|
|
121
|
-
`Agent instance name: ${opts.name} should probably be in lowercase. Received: ${opts.name}`
|
|
122
|
-
);
|
|
123
|
-
}
|
|
124
|
-
return PartySocket.fetch(
|
|
125
|
-
{
|
|
126
|
-
prefix: "agents",
|
|
127
|
-
party: opts.agent,
|
|
128
|
-
room: opts.name || "default",
|
|
129
|
-
...opts
|
|
130
|
-
},
|
|
131
|
-
init
|
|
132
|
-
);
|
|
133
|
-
}
|
|
2
|
+
AgentClient,
|
|
3
|
+
agentFetch,
|
|
4
|
+
camelCaseToKebabCase
|
|
5
|
+
} from "./chunk-QEVM4BVL.js";
|
|
6
|
+
import "./chunk-BER7KXUJ.js";
|
|
7
|
+
import "./chunk-PR4QN5HX.js";
|
|
134
8
|
export {
|
|
135
9
|
AgentClient,
|
|
136
|
-
agentFetch
|
|
10
|
+
agentFetch,
|
|
11
|
+
camelCaseToKebabCase
|
|
137
12
|
};
|
|
138
13
|
//# sourceMappingURL=client.js.map
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,27 @@
|
|
|
1
|
+
import { env } from "cloudflare:workers";
|
|
2
|
+
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
|
3
|
+
import {
|
|
4
|
+
ServerCapabilities,
|
|
5
|
+
Tool,
|
|
6
|
+
Prompt,
|
|
7
|
+
Resource
|
|
8
|
+
} from "@modelcontextprotocol/sdk/types.js";
|
|
1
9
|
import { Server, Connection, PartyServerOptions } from "partyserver";
|
|
2
10
|
export { Connection, ConnectionContext, WSMessage } from "partyserver";
|
|
3
|
-
import {
|
|
11
|
+
import {
|
|
12
|
+
c as MCPClientManager,
|
|
13
|
+
T as TransportType
|
|
14
|
+
} from "./client-DNEb-lf3.js";
|
|
15
|
+
import { Observability } from "./observability/index.js";
|
|
16
|
+
import { MessageType } from "./ai-types.js";
|
|
17
|
+
import "zod";
|
|
18
|
+
import "@modelcontextprotocol/sdk/shared/protocol.js";
|
|
19
|
+
import "ai";
|
|
20
|
+
import "@modelcontextprotocol/sdk/client/sse.js";
|
|
21
|
+
import "@modelcontextprotocol/sdk/client/streamableHttp.js";
|
|
22
|
+
import "./mcp/do-oauth-client-provider.js";
|
|
23
|
+
import "@modelcontextprotocol/sdk/client/auth.js";
|
|
24
|
+
import "@modelcontextprotocol/sdk/shared/auth.js";
|
|
4
25
|
|
|
5
26
|
/**
|
|
6
27
|
* RPC request message from client
|
|
@@ -15,14 +36,14 @@ type RPCRequest = {
|
|
|
15
36
|
* State update message from client
|
|
16
37
|
*/
|
|
17
38
|
type StateUpdateMessage = {
|
|
18
|
-
type:
|
|
39
|
+
type: MessageType.CF_AGENT_STATE;
|
|
19
40
|
state: unknown;
|
|
20
41
|
};
|
|
21
42
|
/**
|
|
22
43
|
* RPC response message to client
|
|
23
44
|
*/
|
|
24
45
|
type RPCResponse = {
|
|
25
|
-
type:
|
|
46
|
+
type: MessageType.RPC;
|
|
26
47
|
id: string;
|
|
27
48
|
} & (
|
|
28
49
|
| {
|
|
@@ -53,16 +74,24 @@ type CallableMetadata = {
|
|
|
53
74
|
* Decorator that marks a method as callable by clients
|
|
54
75
|
* @param metadata Optional metadata about the callable method
|
|
55
76
|
*/
|
|
56
|
-
declare function
|
|
77
|
+
declare function callable(
|
|
57
78
|
metadata?: CallableMetadata
|
|
58
79
|
): <This, Args extends unknown[], Return>(
|
|
59
80
|
target: (this: This, ...args: Args) => Return,
|
|
60
81
|
context: ClassMethodDecoratorContext
|
|
61
82
|
) => (this: This, ...args: Args) => Return;
|
|
62
83
|
/**
|
|
63
|
-
*
|
|
84
|
+
* Decorator that marks a method as callable by clients
|
|
85
|
+
* @deprecated this has been renamed to callable, and unstable_callable will be removed in the next major version
|
|
86
|
+
* @param metadata Optional metadata about the callable method
|
|
64
87
|
*/
|
|
65
|
-
declare
|
|
88
|
+
declare const unstable_callable: (metadata?: CallableMetadata) => void;
|
|
89
|
+
type QueueItem<T = string> = {
|
|
90
|
+
id: string;
|
|
91
|
+
payload: T;
|
|
92
|
+
callback: keyof Agent<unknown>;
|
|
93
|
+
created_at: number;
|
|
94
|
+
};
|
|
66
95
|
/**
|
|
67
96
|
* Represents a scheduled task within an Agent
|
|
68
97
|
* @template T Type of the payload data
|
|
@@ -98,13 +127,51 @@ type Schedule<T = string> = {
|
|
|
98
127
|
cron: string;
|
|
99
128
|
}
|
|
100
129
|
);
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* MCP Server state update message from server -> Client
|
|
133
|
+
*/
|
|
134
|
+
type MCPServerMessage = {
|
|
135
|
+
type: MessageType.CF_AGENT_MCP_SERVERS;
|
|
136
|
+
mcp: MCPServersState;
|
|
137
|
+
};
|
|
138
|
+
type MCPServersState = {
|
|
139
|
+
servers: {
|
|
140
|
+
[id: string]: MCPServer;
|
|
141
|
+
};
|
|
142
|
+
tools: Tool[];
|
|
143
|
+
prompts: Prompt[];
|
|
144
|
+
resources: Resource[];
|
|
145
|
+
};
|
|
146
|
+
type MCPServer = {
|
|
147
|
+
name: string;
|
|
148
|
+
server_url: string;
|
|
149
|
+
auth_url: string | null;
|
|
150
|
+
state: "authenticating" | "connecting" | "ready" | "discovering" | "failed";
|
|
151
|
+
instructions: string | null;
|
|
152
|
+
capabilities: ServerCapabilities | null;
|
|
153
|
+
};
|
|
154
|
+
declare function getCurrentAgent<
|
|
155
|
+
T extends Agent<unknown, unknown> = Agent<unknown, unknown>
|
|
156
|
+
>(): {
|
|
157
|
+
agent: T | undefined;
|
|
158
|
+
connection: Connection | undefined;
|
|
159
|
+
request: Request | undefined;
|
|
160
|
+
email: AgentEmail | undefined;
|
|
161
|
+
};
|
|
101
162
|
/**
|
|
102
163
|
* Base class for creating Agent implementations
|
|
103
164
|
* @template Env Environment type containing bindings
|
|
104
165
|
* @template State State type to store within the Agent
|
|
105
166
|
*/
|
|
106
|
-
declare class Agent<
|
|
107
|
-
|
|
167
|
+
declare class Agent<
|
|
168
|
+
Env = typeof env,
|
|
169
|
+
State = unknown,
|
|
170
|
+
Props extends Record<string, unknown> = Record<string, unknown>
|
|
171
|
+
> extends Server<Env, Props> {
|
|
172
|
+
private _state;
|
|
173
|
+
private _ParentClass;
|
|
174
|
+
readonly mcp: MCPClientManager;
|
|
108
175
|
/**
|
|
109
176
|
* Initial state for the Agent
|
|
110
177
|
* Override to provide default state values
|
|
@@ -121,6 +188,10 @@ declare class Agent<Env, State = unknown> extends Server<Env> {
|
|
|
121
188
|
/** Whether the Agent should hibernate when inactive */
|
|
122
189
|
hibernate: boolean;
|
|
123
190
|
};
|
|
191
|
+
/**
|
|
192
|
+
* The observability implementation to use for the Agent
|
|
193
|
+
*/
|
|
194
|
+
observability?: Observability;
|
|
124
195
|
/**
|
|
125
196
|
* Execute SQL queries against the Agent's database
|
|
126
197
|
* @template T Type of the returned rows
|
|
@@ -133,6 +204,7 @@ declare class Agent<Env, State = unknown> extends Server<Env> {
|
|
|
133
204
|
...values: (string | number | boolean | null)[]
|
|
134
205
|
): T[];
|
|
135
206
|
constructor(ctx: AgentContext, env: Env);
|
|
207
|
+
private _setStateInternal;
|
|
136
208
|
/**
|
|
137
209
|
* Update the Agent's state
|
|
138
210
|
* @param state New state to set
|
|
@@ -145,16 +217,75 @@ declare class Agent<Env, State = unknown> extends Server<Env> {
|
|
|
145
217
|
*/
|
|
146
218
|
onStateUpdate(state: State | undefined, source: Connection | "server"): void;
|
|
147
219
|
/**
|
|
148
|
-
* Called when the Agent receives an email
|
|
220
|
+
* Called when the Agent receives an email via routeAgentEmail()
|
|
221
|
+
* Override this method to handle incoming emails
|
|
149
222
|
* @param email Email message to process
|
|
150
223
|
*/
|
|
151
|
-
|
|
224
|
+
_onEmail(email: AgentEmail): Promise<void>;
|
|
225
|
+
/**
|
|
226
|
+
* Reply to an email
|
|
227
|
+
* @param email The email to reply to
|
|
228
|
+
* @param options Options for the reply
|
|
229
|
+
* @returns void
|
|
230
|
+
*/
|
|
231
|
+
replyToEmail(
|
|
232
|
+
email: AgentEmail,
|
|
233
|
+
options: {
|
|
234
|
+
fromName: string;
|
|
235
|
+
subject?: string | undefined;
|
|
236
|
+
body: string;
|
|
237
|
+
contentType?: string;
|
|
238
|
+
headers?: Record<string, string>;
|
|
239
|
+
}
|
|
240
|
+
): Promise<void>;
|
|
241
|
+
private _tryCatch;
|
|
242
|
+
/**
|
|
243
|
+
* Automatically wrap custom methods with agent context
|
|
244
|
+
* This ensures getCurrentAgent() works in all custom methods without decorators
|
|
245
|
+
*/
|
|
246
|
+
private _autoWrapCustomMethods;
|
|
152
247
|
onError(connection: Connection, error: unknown): void | Promise<void>;
|
|
153
248
|
onError(error: unknown): void | Promise<void>;
|
|
154
249
|
/**
|
|
155
250
|
* Render content (not implemented in base class)
|
|
156
251
|
*/
|
|
157
252
|
render(): void;
|
|
253
|
+
/**
|
|
254
|
+
* Queue a task to be executed in the future
|
|
255
|
+
* @param payload Payload to pass to the callback
|
|
256
|
+
* @param callback Name of the method to call
|
|
257
|
+
* @returns The ID of the queued task
|
|
258
|
+
*/
|
|
259
|
+
queue<T = unknown>(callback: keyof this, payload: T): Promise<string>;
|
|
260
|
+
private _flushingQueue;
|
|
261
|
+
private _flushQueue;
|
|
262
|
+
/**
|
|
263
|
+
* Dequeue a task by ID
|
|
264
|
+
* @param id ID of the task to dequeue
|
|
265
|
+
*/
|
|
266
|
+
dequeue(id: string): Promise<void>;
|
|
267
|
+
/**
|
|
268
|
+
* Dequeue all tasks
|
|
269
|
+
*/
|
|
270
|
+
dequeueAll(): Promise<void>;
|
|
271
|
+
/**
|
|
272
|
+
* Dequeue all tasks by callback
|
|
273
|
+
* @param callback Name of the callback to dequeue
|
|
274
|
+
*/
|
|
275
|
+
dequeueAllByCallback(callback: string): Promise<void>;
|
|
276
|
+
/**
|
|
277
|
+
* Get a queued task by ID
|
|
278
|
+
* @param id ID of the task to get
|
|
279
|
+
* @returns The task or undefined if not found
|
|
280
|
+
*/
|
|
281
|
+
getQueue(id: string): Promise<QueueItem<string> | undefined>;
|
|
282
|
+
/**
|
|
283
|
+
* Get all queues by key and value
|
|
284
|
+
* @param key Key to filter by
|
|
285
|
+
* @param value Value to filter by
|
|
286
|
+
* @returns Array of matching QueueItem objects
|
|
287
|
+
*/
|
|
288
|
+
getQueues(key: string, value: string): Promise<QueueItem<string>[]>;
|
|
158
289
|
/**
|
|
159
290
|
* Schedule a task to be executed in the future
|
|
160
291
|
* @template T Type of the payload data
|
|
@@ -182,7 +313,6 @@ declare class Agent<Env, State = unknown> extends Server<Env> {
|
|
|
182
313
|
* @returns Array of matching Schedule objects
|
|
183
314
|
*/
|
|
184
315
|
getSchedules<T = string>(criteria?: {
|
|
185
|
-
description?: string;
|
|
186
316
|
id?: string;
|
|
187
317
|
type?: "scheduled" | "delayed" | "cron";
|
|
188
318
|
timeRange?: {
|
|
@@ -196,15 +326,79 @@ declare class Agent<Env, State = unknown> extends Server<Env> {
|
|
|
196
326
|
* @returns true if the task was cancelled, false otherwise
|
|
197
327
|
*/
|
|
198
328
|
cancelSchedule(id: string): Promise<boolean>;
|
|
329
|
+
private _scheduleNextAlarm;
|
|
199
330
|
/**
|
|
200
|
-
* Method called when an alarm fires
|
|
201
|
-
* Executes any scheduled tasks that are due
|
|
331
|
+
* Method called when an alarm fires.
|
|
332
|
+
* Executes any scheduled tasks that are due.
|
|
333
|
+
*
|
|
334
|
+
* @remarks
|
|
335
|
+
* To schedule a task, please use the `this.schedule` method instead.
|
|
336
|
+
* See {@link https://developers.cloudflare.com/agents/api-reference/schedule-tasks/}
|
|
202
337
|
*/
|
|
203
|
-
alarm()
|
|
338
|
+
readonly alarm: () => Promise<void>;
|
|
204
339
|
/**
|
|
205
340
|
* Destroy the Agent, removing all state and scheduled tasks
|
|
206
341
|
*/
|
|
207
342
|
destroy(): Promise<void>;
|
|
343
|
+
/**
|
|
344
|
+
* Get all methods marked as callable on this Agent
|
|
345
|
+
* @returns A map of method names to their metadata
|
|
346
|
+
*/
|
|
347
|
+
private _isCallable;
|
|
348
|
+
/**
|
|
349
|
+
* Connect to a new MCP Server
|
|
350
|
+
*
|
|
351
|
+
* @param serverName Name of the MCP server
|
|
352
|
+
* @param url MCP Server SSE URL
|
|
353
|
+
* @param callbackHost Base host for the agent, used for the redirect URI. If not provided, will be derived from the current request.
|
|
354
|
+
* @param agentsPrefix agents routing prefix if not using `agents`
|
|
355
|
+
* @param options MCP client and transport (header) options
|
|
356
|
+
* @returns authUrl
|
|
357
|
+
*/
|
|
358
|
+
addMcpServer(
|
|
359
|
+
serverName: string,
|
|
360
|
+
url: string,
|
|
361
|
+
callbackHost?: string,
|
|
362
|
+
agentsPrefix?: string,
|
|
363
|
+
options?: {
|
|
364
|
+
client?: ConstructorParameters<typeof Client>[1];
|
|
365
|
+
transport?: {
|
|
366
|
+
headers: HeadersInit;
|
|
367
|
+
};
|
|
368
|
+
}
|
|
369
|
+
): Promise<{
|
|
370
|
+
id: string;
|
|
371
|
+
authUrl: string | undefined;
|
|
372
|
+
}>;
|
|
373
|
+
_connectToMcpServerInternal(
|
|
374
|
+
_serverName: string,
|
|
375
|
+
url: string,
|
|
376
|
+
callbackUrl: string,
|
|
377
|
+
options?: {
|
|
378
|
+
client?: ConstructorParameters<typeof Client>[1];
|
|
379
|
+
/**
|
|
380
|
+
* We don't expose the normal set of transport options because:
|
|
381
|
+
* 1) we can't serialize things like the auth provider or a fetch function into the DB for reconnection purposes
|
|
382
|
+
* 2) We probably want these options to be agnostic to the transport type (SSE vs Streamable)
|
|
383
|
+
*
|
|
384
|
+
* This has the limitation that you can't override fetch, but I think headers should handle nearly all cases needed (i.e. non-standard bearer auth).
|
|
385
|
+
*/
|
|
386
|
+
transport?: {
|
|
387
|
+
headers?: HeadersInit;
|
|
388
|
+
type?: TransportType;
|
|
389
|
+
};
|
|
390
|
+
},
|
|
391
|
+
reconnect?: {
|
|
392
|
+
id: string;
|
|
393
|
+
oauthClientId?: string;
|
|
394
|
+
}
|
|
395
|
+
): Promise<{
|
|
396
|
+
id: string;
|
|
397
|
+
authUrl: string | undefined;
|
|
398
|
+
clientId: string | undefined;
|
|
399
|
+
}>;
|
|
400
|
+
removeMcpServer(id: string): Promise<void>;
|
|
401
|
+
getMcpServers(): MCPServersState;
|
|
208
402
|
}
|
|
209
403
|
/**
|
|
210
404
|
* Namespace for creating Agent instances
|
|
@@ -237,17 +431,72 @@ declare function routeAgentRequest<Env>(
|
|
|
237
431
|
env: Env,
|
|
238
432
|
options?: AgentOptions<Env>
|
|
239
433
|
): Promise<Response | null>;
|
|
434
|
+
type EmailResolver<Env> = (
|
|
435
|
+
email: ForwardableEmailMessage,
|
|
436
|
+
env: Env
|
|
437
|
+
) => Promise<{
|
|
438
|
+
agentName: string;
|
|
439
|
+
agentId: string;
|
|
440
|
+
} | null>;
|
|
441
|
+
/**
|
|
442
|
+
* Create a resolver that uses the message-id header to determine the agent to route the email to
|
|
443
|
+
* @returns A function that resolves the agent to route the email to
|
|
444
|
+
*/
|
|
445
|
+
declare function createHeaderBasedEmailResolver<Env>(): EmailResolver<Env>;
|
|
446
|
+
/**
|
|
447
|
+
* Create a resolver that uses the email address to determine the agent to route the email to
|
|
448
|
+
* @param defaultAgentName The default agent name to use if the email address does not contain a sub-address
|
|
449
|
+
* @returns A function that resolves the agent to route the email to
|
|
450
|
+
*/
|
|
451
|
+
declare function createAddressBasedEmailResolver<Env>(
|
|
452
|
+
defaultAgentName: string
|
|
453
|
+
): EmailResolver<Env>;
|
|
454
|
+
/**
|
|
455
|
+
* Create a resolver that uses the agentName and agentId to determine the agent to route the email to
|
|
456
|
+
* @param agentName The name of the agent to route the email to
|
|
457
|
+
* @param agentId The id of the agent to route the email to
|
|
458
|
+
* @returns A function that resolves the agent to route the email to
|
|
459
|
+
*/
|
|
460
|
+
declare function createCatchAllEmailResolver<Env>(
|
|
461
|
+
agentName: string,
|
|
462
|
+
agentId: string
|
|
463
|
+
): EmailResolver<Env>;
|
|
464
|
+
type EmailRoutingOptions<Env> = AgentOptions<Env> & {
|
|
465
|
+
resolver: EmailResolver<Env>;
|
|
466
|
+
};
|
|
240
467
|
/**
|
|
241
468
|
* Route an email to the appropriate Agent
|
|
242
|
-
* @param email
|
|
243
|
-
* @param env
|
|
244
|
-
* @param options
|
|
469
|
+
* @param email The email to route
|
|
470
|
+
* @param env The environment containing the Agent bindings
|
|
471
|
+
* @param options The options for routing the email
|
|
472
|
+
* @returns A promise that resolves when the email has been routed
|
|
245
473
|
*/
|
|
246
474
|
declare function routeAgentEmail<Env>(
|
|
247
475
|
email: ForwardableEmailMessage,
|
|
248
476
|
env: Env,
|
|
249
|
-
options
|
|
477
|
+
options: EmailRoutingOptions<Env>
|
|
250
478
|
): Promise<void>;
|
|
479
|
+
type AgentEmail = {
|
|
480
|
+
from: string;
|
|
481
|
+
to: string;
|
|
482
|
+
getRaw: () => Promise<Uint8Array>;
|
|
483
|
+
headers: Headers;
|
|
484
|
+
rawSize: number;
|
|
485
|
+
setReject: (reason: string) => void;
|
|
486
|
+
forward: (rcptTo: string, headers?: Headers) => Promise<void>;
|
|
487
|
+
reply: (options: { from: string; to: string; raw: string }) => Promise<void>;
|
|
488
|
+
};
|
|
489
|
+
type EmailSendOptions = {
|
|
490
|
+
to: string;
|
|
491
|
+
subject: string;
|
|
492
|
+
body: string;
|
|
493
|
+
contentType?: string;
|
|
494
|
+
headers?: Record<string, string>;
|
|
495
|
+
includeRoutingHeaders?: boolean;
|
|
496
|
+
agentName?: string;
|
|
497
|
+
agentId?: string;
|
|
498
|
+
domain?: string;
|
|
499
|
+
};
|
|
251
500
|
/**
|
|
252
501
|
* Get or create an Agent by name
|
|
253
502
|
* @template Env Environment type containing bindings
|
|
@@ -257,19 +506,26 @@ declare function routeAgentEmail<Env>(
|
|
|
257
506
|
* @param options Options for Agent creation
|
|
258
507
|
* @returns Promise resolving to an Agent instance stub
|
|
259
508
|
*/
|
|
260
|
-
declare function getAgentByName<
|
|
509
|
+
declare function getAgentByName<
|
|
510
|
+
Env,
|
|
511
|
+
T extends Agent<Env>,
|
|
512
|
+
Props extends Record<string, unknown> = Record<string, unknown>
|
|
513
|
+
>(
|
|
261
514
|
namespace: AgentNamespace<T>,
|
|
262
515
|
name: string,
|
|
263
516
|
options?: {
|
|
264
517
|
jurisdiction?: DurableObjectJurisdiction;
|
|
265
518
|
locationHint?: DurableObjectLocationHint;
|
|
519
|
+
props?: Props;
|
|
266
520
|
}
|
|
267
521
|
): Promise<DurableObjectStub<T>>;
|
|
268
522
|
/**
|
|
269
523
|
* A wrapper for streaming responses in callable methods
|
|
270
524
|
*/
|
|
271
525
|
declare class StreamingResponse {
|
|
272
|
-
|
|
526
|
+
private _connection;
|
|
527
|
+
private _id;
|
|
528
|
+
private _closed;
|
|
273
529
|
constructor(connection: Connection, id: string);
|
|
274
530
|
/**
|
|
275
531
|
* Send a chunk of data to the client
|
|
@@ -286,17 +542,30 @@ declare class StreamingResponse {
|
|
|
286
542
|
export {
|
|
287
543
|
Agent,
|
|
288
544
|
type AgentContext,
|
|
545
|
+
type AgentEmail,
|
|
289
546
|
type AgentNamespace,
|
|
290
547
|
type AgentOptions,
|
|
291
548
|
type CallableMetadata,
|
|
549
|
+
type EmailResolver,
|
|
550
|
+
type EmailRoutingOptions,
|
|
551
|
+
type EmailSendOptions,
|
|
552
|
+
type MCPServer,
|
|
553
|
+
type MCPServerMessage,
|
|
554
|
+
type MCPServersState,
|
|
555
|
+
type QueueItem,
|
|
292
556
|
type RPCRequest,
|
|
293
557
|
type RPCResponse,
|
|
294
558
|
type Schedule,
|
|
295
559
|
type StateUpdateMessage,
|
|
296
560
|
StreamingResponse,
|
|
297
|
-
|
|
561
|
+
TransportType,
|
|
562
|
+
callable,
|
|
563
|
+
createAddressBasedEmailResolver,
|
|
564
|
+
createCatchAllEmailResolver,
|
|
565
|
+
createHeaderBasedEmailResolver,
|
|
298
566
|
getAgentByName,
|
|
567
|
+
getCurrentAgent,
|
|
299
568
|
routeAgentEmail,
|
|
300
569
|
routeAgentRequest,
|
|
301
|
-
unstable_callable
|
|
570
|
+
unstable_callable
|
|
302
571
|
};
|