@apollo/client-ai-apps 0.1.1 → 0.2.1

package/.github/workflows/release.yaml

@@ -31,22 +31,22 @@ jobs:
               shell: bash
               run: npm run build
 
-            # - name: Test
-            #   shell: bash
-            #   run: npm run test
-
-            # - name: Configure Git
-            #   run: |
-            #       git config --global user.name GitHub Actions
-            #       git config user.email github-actions@github.com
-
-            # - uses: knope-dev/action@v2.1.0
-            #   with:
-            #       version: 0.21.5
-
-            # - run: knope release
-            #   env:
-            #       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - name: Test
+              shell: bash
+              run: npm run test
+
+            - name: Configure Git
+              run: |
+                  git config --global user.name GitHub Actions
+                  git config user.email github-actions@github.com
+
+            - uses: knope-dev/action@v2.1.0
+              with:
+                  version: 0.21.5
+
+            - run: knope release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
             - name: Publish to npm
               shell: bash

package/dist/hooks/useRequestDisplayMode.d.ts

@@ -1,4 +1,6 @@
 import { DisplayMode } from "../types/openai";
 export declare const useRequestDisplayMode: () => (args: {
     mode: DisplayMode;
-}) => Promise<void>;
+}) => Promise<{
+    mode: DisplayMode;
+}>;

package/dist/index.js

@@ -51,7 +51,7 @@ var useSendFollowUpMessage = () => {
 // src/hooks/useRequestDisplayMode.ts
 var useRequestDisplayMode = () => {
   return async (args) => {
-    await window.openai?.requestDisplayMode(args);
+    return await window.openai?.requestDisplayMode(args);
   };
 };
 

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/dist/vite/{operation_manifest_plugin.d.ts → application_manifest_plugin.d.ts}

@@ -1,6 +1,6 @@
 import { TypeNode, type DocumentNode } from "graphql";
 export declare function getTypeName(type: TypeNode): string;
-export declare const OperationManifestPlugin: () => {
+export declare const ApplicationManifestPlugin: () => {
     name: string;
     configResolved(resolvedConfig: any): Promise<void>;
     buildStart(): Promise<void>;

package/dist/vite/index.d.ts

@@ -1 +1 @@
-export * from "./operation_manifest_plugin";
+export * from "./application_manifest_plugin";

package/dist/vite/index.js

@@ -1,4 +1,4 @@
-// src/vite/operation_manifest_plugin.ts
+// src/vite/application_manifest_plugin.ts
 import { readFileSync, writeFileSync } from "fs";
 import { glob } from "glob";
 import { gqlPluckFromCodeStringSync } from "@graphql-tools/graphql-tag-pluck";
@@ -35,7 +35,7 @@ function getTypeName(type) {
   }
   return t.name.value;
 }
-var OperationManifestPlugin = () => {
+var ApplicationManifestPlugin = () => {
   const cache = /* @__PURE__ */ new Map();
   let packageJson = null;
   let config = null;
@@ -127,7 +127,11 @@ var OperationManifestPlugin = () => {
       description: packageJson.description,
       hash: createHash("sha256").update(Date.now().toString()).digest("hex"),
       operations: Array.from(cache.values()).flatMap((entry) => entry.operations),
-      resource
+      resource,
+      csp: {
+        connectDomains: packageJson.csp?.connectDomains ?? [],
+        resourceDomains: packageJson.csp?.resourceDomains ?? []
+      }
     };
     if (config.command === "build") {
       const dest = path.resolve(root, config.build.outDir, ".application-manifest.json");
@@ -204,7 +208,7 @@ function removeClientDirective(doc) {
   });
 }
 export {
-  OperationManifestPlugin,
+  ApplicationManifestPlugin,
   getTypeName,
   sortTopLevelDefinitions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client-ai-apps",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "publishConfig": {
     "access": "public"
   },
@@ -52,4 +52,4 @@
     "crypto-hash": "^4.0.0",
     "glob": "^11.0.3"
   }
-}
+}

package/src/hooks/useRequestDisplayMode.test.ts

@@ -0,0 +1,17 @@
+import { expect, test, vi } from "vitest";
+import { useRequestDisplayMode } from "./useRequestDisplayMode";
+import { DisplayMode } from "../types/openai";
+
+test("Should set display mode when returned function is called", async () => {
+  vi.stubGlobal("openai", {
+    requestDisplayMode: vi.fn(async (args: { mode: DisplayMode }) => {
+      return args;
+    }),
+  });
+
+  const requestDisplayMode = useRequestDisplayMode();
+  const result = await requestDisplayMode({ mode: "inline" });
+
+  expect(window.openai.requestDisplayMode).toBeCalledWith({ mode: "inline" });
+  expect(result).toEqual({ mode: "inline" });
+});

package/src/hooks/useRequestDisplayMode.ts

@@ -2,6 +2,6 @@ import { DisplayMode } from "../types/openai";
 
 export const useRequestDisplayMode = () => {
   return async (args: { mode: DisplayMode }) => {
-    await window.openai?.requestDisplayMode(args);
+    return await window.openai?.requestDisplayMode(args);
   };
 };

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[];
+};

package/src/vite/{operation_manifest_plugin.ts → application_manifest_plugin.ts}

@@ -46,7 +46,7 @@ export function getTypeName(type: TypeNode): string {
   return (t as NamedTypeNode).name.value;
 }
 
-export const OperationManifestPlugin = () => {
+export const ApplicationManifestPlugin = () => {
   const cache = new Map();
   let packageJson: any = null;
   let config: any = null;
@@ -166,6 +166,10 @@ export const OperationManifestPlugin = () => {
       hash: createHash("sha256").update(Date.now().toString()).digest("hex"),
       operations: Array.from(cache.values()).flatMap((entry) => entry.operations),
       resource,
+      csp: {
+        connectDomains: packageJson.csp?.connectDomains ?? [],
+        resourceDomains: packageJson.csp?.resourceDomains ?? [],
+      },
     };
 
     if (config.command === "build") {

package/src/vite/index.ts

@@ -1 +1 @@
-export * from "./operation_manifest_plugin";
+export * from "./application_manifest_plugin";