@epam/ai-dial-chat-hooks 1.3.0-dev.28 → 1.3.0-dev.282

package/conversation/useConversationStream/generation-resume.d.ts

@@ -0,0 +1,98 @@
+import { Conversation, Message } from '@epam/ai-dial-chat-shared';
+import { Dispatch, MutableRefObject, SetStateAction } from 'react';
+import { BufferedGeneration } from './buffered-generation';
+import { FrameScheduler } from './frame-scheduler';
+import { ConversationStreamTransport } from './useConversationStream';
+/**
+ * True when the assistant message carries anything the backend's finalize save
+ * would have written. Text alone is not enough to tell a finished response from
+ * the start-state placeholder: an image-generation answer settles with an empty
+ * `content` and only `custom_content.attachments`, and a stage-only or
+ * form-only answer is just as text-free.
+ */
+export declare const hasGeneratedPayload: (message: Message) => boolean;
+/**
+ * Index of the conversation's message that a background generation is still
+ * producing (`backgroundGeneration.status` is `pending`), or -1. It can sit
+ * anywhere, e.g. before a model-changed status message.
+ */
+export declare const findPendingBackgroundMessageIndex: (conversation: Conversation) => number;
+/**
+ * True when the conversation has a pending background message, or its last
+ * message is an unresolved assistant placeholder: the backend only persists a
+ * conversation at generation start (empty placeholder) and at generation end
+ * (final content, or a partial flagged `streamErrorMessage`/`wasStoppedByUser`).
+ * This can mean generation is still active elsewhere, or that its terminal save
+ * failed.
+ */
+export declare const isAwaitingGenerationResume: (conversation: Conversation) => boolean;
+export declare const RECOVERY_REFETCH_DELAYS_MS: number[];
+/**
+ * Returns the conversation from `load`, retrying rejected attempts — and
+ * results `isPending` flags as not yet settled — on the
+ * {@link RECOVERY_REFETCH_DELAYS_MS} schedule; `null` once every attempt has
+ * failed or stayed pending, or `shouldStop` turns true between attempts.
+ */
+export declare const fetchConversationForRecovery: (load: () => Promise<Conversation>, shouldStop: () => boolean, isPending?: (conversation: Conversation) => boolean) => Promise<Conversation | null>;
+/** Internal options a resume started by the stream hook itself passes; the public API passes none. */
+export interface ResumeGenerationOptions {
+    /** Initial buffered message, used instead of the stored placeholder — the live partial answer a dropped stream had already shown. */
+    seedMessage?: Message;
+    /** Called once when the resume has resolved or lost ownership of the path to a newer generation. */
+    onSettled?: () => void;
+    /** Resumes even though the path is already in `resumingPathsRef`, for a caller that reserved it itself. */
+    skipDedupe?: boolean;
+    /**
+     * Takes the `generationId` the attach `snapshot` carries so Stop can reach a resumed
+     * non-background generation. Set only by the public entry point: stream recovery
+     * already knows its local id, and the conflict handover keeps Stop unavailable.
+     */
+    trackAttachGenerationId?: boolean;
+}
+/** Host-owned state {@link createResumeIfAwaitingGeneration} reads/writes through. */
+export interface ResumeIfAwaitingGenerationDeps {
+    transport: ConversationStreamTransport;
+    setConversation: Dispatch<SetStateAction<Conversation | null>>;
+    conversationRef: MutableRefObject<Conversation | null>;
+    resumingPathsRef: MutableRefObject<Set<string>>;
+    bufferedGenerationsRef: MutableRefObject<Map<string, BufferedGeneration>>;
+    addStreamingPath: (path: string) => void;
+    removeStreamingPath: (path: string) => void;
+    isPathDisplayed: (path: string) => boolean;
+    generationPersistenceErrorMessage?: string;
+    /** Records a terminal read failure and its guarded read-only retry. */
+    onReloadError?: (path: string, retry: () => Promise<void>, isCurrent: () => boolean) => void;
+    /** Clears a previous read failure after reconciliation. */
+    onReloadSuccess?: (path: string) => void;
+    /** When set, replayed chunks are published at most once per frame through it. */
+    frameScheduler?: FrameScheduler;
+    /**
+     * Generation ids the user stopped. A resumed background generation in this set
+     * ignores further replayed chunks (DIAL Core does not always honour the cancel), and
+     * its id is removed when the resume settles.
+     */
+    stoppedGenerationIdsRef?: MutableRefObject<Set<string>>;
+    /** Records the id an attach `snapshot` supplied for `path`, so the host can offer Stop for it. */
+    rememberResumedGenerationId?: (path: string, generationId: string) => void;
+    /**
+     * Drops that id again once the resume no longer owns an attached generation. Compare-and-clear:
+     * the host removes the entry only while it still holds `generationId`.
+     */
+    forgetResumedGenerationId?: (path: string, generationId: string) => void;
+}
+/**
+ * Builds `resumeIfAwaitingGeneration`: a hard refresh mid-generation loads a
+ * conversation whose last message is the backend's empty start-state
+ * placeholder (no incremental save exists to show partial content). Rather
+ * than leaving that static and forever empty, this marks the path as
+ * streaming — for free, reusing the same typing indicator and any
+ * `isStreaming` guards a composed handlers hook already applies — and
+ * attaches to the backend's live replay of the in-flight generation
+ * (`transport.attachToGeneration`), showing the assistant message populate
+ * progressively. It falls back to watching the conversation's generic
+ * resource-update channel (`transport.watchConversation`) until the
+ * backend's finalize save resolves the placeholder whenever attach is
+ * unavailable or ends without a terminal event.
+ */
+export declare const createResumeIfAwaitingGeneration: ({ transport, setConversation, conversationRef, resumingPathsRef, bufferedGenerationsRef, addStreamingPath, removeStreamingPath, isPathDisplayed, generationPersistenceErrorMessage, frameScheduler, stoppedGenerationIdsRef, rememberResumedGenerationId, forgetResumedGenerationId, onReloadError, onReloadSuccess, }: ResumeIfAwaitingGenerationDeps) => (currentConversationId: string, conversation: Conversation, options?: ResumeGenerationOptions) => void;
+//# sourceMappingURL=generation-resume.d.ts.map

