@robota-sdk/agent-interface-tui 3.0.0-beta.66 → 3.0.0-beta.67
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @robota-sdk/agent-interface-tui
|
|
2
|
+
|
|
3
|
+
TUI interaction contracts for the Robota SDK. This package contains only type contracts and type guards — no implementation, no React, no Ink.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @robota-sdk/agent-interface-tui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Overview
|
|
12
|
+
|
|
13
|
+
Defines the interaction protocol between command handlers (which may run at any layer) and TUI renderers (which live in `@robota-sdk/agent-transport`).
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
agent-interface-tui ← this package (contracts only)
|
|
17
|
+
├── ITuiCommandInteraction ← base: optional onMissingArgs action
|
|
18
|
+
├── ITuiPickerInteraction ← requires picker UI
|
|
19
|
+
├── ITuiConfirmInteraction ← requires confirm UI
|
|
20
|
+
└── TAnyTuiCommandInteraction ← union of all interaction shapes
|
|
21
|
+
|
|
22
|
+
agent-transport/tui
|
|
23
|
+
└── useSideEffects ← renders interactions via ITuiCliAdapter
|
|
24
|
+
|
|
25
|
+
agent-command/*
|
|
26
|
+
└── command descriptors ← annotate onMissingArgs to trigger interaction
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## API
|
|
30
|
+
|
|
31
|
+
### Interfaces
|
|
32
|
+
|
|
33
|
+
| Export | Description |
|
|
34
|
+
| ------------------------ | --------------------------------------------------------- |
|
|
35
|
+
| `ITuiCommandInteraction` | Base interaction: optional `onMissingArgs` |
|
|
36
|
+
| `ITuiPickerInteraction` | Picker variant: `getItems()` returning `ITuiPickerItem[]` |
|
|
37
|
+
| `ITuiPickerItem` | Item in a picker list: `label`, `value`, `description?` |
|
|
38
|
+
| `ITuiConfirmInteraction` | Confirm variant: `message` string prompt |
|
|
39
|
+
|
|
40
|
+
### Types
|
|
41
|
+
|
|
42
|
+
| Export | Description |
|
|
43
|
+
| --------------------------- | ----------------------------------- |
|
|
44
|
+
| `TAnyTuiCommandInteraction` | Union of all interaction variants |
|
|
45
|
+
| `TOnMissingArgsAction` | `'picker' \| 'wizard' \| 'confirm'` |
|
|
46
|
+
|
|
47
|
+
### Type Guards
|
|
48
|
+
|
|
49
|
+
| Export | Description |
|
|
50
|
+
| ---------------------- | ----------------------------------- |
|
|
51
|
+
| `isPickerInteraction` | Narrows to `ITuiPickerInteraction` |
|
|
52
|
+
| `isConfirmInteraction` | Narrows to `ITuiConfirmInteraction` |
|
|
53
|
+
|
|
54
|
+
## Boundaries
|
|
55
|
+
|
|
56
|
+
- **No runtime dependencies** — this package must never gain runtime dependencies.
|
|
57
|
+
- No framework or provider knowledge may enter this package.
|
|
58
|
+
- Rendering implementation lives in `@robota-sdk/agent-transport`.
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@robota-sdk/agent-interface-tui",
|
|
3
|
-
"version": "3.0.0-beta.
|
|
3
|
+
"version": "3.0.0-beta.67",
|
|
4
4
|
"description": "TUI interaction contract interfaces for the Robota SDK (ITuiPickerItem, ITuiCommandInteraction, ITuiPickerInteraction, ITuiConfirmInteraction)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/node/index.js",
|