@apollo/client-ai-apps 0.6.4 → 0.7.0

package/src/openai/react/hooks/__tests__/useToolInfo.test.tsx

@@ -1,92 +0,0 @@
-import { afterEach, expect, test, vi } from "vitest";
-import {
-  graphqlToolResult,
-  minimalHostContextWithToolName,
-  mockApplicationManifest,
-  mockMcpHost,
-  spyOnConsole,
-  stubOpenAiGlobals,
-} from "../../../../testing/internal/index.js";
-import {
-  disableActEnvironment,
-  renderHookToSnapshotStream,
-} from "@testing-library/react-render-stream";
-import { useToolInfo } from "../useToolInfo.js";
-import { ApolloClient } from "../../../core/ApolloClient.js";
-import { InMemoryCache } from "@apollo/client";
-import { Suspense } from "react";
-import { ApolloProvider } from "../../../../react/ApolloProvider.js";
-
-afterEach(() => {
-  vi.unstubAllGlobals();
-});
-
-test("returns tool name and input combined", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: {}, toolInput: { id: "1" } });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost({
-    hostContext: minimalHostContextWithToolName("GetProduct"),
-  });
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: { id: "1" } });
-  host.sendToolResult(graphqlToolResult({ data: { product: null } }));
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolInfo(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toEqual({
-    toolName: "GetProduct",
-    toolInput: { id: "1" },
-  });
-  await expect(takeSnapshot).not.toRerender();
-});
-
-test("returns undefined toolInput when toolInput is not provided", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: {} });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost({
-    hostContext: minimalHostContextWithToolName("GetProduct"),
-  });
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: {} });
-  host.sendToolResult(graphqlToolResult({ data: { product: null } }));
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolInfo(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toEqual({
-    toolName: "GetProduct",
-    toolInput: undefined,
-  });
-  await expect(takeSnapshot).not.toRerender();
-});

package/src/openai/react/hooks/__tests__/useToolInput.test.tsx

@@ -1,85 +0,0 @@
-import { afterEach, expect, test, vi } from "vitest";
-import {
-  mockApplicationManifest,
-  mockMcpHost,
-  spyOnConsole,
-  stubOpenAiGlobals,
-} from "../../../../testing/internal/index.js";
-import {
-  disableActEnvironment,
-  renderHookToSnapshotStream,
-} from "@testing-library/react-render-stream";
-import { useToolInput } from "../useToolInput.js";
-import { ApolloClient } from "../../../core/ApolloClient.js";
-import { InMemoryCache } from "@apollo/client";
-import { Suspense } from "react";
-import { ApolloProvider } from "../../../../react/ApolloProvider.js";
-
-afterEach(() => {
-  vi.unstubAllGlobals();
-});
-
-test("returns the tool input from the MCP host", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: {}, toolInput: { id: "1" } });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost();
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: { id: "1" } });
-  host.sendToolResult({
-    content: [],
-    structuredContent: {},
-  });
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolInput(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toEqual({ id: "1" });
-  await expect(takeSnapshot).not.toRerender();
-});
-
-test("returns undefined when ontoolinput is not fired", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: {} });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost();
-  host.onCleanup(() => client.stop());
-
-  host.sendToolResult({
-    content: [],
-    structuredContent: {},
-  });
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolInput(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toBeUndefined();
-  await expect(takeSnapshot).not.toRerender();
-});

package/src/openai/react/hooks/__tests__/useToolMetadata.test.tsx

