skybridge 0.0.0-dev.d8535f2 → 0.0.0-dev.d8b52a9

package/dist/src/web/typed-hooks.js

@@ -0,0 +1,111 @@
+import { useCallTool } from "./hooks/use-call-tool.js";
+import { useToolInfo } from "./hooks/use-tool-info.js";
+/**
+ * Creates typed versions of skybridge hooks with full type inference
+ * for tool names, inputs, and outputs.
+ *
+ * This is the recommended way to use skybridge hooks in your widgets.
+ * Set this up once in a dedicated file and export the typed hooks for use across your app.
+ *
+ * @typeParam T - The type of your McpServer instance. Use `typeof server`.
+ *
+ * @example
+ * ```typescript
+ * // server/src/index.ts
+ * const server = new McpServer({ name: "my-app", version: "1.0" }, {})
+ *   .widget("search-voyage", {}, {
+ *     inputSchema: { destination: z.string() },
+ *     outputSchema: { results: z.array(z.string()) },
+ *   }, async ({ destination }) => {
+ *     return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
+ *   });
+ *
+ * export type AppType = typeof server;
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // web/src/skybridge.ts (one-time setup)
+ * import type { AppType } from "../server";
+ * import { createTypedHooks } from "skybridge/web";
+ *
+ * export const { useCallTool, useToolInfo } = createTypedHooks<AppType>();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // web/src/widgets/search.tsx (usage)
+ * import { useCallTool, useToolInfo } from "../skybridge";
+ *
+ * export function SearchWidget() {
+ *   const { callTool, data } = useCallTool("search-voyage");
+ *   //                                      ^ autocomplete for tool names
+ *   callTool({ destination: "Spain" });
+ *   //         ^ autocomplete for input fields
+ *
+ *   const toolInfo = useToolInfo<"search-voyage">();
+ *   //                              ^ autocomplete for widget names
+ *   // toolInfo.input is typed based on widget input schema
+ *   // toolInfo.output is typed based on widget output schema
+ * }
+ * ```
+ */
+export function createTypedHooks() {
+    return {
+        /**
+         * Typed version of `useCallTool` that provides autocomplete for tool names
+         * and type inference for inputs and outputs.
+         *
+         * @param name - The name of the widget to call. Autocompletes based on your server's widget registry.
+         * @returns A hook with typed `callTool` function and `data` property.
+         *
+         * @example
+         * ```typescript
+         * const { callTool, data, isPending } = useCallTool("search-voyage");
+         * // TypeScript knows callTool expects { destination: string }
+         * callTool({ destination: "Spain" });
+         *
+         * // data.structuredContent is typed based on your outputSchema
+         * if (data) {
+         *   console.log(data.structuredContent.results);
+         * }
+         * ```
+         */
+        useCallTool: (name) => {
+            // Type assertion is safe here because the runtime types are compatible.
+            // The underlying hook accepts broader types, but we expose narrower, more specific types.
+            return useCallTool(name);
+        },
+        /**
+         * Typed version of `useToolInfo` that provides autocomplete for widget names
+         * and type inference for inputs, outputs, and responseMetadata.
+         *
+         * @typeParam K - The name of the widget. Autocompletes based on your server's widget registry.
+         * @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
+         *
+         * @example
+         * ```typescript
+         * const toolInfo = useToolInfo<"search-voyage">();
+         * // toolInfo.input is typed as { destination: string; ... }
+         * // toolInfo.output is typed as { results: Array<...>; ... } | undefined
+         * // toolInfo.status narrows correctly: "pending" | "success"
+         *
+         * if (toolInfo.isPending) {
+         *   // TypeScript knows output is undefined here
+         *   console.log(toolInfo.input.destination);
+         * }
+         *
+         * if (toolInfo.isSuccess) {
+         *   // TypeScript knows output is defined here
+         *   console.log(toolInfo.output.results);
+         * }
+         * ```
+         */
+        useToolInfo: () => {
+            // Type assertion is safe here because the runtime types are compatible.
+            // The underlying hook accepts broader types, but we expose narrower, more specific types.
+            return useToolInfo();
+        },
+    };
+}
+//# sourceMappingURL=typed-hooks.js.map

package/dist/src/web/typed-hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-hooks.js","sourceRoot":"","sources":["../../../src/web/typed-hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAgCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,UAAU,gBAAgB;IAI9B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAO,EAIP,EAAE;YACF,wEAAwE;YACxE,0FAA0F;YAC1F,OAAO,WAAW,CAGhB,IAAI,CAGL,CAAC;QACJ,CAAC;QACD;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,wEAAwE;YACxE,0FAA0F;YAC1F,OAAO,WAAW,EAQjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/src/web/typed-hooks.test-d.d.ts

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

