@apollo/client-ai-apps 0.4.0 → 0.5.0

package/src/core/__tests__/ApolloClient.test.ts

@@ -1,646 +0,0 @@
-import { expect, test, describe, vi } from "vitest";
-import { ApolloClient } from "../ApolloClient.js";
-import type { ApplicationManifest } from "../../types/application-manifest.js";
-import { parse } from "graphql";
-import { ApolloLink, HttpLink, InMemoryCache } from "@apollo/client";
-import { ToolCallLink } from "../../link/ToolCallLink.js";
-
-describe("Client Basics", () => {
-  test("Should execute tool call when client.query is called", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {},
-      toolOutput: {},
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-      callTool: vi.fn(async (name: string, args: Record<string, unknown>) => {
-        return {
-          structuredContent: {
-            data: {
-              product: {
-                id: "1",
-                title: "Pen",
-                rating: 5,
-                price: 1.0,
-                description: "Awesome pen",
-                images: [],
-                __typename: "Product",
-              },
-            },
-          },
-        };
-      }),
-    });
-
-    const manifest = {
-      format: "apollo-ai-app-manifest",
-      version: "1",
-      name: "the-store",
-      description:
-        "An online store selling a variety of high quality products across many different categories.",
-      hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-      operations: [
-        {
-          id: "c43af26552874026c3fb346148c5795896aa2f3a872410a0a2621cffee25291c",
-          name: "Product",
-          type: "query",
-          body: "query Product($id: ID!) {\n  product(id: $id) {\n    id\n    title\n    rating\n    price\n    description\n    images\n    __typename\n  }\n}",
-          variables: { id: "ID" },
-          prefetch: false,
-          tools: [
-            {
-              name: "Get Product",
-              description: "Shows the details page for a specific product.",
-            },
-          ],
-        },
-      ],
-      resource: "index.html",
-      csp: {
-        connectDomains: [],
-        resourceDomains: [],
-        frameDomains: [],
-        redirectDomains: [],
-      },
-    } satisfies ApplicationManifest;
-
-    const client = new ApolloClient({
-      cache: new InMemoryCache(),
-      manifest,
-    });
-
-    const variables = { id: "1" };
-    await client.query({
-      query: parse(manifest.operations[0].body),
-      variables,
-    });
-
-    expect(window.openai.callTool).toBeCalledWith("execute", {
-      query: manifest.operations[0].body,
-      variables,
-    });
-    expect(client.extract()).toMatchInlineSnapshot(`
-      {
-        "Product:1": {
-          "__typename": "Product",
-          "description": "Awesome pen",
-          "id": "1",
-          "images": [],
-          "price": 1,
-          "rating": 5,
-          "title": "Pen",
-        },
-        "ROOT_QUERY": {
-          "__typename": "Query",
-          "product({"id":"1"})": {
-            "__ref": "Product:1",
-          },
-        },
-      }
-    `);
-  });
-});
-
-describe("prefetchData", () => {
-  test("Should cache tool response when data is provided", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {
-        id: 1,
-      },
-      toolOutput: {
-        result: {
-          data: {
-            product: {
-              id: "1",
-              title: "Pen",
-              rating: 5,
-              price: 1.0,
-              description: "Awesome pen",
-              images: [],
-              __typename: "Product",
-            },
-          },
-        },
-      },
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-    });
-
-    const manifest = {
-      format: "apollo-ai-app-manifest",
-      version: "1",
-      name: "the-store",
-      description:
-        "An online store selling a variety of high quality products across many different categories.",
-      hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-      operations: [
-        {
-          id: "c43af26552874026c3fb346148c5795896aa2f3a872410a0a2621cffee25291c",
-          name: "Product",
-          type: "query",
-          body: "query Product($id: ID!) {\n  product(id: $id) {\n    id\n    title\n    rating\n    price\n    description\n    images\n    __typename\n  }\n}",
-          variables: { id: "ID" },
-          prefetch: false,
-          tools: [
-            {
-              name: "Get Product",
-              description: "Shows the details page for a specific product.",
-            },
-          ],
-        },
-      ],
-      resource: "index.html",
-      csp: {
-        connectDomains: [],
-        resourceDomains: [],
-        frameDomains: [],
-        redirectDomains: [],
-      },
-    } satisfies ApplicationManifest;
-
-    const client = new ApolloClient({
-      cache: new InMemoryCache(),
-      manifest,
-    });
-    await client.prefetchData();
-
-    expect(client.extract()).toMatchInlineSnapshot(`
-      {
-        "Product:1": {
-          "__typename": "Product",
-          "description": "Awesome pen",
-          "id": "1",
-          "images": [],
-          "price": 1,
-          "rating": 5,
-          "title": "Pen",
-        },
-        "ROOT_QUERY": {
-          "__typename": "Query",
-          "product({"id":1})": {
-            "__ref": "Product:1",
-          },
-        },
-      }
-    `);
-  });
-
-  test("Should cache prefetched data when prefetched data is provided", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {},
-      toolOutput: {
-        result: {},
-        prefetch: {
-          __anonymous: {
-            data: {
-              topProducts: [
-                {
-                  id: "2",
-                  title: "iPhone 17",
-                  rating: 5,
-                  price: 999.99,
-                  description: "Awesome phone",
-                  images: [],
-                  __typename: "Product",
-                },
-              ],
-            },
-          },
-        },
-      },
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-    });
-
-    const manifest = {
-      format: "apollo-ai-app-manifest",
-      version: "1",
-      name: "the-store",
-      description:
-        "An online store selling a variety of high quality products across many different categories.",
-      hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-      operations: [
-        {
-          id: "cd0d52159b9003e791de97c6a76efa03d34fe00cee278d1a3f4bfcec5fb3e1e6",
-          name: "TopProducts",
-          type: "query",
-          body: "query TopProducts {\n  topProducts {\n    id\n    title\n    rating\n    price\n    __typename\n  }\n}",
-          variables: {},
-          prefetch: true,
-          prefetchID: "__anonymous",
-          tools: [
-            {
-              name: "Top Products",
-              description: "Shows the currently highest rated products.",
-            },
-          ],
-        },
-      ],
-      resource: "index.html",
-    };
-
-    const client = new ApolloClient({
-      cache: new InMemoryCache(),
-      manifest: manifest as ApplicationManifest,
-    });
-    await client.prefetchData();
-
-    expect(client.extract()).toMatchInlineSnapshot(`
-      {
-        "Product:2": {
-          "__typename": "Product",
-          "id": "2",
-          "price": 999.99,
-          "rating": 5,
-          "title": "iPhone 17",
-        },
-        "ROOT_QUERY": {
-          "__typename": "Query",
-          "topProducts": [
-            {
-              "__ref": "Product:2",
-            },
-          ],
-        },
-      }
-    `);
-  });
-
-  test("Should cache both prefetch and tool response when both are provided", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {
-        id: 1,
-      },
-      toolOutput: {
-        result: {
-          data: {
-            product: {
-              id: "1",
-              title: "Pen",
-              rating: 5,
-              price: 1.0,
-              description: "Awesome pen",
-              images: [],
-              __typename: "Product",
-            },
-          },
-        },
-        prefetch: {
-          __anonymous: {
-            data: {
-              topProducts: [
-                {
-                  id: "2",
-                  title: "iPhone 17",
-                  rating: 5,
-                  price: 999.99,
-                  description: "Awesome phone",
-                  images: [],
-                  __typename: "Product",
-                },
-              ],
-            },
-          },
-        },
-      },
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-    });
-
-    const manifest = {
-      format: "apollo-ai-app-manifest",
-      version: "1",
-      name: "the-store",
-      description:
-        "An online store selling a variety of high quality products across many different categories.",
-      hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-      operations: [
-        {
-          id: "c43af26552874026c3fb346148c5795896aa2f3a872410a0a2621cffee25291c",
-          name: "Product",
-          type: "query",
-          body: "query Product($id: ID!) {\n  product(id: $id) {\n    id\n    title\n    rating\n    price\n    description\n    images\n    __typename\n  }\n}",
-          variables: { id: "ID" },
-          prefetch: false,
-          tools: [
-            {
-              name: "Get Product",
-              description: "Shows the details page for a specific product.",
-            },
-          ],
-        },
-        {
-          id: "cd0d52159b9003e791de97c6a76efa03d34fe00cee278d1a3f4bfcec5fb3e1e6",
-          name: "TopProducts",
-          type: "query",
-          body: "query TopProducts {\n  topProducts {\n    id\n    title\n    rating\n    price\n    __typename\n  }\n}",
-          variables: {},
-          prefetch: true,
-          prefetchID: "__anonymous",
-          tools: [
-            {
-              name: "Top Products",
-              description: "Shows the currently highest rated products.",
-            },
-          ],
-        },
-      ],
-      resource: "index.html",
-    };
-
-    const client = new ApolloClient({
-      cache: new InMemoryCache(),
-      manifest: manifest as ApplicationManifest,
-    });
-    await client.prefetchData();
-
-    expect(client.extract()).toMatchInlineSnapshot(`
-      {
-        "Product:1": {
-          "__typename": "Product",
-          "description": "Awesome pen",
-          "id": "1",
-          "images": [],
-          "price": 1,
-          "rating": 5,
-          "title": "Pen",
-        },
-        "Product:2": {
-          "__typename": "Product",
-          "id": "2",
-          "price": 999.99,
-          "rating": 5,
-          "title": "iPhone 17",
-        },
-        "ROOT_QUERY": {
-          "__typename": "Query",
-          "product({"id":1})": {
-            "__ref": "Product:1",
-          },
-          "topProducts": [
-            {
-              "__ref": "Product:2",
-            },
-          ],
-        },
-      }
-    `);
-  });
-
-  test("Should exclude extra inputs when writing to cache", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {
-        id: 1,
-        myOtherThing: 2,
-      },
-      toolOutput: {
-        result: {
-          data: {
-            product: {
-              id: "1",
-              title: "Pen",
-              rating: 5,
-              price: 1.0,
-              description: "Awesome pen",
-              images: [],
-              __typename: "Product",
-            },
-          },
-        },
-      },
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-    });
-
-    const manifest = {
-      format: "apollo-ai-app-manifest",
-      version: "1",
-      name: "the-store",
-      description:
-        "An online store selling a variety of high quality products across many different categories.",
-      hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-      operations: [
-        {
-          id: "c43af26552874026c3fb346148c5795896aa2f3a872410a0a2621cffee25291c",
-          name: "Product",
-          type: "query",
-          body: "query Product($id: ID!) {\n  product(id: $id) {\n    id\n    title\n    rating\n    price\n    description\n    images\n    __typename\n  }\n}",
-          variables: { id: "ID" },
-          prefetch: false,
-          tools: [
-            {
-              name: "Get Product",
-              description: "Shows the details page for a specific product.",
-            },
-          ],
-        },
-      ],
-      resource: "index.html",
-      csp: {
-        connectDomains: [],
-        resourceDomains: [],
-        frameDomains: [],
-        redirectDomains: [],
-      },
-    } satisfies ApplicationManifest;
-
-    const client = new ApolloClient({
-      cache: new InMemoryCache(),
-      manifest,
-    });
-    await client.prefetchData();
-
-    expect(client.extract()).toMatchInlineSnapshot(`
-      {
-        "Product:1": {
-          "__typename": "Product",
-          "description": "Awesome pen",
-          "id": "1",
-          "images": [],
-          "price": 1,
-          "rating": 5,
-          "title": "Pen",
-        },
-        "ROOT_QUERY": {
-          "__typename": "Query",
-          "product({"id":1})": {
-            "__ref": "Product:1",
-          },
-        },
-      }
-    `);
-  });
-});
-
-describe("custom links", () => {
-  test("allows for custom links provided to the constructor", async () => {
-    vi.stubGlobal("openai", {
-      toolInput: {},
-      toolOutput: {},
-      toolResponseMetadata: {
-        toolName: "the-store--Get Product",
-      },
-      callTool: vi.fn(async (name: string, args: Record<string, unknown>) => {
-        return {
-          structuredContent: {
-            data: {
-              product: {
-                id: "1",
-                title: "Pen",
-                rating: 5,
-                price: 1.0,
-                description: "Awesome pen",
-                images: [],
-                __typename: "Product",
-              },
-            },
-          },
-        };
-      }),
-    });
-
-    const manifest = createManifest();
-    const linkHandler = vi.fn<ApolloLink.RequestHandler>((operation, forward) =>
-      forward(operation)
-    );
-
-    const client = new ApolloClient({
-      manifest,
-      cache: new InMemoryCache(),
-      link: ApolloLink.from([new ApolloLink(linkHandler), new ToolCallLink()]),
-    });
-
-    const variables = { id: "1" };
-    const query = parse(manifest.operations[0].body);
-
-    await expect(client.query({ query, variables })).resolves.toStrictEqual({
-      data: {
-        product: {
-          id: "1",
-          title: "Pen",
-          rating: 5,
-          price: 1.0,
-          description: "Awesome pen",
-          images: [],
-          __typename: "Product",
-        },
-      },
-    });
-
-    expect(linkHandler).toHaveBeenCalledOnce();
-    expect(linkHandler).toHaveBeenCalledWith(
-      expect.objectContaining({ query, variables, operationType: "query" }),
-      expect.any(Function)
-    );
-  });
-
-  test("enforces ToolCallLink as terminating link", async () => {
-    const manifest = createManifest();
-    const expectedError = new Error(
-      "The terminating link must be a `ToolCallLink`. If you are using a `split` link, ensure the `right` branch uses a `ToolCallLink` as the terminating link."
-    );
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: new HttpLink(),
-      });
-    }).toThrow(expectedError);
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: new ApolloLink(),
-      });
-    }).toThrow(expectedError);
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: ApolloLink.from([new ApolloLink(), new HttpLink()]),
-      });
-    }).toThrow(expectedError);
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: ApolloLink.split(() => true, new ApolloLink(), new HttpLink()),
-      });
-    }).toThrow(expectedError);
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: ApolloLink.split(() => true, new ToolCallLink(), new HttpLink()),
-      });
-    }).toThrow(expectedError);
-
-    // Allow you to use a custom terminating link for `split` links if the
-    // custom link is the `left` branch link.
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: ApolloLink.split(() => true, new HttpLink(), new ToolCallLink()),
-      });
-    }).not.toThrow(expectedError);
-
-    expect(() => {
-      new ApolloClient({
-        manifest,
-        cache: new InMemoryCache(),
-        link: ApolloLink.split(
-          () => true,
-          new ToolCallLink(),
-          new ToolCallLink()
-        ),
-      });
-    }).not.toThrow();
-  });
-});
-
-function createManifest(
-  overrides?: Partial<ApplicationManifest>
-): ApplicationManifest {
-  return {
-    format: "apollo-ai-app-manifest",
-    version: "1",
-    name: "the-store",
-    description:
-      "An online store selling a variety of high quality products across many different categories.",
-    hash: "f6a24922f6ad6ed8c2aa57baf3b8242ae5f38a09a6df3f2693077732434c4256",
-    operations: [
-      {
-        id: "c43af26552874026c3fb346148c5795896aa2f3a872410a0a2621cffee25291c",
-        name: "Product",
-        type: "query",
-        body: "query Product($id: ID!) {\n  product(id: $id) {\n    id\n    title\n    rating\n    price\n    description\n    images\n    __typename\n  }\n}",
-        variables: { id: "ID" },
-        prefetch: false,
-        tools: [
-          {
-            name: "Get Product",
-            description: "Shows the details page for a specific product.",
-          },
-        ],
-      },
-    ],
-    resource: "index.html",
-    csp: {
-      resourceDomains: [],
-      connectDomains: [],
-      frameDomains: [],
-      redirectDomains: [],
-    },
-    ...overrides,
-  };
-}