@@ -1,86 +0,0 @@
-import { afterEach, expect, test, vi } from "vitest";
-import {
-  mockApplicationManifest,
-  mockMcpHost,
-  spyOnConsole,
-  stubOpenAiGlobals,
-} from "../../../../testing/internal/index.js";
-import {
-  disableActEnvironment,
-  renderHookToSnapshotStream,
-} from "@testing-library/react-render-stream";
-import { useToolMetadata } from "../useToolMetadata.js";
-import { ApolloClient } from "../../../core/ApolloClient.js";
-import { InMemoryCache } from "@apollo/client";
-import { Suspense } from "react";
-import { ApolloProvider } from "../../../../react/ApolloProvider.js";
-
-afterEach(() => {
-  vi.unstubAllGlobals();
-});
-
-test("returns the tool metadata from window.openai", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: { foo: true } });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost();
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: {} });
-  host.sendToolResult({
-    content: [],
-    structuredContent: {},
-  });
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolMetadata(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toEqual({ foo: true });
-  await expect(takeSnapshot).not.toRerender();
-});
-
-test("returns null when not set", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals();
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost();
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: {} });
-  host.sendToolResult({
-    content: [],
-    structuredContent: {},
-  });
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolMetadata(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toBeNull();
-  await expect(takeSnapshot).not.toRerender();
-});

package/src/openai/react/hooks/__tests__/useToolName.test.tsx

@@ -1,50 +0,0 @@
-import { expect, test } from "vitest";
-import { useToolName } from "../useToolName.js";
-import {
-  graphqlToolResult,
-  minimalHostContextWithToolName,
-  mockApplicationManifest,
-  mockMcpHost,
-  spyOnConsole,
-  stubOpenAiGlobals,
-} from "../../../../testing/internal/index.js";
-import { ApolloClient } from "../../../core/ApolloClient.js";
-import { InMemoryCache } from "@apollo/client";
-import {
-  disableActEnvironment,
-  renderHookToSnapshotStream,
-} from "@testing-library/react-render-stream";
-import { Suspense } from "react";
-import { ApolloProvider } from "../../../../react/ApolloProvider.js";
-
-test("returns the tool name from the MCP host", async () => {
-  using _ = spyOnConsole("debug");
-  stubOpenAiGlobals({ toolResponseMetadata: {} });
-  const client = new ApolloClient({
-    cache: new InMemoryCache(),
-    manifest: mockApplicationManifest(),
-  });
-
-  using host = await mockMcpHost({
-    hostContext: minimalHostContextWithToolName("GetProduct"),
-  });
-  host.onCleanup(() => client.stop());
-
-  host.sendToolInput({ arguments: {} });
-  host.sendToolResult(graphqlToolResult({ data: { product: null } }));
-
-  using _disabledAct = disableActEnvironment();
-  const { takeSnapshot } = await renderHookToSnapshotStream(
-    () => useToolName(),
-    {
-      wrapper: ({ children }) => (
-        <Suspense>
-          <ApolloProvider client={client}>{children}</ApolloProvider>
-        </Suspense>
-      ),
-    }
-  );
-
-  await expect(takeSnapshot()).resolves.toBe("GetProduct");
-  await expect(takeSnapshot).not.toRerender();
-});

package/src/openai/react/hooks/createHydrationUtils.ts

