@shardworks/animator-apparatus 0.1.111 → 0.1.113

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.
Files changed (2) hide show
  1. package/README.md +10 -3
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -7,7 +7,7 @@ The Animator brings animas to life. It is the guild's session apparatus — the
7
7
 
8
8
  Both methods return an `AnimateHandle` synchronously — a `{ chunks, result }` pair. The `result` promise resolves when the session completes. The `chunks` async iterable yields output as the session runs when `streaming: true` is set; otherwise it completes immediately with no items.
9
9
 
10
- Depends on `@shardworks/stacks-apparatus` for persistence. Uses `@shardworks/loom-apparatus` for context composition (resolved at call time by `summon()`, not a startup dependency). The session provider (e.g. `@shardworks/claude-code-apparatus`) is discovered at runtime via guild config.
10
+ Depends on `@shardworks/stacks-apparatus` for persistence (session records and full transcripts). Uses `@shardworks/loom-apparatus` for context composition (resolved at call time by `summon()`, not a startup dependency). The session provider (e.g. `@shardworks/claude-code-apparatus`) is discovered at runtime via guild config.
11
11
 
12
12
  ---
13
13
 
@@ -49,6 +49,7 @@ const { result } = animator.summon({
49
49
  const session = await result;
50
50
  console.log(session.status); // 'completed' | 'failed' | 'timeout'
51
51
  console.log(session.costUsd); // 0.42
52
+ console.log(session.output); // final assistant message text
52
53
  console.log(session.metadata?.trigger); // 'summon' (auto-populated)
53
54
  console.log(session.metadata?.role); // 'artificer' (auto-populated from request)
54
55
  ```
@@ -154,6 +155,7 @@ interface SessionResult {
154
155
  tokenUsage?: TokenUsage;
155
156
  costUsd?: number;
156
157
  metadata?: Record<string, unknown>;
158
+ output?: string; // Final assistant message text
157
159
  }
158
160
 
159
161
  type SessionChunk =
@@ -208,6 +210,8 @@ interface SessionProviderResult {
208
210
  providerSessionId?: string;
209
211
  tokenUsage?: TokenUsage;
210
212
  costUsd?: number;
213
+ transcript?: TranscriptMessage[]; // Full NDJSON message array
214
+ output?: string; // Final assistant message text
211
215
  }
212
216
  ```
213
217
 
@@ -215,13 +219,14 @@ The Animator imports these types; provider packages import them from `@shardwork
215
219
 
216
220
  ## Support Kit
217
221
 
218
- The Animator contributes a `sessions` book and inspection/dispatch tools:
222
+ The Animator contributes two books and inspection/dispatch tools:
219
223
 
220
224
  ### Books
221
225
 
222
226
  | Book | Indexes | Description |
223
227
  |---|---|---|
224
- | `sessions` | `startedAt`, `status`, `conversationId`, `provider` | Session records — one per `animate()` call |
228
+ | `sessions` | `startedAt`, `status`, `conversationId`, `provider` | Session records — one per `animate()` call. Includes `output` (final assistant text). |
229
+ | `transcripts` | `sessionId` | Full NDJSON transcripts — one per session. Drives web UIs, operational logs, debugging. |
225
230
 
226
231
  ### Tools
227
232
 
@@ -251,6 +256,8 @@ import {
251
256
  type SessionProviderConfig,
252
257
  type SessionProviderResult,
253
258
  type SessionDoc,
259
+ type TranscriptDoc,
260
+ type TranscriptMessage,
254
261
  type AnimatorConfig,
255
262
  } from '@shardworks/animator-apparatus';
256
263
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shardworks/animator-apparatus",
3
- "version": "0.1.111",
3
+ "version": "0.1.113",
4
4
  "license": "ISC",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,10 +17,10 @@
17
17
  },
18
18
  "dependencies": {
19
19
  "zod": "4.3.6",
20
- "@shardworks/loom-apparatus": "0.1.111",
21
- "@shardworks/nexus-core": "0.1.111",
22
- "@shardworks/stacks-apparatus": "0.1.111",
23
- "@shardworks/tools-apparatus": "0.1.111"
20
+ "@shardworks/loom-apparatus": "0.1.113",
21
+ "@shardworks/tools-apparatus": "0.1.113",
22
+ "@shardworks/nexus-core": "0.1.113",
23
+ "@shardworks/stacks-apparatus": "0.1.113"
24
24
  },
25
25
  "devDependencies": {
26
26
  "@types/node": "25.5.0"