@pouchy_ai/companion-sdk 0.19.0 → 0.19.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +22 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -12,6 +12,17 @@ a protocol bump is always called out explicitly here.
|
|
|
12
12
|
|
|
13
13
|
## [Unreleased]
|
|
14
14
|
|
|
15
|
+
## [0.19.1] - 2026-07-10
|
|
16
|
+
|
|
17
|
+
### Documentation
|
|
18
|
+
|
|
19
|
+
- README gains a client-method reference table (memory ingest, history,
|
|
20
|
+
setModalities, ping, pendingConfirms/confirmAction incl. the
|
|
21
|
+
exec_failed/retryable retry contract, endSession skipped reasons, close(),
|
|
22
|
+
startCall/connectCall, getAvatar/brandIconUrl) plus a note on
|
|
23
|
+
HOST_CONTROL_TOOLS and AVATAR_VISUAL_TOOLS (declare-or-silent-no-op).
|
|
24
|
+
No code change.
|
|
25
|
+
|
|
15
26
|
## [0.19.0] - 2026-07-10
|
|
16
27
|
|
|
17
28
|
### Added
|
package/README.md
CHANGED
|
@@ -92,6 +92,28 @@ Reference renderers ship in [`examples/`](../../examples): `web-instant-ui` (van
|
|
|
92
92
|
`native-instant-ui` (SwiftUI + Jetpack Compose), and `cli-skills` (terminal +
|
|
93
93
|
local/device skills).
|
|
94
94
|
|
|
95
|
+
## Client methods (beyond the quickstart)
|
|
96
|
+
|
|
97
|
+
| Method | What it does |
|
|
98
|
+
|---|---|
|
|
99
|
+
| `recall(query)` / `remember(text)` | Read / write the token-scoped memory namespace. |
|
|
100
|
+
| `ingestKnowledge(text, opts?)` / `ingestFile(file)` | Push documents into the user's knowledge base ("My materials"); needs `memory.write:core`. |
|
|
101
|
+
| `history(limit?)` | Fetch the session transcript — restore chat on reload. |
|
|
102
|
+
| `setModalities([...])` | Switch active I/O mid-session (within the token's grant). |
|
|
103
|
+
| `ping()` | Keepalive for long-idle embeds. |
|
|
104
|
+
| `pendingConfirms()` / `confirmAction(id, approve)` | List / resolve pending sensitive-action confirms (platform session tokens). On `{ status: 'exec_failed', retryable: true }` you MAY re-call the same confirmId — idempotent actions only. |
|
|
105
|
+
| `endSession()` | Distill the session into durable memory now; returns `{ skipped?: 'no_session' \| 'no_content' \| 'throttled' }`. |
|
|
106
|
+
| `close()` | One-call teardown: `stop()` + `endSession()` — the text-session mirror of the call handle's `close()`. |
|
|
107
|
+
| `startCall(opts)` / `connectCall(opts)` | Voice plane: raw credentials / fully-wired call handle (`call.close()` ends + folds the transcript into memory). |
|
|
108
|
+
| `getAvatar()` / `brandIconUrl(size?)` | The user's avatar (VRM/portrait) and the Pouchy brand icon for your UI. |
|
|
109
|
+
|
|
110
|
+
Tool calling beyond your own declared tools: `HOST_CONTROL_TOOLS` (universal
|
|
111
|
+
verbs — `invoke_action`, `set_feature`, `set_value`, `navigate`, `highlight`)
|
|
112
|
+
are offered automatically once you declare `tools`/`handles`, and
|
|
113
|
+
`AVATAR_VISUAL_TOOLS` (`play_gesture` / `play_expression`) let avatar-rendering
|
|
114
|
+
embeds receive expression cues — declare them or they no-op silently. Full
|
|
115
|
+
contract: `docs/companion-host-control.md`.
|
|
116
|
+
|
|
95
117
|
## Scopes (typed)
|
|
96
118
|
|
|
97
119
|
The full capability-scope vocabulary ships as typed constants — no more
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pouchy_ai/companion-sdk",
|
|
3
|
-
"version": "0.19.
|
|
3
|
+
"version": "0.19.1",
|
|
4
4
|
"description": "Embed the Pouchy companion — chat, voice, tools, memory, live world-state, instant UI, and agent-to-agent messaging — in any app, game, or site.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE",
|