skybridge 0.0.0-dev.be84c43 → 0.0.0-dev.bee74db

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-openai-global.d.ts

@@ -1,2 +1,2 @@
-import { type OpenAiGlobals } from "../types.js";
-export declare function useOpenAiGlobal<K extends keyof OpenAiGlobals>(key: K): OpenAiGlobals[K] | undefined;
+import { type OpenAiProperties } from "../types.js";
+export declare function useOpenAiGlobal<K extends keyof OpenAiProperties>(key: K): OpenAiProperties[K] | undefined;

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

@@ -1,5 +1,5 @@
 import type { UnknownObject } from "../types.js";
-type ToolPendingState<ToolInput extends UnknownObject> = {
+export type ToolPendingState<ToolInput extends UnknownObject> = {
     status: "pending";
     isPending: true;
     isSuccess: false;
@@ -7,7 +7,7 @@ type ToolPendingState<ToolInput extends UnknownObject> = {
     output: undefined;
     responseMetadata: undefined;
 };
-type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
+export type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = {
     status: "success";
     isPending: false;
     isSuccess: true;
@@ -15,7 +15,7 @@ type ToolSuccessState<ToolInput extends UnknownObject, ToolOutput extends Unknow
     output: ToolOutput;
     responseMetadata: ToolResponseMetadata;
 };
-type ToolState<ToolInput extends UnknownObject, ToolOutput extends UnknownObject, ToolResponseMetadata extends UnknownObject> = ToolPendingState<ToolInput> | ToolSuccessState<ToolInput, ToolOutput, 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;

package/dist/src/web/index.d.ts

@@ -3,3 +3,4 @@ export * from "./data-llm.js";
 export { mountWidget } from "./mount-widget.js";
 export { skybridge } from "./plugin/plugin.js";
 export * from "./hooks/index.js";
+export { generateHelpers } from "./generate-helpers.js";

package/dist/src/web/index.js

@@ -3,4 +3,5 @@ export * from "./data-llm.js";
 export { mountWidget } from "./mount-widget.js";
 export { skybridge } from "./plugin/plugin.js";
 export * from "./hooks/index.js";
+export { generateHelpers } from "./generate-helpers.js";
 //# sourceMappingURL=index.js.map

package/dist/src/web/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/src/web/types.d.ts

@@ -5,6 +5,14 @@ declare module "react" {
     }
 }
 export type UnknownObject = Record<string, unknown>;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type Objectify<T> = T & UnknownObject;
+type RequiredKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
+}[keyof T];
+export type HasRequiredKeys<T> = RequiredKeys<T> extends never ? false : true;
 type WidgetState = UnknownObject;
 type FileMetadata = {
     fileId: string;
@@ -20,13 +28,13 @@ export declare class ToolResponseEvent extends CustomEvent<{
 }
 declare global {
     interface Window {
-        openai: API<WidgetState> & OpenAiGlobals;
+        openai: OpenAiMethods<WidgetState> & OpenAiProperties;
     }
     interface WindowEventMap {
         [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
     }
 }
-export type OpenAiGlobals<ToolInput extends UnknownObject = {}, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
+export type OpenAiProperties<ToolInput extends UnknownObject = {}, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
     theme: Theme;
     userAgent: UserAgent;
     locale: string;
@@ -51,7 +59,7 @@ export type CallToolResponse = {
     result: string;
     meta: Record<string, unknown>;
 };
-type API<WidgetState extends UnknownObject> = {
+export type OpenAiMethods<WidgetState extends UnknownObject = UnknownObject> = {
     /** Calls a tool on your MCP. Returns the full response. */
     callTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string, args: ToolArgs) => Promise<ToolResponse>;
     /** Triggers a followup turn in the ChatGPT conversation */
@@ -96,7 +104,7 @@ type API<WidgetState extends UnknownObject> = {
 };
 export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
 export declare class SetGlobalsEvent extends CustomEvent<{
-    globals: Partial<OpenAiGlobals>;
+    globals: Partial<OpenAiProperties>;
 }> {
     readonly type = "openai:set_globals";
 }

package/dist/src/web/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,CAAC;AAcf,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA8FD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,CAAC;AAuBf,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA8FD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAC3D,MAAM,OAAO,eAAgB,SAAQ,WAEnC;IACkB,IAAI,GAAG,sBAAsB,CAAC;CACjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skybridge",
-  "version": "0.0.0-dev.be84c43",
+  "version": "0.0.0-dev.bee74db",
   "description": "Skybridge is a framework for building ChatGPT apps",
   "type": "module",
   "files": [
@@ -35,19 +35,19 @@
   "author": "Frédéric Barthelet",
   "license": "ISC",
   "peerDependencies": {
+    "@modelcontextprotocol/sdk": ">=1.0.0",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   },
   "dependencies": {
     "@babel/core": "^7.28.5",
-    "@modelcontextprotocol/sdk": "^1.20.0",
     "cors": "^2.8.5",
     "express": "^5.1.0",
     "handlebars": "^4.7.8",
-    "vite": "^7.1.11",
-    "zod": "^3.25.51"
+    "vite": "^7.1.11"
   },
   "devDependencies": {
+    "@modelcontextprotocol/sdk": "^1.24.3",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.0",
     "@total-typescript/tsconfig": "^1.0.4",
@@ -61,7 +61,8 @@
     "@vitest/ui": "^2.1.8",
     "jsdom": "^25.0.1",
     "typescript": "^5.9.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "zod": "^4.1.13"
   },
   "packageManager": "pnpm@10.17.1"
 }