@raybase/guide 0.0.1 → 0.1.2
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/LICENSE +21 -0
- package/dist/cli.d.ts +8 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +9 -0
- package/dist/cli.js.map +1 -0
- package/dist/guide-client.d.ts +48 -0
- package/dist/guide-client.d.ts.map +1 -0
- package/dist/guide-client.js +202 -0
- package/dist/guide-client.js.map +1 -0
- package/dist/guide-corpus.d.ts +64 -0
- package/dist/guide-corpus.d.ts.map +1 -0
- package/dist/guide-corpus.js +113 -0
- package/dist/guide-corpus.js.map +1 -0
- package/dist/guide-tables.d.ts +4 -0
- package/dist/guide-tables.d.ts.map +1 -0
- package/dist/guide-tables.js +17 -0
- package/dist/guide-tables.js.map +1 -0
- package/dist/guide.d.ts +164 -0
- package/dist/guide.d.ts.map +1 -0
- package/dist/guide.js +348 -0
- package/dist/guide.js.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/install.d.ts +28 -0
- package/dist/install.d.ts.map +1 -0
- package/dist/install.js +18 -0
- package/dist/install.js.map +1 -0
- package/dist/runtime.d.ts +19 -0
- package/dist/runtime.d.ts.map +1 -0
- package/dist/runtime.js +136 -0
- package/dist/runtime.js.map +1 -0
- package/package.json +49 -8
- package/templates/astro-emdash/content/guide/capability-map.md +17 -0
- package/templates/astro-emdash/src/components/guide-widget.tsx +41 -0
- package/templates/astro-emdash/src/guide/actions.ts +8 -0
- package/templates/astro-emdash/src/guide/config.ts +21 -0
- package/templates/astro-emdash/src/guide/corpus.gen.ts +4 -0
- package/templates/astro-emdash/src/guide/corpus.manifest.json +72 -0
- package/templates/astro-emdash/src/guide/corpus.ts +4 -0
- package/templates/astro-emdash/src/guide/resources.json +4 -0
- package/templates/react-router/app/components/guide-widget.tsx +29 -0
- package/templates/react-router/app/guide/actions.ts +3 -0
- package/templates/react-router/app/guide/config.ts +21 -0
- package/templates/react-router/app/guide/corpus.gen.ts +4 -0
- package/templates/react-router/app/guide/corpus.manifest.json +22 -0
- package/templates/react-router/app/guide/corpus.ts +4 -0
- package/templates/react-router/app/guide/resources.json +4 -0
- package/templates/react-router/content/guide/capability-map.md +13 -0
- package/templates/tanstack-start/content/guide/capability-map.md +17 -0
- package/templates/tanstack-start/src/components/guide-widget.tsx +41 -0
- package/templates/tanstack-start/src/guide/actions.ts +17 -0
- package/templates/tanstack-start/src/guide/config.ts +21 -0
- package/templates/tanstack-start/src/guide/corpus.gen.ts +4 -0
- package/templates/tanstack-start/src/guide/corpus.manifest.json +22 -0
- package/templates/tanstack-start/src/guide/corpus.ts +4 -0
- package/templates/tanstack-start/src/guide/resources.json +4 -0
- package/README.md +0 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Itself & Co
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,OAAO,CAAC;IACZ,WAAW,EAAE,gBAAgB,CAAC;IAC9B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,wBAAgB,cAAc,IAAI,cAAc,CAO/C"}
|
package/dist/cli.js
ADDED
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,EAAE,EAAE,OAAO;QACX,WAAW,EAAE,gBAAgB;QAC7B,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,aAAa,EAAE,cAAc,CAAC;QAC1E,WAAW,EAAE,CAAC,OAAO,CAAC;KACvB,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
export type GuideClientMessagePart = {
|
|
2
|
+
type: "text";
|
|
3
|
+
text: string;
|
|
4
|
+
} | {
|
|
5
|
+
type: string;
|
|
6
|
+
id?: string;
|
|
7
|
+
data?: unknown;
|
|
8
|
+
[key: string]: unknown;
|
|
9
|
+
};
|
|
10
|
+
export type GuideClientTurnRequest = {
|
|
11
|
+
conversationId?: string;
|
|
12
|
+
message: string;
|
|
13
|
+
title?: string;
|
|
14
|
+
route?: string;
|
|
15
|
+
surface?: string;
|
|
16
|
+
};
|
|
17
|
+
export type GuideClientConversation = {
|
|
18
|
+
agentName: string;
|
|
19
|
+
conversationId: string;
|
|
20
|
+
runtime: "ai-chat";
|
|
21
|
+
triggerType: "chat";
|
|
22
|
+
basePath: string;
|
|
23
|
+
expiresAt: string;
|
|
24
|
+
conversationToken: string;
|
|
25
|
+
webSocketToken?: string;
|
|
26
|
+
};
|
|
27
|
+
export type GuideClientTurnResponse = {
|
|
28
|
+
agentName: string;
|
|
29
|
+
conversationId: string;
|
|
30
|
+
requestId: string;
|
|
31
|
+
status: string;
|
|
32
|
+
text: string;
|
|
33
|
+
parts: GuideClientMessagePart[];
|
|
34
|
+
error?: string;
|
|
35
|
+
};
|
|
36
|
+
export type GuideClientTurnOptions = {
|
|
37
|
+
signal?: AbortSignal;
|
|
38
|
+
timeoutMs?: number;
|
|
39
|
+
};
|
|
40
|
+
export declare function createGuideClient(options?: {
|
|
41
|
+
endpoint?: string;
|
|
42
|
+
agentName?: string;
|
|
43
|
+
fetch?: typeof fetch;
|
|
44
|
+
}): {
|
|
45
|
+
bootstrap: (input?: Omit<GuideClientTurnRequest, "message">) => Promise<GuideClientConversation>;
|
|
46
|
+
turn(input: GuideClientTurnRequest, turnOptions?: GuideClientTurnOptions): Promise<GuideClientTurnResponse>;
|
|
47
|
+
};
|
|
48
|
+
//# sourceMappingURL=guide-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-client.d.ts","sourceRoot":"","sources":["../src/guide-client.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AA0BF,wBAAgB,iBAAiB,CAAC,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CAAO;wBAK7E,IAAI,CAAC,sBAAsB,EAAE,SAAS,CAAC,KAAQ,OAAO,CAAC,uBAAuB,CAAC;gBAqB3F,sBAAsB,gBAAe,sBAAsB,GAAQ,OAAO,CAAC,uBAAuB,CAAC;EAkGxH"}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
const defaultGuideTurnTimeoutMs = 120_000;
|
|
2
|
+
const initialGuidePollDelayMs = 250;
|
|
3
|
+
const maximumGuidePollDelayMs = 2_000;
|
|
4
|
+
export function createGuideClient(options = {}) {
|
|
5
|
+
const agentName = options.agentName ?? "guide";
|
|
6
|
+
const endpoint = (options.endpoint ?? "/api/raybase/agents").replace(/\/$/, "");
|
|
7
|
+
const fetcher = options.fetch ?? fetch;
|
|
8
|
+
async function bootstrap(input = {}) {
|
|
9
|
+
const response = await fetcher(`${endpoint}/${encodeURIComponent(agentName)}/conversations`, {
|
|
10
|
+
method: "POST",
|
|
11
|
+
credentials: "include",
|
|
12
|
+
headers: guideHeaders(input),
|
|
13
|
+
body: JSON.stringify({
|
|
14
|
+
conversationId: input.conversationId,
|
|
15
|
+
title: input.title,
|
|
16
|
+
route: input.route,
|
|
17
|
+
surface: input.surface
|
|
18
|
+
})
|
|
19
|
+
});
|
|
20
|
+
const body = await response.json().catch(() => ({}));
|
|
21
|
+
if (!response.ok || !body.conversationId || !body.basePath || !body.conversationToken) {
|
|
22
|
+
throw new Error(body.error ?? `Guide conversation bootstrap failed with ${response.status}`);
|
|
23
|
+
}
|
|
24
|
+
return body;
|
|
25
|
+
}
|
|
26
|
+
return {
|
|
27
|
+
bootstrap,
|
|
28
|
+
async turn(input, turnOptions = {}) {
|
|
29
|
+
const timeoutMs = normalizeGuideTurnTimeout(turnOptions.timeoutMs);
|
|
30
|
+
const deadline = Date.now() + timeoutMs;
|
|
31
|
+
const controller = new AbortController();
|
|
32
|
+
let timedOut = false;
|
|
33
|
+
const abortFromCaller = () => controller.abort(turnOptions.signal?.reason);
|
|
34
|
+
if (turnOptions.signal?.aborted)
|
|
35
|
+
abortFromCaller();
|
|
36
|
+
else
|
|
37
|
+
turnOptions.signal?.addEventListener("abort", abortFromCaller, { once: true });
|
|
38
|
+
const timeout = setTimeout(() => {
|
|
39
|
+
timedOut = true;
|
|
40
|
+
controller.abort();
|
|
41
|
+
}, timeoutMs);
|
|
42
|
+
try {
|
|
43
|
+
const conversation = await bootstrapWithSignal(input, controller.signal);
|
|
44
|
+
const requestKey = guideRequestKey();
|
|
45
|
+
const requestBasePath = conversation.basePath.replace(/\/chat\/?$/, "");
|
|
46
|
+
const sendResponse = await fetcher(`${requestBasePath}/messages`, {
|
|
47
|
+
method: "POST",
|
|
48
|
+
credentials: "include",
|
|
49
|
+
signal: controller.signal,
|
|
50
|
+
headers: {
|
|
51
|
+
...guideHeaders(input),
|
|
52
|
+
authorization: `Bearer ${conversation.conversationToken}`
|
|
53
|
+
},
|
|
54
|
+
body: JSON.stringify({ message: input.message, requestKey })
|
|
55
|
+
});
|
|
56
|
+
const sendBody = await sendResponse.json().catch(() => ({}));
|
|
57
|
+
if (!sendResponse.ok || sendBody.requestKey !== requestKey) {
|
|
58
|
+
throw new Error(sendBody.error ?? `Guide turn send failed with ${sendResponse.status}`);
|
|
59
|
+
}
|
|
60
|
+
let pollDelayMs = initialGuidePollDelayMs;
|
|
61
|
+
for (;;) {
|
|
62
|
+
assertGuideTurnActive(controller.signal, timedOut, timeoutMs);
|
|
63
|
+
const statusResponse = await fetcher(`${requestBasePath}/requests/${encodeURIComponent(requestKey)}`, {
|
|
64
|
+
method: "GET",
|
|
65
|
+
credentials: "include",
|
|
66
|
+
signal: controller.signal,
|
|
67
|
+
headers: {
|
|
68
|
+
...guideHeaders(input),
|
|
69
|
+
authorization: `Bearer ${conversation.conversationToken}`
|
|
70
|
+
}
|
|
71
|
+
});
|
|
72
|
+
const status = await statusResponse.json().catch(() => ({}));
|
|
73
|
+
if (!statusResponse.ok) {
|
|
74
|
+
throw new Error(status.error ?? `Guide turn status failed with ${statusResponse.status}`);
|
|
75
|
+
}
|
|
76
|
+
const terminal = guideTurnResponse(conversation, requestKey, status);
|
|
77
|
+
if (terminal)
|
|
78
|
+
return terminal;
|
|
79
|
+
const remainingMs = deadline - Date.now();
|
|
80
|
+
if (remainingMs <= 0)
|
|
81
|
+
throw guideTurnTimeoutError(timeoutMs);
|
|
82
|
+
await abortableDelay(Math.min(pollDelayMs, remainingMs), controller.signal);
|
|
83
|
+
pollDelayMs = Math.min(pollDelayMs * 2, maximumGuidePollDelayMs);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
catch (error) {
|
|
87
|
+
if (timedOut)
|
|
88
|
+
throw guideTurnTimeoutError(timeoutMs);
|
|
89
|
+
if (turnOptions.signal?.aborted) {
|
|
90
|
+
throw turnOptions.signal.reason instanceof Error
|
|
91
|
+
? turnOptions.signal.reason
|
|
92
|
+
: new DOMException("The Guide turn was aborted", "AbortError");
|
|
93
|
+
}
|
|
94
|
+
throw error;
|
|
95
|
+
}
|
|
96
|
+
finally {
|
|
97
|
+
clearTimeout(timeout);
|
|
98
|
+
turnOptions.signal?.removeEventListener("abort", abortFromCaller);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
};
|
|
102
|
+
async function bootstrapWithSignal(input, signal) {
|
|
103
|
+
const response = await fetcher(`${endpoint}/${encodeURIComponent(agentName)}/conversations`, {
|
|
104
|
+
method: "POST",
|
|
105
|
+
credentials: "include",
|
|
106
|
+
signal,
|
|
107
|
+
headers: guideHeaders(input),
|
|
108
|
+
body: JSON.stringify({
|
|
109
|
+
conversationId: input.conversationId,
|
|
110
|
+
title: input.title,
|
|
111
|
+
route: input.route,
|
|
112
|
+
surface: input.surface
|
|
113
|
+
})
|
|
114
|
+
});
|
|
115
|
+
const body = await response.json().catch(() => ({}));
|
|
116
|
+
if (!response.ok || !body.conversationId || !body.basePath || !body.conversationToken) {
|
|
117
|
+
throw new Error(body.error ?? `Guide conversation bootstrap failed with ${response.status}`);
|
|
118
|
+
}
|
|
119
|
+
return body;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
function guideHeaders(input = {}) {
|
|
123
|
+
const headers = { "content-type": "application/json" };
|
|
124
|
+
if (input.route)
|
|
125
|
+
headers["x-raybase-agent-route"] = input.route;
|
|
126
|
+
if (input.surface)
|
|
127
|
+
headers["x-raybase-agent-surface"] = input.surface;
|
|
128
|
+
return headers;
|
|
129
|
+
}
|
|
130
|
+
function guideTurnResponse(conversation, requestKey, status) {
|
|
131
|
+
const run = status.run;
|
|
132
|
+
if (!run) {
|
|
133
|
+
if (status.disposition !== "ignored")
|
|
134
|
+
return null;
|
|
135
|
+
return {
|
|
136
|
+
agentName: conversation.agentName,
|
|
137
|
+
conversationId: conversation.conversationId,
|
|
138
|
+
requestId: requestKey,
|
|
139
|
+
status: "ignored",
|
|
140
|
+
text: "",
|
|
141
|
+
parts: []
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
if (run.status === "queued" || run.status === "running")
|
|
145
|
+
return null;
|
|
146
|
+
if (run.status === "failed") {
|
|
147
|
+
throw new Error(run.error || "Guide turn failed");
|
|
148
|
+
}
|
|
149
|
+
const dropped = run.status === "completed" && run.delivery?.verdict === "drop";
|
|
150
|
+
const text = dropped ? "" : run.text ?? "";
|
|
151
|
+
const parts = dropped
|
|
152
|
+
? []
|
|
153
|
+
: Array.isArray(run.parts)
|
|
154
|
+
? run.parts
|
|
155
|
+
: text
|
|
156
|
+
? [{ type: "text", text }]
|
|
157
|
+
: [];
|
|
158
|
+
return {
|
|
159
|
+
agentName: conversation.agentName,
|
|
160
|
+
conversationId: conversation.conversationId,
|
|
161
|
+
requestId: run.requestId,
|
|
162
|
+
status: dropped ? "dropped" : run.status,
|
|
163
|
+
text,
|
|
164
|
+
parts
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
function normalizeGuideTurnTimeout(value) {
|
|
168
|
+
if (value === undefined)
|
|
169
|
+
return defaultGuideTurnTimeoutMs;
|
|
170
|
+
if (!Number.isFinite(value) || value <= 0)
|
|
171
|
+
throw new Error("Guide turn timeoutMs must be a positive number");
|
|
172
|
+
return value;
|
|
173
|
+
}
|
|
174
|
+
function guideRequestKey() {
|
|
175
|
+
return `guide_${crypto.randomUUID()}`;
|
|
176
|
+
}
|
|
177
|
+
function guideTurnTimeoutError(timeoutMs) {
|
|
178
|
+
return new Error(`Guide turn timed out after ${timeoutMs}ms`);
|
|
179
|
+
}
|
|
180
|
+
function assertGuideTurnActive(signal, timedOut, timeoutMs) {
|
|
181
|
+
if (!signal.aborted)
|
|
182
|
+
return;
|
|
183
|
+
if (timedOut)
|
|
184
|
+
throw guideTurnTimeoutError(timeoutMs);
|
|
185
|
+
throw signal.reason instanceof Error
|
|
186
|
+
? signal.reason
|
|
187
|
+
: new DOMException("The Guide turn was aborted", "AbortError");
|
|
188
|
+
}
|
|
189
|
+
function abortableDelay(ms, signal) {
|
|
190
|
+
return new Promise((resolve, reject) => {
|
|
191
|
+
if (signal.aborted) {
|
|
192
|
+
reject(signal.reason instanceof Error ? signal.reason : new DOMException("Aborted", "AbortError"));
|
|
193
|
+
return;
|
|
194
|
+
}
|
|
195
|
+
const timeout = setTimeout(resolve, ms);
|
|
196
|
+
signal.addEventListener("abort", () => {
|
|
197
|
+
clearTimeout(timeout);
|
|
198
|
+
reject(signal.reason instanceof Error ? signal.reason : new DOMException("Aborted", "AbortError"));
|
|
199
|
+
}, { once: true });
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
//# sourceMappingURL=guide-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-client.js","sourceRoot":"","sources":["../src/guide-client.ts"],"names":[],"mappings":"AA0DA,MAAM,yBAAyB,GAAG,OAAO,CAAC;AAC1C,MAAM,uBAAuB,GAAG,GAAG,CAAC;AACpC,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,MAAM,UAAU,iBAAiB,CAAC,UAA2E,EAAE;IAC7G,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC;IAC/C,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,qBAAqB,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChF,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IAEvC,KAAK,UAAU,SAAS,CAAC,QAAiD,EAAE;QAC1E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,QAAQ,IAAI,kBAAkB,CAAC,SAAS,CAAC,gBAAgB,EAAE;YAC3F,MAAM,EAAE,MAAM;YACd,WAAW,EAAE,SAAS;YACtB,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC;YAC5B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,cAAc,EAAE,KAAK,CAAC,cAAc;gBACpC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC;SACH,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAA0D,CAAC;QAC9G,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACtF,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,4CAA4C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,IAA+B,CAAC;IACzC,CAAC;IAED,OAAO;QACL,SAAS;QACT,KAAK,CAAC,IAAI,CAAC,KAA6B,EAAE,cAAsC,EAAE;YAChF,MAAM,SAAS,GAAG,yBAAyB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YACxC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC3E,IAAI,WAAW,CAAC,MAAM,EAAE,OAAO;gBAAE,eAAe,EAAE,CAAC;;gBAC9C,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACpF,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC9B,QAAQ,GAAG,IAAI,CAAC;gBAChB,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;gBACzE,MAAM,UAAU,GAAG,eAAe,EAAE,CAAC;gBACrC,MAAM,eAAe,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBACxE,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,eAAe,WAAW,EAAE;oBAChE,MAAM,EAAE,MAAM;oBACd,WAAW,EAAE,SAAS;oBACtB,MAAM,EAAE,UAAU,CAAC,MAAM;oBACzB,OAAO,EAAE;wBACP,GAAG,YAAY,CAAC,KAAK,CAAC;wBACtB,aAAa,EAAE,UAAU,YAAY,CAAC,iBAAiB,EAAE;qBAC1D;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;iBAC7D,CAAC,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAG1D,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;oBAC3D,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,+BAA+B,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC1F,CAAC;gBAED,IAAI,WAAW,GAAG,uBAAuB,CAAC;gBAC1C,SAAS,CAAC;oBACR,qBAAqB,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;oBAC9D,MAAM,cAAc,GAAG,MAAM,OAAO,CAClC,GAAG,eAAe,aAAa,kBAAkB,CAAC,UAAU,CAAC,EAAE,EAC/D;wBACE,MAAM,EAAE,KAAK;wBACb,WAAW,EAAE,SAAS;wBACtB,MAAM,EAAE,UAAU,CAAC,MAAM;wBACzB,OAAO,EAAE;4BACP,GAAG,YAAY,CAAC,KAAK,CAAC;4BACtB,aAAa,EAAE,UAAU,YAAY,CAAC,iBAAiB,EAAE;yBAC1D;qBACF,CACF,CAAC;oBACF,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAqD,CAAC;oBACjH,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;wBACvB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,iCAAiC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;oBAC5F,CAAC;oBACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,YAAY,EAAE,UAAU,EAAE,MAA4B,CAAC,CAAC;oBAC3F,IAAI,QAAQ;wBAAE,OAAO,QAAQ,CAAC;oBAE9B,MAAM,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC1C,IAAI,WAAW,IAAI,CAAC;wBAAE,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;oBAC7D,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;oBAC5E,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,CAAC,EAAE,uBAAuB,CAAC,CAAC;gBACnE,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,QAAQ;oBAAE,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;gBACrD,IAAI,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;oBAChC,MAAM,WAAW,CAAC,MAAM,CAAC,MAAM,YAAY,KAAK;wBAC9C,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM;wBAC3B,CAAC,CAAC,IAAI,YAAY,CAAC,4BAA4B,EAAE,YAAY,CAAC,CAAC;gBACnE,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;KACF,CAAC;IAEF,KAAK,UAAU,mBAAmB,CAChC,KAA8C,EAC9C,MAAmB;QAEnB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,QAAQ,IAAI,kBAAkB,CAAC,SAAS,CAAC,gBAAgB,EAAE;YAC3F,MAAM,EAAE,MAAM;YACd,WAAW,EAAE,SAAS;YACtB,MAAM;YACN,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC;YAC5B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,cAAc,EAAE,KAAK,CAAC,cAAc;gBACpC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC;SACH,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAA0D,CAAC;QAC9G,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACtF,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,4CAA4C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,IAA+B,CAAC;IACzC,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,QAA8C,EAAE;IACpE,MAAM,OAAO,GAA2B,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;IAC/E,IAAI,KAAK,CAAC,KAAK;QAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;IAChE,IAAI,KAAK,CAAC,OAAO;QAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;IACtE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CACxB,YAAqC,EACrC,UAAkB,EAClB,MAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAClD,OAAO;YACL,SAAS,EAAE,YAAY,CAAC,SAAS;YACjC,cAAc,EAAE,YAAY,CAAC,cAAc;YAC3C,SAAS,EAAE,UAAU;YACrB,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,EAAE;YACR,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrE,IAAI,GAAG,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,mBAAmB,CAAC,CAAC;IACpD,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,KAAK,WAAW,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC;IAC/E,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,OAAO;QACnB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,CAAC,CAAC,GAAG,CAAC,KAAK;YACX,CAAC,CAAC,IAAI;gBACJ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAC1B,CAAC,CAAC,EAAE,CAAC;IACX,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,SAAS;QACjC,cAAc,EAAE,YAAY,CAAC,cAAc;QAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM;QACxC,IAAI;QACJ,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAyB;IAC1D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,yBAAyB,CAAC;IAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IAC7G,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe;IACtB,OAAO,SAAS,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,qBAAqB,CAAC,SAAiB;IAC9C,OAAO,IAAI,KAAK,CAAC,8BAA8B,SAAS,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAmB,EAAE,QAAiB,EAAE,SAAiB;IACtF,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO;IAC5B,IAAI,QAAQ;QAAE,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACrD,MAAM,MAAM,CAAC,MAAM,YAAY,KAAK;QAClC,CAAC,CAAC,MAAM,CAAC,MAAM;QACf,CAAC,CAAC,IAAI,YAAY,CAAC,4BAA4B,EAAE,YAAY,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,cAAc,CAAC,EAAU,EAAE,MAAmB;IACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,CAAC,MAAM,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;YACnG,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YACpC,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;QACrG,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import type { RaybaseSchema } from "@raybase/core";
|
|
2
|
+
import type { GuideConfig } from "./guide.js";
|
|
3
|
+
export type GuideCorpusSource = "docs" | "faq" | "spec" | "route" | "schema" | "policy" | "support";
|
|
4
|
+
export type GuideCorpusContext = "template-default" | "app-capability-map" | "workflow";
|
|
5
|
+
export type GuideCorpusDocument = {
|
|
6
|
+
id: string;
|
|
7
|
+
title: string;
|
|
8
|
+
source: GuideCorpusSource;
|
|
9
|
+
text: string;
|
|
10
|
+
guideContext?: GuideCorpusContext | null;
|
|
11
|
+
url?: string;
|
|
12
|
+
routePatterns?: string[];
|
|
13
|
+
public?: boolean;
|
|
14
|
+
updatedAt?: string;
|
|
15
|
+
hash?: string;
|
|
16
|
+
metadata?: Record<string, unknown>;
|
|
17
|
+
};
|
|
18
|
+
export type GuideCorpusManifestSource = {
|
|
19
|
+
kind: "docs";
|
|
20
|
+
path: string;
|
|
21
|
+
} | {
|
|
22
|
+
kind: "guide";
|
|
23
|
+
path: string;
|
|
24
|
+
} | {
|
|
25
|
+
kind: "configured";
|
|
26
|
+
path: string;
|
|
27
|
+
id: string;
|
|
28
|
+
};
|
|
29
|
+
export type GuideCorpusManifest = {
|
|
30
|
+
schemaVersion: 1;
|
|
31
|
+
generatedAt: string;
|
|
32
|
+
sources: GuideCorpusManifestSource[];
|
|
33
|
+
documents: GuideCorpusDocument[];
|
|
34
|
+
};
|
|
35
|
+
export type GuideCorpusResourceSource = Exclude<GuideCorpusSource, "docs">;
|
|
36
|
+
export type GuideCorpusResource = {
|
|
37
|
+
id: string;
|
|
38
|
+
path: string;
|
|
39
|
+
source: GuideCorpusResourceSource;
|
|
40
|
+
title?: string;
|
|
41
|
+
public?: boolean;
|
|
42
|
+
guideContext?: GuideCorpusContext;
|
|
43
|
+
routePatterns?: string[];
|
|
44
|
+
};
|
|
45
|
+
export type GuideCorpusResourceConfig = {
|
|
46
|
+
schemaVersion: 1;
|
|
47
|
+
resources: GuideCorpusResource[];
|
|
48
|
+
};
|
|
49
|
+
export type GuideCorpusSnippet = GuideCorpusDocument & {
|
|
50
|
+
score: number;
|
|
51
|
+
};
|
|
52
|
+
export declare function safeSchemaGuideDocuments(schema: RaybaseSchema, config?: GuideConfig): GuideCorpusDocument[];
|
|
53
|
+
export declare function safePolicyGuideDocuments(schema: RaybaseSchema, config?: GuideConfig): GuideCorpusDocument[];
|
|
54
|
+
export declare function rankGuideCorpus(input: {
|
|
55
|
+
documents: GuideCorpusDocument[];
|
|
56
|
+
query: string;
|
|
57
|
+
surface: "app" | "docs";
|
|
58
|
+
route: string;
|
|
59
|
+
principalKind: "user" | "public";
|
|
60
|
+
config: GuideConfig;
|
|
61
|
+
maxSnippets?: number;
|
|
62
|
+
}): GuideCorpusSnippet[];
|
|
63
|
+
export declare function guideCorpusPrompt(snippets: GuideCorpusSnippet[]): string;
|
|
64
|
+
//# sourceMappingURL=guide-corpus.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-corpus.d.ts","sourceRoot":"","sources":["../src/guide-corpus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AACpG,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,UAAU,CAAC;AAExF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,CAAC,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAE3E,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,yBAAyB,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACrD,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,WAAgB,GAAG,mBAAmB,EAAE,CAc/G;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,WAAgB,GAAG,mBAAmB,EAAE,CAS/G;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE;IACrC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,GAAG,QAAQ,CAAC;IACjC,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,kBAAkB,EAAE,CAoBvB;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,MAAM,CASxE"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
export function safeSchemaGuideDocuments(schema, config = {}) {
|
|
2
|
+
if (config.corpus?.safeSchema === false)
|
|
3
|
+
return [];
|
|
4
|
+
return Object.values(schema.tables).map((table) => ({
|
|
5
|
+
id: `schema:${table.name}`,
|
|
6
|
+
title: table.label ?? table.name,
|
|
7
|
+
source: "schema",
|
|
8
|
+
public: false,
|
|
9
|
+
text: [
|
|
10
|
+
`Table: ${table.label ?? table.name}`,
|
|
11
|
+
`Columns: ${Object.entries(table.columns)
|
|
12
|
+
.map(([name, column]) => `${column.label ?? name} (${column.kind})`)
|
|
13
|
+
.join(", ")}`
|
|
14
|
+
].join("\n")
|
|
15
|
+
}));
|
|
16
|
+
}
|
|
17
|
+
export function safePolicyGuideDocuments(schema, config = {}) {
|
|
18
|
+
if (config.corpus?.safePolicies === false)
|
|
19
|
+
return [];
|
|
20
|
+
return Object.values(schema.tables).map((table) => ({
|
|
21
|
+
id: `policy:${table.name}`,
|
|
22
|
+
title: `${table.label ?? table.name} access rules`,
|
|
23
|
+
source: "policy",
|
|
24
|
+
public: false,
|
|
25
|
+
text: `Access to ${table.label ?? table.name} is enforced by Raybase row policies for read, create, update, and delete operations.`
|
|
26
|
+
}));
|
|
27
|
+
}
|
|
28
|
+
export function rankGuideCorpus(input) {
|
|
29
|
+
const maxSnippets = Math.max(1, input.maxSnippets ?? input.config.limits?.maxCorpusSnippets ?? 8);
|
|
30
|
+
const allowed = input.documents
|
|
31
|
+
.filter((document) => sourceEnabled(document, input.config))
|
|
32
|
+
.filter((document) => input.principalKind === "user" || document.public === true)
|
|
33
|
+
.filter((document) => routeNarrows(document, input.route));
|
|
34
|
+
const queryTokens = tokenize(input.query);
|
|
35
|
+
const routeTokens = tokenize(input.route);
|
|
36
|
+
return allowed
|
|
37
|
+
.map((document) => {
|
|
38
|
+
const haystack = tokenSet([document.title, document.text, document.url, ...(document.routePatterns ?? [])].filter(Boolean).join(" "));
|
|
39
|
+
const tokenScore = scoreTokens(queryTokens, haystack);
|
|
40
|
+
const routeScore = routeTokens.length ? scoreTokens(routeTokens, haystack) * 0.25 : 0;
|
|
41
|
+
const surfaceScore = document.source === "docs" && input.surface === "docs" ? 0.5 : 0;
|
|
42
|
+
return { ...document, score: tokenScore + routeScore + surfaceScore };
|
|
43
|
+
})
|
|
44
|
+
.filter((document) => document.score > 0 || input.query.trim().length < 2)
|
|
45
|
+
.sort((left, right) => right.score - left.score || left.title.localeCompare(right.title))
|
|
46
|
+
.slice(0, maxSnippets);
|
|
47
|
+
}
|
|
48
|
+
export function guideCorpusPrompt(snippets) {
|
|
49
|
+
if (!snippets.length)
|
|
50
|
+
return "No authorized app help snippets were found for this question.";
|
|
51
|
+
return [
|
|
52
|
+
"Authorized app help snippets:",
|
|
53
|
+
...snippets.map((snippet, index) => {
|
|
54
|
+
const label = [snippet.title, snippet.url].filter(Boolean).join(" - ");
|
|
55
|
+
return `[${index + 1}] ${label} (${snippet.source})\n${snippet.text.slice(0, 1800)}`;
|
|
56
|
+
})
|
|
57
|
+
].join("\n\n");
|
|
58
|
+
}
|
|
59
|
+
function sourceEnabled(document, config) {
|
|
60
|
+
const corpus = config.corpus ?? {};
|
|
61
|
+
switch (document.source) {
|
|
62
|
+
case "docs":
|
|
63
|
+
return corpus.docs !== false;
|
|
64
|
+
case "faq":
|
|
65
|
+
return corpus.faq !== false;
|
|
66
|
+
case "spec":
|
|
67
|
+
return corpus.spec !== false;
|
|
68
|
+
case "route":
|
|
69
|
+
return corpus.routeMetadata !== false;
|
|
70
|
+
case "schema":
|
|
71
|
+
return corpus.safeSchema !== false;
|
|
72
|
+
case "policy":
|
|
73
|
+
return corpus.safePolicies !== false;
|
|
74
|
+
case "support":
|
|
75
|
+
return corpus.priorResolvedSupport === true;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
function routeNarrows(document, route) {
|
|
79
|
+
if (!document.routePatterns?.length)
|
|
80
|
+
return true;
|
|
81
|
+
const normalized = normalizeRoute(route);
|
|
82
|
+
return document.routePatterns.some((pattern) => routeMatches(normalized, pattern));
|
|
83
|
+
}
|
|
84
|
+
function routeMatches(route, pattern) {
|
|
85
|
+
const normalized = normalizeRoute(pattern);
|
|
86
|
+
if (normalized === route)
|
|
87
|
+
return true;
|
|
88
|
+
if (normalized.endsWith("*"))
|
|
89
|
+
return route.startsWith(normalized.slice(0, -1));
|
|
90
|
+
return false;
|
|
91
|
+
}
|
|
92
|
+
function normalizeRoute(route) {
|
|
93
|
+
const value = route.trim() || "/";
|
|
94
|
+
return value.startsWith("/") ? value : `/${value}`;
|
|
95
|
+
}
|
|
96
|
+
function scoreTokens(queryTokens, haystack) {
|
|
97
|
+
let score = 0;
|
|
98
|
+
for (const token of queryTokens) {
|
|
99
|
+
if (haystack.has(token))
|
|
100
|
+
score += token.length > 4 ? 2 : 1;
|
|
101
|
+
}
|
|
102
|
+
return score;
|
|
103
|
+
}
|
|
104
|
+
function tokenize(value) {
|
|
105
|
+
return value
|
|
106
|
+
.toLowerCase()
|
|
107
|
+
.split(/[^a-z0-9]+/g)
|
|
108
|
+
.filter((token) => token.length > 1);
|
|
109
|
+
}
|
|
110
|
+
function tokenSet(value) {
|
|
111
|
+
return new Set(tokenize(value));
|
|
112
|
+
}
|
|
113
|
+
//# sourceMappingURL=guide-corpus.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-corpus.js","sourceRoot":"","sources":["../src/guide-corpus.ts"],"names":[],"mappings":"AAqDA,MAAM,UAAU,wBAAwB,CAAC,MAAqB,EAAE,SAAsB,EAAE;IACtF,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IACnD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClD,EAAE,EAAE,UAAU,KAAK,CAAC,IAAI,EAAE;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI;QAChC,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE;YACJ,UAAU,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE;YACrC,YAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;iBACtC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC;iBACnE,IAAI,CAAC,IAAI,CAAC,EAAE;SAChB,CAAC,IAAI,CAAC,IAAI,CAAC;KACb,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAqB,EAAE,SAAsB,EAAE;IACtF,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IACrD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClD,EAAE,EAAE,UAAU,KAAK,CAAC,IAAI,EAAE;QAC1B,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,eAAe;QAClD,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,aAAa,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,uFAAuF;KACpI,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAQ/B;IACC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,IAAI,CAAC,CAAC,CAAC;IAClG,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS;SAC5B,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC3D,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,KAAK,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC;SAChF,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE1C,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACtI,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACtF,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,KAAK,MAAM,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACtF,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,YAAY,EAAE,CAAC;IACxE,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;SACzE,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACxF,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAA8B;IAC9D,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,+DAA+D,CAAC;IAC7F,OAAO;QACL,+BAA+B;QAC/B,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACjC,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,IAAI,KAAK,GAAG,CAAC,KAAK,KAAK,KAAK,OAAO,CAAC,MAAM,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;QACvF,CAAC,CAAC;KACH,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,aAAa,CAAC,QAA6B,EAAE,MAAmB;IACvE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;IACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,MAAM;YACT,OAAO,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC;QAC/B,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,KAAK,KAAK,CAAC;QAC9B,KAAK,MAAM;YACT,OAAO,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC;QAC/B,KAAK,OAAO;YACV,OAAO,MAAM,CAAC,aAAa,KAAK,KAAK,CAAC;QACxC,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,YAAY,KAAK,KAAK,CAAC;QACvC,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,oBAAoB,KAAK,IAAI,CAAC;IAChD,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,QAA6B,EAAE,KAAa;IAChE,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,SAAS,YAAY,CAAC,KAAa,EAAE,OAAe;IAClD,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,UAAU,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC;IAClC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,WAAW,CAAC,WAAqB,EAAE,QAAqB;IAC/D,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,KAAK;SACT,WAAW,EAAE;SACb,KAAK,CAAC,aAAa,CAAC;SACpB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-tables.d.ts","sourceRoot":"","sources":["../src/guide-tables.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEhG,eAAO,MAAM,sBAAsB,oBAAoB,CAAC;AAExD,eAAO,MAAM,wBAAwB,EAAE,kBAAkB,EAiBxD,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { id, longText, raybaseSystemTable, text } from "@raybase/core";
|
|
2
|
+
export const guideFailuresTableName = "_guide_failures";
|
|
3
|
+
export const raybaseGuideSystemTables = [
|
|
4
|
+
raybaseSystemTable(guideFailuresTableName, {
|
|
5
|
+
id: id(),
|
|
6
|
+
conversationId: text(),
|
|
7
|
+
organizationId: text(),
|
|
8
|
+
fingerprint: text({ required: true }),
|
|
9
|
+
surface: text({ required: true }),
|
|
10
|
+
route: text({ required: true }),
|
|
11
|
+
question: longText({ required: true }),
|
|
12
|
+
reason: text({ required: true }),
|
|
13
|
+
corpusIdsJson: longText(),
|
|
14
|
+
createdAt: text({ required: true })
|
|
15
|
+
}, { label: "Guide unanswered questions", indexes: [["fingerprint"], ["organizationId", "createdAt"], ["surface", "createdAt"]] })
|
|
16
|
+
];
|
|
17
|
+
//# sourceMappingURL=guide-tables.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"guide-tables.js","sourceRoot":"","sources":["../src/guide-tables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAA2B,MAAM,eAAe,CAAC;AAEhG,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AAExD,MAAM,CAAC,MAAM,wBAAwB,GAAyB;IAC5D,kBAAkB,CAChB,sBAAsB,EACtB;QACE,EAAE,EAAE,EAAE,EAAE;QACR,cAAc,EAAE,IAAI,EAAE;QACtB,cAAc,EAAE,IAAI,EAAE;QACtB,WAAW,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACrC,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACjC,KAAK,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC/B,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAChC,aAAa,EAAE,QAAQ,EAAE;QACzB,SAAS,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KACpC,EACD,EAAE,KAAK,EAAE,4BAA4B,EAAE,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,EAAE,CAC/H;CACF,CAAC"}
|