@truefoundry/assistant-ui-runtime 0.1.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.
@@ -31,7 +31,7 @@ describe("bindDraftAgentSession", () => {
31
31
  });
32
32
 
33
33
  describe("createDraftSessionBridge", () => {
34
- it("syncs agent spec via draftSessions.update", async () => {
34
+ it("syncs agent spec via draftSessions.update and returns updatedAt", async () => {
35
35
  const { createDraftSessionBridge } = await import("./draftSessionBridge.js");
36
36
  const update = vi.fn().mockResolvedValue({ data: draft });
37
37
  const gateway = {
@@ -46,10 +46,11 @@ describe("createDraftSessionBridge", () => {
46
46
  } as unknown as TrueFoundryGateway;
47
47
 
48
48
  const bridge = createDraftSessionBridge(gateway);
49
- await bridge.syncAgentSpec("draft-1", draft.agentSpec);
49
+ const updatedAt = await bridge.syncAgentSpec("draft-1", draft.agentSpec);
50
50
 
51
51
  expect(update).toHaveBeenCalledWith("draft-1", {
52
52
  agentSpec: draft.agentSpec,
53
53
  });
54
+ expect(updatedAt).toBe(draft.updatedAt);
54
55
  });
55
56
  });
@@ -2,8 +2,10 @@ import type { TrueFoundryGateway } from "truefoundry-gateway-sdk";
2
2
 
3
3
  import type { AgentSpec } from "./agentSpec.js";
4
4
 
5
+ export const DRAFT_SESSION_LAST_UPDATED_AT_HEADER = "x-tfy-session-last-updated-at";
6
+
5
7
  export type DraftSessionBridge = {
6
- syncAgentSpec: (draftSessionId: string, agentSpec: AgentSpec) => Promise<void>;
8
+ syncAgentSpec: (draftSessionId: string, agentSpec: AgentSpec) => Promise<string>;
7
9
  getDraftAgentSpec: (draftSessionId: string) => Promise<AgentSpec>;
8
10
  };
9
11
 
@@ -22,7 +24,11 @@ export function createDraftSessionBridge(
22
24
  },
23
25
 
24
26
  async syncAgentSpec(draftSessionId, agentSpec) {
25
- await gateway.agents.private.draftSessions.update(draftSessionId, { agentSpec });
27
+ const response = await gateway.agents.private.draftSessions.update(
28
+ draftSessionId,
29
+ { agentSpec },
30
+ );
31
+ return response.data.updatedAt;
26
32
  },
27
33
  };
28
34
  }
@@ -0,0 +1,153 @@
1
+ // @vitest-environment jsdom
2
+ import { act, renderHook } from "@testing-library/react";
3
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
4
+
5
+ import type { DraftSessionBridge } from "./draftSessionBridge.js";
6
+ import { useDraftAgentSpec } from "./useDraftAgentSpec.js";
7
+
8
+ const defaultAgentSpec = { model: { name: "anthropic/claude-sonnet-4-6" } };
9
+
10
+ async function flushMicrotasks() {
11
+ await act(async () => {
12
+ await Promise.resolve();
13
+ await Promise.resolve();
14
+ });
15
+ }
16
+
17
+ describe("useDraftAgentSpec", () => {
18
+ beforeEach(() => {
19
+ vi.useFakeTimers();
20
+ });
21
+
22
+ afterEach(() => {
23
+ vi.useRealTimers();
24
+ });
25
+
26
+ it("stores updatedAt from sync and returns it once from takeTurnHeaderTimestamp", async () => {
27
+ const syncAgentSpec = vi
28
+ .fn()
29
+ .mockResolvedValue("2026-06-30T12:00:00.000Z");
30
+ const draftBridge: DraftSessionBridge = {
31
+ getDraftAgentSpec: vi.fn().mockResolvedValue(defaultAgentSpec),
32
+ syncAgentSpec,
33
+ };
34
+
35
+ const { result } = renderHook(() =>
36
+ useDraftAgentSpec({
37
+ draftSessionId: "draft-1",
38
+ draftBridge,
39
+ defaultAgentSpec,
40
+ }),
41
+ );
42
+
43
+ await flushMicrotasks();
44
+ expect(draftBridge.getDraftAgentSpec).toHaveBeenCalledWith("draft-1");
45
+
46
+ act(() => {
47
+ result.current.updateAgentSpec({ instructions: "be brief" });
48
+ });
49
+
50
+ await act(async () => {
51
+ await vi.advanceTimersByTimeAsync(400);
52
+ });
53
+ await flushMicrotasks();
54
+
55
+ expect(syncAgentSpec).toHaveBeenCalledOnce();
56
+
57
+ let first: string | undefined;
58
+ await act(async () => {
59
+ first = await result.current.takeTurnHeaderTimestamp();
60
+ });
61
+ expect(first).toBe("2026-06-30T12:00:00.000Z");
62
+
63
+ let second: string | undefined;
64
+ await act(async () => {
65
+ second = await result.current.takeTurnHeaderTimestamp();
66
+ });
67
+ expect(second).toBeUndefined();
68
+ });
69
+
70
+ it("flushes a pending debounced sync before returning the timestamp", async () => {
71
+ const syncAgentSpec = vi
72
+ .fn()
73
+ .mockResolvedValue("2026-06-30T13:00:00.000Z");
74
+ const draftBridge: DraftSessionBridge = {
75
+ getDraftAgentSpec: vi.fn().mockResolvedValue(defaultAgentSpec),
76
+ syncAgentSpec,
77
+ };
78
+
79
+ const { result } = renderHook(() =>
80
+ useDraftAgentSpec({
81
+ draftSessionId: "draft-1",
82
+ draftBridge,
83
+ defaultAgentSpec,
84
+ }),
85
+ );
86
+
87
+ await flushMicrotasks();
88
+ expect(draftBridge.getDraftAgentSpec).toHaveBeenCalledWith("draft-1");
89
+
90
+ act(() => {
91
+ result.current.updateAgentSpec({ instructions: "new" });
92
+ });
93
+ expect(syncAgentSpec).not.toHaveBeenCalled();
94
+
95
+ let timestamp: string | undefined;
96
+ await act(async () => {
97
+ timestamp = await result.current.takeTurnHeaderTimestamp();
98
+ });
99
+
100
+ expect(syncAgentSpec).toHaveBeenCalledOnce();
101
+ expect(timestamp).toBe("2026-06-30T13:00:00.000Z");
102
+ });
103
+
104
+ it("drops pending sync state and stored timestamp when draftSessionId changes", async () => {
105
+ const syncAgentSpec = vi
106
+ .fn()
107
+ .mockResolvedValue("2026-06-30T14:00:00.000Z");
108
+ const draftBridge: DraftSessionBridge = {
109
+ getDraftAgentSpec: vi.fn().mockResolvedValue(defaultAgentSpec),
110
+ syncAgentSpec,
111
+ };
112
+
113
+ const { result, rerender } = renderHook(
114
+ ({ draftSessionId }: { draftSessionId: string }) =>
115
+ useDraftAgentSpec({
116
+ draftSessionId,
117
+ draftBridge,
118
+ defaultAgentSpec,
119
+ }),
120
+ { initialProps: { draftSessionId: "draft-1" } },
121
+ );
122
+
123
+ await flushMicrotasks();
124
+
125
+ // A completed sync stores a timestamp for draft-1...
126
+ act(() => {
127
+ result.current.updateAgentSpec({ instructions: "for draft-1" });
128
+ });
129
+ await act(async () => {
130
+ await vi.advanceTimersByTimeAsync(400);
131
+ });
132
+ await flushMicrotasks();
133
+ expect(syncAgentSpec).toHaveBeenCalledWith("draft-1", expect.anything());
134
+
135
+ // ...and another edit leaves a pending debounced flush for draft-1.
136
+ act(() => {
137
+ result.current.updateAgentSpec({ instructions: "pending for draft-1" });
138
+ });
139
+
140
+ rerender({ draftSessionId: "draft-2" });
141
+ await flushMicrotasks();
142
+
143
+ let timestamp: string | undefined;
144
+ await act(async () => {
145
+ timestamp = await result.current.takeTurnHeaderTimestamp();
146
+ });
147
+
148
+ // Neither draft-1's stored timestamp nor its pending flush leaks into draft-2.
149
+ expect(timestamp).toBeUndefined();
150
+ expect(syncAgentSpec).toHaveBeenCalledOnce();
151
+ expect(result.current.isSpecSyncing).toBe(false);
152
+ });
153
+ });
@@ -19,13 +19,22 @@ export type UseDraftAgentSpecOptions = {
19
19
  onError?: ((error: unknown) => void) | undefined;
20
20
  };
21
21
 
22
+ export type UseDraftAgentSpecResult = {
23
+ agentSpec: AgentSpec | null;
24
+ draftSessionId: string | undefined;
25
+ isSpecSyncing: boolean;
26
+ specError: unknown | null;
27
+ updateAgentSpec: (update: AgentSpecUpdate) => void;
28
+ takeTurnHeaderTimestamp: () => Promise<string | undefined>;
29
+ };
30
+
22
31
  export function useDraftAgentSpec({
23
32
  draftSessionId,
24
33
  draftBridge,
25
34
  defaultAgentSpec,
26
35
  onAgentSpecChange,
27
36
  onError,
28
- }: UseDraftAgentSpecOptions) {
37
+ }: UseDraftAgentSpecOptions): UseDraftAgentSpecResult {
29
38
  const enabled = draftBridge != null;
30
39
  const [agentSpec, setAgentSpec] = useState<AgentSpec>(defaultAgentSpec);
31
40
  const [isSpecSyncing, setIsSpecSyncing] = useState(false);
@@ -38,6 +47,35 @@ export function useDraftAgentSpec({
38
47
  const syncGenerationRef = useRef(0);
39
48
  const loadedDraftIdRef = useRef<string | undefined>(undefined);
40
49
  const localDirtyRef = useRef(false);
50
+ const lastUpdatedAtRef = useRef<string | undefined>(undefined);
51
+ const pendingFlushRef = useRef<(() => Promise<void>) | undefined>(undefined);
52
+ const inFlightFlushRef = useRef<Promise<void> | undefined>(undefined);
53
+ const activeDraftIdRef = useRef(draftSessionId);
54
+
55
+ // Invalidate sync state from the previous draft so a stale pending flush or
56
+ // stored updatedAt can't update the wrong draft or leak into the next
57
+ // turn's header. Bumping the generation makes any in-flight sync a no-op.
58
+ useEffect(() => {
59
+ const previousDraftId = activeDraftIdRef.current;
60
+ if (previousDraftId === draftSessionId) {
61
+ return;
62
+ }
63
+ activeDraftIdRef.current = draftSessionId;
64
+ syncGenerationRef.current++;
65
+ if (syncTimeoutRef.current != null) {
66
+ clearTimeout(syncTimeoutRef.current);
67
+ syncTimeoutRef.current = undefined;
68
+ }
69
+ pendingFlushRef.current = undefined;
70
+ inFlightFlushRef.current = undefined;
71
+ lastUpdatedAtRef.current = undefined;
72
+ setIsSpecSyncing(false);
73
+ // Dirty edits made against a previous draft must not be replayed onto
74
+ // the new one. Keep them only for lazy creation (undefined -> id).
75
+ if (previousDraftId != null) {
76
+ localDirtyRef.current = false;
77
+ }
78
+ }, [draftSessionId]);
41
79
 
42
80
  useEffect(() => {
43
81
  if (!enabled || draftBridge == null) {
@@ -93,10 +131,12 @@ export function useDraftAgentSpec({
93
131
  }
94
132
  setIsSpecSyncing(true);
95
133
  try {
96
- await draftBridge.syncAgentSpec(draftId, spec);
134
+ const updatedAt = await draftBridge.syncAgentSpec(draftId, spec);
97
135
  if (generation !== syncGenerationRef.current) {
98
136
  return;
99
137
  }
138
+ lastUpdatedAtRef.current =
139
+ updatedAt || new Date().toISOString();
100
140
  setSpecError(null);
101
141
  onAgentSpecChange?.(spec);
102
142
  } catch (error) {
@@ -119,8 +159,20 @@ export function useDraftAgentSpec({
119
159
  clearTimeout(syncTimeoutRef.current);
120
160
  }
121
161
  const generation = ++syncGenerationRef.current;
162
+ const flush = () => {
163
+ pendingFlushRef.current = undefined;
164
+ syncTimeoutRef.current = undefined;
165
+ const promise = flushSpecSync(draftId, spec, generation).finally(() => {
166
+ if (inFlightFlushRef.current === promise) {
167
+ inFlightFlushRef.current = undefined;
168
+ }
169
+ });
170
+ inFlightFlushRef.current = promise;
171
+ return promise;
172
+ };
173
+ pendingFlushRef.current = flush;
122
174
  syncTimeoutRef.current = setTimeout(() => {
123
- void flushSpecSync(draftId, spec, generation);
175
+ void flush();
124
176
  }, SPEC_SYNC_DEBOUNCE_MS);
125
177
  },
126
178
  [flushSpecSync],
@@ -129,6 +181,29 @@ export function useDraftAgentSpec({
129
181
  const scheduleSpecSyncRef = useRef(scheduleSpecSync);
130
182
  scheduleSpecSyncRef.current = scheduleSpecSync;
131
183
 
184
+ const flushPendingSpecSyncNow = useCallback(async () => {
185
+ if (syncTimeoutRef.current != null) {
186
+ clearTimeout(syncTimeoutRef.current);
187
+ syncTimeoutRef.current = undefined;
188
+ }
189
+ const pending = pendingFlushRef.current;
190
+ if (pending != null) {
191
+ pendingFlushRef.current = undefined;
192
+ await pending();
193
+ return;
194
+ }
195
+ if (inFlightFlushRef.current != null) {
196
+ await inFlightFlushRef.current;
197
+ }
198
+ }, []);
199
+
200
+ const takeTurnHeaderTimestamp = useCallback(async () => {
201
+ await flushPendingSpecSyncNow();
202
+ const updatedAt = lastUpdatedAtRef.current;
203
+ lastUpdatedAtRef.current = undefined;
204
+ return updatedAt;
205
+ }, [flushPendingSpecSyncNow]);
206
+
132
207
  useEffect(
133
208
  () => () => {
134
209
  if (syncTimeoutRef.current != null) {
@@ -160,6 +235,7 @@ export function useDraftAgentSpec({
160
235
  isSpecSyncing: enabled ? isSpecSyncing : false,
161
236
  specError: enabled ? specError : null,
162
237
  updateAgentSpec,
238
+ takeTurnHeaderTimestamp,
163
239
  }),
164
240
  [
165
241
  agentSpec,
@@ -167,6 +243,7 @@ export function useDraftAgentSpec({
167
243
  enabled,
168
244
  isSpecSyncing,
169
245
  specError,
246
+ takeTurnHeaderTimestamp,
170
247
  updateAgentSpec,
171
248
  ],
172
249
  );
@@ -3,6 +3,7 @@ import type {
3
3
  Turn,
4
4
  TurnCreatedEvent,
5
5
  TurnDoneEvent,
6
+ TurnEvent,
6
7
  TurnInputItem,
7
8
  } from "truefoundry-gateway-sdk/agents";
8
9
 
@@ -12,6 +13,19 @@ import type { StoredApprovalDecision } from "./toolApproval.js";
12
13
  import type { StoredToolResponse } from "./toolResponse.js";
13
14
  import type { TurnStreamUpdate } from "./turnStreamUpdate.js";
14
15
 
16
+ /** Session-level event item from `AgentSession.listEvents`. */
17
+ export type GatewaySessionEventItem = {
18
+ turnId: string;
19
+ event: TurnCreatedEvent | TurnDoneEvent | TurnEvent;
20
+ };
21
+
22
+ /** Cursor for fetching older `listEvents` pages (scroll-up history). */
23
+ export type SessionHistoryPagination = {
24
+ /** Token for the next older page; omit when exhausted. */
25
+ olderPageToken?: string;
26
+ hasOlder: boolean;
27
+ };
28
+
15
29
  /** Turn metadata retained for cross-turn projection and subsequent required-action replay. */
16
30
  export type SessionTurnRecord = Pick<
17
31
  Turn,
@@ -55,6 +69,12 @@ export type SessionSnapshot = {
55
69
  requiredActions: RequiredActionsOverlay;
56
70
  runningTurn?: Turn;
57
71
  unstable_resume?: boolean;
72
+ /**
73
+ * Chronological `listEvents` items loaded so far (for prepend-on-scroll rebuild).
74
+ * Live stream commits are not appended here — they live in `turns` / `fold`.
75
+ */
76
+ historyEvents?: readonly GatewaySessionEventItem[];
77
+ historyPagination?: SessionHistoryPagination;
58
78
  };
59
79
 
60
80
  export type ProjectSessionMessagesOptions = {
@@ -110,7 +130,7 @@ export function sessionEventsToSessionRecord(
110
130
  /** Returns a new snapshot wrapper; fold maps may be mutated in place before calling. */
111
131
  export function replaceSessionSnapshot(
112
132
  snapshot: SessionSnapshot,
113
- patch: Partial<Omit<SessionSnapshot, "fold" | "requiredActions">> & {
133
+ patch: Partial<Omit<SessionSnapshot, "requiredActions">> & {
114
134
  requiredActions?: RequiredActionsOverlay;
115
135
  },
116
136
  ): SessionSnapshot {
@@ -193,6 +193,40 @@ describe("streamTurn", () => {
193
193
  expect(execute).not.toHaveBeenCalled();
194
194
  expect(updates).toEqual([]);
195
195
  });
196
+
197
+ it("forwards headers to turn.execute request options", async () => {
198
+ const execute = vi.fn(() => (async function* () {})());
199
+ const prepareTurn = vi.fn(() => ({ execute }));
200
+ const session = {
201
+ prepareTurn,
202
+ cancel: vi.fn().mockResolvedValue(undefined),
203
+ } as unknown as AgentSession;
204
+ const abortSignal = new AbortController().signal;
205
+
206
+ await collectUpdates(
207
+ streamTurnContent(
208
+ session,
209
+ new PeerThreadFoldState(),
210
+ {
211
+ userMessage: "hello",
212
+ headers: {
213
+ "x-tfy-session-last-updated-at": "2026-06-30T10:00:00.000Z",
214
+ },
215
+ },
216
+ abortSignal,
217
+ ),
218
+ );
219
+
220
+ expect(execute).toHaveBeenCalledWith(
221
+ { stream: true },
222
+ {
223
+ abortSignal,
224
+ headers: {
225
+ "x-tfy-session-last-updated-at": "2026-06-30T10:00:00.000Z",
226
+ },
227
+ },
228
+ );
229
+ });
196
230
  });
197
231
 
198
232
  describe("resumeTurnStream", () => {
package/src/streamTurn.ts CHANGED
@@ -21,6 +21,8 @@ export type StreamTurnOptions = {
21
21
  * root turn (no `previousTurnId` field).
22
22
  */
23
23
  previousTurnId?: string | null;
24
+ /** Extra headers for the createTurn request (`execute` request options). */
25
+ headers?: Record<string, string>;
24
26
  };
25
27
 
26
28
  function buildTurnInput(options: StreamTurnOptions): TurnInputItem[] {
@@ -68,7 +70,13 @@ export async function* streamTurnContent(
68
70
 
69
71
  try {
70
72
  yield* streamTurnEvents(
71
- turn.execute({ stream: true }, { abortSignal }),
73
+ turn.execute(
74
+ { stream: true },
75
+ {
76
+ abortSignal,
77
+ ...(options.headers != null ? { headers: options.headers } : {}),
78
+ },
79
+ ),
72
80
  foldState,
73
81
  groupRootBaseline,
74
82
  );
@@ -28,6 +28,9 @@ export type TrueFoundryRuntimeExtras = {
28
28
  cancel: () => Promise<void>;
29
29
  resetFromTurn: (turnId: string) => Promise<void>;
30
30
  reload: () => void;
31
+ hasOlderHistory: boolean;
32
+ isLoadingOlderHistory: boolean;
33
+ loadOlderHistory: () => Promise<void>;
31
34
  draft: TrueFoundryDraftRuntimeExtras | null;
32
35
  };
33
36
 
@@ -329,6 +329,56 @@ describe("useTrueFoundryAgentMessages", () => {
329
329
  expect(loadSessionSnapshot).not.toHaveBeenCalled();
330
330
  });
331
331
 
332
+ it("sendTurn forwards getTurnHeaders only when they resolve to a value", async () => {
333
+ const getTurnHeaders = vi
334
+ .fn()
335
+ .mockResolvedValueOnce({
336
+ "x-tfy-session-last-updated-at": "2026-06-30T12:00:00.000Z",
337
+ })
338
+ .mockResolvedValueOnce(undefined);
339
+
340
+ const { result } = renderHook(() =>
341
+ useTrueFoundryAgentMessages({
342
+ client: mockClient,
343
+ sessionId: "session-1",
344
+ getTurnHeaders,
345
+ }),
346
+ );
347
+
348
+ await waitFor(() => expect(result.current.isLoading).toBe(false));
349
+
350
+ await act(async () => {
351
+ await result.current.sendTurn({ userMessage: "first" });
352
+ });
353
+
354
+ expect(getTurnHeaders).toHaveBeenCalledTimes(1);
355
+ expect(streamTurnContent).toHaveBeenCalledWith(
356
+ expect.anything(),
357
+ expect.any(PeerThreadFoldState),
358
+ {
359
+ userMessage: "first",
360
+ headers: {
361
+ "x-tfy-session-last-updated-at": "2026-06-30T12:00:00.000Z",
362
+ },
363
+ },
364
+ expect.any(AbortSignal),
365
+ expect.any(Array),
366
+ );
367
+
368
+ await act(async () => {
369
+ await result.current.sendTurn({ userMessage: "second" });
370
+ });
371
+
372
+ expect(getTurnHeaders).toHaveBeenCalledTimes(2);
373
+ expect(streamTurnContent).toHaveBeenLastCalledWith(
374
+ expect.anything(),
375
+ expect.any(PeerThreadFoldState),
376
+ { userMessage: "second" },
377
+ expect.any(AbortSignal),
378
+ expect.any(Array),
379
+ );
380
+ });
381
+
332
382
  it("loads converted session history on mount", async () => {
333
383
  vi.mocked(loadSessionSnapshot).mockResolvedValue(
334
384
  snapshotWithUserTurn("hello"),