@agent-native/core 0.131.4 → 0.131.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/corpus/README.md +1 -1
- package/corpus/core/CHANGELOG.md +6 -0
- package/corpus/core/docs/content/docs-components.mdx +491 -0
- package/corpus/core/package.json +1 -1
- package/corpus/templates/content/.agents/skills/content-product-development/SKILL.md +47 -0
- package/dist/collab/awareness.d.ts +2 -2
- package/dist/collab/awareness.d.ts.map +1 -1
- package/dist/collab/routes.d.ts +1 -1
- package/dist/collab/struct-routes.d.ts +1 -1
- package/dist/mcp/screen-memory-stdio.d.ts +7 -7
- package/dist/mcp/screen-memory-stdio.d.ts.map +1 -1
- package/dist/notifications/routes.d.ts +4 -4
- package/dist/resources/handlers.d.ts +1 -1
- package/dist/server/agent-engine-api-key-route.d.ts +1 -1
- package/dist/server/realtime-token.d.ts +1 -1
- package/docs/content/docs-components.mdx +491 -0
- package/package.json +1 -1
package/corpus/README.md
CHANGED
package/corpus/core/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,491 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Docs components"
|
|
3
|
+
description: "Reference for every MDX component available in the Agent Native docs, with live rendered examples and copy-paste syntax."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Docs components
|
|
7
|
+
|
|
8
|
+
The docs site renders standard Markdown plus a set of MDX block components for
|
|
9
|
+
richer content. Each section below shows a live rendered example followed by
|
|
10
|
+
the exact MDX syntax that produced it.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Callout
|
|
15
|
+
|
|
16
|
+
<Callout tone="info">
|
|
17
|
+
|
|
18
|
+
This is an `info` callout. Use it for background context or neutral notes. You can use **bold**, `inline code`, and [links](/docs/getting-started) inside.
|
|
19
|
+
|
|
20
|
+
</Callout>
|
|
21
|
+
|
|
22
|
+
<Callout tone="warning">
|
|
23
|
+
|
|
24
|
+
This is a `warning` callout. Use it for potential data loss, breaking changes, or hard-to-reverse steps. For example: restart `pnpm dev` after adding a new route file — the router only picks up files present at startup.
|
|
25
|
+
|
|
26
|
+
</Callout>
|
|
27
|
+
|
|
28
|
+
<Callout tone="success">
|
|
29
|
+
|
|
30
|
+
This is a `success` callout. Use it for the recommended path or to confirm a working approach.
|
|
31
|
+
|
|
32
|
+
</Callout>
|
|
33
|
+
|
|
34
|
+
<Callout tone="risk">
|
|
35
|
+
|
|
36
|
+
This is a `risk` callout. Use it for security implications or production caveats.
|
|
37
|
+
|
|
38
|
+
</Callout>
|
|
39
|
+
|
|
40
|
+
<Callout tone="decision">
|
|
41
|
+
|
|
42
|
+
This is a `decision` callout. Use it to surface a deliberate tradeoff the reader should understand.
|
|
43
|
+
|
|
44
|
+
</Callout>
|
|
45
|
+
|
|
46
|
+
```mdx
|
|
47
|
+
<Callout tone="info">
|
|
48
|
+
|
|
49
|
+
This is an `info` callout. Use it for background context or neutral notes. You can use **bold**, `inline code`, and [links](/docs/getting-started) inside.
|
|
50
|
+
|
|
51
|
+
</Callout>
|
|
52
|
+
|
|
53
|
+
<Callout tone="warning">
|
|
54
|
+
|
|
55
|
+
This is a `warning` callout. Use it for potential data loss, breaking changes, or hard-to-reverse steps. For example: restart `pnpm dev` after adding a new route file — the router only picks up files present at startup.
|
|
56
|
+
|
|
57
|
+
</Callout>
|
|
58
|
+
|
|
59
|
+
<Callout tone="success">
|
|
60
|
+
|
|
61
|
+
This is a `success` callout. Use it for the recommended path or to confirm a working approach.
|
|
62
|
+
|
|
63
|
+
</Callout>
|
|
64
|
+
|
|
65
|
+
<Callout tone="risk">
|
|
66
|
+
|
|
67
|
+
This is a `risk` callout. Use it for security implications or production caveats.
|
|
68
|
+
|
|
69
|
+
</Callout>
|
|
70
|
+
|
|
71
|
+
<Callout tone="decision">
|
|
72
|
+
|
|
73
|
+
This is a `decision` callout. Use it to surface a deliberate tradeoff the reader should understand.
|
|
74
|
+
|
|
75
|
+
</Callout>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
| Tone | When to use |
|
|
79
|
+
| ---------- | ------------------------------------------------------------ |
|
|
80
|
+
| `info` | Background context, neutral notes |
|
|
81
|
+
| `warning` | Potential data loss, breaking changes, hard-to-reverse steps |
|
|
82
|
+
| `success` | Recommended option, confirmed working path |
|
|
83
|
+
| `risk` | Security implications, production caveats |
|
|
84
|
+
| `decision` | Deliberate tradeoffs the reader should understand |
|
|
85
|
+
|
|
86
|
+
Leave a blank line between the opening tag and the body, and another before the closing tag.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Steps
|
|
91
|
+
|
|
92
|
+
<Steps>
|
|
93
|
+
|
|
94
|
+
### Install dependencies
|
|
95
|
+
|
|
96
|
+
Run the following inside your project directory:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
pnpm install
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Start the dev server
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
pnpm dev
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Open `http://localhost:3000`. The app is ready when **VITE ready** appears in the terminal.
|
|
109
|
+
|
|
110
|
+
### Sign in
|
|
111
|
+
|
|
112
|
+
The first run shows a login screen. Use any credentials — local development does not send email.
|
|
113
|
+
|
|
114
|
+
</Steps>
|
|
115
|
+
|
|
116
|
+
````mdx
|
|
117
|
+
<Steps>
|
|
118
|
+
|
|
119
|
+
### Install dependencies
|
|
120
|
+
|
|
121
|
+
Run the following inside your project directory:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
pnpm install
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Start the dev server
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
pnpm dev
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Open `http://localhost:3000`. The app is ready when **VITE ready** appears in the terminal.
|
|
134
|
+
|
|
135
|
+
### Sign in
|
|
136
|
+
|
|
137
|
+
The first run shows a login screen. Use any credentials — local development does not send email.
|
|
138
|
+
|
|
139
|
+
</Steps>
|
|
140
|
+
````
|
|
141
|
+
|
|
142
|
+
Each step is a `###` heading followed by the body content. Steps work best for 3–8 items. For 2 items a numbered list is fine. For longer procedures, split into multiple `<Steps>` blocks with a prose bridge between them.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Cards
|
|
147
|
+
|
|
148
|
+
<Cards>
|
|
149
|
+
|
|
150
|
+
### [Actions](/docs/actions)
|
|
151
|
+
|
|
152
|
+
Typed operations callable from the agent, UI, CLI, and HTTP. Define once, call from anywhere.
|
|
153
|
+
|
|
154
|
+
### [Database](/docs/database)
|
|
155
|
+
|
|
156
|
+
SQL persistence with automatic migrations. SQLite locally, Postgres/Turso in production.
|
|
157
|
+
|
|
158
|
+
### [Agent Surfaces](/docs/agent-surfaces)
|
|
159
|
+
|
|
160
|
+
Configure where the agent appears: full-page chat, sidebar panel, or embedded in a route.
|
|
161
|
+
|
|
162
|
+
### Skills
|
|
163
|
+
|
|
164
|
+
Plain-text instruction files that give the agent domain knowledge and task-specific behavior without code changes.
|
|
165
|
+
|
|
166
|
+
</Cards>
|
|
167
|
+
|
|
168
|
+
```mdx
|
|
169
|
+
<Cards>
|
|
170
|
+
|
|
171
|
+
### [Actions](/docs/actions)
|
|
172
|
+
|
|
173
|
+
Typed operations callable from the agent, UI, CLI, and HTTP. Define once, call from anywhere.
|
|
174
|
+
|
|
175
|
+
### [Database](/docs/database)
|
|
176
|
+
|
|
177
|
+
SQL persistence with automatic migrations. SQLite locally, Postgres/Turso in production.
|
|
178
|
+
|
|
179
|
+
### [Agent Surfaces](/docs/agent-surfaces)
|
|
180
|
+
|
|
181
|
+
Configure where the agent appears: full-page chat, sidebar panel, or embedded in a route.
|
|
182
|
+
|
|
183
|
+
### Skills
|
|
184
|
+
|
|
185
|
+
Plain-text instruction files that give the agent domain knowledge and task-specific behavior without code changes.
|
|
186
|
+
|
|
187
|
+
</Cards>
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
Each card is a `###` heading (optionally linked) followed by the description. Cards without a link render as plain info boxes with no hover state or arrow.
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Comparison
|
|
195
|
+
|
|
196
|
+
<Comparison>
|
|
197
|
+
|
|
198
|
+
### Before
|
|
199
|
+
|
|
200
|
+
Every feature needs a separate API endpoint, a separate React query, and manual wiring between the AI response and UI state.
|
|
201
|
+
|
|
202
|
+
### After
|
|
203
|
+
|
|
204
|
+
Define one action. The agent calls it as a tool, the UI calls it through a React hook, and both read the same validated output.
|
|
205
|
+
|
|
206
|
+
</Comparison>
|
|
207
|
+
|
|
208
|
+
```mdx
|
|
209
|
+
<Comparison>
|
|
210
|
+
|
|
211
|
+
### Before
|
|
212
|
+
|
|
213
|
+
Every feature needs a separate API endpoint, a separate React query, and manual wiring between the AI response and UI state.
|
|
214
|
+
|
|
215
|
+
### After
|
|
216
|
+
|
|
217
|
+
Define one action. The agent calls it as a tool, the UI calls it through a React hook, and both read the same validated output.
|
|
218
|
+
|
|
219
|
+
</Comparison>
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Add more `###` sections to get 3 or 4 columns (max 4). The red/green label accent only applies to headings that exactly match `Before`, `Old`, `Without` (red) or `After`, `New`, `With` (green).
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## kbd — keyboard shortcut
|
|
227
|
+
|
|
228
|
+
Press [[⌘K]] to open the command palette. Save with [[Ctrl+S]] before running the dev server. Navigate fields with [[Tab]] and [[Shift+Tab]].
|
|
229
|
+
|
|
230
|
+
```mdx
|
|
231
|
+
Press [[⌘K]] to open the command palette. Save with [[Ctrl+S]] before running the dev server. Navigate fields with [[Tab]] and [[Shift+Tab]].
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Double brackets around the key sequence; no MDX component needed. Works anywhere in regular Markdown paragraphs.
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## Mermaid diagram
|
|
239
|
+
|
|
240
|
+
```mermaid
|
|
241
|
+
graph LR
|
|
242
|
+
A[defineAction] --> B[Agent calls it as a tool]
|
|
243
|
+
A --> C[UI calls it via useActionQuery]
|
|
244
|
+
A --> D[CLI calls it directly]
|
|
245
|
+
A --> E[HTTP API]
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
````mdx
|
|
249
|
+
```mermaid
|
|
250
|
+
graph LR
|
|
251
|
+
A[defineAction] --> B[Agent calls it as a tool]
|
|
252
|
+
A --> C[UI calls it via useActionQuery]
|
|
253
|
+
A --> D[CLI calls it directly]
|
|
254
|
+
A --> E[HTTP API]
|
|
255
|
+
```
|
|
256
|
+
````
|
|
257
|
+
|
|
258
|
+
Use a fenced code block with the `mermaid` language tag. Mermaid supports flowcharts (`graph`), sequence diagrams (`sequenceDiagram`), entity-relationship diagrams (`erDiagram`), and more. See [mermaid.js.org](https://mermaid.js.org/intro/) for the full syntax reference.
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## FileTree
|
|
263
|
+
|
|
264
|
+
<FileTree
|
|
265
|
+
id="docs-components-filetree"
|
|
266
|
+
entries={[
|
|
267
|
+
{
|
|
268
|
+
path: "actions/analyze-text.ts",
|
|
269
|
+
change: "added",
|
|
270
|
+
note: "New action — callable from agent, UI, and CLI",
|
|
271
|
+
},
|
|
272
|
+
{ path: "actions/list-text-analyses.ts", change: "added" },
|
|
273
|
+
{ path: "app/routes/analyses.tsx", change: "modified" },
|
|
274
|
+
{
|
|
275
|
+
path: "app/config/nav.ts",
|
|
276
|
+
change: "modified",
|
|
277
|
+
note: "Add the new route to the sidebar nav",
|
|
278
|
+
},
|
|
279
|
+
{ path: "db/migrations/001_analyses.sql" },
|
|
280
|
+
]}
|
|
281
|
+
/>
|
|
282
|
+
|
|
283
|
+
```mdx
|
|
284
|
+
<FileTree
|
|
285
|
+
id="docs-components-filetree"
|
|
286
|
+
entries={[
|
|
287
|
+
{
|
|
288
|
+
path: "actions/analyze-text.ts",
|
|
289
|
+
change: "added",
|
|
290
|
+
note: "New action — callable from agent, UI, and CLI",
|
|
291
|
+
},
|
|
292
|
+
{ path: "actions/list-text-analyses.ts", change: "added" },
|
|
293
|
+
{ path: "app/routes/analyses.tsx", change: "modified" },
|
|
294
|
+
{
|
|
295
|
+
path: "app/config/nav.ts",
|
|
296
|
+
change: "modified",
|
|
297
|
+
note: "Add the new route to the sidebar nav",
|
|
298
|
+
},
|
|
299
|
+
{ path: "db/migrations/001_analyses.sql" },
|
|
300
|
+
]}
|
|
301
|
+
/>
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
FileTree is **self-closing** (`/>`). It does not accept Markdown children — if you use open/close tags with content inside you will get a parse error.
|
|
305
|
+
|
|
306
|
+
Each entry in `entries` is an object with a `path` key (slash-delimited) and optional fields:
|
|
307
|
+
|
|
308
|
+
| Field | Values | Effect |
|
|
309
|
+
| ---------- | ------------------------------------------------------- | ------------------------------------ |
|
|
310
|
+
| `change` | `"added"` \| `"modified"` \| `"removed"` \| `"renamed"` | Colored badge on the row |
|
|
311
|
+
| `note` | any string | Expandable annotation shown on hover |
|
|
312
|
+
| `snippet` | code string | Expandable code preview |
|
|
313
|
+
| `language` | e.g. `"ts"` | Syntax highlighting for the snippet |
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## Tabs
|
|
318
|
+
|
|
319
|
+
<TabsBlock
|
|
320
|
+
id="docs-components-tabs"
|
|
321
|
+
tabs={[
|
|
322
|
+
{
|
|
323
|
+
id: "pnpm",
|
|
324
|
+
label: "pnpm",
|
|
325
|
+
blocks: [
|
|
326
|
+
{
|
|
327
|
+
type: "code",
|
|
328
|
+
id: "pnpm-install",
|
|
329
|
+
data: { code: "pnpm install", language: "bash" },
|
|
330
|
+
},
|
|
331
|
+
],
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
id: "npm",
|
|
335
|
+
label: "npm",
|
|
336
|
+
blocks: [
|
|
337
|
+
{
|
|
338
|
+
type: "code",
|
|
339
|
+
id: "npm-install",
|
|
340
|
+
data: { code: "npm install", language: "bash" },
|
|
341
|
+
},
|
|
342
|
+
],
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
id: "yarn",
|
|
346
|
+
label: "yarn",
|
|
347
|
+
blocks: [
|
|
348
|
+
{
|
|
349
|
+
type: "code",
|
|
350
|
+
id: "yarn-install",
|
|
351
|
+
data: { code: "yarn install", language: "bash" },
|
|
352
|
+
},
|
|
353
|
+
],
|
|
354
|
+
},
|
|
355
|
+
]}
|
|
356
|
+
/>
|
|
357
|
+
|
|
358
|
+
```mdx
|
|
359
|
+
<TabsBlock
|
|
360
|
+
id="docs-components-tabs"
|
|
361
|
+
tabs={[
|
|
362
|
+
{
|
|
363
|
+
id: "pnpm",
|
|
364
|
+
label: "pnpm",
|
|
365
|
+
blocks: [
|
|
366
|
+
{
|
|
367
|
+
type: "code",
|
|
368
|
+
id: "pnpm-install",
|
|
369
|
+
data: { code: "pnpm install", language: "bash" },
|
|
370
|
+
},
|
|
371
|
+
],
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
id: "npm",
|
|
375
|
+
label: "npm",
|
|
376
|
+
blocks: [
|
|
377
|
+
{
|
|
378
|
+
type: "code",
|
|
379
|
+
id: "npm-install",
|
|
380
|
+
data: { code: "npm install", language: "bash" },
|
|
381
|
+
},
|
|
382
|
+
],
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
id: "yarn",
|
|
386
|
+
label: "yarn",
|
|
387
|
+
blocks: [
|
|
388
|
+
{
|
|
389
|
+
type: "code",
|
|
390
|
+
id: "yarn-install",
|
|
391
|
+
data: { code: "yarn install", language: "bash" },
|
|
392
|
+
},
|
|
393
|
+
],
|
|
394
|
+
},
|
|
395
|
+
]}
|
|
396
|
+
/>
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
`TabsBlock` is self-closing. The entire structure is one JSON `tabs` attribute. Each tab's content is a `blocks` array where each item is a block object with `type`, `id`, and `data` matching that block's schema. Tabs works best for short parallel code snippets (one code block per tab). For richer multi-block content per tab, use a visual editor rather than hand-authoring the JSON.
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
## Columns
|
|
404
|
+
|
|
405
|
+
<Columns
|
|
406
|
+
id="docs-components-columns"
|
|
407
|
+
columns={[
|
|
408
|
+
{
|
|
409
|
+
id: "col-manual",
|
|
410
|
+
label: "Manual approach",
|
|
411
|
+
blocks: [
|
|
412
|
+
{
|
|
413
|
+
type: "code",
|
|
414
|
+
id: "manual-code",
|
|
415
|
+
data: {
|
|
416
|
+
code: "const res = await fetch('/api/analyses')\nconst data = await res.json()",
|
|
417
|
+
language: "ts",
|
|
418
|
+
},
|
|
419
|
+
},
|
|
420
|
+
],
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
id: "col-actions",
|
|
424
|
+
label: "With actions",
|
|
425
|
+
blocks: [
|
|
426
|
+
{
|
|
427
|
+
type: "code",
|
|
428
|
+
id: "action-code",
|
|
429
|
+
data: {
|
|
430
|
+
code: "const { data } = useActionQuery('list-text-analyses', {})",
|
|
431
|
+
language: "ts",
|
|
432
|
+
},
|
|
433
|
+
},
|
|
434
|
+
],
|
|
435
|
+
},
|
|
436
|
+
]}
|
|
437
|
+
/>
|
|
438
|
+
|
|
439
|
+
```mdx
|
|
440
|
+
<Columns
|
|
441
|
+
id="docs-components-columns"
|
|
442
|
+
columns={[
|
|
443
|
+
{
|
|
444
|
+
id: "col-manual",
|
|
445
|
+
label: "Manual approach",
|
|
446
|
+
blocks: [
|
|
447
|
+
{
|
|
448
|
+
type: "code",
|
|
449
|
+
id: "manual-code",
|
|
450
|
+
data: {
|
|
451
|
+
code: "const res = await fetch('/api/analyses')\nconst data = await res.json()",
|
|
452
|
+
language: "ts",
|
|
453
|
+
},
|
|
454
|
+
},
|
|
455
|
+
],
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
id: "col-actions",
|
|
459
|
+
label: "With actions",
|
|
460
|
+
blocks: [
|
|
461
|
+
{
|
|
462
|
+
type: "code",
|
|
463
|
+
id: "action-code",
|
|
464
|
+
data: {
|
|
465
|
+
code: "const { data } = useActionQuery('list-text-analyses', {})",
|
|
466
|
+
language: "ts",
|
|
467
|
+
},
|
|
468
|
+
},
|
|
469
|
+
],
|
|
470
|
+
},
|
|
471
|
+
]}
|
|
472
|
+
/>
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
Like `TabsBlock`, `Columns` is self-closing with a single JSON `columns` attribute. Each column has an optional `label` header and a `blocks` array. For comparing prose rather than code, `Comparison` is easier to hand-author.
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
## When to use which component
|
|
480
|
+
|
|
481
|
+
| Situation | Component |
|
|
482
|
+
| ----------------------------------------- | ------------------------------------ |
|
|
483
|
+
| Reader must not miss something | `Callout` (warning / info / success) |
|
|
484
|
+
| Sequential procedure with titled steps | `Steps` |
|
|
485
|
+
| Navigation or feature overview grid | `Cards` |
|
|
486
|
+
| Before vs. after, old vs. new (prose) | `Comparison` |
|
|
487
|
+
| Same task in multiple tools or frameworks | `Tabs` |
|
|
488
|
+
| Side-by-side code (labeled columns) | `Columns` |
|
|
489
|
+
| Project directory structure | `FileTree` |
|
|
490
|
+
| Inline keyboard shortcut | `[[Key]]` |
|
|
491
|
+
| Architecture or flow diagram | Mermaid fence |
|
package/corpus/core/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-native/core",
|
|
3
|
-
"version": "0.131.
|
|
3
|
+
"version": "0.131.5",
|
|
4
4
|
"description": "Framework for agent-native application development — where AI agents and UI share SQL state, actions, and context",
|
|
5
5
|
"homepage": "https://github.com/BuilderIO/agent-native#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -72,6 +72,53 @@ require a permission slip for every useful bug fix.
|
|
|
72
72
|
Load the domain skill for the work, especially `actions`, `security`, `sharing`,
|
|
73
73
|
`storing-data`, `portability`, `real-time-collab`, or `real-time-sync`.
|
|
74
74
|
|
|
75
|
+
## Declare pull-request impact
|
|
76
|
+
|
|
77
|
+
During the advisory conformance pilot, add exactly one fenced YAML declaration
|
|
78
|
+
to the pull-request body when a change directly affects Content or when a shared
|
|
79
|
+
framework change has specific Content impact:
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
content_product_impact:
|
|
83
|
+
lane: contract_repair
|
|
84
|
+
features:
|
|
85
|
+
- content.feature.example
|
|
86
|
+
capabilities:
|
|
87
|
+
- content.example.capability
|
|
88
|
+
record_change: none
|
|
89
|
+
proof:
|
|
90
|
+
- pnpm --filter content test
|
|
91
|
+
rationale: The change repairs the declared Capability without changing its contract.
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Use stable IDs from `templates/content/docs/product/`. Valid lanes are
|
|
95
|
+
`contract_repair`, `contract_fulfillment`, `local_refinement`, and
|
|
96
|
+
`product_decision_candidate`. Set `record_change` to `included` when the PR
|
|
97
|
+
changes a Feature or Capability record, or `decision_pending` when the product
|
|
98
|
+
record must wait for an explicit product decision.
|
|
99
|
+
|
|
100
|
+
The lane meanings are the same as the classification table above. A contract
|
|
101
|
+
repair does not require roadmap churn when the accepted record remains true.
|
|
102
|
+
Repairs, fulfillment, and local refinement must name at least one real Feature
|
|
103
|
+
or Capability. A product-decision candidate may omit IDs only with
|
|
104
|
+
`decision_pending`, or while the same PR includes the proposed new record; do
|
|
105
|
+
not invent an ID to make the declaration look complete.
|
|
106
|
+
|
|
107
|
+
Run the focused declaration and workflow-policy tests with:
|
|
108
|
+
|
|
109
|
+
```sh
|
|
110
|
+
pnpm test:content-product-impact
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
To repair a warning, copy the block above into the PR body, replace the example
|
|
114
|
+
IDs with exact catalog IDs, align `record_change` with any changed product
|
|
115
|
+
records, and name the focused proof you actually ran.
|
|
116
|
+
|
|
117
|
+
The check is intentionally advisory while its deterministic rules calibrate.
|
|
118
|
+
It never edits the roadmap, assigns or tags a reviewer, and never turns an LLM
|
|
119
|
+
opinion into a merge gate. Shared framework changes with no direct Content
|
|
120
|
+
evidence should remain quiet.
|
|
121
|
+
|
|
75
122
|
## Prove and record the result
|
|
76
123
|
|
|
77
124
|
Use the affected Capability's proof requirements and the Feature's example
|
|
@@ -62,11 +62,11 @@ export declare const postAwareness: import("h3").EventHandlerWithFetch<import("h
|
|
|
62
62
|
error: string;
|
|
63
63
|
states?: undefined;
|
|
64
64
|
} | {
|
|
65
|
-
error?: undefined;
|
|
66
65
|
states: {
|
|
67
66
|
clientId: number;
|
|
68
67
|
state: string;
|
|
69
68
|
}[];
|
|
69
|
+
error?: undefined;
|
|
70
70
|
}>>;
|
|
71
71
|
/**
|
|
72
72
|
* GET /_agent-native/collab/:docId/users
|
|
@@ -77,10 +77,10 @@ export declare const getActiveUsers: import("h3").EventHandlerWithFetch<import("
|
|
|
77
77
|
error: string;
|
|
78
78
|
users?: undefined;
|
|
79
79
|
} | {
|
|
80
|
-
error?: undefined;
|
|
81
80
|
users: {
|
|
82
81
|
clientId: number;
|
|
83
82
|
lastSeen: number;
|
|
84
83
|
}[];
|
|
84
|
+
error?: undefined;
|
|
85
85
|
}>>;
|
|
86
86
|
//# sourceMappingURL=awareness.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"awareness.d.ts","sourceRoot":"","sources":["../../src/collab/awareness.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAgB3C,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAOD,eAAO,MAAM,sBAAsB,EAAG,kBAA2B,CAAC;AAElE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,WAAW,CAAC;IACpB,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,MAAM,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAOD,wBAAgB,mBAAmB,IAAI,YAAY,CAElD;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,cAAc,GAAG,SAAS,GAChC,IAAI,CAON;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,KAAK,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,EAClD,KAAK,CAAC,EAAE,cAAc,GACrB,IAAI,CAgBN;AAoBD,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAmB,GAC7B,IAAI,CAON;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAE1E;AAiBD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAO1E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAOnE;AAkCD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa
|
|
1
|
+
{"version":3,"file":"awareness.d.ts","sourceRoot":"","sources":["../../src/collab/awareness.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAgB3C,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAOD,eAAO,MAAM,sBAAsB,EAAG,kBAA2B,CAAC;AAElE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,WAAW,CAAC;IACpB,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,MAAM,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAOD,wBAAgB,mBAAmB,IAAI,YAAY,CAElD;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,cAAc,GAAG,SAAS,GAChC,IAAI,CAON;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,KAAK,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,EAClD,KAAK,CAAC,EAAE,cAAc,GACrB,IAAI,CAgBN;AAoBD,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAmB,GAC7B,IAAI,CAON;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAE1E;AAiBD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAO1E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAOnE;AAkCD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;;;;kBAwDa,MAAM;eAAS,MAAM;;;GAoB1D,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;kBAYM,MAAM;kBAAY,MAAM;;;GAMvD,CAAC"}
|
package/dist/collab/routes.d.ts
CHANGED
|
@@ -26,8 +26,8 @@ export declare const getCollabState: import("h3").EventHandlerWithFetch<import("
|
|
|
26
26
|
* Body: { update: string (base64), requestSource?: string }
|
|
27
27
|
*/
|
|
28
28
|
export declare const postCollabUpdate: import("h3").EventHandlerWithFetch<import("h3").EventHandlerRequest, Promise<{
|
|
29
|
-
error: string;
|
|
30
29
|
ok?: undefined;
|
|
30
|
+
error: string;
|
|
31
31
|
} | {
|
|
32
32
|
error?: undefined;
|
|
33
33
|
ok: boolean;
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
* Body: { json: any, fieldName?: string, type?: "map"|"array", requestSource?: string }
|
|
14
14
|
*/
|
|
15
15
|
export declare const postCollabJson: import("h3").EventHandlerWithFetch<import("h3").EventHandlerRequest, Promise<{
|
|
16
|
-
error: string;
|
|
17
16
|
ok?: undefined;
|
|
17
|
+
error: string;
|
|
18
18
|
} | {
|
|
19
19
|
error?: undefined;
|
|
20
20
|
ok: boolean;
|
|
@@ -137,13 +137,13 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
137
137
|
inputSchema: {
|
|
138
138
|
type: string;
|
|
139
139
|
properties: {
|
|
140
|
+
count?: undefined;
|
|
140
141
|
query?: undefined;
|
|
141
142
|
minutes?: undefined;
|
|
142
143
|
limit?: undefined;
|
|
143
144
|
clientHint?: undefined;
|
|
144
145
|
timestamp?: undefined;
|
|
145
146
|
chapterId?: undefined;
|
|
146
|
-
count?: undefined;
|
|
147
147
|
startAt?: undefined;
|
|
148
148
|
endAt?: undefined;
|
|
149
149
|
reason?: undefined;
|
|
@@ -159,6 +159,7 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
159
159
|
inputSchema: {
|
|
160
160
|
type: string;
|
|
161
161
|
properties: {
|
|
162
|
+
count?: undefined;
|
|
162
163
|
query: {
|
|
163
164
|
type: string;
|
|
164
165
|
description: string;
|
|
@@ -174,7 +175,6 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
174
175
|
clientHint?: undefined;
|
|
175
176
|
timestamp?: undefined;
|
|
176
177
|
chapterId?: undefined;
|
|
177
|
-
count?: undefined;
|
|
178
178
|
startAt?: undefined;
|
|
179
179
|
endAt?: undefined;
|
|
180
180
|
reason?: undefined;
|
|
@@ -190,6 +190,7 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
190
190
|
inputSchema: {
|
|
191
191
|
type: string;
|
|
192
192
|
properties: {
|
|
193
|
+
count?: undefined;
|
|
193
194
|
minutes: {
|
|
194
195
|
type: string;
|
|
195
196
|
description: string;
|
|
@@ -199,7 +200,6 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
199
200
|
clientHint?: undefined;
|
|
200
201
|
timestamp?: undefined;
|
|
201
202
|
chapterId?: undefined;
|
|
202
|
-
count?: undefined;
|
|
203
203
|
startAt?: undefined;
|
|
204
204
|
endAt?: undefined;
|
|
205
205
|
reason?: undefined;
|
|
@@ -216,6 +216,7 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
216
216
|
type: string;
|
|
217
217
|
required: string[];
|
|
218
218
|
properties: {
|
|
219
|
+
count?: undefined;
|
|
219
220
|
query: {
|
|
220
221
|
type: string;
|
|
221
222
|
description: string;
|
|
@@ -234,7 +235,6 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
234
235
|
};
|
|
235
236
|
timestamp?: undefined;
|
|
236
237
|
chapterId?: undefined;
|
|
237
|
-
count?: undefined;
|
|
238
238
|
startAt?: undefined;
|
|
239
239
|
endAt?: undefined;
|
|
240
240
|
reason?: undefined;
|
|
@@ -250,6 +250,7 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
250
250
|
type: string;
|
|
251
251
|
required: string[];
|
|
252
252
|
properties: {
|
|
253
|
+
count?: undefined;
|
|
253
254
|
query?: undefined;
|
|
254
255
|
minutes?: undefined;
|
|
255
256
|
limit?: undefined;
|
|
@@ -263,7 +264,6 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
263
264
|
description: string;
|
|
264
265
|
};
|
|
265
266
|
chapterId?: undefined;
|
|
266
|
-
count?: undefined;
|
|
267
267
|
startAt?: undefined;
|
|
268
268
|
endAt?: undefined;
|
|
269
269
|
includeMicrophone?: undefined;
|
|
@@ -314,13 +314,13 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
314
314
|
type: string;
|
|
315
315
|
required: string[];
|
|
316
316
|
properties: {
|
|
317
|
+
count?: undefined;
|
|
317
318
|
query?: undefined;
|
|
318
319
|
minutes?: undefined;
|
|
319
320
|
limit?: undefined;
|
|
320
321
|
clientHint?: undefined;
|
|
321
322
|
timestamp?: undefined;
|
|
322
323
|
chapterId?: undefined;
|
|
323
|
-
count?: undefined;
|
|
324
324
|
startAt: {
|
|
325
325
|
type: string;
|
|
326
326
|
description: string;
|
|
@@ -349,13 +349,13 @@ export declare function screenMemoryMcpToolDefinitions(): ({
|
|
|
349
349
|
type: string;
|
|
350
350
|
required: string[];
|
|
351
351
|
properties: {
|
|
352
|
+
count?: undefined;
|
|
352
353
|
query?: undefined;
|
|
353
354
|
minutes?: undefined;
|
|
354
355
|
limit?: undefined;
|
|
355
356
|
clientHint?: undefined;
|
|
356
357
|
timestamp?: undefined;
|
|
357
358
|
chapterId?: undefined;
|
|
358
|
-
count?: undefined;
|
|
359
359
|
startAt?: undefined;
|
|
360
360
|
endAt?: undefined;
|
|
361
361
|
reason?: undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screen-memory-stdio.d.ts","sourceRoot":"","sources":["../../src/mcp/screen-memory-stdio.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAiBhF,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,SAAS,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,YAAY,EAAE,KAAK,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,QAAQ,EAAE,KAAK,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC,CAAC;IACH,qBAAqB,EAAE,KAAK,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH,sBAAsB,CAAC,EACnB,MAAM,GACN;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC;IACvE,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;CAC7C;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CACjD;AAWD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,wBAAwB,CAAC;CACxC;AA8RD,4FAA4F;AAC5F,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,MAAM,GACf,4BAA4B,GAAG,IAAI,CA2BrC;AAED,KAAK,eAAe,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAsBF,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,MAAM,EACb,KAAK,SAAI,EACT,UAAU,CAAC,EAAE,MAAM,GAClB,KAAK,CACN,mBAAmB,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,eAAe,EAAE,eAAe,EAAE,CAAC;CACpC,CACF,CA+HA;AAED,wBAAgB,mCAAmC,CACjD,OAAO,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC;;;;;;;;;;;;;;kBAlhBlD,MAAM;sBACF,MAAM;mBACT,MAAM;;;;;;;;uBAWE,MAAM;qBAAe,MAAM;mBAAa,OAAO;;;;;;;EA2iBrE;AAqGD,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,wBAAgD;;;;QAVrD,IAAI,EAAE,OAAO;QACb,IAAI;QACJ,QAAQ;;EAeb;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CAsCV;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,OAAO,GAC1B,OAAO,CAET;AAiCD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAW1D;AAgHD,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,GACxD,IAAI,CAgBN;AAkDD,wBAAgB,8BAA8B
|
|
1
|
+
{"version":3,"file":"screen-memory-stdio.d.ts","sourceRoot":"","sources":["../../src/mcp/screen-memory-stdio.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAiBhF,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,SAAS,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,YAAY,EAAE,KAAK,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,QAAQ,EAAE,KAAK,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC,CAAC;IACH,qBAAqB,EAAE,KAAK,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH,sBAAsB,CAAC,EACnB,MAAM,GACN;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC;IACvE,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;CAC7C;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CACjD;AAWD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,wBAAwB,CAAC;CACxC;AA8RD,4FAA4F;AAC5F,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,MAAM,GACf,4BAA4B,GAAG,IAAI,CA2BrC;AAED,KAAK,eAAe,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAsBF,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,MAAM,EACb,KAAK,SAAI,EACT,UAAU,CAAC,EAAE,MAAM,GAClB,KAAK,CACN,mBAAmB,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,eAAe,EAAE,eAAe,EAAE,CAAC;CACpC,CACF,CA+HA;AAED,wBAAgB,mCAAmC,CACjD,OAAO,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC;;;;;;;;;;;;;;kBAlhBlD,MAAM;sBACF,MAAM;mBACT,MAAM;;;;;;;;uBAWE,MAAM;qBAAe,MAAM;mBAAa,OAAO;;;;;;;EA2iBrE;AAqGD,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,wBAAgD;;;;QAVrD,IAAI,EAAE,OAAO;QACb,IAAI;QACJ,QAAQ;;EAeb;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CAsCV;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,OAAO,GAC1B,OAAO,CAET;AAiCD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAW1D;AAgHD,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,GACxD,IAAI,CAgBN;AAkDD,wBAAgB,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAgBlC,IAAI;gBACJ,WAAW;;;gBAGX,IAAI;gBACJ,WAAW;;;gBAGX,IAAI;gBACJ,WAAW;;;;;;;;;;;;;;;;;;;;;;gBAaX,IAAI;gBACJ,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;gBAcX,IAAI;gBACJ,WAAW;;;gBAIX,IAAI;gBACJ,WAAW;;;gBAGX,IAAI;gBACJ,WAAW;;;gBAGX,IAAI;gBACJ,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;gBAeX,IAAI;gBACJ,WAAW;;;gBAGX,IAAI;gBACJ,WAAW;;;;;;;;;;;;;;;;;;;;;;gBAYA,IAAI;;;;;;;;;;;gBAIf,IAAI;gBACJ,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAcF,IAAI;gBAAY,WAAW;;;gBAC7B,IAAI;gBAAY,WAAW;;;gBAElC,IAAI;gBACJ,WAAW;;;gBAEQ,IAAI;;;gBACH,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;gBAWD,IAAI;;;;KAItC;AAED,wBAAsB,gCAAgC,CACpD,IAAI,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC,CAAC,CAAC,EACpD,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,CAAC,UAAU,mFAavB;AAED,wBAAsB,uBAAuB,CAC3C,IAAI,GAAE,8BAAmC,GACxC,OAAO,CAAC,IAAI,CAAC,CAkaf"}
|
|
@@ -16,19 +16,19 @@ export declare function createNotificationsHandler(): import("h3").EventHandlerW
|
|
|
16
16
|
error?: undefined;
|
|
17
17
|
ok?: undefined;
|
|
18
18
|
} | {
|
|
19
|
+
count?: undefined;
|
|
19
20
|
updated: number;
|
|
20
21
|
error?: undefined;
|
|
21
22
|
ok?: undefined;
|
|
22
|
-
count?: undefined;
|
|
23
23
|
} | {
|
|
24
|
+
count?: undefined;
|
|
24
25
|
updated?: undefined;
|
|
25
26
|
error: string;
|
|
26
27
|
ok?: undefined;
|
|
27
|
-
count?: undefined;
|
|
28
28
|
} | {
|
|
29
|
+
count?: undefined;
|
|
29
30
|
updated?: undefined;
|
|
30
|
-
ok: boolean;
|
|
31
31
|
error?: undefined;
|
|
32
|
-
|
|
32
|
+
ok: boolean;
|
|
33
33
|
}>>;
|
|
34
34
|
//# sourceMappingURL=routes.d.ts.map
|
|
@@ -48,8 +48,8 @@ export declare function handleUpdateResource(event: any): Promise<import("./stor
|
|
|
48
48
|
}>;
|
|
49
49
|
/** DELETE /_agent-native/resources/:id — delete a resource */
|
|
50
50
|
export declare function handleDeleteResource(event: any): Promise<{
|
|
51
|
-
error: string;
|
|
52
51
|
ok?: undefined;
|
|
52
|
+
error: string;
|
|
53
53
|
} | {
|
|
54
54
|
error?: undefined;
|
|
55
55
|
ok: boolean;
|
|
@@ -27,11 +27,11 @@ export declare function resolveAgentEngineApiKeyWriteTarget(event: H3Event, scop
|
|
|
27
27
|
export declare function createAgentEngineApiKeyHandler(): import("h3").EventHandlerWithFetch<import("h3").EventHandlerRequest, Promise<{
|
|
28
28
|
error: any;
|
|
29
29
|
} | {
|
|
30
|
+
error?: undefined;
|
|
30
31
|
ok: boolean;
|
|
31
32
|
key: string;
|
|
32
33
|
baseUrlKey?: string;
|
|
33
34
|
scope: AgentEngineApiKeyScope;
|
|
34
|
-
error?: undefined;
|
|
35
35
|
}>>;
|
|
36
36
|
export {};
|
|
37
37
|
//# sourceMappingURL=agent-engine-api-key-route.d.ts.map
|
|
@@ -26,9 +26,9 @@ export declare function createRealtimeTokenHandler(): import("h3").EventHandlerW
|
|
|
26
26
|
expiresAt?: undefined;
|
|
27
27
|
ttlSeconds?: undefined;
|
|
28
28
|
} | {
|
|
29
|
-
error?: undefined;
|
|
30
29
|
token: string;
|
|
31
30
|
expiresAt: string;
|
|
32
31
|
ttlSeconds: number;
|
|
32
|
+
error?: undefined;
|
|
33
33
|
}>>;
|
|
34
34
|
//# sourceMappingURL=realtime-token.d.ts.map
|
|
@@ -0,0 +1,491 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Docs components"
|
|
3
|
+
description: "Reference for every MDX component available in the Agent Native docs, with live rendered examples and copy-paste syntax."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Docs components
|
|
7
|
+
|
|
8
|
+
The docs site renders standard Markdown plus a set of MDX block components for
|
|
9
|
+
richer content. Each section below shows a live rendered example followed by
|
|
10
|
+
the exact MDX syntax that produced it.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Callout
|
|
15
|
+
|
|
16
|
+
<Callout tone="info">
|
|
17
|
+
|
|
18
|
+
This is an `info` callout. Use it for background context or neutral notes. You can use **bold**, `inline code`, and [links](/docs/getting-started) inside.
|
|
19
|
+
|
|
20
|
+
</Callout>
|
|
21
|
+
|
|
22
|
+
<Callout tone="warning">
|
|
23
|
+
|
|
24
|
+
This is a `warning` callout. Use it for potential data loss, breaking changes, or hard-to-reverse steps. For example: restart `pnpm dev` after adding a new route file — the router only picks up files present at startup.
|
|
25
|
+
|
|
26
|
+
</Callout>
|
|
27
|
+
|
|
28
|
+
<Callout tone="success">
|
|
29
|
+
|
|
30
|
+
This is a `success` callout. Use it for the recommended path or to confirm a working approach.
|
|
31
|
+
|
|
32
|
+
</Callout>
|
|
33
|
+
|
|
34
|
+
<Callout tone="risk">
|
|
35
|
+
|
|
36
|
+
This is a `risk` callout. Use it for security implications or production caveats.
|
|
37
|
+
|
|
38
|
+
</Callout>
|
|
39
|
+
|
|
40
|
+
<Callout tone="decision">
|
|
41
|
+
|
|
42
|
+
This is a `decision` callout. Use it to surface a deliberate tradeoff the reader should understand.
|
|
43
|
+
|
|
44
|
+
</Callout>
|
|
45
|
+
|
|
46
|
+
```mdx
|
|
47
|
+
<Callout tone="info">
|
|
48
|
+
|
|
49
|
+
This is an `info` callout. Use it for background context or neutral notes. You can use **bold**, `inline code`, and [links](/docs/getting-started) inside.
|
|
50
|
+
|
|
51
|
+
</Callout>
|
|
52
|
+
|
|
53
|
+
<Callout tone="warning">
|
|
54
|
+
|
|
55
|
+
This is a `warning` callout. Use it for potential data loss, breaking changes, or hard-to-reverse steps. For example: restart `pnpm dev` after adding a new route file — the router only picks up files present at startup.
|
|
56
|
+
|
|
57
|
+
</Callout>
|
|
58
|
+
|
|
59
|
+
<Callout tone="success">
|
|
60
|
+
|
|
61
|
+
This is a `success` callout. Use it for the recommended path or to confirm a working approach.
|
|
62
|
+
|
|
63
|
+
</Callout>
|
|
64
|
+
|
|
65
|
+
<Callout tone="risk">
|
|
66
|
+
|
|
67
|
+
This is a `risk` callout. Use it for security implications or production caveats.
|
|
68
|
+
|
|
69
|
+
</Callout>
|
|
70
|
+
|
|
71
|
+
<Callout tone="decision">
|
|
72
|
+
|
|
73
|
+
This is a `decision` callout. Use it to surface a deliberate tradeoff the reader should understand.
|
|
74
|
+
|
|
75
|
+
</Callout>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
| Tone | When to use |
|
|
79
|
+
| ---------- | ------------------------------------------------------------ |
|
|
80
|
+
| `info` | Background context, neutral notes |
|
|
81
|
+
| `warning` | Potential data loss, breaking changes, hard-to-reverse steps |
|
|
82
|
+
| `success` | Recommended option, confirmed working path |
|
|
83
|
+
| `risk` | Security implications, production caveats |
|
|
84
|
+
| `decision` | Deliberate tradeoffs the reader should understand |
|
|
85
|
+
|
|
86
|
+
Leave a blank line between the opening tag and the body, and another before the closing tag.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Steps
|
|
91
|
+
|
|
92
|
+
<Steps>
|
|
93
|
+
|
|
94
|
+
### Install dependencies
|
|
95
|
+
|
|
96
|
+
Run the following inside your project directory:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
pnpm install
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Start the dev server
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
pnpm dev
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Open `http://localhost:3000`. The app is ready when **VITE ready** appears in the terminal.
|
|
109
|
+
|
|
110
|
+
### Sign in
|
|
111
|
+
|
|
112
|
+
The first run shows a login screen. Use any credentials — local development does not send email.
|
|
113
|
+
|
|
114
|
+
</Steps>
|
|
115
|
+
|
|
116
|
+
````mdx
|
|
117
|
+
<Steps>
|
|
118
|
+
|
|
119
|
+
### Install dependencies
|
|
120
|
+
|
|
121
|
+
Run the following inside your project directory:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
pnpm install
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Start the dev server
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
pnpm dev
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Open `http://localhost:3000`. The app is ready when **VITE ready** appears in the terminal.
|
|
134
|
+
|
|
135
|
+
### Sign in
|
|
136
|
+
|
|
137
|
+
The first run shows a login screen. Use any credentials — local development does not send email.
|
|
138
|
+
|
|
139
|
+
</Steps>
|
|
140
|
+
````
|
|
141
|
+
|
|
142
|
+
Each step is a `###` heading followed by the body content. Steps work best for 3–8 items. For 2 items a numbered list is fine. For longer procedures, split into multiple `<Steps>` blocks with a prose bridge between them.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Cards
|
|
147
|
+
|
|
148
|
+
<Cards>
|
|
149
|
+
|
|
150
|
+
### [Actions](/docs/actions)
|
|
151
|
+
|
|
152
|
+
Typed operations callable from the agent, UI, CLI, and HTTP. Define once, call from anywhere.
|
|
153
|
+
|
|
154
|
+
### [Database](/docs/database)
|
|
155
|
+
|
|
156
|
+
SQL persistence with automatic migrations. SQLite locally, Postgres/Turso in production.
|
|
157
|
+
|
|
158
|
+
### [Agent Surfaces](/docs/agent-surfaces)
|
|
159
|
+
|
|
160
|
+
Configure where the agent appears: full-page chat, sidebar panel, or embedded in a route.
|
|
161
|
+
|
|
162
|
+
### Skills
|
|
163
|
+
|
|
164
|
+
Plain-text instruction files that give the agent domain knowledge and task-specific behavior without code changes.
|
|
165
|
+
|
|
166
|
+
</Cards>
|
|
167
|
+
|
|
168
|
+
```mdx
|
|
169
|
+
<Cards>
|
|
170
|
+
|
|
171
|
+
### [Actions](/docs/actions)
|
|
172
|
+
|
|
173
|
+
Typed operations callable from the agent, UI, CLI, and HTTP. Define once, call from anywhere.
|
|
174
|
+
|
|
175
|
+
### [Database](/docs/database)
|
|
176
|
+
|
|
177
|
+
SQL persistence with automatic migrations. SQLite locally, Postgres/Turso in production.
|
|
178
|
+
|
|
179
|
+
### [Agent Surfaces](/docs/agent-surfaces)
|
|
180
|
+
|
|
181
|
+
Configure where the agent appears: full-page chat, sidebar panel, or embedded in a route.
|
|
182
|
+
|
|
183
|
+
### Skills
|
|
184
|
+
|
|
185
|
+
Plain-text instruction files that give the agent domain knowledge and task-specific behavior without code changes.
|
|
186
|
+
|
|
187
|
+
</Cards>
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
Each card is a `###` heading (optionally linked) followed by the description. Cards without a link render as plain info boxes with no hover state or arrow.
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Comparison
|
|
195
|
+
|
|
196
|
+
<Comparison>
|
|
197
|
+
|
|
198
|
+
### Before
|
|
199
|
+
|
|
200
|
+
Every feature needs a separate API endpoint, a separate React query, and manual wiring between the AI response and UI state.
|
|
201
|
+
|
|
202
|
+
### After
|
|
203
|
+
|
|
204
|
+
Define one action. The agent calls it as a tool, the UI calls it through a React hook, and both read the same validated output.
|
|
205
|
+
|
|
206
|
+
</Comparison>
|
|
207
|
+
|
|
208
|
+
```mdx
|
|
209
|
+
<Comparison>
|
|
210
|
+
|
|
211
|
+
### Before
|
|
212
|
+
|
|
213
|
+
Every feature needs a separate API endpoint, a separate React query, and manual wiring between the AI response and UI state.
|
|
214
|
+
|
|
215
|
+
### After
|
|
216
|
+
|
|
217
|
+
Define one action. The agent calls it as a tool, the UI calls it through a React hook, and both read the same validated output.
|
|
218
|
+
|
|
219
|
+
</Comparison>
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Add more `###` sections to get 3 or 4 columns (max 4). The red/green label accent only applies to headings that exactly match `Before`, `Old`, `Without` (red) or `After`, `New`, `With` (green).
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## kbd — keyboard shortcut
|
|
227
|
+
|
|
228
|
+
Press [[⌘K]] to open the command palette. Save with [[Ctrl+S]] before running the dev server. Navigate fields with [[Tab]] and [[Shift+Tab]].
|
|
229
|
+
|
|
230
|
+
```mdx
|
|
231
|
+
Press [[⌘K]] to open the command palette. Save with [[Ctrl+S]] before running the dev server. Navigate fields with [[Tab]] and [[Shift+Tab]].
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Double brackets around the key sequence; no MDX component needed. Works anywhere in regular Markdown paragraphs.
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## Mermaid diagram
|
|
239
|
+
|
|
240
|
+
```mermaid
|
|
241
|
+
graph LR
|
|
242
|
+
A[defineAction] --> B[Agent calls it as a tool]
|
|
243
|
+
A --> C[UI calls it via useActionQuery]
|
|
244
|
+
A --> D[CLI calls it directly]
|
|
245
|
+
A --> E[HTTP API]
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
````mdx
|
|
249
|
+
```mermaid
|
|
250
|
+
graph LR
|
|
251
|
+
A[defineAction] --> B[Agent calls it as a tool]
|
|
252
|
+
A --> C[UI calls it via useActionQuery]
|
|
253
|
+
A --> D[CLI calls it directly]
|
|
254
|
+
A --> E[HTTP API]
|
|
255
|
+
```
|
|
256
|
+
````
|
|
257
|
+
|
|
258
|
+
Use a fenced code block with the `mermaid` language tag. Mermaid supports flowcharts (`graph`), sequence diagrams (`sequenceDiagram`), entity-relationship diagrams (`erDiagram`), and more. See [mermaid.js.org](https://mermaid.js.org/intro/) for the full syntax reference.
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## FileTree
|
|
263
|
+
|
|
264
|
+
<FileTree
|
|
265
|
+
id="docs-components-filetree"
|
|
266
|
+
entries={[
|
|
267
|
+
{
|
|
268
|
+
path: "actions/analyze-text.ts",
|
|
269
|
+
change: "added",
|
|
270
|
+
note: "New action — callable from agent, UI, and CLI",
|
|
271
|
+
},
|
|
272
|
+
{ path: "actions/list-text-analyses.ts", change: "added" },
|
|
273
|
+
{ path: "app/routes/analyses.tsx", change: "modified" },
|
|
274
|
+
{
|
|
275
|
+
path: "app/config/nav.ts",
|
|
276
|
+
change: "modified",
|
|
277
|
+
note: "Add the new route to the sidebar nav",
|
|
278
|
+
},
|
|
279
|
+
{ path: "db/migrations/001_analyses.sql" },
|
|
280
|
+
]}
|
|
281
|
+
/>
|
|
282
|
+
|
|
283
|
+
```mdx
|
|
284
|
+
<FileTree
|
|
285
|
+
id="docs-components-filetree"
|
|
286
|
+
entries={[
|
|
287
|
+
{
|
|
288
|
+
path: "actions/analyze-text.ts",
|
|
289
|
+
change: "added",
|
|
290
|
+
note: "New action — callable from agent, UI, and CLI",
|
|
291
|
+
},
|
|
292
|
+
{ path: "actions/list-text-analyses.ts", change: "added" },
|
|
293
|
+
{ path: "app/routes/analyses.tsx", change: "modified" },
|
|
294
|
+
{
|
|
295
|
+
path: "app/config/nav.ts",
|
|
296
|
+
change: "modified",
|
|
297
|
+
note: "Add the new route to the sidebar nav",
|
|
298
|
+
},
|
|
299
|
+
{ path: "db/migrations/001_analyses.sql" },
|
|
300
|
+
]}
|
|
301
|
+
/>
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
FileTree is **self-closing** (`/>`). It does not accept Markdown children — if you use open/close tags with content inside you will get a parse error.
|
|
305
|
+
|
|
306
|
+
Each entry in `entries` is an object with a `path` key (slash-delimited) and optional fields:
|
|
307
|
+
|
|
308
|
+
| Field | Values | Effect |
|
|
309
|
+
| ---------- | ------------------------------------------------------- | ------------------------------------ |
|
|
310
|
+
| `change` | `"added"` \| `"modified"` \| `"removed"` \| `"renamed"` | Colored badge on the row |
|
|
311
|
+
| `note` | any string | Expandable annotation shown on hover |
|
|
312
|
+
| `snippet` | code string | Expandable code preview |
|
|
313
|
+
| `language` | e.g. `"ts"` | Syntax highlighting for the snippet |
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## Tabs
|
|
318
|
+
|
|
319
|
+
<TabsBlock
|
|
320
|
+
id="docs-components-tabs"
|
|
321
|
+
tabs={[
|
|
322
|
+
{
|
|
323
|
+
id: "pnpm",
|
|
324
|
+
label: "pnpm",
|
|
325
|
+
blocks: [
|
|
326
|
+
{
|
|
327
|
+
type: "code",
|
|
328
|
+
id: "pnpm-install",
|
|
329
|
+
data: { code: "pnpm install", language: "bash" },
|
|
330
|
+
},
|
|
331
|
+
],
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
id: "npm",
|
|
335
|
+
label: "npm",
|
|
336
|
+
blocks: [
|
|
337
|
+
{
|
|
338
|
+
type: "code",
|
|
339
|
+
id: "npm-install",
|
|
340
|
+
data: { code: "npm install", language: "bash" },
|
|
341
|
+
},
|
|
342
|
+
],
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
id: "yarn",
|
|
346
|
+
label: "yarn",
|
|
347
|
+
blocks: [
|
|
348
|
+
{
|
|
349
|
+
type: "code",
|
|
350
|
+
id: "yarn-install",
|
|
351
|
+
data: { code: "yarn install", language: "bash" },
|
|
352
|
+
},
|
|
353
|
+
],
|
|
354
|
+
},
|
|
355
|
+
]}
|
|
356
|
+
/>
|
|
357
|
+
|
|
358
|
+
```mdx
|
|
359
|
+
<TabsBlock
|
|
360
|
+
id="docs-components-tabs"
|
|
361
|
+
tabs={[
|
|
362
|
+
{
|
|
363
|
+
id: "pnpm",
|
|
364
|
+
label: "pnpm",
|
|
365
|
+
blocks: [
|
|
366
|
+
{
|
|
367
|
+
type: "code",
|
|
368
|
+
id: "pnpm-install",
|
|
369
|
+
data: { code: "pnpm install", language: "bash" },
|
|
370
|
+
},
|
|
371
|
+
],
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
id: "npm",
|
|
375
|
+
label: "npm",
|
|
376
|
+
blocks: [
|
|
377
|
+
{
|
|
378
|
+
type: "code",
|
|
379
|
+
id: "npm-install",
|
|
380
|
+
data: { code: "npm install", language: "bash" },
|
|
381
|
+
},
|
|
382
|
+
],
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
id: "yarn",
|
|
386
|
+
label: "yarn",
|
|
387
|
+
blocks: [
|
|
388
|
+
{
|
|
389
|
+
type: "code",
|
|
390
|
+
id: "yarn-install",
|
|
391
|
+
data: { code: "yarn install", language: "bash" },
|
|
392
|
+
},
|
|
393
|
+
],
|
|
394
|
+
},
|
|
395
|
+
]}
|
|
396
|
+
/>
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
`TabsBlock` is self-closing. The entire structure is one JSON `tabs` attribute. Each tab's content is a `blocks` array where each item is a block object with `type`, `id`, and `data` matching that block's schema. Tabs works best for short parallel code snippets (one code block per tab). For richer multi-block content per tab, use a visual editor rather than hand-authoring the JSON.
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
## Columns
|
|
404
|
+
|
|
405
|
+
<Columns
|
|
406
|
+
id="docs-components-columns"
|
|
407
|
+
columns={[
|
|
408
|
+
{
|
|
409
|
+
id: "col-manual",
|
|
410
|
+
label: "Manual approach",
|
|
411
|
+
blocks: [
|
|
412
|
+
{
|
|
413
|
+
type: "code",
|
|
414
|
+
id: "manual-code",
|
|
415
|
+
data: {
|
|
416
|
+
code: "const res = await fetch('/api/analyses')\nconst data = await res.json()",
|
|
417
|
+
language: "ts",
|
|
418
|
+
},
|
|
419
|
+
},
|
|
420
|
+
],
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
id: "col-actions",
|
|
424
|
+
label: "With actions",
|
|
425
|
+
blocks: [
|
|
426
|
+
{
|
|
427
|
+
type: "code",
|
|
428
|
+
id: "action-code",
|
|
429
|
+
data: {
|
|
430
|
+
code: "const { data } = useActionQuery('list-text-analyses', {})",
|
|
431
|
+
language: "ts",
|
|
432
|
+
},
|
|
433
|
+
},
|
|
434
|
+
],
|
|
435
|
+
},
|
|
436
|
+
]}
|
|
437
|
+
/>
|
|
438
|
+
|
|
439
|
+
```mdx
|
|
440
|
+
<Columns
|
|
441
|
+
id="docs-components-columns"
|
|
442
|
+
columns={[
|
|
443
|
+
{
|
|
444
|
+
id: "col-manual",
|
|
445
|
+
label: "Manual approach",
|
|
446
|
+
blocks: [
|
|
447
|
+
{
|
|
448
|
+
type: "code",
|
|
449
|
+
id: "manual-code",
|
|
450
|
+
data: {
|
|
451
|
+
code: "const res = await fetch('/api/analyses')\nconst data = await res.json()",
|
|
452
|
+
language: "ts",
|
|
453
|
+
},
|
|
454
|
+
},
|
|
455
|
+
],
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
id: "col-actions",
|
|
459
|
+
label: "With actions",
|
|
460
|
+
blocks: [
|
|
461
|
+
{
|
|
462
|
+
type: "code",
|
|
463
|
+
id: "action-code",
|
|
464
|
+
data: {
|
|
465
|
+
code: "const { data } = useActionQuery('list-text-analyses', {})",
|
|
466
|
+
language: "ts",
|
|
467
|
+
},
|
|
468
|
+
},
|
|
469
|
+
],
|
|
470
|
+
},
|
|
471
|
+
]}
|
|
472
|
+
/>
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
Like `TabsBlock`, `Columns` is self-closing with a single JSON `columns` attribute. Each column has an optional `label` header and a `blocks` array. For comparing prose rather than code, `Comparison` is easier to hand-author.
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
## When to use which component
|
|
480
|
+
|
|
481
|
+
| Situation | Component |
|
|
482
|
+
| ----------------------------------------- | ------------------------------------ |
|
|
483
|
+
| Reader must not miss something | `Callout` (warning / info / success) |
|
|
484
|
+
| Sequential procedure with titled steps | `Steps` |
|
|
485
|
+
| Navigation or feature overview grid | `Cards` |
|
|
486
|
+
| Before vs. after, old vs. new (prose) | `Comparison` |
|
|
487
|
+
| Same task in multiple tools or frameworks | `Tabs` |
|
|
488
|
+
| Side-by-side code (labeled columns) | `Columns` |
|
|
489
|
+
| Project directory structure | `FileTree` |
|
|
490
|
+
| Inline keyboard shortcut | `[[Key]]` |
|
|
491
|
+
| Architecture or flow diagram | Mermaid fence |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-native/core",
|
|
3
|
-
"version": "0.131.
|
|
3
|
+
"version": "0.131.5",
|
|
4
4
|
"description": "Framework for agent-native application development — where AI agents and UI share SQL state, actions, and context",
|
|
5
5
|
"homepage": "https://github.com/BuilderIO/agent-native#readme",
|
|
6
6
|
"bugs": {
|