@tanstack/ai-octane 0.5.4 → 0.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-octane",
-  "version": "0.5.4",
+  "version": "0.6.3",
   "description": "Octane bindings for TanStack AI streaming chat, structured outputs, and media generation.",
   "author": "Dominic Gannaway",
   "license": "MIT",
@@ -48,11 +48,11 @@
   ],
   "//lint": "The .tsrx.d.ts companions are generated declaration emits of the .tsrx implementations, so they are not hand-formatted and are excluded from lint rather than edited in place (a regeneration would undo any fix).",
   "dependencies": {
-    "@tanstack/ai-client": "0.34.0"
+    "@tanstack/ai-client": "0.36.0"
   },
   "peerDependencies": {
     "octane": "^0.1.17",
-    "@tanstack/ai": "^0.59.0"
+    "@tanstack/ai": "^0.63.0"
   },
   "devDependencies": {
     "@octanejs/testing-library": "0.1.14",
@@ -63,11 +63,12 @@
     "octane": "0.1.17",
     "vite": "^8.2.1",
     "zod": "^4.2.0",
-    "@tanstack/ai": "0.59.0"
+    "@tanstack/ai": "0.63.0"
   },
   "scripts": {
     "lint:fix": "oxlint src --type-aware --ignore-pattern '**/*.tsrx.d.ts' --fix",
     "test:oxlint": "oxlint src --type-aware --ignore-pattern '**/*.tsrx.d.ts'",
+    "test:coverage": "vitest run --coverage --coverage.include='src/**' --coverage.reporter=text-summary --coverage.reporter=json-summary",
     "test:lib": "vitest run",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc && tsc -p typetests/tsconfig.json"

package/src/index.ts

@@ -3,8 +3,16 @@ export { createChatHook } from './create-chat-hook'
 export { useRealtimeChat } from './use-realtime-chat.tsrx'
 export { useMcpAppBridge } from './use-mcp-app-bridge.tsrx'
 export type { UseMcpAppBridgeOptions } from './use-mcp-app-bridge.tsrx'
-export { useWebMCPTools } from './use-web-mcp-tools.tsrx'
-export type { UseWebMCPToolsOptions } from './use-web-mcp-tools.tsrx'
+export {
+  usePageWebMCPTools,
+  useRegisterWebMCPTools,
+  useWebMCPTools,
+} from './use-web-mcp-tools.tsrx'
+export type {
+  UsePageWebMCPToolsOptions,
+  UseRegisterWebMCPToolsOptions,
+  UseWebMCPToolsOptions,
+} from './use-web-mcp-tools.tsrx'
 export type {
   DeepPartial,
   UseChatOptions,
@@ -99,6 +107,11 @@ export {
   PartialJSONParser,
   defaultJSONParser,
   registerWebMCPTools,
+  getWebMCPTools,
+  subscribeWebMCPTools,
+  type GetWebMCPToolsOptions,
+  type SubscribeWebMCPToolsOptions,
+  type WebMCPPageTool,
   clientTools,
   webSocket,
   fetchServerSentEvents,

package/src/use-web-mcp-tools.tsrx

@@ -1,13 +1,14 @@
-import { useEffect } from 'octane'
-import { registerWebMCPTools } from '@tanstack/ai-client'
+import { useEffect, useRef, useState } from 'octane'
+import { registerWebMCPTools, subscribeWebMCPTools } from '@tanstack/ai-client'
 import type {
   AnyClientTool,
   InferredClientContext,
   RegisterWebMCPToolsOptions,
+  SubscribeWebMCPToolsOptions,
 } from '@tanstack/ai-client'
 
-/** Options for the Octane {@link useWebMCPTools} lifecycle hook. */
-export type UseWebMCPToolsOptions<
+/** Options for the Octane {@link useRegisterWebMCPTools} lifecycle hook. */
+export type UseRegisterWebMCPToolsOptions<
   TTools extends ReadonlyArray<AnyClientTool>,
   TContext = InferredClientContext<TTools>,
 > = Omit<RegisterWebMCPToolsOptions<TTools, TContext>, 'signal'> & {
@@ -15,12 +16,19 @@ export type UseWebMCPToolsOptions<
   onError?: (error: unknown) => void
 }
 
-type UseWebMCPToolsArguments<
+/** @deprecated Use `UseRegisterWebMCPToolsOptions`. Removed in 1.0.0. */
+export type UseWebMCPToolsOptions<
+  TTools extends ReadonlyArray<AnyClientTool>,
+  TContext = InferredClientContext<TTools>,
+> = UseRegisterWebMCPToolsOptions<TTools, TContext>
+
+type UseRegisterWebMCPToolsArguments<
   TTools extends ReadonlyArray<AnyClientTool>,
   TContext,
-> = RegisterWebMCPToolsOptions<TTools, TContext> extends { context: unknown }
-  ? [options: UseWebMCPToolsOptions<TTools, TContext>]
-  : [options?: UseWebMCPToolsOptions<TTools, TContext>]
+> =
+  RegisterWebMCPToolsOptions<TTools, TContext> extends { context: unknown }
+    ? [options: UseRegisterWebMCPToolsOptions<TTools, TContext>]
+    : [options?: UseRegisterWebMCPToolsOptions<TTools, TContext>]
 
 /**
  * Registers client tools with WebMCP for the lifetime of an Octane component.
@@ -33,17 +41,17 @@ type UseWebMCPToolsArguments<
  *
  * @example
  * ```tsx
- * useWebMCPTools([searchProducts], {
+ * useRegisterWebMCPTools([searchProducts], {
  *   toolOptions: { searchProducts: { title: 'Search products' } },
  * })
  * ```
  */
-export function useWebMCPTools<
+export function useRegisterWebMCPTools<
   const TTools extends ReadonlyArray<AnyClientTool>,
   TContext = InferredClientContext<TTools>,
 >(
   tools: TTools,
-  ...[options]: UseWebMCPToolsArguments<TTools, TContext>
+  ...[options]: UseRegisterWebMCPToolsArguments<TTools, TContext>
 ) {
   useEffect(() => {
     const controller = new AbortController()
@@ -59,3 +67,49 @@ export function useWebMCPTools<
     return () => controller.abort()
   }, [tools, options])
 }
+
+/** @deprecated Use `useRegisterWebMCPTools`. Removed in 1.0.0. */
+export const useWebMCPTools = useRegisterWebMCPTools
+
+/** Options for {@link usePageWebMCPTools}. */
+export type UsePageWebMCPToolsOptions = Omit<
+  SubscribeWebMCPToolsOptions,
+  'signal'
+>
+
+/**
+ * Returns the WebMCP tools on the page as client tools for `useChat`.
+ *
+ * The list starts empty and updates when the page registers or removes a
+ * tool. The hook reads the latest `filter` and `onError` on each update.
+ * Unsupported browsers and server rendering return an empty array.
+ *
+ * @param options - A filter that skips tools, and an error callback.
+ *
+ * @example
+ * ```tsx
+ * const pageTools = usePageWebMCPTools({
+ *   filter: (tool) => tool.origin === location.origin,
+ * })
+ * const chat = useChat({ connection, tools: pageTools })
+ * ```
+ */
+export function usePageWebMCPTools(
+  options?: UsePageWebMCPToolsOptions,
+): Array<AnyClientTool> {
+  const [tools, setTools] = useState<Array<AnyClientTool>>([])
+  const optionsRef = useRef(options)
+  optionsRef.current = options
+
+  useEffect(() => {
+    const controller = new AbortController()
+    subscribeWebMCPTools(setTools, {
+      signal: controller.signal,
+      filter: (tool) => optionsRef.current?.filter?.(tool) ?? true,
+      onError: (error) => optionsRef.current?.onError?.(error),
+    })
+    return () => controller.abort()
+  }, [])
+
+  return tools
+}

package/src/use-web-mcp-tools.tsrx.d.ts

@@ -3,23 +3,29 @@ import type {
   AnyClientTool,
   InferredClientContext,
   RegisterWebMCPToolsOptions,
+  SubscribeWebMCPToolsOptions,
 } from '@tanstack/ai-client'
 
-/** Options for the Octane {@link useWebMCPTools} lifecycle hook. */
-export type UseWebMCPToolsOptions<
+/** Options for the Octane {@link useRegisterWebMCPTools} lifecycle hook. */
+export type UseRegisterWebMCPToolsOptions<
   TTools extends ReadonlyArray<AnyClientTool>,
   TContext = InferredClientContext<TTools>,
 > = Omit<RegisterWebMCPToolsOptions<TTools, TContext>, 'signal'> & {
   /** Receives an asynchronous registration failure. */
   onError?: (error: unknown) => void
 }
-type UseWebMCPToolsArguments<
+/** @deprecated Use `UseRegisterWebMCPToolsOptions`. Removed in 1.0.0. */
+export type UseWebMCPToolsOptions<
+  TTools extends ReadonlyArray<AnyClientTool>,
+  TContext = InferredClientContext<TTools>,
+> = UseRegisterWebMCPToolsOptions<TTools, TContext>
+type UseRegisterWebMCPToolsArguments<
   TTools extends ReadonlyArray<AnyClientTool>,
   TContext,
 > =
   RegisterWebMCPToolsOptions<TTools, TContext> extends { context: unknown }
-    ? [options: UseWebMCPToolsOptions<TTools, TContext>]
-    : [options?: UseWebMCPToolsOptions<TTools, TContext>]
+    ? [options: UseRegisterWebMCPToolsOptions<TTools, TContext>]
+    : [options?: UseRegisterWebMCPToolsOptions<TTools, TContext>]
 /**
  * Registers client tools with WebMCP for the lifetime of an Octane component.
  *
@@ -31,12 +37,42 @@ type UseWebMCPToolsArguments<
  *
  * @example
  * ```tsx
- * useWebMCPTools([searchProducts], {
+ * useRegisterWebMCPTools([searchProducts], {
  *   toolOptions: { searchProducts: { title: 'Search products' } },
  * })
  * ```
  */
-export declare function useWebMCPTools<
+export declare function useRegisterWebMCPTools<
   const TTools extends ReadonlyArray<AnyClientTool>,
   TContext = InferredClientContext<TTools>,
->(tools: TTools, ...[options]: UseWebMCPToolsArguments<TTools, TContext>): void
+>(
+  tools: TTools,
+  ...[options]: UseRegisterWebMCPToolsArguments<TTools, TContext>
+): void
+/** @deprecated Use `useRegisterWebMCPTools`. Removed in 1.0.0. */
+export declare const useWebMCPTools: typeof useRegisterWebMCPTools
+/** Options for {@link usePageWebMCPTools}. */
+export type UsePageWebMCPToolsOptions = Omit<
+  SubscribeWebMCPToolsOptions,
+  'signal'
+>
+/**
+ * Returns the WebMCP tools on the page as client tools for `useChat`.
+ *
+ * The list starts empty and updates when the page registers or removes a
+ * tool. The hook reads the latest `filter` and `onError` on each update.
+ * Unsupported browsers and server rendering return an empty array.
+ *
+ * @param options - A filter that skips tools, and an error callback.
+ *
+ * @example
+ * ```tsx
+ * const pageTools = usePageWebMCPTools({
+ *   filter: (tool) => tool.origin === location.origin,
+ * })
+ * const chat = useChat({ connection, tools: pageTools })
+ * ```
+ */
+export declare function usePageWebMCPTools(
+  options?: UsePageWebMCPToolsOptions,
+): Array<AnyClientTool>