@softr/sdk 0.0.90-alpha.3 → 0.0.90-alpha.5
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/dist/app-identity.js +77 -0
- package/dist/auth/isomorphic.d.ts +1 -1
- package/dist/auth/isomorphic.js +2 -0
- package/dist/formatting.d.ts +3 -3
- package/dist/index.d.ts +1 -3
- package/dist/index.js +1 -3
- package/dist/mcp.js +3 -7
- package/dist/package.js +1 -1
- package/dist/pwa.d.ts +2 -2
- package/package.json +3 -3
- package/skills/softr-sdk/SKILL.md +1 -5
- package/skills/softr-sdk/auth/SKILL.md +1 -1
- package/skills/softr-sdk/charts-and-metrics/SKILL.md +1 -1
- package/skills/softr-sdk/current-user/SKILL.md +1 -1
- package/skills/softr-sdk/file-uploads/SKILL.md +1 -1
- package/skills/softr-sdk/formatting/SKILL.md +1 -1
- package/skills/softr-sdk/integrations/SKILL.md +1 -1
- package/skills/softr-sdk/mcp/SKILL.md +1 -1
- package/skills/softr-sdk/pwa/SKILL.md +1 -1
- package/skills/softr-sdk/record-mutations/SKILL.md +1 -1
- package/skills/softr-sdk/record-queries/SKILL.md +1 -1
- package/skills/softr-sdk/region-visibility/SKILL.md +1 -1
- package/skills/softr-sdk/routes-and-visibility/SKILL.md +1 -1
- package/skills/softr-sdk/workflows/SKILL.md +1 -1
- package/dist/agent/agent-fns.d.ts +0 -30
- package/dist/agent/agent-fns.js +0 -215
- package/dist/agent/use-agent-chat.d.ts +0 -106
- package/dist/agent/use-agent-chat.js +0 -486
- package/skills/softr-sdk/agent-chat/SKILL.md +0 -106
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
import { AgentChatSummary } from "./agent-fns.js";
|
|
2
|
-
|
|
3
|
-
//#region src/agent/use-agent-chat.d.ts
|
|
4
|
-
/** A step of the agent's work: a tool it calls, and where that call stands. */
|
|
5
|
-
type AgentToolCall = {
|
|
6
|
-
type: "tool";
|
|
7
|
-
id: string;
|
|
8
|
-
name: string;
|
|
9
|
-
/** The tool's input as the agent sent it, usually JSON. */
|
|
10
|
-
input?: string;
|
|
11
|
-
/**
|
|
12
|
-
* `awaiting-approval` waits for `approve` or `reject`. `awaiting-connection`
|
|
13
|
-
* waits for the visitor to `connect` their own `integration` account, and is
|
|
14
|
-
* `connecting` while they sign in.
|
|
15
|
-
*/
|
|
16
|
-
status: "running" | "done" | "failed" | "awaiting-approval" | "approved" | "rejected" | "awaiting-connection" | "connecting";
|
|
17
|
-
error?: string;
|
|
18
|
-
integration?: string;
|
|
19
|
-
/** Why the agent calls it, in its own words. */
|
|
20
|
-
thought?: string;
|
|
21
|
-
/** How long a finished call took. */
|
|
22
|
-
durationMs?: number;
|
|
23
|
-
};
|
|
24
|
-
type AgentTodo = {
|
|
25
|
-
content: string;
|
|
26
|
-
status: "pending" | "in_progress" | "completed";
|
|
27
|
-
};
|
|
28
|
-
type AgentQuestion = {
|
|
29
|
-
question: string;
|
|
30
|
-
header: string;
|
|
31
|
-
options: Array<{
|
|
32
|
-
label: string;
|
|
33
|
-
description: string;
|
|
34
|
-
}>;
|
|
35
|
-
multiSelect: boolean;
|
|
36
|
-
};
|
|
37
|
-
/**
|
|
38
|
-
* One piece of a message, in the order the agent produced it. A tool waiting for
|
|
39
|
-
* the visitor comes last, below the text that asks for it, until they answer.
|
|
40
|
-
*/
|
|
41
|
-
type AgentBlock = {
|
|
42
|
-
type: "text";
|
|
43
|
-
text: string;
|
|
44
|
-
} | AgentToolCall
|
|
45
|
-
/** The agent's plan. It replaces itself as the agent works through it. */ | {
|
|
46
|
-
type: "todo";
|
|
47
|
-
todos: AgentTodo[];
|
|
48
|
-
}
|
|
49
|
-
/** The agent asks the visitor to pick. They answer by sending a message. */ | {
|
|
50
|
-
type: "question";
|
|
51
|
-
questions: AgentQuestion[];
|
|
52
|
-
} | {
|
|
53
|
-
type: "error";
|
|
54
|
-
message: string;
|
|
55
|
-
};
|
|
56
|
-
type AgentMessage = {
|
|
57
|
-
id: string;
|
|
58
|
-
role: "user" | "assistant";
|
|
59
|
-
blocks: AgentBlock[];
|
|
60
|
-
};
|
|
61
|
-
type AgentChat = {
|
|
62
|
-
/** The whole chat, oldest first. While the agent replies, its reply is the last one and grows. */
|
|
63
|
-
messages: AgentMessage[];
|
|
64
|
-
/** `thinking` until the first part of the reply arrives, `replying` until it ends. */
|
|
65
|
-
status: "idle" | "thinking" | "replying";
|
|
66
|
-
/** True while a past chat loads, including the one reopened on mount. */
|
|
67
|
-
loading: boolean;
|
|
68
|
-
/** Why the last request failed. Cleared by the next one. */
|
|
69
|
-
error: Error | null;
|
|
70
|
-
/** The chat the next message goes to, `null` for a new one. */
|
|
71
|
-
chatId: string | null;
|
|
72
|
-
send: (text: string) => void;
|
|
73
|
-
/** Stops the reply. What arrived so far stays. */
|
|
74
|
-
stop: () => void;
|
|
75
|
-
newChat: () => void;
|
|
76
|
-
/** Opens a past chat from `listChats`. */
|
|
77
|
-
openChat: (chatId: string) => void;
|
|
78
|
-
/** The visitor's past chats with this agent. */
|
|
79
|
-
listChats: () => Promise<AgentChatSummary[]>;
|
|
80
|
-
/** Lets a tool waiting for approval run: once, for the rest of this chat, or for this agent from now on. */
|
|
81
|
-
approve: (toolCallId: string, scope?: "ONCE" | "SESSION" | "USER") => void;
|
|
82
|
-
reject: (toolCallId: string) => void;
|
|
83
|
-
/** Opens the sign-in for a tool's `integration` in a popup. Call it from a click, or the browser blocks the popup. */
|
|
84
|
-
connect: (toolCallId: string) => void;
|
|
85
|
-
};
|
|
86
|
-
type AgentChatOptions = {
|
|
87
|
-
/**
|
|
88
|
-
* The record the visitor is looking at, so they can say "this one". Sent
|
|
89
|
-
* with each message. Keys are what the agent reads, so use field names.
|
|
90
|
-
*/
|
|
91
|
-
record?: {
|
|
92
|
-
id: string;
|
|
93
|
-
fields: Record<string, unknown>;
|
|
94
|
-
} | null;
|
|
95
|
-
};
|
|
96
|
-
/**
|
|
97
|
-
* A chat with one of the app's Softr agents, as the signed-in visitor. No UI:
|
|
98
|
-
* render `messages` with the app's own components.
|
|
99
|
-
*
|
|
100
|
-
* @example
|
|
101
|
-
* const chat = useAgentChat(AGENT_ID, { record: ticket && { id: ticket.id, fields: ticket.fields } })
|
|
102
|
-
* <form onSubmit={(e) => { e.preventDefault(); chat.send(draft) }}>
|
|
103
|
-
*/
|
|
104
|
-
declare function useAgentChat(agentId: string, options?: AgentChatOptions): AgentChat;
|
|
105
|
-
//#endregion
|
|
106
|
-
export { AgentBlock, AgentChat, AgentChatOptions, AgentMessage, AgentQuestion, AgentTodo, AgentToolCall, useAgentChat };
|
|
@@ -1,486 +0,0 @@
|
|
|
1
|
-
import { assert } from "../assertions.js";
|
|
2
|
-
import { useCurrentUser } from "../auth/isomorphic.js";
|
|
3
|
-
import { agentChatFn, awaitAgentConnectionFn, decideAgentToolFn, finishAgentConnectionFn, listAgentChatsFn, loadAgentChatFn, startAgentConnectionFn } from "./agent-fns.js";
|
|
4
|
-
import { useCallback, useEffect, useRef, useState } from "react";
|
|
5
|
-
|
|
6
|
-
//#region src/agent/use-agent-chat.ts
|
|
7
|
-
/**
|
|
8
|
-
* A chat with one of the app's Softr agents, as the signed-in visitor. No UI:
|
|
9
|
-
* render `messages` with the app's own components.
|
|
10
|
-
*
|
|
11
|
-
* @example
|
|
12
|
-
* const chat = useAgentChat(AGENT_ID, { record: ticket && { id: ticket.id, fields: ticket.fields } })
|
|
13
|
-
* <form onSubmit={(e) => { e.preventDefault(); chat.send(draft) }}>
|
|
14
|
-
*/
|
|
15
|
-
function useAgentChat(agentId, options = {}) {
|
|
16
|
-
const [messages, setMessages] = useState([]);
|
|
17
|
-
const [live, setLive] = useState(null);
|
|
18
|
-
const [status, setStatus] = useState("idle");
|
|
19
|
-
const [loading, setLoading] = useState(false);
|
|
20
|
-
const [error, setError] = useState(null);
|
|
21
|
-
const [chatId, setChatId] = useState(null);
|
|
22
|
-
const storeKey = chatKey(agentId, useCurrentUser()?.id ?? null);
|
|
23
|
-
const chatIdRef = useRef(chatId);
|
|
24
|
-
chatIdRef.current = chatId;
|
|
25
|
-
const recordRef = useRef(options.record ?? null);
|
|
26
|
-
recordRef.current = options.record ?? null;
|
|
27
|
-
const liveRef = useRef(live);
|
|
28
|
-
liveRef.current = live;
|
|
29
|
-
const abortRef = useRef(null);
|
|
30
|
-
useEffect(() => () => abortRef.current?.abort(), []);
|
|
31
|
-
const commitLive = useCallback((blocks) => {
|
|
32
|
-
setLive(null);
|
|
33
|
-
if (!blocks?.some((b) => b.type !== "text" || b.text.trim())) return;
|
|
34
|
-
setMessages((prev) => [...prev, {
|
|
35
|
-
id: crypto.randomUUID(),
|
|
36
|
-
role: "assistant",
|
|
37
|
-
blocks: endRunningTools(blocks)
|
|
38
|
-
}]);
|
|
39
|
-
}, []);
|
|
40
|
-
const stream = useCallback(async (message) => {
|
|
41
|
-
abortRef.current?.abort();
|
|
42
|
-
const controller = new AbortController();
|
|
43
|
-
abortRef.current = controller;
|
|
44
|
-
setError(null);
|
|
45
|
-
setStatus("thinking");
|
|
46
|
-
let blocks = [];
|
|
47
|
-
try {
|
|
48
|
-
const request = {
|
|
49
|
-
agentId,
|
|
50
|
-
message,
|
|
51
|
-
sessionId: chatIdRef.current,
|
|
52
|
-
timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
|
|
53
|
-
pageName: document.title,
|
|
54
|
-
pageUrl: location.href,
|
|
55
|
-
record: recordRef.current
|
|
56
|
-
};
|
|
57
|
-
const form = new FormData();
|
|
58
|
-
form.append("payload", JSON.stringify(request));
|
|
59
|
-
const res = await fetch(agentChatFn.url, {
|
|
60
|
-
method: "POST",
|
|
61
|
-
body: form,
|
|
62
|
-
signal: controller.signal
|
|
63
|
-
});
|
|
64
|
-
if (!res.ok) throw new Error(await failureMessage(res));
|
|
65
|
-
assert(res.body, "agent chat: the reply has no body");
|
|
66
|
-
const reader = res.body.pipeThrough(new TextDecoderStream()).getReader();
|
|
67
|
-
let buffer = "";
|
|
68
|
-
const onLine = (line) => {
|
|
69
|
-
const event = parseEvent(line);
|
|
70
|
-
if (event === null) return;
|
|
71
|
-
if (event.sessionId && event.sessionId !== chatIdRef.current) {
|
|
72
|
-
chatIdRef.current = event.sessionId;
|
|
73
|
-
setChatId(event.sessionId);
|
|
74
|
-
saveChatId(storeKey, event.sessionId);
|
|
75
|
-
}
|
|
76
|
-
blocks = reduceEvent(blocks, event);
|
|
77
|
-
setLive(blocks);
|
|
78
|
-
setStatus("replying");
|
|
79
|
-
};
|
|
80
|
-
for (;;) {
|
|
81
|
-
const { done, value } = await reader.read();
|
|
82
|
-
if (done) break;
|
|
83
|
-
buffer += value;
|
|
84
|
-
const lines = buffer.split("\n");
|
|
85
|
-
buffer = lines.pop() ?? "";
|
|
86
|
-
lines.forEach(onLine);
|
|
87
|
-
}
|
|
88
|
-
onLine(buffer);
|
|
89
|
-
} catch (err) {
|
|
90
|
-
if (controller.signal.aborted) return;
|
|
91
|
-
setError(err instanceof Error ? err : new Error(String(err)));
|
|
92
|
-
}
|
|
93
|
-
if (abortRef.current !== controller) return;
|
|
94
|
-
abortRef.current = null;
|
|
95
|
-
commitLive(blocks);
|
|
96
|
-
setStatus("idle");
|
|
97
|
-
}, [
|
|
98
|
-
agentId,
|
|
99
|
-
storeKey,
|
|
100
|
-
commitLive
|
|
101
|
-
]);
|
|
102
|
-
const send = useCallback((text) => {
|
|
103
|
-
const trimmed = text.trim();
|
|
104
|
-
if (!trimmed) return;
|
|
105
|
-
abortRef.current?.abort();
|
|
106
|
-
commitLive(liveRef.current);
|
|
107
|
-
setMessages((prev) => [...prev, {
|
|
108
|
-
id: crypto.randomUUID(),
|
|
109
|
-
role: "user",
|
|
110
|
-
blocks: [{
|
|
111
|
-
type: "text",
|
|
112
|
-
text: trimmed
|
|
113
|
-
}]
|
|
114
|
-
}]);
|
|
115
|
-
stream(trimmed);
|
|
116
|
-
}, [stream, commitLive]);
|
|
117
|
-
const stop = useCallback(() => {
|
|
118
|
-
if (abortRef.current === null) return;
|
|
119
|
-
abortRef.current.abort();
|
|
120
|
-
abortRef.current = null;
|
|
121
|
-
commitLive(liveRef.current);
|
|
122
|
-
setStatus("idle");
|
|
123
|
-
}, [commitLive]);
|
|
124
|
-
const reset = useCallback((id) => {
|
|
125
|
-
abortRef.current?.abort();
|
|
126
|
-
abortRef.current = null;
|
|
127
|
-
chatIdRef.current = id;
|
|
128
|
-
setChatId(id);
|
|
129
|
-
saveChatId(storeKey, id);
|
|
130
|
-
setMessages([]);
|
|
131
|
-
setLive(null);
|
|
132
|
-
setStatus("idle");
|
|
133
|
-
setLoading(false);
|
|
134
|
-
setError(null);
|
|
135
|
-
}, [storeKey]);
|
|
136
|
-
const newChat = useCallback(() => reset(null), [reset]);
|
|
137
|
-
const load = useCallback((id, restoring) => {
|
|
138
|
-
reset(id);
|
|
139
|
-
setLoading(true);
|
|
140
|
-
loadAgentChatFn({ data: {
|
|
141
|
-
agentId,
|
|
142
|
-
sessionId: id
|
|
143
|
-
} }).then((history) => {
|
|
144
|
-
if (chatIdRef.current !== id) return;
|
|
145
|
-
if (history === null) {
|
|
146
|
-
reset(null);
|
|
147
|
-
if (!restoring) setError(new Error(CHAT_GONE_MESSAGE));
|
|
148
|
-
return;
|
|
149
|
-
}
|
|
150
|
-
setLoading(false);
|
|
151
|
-
setMessages(fromHistory(history));
|
|
152
|
-
}).catch((err) => {
|
|
153
|
-
if (chatIdRef.current !== id) return;
|
|
154
|
-
setLoading(false);
|
|
155
|
-
setError(err instanceof Error ? err : new Error(String(err)));
|
|
156
|
-
});
|
|
157
|
-
}, [agentId, reset]);
|
|
158
|
-
const openChat = useCallback((id) => load(id, false), [load]);
|
|
159
|
-
useEffect(() => {
|
|
160
|
-
const saved = savedChatId(storeKey);
|
|
161
|
-
if (saved) load(saved, true);
|
|
162
|
-
else newChat();
|
|
163
|
-
}, [
|
|
164
|
-
storeKey,
|
|
165
|
-
load,
|
|
166
|
-
newChat
|
|
167
|
-
]);
|
|
168
|
-
const listChats = useCallback(() => listAgentChatsFn({ data: { agentId } }), [agentId]);
|
|
169
|
-
const setToolStatus = useCallback((toolCallId, next) => {
|
|
170
|
-
const update = (blocks) => blocks.map((b) => b.type === "tool" && b.id === toolCallId ? {
|
|
171
|
-
...b,
|
|
172
|
-
status: next
|
|
173
|
-
} : b);
|
|
174
|
-
setLive((prev) => prev && update(prev));
|
|
175
|
-
setMessages((prev) => prev.map((m) => ({
|
|
176
|
-
...m,
|
|
177
|
-
blocks: update(m.blocks)
|
|
178
|
-
})));
|
|
179
|
-
}, []);
|
|
180
|
-
const decide = useCallback((toolCallId, decision, scope) => {
|
|
181
|
-
const sessionId = chatIdRef.current;
|
|
182
|
-
const tool = [...messages.flatMap((m) => m.blocks), ...liveRef.current ?? []].find((b) => b.type === "tool" && b.id === toolCallId);
|
|
183
|
-
if (sessionId === null || tool?.status !== "awaiting-approval") return;
|
|
184
|
-
setToolStatus(toolCallId, decision === "APPROVE" ? "approved" : "rejected");
|
|
185
|
-
decideAgentToolFn({ data: {
|
|
186
|
-
agentId,
|
|
187
|
-
sessionId,
|
|
188
|
-
toolCallId,
|
|
189
|
-
toolName: tool.name,
|
|
190
|
-
decision,
|
|
191
|
-
scope
|
|
192
|
-
} }).then((saved) => {
|
|
193
|
-
if (!saved) {
|
|
194
|
-
reset(null);
|
|
195
|
-
setError(new Error(CHAT_GONE_MESSAGE));
|
|
196
|
-
return;
|
|
197
|
-
}
|
|
198
|
-
if (decision !== "APPROVE") return;
|
|
199
|
-
abortRef.current?.abort();
|
|
200
|
-
commitLive(liveRef.current);
|
|
201
|
-
stream("");
|
|
202
|
-
}).catch((err) => {
|
|
203
|
-
setToolStatus(toolCallId, "awaiting-approval");
|
|
204
|
-
setError(err instanceof Error ? err : new Error(String(err)));
|
|
205
|
-
});
|
|
206
|
-
}, [
|
|
207
|
-
agentId,
|
|
208
|
-
messages,
|
|
209
|
-
setToolStatus,
|
|
210
|
-
commitLive,
|
|
211
|
-
stream,
|
|
212
|
-
reset
|
|
213
|
-
]);
|
|
214
|
-
const approve = useCallback((toolCallId, scope = "ONCE") => decide(toolCallId, "APPROVE", scope), [decide]);
|
|
215
|
-
const reject = useCallback((toolCallId) => decide(toolCallId, "REJECT", "ONCE"), [decide]);
|
|
216
|
-
const connect = useCallback((toolCallId) => {
|
|
217
|
-
const sessionId = chatIdRef.current;
|
|
218
|
-
const tool = [...messages.flatMap((m) => m.blocks), ...liveRef.current ?? []].find((b) => b.type === "tool" && b.id === toolCallId);
|
|
219
|
-
if (sessionId === null || tool?.status !== "awaiting-connection" || !tool.integration) return;
|
|
220
|
-
const popup = window.open("", "softr-agent-connect", popupFeatures(500, 600));
|
|
221
|
-
if (!popup) {
|
|
222
|
-
setError(/* @__PURE__ */ new Error("Allow pop-ups for this site to connect your account."));
|
|
223
|
-
return;
|
|
224
|
-
}
|
|
225
|
-
setToolStatus(toolCallId, "connecting");
|
|
226
|
-
const connection = {
|
|
227
|
-
integration: tool.integration,
|
|
228
|
-
requestId: crypto.randomUUID()
|
|
229
|
-
};
|
|
230
|
-
const deadline = Date.now() + CONNECT_TIMEOUT_MS;
|
|
231
|
-
(async () => {
|
|
232
|
-
popup.location.href = await startAgentConnectionFn({ data: connection });
|
|
233
|
-
while (!await awaitAgentConnectionFn({ data: connection })) {
|
|
234
|
-
if (Date.now() > deadline) throw new Error("Connecting took too long. Try again.");
|
|
235
|
-
await new Promise((resolve) => setTimeout(resolve, CONNECT_RETRY_MS));
|
|
236
|
-
}
|
|
237
|
-
popup.close();
|
|
238
|
-
if (!await finishAgentConnectionFn({ data: {
|
|
239
|
-
agentId,
|
|
240
|
-
sessionId,
|
|
241
|
-
toolCallId
|
|
242
|
-
} })) {
|
|
243
|
-
reset(null);
|
|
244
|
-
setError(new Error(CHAT_GONE_MESSAGE));
|
|
245
|
-
return;
|
|
246
|
-
}
|
|
247
|
-
setToolStatus(toolCallId, "approved");
|
|
248
|
-
abortRef.current?.abort();
|
|
249
|
-
commitLive(liveRef.current);
|
|
250
|
-
stream("");
|
|
251
|
-
})().catch((err) => {
|
|
252
|
-
popup.close();
|
|
253
|
-
setToolStatus(toolCallId, "awaiting-connection");
|
|
254
|
-
setError(err instanceof Error ? err : new Error(String(err)));
|
|
255
|
-
});
|
|
256
|
-
}, [
|
|
257
|
-
agentId,
|
|
258
|
-
messages,
|
|
259
|
-
setToolStatus,
|
|
260
|
-
commitLive,
|
|
261
|
-
stream,
|
|
262
|
-
reset
|
|
263
|
-
]);
|
|
264
|
-
return {
|
|
265
|
-
messages: (live === null ? messages : [...messages, {
|
|
266
|
-
id: "live",
|
|
267
|
-
role: "assistant",
|
|
268
|
-
blocks: live
|
|
269
|
-
}]).map(waitingLast),
|
|
270
|
-
status,
|
|
271
|
-
loading,
|
|
272
|
-
error,
|
|
273
|
-
chatId,
|
|
274
|
-
send,
|
|
275
|
-
stop,
|
|
276
|
-
newChat,
|
|
277
|
-
openChat,
|
|
278
|
-
listChats,
|
|
279
|
-
approve,
|
|
280
|
-
reject,
|
|
281
|
-
connect
|
|
282
|
-
};
|
|
283
|
-
}
|
|
284
|
-
const waitsForVisitor = (b) => b.type === "tool" && (b.status === "awaiting-approval" || b.status === "awaiting-connection" || b.status === "connecting");
|
|
285
|
-
function waitingLast(message) {
|
|
286
|
-
if (!message.blocks.some(waitsForVisitor)) return message;
|
|
287
|
-
const blocks = [...message.blocks.filter((b) => !waitsForVisitor(b)), ...message.blocks.filter(waitsForVisitor)];
|
|
288
|
-
return {
|
|
289
|
-
...message,
|
|
290
|
-
blocks
|
|
291
|
-
};
|
|
292
|
-
}
|
|
293
|
-
const CONNECT_TIMEOUT_MS = 5 * 6e4;
|
|
294
|
-
const CONNECT_RETRY_MS = 3e3;
|
|
295
|
-
function popupFeatures(width, height) {
|
|
296
|
-
return `width=${width},height=${height},left=${window.screenX + (window.innerWidth - width) / 2},top=${window.screenY + (window.innerHeight - height) / 2}`;
|
|
297
|
-
}
|
|
298
|
-
const TODO_TOOL = "TodoWrite";
|
|
299
|
-
/** Its question shows as a question block, so the call itself is noise. */
|
|
300
|
-
const QUESTION_TOOL = "AskUserQuestion";
|
|
301
|
-
function parseEvent(line) {
|
|
302
|
-
if (!line.trim()) return null;
|
|
303
|
-
try {
|
|
304
|
-
return JSON.parse(line);
|
|
305
|
-
} catch {
|
|
306
|
-
return null;
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
function reduceEvent(blocks, event) {
|
|
310
|
-
switch (event.type) {
|
|
311
|
-
case "TEXT": {
|
|
312
|
-
const last = blocks.at(-1);
|
|
313
|
-
return last?.type === "text" ? [...blocks.slice(0, -1), {
|
|
314
|
-
type: "text",
|
|
315
|
-
text: last.text + event.response
|
|
316
|
-
}] : [...blocks, {
|
|
317
|
-
type: "text",
|
|
318
|
-
text: event.response
|
|
319
|
-
}];
|
|
320
|
-
}
|
|
321
|
-
case "TOOL_CALL_START":
|
|
322
|
-
if (event.toolName === TODO_TOOL) {
|
|
323
|
-
const todos = parseTodos(event.input);
|
|
324
|
-
if (todos) return upsertTodos(blocks, todos);
|
|
325
|
-
}
|
|
326
|
-
if (event.toolName === QUESTION_TOOL) return blocks;
|
|
327
|
-
if (blocks.some((b) => b.type === "tool" && b.id === event.toolCallId)) return updateTool(blocks, event.toolCallId, (b) => b.status === "running" ? {
|
|
328
|
-
...b,
|
|
329
|
-
input: event.input ?? b.input,
|
|
330
|
-
thought: event.innerThought ?? b.thought
|
|
331
|
-
} : b);
|
|
332
|
-
return [...blocks, {
|
|
333
|
-
type: "tool",
|
|
334
|
-
id: event.toolCallId,
|
|
335
|
-
name: event.toolName,
|
|
336
|
-
input: event.input,
|
|
337
|
-
thought: event.innerThought,
|
|
338
|
-
integration: event.integrationType,
|
|
339
|
-
status: "running"
|
|
340
|
-
}];
|
|
341
|
-
case "TOOL_CALL_END": return updateTool(blocks, event.toolCallId, (b) => b.status === "running" || b.status === "approved" ? {
|
|
342
|
-
...b,
|
|
343
|
-
status: event.failed ? "failed" : "done",
|
|
344
|
-
error: event.errorMessage,
|
|
345
|
-
durationMs: event.durationMs
|
|
346
|
-
} : b);
|
|
347
|
-
case "TOOL_PERMISSION_REQUEST":
|
|
348
|
-
case "INTEGRATION_AUTH_REQUEST": {
|
|
349
|
-
const status = event.type === "TOOL_PERMISSION_REQUEST" ? "awaiting-approval" : "awaiting-connection";
|
|
350
|
-
const integration = event.type === "INTEGRATION_AUTH_REQUEST" ? event.integrationType : void 0;
|
|
351
|
-
if (blocks.some((b) => b.type === "tool" && b.id === event.toolCallId)) return updateTool(blocks, event.toolCallId, (b) => ({
|
|
352
|
-
...b,
|
|
353
|
-
status,
|
|
354
|
-
integration: integration ?? b.integration,
|
|
355
|
-
input: ("input" in event ? event.input : void 0) ?? b.input
|
|
356
|
-
}));
|
|
357
|
-
return [...blocks, {
|
|
358
|
-
type: "tool",
|
|
359
|
-
id: event.toolCallId,
|
|
360
|
-
name: event.toolName,
|
|
361
|
-
input: "input" in event ? event.input : void 0,
|
|
362
|
-
integration,
|
|
363
|
-
status
|
|
364
|
-
}];
|
|
365
|
-
}
|
|
366
|
-
case "QUESTION": return [...blocks, {
|
|
367
|
-
type: "question",
|
|
368
|
-
questions: event.questions
|
|
369
|
-
}];
|
|
370
|
-
case "ERROR": return [...blocks, {
|
|
371
|
-
type: "error",
|
|
372
|
-
message: event.message
|
|
373
|
-
}];
|
|
374
|
-
default: return blocks;
|
|
375
|
-
}
|
|
376
|
-
}
|
|
377
|
-
function updateTool(blocks, id, update) {
|
|
378
|
-
return blocks.map((b) => b.type === "tool" && b.id === id ? update(b) : b);
|
|
379
|
-
}
|
|
380
|
-
/** A reply that ended without finishing a tool call, stopped or cut off, never will. */
|
|
381
|
-
function endRunningTools(blocks) {
|
|
382
|
-
return blocks.map((b) => b.type === "tool" && b.status === "running" ? {
|
|
383
|
-
...b,
|
|
384
|
-
status: "failed",
|
|
385
|
-
error: "The agent stopped before this step finished."
|
|
386
|
-
} : b);
|
|
387
|
-
}
|
|
388
|
-
/** Each plan update re-sends the whole list, so only the latest one is kept, where the first one was. */
|
|
389
|
-
function upsertTodos(blocks, todos) {
|
|
390
|
-
const index = blocks.findIndex((b) => b.type === "todo");
|
|
391
|
-
if (index === -1) return [...blocks, {
|
|
392
|
-
type: "todo",
|
|
393
|
-
todos
|
|
394
|
-
}];
|
|
395
|
-
return blocks.map((b, i) => i === index ? {
|
|
396
|
-
type: "todo",
|
|
397
|
-
todos
|
|
398
|
-
} : b);
|
|
399
|
-
}
|
|
400
|
-
function parseTodos(input) {
|
|
401
|
-
if (!input) return null;
|
|
402
|
-
try {
|
|
403
|
-
const parsed = JSON.parse(input);
|
|
404
|
-
if (typeof parsed !== "object" || parsed === null || !("todos" in parsed)) return null;
|
|
405
|
-
const outer = parsed.todos;
|
|
406
|
-
const raw = typeof outer === "object" && outer !== null && "todos" in outer ? outer.todos : outer;
|
|
407
|
-
if (!Array.isArray(raw)) return null;
|
|
408
|
-
const todos = raw.flatMap((item) => {
|
|
409
|
-
if (typeof item !== "object" || item === null) return [];
|
|
410
|
-
const { content, status } = item;
|
|
411
|
-
if (typeof content !== "string" || !content.trim()) return [];
|
|
412
|
-
if (status !== "pending" && status !== "in_progress" && status !== "completed") return [];
|
|
413
|
-
return [{
|
|
414
|
-
content,
|
|
415
|
-
status
|
|
416
|
-
}];
|
|
417
|
-
});
|
|
418
|
-
return todos.length > 0 ? todos : null;
|
|
419
|
-
} catch {
|
|
420
|
-
return null;
|
|
421
|
-
}
|
|
422
|
-
}
|
|
423
|
-
function fromHistory(history) {
|
|
424
|
-
const toolsByMessage = Map.groupBy(history.toolCalls, (call) => call.messageId);
|
|
425
|
-
return history.messages.filter((m) => m.role !== "USER" || m.content.trim()).map((m) => {
|
|
426
|
-
if (m.role === "USER") return {
|
|
427
|
-
id: m.id,
|
|
428
|
-
role: "user",
|
|
429
|
-
blocks: [{
|
|
430
|
-
type: "text",
|
|
431
|
-
text: m.content
|
|
432
|
-
}]
|
|
433
|
-
};
|
|
434
|
-
let blocks = [];
|
|
435
|
-
const calls = (toolsByMessage.get(m.id) ?? []).toSorted((a, b) => a.createdAt - b.createdAt);
|
|
436
|
-
for (const call of calls) {
|
|
437
|
-
const todos = call.toolName === TODO_TOOL ? parseTodos(call.input) : null;
|
|
438
|
-
if (todos) blocks = upsertTodos(blocks, todos);
|
|
439
|
-
else if (call.toolName !== QUESTION_TOOL) blocks.push({
|
|
440
|
-
type: "tool",
|
|
441
|
-
id: call.id,
|
|
442
|
-
name: call.toolName,
|
|
443
|
-
input: call.input,
|
|
444
|
-
thought: call.metadata.innerThought ?? void 0,
|
|
445
|
-
durationMs: call.metadata.durationMs ?? void 0,
|
|
446
|
-
status: call.metadata.failed ? "failed" : "done"
|
|
447
|
-
});
|
|
448
|
-
}
|
|
449
|
-
if (m.content) blocks.push({
|
|
450
|
-
type: "text",
|
|
451
|
-
text: m.content
|
|
452
|
-
});
|
|
453
|
-
return {
|
|
454
|
-
id: m.id,
|
|
455
|
-
role: "assistant",
|
|
456
|
-
blocks
|
|
457
|
-
};
|
|
458
|
-
});
|
|
459
|
-
}
|
|
460
|
-
const CHAT_GONE_MESSAGE = "This chat is no longer available. Start a new one.";
|
|
461
|
-
const VISITOR = "visitor";
|
|
462
|
-
const chatKey = (agentId, userId) => `softr-code-app:agent-chat:${agentId}:${userId ?? VISITOR}`;
|
|
463
|
-
function chatStore(key) {
|
|
464
|
-
return key.endsWith(`:${VISITOR}`) ? sessionStorage : localStorage;
|
|
465
|
-
}
|
|
466
|
-
function savedChatId(key) {
|
|
467
|
-
try {
|
|
468
|
-
return chatStore(key).getItem(key);
|
|
469
|
-
} catch {
|
|
470
|
-
return null;
|
|
471
|
-
}
|
|
472
|
-
}
|
|
473
|
-
function saveChatId(key, chatId) {
|
|
474
|
-
try {
|
|
475
|
-
if (chatId) chatStore(key).setItem(key, chatId);
|
|
476
|
-
else chatStore(key).removeItem(key);
|
|
477
|
-
} catch {}
|
|
478
|
-
}
|
|
479
|
-
async function failureMessage(res) {
|
|
480
|
-
const body = await res.json().catch(() => null);
|
|
481
|
-
if (typeof body === "object" && body !== null && "message" in body && typeof body.message === "string") return body.message;
|
|
482
|
-
return `The agent could not answer (${res.status}).`;
|
|
483
|
-
}
|
|
484
|
-
|
|
485
|
-
//#endregion
|
|
486
|
-
export { useAgentChat };
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: agent-chat
|
|
3
|
-
description: >-
|
|
4
|
-
Chat with one of the app's Softr agents: listAgents() and useAgentChat(agentId,
|
|
5
|
-
{ record }) from @softr/sdk give the chat state with no UI — messages, the
|
|
6
|
-
streaming reply, past chats, approve, reject, connect. Load it for an agent
|
|
7
|
-
chat, approving its actions, or connecting the visitor's account a tool needs.
|
|
8
|
-
metadata:
|
|
9
|
-
type: sub-skill
|
|
10
|
-
library: softr-sdk
|
|
11
|
-
library_version: 0.0.90-alpha.3
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
**Boundary.** `listAgents` and `useAgentChat` live on `@softr/sdk`. `listAgents` runs in a route loader, `useAgentChat` in a component. Neither needs a route, server function or registration of its own. It chats as the signed-in visitor, or anonymously when no one is signed in.
|
|
15
|
-
|
|
16
|
-
# Agent chat
|
|
17
|
-
|
|
18
|
-
A Softr agent is set up in Studio's Agents tab and attached to the app there. There is no chat widget: the hook gives the state, and the app draws it with its own components.
|
|
19
|
-
|
|
20
|
-
## Setup
|
|
21
|
-
|
|
22
|
-
```ts
|
|
23
|
-
import { listAgents, useAgentChat } from '@softr/sdk'
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
`listAgents()` resolves to the agents this visitor may chat with, `{ id, title, avatar, thumbnail }[]`. Call it in the route's `loader`. An agent hidden from this visitor isn't in the list, so show no chat when it's empty. When there are several, let the visitor pick one, or pick the one the builder named by its `title`. Take the id from the list. A hand-written id fails on the first message, and shows an agent the visitor may not see.
|
|
27
|
-
|
|
28
|
-
## Core pattern
|
|
29
|
-
|
|
30
|
-
```tsx
|
|
31
|
-
// agentId comes from listAgents() in the route's loader.
|
|
32
|
-
function AgentPanel({ agentId, ticket }: { agentId: string; ticket: Ticket | null }) {
|
|
33
|
-
const chat = useAgentChat(agentId, {
|
|
34
|
-
record: ticket && { id: ticket.id, fields: { Title: ticket.title, Status: ticket.status } },
|
|
35
|
-
})
|
|
36
|
-
const [draft, setDraft] = useState('')
|
|
37
|
-
|
|
38
|
-
return (
|
|
39
|
-
<>
|
|
40
|
-
{chat.messages.map((message) => (
|
|
41
|
-
<Message key={message.id} message={message} onApprove={chat.approve} onReject={chat.reject} />
|
|
42
|
-
))}
|
|
43
|
-
{chat.error && <p role="alert">{chat.error.message}</p>}
|
|
44
|
-
<form onSubmit={(e) => { e.preventDefault(); chat.send(draft); setDraft('') }}>
|
|
45
|
-
<Textarea value={draft} onChange={(e) => setDraft(e.target.value)} />
|
|
46
|
-
{chat.status === 'idle'
|
|
47
|
-
? <Button type="submit">Send</Button>
|
|
48
|
-
: <Button type="button" onClick={chat.stop}>Stop</Button>}
|
|
49
|
-
</form>
|
|
50
|
-
</>
|
|
51
|
-
)
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
## What the hook returns
|
|
56
|
-
|
|
57
|
-
- `messages`: the whole chat, oldest first. While the agent answers, its reply is the last message and grows as it streams.
|
|
58
|
-
- `status`: `thinking` until the first part of the reply arrives, `replying` until it ends, then `idle`. Show a typing hint while it's `thinking`.
|
|
59
|
-
- `loading`: `true` while a past chat loads. Show a spinner, not the empty-chat greeting.
|
|
60
|
-
- `error`: why the last request failed, or `null`.
|
|
61
|
-
- `send(text)`, `stop()`, `newChat()`.
|
|
62
|
-
- `listChats()` resolves to the visitor's past chats, `{ id, title }[]`, with `title` `null` until the agent names the chat. `openChat(id)` loads one. `chatId` is the open one, `null` for a new chat. The open chat is kept in the browser for each signed-in user, so the hook reopens it after a remount or a reload. A signed-out visitor keeps it only until the tab closes.
|
|
63
|
-
- `approve(toolCallId, scope?)` and `reject(toolCallId)` answer a tool waiting for approval. `scope` is `ONCE` (default), `SESSION` for the rest of this chat, or `USER` for this agent from now on.
|
|
64
|
-
- `connect(toolCallId)` signs the visitor in to a tool's `integration` in a popup. Call it straight from the click, or the browser blocks the popup.
|
|
65
|
-
|
|
66
|
-
## Rendering a message
|
|
67
|
-
|
|
68
|
-
Each message has `role` (`user` or `assistant`) and `blocks`. Render every block type, in the order given. Show only `text` and a tool waiting for approval never appears, so the agent waits forever. A tool waiting for Approve or Connect comes last in its message, below the text asking for it.
|
|
69
|
-
|
|
70
|
-
| Block | Show it as |
|
|
71
|
-
| --- | --- |
|
|
72
|
-
| `text` | Markdown, tables included |
|
|
73
|
-
| `tool` | One line: the tool `name` and its `status`. Collapse finished ones. Expanded, show `thought`, `input` as `Label: value` lines (never raw JSON), `error` and `durationMs`, leaving out empty ones. |
|
|
74
|
-
| `todo` | A checklist of the agent's plan. It updates in place. |
|
|
75
|
-
| `question` | The questions with their options. One question with a single choice sends its label with `send` on click. Several questions, or `multiSelect`, collect the picks and show a Send button, enabled once each question has one. It sends one line per question, picked labels joined by ", ". An answered question stays locked. |
|
|
76
|
-
| `error` | An error line inside the reply |
|
|
77
|
-
|
|
78
|
-
A `tool` with status `awaiting-approval` blocks the agent until the visitor answers. Give it a split Approve button and a Reject button. The button says "Approve once" (`approve(id)`), and its menu offers "Approve for this session" (`approve(id, 'SESSION')`) and "Approve for this agent" (`approve(id, 'USER')`). With only one Approve, the visitor approves the same action again on every call. The agent continues on its own after an approval.
|
|
79
|
-
|
|
80
|
-
A `tool` with status `awaiting-connection` needs the visitor's own `integration` account, such as their Gmail. Say "You need to connect to {integration} for this request. You'll only need to connect once.", with the name in readable case, and show a Connect button that calls `connect`. While it's `connecting`, show "Connecting…" and disable the button. The agent continues on its own once they're signed in. Every integration works the same way, so build one button, not one per integration.
|
|
81
|
-
|
|
82
|
-
## Context
|
|
83
|
-
|
|
84
|
-
`record` is the one record the visitor is looking at, so they can say "close this one". Pass it where a page shows one record, and `null` elsewhere. Use readable field names as keys. The agent reads them as they are.
|
|
85
|
-
|
|
86
|
-
The page title and URL go along on their own. Nothing else about the page does, so don't try to send whole lists.
|
|
87
|
-
|
|
88
|
-
## Letting the agent act on the app
|
|
89
|
-
|
|
90
|
-
The agent reads and changes data through the app's own MCP, as the visitor who is chatting, using the actions `softrMcpMiddleware` lists. With no MCP wired, the agent can only talk. Load [mcp/SKILL.md](../mcp/SKILL.md) to wire it and choose the actions.
|
|
91
|
-
|
|
92
|
-
**The agent calls a listed action directly, with any input.** It skips pages and server functions, so the action's `permissions` are its only guard: a read returns every row those groups may see, an update or delete takes any id.
|
|
93
|
-
|
|
94
|
-
- Narrow `permissions` to who may really run it. When roles differ, split the action: each writes only that role's fields, with `customGroups` for that role. One update open to every signed-in visitor that writes the status lets an employee have the agent approve their own vacation request.
|
|
95
|
-
- Don't list an action that is only safe for a visitor's own records. Nothing scopes it to them.
|
|
96
|
-
|
|
97
|
-
## Failure modes
|
|
98
|
-
|
|
99
|
-
**Building a chat without the hook.** Calling the agents service from the browser fails: only the app's server can sign the request in as the visitor. Use `useAgentChat`.
|
|
100
|
-
|
|
101
|
-
**The hook inside a component that unmounts when the panel closes.** Closing it stops a reply that is still coming. Call `useAgentChat` in the component that owns the panel's open state and pass `chat` down. Keep the selected agent there too, or closing the panel resets it.
|
|
102
|
-
|
|
103
|
-
## References
|
|
104
|
-
|
|
105
|
-
- [mcp/SKILL.md](../mcp/SKILL.md): the actions the agent may call
|
|
106
|
-
- [current-user/SKILL.md](../current-user/SKILL.md): showing the chat to signed-in visitors only
|