package/src/react/__tests__/ApolloProvider.test.tsx

@@ -1,41 +0,0 @@
-import { expect, test, vi } from "vitest";
-import { ApolloProvider } from "../ApolloProvider.js";
-import { render } from "@testing-library/react";
-import { ApolloClient } from "../../core/ApolloClient.js";
-import { SET_GLOBALS_EVENT_TYPE } from "../../types/openai.js";
-
-test("Should call prefetch data when window.open is immediately available", () => {
-  vi.stubGlobal("openai", {
-    toolOutput: {},
-  });
-
-  const client = {
-    prefetchData: vi.fn(async () => {}),
-  } as unknown as ApolloClient;
-
-  render(<ApolloProvider client={client} />);
-
-  expect(client.prefetchData).toBeCalled();
-});
-
-test("Should NOT call prefetch data when window.open is not immediately available", () => {
-  const client = {
-    prefetchData: vi.fn(async () => {}),
-  } as unknown as ApolloClient;
-
-  render(<ApolloProvider client={client} />);
-
-  expect(client.prefetchData).not.toBeCalled();
-});
-
-test("Should call prefetch data when window.open is not immediately available and event is sent", () => {
-  const client = {
-    prefetchData: vi.fn(async () => {}),
-  } as unknown as ApolloClient;
-
-  render(<ApolloProvider client={client} />);
-
-  window.dispatchEvent(new CustomEvent(SET_GLOBALS_EVENT_TYPE));
-
-  expect(client.prefetchData).toBeCalled();
-});

package/src/react/context/ToolUseContext.tsx

@@ -1,31 +0,0 @@
-import type { ReactNode } from "react";
-import { createContext, useContext, useState } from "react";
-
-interface ToolUseState {
-  appName: string;
-  hasNavigated: boolean;
-  setHasNavigated: (v: boolean) => void;
-}
-
-const ToolUseContext = createContext<ToolUseState | null>(null);
-
-export declare namespace ToolUseProvider {
-  export interface Props {
-    children?: ReactNode;
-    appName: string;
-  }
-}
-
-export function ToolUseProvider({ children, appName }: ToolUseProvider.Props) {
-  const [hasNavigated, setHasNavigated] = useState(false);
-
-  return (
-    <ToolUseContext.Provider value={{ hasNavigated, setHasNavigated, appName }}>
-      {children}
-    </ToolUseContext.Provider>
-  );
-}
-
-export function useToolUseState() {
-  return useContext(ToolUseContext);
-}