@softr/sdk 0.0.89 → 0.0.90-alpha.1
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/agent/agent-fns.d.ts +30 -0
- package/dist/agent/agent-fns.js +215 -0
- package/dist/agent/use-agent-chat.d.ts +106 -0
- package/dist/agent/use-agent-chat.js +486 -0
- package/dist/index.d.ts +3 -1
- package/dist/index.js +3 -1
- package/dist/mcp.js +7 -3
- package/dist/package.js +1 -1
- package/package.json +1 -1
- package/skills/softr-sdk/SKILL.md +5 -1
- package/skills/softr-sdk/agent-chat/SKILL.md +144 -0
- 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
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import * as _tanstack_react_start8 from "@tanstack/react-start";
|
|
3
|
+
|
|
4
|
+
//#region src/agent/agent-fns.d.ts
|
|
5
|
+
|
|
6
|
+
declare const agentSchema: z.ZodObject<{
|
|
7
|
+
id: z.ZodString;
|
|
8
|
+
title: z.ZodString;
|
|
9
|
+
avatar: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
10
|
+
thumbnail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
11
|
+
}, z.core.$strip>;
|
|
12
|
+
/** An agent the visitor may chat with. */
|
|
13
|
+
type Agent = z.infer<typeof agentSchema>;
|
|
14
|
+
/**
|
|
15
|
+
* The agents the visitor may chat with in this app. The builder attaches them
|
|
16
|
+
* in Studio, and each one's visibility settings decide who sees it.
|
|
17
|
+
*/
|
|
18
|
+
declare const listAgents: _tanstack_react_start8.OptionalFetcher<undefined, undefined, Promise<{
|
|
19
|
+
id: string;
|
|
20
|
+
title: string;
|
|
21
|
+
avatar?: string | null | undefined;
|
|
22
|
+
thumbnail?: string | null | undefined;
|
|
23
|
+
}[]>>;
|
|
24
|
+
/** One past chat with an agent. `title` is null until the agent names the chat. */
|
|
25
|
+
type AgentChatSummary = {
|
|
26
|
+
id: string;
|
|
27
|
+
title: string | null;
|
|
28
|
+
};
|
|
29
|
+
//#endregion
|
|
30
|
+
export { Agent, AgentChatSummary, listAgents };
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
import { assert } from "../assertions.js";
|
|
2
|
+
import { softrApiUrl } from "../softr-api.js";
|
|
3
|
+
import { fetch } from "../fetch.js";
|
|
4
|
+
import { sessionConfig } from "../auth/config.js";
|
|
5
|
+
import { readSessionToken } from "../auth/session.js";
|
|
6
|
+
import { describeFailure, refererHeader } from "../datasource/record.js";
|
|
7
|
+
import { z } from "zod";
|
|
8
|
+
import { createServerFn } from "@tanstack/react-start";
|
|
9
|
+
import { getRequest } from "@tanstack/react-start/server";
|
|
10
|
+
|
|
11
|
+
//#region src/agent/agent-fns.ts
|
|
12
|
+
const AGENTS_PRODUCTION = "https://agents-api.softr.io";
|
|
13
|
+
const PLATFORM_HOST = /^(platform-api|platform-preview-api|preview-api)(?=[.-])/;
|
|
14
|
+
/**
|
|
15
|
+
* Where the agents service is. It sits next to the platform API, so unless
|
|
16
|
+
* `SOFTR_AGENTS_API_URL` says otherwise, it's the platform's host with
|
|
17
|
+
* `agents-api` in place of the platform's name. Live and preview share one
|
|
18
|
+
* agents service.
|
|
19
|
+
*/
|
|
20
|
+
function agentsApiUrl() {
|
|
21
|
+
const explicit = process.env.SOFTR_AGENTS_API_URL;
|
|
22
|
+
if (explicit) return explicit.replace(/\/+$/, "");
|
|
23
|
+
if (!process.env.SOFTR_PLATFORM_API_URL) return AGENTS_PRODUCTION;
|
|
24
|
+
const platform = new URL(softrApiUrl("SOFTR_PLATFORM_API_URL"));
|
|
25
|
+
assert(PLATFORM_HOST.test(platform.hostname), () => `can't tell the agents API from ${platform.origin}, set SOFTR_AGENTS_API_URL`);
|
|
26
|
+
platform.hostname = platform.hostname.replace(PLATFORM_HOST, "agents-api");
|
|
27
|
+
return platform.origin;
|
|
28
|
+
}
|
|
29
|
+
function agentsFetch(path, init = {}) {
|
|
30
|
+
const token = readSessionToken();
|
|
31
|
+
return fetch(`${agentsApiUrl()}/v1/agents/${path}`, {
|
|
32
|
+
method: init.method ?? "GET",
|
|
33
|
+
signal: init.signal,
|
|
34
|
+
headers: {
|
|
35
|
+
"Content-Type": "application/json",
|
|
36
|
+
...token ? { Authorization: `Bearer ${token}` } : {},
|
|
37
|
+
"Softr-Application-ID": sessionConfig().applicationId,
|
|
38
|
+
...refererHeader(),
|
|
39
|
+
...init.headers
|
|
40
|
+
},
|
|
41
|
+
body: init.body === void 0 ? void 0 : JSON.stringify(init.body)
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
const chatSchema = z.object({
|
|
45
|
+
agentId: z.string().min(1),
|
|
46
|
+
message: z.string(),
|
|
47
|
+
sessionId: z.string().nullable(),
|
|
48
|
+
timezone: z.string(),
|
|
49
|
+
pageName: z.string(),
|
|
50
|
+
pageUrl: z.string(),
|
|
51
|
+
record: z.object({
|
|
52
|
+
id: z.string(),
|
|
53
|
+
fields: z.record(z.string(), z.unknown())
|
|
54
|
+
}).nullable()
|
|
55
|
+
});
|
|
56
|
+
/**
|
|
57
|
+
* Sends one message and streams the reply back as it comes, one JSON event per line.
|
|
58
|
+
*
|
|
59
|
+
* Takes FormData so the browser can call it with plain `fetch` and read the
|
|
60
|
+
* stream itself. A failed call passes the agents service's status and message on.
|
|
61
|
+
*/
|
|
62
|
+
const agentChatFn = createServerFn({ method: "POST" }).validator((data) => {
|
|
63
|
+
const payload = data.get("payload");
|
|
64
|
+
assert(typeof payload === "string", "agent chat: payload is required");
|
|
65
|
+
return chatSchema.parse(JSON.parse(payload));
|
|
66
|
+
}).handler(async ({ data }) => {
|
|
67
|
+
const upstream = await agentsFetch(`${encodeURIComponent(data.agentId)}/chat`, {
|
|
68
|
+
method: "POST",
|
|
69
|
+
signal: getRequest().signal,
|
|
70
|
+
headers: {
|
|
71
|
+
Accept: "application/x-ndjson",
|
|
72
|
+
"X-User-Timezone": data.timezone
|
|
73
|
+
},
|
|
74
|
+
body: {
|
|
75
|
+
message: data.message,
|
|
76
|
+
...data.sessionId ? { sessionId: data.sessionId } : {},
|
|
77
|
+
context: {
|
|
78
|
+
pageName: data.pageName,
|
|
79
|
+
pageUrl: data.pageUrl,
|
|
80
|
+
...data.record ? { currentRecord: { data: data.record } } : {}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
});
|
|
84
|
+
return new Response(upstream.body, {
|
|
85
|
+
status: upstream.status,
|
|
86
|
+
headers: { "Content-Type": upstream.headers.get("Content-Type") ?? "application/x-ndjson" }
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
const agentSchema = z.object({
|
|
90
|
+
id: z.string(),
|
|
91
|
+
title: z.string(),
|
|
92
|
+
avatar: z.string().nullish(),
|
|
93
|
+
thumbnail: z.string().nullish()
|
|
94
|
+
});
|
|
95
|
+
/**
|
|
96
|
+
* The agents the visitor may chat with in this app. The builder attaches them
|
|
97
|
+
* in Studio, and each one's visibility settings decide who sees it.
|
|
98
|
+
*/
|
|
99
|
+
const listAgents = createServerFn({ method: "GET" }).handler(async () => {
|
|
100
|
+
const token = readSessionToken();
|
|
101
|
+
const res = await fetch(`${softrApiUrl("SOFTR_PLATFORM_API_URL")}/v1/vibe/applications/${sessionConfig().applicationId}/agents`, { headers: token ? { Authorization: `Bearer ${token}` } : {} });
|
|
102
|
+
if (!res.ok) throw new Error(`Loading agents failed: ${await describeFailure(res)}`);
|
|
103
|
+
return z.array(agentSchema).parse(await res.json());
|
|
104
|
+
});
|
|
105
|
+
const listAgentChatsFn = createServerFn({ method: "POST" }).validator(z.object({ agentId: z.string().min(1) })).handler(async ({ data }) => {
|
|
106
|
+
const res = await agentsFetch(`${encodeURIComponent(data.agentId)}/sessions`);
|
|
107
|
+
if (!res.ok) throw new Error(`Loading chats failed: ${await describeFailure(res)}`);
|
|
108
|
+
return z.array(z.object({
|
|
109
|
+
id: z.string(),
|
|
110
|
+
title: z.string().nullable()
|
|
111
|
+
})).parse(await res.json());
|
|
112
|
+
});
|
|
113
|
+
const historySchema = z.object({
|
|
114
|
+
messages: z.array(z.object({
|
|
115
|
+
id: z.string(),
|
|
116
|
+
role: z.enum(["USER", "ASSISTANT"]),
|
|
117
|
+
content: z.string(),
|
|
118
|
+
createdAt: z.number()
|
|
119
|
+
})),
|
|
120
|
+
toolCalls: z.array(z.object({
|
|
121
|
+
id: z.string(),
|
|
122
|
+
messageId: z.string(),
|
|
123
|
+
toolName: z.string(),
|
|
124
|
+
input: z.string(),
|
|
125
|
+
createdAt: z.number(),
|
|
126
|
+
metadata: z.object({
|
|
127
|
+
innerThought: z.string().nullish(),
|
|
128
|
+
durationMs: z.number().nullish(),
|
|
129
|
+
failed: z.boolean().nullish()
|
|
130
|
+
})
|
|
131
|
+
}))
|
|
132
|
+
});
|
|
133
|
+
const CHAT_GONE = [
|
|
134
|
+
401,
|
|
135
|
+
403,
|
|
136
|
+
404,
|
|
137
|
+
410
|
|
138
|
+
];
|
|
139
|
+
/** What a past chat holds, or `null` when it's gone or belongs to someone else. */
|
|
140
|
+
const loadAgentChatFn = createServerFn({ method: "POST" }).validator(z.object({
|
|
141
|
+
agentId: z.string().min(1),
|
|
142
|
+
sessionId: z.string().min(1)
|
|
143
|
+
})).handler(async ({ data }) => {
|
|
144
|
+
const res = await agentsFetch(`${encodeURIComponent(data.agentId)}/sessions/${encodeURIComponent(data.sessionId)}`);
|
|
145
|
+
if (CHAT_GONE.includes(res.status)) return null;
|
|
146
|
+
if (!res.ok) throw new Error(`Loading the chat failed: ${await describeFailure(res)}`);
|
|
147
|
+
return historySchema.parse(await res.json());
|
|
148
|
+
});
|
|
149
|
+
/** Saves the visitor's answer. `false` when the chat is gone, see `loadAgentChatFn`. */
|
|
150
|
+
const decideAgentToolFn = createServerFn({ method: "POST" }).validator(z.object({
|
|
151
|
+
agentId: z.string().min(1),
|
|
152
|
+
sessionId: z.string().min(1),
|
|
153
|
+
toolCallId: z.string().min(1),
|
|
154
|
+
toolName: z.string().min(1),
|
|
155
|
+
decision: z.enum(["APPROVE", "REJECT"]),
|
|
156
|
+
scope: z.enum([
|
|
157
|
+
"ONCE",
|
|
158
|
+
"SESSION",
|
|
159
|
+
"USER"
|
|
160
|
+
])
|
|
161
|
+
})).handler(async ({ data: { agentId,...decision } }) => {
|
|
162
|
+
const res = await agentsFetch(`${encodeURIComponent(agentId)}/tool-permission-decisions`, {
|
|
163
|
+
method: "POST",
|
|
164
|
+
body: decision
|
|
165
|
+
});
|
|
166
|
+
if (CHAT_GONE.includes(res.status)) return false;
|
|
167
|
+
if (!res.ok) throw new Error(`Saving the answer failed: ${await describeFailure(res)}`);
|
|
168
|
+
return true;
|
|
169
|
+
});
|
|
170
|
+
const connectionSchema = z.object({
|
|
171
|
+
integration: z.string().min(1),
|
|
172
|
+
requestId: z.string().min(1)
|
|
173
|
+
});
|
|
174
|
+
function connectionUrl({ integration, requestId }, step) {
|
|
175
|
+
const { applicationId } = sessionConfig();
|
|
176
|
+
const provider = encodeURIComponent(integration.toLowerCase());
|
|
177
|
+
return `${`${softrApiUrl("SOFTR_DATASOURCE_API_URL")}/v1/datasource/applications/${applicationId}`}/integrations/${provider}/oauth/${step}?${new URLSearchParams({ requestId })}`;
|
|
178
|
+
}
|
|
179
|
+
/** The sign-in page to open in the popup. */
|
|
180
|
+
const startAgentConnectionFn = createServerFn({ method: "POST" }).validator(connectionSchema).handler(async ({ data }) => {
|
|
181
|
+
const token = readSessionToken();
|
|
182
|
+
const res = await fetch(connectionUrl(data, "register"), {
|
|
183
|
+
method: "POST",
|
|
184
|
+
headers: {
|
|
185
|
+
...token ? { Authorization: `Bearer ${token}` } : {},
|
|
186
|
+
...refererHeader()
|
|
187
|
+
}
|
|
188
|
+
});
|
|
189
|
+
if (!res.ok) throw new Error(`Starting the connection failed: ${await describeFailure(res)}`);
|
|
190
|
+
return z.object({ url: z.string() }).parse(await res.json()).url;
|
|
191
|
+
});
|
|
192
|
+
/** Waits a while for the visitor to finish signing in. `false` when they haven't yet. */
|
|
193
|
+
const awaitAgentConnectionFn = createServerFn({ method: "POST" }).validator(connectionSchema).handler(async ({ data }) => {
|
|
194
|
+
const res = await fetch(connectionUrl(data, "register-result"), { signal: getRequest().signal });
|
|
195
|
+
if (res.status === 503) return false;
|
|
196
|
+
if (!res.ok) throw new Error(`Connecting failed: ${await describeFailure(res)}`);
|
|
197
|
+
return true;
|
|
198
|
+
});
|
|
199
|
+
/** Tells the agent the account is connected. `false` when the chat is gone, see `loadAgentChatFn`. */
|
|
200
|
+
const finishAgentConnectionFn = createServerFn({ method: "POST" }).validator(z.object({
|
|
201
|
+
agentId: z.string().min(1),
|
|
202
|
+
sessionId: z.string().min(1),
|
|
203
|
+
toolCallId: z.string().min(1)
|
|
204
|
+
})).handler(async ({ data: { agentId,...completion } }) => {
|
|
205
|
+
const res = await agentsFetch(`${encodeURIComponent(agentId)}/integration-auth-completions`, {
|
|
206
|
+
method: "POST",
|
|
207
|
+
body: completion
|
|
208
|
+
});
|
|
209
|
+
if (CHAT_GONE.includes(res.status)) return false;
|
|
210
|
+
if (!res.ok) throw new Error(`Finishing the connection failed: ${await describeFailure(res)}`);
|
|
211
|
+
return true;
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
//#endregion
|
|
215
|
+
export { agentChatFn, awaitAgentConnectionFn, decideAgentToolFn, finishAgentConnectionFn, listAgentChatsFn, listAgents, loadAgentChatFn, startAgentConnectionFn };
|
|
@@ -0,0 +1,106 @@
|
|
|
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 };
|
|
@@ -0,0 +1,486 @@
|
|
|
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -16,5 +16,7 @@ import { useOverrides } from "./core/use-overrides.js";
|
|
|
16
16
|
import { useUserTimezone } from "./timezone.js";
|
|
17
17
|
import { PwaInstall, PwaPlatform, SoftrPwaHead, usePwaInstall } from "./pwa.js";
|
|
18
18
|
import { DefaultErrorOverlay } from "./default-error-overlay.js";
|
|
19
|
+
import { Agent, AgentChatSummary, listAgents } from "./agent/agent-fns.js";
|
|
20
|
+
import { AgentBlock, AgentChat, AgentChatOptions, AgentMessage, AgentQuestion, AgentTodo, AgentToolCall, useAgentChat } from "./agent/use-agent-chat.js";
|
|
19
21
|
import { Audience } from "./route/audience.js";
|
|
20
|
-
export { type ActionPermissions, Audience, type AuthOptions, type AuthSettings, AuthSettingsProvider, type DateOptions, type DateParts, type DateSeparator, type DateValue, DefaultErrorOverlay, type FieldShape, type FileAttachment, type FileItem, type FixedDateFormat, FormattedDate, type Formatting, FormattingScope, type Page, type PageSettings, type PwaInstall, type PwaPlatform, type SoftrContext, type SoftrDatasources, type SoftrFieldRegistry, SoftrPwaHead, type SoftrUserGroupId, type SoftrUserGroups, type SoftrUserProperties, type User, type WeekDay, assertRouteAccess, checkAccess, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
|
|
22
|
+
export { type ActionPermissions, type Agent, type AgentBlock, type AgentChat, type AgentChatOptions, type AgentChatSummary, type AgentMessage, type AgentQuestion, type AgentTodo, type AgentToolCall, Audience, type AuthOptions, type AuthSettings, AuthSettingsProvider, type DateOptions, type DateParts, type DateSeparator, type DateValue, DefaultErrorOverlay, type FieldShape, type FileAttachment, type FileItem, type FixedDateFormat, FormattedDate, type Formatting, FormattingScope, type Page, type PageSettings, type PwaInstall, type PwaPlatform, type SoftrContext, type SoftrDatasources, type SoftrFieldRegistry, SoftrPwaHead, type SoftrUserGroupId, type SoftrUserGroups, type SoftrUserProperties, type User, type WeekDay, assertRouteAccess, checkAccess, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, listAgents, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAgentChat, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
|
package/dist/index.js
CHANGED
|
@@ -12,6 +12,8 @@ import { fieldShape, formatDuration, formatField, formatValue, registerSoftrFiel
|
|
|
12
12
|
import { useOverrides } from "./core/use-overrides.js";
|
|
13
13
|
import { useUserTimezone } from "./timezone.js";
|
|
14
14
|
import { DefaultErrorOverlay } from "./default-error-overlay.js";
|
|
15
|
+
import { listAgents } from "./agent/agent-fns.js";
|
|
16
|
+
import { useAgentChat } from "./agent/use-agent-chat.js";
|
|
15
17
|
import { Audience } from "./route/audience.js";
|
|
16
18
|
|
|
17
|
-
export { Audience, AuthSettingsProvider, DefaultErrorOverlay, FormattedDate, FormattingScope, SoftrPwaHead, assertRouteAccess, checkAccess, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
|
|
19
|
+
export { Audience, AuthSettingsProvider, DefaultErrorOverlay, FormattedDate, FormattingScope, SoftrPwaHead, assertRouteAccess, checkAccess, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, listAgents, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAgentChat, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
|
package/dist/mcp.js
CHANGED
|
@@ -244,7 +244,8 @@ const WHOAMI = {
|
|
|
244
244
|
type: "object",
|
|
245
245
|
properties: {},
|
|
246
246
|
additionalProperties: false
|
|
247
|
-
}
|
|
247
|
+
},
|
|
248
|
+
annotations: { readOnlyHint: true }
|
|
248
249
|
};
|
|
249
250
|
/** How many records a read returns when the caller does not say. */
|
|
250
251
|
const DEFAULT_LIMIT = 20;
|
|
@@ -265,6 +266,7 @@ function describeTool(action) {
|
|
|
265
266
|
case "read": return {
|
|
266
267
|
name: action.id,
|
|
267
268
|
description: `Read records from "${action.id}". Returns the fields ${names.join(", ")}. Only records the signed-in user may see come back.`,
|
|
269
|
+
annotations: { readOnlyHint: true },
|
|
268
270
|
inputSchema: {
|
|
269
271
|
type: "object",
|
|
270
272
|
properties: {
|
|
@@ -385,8 +387,10 @@ async function rpc(request, origin, actions) {
|
|
|
385
387
|
const token = bearerToken(request);
|
|
386
388
|
if (token === null) return unauthorized(origin);
|
|
387
389
|
const session = await platformSession(token);
|
|
388
|
-
|
|
389
|
-
|
|
390
|
+
let sessionToken;
|
|
391
|
+
if (session.ok) sessionToken = session.sessionToken;
|
|
392
|
+
else if (session.refused && await resolveUser(token) !== null) sessionToken = token;
|
|
393
|
+
else return session.refused ? unauthorized(origin) : unavailable();
|
|
390
394
|
const body = await readJson(request);
|
|
391
395
|
const message = z.object({
|
|
392
396
|
id: z.union([z.string(), z.number()]).optional(),
|
package/dist/package.js
CHANGED
package/package.json
CHANGED
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: core
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
# Softr SDK core
|
|
@@ -49,6 +49,7 @@ Each sub-skill stands alone for its task and repeats the boundary above, so most
|
|
|
49
49
|
| Sign a visitor in, out, or up | [auth/SKILL.md](./auth/SKILL.md) |
|
|
50
50
|
| Call a connected third-party API (Slack, Stripe, Gmail, …) | [integrations/SKILL.md](./integrations/SKILL.md) |
|
|
51
51
|
| Open the app to AI assistants over MCP | [mcp/SKILL.md](./mcp/SKILL.md) |
|
|
52
|
+
| Let visitors chat with a Softr agent | [agent-chat/SKILL.md](./agent-chat/SKILL.md) |
|
|
52
53
|
| Let visitors install the app on their home screen | [pwa/SKILL.md](./pwa/SKILL.md) |
|
|
53
54
|
| Show a date, a time or a number | [formatting/SKILL.md](./formatting/SKILL.md) |
|
|
54
55
|
|
|
@@ -85,6 +86,9 @@ Calling a connected third-party API (Slack, Stripe, Gmail, Google Calendar, …)
|
|
|
85
86
|
Opening the app to an AI assistant over MCP?
|
|
86
87
|
load softr-sdk/mcp
|
|
87
88
|
|
|
89
|
+
Adding a chat with one of the app's Softr agents, or a Connect button for the visitor's account it needs?
|
|
90
|
+
load softr-sdk/agent-chat
|
|
91
|
+
|
|
88
92
|
Adding an install button, or making the app installable?
|
|
89
93
|
load softr-sdk/pwa
|
|
90
94
|
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: agent-chat
|
|
3
|
+
description: >-
|
|
4
|
+
Let visitors chat with one of the app's Softr agents: listAgents() from
|
|
5
|
+
@softr/sdk gives the agents the visitor may use, and useAgentChat(agentId, {
|
|
6
|
+
record }) returns the messages, the reply as it streams, past chats, and
|
|
7
|
+
send, stop, approve, reject and connect, with no UI. Load it for an agent
|
|
8
|
+
chat panel, approving the agent's actions, or connecting the visitor's own
|
|
9
|
+
account (Gmail, Slack…) that a tool needs. Build the chat from the app's own
|
|
10
|
+
components. The agent acts on the app's data through the app's MCP, so
|
|
11
|
+
softrMcpMiddleware must list the actions it may use.
|
|
12
|
+
metadata:
|
|
13
|
+
type: sub-skill
|
|
14
|
+
library: softr-sdk
|
|
15
|
+
library_version: 0.0.90-alpha.1
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
**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.
|
|
19
|
+
|
|
20
|
+
# Agent chat
|
|
21
|
+
|
|
22
|
+
A Softr agent is set up in Studio's Agents tab and attached to the app there. The app gives it a chat. There is no ready-made chat widget: the hook gives the state, and the app draws it with its own components.
|
|
23
|
+
|
|
24
|
+
## Setup
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import { listAgents, useAgentChat } from '@softr/sdk'
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`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, never write one by hand.
|
|
31
|
+
|
|
32
|
+
## Core pattern
|
|
33
|
+
|
|
34
|
+
```tsx
|
|
35
|
+
// agentId comes from listAgents() in the route's loader.
|
|
36
|
+
function AgentPanel({ agentId, ticket }: { agentId: string; ticket: Ticket | null }) {
|
|
37
|
+
const chat = useAgentChat(agentId, {
|
|
38
|
+
record: ticket && { id: ticket.id, fields: { Title: ticket.title, Status: ticket.status } },
|
|
39
|
+
})
|
|
40
|
+
const [draft, setDraft] = useState('')
|
|
41
|
+
|
|
42
|
+
return (
|
|
43
|
+
<>
|
|
44
|
+
{chat.messages.map((message) => (
|
|
45
|
+
<Message key={message.id} message={message} onApprove={chat.approve} onReject={chat.reject} />
|
|
46
|
+
))}
|
|
47
|
+
{chat.error && <p role="alert">{chat.error.message}</p>}
|
|
48
|
+
<form onSubmit={(e) => { e.preventDefault(); chat.send(draft); setDraft('') }}>
|
|
49
|
+
<Textarea value={draft} onChange={(e) => setDraft(e.target.value)} />
|
|
50
|
+
{chat.status === 'idle'
|
|
51
|
+
? <Button type="submit">Send</Button>
|
|
52
|
+
: <Button type="button" onClick={chat.stop}>Stop</Button>}
|
|
53
|
+
</form>
|
|
54
|
+
</>
|
|
55
|
+
)
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## What the hook returns
|
|
60
|
+
|
|
61
|
+
- `messages`: the whole chat, oldest first. While the agent answers, its reply is the last message and grows as it streams. A tool waiting for Approve or Connect comes last in its message, so render blocks in the order given.
|
|
62
|
+
- `status`: `thinking` until the first part of the reply arrives, `replying` until it ends, then `idle`. Show a typing hint while it's `thinking`.
|
|
63
|
+
- `loading`: `true` while a past chat loads. Show a spinner, not the empty-chat greeting.
|
|
64
|
+
- `error`: why the last request failed, or `null`.
|
|
65
|
+
- `send(text)`, `stop()`, `newChat()`.
|
|
66
|
+
- `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.
|
|
67
|
+
- `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.
|
|
68
|
+
- `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.
|
|
69
|
+
|
|
70
|
+
## Rendering a message
|
|
71
|
+
|
|
72
|
+
Each message has `role` (`user` or `assistant`) and `blocks`, in the order the agent produced them. Render every block type:
|
|
73
|
+
|
|
74
|
+
| Block | Show it as |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| `text` | Markdown text |
|
|
77
|
+
| `tool` | One line: the tool `name` and its `status`. Collapse finished ones. Expanded, show `thought`, `input`, `error` and `durationMs`. |
|
|
78
|
+
| `todo` | A checklist of the agent's plan. It updates in place. |
|
|
79
|
+
| `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 ", ". |
|
|
80
|
+
| `error` | An error line inside the reply |
|
|
81
|
+
|
|
82
|
+
A `tool` with status `awaiting-approval` blocks the agent until the visitor answers. Give it a split Approve button and a Reject button, as classic apps do. 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 has to approve the same action again on every call. The agent continues on its own after an approval.
|
|
83
|
+
|
|
84
|
+
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. Any integration works the same way, so don't build one per integration.
|
|
85
|
+
|
|
86
|
+
## The chat panel
|
|
87
|
+
|
|
88
|
+
Classic Softr apps ship a chat panel. Visitors expect the same from yours:
|
|
89
|
+
|
|
90
|
+
- A round `primary` button in a corner opens it: about 56px, a soft shadow, the agent's avatar or a chat icon. It hides while the panel is open.
|
|
91
|
+
- The panel opens on the right on desktop, about 420px wide with a left border and a large shadow, and full screen on mobile.
|
|
92
|
+
- The header shows the agent's avatar and name, a picker when there are several agents, new chat, past chats and close.
|
|
93
|
+
- An empty chat greets the visitor with the agent's avatar.
|
|
94
|
+
- The list scrolls to the newest message as the reply streams, until the visitor scrolls up. Then a button takes them back down.
|
|
95
|
+
- Text renders as Markdown, tables included.
|
|
96
|
+
- The input says "Ask {agent title}…". Enter sends. Shift+Enter adds a line.
|
|
97
|
+
- A line under the input: "AI can make mistakes. Please double-check responses."
|
|
98
|
+
- An answered question stays locked.
|
|
99
|
+
- A tool's `input` is JSON. Show it readable: one `Label: value` line per field, with line breaks kept, never the raw JSON. Leave out `thought`, `input`, `error` or the duration when it's empty.
|
|
100
|
+
- A tool that needs the visitor's account shows a Connect button.
|
|
101
|
+
|
|
102
|
+
## How it looks
|
|
103
|
+
|
|
104
|
+
The chat is the visitor's first impression of the agent. These are defaults for the first build. When the builder asks for a different look, follow them instead.
|
|
105
|
+
|
|
106
|
+
- **The app's own look.** Build it from the app's own primitives and match its pages, so it never reads as a third-party widget.
|
|
107
|
+
- **One loud thing at a time.** The answer is the content. Tool lines stay quiet. Only a block that waits for the visitor (approve, connect, question) stands out.
|
|
108
|
+
- **Layout.** Three zones: a fixed header, the scrolling messages, a fixed composer. Use `text-sm` throughout.
|
|
109
|
+
- **Header.** A small round avatar, the agent's name, and a muted line under it (the agent picker, when there are several). Actions are ghost icon buttons with tooltips.
|
|
110
|
+
- **Visitor messages.** Right-aligned bubbles in `primary`, generously rounded, at most 85% wide.
|
|
111
|
+
- **Agent replies.** No bubble. Full width on the background, with a small avatar at the start of each reply, so long answers and tables read like a page.
|
|
112
|
+
- **Markdown.** Comfortable paragraph and list spacing. Inline code on `muted`. Tables bordered, in a horizontal scroll wrapper, never wider than the panel. Links in `primary`.
|
|
113
|
+
- **Tools.** One `text-xs` muted line with a status icon: a spinner while running, a check when done, an alert on error. Click to expand.
|
|
114
|
+
- **Blocks that wait for the visitor.** A `card` with a border, a rounded corner and padding: a one-line title, a short explanation, buttons on the right. The main action is `primary`, the other `outline`.
|
|
115
|
+
- **Thinking.** Where the reply will appear, a muted "Thinking…" with a gentle pulse or shimmer.
|
|
116
|
+
- **Empty chat.** Centred: a large avatar, "Hi, I'm {agent title}", one muted line inviting a question. Add two to four suggestion chips only when the builder said what the agent does; they send on click.
|
|
117
|
+
- **Composer.** One rounded, bordered box that holds the textarea and an icon send button in its corner, with the focus ring on the box. The textarea grows to about six lines, then scrolls. The disclaimer sits under it in `text-xs` muted, centred.
|
|
118
|
+
- **Spacing.** Clear space between turns, tight space inside a turn.
|
|
119
|
+
- **Motion.** The panel slides in and new messages fade in, both short, and they respect reduced motion. Nothing bounces.
|
|
120
|
+
|
|
121
|
+
## Context
|
|
122
|
+
|
|
123
|
+
`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.
|
|
124
|
+
|
|
125
|
+
The page title and URL go along on their own. Nothing else about the page does, so don't try to send whole lists.
|
|
126
|
+
|
|
127
|
+
## Letting the agent act on the app
|
|
128
|
+
|
|
129
|
+
The agent reads and changes data through the app's own MCP, as the visitor who is chatting. Their groups and each action's `permissions` apply. The actions it may use are the ones listed in `softrMcpMiddleware`. With no MCP wired, the agent can only talk. Load [mcp/SKILL.md](../mcp/SKILL.md) to wire it.
|
|
130
|
+
|
|
131
|
+
## Failure modes
|
|
132
|
+
|
|
133
|
+
**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`.
|
|
134
|
+
|
|
135
|
+
**Rendering only `text` blocks.** A tool waiting for approval never shows, and the agent waits forever. Render every block type.
|
|
136
|
+
|
|
137
|
+
**The hook inside a panel that unmounts when it closes.** Closing it stops a reply that is still coming. Call `useAgentChat` in the component that owns the open state, such as `AppLayout` in `src/routes/_app.tsx`, and pass `chat` into the panel. Keep the selected agent there too, or closing the panel resets it.
|
|
138
|
+
|
|
139
|
+
**An agent id written by hand.** The chat fails on the first message, and an agent hidden from the visitor still shows. Take the id from `listAgents`.
|
|
140
|
+
|
|
141
|
+
## References
|
|
142
|
+
|
|
143
|
+
- [mcp/SKILL.md](../mcp/SKILL.md): the actions the agent may call
|
|
144
|
+
- [current-user/SKILL.md](../current-user/SKILL.md): showing the chat to signed-in visitors only
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `auth` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build.
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.
|
|
@@ -7,7 +7,7 @@ description: >-
|
|
|
7
7
|
metadata:
|
|
8
8
|
type: sub-skill
|
|
9
9
|
library: softr-sdk
|
|
10
|
-
library_version: 0.0.
|
|
10
|
+
library_version: 0.0.90-alpha.1
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
**Boundary.** `upload` lives on `@softr/sdk/server` and runs inside server functions. `useFileUpload` and `FileItem` live on `@softr/sdk` and run in components. `FileAttachment` comes from `@softr/sdk` and can be imported anywhere.
|
|
@@ -7,7 +7,7 @@ description: >-
|
|
|
7
7
|
metadata:
|
|
8
8
|
type: sub-skill
|
|
9
9
|
library: softr-sdk
|
|
10
|
-
library_version: 0.0.
|
|
10
|
+
library_version: 0.0.90-alpha.1
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
**Boundary.** `integration` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineIntegration` and every type come from `@softr/sdk` and can be imported anywhere.
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `softrMcpMiddleware` lives on `@softr/sdk` and is registered once, in `src/start.ts`. The actions you hand it are the same `defineQuery` / `defineMutation` values the app's own pages use — declared wherever they already live, not duplicated for MCP.
|
|
@@ -8,7 +8,7 @@ description: >-
|
|
|
8
8
|
metadata:
|
|
9
9
|
type: sub-skill
|
|
10
10
|
library: softr-sdk
|
|
11
|
-
library_version: 0.0.
|
|
11
|
+
library_version: 0.0.90-alpha.1
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
**Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineMutation` and every type come from `@softr/sdk` and can be imported anywhere.
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. The same holds for any helper that calls `ds`: declare it inside the handler. A function at module level that calls `ds` keeps the server-only import in the browser bundle, and every page stops loading until it moves. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `definePage`, `pageHead`, the access functions and the error predicates come from `@softr/sdk` and work anywhere.
|
|
@@ -9,7 +9,7 @@ description: >-
|
|
|
9
9
|
metadata:
|
|
10
10
|
type: sub-skill
|
|
11
11
|
library: softr-sdk
|
|
12
|
-
library_version: 0.0.
|
|
12
|
+
library_version: 0.0.90-alpha.1
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
**Boundary.** `workflow` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineWorkflow` and every type come from `@softr/sdk` and can be imported anywhere.
|