@assistant-ui/react/src/context/react/AssistantContext.ts

React components for AI chat.

"use client";

import { createContext } from "react";
import type { AssistantToolUIsState } from "../stores/AssistantToolUIs";
import { ReadonlyStore } from "../ReadonlyStore";
import { createContextHook } from "./utils/createContextHook";
import { createContextStoreHook } from "./utils/createContextStoreHook";
import { UseBoundStore } from "zustand";
import { AssistantRuntime } from "../../api/AssistantRuntime";
import { ThreadListState } from "../../api/ThreadListRuntime";

export type AssistantContextValue = {
  useToolUIs: UseBoundStore<ReadonlyStore<AssistantToolUIsState>>;
  useAssistantRuntime: UseBoundStore<ReadonlyStore<AssistantRuntime>>;
  useThreadList: UseBoundStore<ReadonlyStore<ThreadListState>>;

  /**
   * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
   */
  useAssistantActions: UseBoundStore<ReadonlyStore<AssistantRuntime>>;
};

export const AssistantContext = createContext<AssistantContextValue | null>(
  null,
);

export const useAssistantContext = createContextHook(
  AssistantContext,
  "AssistantRuntimeProvider",
);

export function useAssistantRuntime(options?: {
  optional?: false | undefined;
}): AssistantRuntime;
export function useAssistantRuntime(options?: {
  optional?: boolean | undefined;
}): AssistantRuntime | null;
export function useAssistantRuntime(options?: {
  optional?: boolean | undefined;
}) {
  const context = useAssistantContext(options);
  if (!context) return null;
  return context.useAssistantRuntime();
}

export const actions = createContextStoreHook(
  useAssistantContext,
  "useAssistantActions",
);

/**
 * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
 */
export const useAssistantActionsStore = actions.useAssistantActionsStore;

/**
 * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
 */
export const useAssistantActions = actions.useAssistantActions;

/**
 * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
 */
export const useAssistantRuntimeStore = useAssistantActionsStore;

export const { useToolUIs, useToolUIsStore } = createContextStoreHook(
  useAssistantContext,
  "useToolUIs",
);

export const { useThreadList } = createContextStoreHook(
  useAssistantContext,
  "useThreadList",
);