skybridge 0.0.0-dev.e3e0986 → 0.0.0-dev.e434f62

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

@@ -1,61 +0,0 @@
-import { useCallTool } from "./hooks/use-call-tool.js";
-import type { ToolPendingState, ToolSuccessState } from "./hooks/use-tool-info.js";
-import type { McpServer, InferWidgets, AnyWidgetRegistry, WidgetInput, WidgetOutput } from "../server/index.js";
-import type { CallToolArgs, UnknownObject } from "./types.js";
-type TypedCallToolReturn<TInput, TOutput> = ReturnType<typeof useCallTool<TInput & CallToolArgs, {
-    structuredContent: TOutput & UnknownObject;
-}>>;
-type TypedToolInfoReturn<TInput extends UnknownObject, TOutput extends UnknownObject, TResponseMetadata extends UnknownObject> = ToolPendingState<TInput> | ToolSuccessState<TInput, TOutput, TResponseMetadata>;
-/**
- * Creates typed versions of skybridge hooks with full type inference
- * for tool names, inputs, and outputs.
- *
- * Set this up once in a dedicated file and export the typed hooks:
- *
- * @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>();
- * ```
- *
- * ```typescript
- * // web/src/widgets/search.tsx (usage)
- * import { useCallTool, useToolInfo } from "../skybridge";
- *
- * export function SearchWidget() {
- *   const { callTool, data } = useCallTool("search");
- *   //                                      ^ autocomplete for tool names
- *   callTool({ query: "test" });
- *   //         ^ autocomplete for input fields
- *
- *   const toolInfo = useToolInfo<"search">();
- *   //                              ^ autocomplete for tool names
- *   // toolInfo.input is typed based on widget input schema
- *   // toolInfo.output is typed based on widget output schema
- * }
- * ```
- */
-export declare function createTypedHooks<T extends McpServer<AnyWidgetRegistry>>(): {
-    /**
-     * Typed version of useCallTool that provides autocomplete for tool names
-     * and type inference for inputs and outputs.
-     */
-    useCallTool: <K extends keyof InferWidgets<T> & string>(name: K) => TypedCallToolReturn<InferWidgets<T>[K]["input"], InferWidgets<T>[K]["output"]>;
-    /**
-     * Typed version of useToolInfo that provides autocomplete for widget names
-     * and type inference for inputs, outputs, and responseMetadata.
-     *
-     * @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"
-     * ```
-     */
-    useToolInfo: <K extends keyof InferWidgets<T> & string>() => TypedToolInfoReturn<WidgetInput<T, K> & UnknownObject, WidgetOutput<T, K> & UnknownObject, UnknownObject>;
-};
-export {};

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

@@ -1,61 +0,0 @@
-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.
- *
- * Set this up once in a dedicated file and export the typed hooks:
- *
- * @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>();
- * ```
- *
- * ```typescript
- * // web/src/widgets/search.tsx (usage)
- * import { useCallTool, useToolInfo } from "../skybridge";
- *
- * export function SearchWidget() {
- *   const { callTool, data } = useCallTool("search");
- *   //                                      ^ autocomplete for tool names
- *   callTool({ query: "test" });
- *   //         ^ autocomplete for input fields
- *
- *   const toolInfo = useToolInfo<"search">();
- *   //                              ^ autocomplete for tool 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.
-         */
-        useCallTool: (name) => {
-            return useCallTool(name);
-        },
-        /**
-         * Typed version of useToolInfo that provides autocomplete for widget names
-         * and type inference for inputs, outputs, and responseMetadata.
-         *
-         * @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"
-         * ```
-         */
-        useToolInfo: () => {
-            return useToolInfo();
-        },
-    };
-}
-//# sourceMappingURL=typed-hooks.js.map

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

@@ -1 +0,0 @@
-{"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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,gBAAgB;IAI9B,OAAO;QACL;;;WAGG;QACH,WAAW,EAAE,CACX,IAAO,EAIP,EAAE;YACF,OAAO,WAAW,CAGhB,IAAI,CAGL,CAAC;QACJ,CAAC;QACD;;;;;;;;;;;WAWG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,OAAO,WAAW,EAQjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

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

@@ -1,72 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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.js

@@ -1,10 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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,119 +0,0 @@
-export type UnknownObject = Record<string, unknown>;
-type WidgetState = UnknownObject;
-type FileMetadata = {
-    fileId: string;
-};
-export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
-export declare class ToolResponseEvent extends CustomEvent<{
-    tool: {
-        name: string;
-        args: UnknownObject;
-    };
-}> {
-    readonly type = "openai:tool_response";
-}
-declare global {
-    interface Window {
-        openai: API<WidgetState> & OpenAiGlobals;
-    }
-    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> = {
-    theme: Theme;
-    userAgent: UserAgent;
-    locale: string;
-    maxHeight: number;
-    displayMode: DisplayMode;
-    safeArea: SafeArea;
-    toolInput: ToolInput;
-    toolOutput: ToolOutput | {
-        text: string;
-    } | null;
-    toolResponseMetadata: ToolResponseMetadata | null;
-    widgetState: WidgetState | null;
-};
-export type CallToolArgs = Record<string, unknown> | null;
-export type CallToolResponse = {
-    content: {
-        type: "text";
-        text: string;
-    }[];
-    structuredContent: Record<string, unknown>;
-    isError: boolean;
-    result: string;
-    meta: Record<string, unknown>;
-};
-type API<WidgetState extends 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 */
-    sendFollowUpMessage: (args: {
-        prompt: string;
-    }) => Promise<void>;
-    /** Opens an external link, redirects web page or mobile app */
-    openExternal(args: {
-        href: string;
-    }): void;
-    /** For transitioning an app from inline to fullscreen or pip */
-    requestDisplayMode: (args: {
-        mode: DisplayMode;
-    }) => Promise<{
-        /**
-         * The granted display mode. The host may reject the request.
-         * For mobile, PiP is always coerced to fullscreen.
-         */
-        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<{
-    globals: Partial<OpenAiGlobals>;
-}> {
-    readonly type = "openai:set_globals";
-}
-export type CallTool = (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
-export type DisplayMode = "pip" | "inline" | "fullscreen";
-export type Theme = "light" | "dark";
-export type SafeAreaInsets = {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-};
-export type SafeArea = {
-    insets: SafeAreaInsets;
-};
-export type DeviceType = "mobile" | "tablet" | "desktop" | "unknown";
-export type UserAgent = {
-    device: {
-        type: DeviceType;
-    };
-    capabilities: {
-        hover: boolean;
-        touch: boolean;
-    };
-};
-export {};

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

@@ -1 +0,0 @@
-{"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.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;

package/dist/vitest.config.js

@@ -1,8 +0,0 @@
-import { defineConfig } from "vitest/config";
-export default defineConfig({
-    test: {
-        environment: "jsdom",
-        globals: true,
-    },
-});
-//# sourceMappingURL=vitest.config.js.map

package/dist/vitest.config.js.map

@@ -1 +0,0 @@
-{"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"}