package/conversation/useConversationStream/generation-resume.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generation-resume.d.ts","sourceRoot":"","sources":["../../../src/conversation/useConversationStream/generation-resume.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EAEjB,KAAK,OAAO,EAEb,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAQxE,OAAO,EACL,KAAK,kBAAkB,EAExB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAS,OAAO,KAAG,OAWtD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,GAC5C,cAAc,YAAY,KACzB,MAKA,CAAC;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,GACrC,cAAc,YAAY,KACzB,OAUF,CAAC;AA6BF,eAAO,MAAM,0BAA0B,UAAkC,CAAC;AAe1E;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACvC,MAAM,MAAM,OAAO,CAAC,YAAY,CAAC,EACjC,YAAY,MAAM,OAAO,EACzB,YAAY,CAAC,YAAY,EAAE,YAAY,KAAK,OAAO,KAClD,OAAO,CAAC,YAAY,GAAG,IAAI,CAiB7B,CAAC;AAUF,sGAAsG;AACtG,MAAM,WAAW,uBAAuB;IACtC,qIAAqI;IACrI,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oGAAoG;IACpG,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,2GAA2G;IAC3G,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,2BAA2B,CAAC;IACvC,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/D,eAAe,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACvD,gBAAgB,EAAE,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,sBAAsB,EAAE,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC1E,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,mBAAmB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3C,iCAAiC,CAAC,EAAE,MAAM,CAAC;IAC3C,uEAAuE;IACvE,aAAa,CAAC,EAAE,CACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAC1B,SAAS,EAAE,MAAM,OAAO,KACrB,IAAI,CAAC;IACV,2DAA2D;IAC3D,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,iFAAiF;IACjF,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,kGAAkG;IAClG,2BAA2B,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3E;;;OAGG;IACH,yBAAyB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1E;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gCAAgC,GAAI,wTAgB9C,8BAA8B,MAE7B,uBAAuB,MAAM,EAC7B,cAAc,YAAY,EAC1B,UAAS,uBAA4B,KACpC,IA6SJ,CAAC"}

