Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

🔌 refactor: Inject the App Services the Steer Hooks Use through a Steer Host (#17156)

Marco Beretta73afd79e930b
diff --git a/client/src/Providers/SteerHostContext.tsx b/client/src/Providers/SteerHostContext.tsx
new file mode 100644
index 0000000000..3b95322a6e
--- /dev/null
+++ b/client/src/Providers/SteerHostContext.tsx
@@ -0,0 +1,91 @@
+import { useCallback } from 'react';
+import { useToastContext } from '@librechat/client';
+import { setDefaultSteerHost } from '@librechat/chat/react';
+import type {
+ SteerHost,
+ SteerSettings,
+ SteerNotification,
+ SteerRequestCallbacks,
+} from '@librechat/chat/react';
+import type { ChatTransportError } from '@librechat/chat';
+import {
+ fetchStreamStatus,
+ useAgentQueuedTurns,
+ useArmSteerMutation,
+ useCancelSteerMutation,
+ useSteerMessageMutation,
+ useMarkFilesUsageMutation,
+ useCancelAgentQueuedTurnMutation,
+ useEnqueueAgentQueuedTurnMutation,
+} from '~/data-provider';
+import useCodeApprovalMode from '~/hooks/Agents/useCodeApprovalMode';
+import { useChatSettings } from '~/Providers/ChatSettingsContext';
+import { useLatestMessage } from '~/hooks/Messages';
+import { useSetFilesToDelete } from '~/hooks/Files';
+import { useFileMapContext } from '~/Providers';
+import useLocalize from '~/hooks/useLocalize';
+
+/** Settles a fire-and-forget request through the caller's callbacks. The transport rejects with
+ * a `ChatTransportError`; the mutation layer only types its error as unknown. */
+const settleWith = <Result,>(callbacks?: SteerRequestCallbacks<Result>) => ({
+ onSuccess: (result: Result) => callbacks?.onSuccess?.(result),
+ onError: (error: unknown) => callbacks?.onError?.(error as ChatTransportError),
+});
+
+function useSteerMessage(): ReturnType<SteerHost['useSteerMessage']> {
+ const { mutate } = useSteerMessageMutation();
+ return useCallback((request, callbacks) => mutate(request, settleWith(callbacks)), [mutate]);
+}
+
+function useEnqueueQueuedTurn(): ReturnType<SteerHost['useEnqueueQueuedTurn']> {
+ const { mutate } = useEnqueueAgentQueuedTurnMutation();
+ return useCallback((input, callbacks) => mutate(input, settleWith(callbacks)), [mutate]);
+}
+
+function useNotify(): (notification: SteerNotification) => void {
+ const { showToast } = useToastContext();
+ return showToast;
+}
+
+function useClearFilesToDelete(): () => void {
+ const setFilesToDelete = useSetFilesToDelete();
+ return useCallback(() => setFilesToDelete({}), [setFilesToDelete]);
+}
+
+function useSettings(): SteerSettings {
+ const { config, duringRunDefaultAction, setDuringRunDefaultAction } = useChatSettings();
+ return {
+ duringRunDefaultAction,
+ setDuringRunDefaultAction,
+ queuedSendLockTimeoutMs: config.queuedSendLockTimeoutMs,
+ queuedTurnReconciliationTimeoutMs: config.queuedTurnReconciliationTimeoutMs,
+ steerArmConfirmationTimeoutMs: config.steerArmConfirmationTimeoutMs,
+ };
+}
+
+/** The app's services behind the steer and queue hooks: its transport-backed mutations and
+ * queries, toasts, translations, file map and chat settings. */
+export const appSteerHost: SteerHost = {
+ useSteerMessage,
+ useCancelSteer: () => useCancelSteerMutation().mutateAsync,
+ useArmSteer: () => useArmSteerMutation().mutateAsync,
+ useMarkFilesUsage: () => useMarkFilesUsageMutation().mutate,
+ useEnqueueQueuedTurn,
+ useCancelQueuedTurn: () => useCancelAgentQueuedTurnMutation().mutateAsync,
+ useQueuedTurns: (conversationId, enabled, clientRequestIds, reconcileUntil, expectsReceipts) =>
+ useAgentQueuedTurns(conversationId, enabled, clientRequestIds, reconcileUntil, expectsReceipts)
+ .data,
+ useFetchStreamStatus: () => fetchStreamStatus,
+ useLatestMessage: (index, conversationId) => useLatestMessage(index, conversationId),
+ useCodeApprovalMode: (conversation, addedConversation, codeEnvironmentMode) =>
+ useCodeApprovalMode(conversation, addedConversation, codeEnvironmentMode).selected,
+ useLocalize,
+ useNotify,
+ useFileMap: useFileMapContext,
+ useClearFilesToDelete,
+ useSettings,
+};
+
+setDefaultSteerHost(appSteerHost);
+
+export { SteerHostProvider, useSteerHost } from '@librechat/chat/react';
diff --git a/client/src/components/Chat/Input/__tests__/ChatForm.approvalMode.spec.tsx b/client/src/components/Chat/Input/__tests__/ChatForm.approvalMode.spec.tsx
index 4556d2f2c9..d580a92648 100644
--- a/client/src/components/Chat/Input/__tests__/ChatForm.approvalMode.spec.tsx
+++ b/client/src/components/Chat/Input/__tests__/ChatForm.approvalMode.spec.tsx
@@ -16,6 +16,7 @@ import { ChatContext, ChatFormProvider } from '~/Providers';
import { AuthContextProvider } from '~/hooks/AuthContext';
import ChatForm from '../ChatForm';
import store from '~/store';
+import '~/Providers/SteerHostContext';
jest.mock('~/hooks/Agents/useCodeApprovalMode', () => ({
__esModule: true,
diff --git a/client/src/components/Chat/Input/__tests__/ChatForm.attachments.spec.tsx b/client/src/components/Chat/Input/__tests__/ChatForm.attachments.spec.tsx
index 04e31d07a3..d490de9b82 100644
--- a/client/src/components/Chat/Input/__tests__/ChatForm.attachments.spec.tsx
+++ b/client/src/components/Chat/Input/__tests__/ChatForm.attachments.spec.tsx
@@ -21,6 +21,7 @@ import { AuthContextProvider } from '~/hooks/AuthContext';
import * as FileContainer from '../Files/FileContainer';
import ChatForm from '../ChatForm';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const mockUpload = jest.fn();
const mockAsk = jest.fn();
diff --git a/client/src/components/Chat/Input/__tests__/ChatForm.enterToSend.spec.tsx b/client/src/components/Chat/Input/__tests__/ChatForm.enterToSend.spec.tsx
index dd07472bef..0120014c33 100644
--- a/client/src/components/Chat/Input/__tests__/ChatForm.enterToSend.spec.tsx
+++ b/client/src/components/Chat/Input/__tests__/ChatForm.enterToSend.spec.tsx
@@ -17,6 +17,7 @@ import { ChatContext, ChatFormProvider } from '~/Providers';
import { AuthContextProvider } from '~/hooks/AuthContext';
import ChatForm from '../ChatForm';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const conversation = {
conversationId: 'new',
diff --git a/client/src/components/Chat/Input/__tests__/ChatForm.pasteUpload.spec.tsx b/client/src/components/Chat/Input/__tests__/ChatForm.pasteUpload.spec.tsx
index 002f28516a..ab35e165c3 100644
--- a/client/src/components/Chat/Input/__tests__/ChatForm.pasteUpload.spec.tsx
+++ b/client/src/components/Chat/Input/__tests__/ChatForm.pasteUpload.spec.tsx
@@ -18,6 +18,7 @@ import { AuthContextProvider } from '~/hooks/AuthContext';
import DragDropWrapper from '../Files/DragDropWrapper';
import ChatForm from '../ChatForm';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const mockUpload = jest.fn();
const mockAsk = jest.fn();
diff --git a/client/src/components/Chat/Input/__tests__/ChatForm.queryParams.spec.tsx b/client/src/components/Chat/Input/__tests__/ChatForm.queryParams.spec.tsx
index 1212cfcae5..ee7e4ce177 100644
--- a/client/src/components/Chat/Input/__tests__/ChatForm.queryParams.spec.tsx
+++ b/client/src/components/Chat/Input/__tests__/ChatForm.queryParams.spec.tsx
@@ -24,6 +24,7 @@ import { AuthContextProvider } from '~/hooks/AuthContext';
import { startupConfigKey } from '~/data-provider';
import ChatForm from '../ChatForm';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const initialConversation = {
conversationId: 'new',
diff --git a/client/src/data-provider/SSE/queuedTurns.ts b/client/src/data-provider/SSE/queuedTurns.ts
index 3b38557867..acefa6023b 100644
--- a/client/src/data-provider/SSE/queuedTurns.ts
+++ b/client/src/data-provider/SSE/queuedTurns.ts
@@ -1,12 +1,15 @@
import { useEffect, useRef } from 'react';
import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
import { dataService, MutationKeys, QueryKeys } from 'librechat-data-provider';
+import { isDefiniteQueuedTurnRejection, isDefiniteQueuedTurnsUnsupported } from '@librechat/chat';
import type {
TAgentQueuedTurnReceipt,
TEnqueueAgentQueuedTurnRequest,
} from 'librechat-data-provider';
import { useChatTransport } from '~/Providers/ChatTransportContext';
+export { isDefiniteQueuedTurnRejection, isDefiniteQueuedTurnsUnsupported };
+
export type AgentQueuedTurnReceipt = TAgentQueuedTurnReceipt;
export type EnqueueAgentQueuedTurnRequest = TEnqueueAgentQueuedTurnRequest;
@@ -17,42 +20,6 @@ export type EnqueueAgentQueuedTurnRequest = TEnqueueAgentQueuedTurnRequest;
export const agentQueuedTurnsQueryKey = (conversationId: string) =>
[QueryKeys.agentQueuedTurns, conversationId] as const;
-function queuedTurnErrorResponse(error: unknown): { status?: number; code?: string } {
- const response = (
- error as { response?: { status?: unknown; data?: { code?: unknown } } } | undefined
- )?.response;
- return {
- ...(typeof response?.status === 'number' && { status: response.status }),
- ...(typeof response?.data?.code === 'string' && { code: response.data.code }),
- };
-}
-
-export function isDefiniteQueuedTurnsUnsupported(error: unknown): boolean {
- const { status, code } = queuedTurnErrorResponse(error);
- return (
- (status === 404 && code == null) ||
- (status === 501 &&
- (code == null ||
- code === 'QUEUED_TURNS_UNSUPPORTED' ||
- code === 'QUEUED_TURN_PRIORITY_UNSUPPORTED'))
- );
-}
-
-/** A bounded origin 4xx proves the queued row was not committed. Timeouts and
- * early-data responses can be generated while the origin request continues,
- * so those remain outcome-ambiguous and must reconcile by request identity. */
-export function isDefiniteQueuedTurnRejection(error: unknown): boolean {
- const { status } = queuedTurnErrorResponse(error);
- return (
- !isDefiniteQueuedTurnsUnsupported(error) &&
- typeof status === 'number' &&
- status >= 400 &&
- status < 500 &&
- status !== 408 &&
- status !== 425
- );
-}
-
export async function fetchAgentQueuedTurns(
conversationId: string,
clientRequestIds?: string[],
diff --git a/client/src/hooks/Chat/__tests__/transport.spec.tsx b/client/src/hooks/Chat/__tests__/transport.spec.tsx
index d8f5b5e6a1..7bf8155486 100644
--- a/client/src/hooks/Chat/__tests__/transport.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/transport.spec.tsx
@@ -39,6 +39,7 @@ import useSteering from '~/hooks/Chat/useSteering';
import { useChat } from '~/hooks/Chat/facade';
import useSSE from '~/hooks/SSE/useSSE';
import store from '~/store';
+import '~/Providers/SteerHostContext';
jest.mock('~/hooks/AuthContext', () => {
const { createContext } = jest.requireActual('react');
diff --git a/client/src/hooks/Chat/__tests__/useQueueDrain.spec.tsx b/client/src/hooks/Chat/__tests__/useQueueDrain.spec.tsx
index 3c5309b15d..582f851012 100644
--- a/client/src/hooks/Chat/__tests__/useQueueDrain.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useQueueDrain.spec.tsx
@@ -28,6 +28,7 @@ import {
} from '~/hooks/Chat/queue';
import { recoveryDispositionsFamily } from '~/components/Chat/Steering/recovery';
import useQueueDrain from '../useQueueDrain';
+import '~/Providers/SteerHostContext';
const mockMarkFilesUsage = jest.fn();
jest.mock('~/data-provider', () => ({
diff --git a/client/src/hooks/Chat/__tests__/useSteerCancel.spec.tsx b/client/src/hooks/Chat/__tests__/useSteerCancel.spec.tsx
index ed044e0b63..7a66e4ca73 100644
--- a/client/src/hooks/Chat/__tests__/useSteerCancel.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useSteerCancel.spec.tsx
@@ -16,6 +16,7 @@ import {
} from '~/Providers/ComposerRestoreContext';
import { queuedMessagesByConvoId, resetQueueFamilies } from '~/hooks/Chat/queue';
import useSteerCancel, { useSteerMoveToQueue } from '../useSteerCancel';
+import '~/Providers/SteerHostContext';
const mockCancelAsync = jest.fn();
diff --git a/client/src/hooks/Chat/__tests__/useSteerConvert.spec.tsx b/client/src/hooks/Chat/__tests__/useSteerConvert.spec.tsx
index 16cb3bc29f..413c683188 100644
--- a/client/src/hooks/Chat/__tests__/useSteerConvert.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useSteerConvert.spec.tsx
@@ -11,6 +11,7 @@ import {
import { recoveryDispositionsFamily } from '~/components/Chat/Steering/recovery';
import { queuedMessagesByConvoId, resetQueueFamilies } from '~/hooks/Chat/queue';
import useSteerConvert from '../useSteerConvert';
+import '~/Providers/SteerHostContext';
const mockFetchStreamStatus = jest.fn();
let mockFileMap: Record<string, { llmDeliveryPath: 'text' }> = {};
diff --git a/client/src/hooks/Chat/__tests__/useSteerEscalate.spec.tsx b/client/src/hooks/Chat/__tests__/useSteerEscalate.spec.tsx
index 147f51f5d4..4a3ae8ae65 100644
--- a/client/src/hooks/Chat/__tests__/useSteerEscalate.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useSteerEscalate.spec.tsx
@@ -12,6 +12,7 @@ import {
import type { PendingSteer } from '~/hooks/Chat/queue';
import { ChatSettingsContext, defaultChatSettings } from '~/Providers/ChatSettingsContext';
import useSteerEscalate from '../useSteerEscalate';
+import '~/Providers/SteerHostContext';
const mockArmMutateAsync = jest.fn();
const mockShowToast = jest.fn();
diff --git a/client/src/hooks/Chat/__tests__/useSteerRecovery.spec.tsx b/client/src/hooks/Chat/__tests__/useSteerRecovery.spec.tsx
index 2a9b97d4ff..0ba0fe88aa 100644
--- a/client/src/hooks/Chat/__tests__/useSteerRecovery.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useSteerRecovery.spec.tsx
@@ -21,6 +21,7 @@ import { queuedMessagesByConvoId, resetQueueFamilies } from '~/hooks/Chat/queue'
import { usePaneConversations } from '~/routes/ChatSettings';
import useSteerRecovery from '../useSteerRecovery';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const mockMutateAsync = jest.fn();
const mockCancelSteer = jest.fn();
diff --git a/client/src/hooks/Chat/__tests__/useSteering.spec.tsx b/client/src/hooks/Chat/__tests__/useSteering.spec.tsx
index d43d0f3c68..bd353ee6d7 100644
--- a/client/src/hooks/Chat/__tests__/useSteering.spec.tsx
+++ b/client/src/hooks/Chat/__tests__/useSteering.spec.tsx
@@ -54,6 +54,7 @@ import { duringRunActionAtom } from '~/store/duringRun';
import { applyPendingAction } from '~/utils/approval';
import English from '~/locales/en/translation.json';
import useQueueDrain from '../useQueueDrain';
+import '~/Providers/SteerHostContext';
const CONVO_ID = 'convo-steer-ui';
const UUID_V4_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
diff --git a/client/src/hooks/Chat/steering/composer.ts b/client/src/hooks/Chat/steering/composer.ts
index f733e28d42..3ab2fde771 100644
--- a/client/src/hooks/Chat/steering/composer.ts
+++ b/client/src/hooks/Chat/steering/composer.ts
@@ -1,5 +1,6 @@
import { useCallback, useMemo } from 'react';
import { useStore } from 'jotai';
+import { useSteerHost } from '@librechat/chat/react';
import type { QueuedMessageContext } from '@librechat/chat';
import type { TMessage } from 'librechat-data-provider';
import type { ExtendedFile, FileSetter } from '~/common';
@@ -9,7 +10,6 @@ import {
pendingReasoningOverrideFamily,
} from '~/components/Chat/Input/Composer/state';
import { markComposerFilesTaken } from '~/utils/composerFiles';
-import { useSetFilesToDelete } from '~/hooks/Files';
export interface ComposerTake {
takeComposerFiles: () => TMessage['files'];
@@ -31,7 +31,7 @@ export default function useComposerTake({
setFiles?: FileSetter;
}): ComposerTake {
const reasoningStore = useStore();
- const setFilesToDelete = useSetFilesToDelete();
+ const clearFilesToDelete = useSteerHost().useClearFilesToDelete();
/** Consumes completed composer attachments into message file refs (clearing
* the composer) so they pair with THIS queued message instead of gluing
@@ -74,9 +74,9 @@ export default function useComposerTake({
}
return remaining;
});
- setFilesToDelete({});
+ clearFilesToDelete();
return taken;
- }, [files, setFiles, setFilesToDelete]);
+ }, [files, setFiles, clearFilesToDelete]);
/** Consumes staged quote chips + manual skill picks (mirroring `ask()`'s
* fresh-submit drain of the same atoms) so they pair with THIS queued
diff --git a/client/src/hooks/Chat/steering/enqueue.ts b/client/src/hooks/Chat/steering/enqueue.ts
index 645e60f840..dfa0c504c7 100644
--- a/client/src/hooks/Chat/steering/enqueue.ts
+++ b/client/src/hooks/Chat/steering/enqueue.ts
@@ -1,18 +1,14 @@
import { useCallback, useMemo } from 'react';
import { v4 } from 'uuid';
import { useStore } from 'jotai';
+import { useSteerHost } from '@librechat/chat/react';
import { getSteerErrorCode, toQueuedTurnFileRefs, QUEUE_USAGE_MAX_FILES } from '@librechat/chat';
+import { isDefiniteQueuedTurnRejection, isDefiniteQueuedTurnsUnsupported } from '@librechat/chat';
import type { TMessage, CodeApprovalMode } from 'librechat-data-provider';
import type { RevealedQueuedTurn } from '@librechat/chat/react';
import type { QueuedMessage } from '@librechat/chat';
import type { QueuedTurnReceipts } from './receipts';
import type { QueueRows } from './rows';
-import {
- useMarkFilesUsageMutation,
- isDefiniteQueuedTurnRejection,
- isDefiniteQueuedTurnsUnsupported,
- useEnqueueAgentQueuedTurnMutation,
-} from '~/data-provider';
import { pendingQueuedTurnEnqueueIdsByConvoId, queuedMessagesByConvoId } from '~/hooks/Chat/queue';
import { insertQueuedMessage } from '~/utils/queue';
@@ -42,8 +38,9 @@ export default function useQueueEnqueue({
updateQueuedMessage: QueueRows['updateQueuedMessage'];
}) {
const jotaiStore = useStore();
- const { mutate: markFilesUsage } = useMarkFilesUsageMutation();
- const { mutate: enqueueAgentQueuedTurn } = useEnqueueAgentQueuedTurnMutation();
+ const host = useSteerHost();
+ const markFilesUsage = host.useMarkFilesUsage();
+ const enqueueAgentQueuedTurn = host.useEnqueueQueuedTurn();
/** Fire-and-forget TTL hold for uploads entering the client queue: a
* queued message can outlive the upload window (long run, approval pause)
* and send-time marking only happens at drain. The server extends the
diff --git a/client/src/hooks/Chat/steering/receipts.ts b/client/src/hooks/Chat/steering/receipts.ts
index 477543ae0b..2925a9c366 100644
--- a/client/src/hooks/Chat/steering/receipts.ts
+++ b/client/src/hooks/Chat/steering/receipts.ts
@@ -1,17 +1,15 @@
import { useCallback, useEffect, useMemo } from 'react';
+import { useSteerHost } from '@librechat/chat/react';
import { useAtomValue, useSetAtom, useStore } from 'jotai';
import { DEFAULT_QUEUED_TURN_RECONCILIATION_TIMEOUT_MS } from 'librechat-data-provider';
import { reconcileServerQueuedTurns, mergeSettledQueuedTurnEvidence } from '@librechat/chat';
+import type { TAgentQueuedTurnReceipt as AgentQueuedTurnReceipt } from 'librechat-data-provider';
import type { QueuedTurnReceiptSource } from '@librechat/chat';
-import type { AgentQueuedTurnReceipt } from '~/data-provider';
import {
queuedMessagesByConvoId,
settledQueuedTurnReceiptsByConvoId,
pendingQueuedTurnEnqueueIdsByConvoId,
} from '~/hooks/Chat/queue';
-import { useChatSettings } from '~/Providers/ChatSettingsContext';
-import { useAgentQueuedTurns } from '~/data-provider';
-import { useFileMapContext } from '~/Providers';
export interface QueuedTurnReceipts {
/** Folds server receipts into the settled evidence and, unless `direct`, the visible queue. */
@@ -39,8 +37,9 @@ export default function useQueuedTurnReceipts({
serverQueueEnabled: boolean;
}): QueuedTurnReceipts {
const jotaiStore = useStore();
- const fileMap = useFileMapContext();
- const { config } = useChatSettings();
+ const host = useSteerHost();
+ const fileMap = host.useFileMap();
+ const { queuedTurnReconciliationTimeoutMs } = host.useSettings();
const queuedMessages = useAtomValue(queuedMessagesByConvoId(queueKey));
const setQueuedMessages = useSetAtom(queuedMessagesByConvoId(queueKey));
/** Bound transport-outcome reconciliation while still guaranteeing several
@@ -48,7 +47,7 @@ export default function useQueuedTurnReceipts({
* reconciliation path; a slow proxy or a delayed read replica needs the
* operator to widen this rather than wait for one. */
const reconciliationWindowMs =
- config.queuedTurnReconciliationTimeoutMs ?? DEFAULT_QUEUED_TURN_RECONCILIATION_TIMEOUT_MS;
+ queuedTurnReconciliationTimeoutMs ?? DEFAULT_QUEUED_TURN_RECONCILIATION_TIMEOUT_MS;
const knownClientRequestIds = useMemo(
() =>
Array.from(
@@ -92,7 +91,7 @@ export default function useQueuedTurnReceipts({
),
[queuedMessages],
);
- const { data: serverQueuedTurns } = useAgentQueuedTurns(
+ const serverQueuedTurns = host.useQueuedTurns(
conversationId,
serverQueueEnabled,
knownClientRequestIds,
diff --git a/client/src/hooks/Chat/steering/recovery.ts b/client/src/hooks/Chat/steering/recovery.ts
index 60cdbb6754..b7dddbe3ef 100644
--- a/client/src/hooks/Chat/steering/recovery.ts
+++ b/client/src/hooks/Chat/steering/recovery.ts
@@ -1,14 +1,12 @@
import { useCallback, useMemo } from 'react';
import { useStore } from 'jotai';
-import { useToastContext } from '@librechat/client';
+import { useSteerHost } from '@librechat/chat/react';
import { revealedQueuedTurnFamily } from '@librechat/chat/react';
import { blockRecovery, canRestoreRecovery, recoveryDisposition } from '@librechat/chat';
import type { QueuedMessage } from '@librechat/chat';
import type { QueuedTurnReceipts } from './receipts';
import type { QueueRows } from './rows';
-import { useCancelSteerMutation, useCancelAgentQueuedTurnMutation } from '~/data-provider';
import { recoveryDispositionsFamily } from '~/components/Chat/Steering/recovery';
-import useLocalize from '~/hooks/useLocalize';
/** Lets go of a queued row's server copy (a durable queued turn or a parked
* steer receipt) before the row is edited, removed or sent another way. */
@@ -27,11 +25,12 @@ export default function useQueuedRecovery({
downgradeServerQueuedTurn: QueueRows['downgradeServerQueuedTurn'];
removeQueued: QueueRows['removeQueued'];
}) {
- const localize = useLocalize();
+ const host = useSteerHost();
+ const localize = host.useLocalize();
const jotaiStore = useStore();
- const { showToast } = useToastContext();
- const { mutateAsync: cancelSteer } = useCancelSteerMutation();
- const { mutateAsync: cancelAgentQueuedTurn } = useCancelAgentQueuedTurnMutation();
+ const notify = host.useNotify();
+ const cancelSteer = host.useCancelSteer();
+ const cancelAgentQueuedTurn = host.useCancelQueuedTurn();
/** Settle a queued row's terminal recovery source before an Edit/Remove.
* Ordinary rows have no server copy. A v2 leftover first uses its durable
* receipt to atomically discard the parked copy, then becomes an ordinary
@@ -45,7 +44,7 @@ export default function useQueuedRecovery({
return downgradeServerQueuedTurn(item.id);
}
if (item.server.id == null || !hasRealConvoId) {
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -57,7 +56,7 @@ export default function useQueuedRecovery({
queuedTurnId: item.server.id,
});
if (receipt.status !== 'cancelled') {
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -72,7 +71,7 @@ export default function useQueuedRecovery({
}
return downgradeServerQueuedTurn(item.id);
} catch {
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -86,7 +85,7 @@ export default function useQueuedRecovery({
jotaiStore.set(recoveryDispositionsFamily(queueKey), (previous) =>
blockRecovery(previous, item.recoverySteerId!),
);
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -112,7 +111,7 @@ export default function useQueuedRecovery({
clientSteerId: item.recoveryClientSteerId,
});
if (removed !== true) {
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -123,7 +122,7 @@ export default function useQueuedRecovery({
// A newer composer draft must not turn cancelled words into an auto-send.
return true;
} catch {
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'error',
});
@@ -142,7 +141,7 @@ export default function useQueuedRecovery({
downgradeServerQueuedTurn,
hasRealConvoId,
localize,
- showToast,
+ notify,
jotaiStore,
queueKey,
],
diff --git a/client/src/hooks/Chat/steering/submit.ts b/client/src/hooks/Chat/steering/submit.ts
index fcc2ce08a5..53c9014aeb 100644
--- a/client/src/hooks/Chat/steering/submit.ts
+++ b/client/src/hooks/Chat/steering/submit.ts
@@ -1,6 +1,6 @@
import { useCallback, useRef } from 'react';
import { v4 } from 'uuid';
-import { useToastContext } from '@librechat/client';
+import { useSteerHost } from '@librechat/chat/react';
import {
steerAttemptChip,
routeSteerFailure,
@@ -21,10 +21,8 @@ import type { MutableRefObject } from 'react';
import type { QueueEnqueue } from './enqueue';
import type { SteerChips } from './chips';
import type { QueueRows } from './rows';
-import { useCancelSteerMutation, useSteerMessageMutation } from '~/data-provider';
import { useSteerRehome } from '~/hooks/Chat/useSteerCancel';
import useSteerConvert from '~/hooks/Chat/useSteerConvert';
-import useLocalize from '~/hooks/useLocalize';
export type SubmitSteer = (
text: string,
@@ -61,16 +59,17 @@ export default function useSubmitSteer({
rows: Pick<QueueRows, 'restoreQueued' | 'rewakeDrain' | 'registerQueuedOrigin'>;
enqueue: QueueEnqueue['enqueue'];
}): SubmitSteer {
- const localize = useLocalize();
- const { showToast } = useToastContext();
+ const host = useSteerHost();
+ const localize = host.useLocalize();
+ const notify = host.useNotify();
const convertSteersToQueued = useSteerConvert();
/* The single boundary a steer's words return through, wherever the cancel
that reclaimed them was decided. */
const rehomeSteer = useSteerRehome(conversationId);
/** `mutate` is a stable callback; the mutation result objects are fresh
* every render and would defeat the memoized return value of the caller. */
- const { mutate: steerMessage } = useSteerMessageMutation();
- const { mutateAsync: cancelSteer } = useCancelSteerMutation();
+ const steerMessage = host.useSteerMessage();
+ const cancelSteer = host.useCancelSteer();
const dispatchRef = useRef(createSteerDispatch());
const {
upsertSteerChip,
@@ -272,7 +271,7 @@ export default function useSubmitSteer({
response.preempt !== true &&
visibleConversationRef.current === conversationId
) {
- showToast({
+ notify({
message: localize('com_ui_steer_preempt_unsupported'),
status: 'warning',
});
@@ -313,7 +312,7 @@ export default function useSubmitSteer({
comes back through the ordinary acknowledgement, so it
settles like any other accepted steer. */
acceptResponse();
- showToast({
+ notify({
message: localize('com_ui_steer_already_applied'),
status: 'info',
});
@@ -323,7 +322,7 @@ export default function useSubmitSteer({
/* Unknown outcome, but the POST was accepted: treat the
steer as live rather than claiming it is gone. */
acceptResponse();
- showToast({
+ notify({
message: localize('com_ui_steer_cancel_failed'),
status: 'warning',
});
@@ -373,7 +372,7 @@ export default function useSubmitSteer({
return;
}
restoreRejectedSteer();
- showToast({
+ notify({
message: localize('com_ui_steer_paused_queued'),
status: 'info',
});
@@ -386,7 +385,7 @@ export default function useSubmitSteer({
* drain regardless of this tab's local submission state. */
replaceSteerChip(conversationId, localId, null);
restoreRejectedSteer();
- showToast({
+ notify({
message: localize('com_ui_steer_paused_queued'),
status: 'info',
});
@@ -434,7 +433,7 @@ export default function useSubmitSteer({
hasPendingSteerCancel,
clearPendingSteerCancel,
cancelSteer,
- showToast,
+ notify,
localize,
activeGenerationCreatedAt,
activeGenerationProtocolVersion,
diff --git a/client/src/hooks/Chat/useSteerCancel.ts b/client/src/hooks/Chat/useSteerCancel.ts
index 1ab4713d7f..6b4a8e747a 100644
--- a/client/src/hooks/Chat/useSteerCancel.ts
+++ b/client/src/hooks/Chat/useSteerCancel.ts
@@ -1,4 +1,5 @@
import { useCallback } from 'react';
+import { useSteerHost } from '@librechat/chat/react';
import { useSetAtom, useStore, useAtomValue } from 'jotai';
import {
pendingSteerCancelClientIdsFamily,
@@ -11,7 +12,6 @@ import { useComposerRestoreHost } from '~/Providers/ComposerRestoreContext';
import { appendAppliedSteerIds, carriedSteerContext } from '~/utils';
import { queuedMessagesByConvoId } from '~/hooks/Chat/queue';
import useSteerConvert from '~/hooks/Chat/useSteerConvert';
-import { useCancelSteerMutation } from '~/data-provider';
export type SteerCancelOutcome = 'reclaimed' | 'applied' | 'failed';
@@ -23,7 +23,7 @@ export type SteerRehomeTarget = 'composer' | 'queue';
* confirmed reclaim proves the words remain safe to move elsewhere.
*/
export function useSteerReclaim(conversationId: string) {
- const cancelMutation = useCancelSteerMutation();
+ const cancelSteer = useSteerHost().useCancelSteer();
const activeGenerationCreatedAt = useAtomValue(
activeGenerationCreatedAtByConvoId(conversationId),
);
@@ -64,7 +64,7 @@ export function useSteerReclaim(conversationId: string) {
if (generationCreatedAt == null) {
return 'failed';
}
- const { removed } = await cancelMutation.mutateAsync({
+ const { removed } = await cancelSteer({
conversationId,
steerId: steer.steerId,
...(steer.clientSteerId && { clientSteerId: steer.clientSteerId }),
@@ -79,7 +79,7 @@ export function useSteerReclaim(conversationId: string) {
return 'failed';
}
},
- [conversationId, cancelMutation, settleReclaimed, activeGenerationCreatedAt],
+ [conversationId, cancelSteer, settleReclaimed, activeGenerationCreatedAt],
);
}
diff --git a/client/src/hooks/Chat/useSteerConvert.ts b/client/src/hooks/Chat/useSteerConvert.ts
index a3bcfc26eb..46a36cca09 100644
--- a/client/src/hooks/Chat/useSteerConvert.ts
+++ b/client/src/hooks/Chat/useSteerConvert.ts
@@ -1,14 +1,16 @@
import { useCallback, useRef } from 'react';
import { v4 } from 'uuid';
import { useStore } from 'jotai';
+import { useSteerHost } from '@librechat/chat/react';
+import { getGenerationProtocolVersion } from '@librechat/chat';
import {
pendingSteersByConvoId,
appliedSteerIdsByConvoId,
activeGenerationProtocolVersionByConvoId,
} from '@librechat/chat/react';
+import type { GenerationProtocolVersion } from '@librechat/chat';
import type { TPendingSteer } from 'librechat-data-provider';
import type { QueuedMessage, QueuedMessageOrigin } from '~/hooks/Chat/queue';
-import type { GenerationProtocolVersion } from '~/data-provider';
import type { SteerCarriedContext } from '~/utils';
import {
appendAppliedSteerIds,
@@ -20,9 +22,7 @@ import {
recoveryDispositionsFamily,
canRestoreRecovery,
} from '~/components/Chat/Steering/recovery';
-import { fetchStreamStatus, getGenerationProtocolVersion } from '~/data-provider';
import { queuedMessagesByConvoId } from '~/hooks/Chat/queue';
-import { useFileMapContext } from '~/Providers';
/** A server-reported steer, or a local one that carries its own client-only
* context (quotes / skill picks) because its chip may already be gone. */
@@ -69,7 +69,9 @@ interface SteerConvertOptions {
*/
export default function useSteerConvert() {
const jotaiStore = useStore();
- const fileMap = useFileMapContext();
+ const host = useSteerHost();
+ const fileMap = host.useFileMap();
+ const fetchStreamStatus = host.useFetchStreamStatus();
const fileMapRef = useRef(fileMap);
fileMapRef.current = fileMap;
const convert = useCallback(
@@ -267,6 +269,6 @@ export default function useSteerConvert() {
})
.catch(() => undefined);
},
- [convert],
+ [convert, fetchStreamStatus],
);
}
diff --git a/client/src/hooks/Chat/useSteerEscalate.ts b/client/src/hooks/Chat/useSteerEscalate.ts
index c6758a063e..0f0a54b366 100644
--- a/client/src/hooks/Chat/useSteerEscalate.ts
+++ b/client/src/hooks/Chat/useSteerEscalate.ts
@@ -1,6 +1,7 @@
import { useCallback } from 'react';
-import { useToastContext } from '@librechat/client';
+import { useSteerHost } from '@librechat/chat/react';
import { useSetAtom, useAtomValue, useStore } from 'jotai';
+import { supportsGenerationProtocolV2 } from '@librechat/chat';
import { DEFAULT_STEER_ARM_CONFIRMATION_TIMEOUT_MS } from 'librechat-data-provider';
import {
escalatingSteerFamily,
@@ -8,9 +9,6 @@ import {
activeGenerationCreatedAtByConvoId,
activeGenerationProtocolVersionByConvoId,
} from '@librechat/chat/react';
-import { supportsGenerationProtocolV2, useArmSteerMutation } from '~/data-provider';
-import { useChatSettings } from '~/Providers/ChatSettingsContext';
-import useLocalize from '~/hooks/useLocalize';
type ArmFailure = {
name?: string;
@@ -47,12 +45,13 @@ export interface EscalateTarget {
* `onArmed` lets a caller move focus off a control the success state removes.
*/
export default function useSteerEscalate(conversationId: string) {
- const localize = useLocalize();
- const { showToast } = useToastContext();
- const { mutateAsync: armSteer } = useArmSteerMutation();
- const { config } = useChatSettings();
+ const host = useSteerHost();
+ const localize = host.useLocalize();
+ const notify = host.useNotify();
+ const armSteer = host.useArmSteer();
+ const { steerArmConfirmationTimeoutMs } = host.useSettings();
const armConfirmTimeoutMs =
- config.steerArmConfirmationTimeoutMs ?? DEFAULT_STEER_ARM_CONFIRMATION_TIMEOUT_MS;
+ steerArmConfirmationTimeoutMs ?? DEFAULT_STEER_ARM_CONFIRMATION_TIMEOUT_MS;
const setEscalating = useSetAtom(escalatingSteerFamily(conversationId));
const jotaiStore = useStore();
const activeGenerationCreatedAt = useAtomValue(
@@ -123,7 +122,7 @@ export default function useSteerEscalate(conversationId: string) {
return;
}
if (!responseSupportsNegotiatedProtocol) {
- showToast({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
+ notify({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
return;
}
/** Once a response was lost, a later `armed: false` cannot prove the
@@ -131,13 +130,13 @@ export default function useSteerEscalate(conversationId: string) {
* may have paused between attempts. Keep the chip event-driven and
* report the result as unknown instead of claiming a lost race. */
if (firstResponseWasLost) {
- showToast({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
+ notify({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
return;
}
/* `armed: false` is deliberately ambiguous (injected, cancelled,
* re-homed, or run over), so the message only says the escalation
* lost, and the chip defers to the events for what happened. */
- showToast({
+ notify({
message: localize(
response.code === 'PREEMPT_UNSUPPORTED'
? 'com_ui_steer_preempt_unsupported'
@@ -147,10 +146,10 @@ export default function useSteerEscalate(conversationId: string) {
});
} catch (error) {
if (isAmbiguousArmFailure(error)) {
- showToast({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
+ notify({ message: localize('com_ui_steer_arm_unconfirmed'), status: 'warning' });
return;
}
- showToast({
+ notify({
message: localize(
armFailureCode(error) === 'PREEMPT_UNSUPPORTED'
? 'com_ui_steer_preempt_unsupported'
@@ -173,7 +172,7 @@ export default function useSteerEscalate(conversationId: string) {
armConfirmTimeoutMs,
setEscalating,
markSteerPreempt,
- showToast,
+ notify,
localize,
],
);
diff --git a/client/src/hooks/Chat/useSteering.ts b/client/src/hooks/Chat/useSteering.ts
index d214425527..21812d8a8d 100644
--- a/client/src/hooks/Chat/useSteering.ts
+++ b/client/src/hooks/Chat/useSteering.ts
@@ -1,5 +1,6 @@
import { useCallback, useMemo, useRef } from 'react';
import { useAtomValue } from 'jotai';
+import { useSteerHost } from '@librechat/chat/react';
import { hasLiveRunPause, selectLiveMessageState } from '@librechat/chat';
import {
Constants,
@@ -23,11 +24,8 @@ import {
getReasoningStateKey,
pendingReasoningOverrideFamily,
} from '~/components/Chat/Input/Composer/state';
-import { useChatSettings } from '~/Providers/ChatSettingsContext';
-import useCodeApprovalMode from '../Agents/useCodeApprovalMode';
import useQueuedTurnReceipts from './steering/receipts';
import useDuringRunActions from './steering/actions';
-import { useLatestMessage } from '~/hooks/Messages';
import useQueuedRecovery from './steering/recovery';
import useComposerTake from './steering/composer';
import useQueueEnqueue from './steering/enqueue';
@@ -109,13 +107,14 @@ export default function useSteering({
}: UseSteeringParams) {
const composerDisabledRef = useRef(composerDisabled);
composerDisabledRef.current = composerDisabled;
+ const host = useSteerHost();
const {
- config,
+ queuedSendLockTimeoutMs,
duringRunDefaultAction: defaultAction,
setDuringRunDefaultAction: setDefaultAction,
- } = useChatSettings();
+ } = host.useSettings();
- const { selected: codeApprovalMode } = useCodeApprovalMode(
+ const codeApprovalMode = host.useCodeApprovalMode(
conversation,
addedConversation,
codeEnvironmentMode,
@@ -129,7 +128,7 @@ export default function useSteering({
const enabled = steerable && index === 0;
const queueKey = hasRealConvoId ? conversationId : Constants.NEW_CONVO;
const reasoningStateKey = getReasoningStateKey(conversationId, index);
- const sendLockTimeoutMs = config.queuedSendLockTimeoutMs ?? DEFAULT_QUEUED_SEND_LOCK_TIMEOUT_MS;
+ const sendLockTimeoutMs = queuedSendLockTimeoutMs ?? DEFAULT_QUEUED_SEND_LOCK_TIMEOUT_MS;
const pendingReasoningOverride = useAtomValue(pendingReasoningOverrideFamily(reasoningStateKey));
const { applyQueuedTurnReceipts, finishQueuedTurnEnqueue } = useQueuedTurnReceipts({
conversationId,
@@ -175,7 +174,7 @@ export default function useSteering({
/** Capture a durable branch anchor into a server queued turn. Optimistic
* assistant placeholders are siblings of their eventual persisted response,
* so they anchor through their stable user parent. */
- const latestMessage = useLatestMessage(index, hasRealConvoId ? conversationId : null);
+ const latestMessage = host.useLatestMessage(index, hasRealConvoId ? conversationId : null);
const liveMessageState = useMemo(() => selectLiveMessageState(latestMessage), [latestMessage]);
/** Both approval cards and `ask_user_question` suspend the current
* generation while keeping its submission slot occupied. Answer mode hides
diff --git a/client/src/hooks/SSE/__tests__/useResumeOnLoad.spec.tsx b/client/src/hooks/SSE/__tests__/useResumeOnLoad.spec.tsx
index cbda09e449..d24abca803 100644
--- a/client/src/hooks/SSE/__tests__/useResumeOnLoad.spec.tsx
+++ b/client/src/hooks/SSE/__tests__/useResumeOnLoad.spec.tsx
@@ -33,6 +33,7 @@ import { pendingApprovalActionFamily } from '~/components/Chat/approval/state';
import { agentQueuedTurnsQueryKey } from '~/data-provider/SSE/queuedTurns';
import useResumeOnLoad from '../useResumeOnLoad';
import store from '~/store';
+import '~/Providers/SteerHostContext';
const mockUseStreamStatus = jest.fn();
const mockUseActiveJobs = jest.fn();
diff --git a/client/src/routes/Root.tsx b/client/src/routes/Root.tsx
index a89e73ec6d..a7f416258a 100644
--- a/client/src/routes/Root.tsx
+++ b/client/src/routes/Root.tsx
@@ -36,6 +36,7 @@ import {
normalizeCodeHighlightThrottleMs,
} from '~/components/Chat/Messages/Content/Parts/useLazyHighlight';
import KeyboardShortcutsDialog from '~/components/Nav/KeyboardShortcutsDialog';
+import { SteerHostProvider, appSteerHost } from '~/Providers/SteerHostContext';
import KeyboardDeleteDialog from '~/components/Nav/KeyboardDeleteDialog';
import { useUserTermsQuery, useGetStartupConfig } from '~/data-provider';
import { MobileDrawerScrim } from '~/components/UnifiedSidebar/mobile';
@@ -274,7 +275,9 @@ function RootLayout() {
export default function Root() {
return (
<ChatSettingsProvider>
- <RootLayout />
+ <SteerHostProvider host={appSteerHost}>
+ <RootLayout />
+ </SteerHostProvider>
</ChatSettingsProvider>
);
}
diff --git a/packages/chat/src/core/steer/errors.ts b/packages/chat/src/core/steer/errors.ts
index 3d9106ebc8..632095d67b 100644
--- a/packages/chat/src/core/steer/errors.ts
+++ b/packages/chat/src/core/steer/errors.ts
@@ -45,3 +45,39 @@ export function isDefiniteSteerRejection(error: unknown): boolean {
status !== 425
);
}
+
+function queuedTurnErrorResponse(error: unknown): { status?: number; code?: string } {
+ const response = (
+ error as { response?: { status?: unknown; data?: { code?: unknown } } } | undefined
+ )?.response;
+ return {
+ ...(typeof response?.status === 'number' && { status: response.status }),
+ ...(typeof response?.data?.code === 'string' && { code: response.data.code }),
+ };
+}
+
+export function isDefiniteQueuedTurnsUnsupported(error: unknown): boolean {
+ const { status, code } = queuedTurnErrorResponse(error);
+ return (
+ (status === 404 && code == null) ||
+ (status === 501 &&
+ (code == null ||
+ code === 'QUEUED_TURNS_UNSUPPORTED' ||
+ code === 'QUEUED_TURN_PRIORITY_UNSUPPORTED'))
+ );
+}
+
+/** A bounded origin 4xx proves the queued row was not committed. Timeouts and
+ * early-data responses can be generated while the origin request continues,
+ * so those remain outcome-ambiguous and must reconcile by request identity. */
+export function isDefiniteQueuedTurnRejection(error: unknown): boolean {
+ const { status } = queuedTurnErrorResponse(error);
+ return (
+ !isDefiniteQueuedTurnsUnsupported(error) &&
+ typeof status === 'number' &&
+ status >= 400 &&
+ status < 500 &&
+ status !== 408 &&
+ status !== 425
+ );
+}
diff --git a/packages/chat/src/react.ts b/packages/chat/src/react.ts
index f7a7b74b85..b246378d02 100644
--- a/packages/chat/src/react.ts
+++ b/packages/chat/src/react.ts
@@ -66,3 +66,11 @@ export {
showStopButtonByIndex,
abortScrollFamily,
} from './react/generation';
+export { SteerHostProvider, setDefaultSteerHost, useSteerHost } from './react/steer/host';
+export type {
+ SteerHost,
+ SteerSettings,
+ SteerMessageKey,
+ SteerNotification,
+ SteerRequestCallbacks,
+} from './react/steer/host';
diff --git a/packages/chat/src/react/steer/__tests__/host.spec.tsx b/packages/chat/src/react/steer/__tests__/host.spec.tsx
new file mode 100644
index 0000000000..595abe235f
--- /dev/null
+++ b/packages/chat/src/react/steer/__tests__/host.spec.tsx
@@ -0,0 +1,46 @@
+/**
+ * @jest-environment jsdom
+ */
+import { renderHook } from '@testing-library/react';
+import type { ReactNode } from 'react';
+import type { SteerHost } from '../host';
+import { SteerHostProvider, setDefaultSteerHost, useSteerHost } from '../host';
+
+const createHost = (label: string): SteerHost => ({
+ useSteerMessage: () => () => undefined,
+ useCancelSteer: () => async () => ({ removed: true }),
+ useArmSteer: () => async () => ({ armed: true }),
+ useMarkFilesUsage: () => () => undefined,
+ useEnqueueQueuedTurn: () => () => undefined,
+ useCancelQueuedTurn: () => async () => {
+ throw new Error('not queued');
+ },
+ useQueuedTurns: () => undefined,
+ useFetchStreamStatus: () => async () => ({ active: false }),
+ useLatestMessage: () => null,
+ useCodeApprovalMode: () => undefined,
+ useLocalize: () => (key) => `${label}:${key}`,
+ useNotify: () => () => undefined,
+ useFileMap: () => undefined,
+ useClearFilesToDelete: () => () => undefined,
+ useSettings: () => ({ duringRunDefaultAction: 'steer', setDuringRunDefaultAction: () => {} }),
+});
+
+const translate = (host: SteerHost) => host.useLocalize()('com_ui_steer_cancel_failed');
+
+describe('useSteerHost', () => {
+ it('reads the host a provider supplies over the registered default', () => {
+ setDefaultSteerHost(createHost('default'));
+ const wrapper = ({ children }: { children: ReactNode }) => (
+ <SteerHostProvider host={createHost('provided')}>{children}</SteerHostProvider>
+ );
+ const { result } = renderHook(() => translate(useSteerHost()), { wrapper });
+ expect(result.current).toBe('provided:com_ui_steer_cancel_failed');
+ });
+
+ it('falls back to the registered default outside a provider', () => {
+ setDefaultSteerHost(createHost('default'));
+ const { result } = renderHook(() => translate(useSteerHost()));
+ expect(result.current).toBe('default:com_ui_steer_cancel_failed');
+ });
+});
diff --git a/packages/chat/src/react/steer/host.tsx b/packages/chat/src/react/steer/host.tsx
new file mode 100644
index 0000000000..125ca957b2
--- /dev/null
+++ b/packages/chat/src/react/steer/host.tsx
@@ -0,0 +1,134 @@
+import { createContext, useContext } from 'react';
+import type {
+ TMessage,
+ TConversation,
+ CodeApprovalMode,
+ CodeEnvironmentMode,
+ TAgentQueuedTurnReceipt,
+ TEnqueueAgentQueuedTurnRequest,
+} from 'librechat-data-provider';
+import type { ReactNode } from 'react';
+import type {
+ ChatSteerResult,
+ ChatSteerTarget,
+ DuringRunAction,
+ ChatSteerRequest,
+ ChatStreamStatus,
+ ChatArmSteerResult,
+ ChatTransportError,
+ ChatCancelSteerResult,
+} from '../../core/types';
+import type { FileDeliveryMetadataMap } from '../../core/files';
+
+/** Callbacks of a fire-and-forget request, called once it settles. */
+export type SteerRequestCallbacks<Result> = {
+ onSuccess?: (result: Result) => void;
+ onError?: (error: ChatTransportError) => void;
+};
+
+/** A toast the host shows on the steer surfaces' behalf. */
+export type SteerNotification = {
+ message: string;
+ status: 'error' | 'info' | 'success' | 'warning';
+};
+
+/** The copy the steer hooks show, by the key the host's catalogue holds it under. */
+export type SteerMessageKey =
+ | 'com_ui_steer_already_applied'
+ | 'com_ui_steer_arm_lost_race'
+ | 'com_ui_steer_arm_unconfirmed'
+ | 'com_ui_steer_cancel_failed'
+ | 'com_ui_steer_paused_queued'
+ | 'com_ui_steer_preempt_unsupported';
+
+/** The app-global preferences and deployment limits the steer hooks read. */
+export type SteerSettings = {
+ duringRunDefaultAction: DuringRunAction;
+ setDuringRunDefaultAction: (action: DuringRunAction) => void;
+ queuedSendLockTimeoutMs?: number;
+ queuedTurnReconciliationTimeoutMs?: number;
+ steerArmConfirmationTimeoutMs?: number;
+};
+
+/**
+ * What the steer and queue hooks need from the app that hosts them. Every member is a hook,
+ * called by a steer hook exactly where it needs the service, so the host can back each one with
+ * its own query cache, router or store without the package reaching into any of them.
+ */
+export interface SteerHost {
+ /** Posts a steer into the running generation. */
+ useSteerMessage(): (
+ request: ChatSteerRequest,
+ callbacks?: SteerRequestCallbacks<ChatSteerResult>,
+ ) => void;
+ /** Withdraws a steer that has not been injected yet. */
+ useCancelSteer(): (
+ request: ChatSteerTarget & { clientSteerId?: string },
+ ) => Promise<ChatCancelSteerResult>;
+ /** Escalates a queued steer to interrupt the running step. */
+ useArmSteer(): (request: ChatSteerTarget) => Promise<ChatArmSteerResult>;
+ /** Holds queued uploads past their upload window; failures are tolerated. */
+ useMarkFilesUsage(): (body: { file_ids: string[] }) => void;
+ /** Adds a durable queued turn behind the running one. */
+ useEnqueueQueuedTurn(): (
+ input: TEnqueueAgentQueuedTurnRequest,
+ callbacks?: SteerRequestCallbacks<TAgentQueuedTurnReceipt>,
+ ) => void;
+ /** Cancels a durable queued turn. */
+ useCancelQueuedTurn(): (input: {
+ conversationId: string;
+ queuedTurnId: string;
+ }) => Promise<TAgentQueuedTurnReceipt>;
+ /** The server's queued-turn receipts for a conversation, polled while any is unresolved. */
+ useQueuedTurns(
+ conversationId: string,
+ enabled: boolean,
+ clientRequestIds: string[],
+ reconcileUntil: number | undefined,
+ expectsReceipts: boolean,
+ ): TAgentQueuedTurnReceipt[] | undefined;
+ /** Reads a conversation's generation state, including steers it could not deliver. */
+ useFetchStreamStatus(): (conversationId: string) => Promise<ChatStreamStatus>;
+ /** The latest message of the pane, on the branch on screen. */
+ useLatestMessage(index: number, conversationId: string | null): TMessage | null;
+ /** The code approval mode a new turn would run under. */
+ useCodeApprovalMode(
+ conversation: TConversation | null,
+ addedConversation?: TConversation | null,
+ codeEnvironmentMode?: CodeEnvironmentMode,
+ ): CodeApprovalMode | undefined;
+ useLocalize(): (key: SteerMessageKey) => string;
+ useNotify(): (notification: SteerNotification) => void;
+ /** Delivery metadata of the files the user owns, by id. */
+ useFileMap(): FileDeliveryMetadataMap | undefined;
+ /** Drops the composer's pending file deletions once its attachments ride a message. */
+ useClearFilesToDelete(): () => void;
+ useSettings(): SteerSettings;
+}
+
+let defaultSteerHost: SteerHost | null = null;
+
+/** Registers the host used outside any `SteerHostProvider`, once at the app's entry. */
+export function setDefaultSteerHost(host: SteerHost): void {
+ defaultSteerHost = host;
+}
+
+const SteerHostContext = createContext<SteerHost | null>(null);
+
+export function SteerHostProvider({
+ host,
+ children,
+}: {
+ host: SteerHost;
+ children?: ReactNode;
+}): ReactNode {
+ return <SteerHostContext.Provider value={host}>{children}</SteerHostContext.Provider>;
+}
+
+export function useSteerHost(): SteerHost {
+ const host = useContext(SteerHostContext) ?? defaultSteerHost;
+ if (host == null) {
+ throw new Error('The steer hooks need a SteerHostProvider or a default steer host.');
+ }
+ return host;
+}