package/dist/src/web/typed-hooks.test-d.js

@@ -0,0 +1,72 @@
+import { expectTypeOf, test } from "vitest";
+import { createTypedHooks } from "./typed-hooks.js";
+test("InferWidgets extracts the widget registry type", () => {
+    expectTypeOf().toHaveProperty("search-voyage");
+    expectTypeOf().toHaveProperty("get-trip-details");
+    expectTypeOf().toHaveProperty("no-input-widget");
+});
+test("WidgetNames returns a union of widget name literals", () => {
+    expectTypeOf().toEqualTypeOf();
+});
+test("WidgetInput extracts the correct input type from Zod schema", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+});
+test("WidgetOutput extracts the correct output type from Zod schema", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+});
+test("createTypedHooks provides autocomplete for widget names", () => {
+    const { useCallTool } = createTypedHooks();
+    useCallTool("search-voyage");
+    useCallTool("get-trip-details");
+    useCallTool("no-input-widget");
+    // @ts-expect-error - "invalid-name" is not a valid widget name
+    useCallTool("invalid-name");
+});
+test("useCallTool returns correctly typed callTool function", () => {
+    const { useCallTool } = createTypedHooks();
+    const { callTool } = useCallTool("search-voyage");
+    callTool({ destination: "Spain" });
+    callTool({ destination: "France", departureDate: "2024-06-01" });
+    callTool({ destination: "Italy", maxPrice: 1000 });
+});
+test("useCallTool returns correctly typed data", () => {
+    const { useCallTool } = createTypedHooks();
+    const { data } = useCallTool("search-voyage");
+    if (data) {
+        expectTypeOf(data.structuredContent).toExtend();
+        expectTypeOf(data.structuredContent.results).toBeArray();
+        expectTypeOf(data.structuredContent.totalCount).toBeNumber();
+    }
+});
+test("widgets with no outputSchema have empty object output type", () => {
+    expectTypeOf().toEqualTypeOf();
+});
+test("createTypedHooks provides autocomplete for widget names in useToolInfo", () => {
+    const { useToolInfo } = createTypedHooks();
+    useToolInfo();
+    useToolInfo();
+    useToolInfo();
+    // @ts-expect-error - "invalid-name" is not a valid widget name
+    useToolInfo();
+});
+test("useToolInfo infers input types from WidgetInput utility", () => {
+    const { useToolInfo } = createTypedHooks();
+    const toolInfo = useToolInfo();
+    expectTypeOf(toolInfo.input).toExtend();
+    const detailsInfo = useToolInfo();
+    expectTypeOf(detailsInfo.input).toExtend();
+});
+test("useToolInfo infers output types from WidgetOutput utility", () => {
+    const { useToolInfo } = createTypedHooks();
+    const toolInfo = useToolInfo();
+    if (toolInfo.status === "success") {
+        expectTypeOf(toolInfo.output).toExtend();
+    }
+    const detailsInfo = useToolInfo();
+    if (detailsInfo.status === "success") {
+        expectTypeOf(detailsInfo.output).toExtend();
+    }
+});
+//# sourceMappingURL=typed-hooks.test-d.js.map

package/dist/src/web/typed-hooks.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-hooks.test-d.js","sourceRoot":"","sources":["../../../src/web/typed-hooks.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAuCpD,IAAI,CAAC,gDAAgD,EAAE,GAAG,EAAE;IAG1D,YAAY,EAAW,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACxD,YAAY,EAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC3D,YAAY,EAAW,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;IAG/D,YAAY,EAAS,CAAC,aAAa,EAEhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAGvE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IAGzE,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IAEvD,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAE/B,+DAA+D;IAC/D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAE9C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAOzC,CAAC;QAEL,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACzD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAGH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;IAGtE,YAAY,EAAiB,CAAC,aAAa,EAAM,CAAC;AACpD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IAEvD,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAqB,CAAC;IAEjC,+DAA+D;IAC/D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,QAAQ,GAAG,WAAW,EAAmB,CAAC;IAGhD,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAiB,CAAC;IAEvD,MAAM,WAAW,GAAG,WAAW,EAAsB,CAAC;IAEtD,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAwB,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACrE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAc,CAAC;IACvD,MAAM,QAAQ,GAAG,WAAW,EAAmB,CAAC;IAGhD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAkB,CAAC;IAC3D,CAAC;IAED,MAAM,WAAW,GAAG,WAAW,EAAsB,CAAC;IAEtD,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACrC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAyB,CAAC;IACrE,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/src/web/typed-hooks.test.d.ts

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