package/conversation/useConversationStream/generation-resume.js

@@ -1,184 +1,155 @@
 import { safeDecodeURI as e } from "../../shared/string-utils.js";
 import { DEFAULT_GENERATION_PERSISTENCE_ERROR_MESSAGE as t, GenerationPersistenceError as n } from "../create-chat-stream-api.js";
-import { getConversationPath as r } from "./conversation-path.js";
-import { applyChunkToMessages as i } from "./apply-chunk.js";
-import { restoreBufferedMessage as a } from "./buffered-generation.js";
-import { BackgroundGenerationStatus as o, MessageRole as s } from "@epam/ai-dial-chat-shared";
+import { readSseEvents as r } from "../../shared/read-sse-events.js";
+import { getConversationPath as i } from "./conversation-path.js";
+import { applyChunkToMessages as a } from "./apply-chunk.js";
+import { restoreBufferedMessage as o } from "./buffered-generation.js";
+import { BackgroundGenerationStatus as s, MessageRole as c } from "@epam/ai-dial-chat-shared";
 //#region src/conversation/useConversationStream/generation-resume.ts
-var c = (e) => {
+var l = (e) => {
 	let t = e.custom_content;
 	return !!e.content || e.responseId != null || !!t?.attachments?.length || !!t?.stages?.length || !!t?.annotations?.length || !!t?.form_schema || t?.state != null;
-}, l = (e) => e.messages.findIndex((e) => e.backgroundGeneration?.status === o.Pending), u = (e) => {
-	if (l(e) !== -1) return !0;
+}, u = (e) => e.messages.findIndex((e) => e.backgroundGeneration?.status === s.Pending), d = (e) => {
+	if (u(e) !== -1) return !0;
 	let t = e.messages[e.messages.length - 1];
-	return !!t && t.role === s.Assistant && !c(t) && t.streamErrorMessage == null && !t.wasStoppedByUser;
-}, d = 300 * 1e3, f = "awaiting-resume", p = [
+	return !!t && t.role === c.Assistant && !l(t) && t.streamErrorMessage == null && !t.wasStoppedByUser;
+}, f = 3e5, p = "awaiting-resume", m = [
 	1e3,
 	2e3,
 	4e3,
 	8e3,
 	16e3
-], m = (e) => new Promise((t) => {
+], h = (e) => new Promise((t) => {
 	let n = typeof window < "u", r = () => {
 		clearTimeout(i), n && window.removeEventListener("online", r), t();
 	}, i = setTimeout(r, e);
 	n && window.addEventListener("online", r);
-}), h = async (e, t, n) => {
-	for (let r = 0; r <= p.length; r++) {
+}), g = async (e, t, n) => {
+	for (let r = 0; r <= m.length; r++) {
 		if (t()) return null;
 		try {
 			let t = await e();
 			if (!n?.(t)) return t;
 		} catch {}
-		if (r === p.length) return null;
-		await m(p[r]);
+		if (r === m.length) return null;
+		await h(m[r]);
 	}
 	return null;
-}, g = async (e, t) => {
-	let n = e.getReader(), r = new TextDecoder(), i = "";
-	try {
-		for (;;) {
-			let { done: e, value: a } = await n.read();
-			if (e) break;
-			i += r.decode(a, { stream: !0 });
-			let o = i.split("\n");
-			i = o.pop() ?? "";
-			let s = !1;
-			for (let e of o) {
-				let n = e.trim();
-				if (!n.startsWith("data:")) continue;
-				let r = n.slice(5).trim(), i;
-				try {
-					i = JSON.parse(r);
-				} catch {
-					continue;
-				}
-				if (await t(i)) {
-					s = !0;
-					break;
-				}
-			}
-			if (s) break;
-		}
-	} catch {} finally {
-		n.releaseLock();
-	}
-}, _ = ({ transport: o, setConversation: s, conversationRef: p, resumingPathsRef: m, bufferedGenerationsRef: h, addStreamingPath: _, removeStreamingPath: v, isPathDisplayed: y, generationPersistenceErrorMessage: b = t, frameScheduler: x, stoppedGenerationIdsRef: S, onReloadError: C, onReloadSuccess: w }) => (t, T, E = {}) => {
-	if (!u(T)) {
-		E.onSettled?.();
+}, _ = ({ transport: s, setConversation: c, conversationRef: m, resumingPathsRef: h, bufferedGenerationsRef: g, addStreamingPath: _, removeStreamingPath: v, isPathDisplayed: y, generationPersistenceErrorMessage: b = t, frameScheduler: x, stoppedGenerationIdsRef: S, rememberResumedGenerationId: C, forgetResumedGenerationId: w, onReloadError: T, onReloadSuccess: E }) => (t, D, O = {}) => {
+	if (!d(D)) {
+		O.onSettled?.();
 		return;
 	}
-	let D = r(t);
-	if (!E.skipDedupe && m.current.has(D)) return;
-	m.current.add(D), _(D);
-	let O = l(T), k = O !== -1, A = k ? O : T.messages.length - 1, j = {
-		generationId: f,
-		messageIndex: A,
-		message: E.seedMessage ?? T.messages[A]
+	let k = i(t);
+	if (!O.skipDedupe && h.current.has(k)) return;
+	h.current.add(k), _(k);
+	let A = u(D), j = A !== -1, M = j ? A : D.messages.length - 1, N = {
+		generationId: p,
+		messageIndex: M,
+		message: O.seedMessage ?? D.messages[M]
 	};
-	h.current.set(D, j);
-	let M = () => h.current.get(D) === j, N = k ? T.messages[A].backgroundGeneration?.generationId : void 0, P = () => N != null && (S?.current.has(N) ?? !1), F = (e, t = !1) => {
-		if (x?.flush(D), N != null && S?.current.delete(N), !M()) return;
-		m.current.delete(D), v(D);
-		let n = !k && e && e.messages.length - 1 === A && u(e) && c(j.message);
-		if (t || n) {
-			j.message = {
-				...j.message,
-				streamErrorMessage: b
-			}, y(D) && s((e) => {
-				if (!e || !M() || !y(D)) return e;
-				let t = a(e, j);
-				return p.current = t, t;
-			});
-			return;
-		}
-		h.current.delete(D), e && y(D) && (s(e), p.current = e);
-	}, I = async () => {
-		if (M()) try {
-			let n = await o.getConversation(e(t));
-			if (!M()) return;
-			w?.(D), F(n);
+	g.current.set(k, N);
+	let P = () => g.current.get(k) === N, F = j ? D.messages[M].backgroundGeneration?.generationId : void 0, I, L = () => {
+		let e = F ?? I;
+		return e != null && (S?.current.has(e) ?? !1);
+	}, R = (e) => {
+		O.trackAttachGenerationId && !j && e != null && P() && (I = e, C?.(k, e));
+	}, z = () => {
+		if (I == null) return;
+		let e = I;
+		I = void 0, S?.current.delete(e), w?.(k, e);
+	}, B = (e, t = !1) => {
+		if (x?.flush(k), F != null && S?.current.delete(F), z(), !P()) return;
+		h.current.delete(k), v(k);
+		let n = !j && e && e.messages.length - 1 === M && d(e) && l(N.message);
+		t || n ? (N.message = {
+			...N.message,
+			streamErrorMessage: b
+		}, y(k) && c((e) => {
+			if (!e || !P() || !y(k)) return e;
+			let t = o(e, N);
+			return m.current = t, t;
+		})) : (g.current.delete(k), e && y(k) && (c(e), m.current = e));
+	}, V = async () => {
+		if (P()) try {
+			let n = await s.getConversation(e(t));
+			if (!P()) return;
+			E?.(k), B(n);
 		} catch {
-			if (!M()) return;
-			x?.flush(D), m.current.delete(D), v(D), N != null && S?.current.delete(N), C?.(D, I, M);
+			if (!P()) return;
+			x?.flush(k), h.current.delete(k), v(k), F != null && S?.current.delete(F), z(), T?.(k, V, P);
 		}
-	}, L = (e) => {
-		x?.cancel(D), M() && (j.message = e, y(D) && s((e) => {
-			if (!e || !M() || !y(D)) return e;
-			let t = a(e, j);
-			return p.current = t, t;
+	}, H = (e) => {
+		x?.cancel(k), P() && (N.message = e, y(k) && c((e) => {
+			if (!e || !P() || !y(k)) return e;
+			let t = o(e, N);
+			return m.current = t, t;
 		}));
-	}, R = () => s((e) => {
-		if (!e || !M() || !y(D)) return e;
-		let t = a(e, j);
-		return p.current = t, t;
-	}), z = (e) => {
-		if (!M() || P()) return;
-		let t = i([j.message], 0, e);
-		if (t && (j.message = t[0]), y(D)) {
-			if (x) {
-				x.schedule(D, R);
-				return;
-			}
-			R();
-		}
-	}, B = async () => {
-		let n = new AbortController(), r;
+	}, U = () => c((e) => {
+		if (!e || !P() || !y(k)) return e;
+		let t = o(e, N);
+		return m.current = t, t;
+	}), W = (e) => {
+		if (!P() || L()) return;
+		let t = a([N.message], 0, e);
+		t && (N.message = t[0]), y(k) && (x ? x.schedule(k, U) : U());
+	}, G = async () => {
+		let n = new AbortController(), i;
 		try {
-			r = await o.watchConversation(D, n.signal);
+			i = await s.watchConversation(k, n.signal);
 		} catch {
-			await I();
+			await V();
 			return;
 		}
 		try {
-			let i = await o.getConversation(e(t));
-			if (!u(i)) {
-				n.abort(), r.cancel().catch(() => void 0), F(i);
+			let r = await s.getConversation(e(t));
+			if (!d(r)) {
+				n.abort(), i.cancel().catch(() => void 0), B(r);
 				return;
 			}
 		} catch {}
-		let i = !1, a = window.setTimeout(() => {
+		let a = !1, o = window.setTimeout(() => {
 			n.abort();
-		}, d);
+		}, f);
 		try {
-			await g(r, async (n) => {
+			await r(i, async (n) => {
 				if (n?.action !== "UPDATE") return !1;
 				try {
-					let n = await o.getConversation(e(t));
-					if (!u(n)) return F(n), i = !0, !0;
+					let n = await s.getConversation(e(t));
+					if (!d(n)) return B(n), a = !0, !0;
 				} catch {}
 				return !1;
 			});
 		} finally {
-			clearTimeout(a);
+			clearTimeout(o);
 		}
-		i || await I();
-	}, V = async () => {
+		a || await V();
+	}, K = async () => {
 		let e = new AbortController(), t;
 		try {
-			t = await o.attachToGeneration(D, e.signal);
+			t = await s.attachToGeneration(k, e.signal);
 		} catch {
 			return !1;
 		}
-		let r = !1, i = !1;
-		return await g(t, (e) => {
-			if (!M()) return !0;
+		let i = !1, a = !1;
+		return await r(t, (e) => {
+			if (!P()) return !0;
 			switch (e.type) {
-				case "snapshot": return L(e.message), !1;
-				case "chunk": return z(e.chunk), !1;
+				case "snapshot": return R(e.generationId), H(e.message), !1;
+				case "chunk": return W(e.chunk), !1;
 				case "done":
 				case "error":
-				case "stopped": return i = e.type === "error" && e.errorType === n.type, r = !0, !0;
+				case "stopped": return a = e.type === "error" && e.errorType === n.type, i = !0, !0;
 			}
-		}), r ? (i ? F(void 0, !0) : await I(), !0) : !M();
+		}), i ? (a ? B(void 0, !0) : await V(), !0) : (z(), !P());
 	};
 	(async () => {
 		try {
-			await V() || await B();
+			await K() || await G();
 		} finally {
-			E.onSettled?.();
+			O.onSettled?.();
 		}
 	})();
 };
 //#endregion
-export { _ as createResumeIfAwaitingGeneration, h as fetchConversationForRecovery, l as findPendingBackgroundMessageIndex, c as hasGeneratedPayload, u as isAwaitingGenerationResume };
+export { m as RECOVERY_REFETCH_DELAYS_MS, _ as createResumeIfAwaitingGeneration, g as fetchConversationForRecovery, u as findPendingBackgroundMessageIndex, l as hasGeneratedPayload, d as isAwaitingGenerationResume };

package/conversation/useConversationStream/useConversationStream.d.ts

@@ -0,0 +1,145 @@
+import { SendCompletionDtoModeEnum } from '@epam/ai-dial-chat-api-client';
+import { Conversation, MessageCustomContent, StreamChunk } from '@epam/ai-dial-chat-shared';
+import { Dispatch, MutableRefObject, SetStateAction } from 'react';
+/** Options accepted by {@link ConversationStreamTransport.streamCompletion}. */
+export interface StreamCompletionOptions {
+    onChunk: (chunk: StreamChunk) => void;
+    onComplete: () => void | Promise<void>;
+    onError: (error: Error) => void;
+    signal: AbortSignal;
+}
+/**
+ * Host-owned transport for the DIAL Core completion protocol. Implemented at
+ * the app edge — never hardcodes an `/api` path, CSRF handling, or a
+ * `server-api` import; the library only depends on this interface's shape.
+ */
+export interface ConversationStreamTransport {
+    /** Starts a completion; delivers chunks/completion/error through `options`, aborted via `options.signal`. */
+    streamCompletion(path: string, message: string | undefined, model: string, options: StreamCompletionOptions, customContent?: MessageCustomContent, generationId?: string, mode?: SendCompletionDtoModeEnum, messageIndex?: number, clientChannelId?: string): void;
+    /**
+     * Requests the backend stop an active generation. `content` is the answer text shown
+     * so far; the backend saves it for a generation whose text it does not hold.
+     */
+    stopCompletion(params: {
+        generationId: string;
+        path: string;
+        content?: string;
+    }): Promise<void>;
+    /** Opens a stream of resource-update events for `path`, until aborted via `signal`. */
+    watchConversation(path: string, signal: AbortSignal): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Attaches to an active generation's live replay: a `snapshot` event
+     * carrying the assistant message as assembled so far, then a `chunk` event
+     * per subsequent delta, then exactly one terminal event (`done`/`error`/
+     * `stopped`), until aborted via `signal`. Rejects when no active
+     * generation exists for `path` — including one that already finished —
+     * so the caller can fall back to `watchConversation`.
+     */
+    attachToGeneration(path: string, signal: AbortSignal): Promise<ReadableStream<Uint8Array>>;
+    /** Reloads the persisted conversation by its full (bucket-qualified) id. */
+    getConversation(conversationId: string, signal?: AbortSignal): Promise<Conversation>;
+    /**
+     * Saves `conversation` at the bucket-stripped `path`, resolving with the saved
+     * conversation. Used only for the single recovery save after the backend's
+     * terminal save was rejected with `401`; without it that failure shows the
+     * persistence warning immediately.
+     */
+    saveConversation?(path: string, conversation: Conversation): Promise<Conversation>;
+}
+/** Host-owned generation lifecycle, backing cross-navigation `AbortController` ownership. */
+export interface ConversationGenerationLifecycle {
+    /** Starts (or replaces) tracking for a generation on `path`, returning its `AbortController`. */
+    startGeneration: (path: string, generationId: string) => AbortController;
+    /** Marks the generation identified by `path`/`generationId` complete, if it is still the active one. */
+    completeGeneration: (path: string, generationId: string) => void;
+}
+/** Optional host-owned client-channel connection, used to nudge tool-signin delivery. */
+export interface ConversationStreamChannel {
+    channelId: string | null;
+    ensureConnected: () => void;
+    /** Resolves with a channel id, waiting for an in-flight subscribe if one isn't established yet, so a completion sent immediately after mount can still carry it. */
+    waitForChannel: (timeoutMs?: number) => Promise<string | null>;
+    /** Notifies the host that a generation just ended (completed or errored), so it can consider disconnecting an idle channel. */
+    notifyGenerationSettled?: () => void;
+}
+/** Optional host-owned overlay generation-lifecycle notifications. Each method is independently optional. */
+export interface ConversationStreamOverlayNotifier {
+    notifyGenerationStart?: () => void;
+    notifyGenerationEnd?: () => void;
+    notifyStopGenerating?: () => void;
+}
+/** Shared mutable channel through which the displayed conversation's state is read/written. */
+export interface ConversationStateAccessor {
+    setConversation: Dispatch<SetStateAction<Conversation | null>>;
+    conversationRef: MutableRefObject<Conversation | null>;
+}
+/** Parameters for {@link useConversationStream}. */
+export interface UseConversationStreamParams {
+    conversationId: string | undefined;
+    state: ConversationStateAccessor;
+    transport: ConversationStreamTransport;
+    generation: ConversationGenerationLifecycle;
+    channel?: ConversationStreamChannel;
+    overlay?: ConversationStreamOverlayNotifier;
+    onStopError?: (error: Error) => void;
+    /**
+     * Message shown on the message bubble when the backend rejects a completion
+     * because this conversation is already generating — the case a second
+     * browser tab of the same session hits. Defaults to
+     * {@link DEFAULT_GENERATION_CONFLICT_MESSAGE}.
+     */
+    generationConflictMessage?: string;
+    /** Host-translated warning shown when the received answer could not be saved. */
+    generationPersistenceErrorMessage?: string;
+    /**
+     * Receives the original error of every failed stream. The hook shows only
+     * host-supplied or upstream-supplied text on the message bubble and hides
+     * transport detail (e.g. `Failed to fetch`), so this is where the host can
+     * still log or report the raw error.
+     */
+    onStreamError?: (error: Error) => void;
+    /**
+     * Coalesces the displayed chunk updates into one `setConversation` per
+     * animation frame. Chunks still reach the per-path buffer immediately, and
+     * any pending update is flushed before completion, error, stop, or a
+     * superseding generation. Defaults to `false` (one update per chunk).
+     */
+    batchChunksPerFrame?: boolean;
+}
+/** Per-start options of {@link UseConversationStreamResult.startStream}. */
+export interface StartStreamOptions {
+    /**
+     * Treats a `GenerationConflictError` as "this turn is already being
+     * generated" — e.g. a page reloaded before that generation saved its start
+     * state — and joins the running generation instead of showing the conflict
+     * message, which remains the fallback. Only for a start that sends no new
+     * user text; a send the user typed must keep reporting the conflict.
+     */
+    resumeOnConflict?: boolean;
+}
+/** Return value of {@link useConversationStream}. */
+export interface UseConversationStreamResult {
+    startStream: (conversationId: string, userContent: string, messageIndex: number, model: string, customContent?: MessageCustomContent, generationId?: string, mode?: SendCompletionDtoModeEnum, options?: StartStreamOptions) => void;
+    handleStop: () => void;
+    resumeIfAwaitingGeneration: (currentConversationId: string, conversation: Conversation) => void;
+    /** Restores the accumulated live assistant message when its conversation is loaded again before completion. */
+    restoreBufferedGeneration: (currentConversationId: string, conversation: Conversation) => Conversation;
+    isStreaming: boolean;
+    canStopStreaming: boolean;
+    /** Whether the displayed conversation's terminal read failed. */
+    hasConversationReloadError: boolean;
+    /** Whether a retry of that read is in flight. */
+    isReloadingConversation: boolean;
+    /** Retries the failed read without saving or regenerating the answer. */
+    retryConversationReload: () => Promise<void>;
+}
+/**
+ * Owns completion-streaming state: per-path streaming/stoppable tracking,
+ * stale-chunk rejection, cross-navigation live-message buffering,
+ * reload-after-complete, backend-driven stop, and hard-refresh resume
+ * detection — all driven through the injected
+ * `transport`/`generation`/`channel`/`overlay` capabilities rather than any
+ * app context or `server-api` import.
+ */
+export declare const useConversationStream: ({ conversationId, state: { setConversation, conversationRef }, transport, generation: { startGeneration, completeGeneration }, channel, overlay, onStopError, generationConflictMessage, generationPersistenceErrorMessage, onStreamError, batchChunksPerFrame, }: UseConversationStreamParams) => UseConversationStreamResult;
+//# sourceMappingURL=useConversationStream.d.ts.map

package/conversation/useConversationStream/useConversationStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConversationStream.d.ts","sourceRoot":"","sources":["../../../src/conversation/useConversationStream/useConversationStream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACL,KAAK,YAAY,EAEjB,KAAK,oBAAoB,EAEzB,KAAK,WAAW,EACjB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,cAAc,EAMpB,MAAM,OAAO,CAAC;AA6Cf,gFAAgF;AAChF,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;IACtC,UAAU,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAChC,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,6GAA6G;IAC7G,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,uBAAuB,EAChC,aAAa,CAAC,EAAE,oBAAoB,EACpC,YAAY,CAAC,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,yBAAyB,EAChC,YAAY,CAAC,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,MAAM,GACvB,IAAI,CAAC;IACR;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,uFAAuF;IACvF,iBAAiB,CACf,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IACvC;;;;;;;OAOG;IACH,kBAAkB,CAChB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IACvC,4EAA4E;IAC5E,eAAe,CACb,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB;;;;;OAKG;IACH,gBAAgB,CAAC,CACf,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1B;AAED,6FAA6F;AAC7F,MAAM,WAAW,+BAA+B;IAC9C,iGAAiG;IACjG,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,eAAe,CAAC;IACzE,wGAAwG;IACxG,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAClE;AAED,yFAAyF;AACzF,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,oKAAoK;IACpK,cAAc,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC/D,+HAA+H;IAC/H,uBAAuB,CAAC,EAAE,MAAM,IAAI,CAAC;CACtC;AAED,6GAA6G;AAC7G,MAAM,WAAW,iCAAiC;IAChD,qBAAqB,CAAC,EAAE,MAAM,IAAI,CAAC;IACnC,mBAAmB,CAAC,EAAE,MAAM,IAAI,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;CACnC;AAED,+FAA+F;AAC/F,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/D,eAAe,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;CACxD;AAED,oDAAoD;AACpD,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,KAAK,EAAE,yBAAyB,CAAC;IACjC,SAAS,EAAE,2BAA2B,CAAC;IACvC,UAAU,EAAE,+BAA+B,CAAC;IAC5C,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,OAAO,CAAC,EAAE,iCAAiC,CAAC;IAC5C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACrC;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,iFAAiF;IACjF,iCAAiC,CAAC,EAAE,MAAM,CAAC;IAC3C;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACvC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAqBD,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,qDAAqD;AACrD,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,CACX,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,aAAa,CAAC,EAAE,oBAAoB,EACpC,YAAY,CAAC,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,kBAAkB,KACzB,IAAI,CAAC;IACV,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,0BAA0B,EAAE,CAC1B,qBAAqB,EAAE,MAAM,EAC7B,YAAY,EAAE,YAAY,KACvB,IAAI,CAAC;IACV,+GAA+G;IAC/G,yBAAyB,EAAE,CACzB,qBAAqB,EAAE,MAAM,EAC7B,YAAY,EAAE,YAAY,KACvB,YAAY,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iEAAiE;IACjE,0BAA0B,EAAE,OAAO,CAAC;IACpC,iDAAiD;IACjD,uBAAuB,EAAE,OAAO,CAAC;IACjC,yEAAyE;IACzE,uBAAuB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9C;AAkBD;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAAI,mQAYnC,2BAA2B,KAAG,2BAo+BhC,CAAC"}