@@ -1,182 +0,0 @@
-import { useState, useCallback, useRef, useMemo, useLayoutEffect } from "react";
-import type {
-  DocumentNode,
-  OperationVariables,
-  TypedDocumentNode,
-} from "@apollo/client";
-import { useApolloClient } from "./useApolloClient.js";
-import { useToolName } from "./useToolName.js";
-import { isReactive } from "../../../react/reactive.js";
-import type { Reactive } from "../../../react/reactive.js";
-import { equal } from "@wry/equality";
-import { __DEV__ } from "@apollo/client/utilities/environment";
-import {
-  getToolNamesFromDocument,
-  getVariableNamesFromDocument,
-} from "../../../utilities/index.js";
-
-type HydratedVariablesInput<TVariables> = {
-  [K in keyof TVariables]: TVariables[K] | Reactive<TVariables[K]>;
-};
-
-type StateVariables<TVariables, Input> = {
-  [K in keyof TVariables as K extends keyof Input ?
-    Input[K] extends Reactive<any> ?
-      never
-    : K
-  : K]: K extends keyof TVariables ? TVariables[K] : never;
-};
-
-type SetVariables<TState> = (
-  update: Partial<TState> | ((prev: TState) => Partial<TState>)
-) => void;
-
-/** @experimental */
-export function createHydrationUtils<
-  TVariables extends OperationVariables = OperationVariables,
->(document: TypedDocumentNode<any, TVariables> | DocumentNode) {
-  const documentToolNames = getToolNamesFromDocument(document);
-  const variableNames = getVariableNamesFromDocument(document);
-
-  function useHydratedVariables<
-    TInputVariables extends HydratedVariablesInput<TVariables>,
-  >(
-    variables: TInputVariables &
-      Record<Exclude<keyof TInputVariables, keyof TVariables>, never>
-  ): [
-    variables: TVariables,
-    setVariables: SetVariables<StateVariables<TVariables, TInputVariables>>,
-  ] {
-    const client = useApolloClient();
-    const toolName = useToolName();
-    const [toolInput] = useState(() => client.toolInput);
-
-    const toolMatches =
-      toolInput !== undefined &&
-      toolName !== undefined &&
-      documentToolNames.has(toolName);
-
-    const [stateVars, setStateVars] = useState<Record<string, unknown>>(() => {
-      const values: Record<string, unknown> = {};
-
-      for (const [key, value] of Object.entries(
-        toolMatches ? toolInput : variables
-      )) {
-        if (variableNames.has(key) && !isReactive(value)) {
-          values[key] = value;
-        }
-      }
-
-      return values;
-    });
-
-    const [initialReactiveValues] = useState<Record<string, unknown>>(() => {
-      const values: Record<string, unknown> = {};
-
-      for (const [key, value] of Object.entries(variables)) {
-        if (variableNames.has(key) && isReactive(value)) {
-          values[key] = value.value;
-        }
-      }
-
-      return values;
-    });
-
-    const [reactiveVars, setReactiveVars] = useState(() => {
-      const values: Record<string, unknown> = {};
-
-      for (const [key, value] of Object.entries(initialReactiveValues)) {
-        if (toolMatches && key in toolInput) {
-          values[key] = toolInput[key];
-        } else if (!toolMatches) {
-          values[key] = value;
-        }
-      }
-
-      return values;
-    });
-
-    const changedKeysRef = useRef(new Set<string>());
-    const nextReactiveVars: Record<string, unknown> = {};
-
-    for (const [key, value] of Object.entries(variables)) {
-      if (!variableNames.has(key) || !isReactive(value)) continue;
-
-      const hasChanged =
-        changedKeysRef.current.has(key) ||
-        !equal(value.value, initialReactiveValues[key]);
-
-      if (toolMatches && !hasChanged) {
-        if (key in toolInput) {
-          nextReactiveVars[key] = toolInput[key];
-        }
-      } else {
-        nextReactiveVars[key] = value.value;
-      }
-    }
-
-    if (!equal(nextReactiveVars, reactiveVars)) {
-      setReactiveVars(nextReactiveVars);
-    }
-
-    // Clear the tool input after first mount so that remounting the component
-    // uses the user-provided variables rather than the hydrated tool input.
-    // This runs once on mount; watchQuery also clears it when useQuery is
-    // present, so both paths are idempotent.
-    useLayoutEffect(() => {
-      if (toolMatches) {
-        client.clearToolInput();
-      }
-      // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
-
-    useLayoutEffect(() => {
-      for (const [key, value] of Object.entries(variables)) {
-        if (
-          variableNames.has(key) &&
-          isReactive(value) &&
-          !changedKeysRef.current.has(key) &&
-          !equal(value.value, initialReactiveValues[key])
-        ) {
-          changedKeysRef.current.add(key);
-        }
-      }
-    });
-
-    const resolvedVariables = useMemo(() => {
-      return { ...stateVars, ...reactiveVars } as TVariables;
-    }, [stateVars, reactiveVars]);
-
-    const setVariables = useCallback<
-      SetVariables<StateVariables<TVariables, TInputVariables>>
-    >((update) => {
-      setStateVars((prev) => {
-        const updates =
-          typeof update === "function" ? update(prev as any) : update;
-
-        const filtered = Object.fromEntries(
-          Object.entries(updates).filter(([key]) => {
-            if (key in initialReactiveValues) {
-              if (__DEV__) {
-                console.warn(
-                  `Attempted to set reactive variable "${key}" via setVariables. ` +
-                    `Reactive variables are read-only and are ignored. `
-                );
-              }
-              return false;
-            }
-            return true;
-          })
-        );
-
-        if (Object.keys(filtered).length === 0) return prev;
-
-        return { ...prev, ...filtered };
-      });
-    }, []);
-
-    return [resolvedVariables, setVariables];
-  }
-
-  return { useHydratedVariables };
-}

package/src/openai/react/hooks/useApp.ts

@@ -1,5 +0,0 @@
-import { useApolloClient } from "./useApolloClient.js";
-
-export function useApp() {
-  return useApolloClient()["appManager"].app;
-}

package/src/openai/react/hooks/useToolInfo.ts

@@ -1,13 +0,0 @@
-import type { ToolInfo } from "../../../core/typeRegistration.js";
-import { useApolloClient } from "./useApolloClient.js";
-
-export function useToolInfo(): ToolInfo | undefined {
-  const appManager = useApolloClient()["appManager"];
-  const toolName = appManager.toolName;
-
-  if (!toolName) {
-    return;
-  }
-
-  return { toolName, toolInput: appManager.toolInput };
-}

package/src/openai/react/hooks/useToolInput.ts

@@ -1,10 +0,0 @@
-import type { ToolInput } from "../../../core/typeRegistration.js";
-import { useApolloClient } from "./useApolloClient.js";
-
-/**
- * @deprecated Please use the `useToolInfo` hook. `useToolInput` will be removed
- * in the next major version.
- */
-export function useToolInput(): ToolInput | undefined {
-  return useApolloClient()["appManager"].toolInput;
-}

package/src/openai/react/hooks/useToolMetadata.ts

@@ -1,5 +0,0 @@
-import { useApolloClient } from "./useApolloClient.js";
-
-export function useToolMetadata() {
-  return useApolloClient()["appManager"].toolMetadata;
-}

package/src/openai/react/hooks/useToolName.ts

@@ -1,10 +0,0 @@
-import type { ToolName } from "../../../core/typeRegistration.js";
-import { useApolloClient } from "./useApolloClient.js";
-
-/**
- * @deprecated Please use the `useToolInfo` hook. `useToolName` will be removed
- * in the next major version.
- */
-export const useToolName = (): ToolName | undefined => {
-  return useApolloClient()["appManager"].toolName;
-};

package/src/react/index.mcp.ts

@@ -1,10 +0,0 @@
-export * from "./index.js";
-export {
-  useApp,
-  useHostContext,
-  useToolInput,
-  useToolInfo,
-  createHydrationUtils,
-  useToolMetadata,
-  useToolName,
-} from "../mcp/react/index.js";

package/src/react/index.openai.ts

@@ -1,10 +0,0 @@
-export * from "./index.js";
-export {
-  useApp,
-  useHostContext,
-  useToolInput,
-  useToolInfo,
-  createHydrationUtils,
-  useToolMetadata,
-  useToolName,
-} from "../openai/react/index.js";

package/src/react/missingHook.ts

@@ -1,9 +0,0 @@
-export function missingHook<HookFn extends (...args: any[]) => any>(
-  name: string
-) {
-  return (() => {
-    throw new Error(
-      `Cannot use the '${name}' hook without export conditions. Please set export conditions or import from the \`/openai\` or \`/mcp\` subpath directly.`
-    );
-  }) as unknown as HookFn;
-}