@apollo/client-ai-apps 0.2.0 → 0.2.1

package/dist/types/application-manifest.d.ts

@@ -6,13 +6,14 @@ export type ApplicationManifest = {
     hash: string;
     resource: string;
     operations: ManifestOperation[];
+    csp: ManifestCsp;
 };
 export type ManifestOperation = {
     id: string;
     name: string;
     type: "query" | "mutation";
     body: string;
-    variables: Record<string, string>;
+    variables?: Record<string, string | undefined>;
     prefetch: boolean;
     prefetchID?: string;
     tools: ManifestTool[];
@@ -27,3 +28,7 @@ export type ManifestExtraInput = {
     description: string;
     type: "string" | "boolean" | "number";
 };
+export type ManifestCsp = {
+    connectDomains: string[];
+    resourceDomains: string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client-ai-apps",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "publishConfig": {
     "access": "public"
   },

package/src/hooks/useSendFollowUpMessage.test.ts

@@ -0,0 +1,13 @@
+import { expect, test, vi } from "vitest";
+import { useSendFollowUpMessage } from "./useSendFollowUpMessage";
+
+test("Should set display mode when returned function is called", async () => {
+  vi.stubGlobal("openai", {
+    sendFollowUpMessage: vi.fn(async (args: { prompt: string }) => {}),
+  });
+
+  const sendFollowUpMessage = useSendFollowUpMessage();
+  await sendFollowUpMessage("Do a cool thing!");
+
+  expect(window.openai.sendFollowUpMessage).toBeCalledWith({ prompt: "Do a cool thing!" });
+});

package/src/hooks/useToolEffect.test.tsx

@@ -0,0 +1,50 @@
+import { expect, test, vi } from "vitest";
+import { useToolEffect, ToolUseProvider } from "./useToolEffect";
+import { renderHook } from "@testing-library/react";
+
+test("Should trigger effect when tool name matches toolResponseMetadata", async () => {
+  vi.stubGlobal("openai", {
+    toolResponseMetadata: { toolName: "my-app--my-tool" },
+  });
+  const navigate = vi.fn();
+  const wrapper = ({ children }: { children: any }) => <ToolUseProvider appName="my-app">{children}</ToolUseProvider>;
+
+  renderHook(() => useToolEffect("my-tool", () => navigate(), [navigate]), { wrapper });
+
+  expect(navigate).toBeCalled();
+});
+
+test("Should trigger effect when one of multiple tool name matches toolResponseMetadata", async () => {
+  vi.stubGlobal("openai", {
+    toolResponseMetadata: { toolName: "my-app--my-tool" },
+  });
+  const navigate = vi.fn();
+  const wrapper = ({ children }: { children: any }) => <ToolUseProvider appName="my-app">{children}</ToolUseProvider>;
+
+  renderHook(() => useToolEffect(["my-tool", "my-similar-tool"], () => navigate(), [navigate]), { wrapper });
+
+  expect(navigate).toBeCalled();
+});
+
+test("Should not trigger effect when tool name does not match toolResponseMetadata", async () => {
+  vi.stubGlobal("openai", {
+    toolResponseMetadata: { toolName: "my-app--my-other-tool" },
+  });
+  const navigate = vi.fn();
+  const wrapper = ({ children }: { children: any }) => <ToolUseProvider appName="my-app">{children}</ToolUseProvider>;
+
+  renderHook(() => useToolEffect("my-tool", () => navigate(), [navigate]), { wrapper });
+
+  expect(navigate).not.toBeCalled();
+});
+
+test("Should throw an error when used outside of a ToolUseProvider", async () => {
+  vi.stubGlobal("openai", {
+    toolResponseMetadata: { toolName: "my-app--my-other-tool" },
+  });
+  const navigate = vi.fn();
+
+  expect(() => renderHook(() => useToolEffect("my-tool", () => navigate(), [navigate]))).toThrowError(
+    "useToolEffect must be used within ToolUseProvider"
+  );
+});

package/src/types/application-manifest.ts

@@ -6,6 +6,7 @@ export type ApplicationManifest = {
   hash: string;
   resource: string;
   operations: ManifestOperation[];
+  csp: ManifestCsp;
 };
 
 export type ManifestOperation = {
@@ -13,7 +14,7 @@ export type ManifestOperation = {
   name: string;
   type: "query" | "mutation";
   body: string;
-  variables: Record<string, string>;
+  variables?: Record<string, string | undefined>;
   prefetch: boolean;
   prefetchID?: string;
   tools: ManifestTool[];
@@ -30,3 +31,8 @@ export type ManifestExtraInput = {
   description: string;
   type: "string" | "boolean" | "number";
 };
+
+export type ManifestCsp = {
+  connectDomains: string[];
+  resourceDomains: string[];
+};