skybridge 0.0.0-dev.f76ccdc → 0.0.0-dev.fc2f516

package/dist/src/web/hooks/use-call-tool.d.ts

@@ -1,10 +1,64 @@
-import type { CallToolArgs, CallToolResponse } from "../types.js";
-export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string) => {
-    callTool: (toolArgs: ToolArgs, sideEffects?: {
-        onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
-        onError?: (error: unknown, toolArgs: ToolArgs) => void;
-    }) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
+import type { CallToolArgs, CallToolResponse, HasRequiredKeys } from "../types.js";
+type CallToolIdleState = {
+    status: "idle";
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    isError: false;
+    data: undefined;
+    error: undefined;
+};
+type CallToolPendingState = {
+    status: "pending";
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    isError: false;
+    data: undefined;
+    error: undefined;
+};
+type CallToolSuccessState<TData extends CallToolResponse = CallToolResponse> = {
+    status: "success";
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    isError: false;
+    data: TData;
+    error: undefined;
+};
+type CallToolErrorState = {
+    status: "error";
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    isError: true;
+    data: undefined;
+    error: unknown;
+};
+export type CallToolState<TData extends CallToolResponse = CallToolResponse> = CallToolIdleState | CallToolPendingState | CallToolSuccessState<TData> | CallToolErrorState;
+export type SideEffects<ToolArgs, ToolResponse> = {
+    onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
+    onError?: (error: unknown, toolArgs: ToolArgs) => void;
+    onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
+};
+type IsArgsOptional<T> = [T] extends [null] ? true : HasRequiredKeys<T> extends false ? true : false;
+export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
+    (): void;
+    (sideEffects: SideEffects<TArgs, TResponse>): void;
+    (args: TArgs): void;
+    (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
+} : {
+    (args: TArgs): void;
+    (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
+};
+export type CallToolAsyncFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
+    (): Promise<TResponse>;
+    (args: TArgs): Promise<TResponse>;
+} : (args: TArgs) => Promise<TResponse>;
+type ToolResponseSignature = Pick<CallToolResponse, "structuredContent" | "meta">;
+export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = {}>(name: string) => {
+    callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
+    callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
     status: "idle";
     isIdle: true;
     isPending: false;
@@ -13,11 +67,8 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
     data: undefined;
     error: undefined;
 } | {
-    callTool: (toolArgs: ToolArgs, sideEffects?: {
-        onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
-        onError?: (error: unknown, toolArgs: ToolArgs) => void;
-    }) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
+    callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
+    callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
     status: "pending";
     isIdle: false;
     isPending: true;
@@ -26,11 +77,8 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
     data: undefined;
     error: undefined;
 } | {
-    callTool: (toolArgs: ToolArgs, sideEffects?: {
-        onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
-        onError?: (error: unknown, toolArgs: ToolArgs) => void;
-    }) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
+    callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
+    callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
     status: "error";
     isIdle: false;
     isPending: false;
@@ -39,16 +87,14 @@ export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolRes
     data: undefined;
     error: unknown;
 } | {
-    callTool: (toolArgs: ToolArgs, sideEffects?: {
-        onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
-        onError?: (error: unknown, toolArgs: ToolArgs) => void;
-    }) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse>;
+    callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
+    callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
     status: "success";
     isIdle: false;
     isPending: false;
     isSuccess: true;
     isError: false;
-    data: ToolResponse;
+    data: CallToolResponse & ToolResponse;
     error: undefined;
 };
+export {};

package/dist/src/web/hooks/use-call-tool.js

@@ -1,7 +1,7 @@
 import { useState } from "react";
 export const useCallTool = (name) => {
     const [{ status, data, error }, setCallToolState] = useState({ status: "idle", data: undefined, error: undefined });
-    const callToolAsync = async (toolArgs) => {
+    const execute = async (toolArgs) => {
         setCallToolState({ status: "pending", data: undefined, error: undefined });
         try {
             const data = await window.openai.callTool(name, toolArgs);
@@ -13,19 +13,35 @@ export const useCallTool = (name) => {
             throw error;
         }
     };
-    const callTool = (toolArgs, sideEffects) => {
-        callToolAsync(toolArgs)
+    const callToolAsync = ((toolArgs) => {
+        if (toolArgs === undefined) {
+            return execute(null);
+        }
+        return execute(toolArgs);
+    });
+    const callTool = ((firstArg, sideEffects) => {
+        let toolArgs;
+        if (firstArg &&
+            typeof firstArg === "object" &&
+            ("onSuccess" in firstArg ||
+                "onError" in firstArg ||
+                "onSettled" in firstArg)) {
+            toolArgs = null; // no toolArgs provided
+            sideEffects = firstArg;
+        }
+        else {
+            toolArgs = (firstArg === undefined ? null : firstArg);
+        }
+        execute(toolArgs)
             .then((data) => {
-            if (sideEffects?.onSuccess) {
-                sideEffects.onSuccess(data, toolArgs);
-            }
+            sideEffects?.onSuccess?.(data, toolArgs);
+            sideEffects?.onSettled?.(data, undefined, toolArgs);
         })
             .catch((error) => {
-            if (sideEffects?.onError) {
-                sideEffects.onError(error, toolArgs);
-            }
+            sideEffects?.onError?.(error, toolArgs);
+            sideEffects?.onSettled?.(undefined, error, toolArgs);
         });
-    };
+    });
     const callToolState = {
         status,
         data,

package/dist/src/web/hooks/use-call-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA4BjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,aAAa,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;QACjD,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CACvC,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CACf,QAAkB,EAClB,WAGC,EACD,EAAE;QACF,aAAa,CAAC,QAAQ,CAAC;aACpB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,WAAW,EAAE,OAAO,EAAE,CAAC;gBACzB,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACG,CAAC;IAEjC,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA0FjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IAGF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,OAAO,GAAG,KAAK,EACnB,QAAkB,EACiB,EAAE;QACrC,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAGvC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClB,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAC,QAAmB,EAAE,EAAE;QAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,CAAwD,CAAC;IAE1D,MAAM,QAAQ,GAAG,CAAC,CAChB,QAAqE,EACrE,WAA6D,EAC7D,EAAE;QACF,IAAI,QAAkB,CAAC;QACvB,IACE,QAAQ;YACR,OAAO,QAAQ,KAAK,QAAQ;YAC5B,CAAC,WAAW,IAAI,QAAQ;gBACtB,SAAS,IAAI,QAAQ;gBACrB,WAAW,IAAI,QAAQ,CAAC,EAC1B,CAAC;YACD,QAAQ,GAAG,IAAgB,CAAC,CAAC,uBAAuB;YACpD,WAAW,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QACpE,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC;aACd,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACzC,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,WAAW,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACxC,WAAW,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC,CAAmD,CAAC;IAErD,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACe,CAAC;IAE7C,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}

package/dist/src/web/hooks/use-call-tool.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/web/hooks/use-call-tool.test-d.js

@@ -0,0 +1,104 @@
+import { expectTypeOf, test } from "vitest";
+import { useCallTool } from "./use-call-tool.js";
+test("callTool can be called without args when ToolArgs is null", () => {
+    const { callTool, callToolAsync } = useCallTool("test-tool");
+    callTool();
+    callTool({ onSuccess: () => { } });
+    callToolAsync();
+});
+test("callTool requires args when ToolArgs has required properties", () => {
+    const { callTool, callToolAsync } = useCallTool("test-tool");
+    // @ts-expect-error - query is required
+    callTool();
+    callTool({ query: "test" });
+    callTool({ query: "test" }, { onSuccess: () => { } });
+    // @ts-expect-error - query is required
+    callToolAsync();
+    callToolAsync({ query: "test" });
+});
+test("callTool supports sideEffects with correct types", () => {
+    const { callTool } = useCallTool("test-tool");
+    callTool({ id: 1 }, {
+        onSuccess: (data, args) => {
+            expectTypeOf(data.structuredContent.result).toBeString();
+            expectTypeOf(args.id).toBeNumber();
+        },
+        onError: (error, args) => {
+            expectTypeOf(error).toBeUnknown();
+            expectTypeOf(args.id).toBeNumber();
+        },
+        onSettled: (data, error, args) => {
+            if (data) {
+                expectTypeOf(data.structuredContent.result).toBeString();
+            }
+            expectTypeOf(error).toEqualTypeOf();
+            expectTypeOf(args.id).toBeNumber();
+        },
+    });
+});
+test("callTool allows sideEffects as first arg when ToolArgs is null", () => {
+    const { callTool } = useCallTool("test-tool");
+    callTool({
+        onSuccess: (data) => {
+            expectTypeOf(data.structuredContent.value).toBeNumber();
+        },
+    });
+});
+test("callToolAsync returns correctly typed promise", () => {
+    const { callToolAsync } = useCallTool("test-tool");
+    const promise = callToolAsync({ name: "test" });
+    expectTypeOf(promise).resolves.toHaveProperty("structuredContent");
+    expectTypeOf(promise).resolves.toHaveProperty("meta");
+});
+test("state narrowing works correctly with status", () => {
+    const result = useCallTool("test-tool");
+    if (result.status === "idle") {
+        expectTypeOf(result.isIdle).toEqualTypeOf();
+        expectTypeOf(result.data).toEqualTypeOf();
+    }
+    if (result.status === "pending") {
+        expectTypeOf(result.isPending).toEqualTypeOf();
+        expectTypeOf(result.data).toEqualTypeOf();
+    }
+    if (result.status === "success") {
+        expectTypeOf(result.isSuccess).toEqualTypeOf();
+        expectTypeOf(result.data).not.toEqualTypeOf();
+        expectTypeOf(result.data.structuredContent.data).toBeString();
+    }
+    if (result.status === "error") {
+        expectTypeOf(result.isError).toEqualTypeOf();
+        expectTypeOf(result.error).toBeUnknown();
+    }
+});
+test("state narrowing works correctly with boolean flags", () => {
+    const result = useCallTool("test-tool");
+    if (result.isIdle) {
+        expectTypeOf(result.status).toEqualTypeOf();
+    }
+    if (result.isPending) {
+        expectTypeOf(result.status).toEqualTypeOf();
+    }
+    if (result.isSuccess) {
+        expectTypeOf(result.status).toEqualTypeOf();
+        expectTypeOf(result.data.structuredContent.items).toBeArray();
+    }
+    if (result.isError) {
+        expectTypeOf(result.status).toEqualTypeOf();
+    }
+});
+test("CallToolState type is correctly exported and usable", () => {
+    const state = {};
+    if (state.status === "success") {
+        expectTypeOf(state.data.structuredContent.foo).toBeString();
+    }
+});
+test("SideEffects type is correctly exported and usable", () => {
+    const sideEffects = {
+        onSuccess: (data, args) => {
+            expectTypeOf(data.structuredContent.y).toBeString();
+            expectTypeOf(args.x).toBeNumber();
+        },
+    };
+    expectTypeOf(sideEffects).toHaveProperty("onSuccess");
+});
+//# sourceMappingURL=use-call-tool.test-d.js.map

package/dist/src/web/hooks/use-call-tool.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-call-tool.test-d.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAwC,MAAM,oBAAoB,CAAC;AAGvF,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACrE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IACnE,QAAQ,EAAE,CAAC;IACX,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAClC,aAAa,EAAE,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IAExE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IAEnE,uCAAuC;IACvC,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAErD,uCAAuC;IACvC,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;IAI5D,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;QAClB,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,IAAI,IAAI,EAAE,CAAC;gBACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YAC3D,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,aAAa,EAAuB,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;IAE1E,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAClB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1D,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IAIzD,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAEhD,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IACnE,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;IAEvD,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAQ,CAAC;QAClD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,aAAa,EAAa,CAAC;QACzD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAC9B,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAQ,CAAC;QACnD,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;IAE9D,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAU,CAAC;IACtD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;IACzD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;QACvD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAW,CAAC;IACvD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;IAI/D,MAAM,KAAK,GAAY,EAAa,CAAC;IAErC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAI7D,MAAM,WAAW,GAAgC;QAC/C,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YACpD,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACpC,CAAC;KACF,CAAC;IAEF,YAAY,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC"}

package/dist/src/web/hooks/use-call-tool.test.js

@@ -1,6 +1,6 @@
+import { act, renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi, expectTypeOf, } from "vitest";
 import { useCallTool } from "./use-call-tool.js";
-import { describe, it, expect, vi, beforeEach, afterEach, } from "vitest";
-import { renderHook, act, waitFor } from "@testing-library/react";
 describe("useCallTool - onSuccess callback", () => {
     let OpenaiMock;
     beforeEach(() => {
@@ -25,7 +25,7 @@ describe("useCallTool - onSuccess callback", () => {
     const error = new Error("test error");
     it("should call window.openai.callTool with correct arguments", async () => {
         const { result } = renderHook(() => useCallTool(toolName));
-        act(() => {
+        await act(async () => {
             result.current.callTool(args);
         });
         expect(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);
@@ -62,5 +62,110 @@ describe("useCallTool - onSuccess callback", () => {
             expect(onError).toHaveBeenCalledWith(error, args);
         });
     });
+    it("should call onSettled callback with data and undefined error on successful execution", async () => {
+        const onSuccess = vi.fn();
+        const onError = vi.fn();
+        const onSettled = vi.fn();
+        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        const { result } = renderHook(() => useCallTool(toolName));
+        act(() => {
+            result.current.callTool(args, {
+                onSuccess,
+                onError,
+                onSettled,
+            });
+        });
+        await waitFor(() => {
+            expect(onSuccess).toHaveBeenCalledWith(data, args);
+            expect(onSettled).toHaveBeenCalledWith(data, undefined, args);
+            expect(onError).not.toHaveBeenCalled();
+        });
+    });
+    it("should call onSettled callback with undefined data and error on failed execution", async () => {
+        const onSuccess = vi.fn();
+        const onError = vi.fn();
+        const onSettled = vi.fn();
+        OpenaiMock.callTool.mockRejectedValueOnce(error);
+        const { result } = renderHook(() => useCallTool(toolName));
+        act(() => {
+            result.current.callTool(args, {
+                onSuccess,
+                onError,
+                onSettled,
+            });
+        });
+        await waitFor(() => {
+            expect(onError).toHaveBeenCalledWith(error, args);
+            expect(onSettled).toHaveBeenCalledWith(undefined, error, args);
+            expect(onSuccess).not.toHaveBeenCalled();
+        });
+    });
+});
+describe("useCallTool - TypeScript typing", () => {
+    let OpenaiMock;
+    beforeEach(() => {
+        OpenaiMock = {
+            callTool: vi.fn(),
+        };
+        vi.stubGlobal("openai", OpenaiMock);
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        vi.resetAllMocks();
+    });
+    it("should have correct return types when ToolArgs is null and ToolResponse is specified", async () => {
+        const { result } = renderHook(() => useCallTool("test-tool"));
+        const data = {
+            content: [{ type: "text", text: "test" }],
+            structuredContent: { result: "test" },
+            isError: false,
+            result: "test",
+            meta: { id: 123 },
+        };
+        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        await act(async () => {
+            result.current.callTool();
+        });
+        expect(OpenaiMock.callTool).toHaveBeenCalledWith("test-tool", null);
+        expectTypeOf(result.current.data);
+    });
+    it("should correctly type callToolAsync return value", async () => {
+        const { result } = renderHook(() => useCallTool("test-tool"));
+        const testArgs = { query: "test" };
+        const mockResponse = {
+            content: [{ type: "text", text: "answer" }],
+            structuredContent: { answer: "test answer" },
+            isError: false,
+            result: "answer",
+            meta: {},
+        };
+        OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
+        let promise;
+        let resolvedValue;
+        await act(async () => {
+            promise = result.current.callToolAsync(testArgs);
+            expectTypeOf(promise);
+            resolvedValue = await promise;
+        });
+        expect(resolvedValue).toEqual(mockResponse);
+    });
+    it("should correctly type callToolAsync when ToolArgs is null", async () => {
+        const { result } = renderHook(() => useCallTool("test-tool"));
+        const mockResponse = {
+            content: [{ type: "text", text: "data" }],
+            structuredContent: { data: "test data" },
+            isError: false,
+            result: "data",
+        };
+        OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
+        let promise;
+        let resolvedValue;
+        await act(async () => {
+            promise = result.current.callToolAsync();
+            expectTypeOf(promise);
+            resolvedValue = await promise;
+        });
+        expect(resolvedValue).toEqual(mockResponse);
+    });
 });
 //# sourceMappingURL=use-call-tool.test.js.map

package/dist/src/web/hooks/use-call-tool.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAElE,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EACF,EAAE,EAEF,YAAY,GACb,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QACpG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/D,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QAMpG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QACF,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YACrC,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE;SAClB,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEhD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACpE,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAMhE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAyB,WAAW,CAAC,CACjD,CAAC;QAEF,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,YAAY,GAAG;YACnB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;YAC5C,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,IAAI,OAAqC,CAAC;QAC1C,IAAI,aAAkC,CAAC;QACvC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACjD,YAAY,CAA+B,OAAO,CAAC,CAAC;YACpD,aAAa,GAAG,MAAM,OAAO,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,aAAc,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAKzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QAEF,MAAM,YAAY,GAId;YACF,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,MAAM;SACf,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,IAAI,OAAqC,CAAC;QAC1C,IAAI,aAAkC,CAAC;QACvC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YACzC,YAAY,CAA+B,OAAO,CAAC,CAAC;YACpD,aAAa,GAAG,MAAM,OAAO,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,aAAc,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/web/hooks/use-files.d.ts

@@ -0,0 +1,10 @@
+export declare function useFiles(): {
+    upload: (file: File) => Promise<{
+        fileId: string;
+    }>;
+    download: (file: {
+        fileId: string;
+    }) => Promise<{
+        downloadUrl: string;
+    }>;
+};

package/dist/src/web/hooks/use-files.js

@@ -0,0 +1,7 @@
+export function useFiles() {
+    return {
+        upload: window.openai.uploadFile,
+        download: window.openai.downloadFile,
+    };
+}
+//# sourceMappingURL=use-files.js.map

package/dist/src/web/hooks/use-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,QAAQ;IACtB,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU;QAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY;KACrC,CAAC;AACJ,CAAC"}

package/dist/src/web/hooks/use-files.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/web/hooks/use-files.test.js

@@ -0,0 +1,29 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { renderHook } from "@testing-library/react";
+import { useFiles } from "./use-files.js";
+describe("useLocale", () => {
+    const OpenaiMock = {
+        uploadFile: vi.fn(),
+        downloadFile: vi.fn(),
+    };
+    beforeEach(() => {
+        vi.stubGlobal("openai", OpenaiMock);
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        vi.resetAllMocks();
+    });
+    const dummyFile = new File([], "test.txt");
+    it("should upload a file to ChatGPT", () => {
+        const { result } = renderHook(() => useFiles());
+        result.current.upload(dummyFile);
+        expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile);
+    });
+    it("should download a file from ChatGPT", () => {
+        const fileId = "123";
+        const { result } = renderHook(() => useFiles());
+        result.current.download({ fileId });
+        expect(OpenaiMock.downloadFile).toHaveBeenCalledWith({ fileId });
+    });
+});
+//# sourceMappingURL=use-files.test.js.map

package/dist/src/web/hooks/use-files.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-files.test.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,UAAU,GAAG;QACjB,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE;QACnB,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE;KACtB,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAE3C,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACpC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/web/hooks/use-openai-global.js

@@ -1,13 +1,15 @@
 import { useSyncExternalStore } from "react";
 import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
 export function useOpenAiGlobal(key) {
+    if (!window.openai) {
+        console.warn("openai is not defined on window. Please make sure to only call this hook inside the OpenAI iFrame skybridge runtime.");
+    }
     return useSyncExternalStore((onChange) => {
         const handleSetGlobal = (event) => {
             const value = event.detail.globals[key];
             if (value === undefined) {
                 return;
             }
-            console.dir(event.detail.globals, { depth: Infinity });
             onChange();
         };
         window.addEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal, {

package/dist/src/web/hooks/use-openai-global.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EACL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,UAAU,eAAe,CAC7B,GAAM;IAEN,OAAO,oBAAoB,CACzB,CAAC,QAAQ,EAAE,EAAE;QACX,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;YACjD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvD,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,eAAe,EAAE;YAC/D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;QACtE,CAAC,CAAC;IACJ,CAAC,EACD,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAC3B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EACL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,UAAU,eAAe,CAC7B,GAAM;IAEN,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CACV,sHAAsH,CACvH,CAAC;IACJ,CAAC;IAED,OAAO,oBAAoB,CACzB,CAAC,QAAQ,EAAE,EAAE;QACX,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;YACjD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YAED,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,eAAe,EAAE;YAC/D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;QACtE,CAAC,CAAC;IACJ,CAAC,EACD,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAC3B,CAAC;AACJ,CAAC"}

package/dist/src/web/hooks/use-request-modal.d.ts

@@ -1,5 +1,6 @@
-import type { RequestModalOptions } from "../types.js";
 /**
  * Triggers a modal containing the widget rendered in display mode "modal"
  */
-export declare function useRequestModal(): (options: RequestModalOptions) => void;
+export declare function useRequestModal(): (options: {
+    title: string;
+}) => void;

package/dist/src/web/hooks/use-request-modal.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-request-modal.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-request-modal.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,CAAC,OAA4B,EAAE,EAAE;QACtC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"use-request-modal.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-request-modal.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,CAAC,OAA0B,EAAE,EAAE;QACpC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/web/hooks/use-tool-info.d.ts

@@ -1,5 +1,25 @@
-export declare function useToolInfo(): {
-    output: import("skybridge/web").UnknownObject | null | undefined;
-    input: import("skybridge/web").UnknownObject | undefined;
-    responseMetadata: import("skybridge/web").UnknownObject | null | undefined;
+import type { UnknownObject } from "../types.js";
+export type ToolPendingState<ToolInput extends UnknownObject> = {
+    status: "pending";
+    isPending: true;
+    isSuccess: false;
+    input: ToolInput;
+    output: undefined;
+    responseMetadata: undefined;
 };
+export type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
+    status: "success";
+    isPending: false;
+    isSuccess: true;
+    input: ToolInput;
+    output: ToolOutput;
+    responseMetadata: ToolResponseMetadata;
+};
+export type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, ToolResponseMetadata>;
+type ToolSignature = {
+    input: UnknownObject;
+    output: UnknownObject;
+    responseMetadata: UnknownObject;
+};
+export declare function useToolInfo<TS extends Partial<ToolSignature> = {}>(): ToolState<UnknownObject & TS["input"], UnknownObject & TS["output"], UnknownObject & TS["responseMetadata"]>;
+export {};

package/dist/src/web/hooks/use-tool-info.js

@@ -1,9 +1,22 @@
-import { useOpenAiGlobal } from "skybridge/web";
+import { useOpenAiGlobal } from "./use-openai-global.js";
+import { useEffect, useState } from "react";
 export function useToolInfo() {
+    const [status, setStatus] = useState("pending");
+    const input = useOpenAiGlobal("toolInput");
+    const output = useOpenAiGlobal("toolOutput") ?? undefined;
+    const responseMetadata = useOpenAiGlobal("toolResponseMetadata") ?? undefined;
+    useEffect(() => {
+        setStatus(output === undefined && responseMetadata === undefined
+            ? "pending"
+            : "success");
+    }, [output, responseMetadata]);
     return {
-        output: useOpenAiGlobal("toolOutput"),
-        input: useOpenAiGlobal("toolInput"),
-        responseMetadata: useOpenAiGlobal("toolResponseMetadata"),
+        input,
+        status,
+        isPending: status === "pending",
+        isSuccess: status === "success",
+        output,
+        responseMetadata,
     };
 }
 //# sourceMappingURL=use-tool-info.js.map

package/dist/src/web/hooks/use-tool-info.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,UAAU,WAAW;IACzB,OAAO;QACL,MAAM,EAAE,eAAe,CAAC,YAAY,CAAC;QACrC,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC;QACnC,gBAAgB,EAAE,eAAe,CAAC,sBAAsB,CAAC;KAC1D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"use-tool-info.js","sourceRoot":"","sources":["../../../../src/web/hooks/use-tool-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAuC5C,MAAM,UAAU,WAAW;IACzB,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAwB,SAAS,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,eAAe,CAAC,WAAW,CAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;IAC1D,MAAM,gBAAgB,GAAG,eAAe,CAAC,sBAAsB,CAAC,IAAI,SAAS,CAAC;IAE9E,SAAS,CAAC,GAAG,EAAE;QACb,SAAS,CACP,MAAM,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS;YACpD,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,SAAS,CACd,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAM/B,OAAO;QACL,KAAK;QACL,MAAM;QACN,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,MAAM;QACN,gBAAgB;KACqB,CAAC;AAC1C,CAAC"}

package/dist/src/web/hooks/use-tool-info.test-d.d.ts

@@ -0,0 +1 @@
+export {};