package/dist/src/web/typed-hooks.test.js

@@ -0,0 +1,10 @@
+import { describe, expect, it } from "vitest";
+import { createTypedHooks } from "./typed-hooks.js";
+describe("createTypedHooks", () => {
+    it("should return an object with useCallTool hook", () => {
+        const hooks = createTypedHooks();
+        expect(hooks).toHaveProperty("useCallTool");
+        expect(typeof hooks.useCallTool).toBe("function");
+    });
+});
+//# sourceMappingURL=typed-hooks.test.js.map

package/dist/src/web/typed-hooks.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-hooks.test.js","sourceRoot":"","sources":["../../../src/web/typed-hooks.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAYpD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,gBAAgB,EAAc,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -1,17 +1,7 @@
 export type UnknownObject = Record<string, unknown>;
-export type WidgetState = UnknownObject;
-export type SetWidgetState = (state: WidgetState) => Promise<void>;
-export type SendFollowUpMessage = (args: {
-    prompt: string;
-}) => Promise<void>;
-export type RequestDisplayMode = (args: {
-    mode: DisplayMode;
-}) => Promise<{
-    mode: DisplayMode;
-}>;
-export type RequestModal = (options: RequestModalOptions) => Promise<void>;
-export type RequestModalOptions = {
-    title: string;
+type WidgetState = UnknownObject;
+type FileMetadata = {
+    fileId: string;
 };
 export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
 export declare class ToolResponseEvent extends CustomEvent<{
@@ -43,8 +33,6 @@ export type OpenAiGlobals<ToolInput extends UnknownObject = {}, ToolOutput exten
     } | null;
     toolResponseMetadata: ToolResponseMetadata | null;
     widgetState: WidgetState | null;
-    requestDisplayMode: RequestDisplayMode;
-    requestModal: RequestModal;
 };
 export type CallToolArgs = Record<string, unknown> | null;
 export type CallToolResponse = {
@@ -65,7 +53,7 @@ type API<WidgetState extends UnknownObject> = {
         prompt: string;
     }) => Promise<void>;
     /** Opens an external link, redirects web page or mobile app */
-    openExternal(payload: {
+    openExternal(args: {
         href: string;
     }): void;
     /** For transitioning an app from inline to fullscreen or pip */
@@ -78,7 +66,27 @@ type API<WidgetState extends UnknownObject> = {
          */
         mode: DisplayMode;
     }>;
+    /**
+     * Sets the widget state.
+     * This state is persisted across widget renders.
+     */
     setWidgetState: (state: WidgetState) => Promise<void>;
+    /**
+     * Opens a modal portaled outside of the widget iFrame.
+     * This ensures the modal is correctly displayed and not limited to the widget's area.
+     */
+    requestModal: (args: {
+        title: string;
+    }) => Promise<void>;
+    /** Uploads a new file to the host */
+    uploadFile: (file: File) => Promise<FileMetadata>;
+    /**
+     * Downloads a file from the host that was previously uploaded.
+     * Only files uploaded by the same connector instance can be downloaded.
+     */
+    downloadFile: (file: FileMetadata) => Promise<{
+        downloadUrl: string;
+    }>;
 };
 export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
 export declare class SetGlobalsEvent extends CustomEvent<{

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA6ED,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":"AAMA,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/dist/vitest.config.js

@@ -3,7 +3,6 @@ export default defineConfig({
     test: {
         environment: "jsdom",
         globals: true,
-        setupFiles: ["./src/test/setup.ts"],
     },
 });
 //# sourceMappingURL=vitest.config.js.map

package/dist/vitest.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,CAAC,qBAAqB,CAAC;KACpC;CACF,CAAC,CAAC"}
+{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE,IAAI;KACd;CACF,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skybridge",
-  "version": "0.0.0-dev.d8535f2",
+  "version": "0.0.0-dev.d8b52a9",
   "description": "Skybridge is a framework for building ChatGPT apps",
   "type": "module",
   "files": [

package/dist/src/test/setup.js

@@ -1,9 +0,0 @@
-import { vi } from "vitest";
-// Mock console methods to avoid noise in tests
-global.console = {
-    ...console,
-    error: vi.fn(),
-    warn: vi.fn(),
-    log: vi.fn(),
-};
-//# sourceMappingURL=setup.js.map

package/dist/src/test/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../../src/test/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,+CAA+C;AAC/C,MAAM,CAAC,OAAO,GAAG;IACf,GAAG,OAAO;IACV,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE;IACd,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;IACb,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;CACb,CAAC"}