skybridge 0.0.0-dev.b3151dc → 0.0.0-dev.b494eb4

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

@@ -1,14 +1,24 @@
-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;
-}>;
+import "react";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { WidgetHostType } from "../server/index.js";
+declare module "react" {
+    interface HTMLAttributes<T> {
+        "data-llm"?: string;
+    }
+}
+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]-?: Record<string, never> 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;
+};
 export declare const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
 export declare class ToolResponseEvent extends CustomEvent<{
     tool: {
@@ -20,36 +30,58 @@ export declare class ToolResponseEvent extends CustomEvent<{
 }
 declare global {
     interface Window {
-        openai: API<WidgetState> & OpenAiGlobals;
+        skybridge: SkybridgeProperties;
+        openai: OpenAiMethods<WidgetState> & OpenAiProperties;
     }
     interface WindowEventMap {
         [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
     }
 }
-export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
+export type SkybridgeProperties = {
+    hostType: WidgetHostType;
+};
+export type OpenAiProperties<ToolInput extends UnknownObject = Record<never, unknown>, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
     theme: Theme;
     userAgent: UserAgent;
     locale: string;
     maxHeight: number;
     displayMode: DisplayMode;
     safeArea: SafeArea;
+    view: View;
     toolInput: ToolInput;
-    toolOutput: ToolOutput | null;
+    toolOutput: ToolOutput | {
+        text: string;
+    } | null;
     toolResponseMetadata: ToolResponseMetadata | null;
     widgetState: WidgetState | null;
 };
+export type CallToolArgs = Record<string, unknown> | null;
 export type CallToolResponse = {
+    content: CallToolResult["content"];
+    structuredContent: Record<string, unknown>;
+    isError: boolean;
     result: string;
+    _meta?: CallToolResult["_meta"];
 };
-type API<WidgetState extends UnknownObject> = {
+export type RequestModalOptions = {
+    title?: string;
+    params?: Record<string, unknown>;
+    anchor?: {
+        top?: number;
+        left?: number;
+        width?: number;
+        height?: number;
+    };
+};
+export type OpenAiMethods<WidgetState extends UnknownObject = UnknownObject> = {
     /** Calls a tool on your MCP. Returns the full response. */
-    callTool: (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
+    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(payload: {
+    openExternal(args: {
         href: string;
     }): void;
     /** For transitioning an app from inline to fullscreen or pip */
@@ -62,16 +94,38 @@ 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: RequestModalOptions) => 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>;
+    globals: Partial<OpenAiProperties>;
 }> {
     readonly type = "openai:set_globals";
 }
 export type CallTool = (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
-export type DisplayMode = "pip" | "inline" | "fullscreen";
+export type DisplayMode = "pip" | "inline" | "fullscreen" | "modal";
+export type View = {
+    mode: DisplayMode;
+    params?: Record<string, unknown>;
+};
 export type Theme = "light" | "dark";
 export type SafeAreaInsets = {
     top: number;

package/dist/src/web/types.js

@@ -1,3 +1,4 @@
+import "react";
 export const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
 export class ToolResponseEvent extends CustomEvent {
     type = TOOL_RESPONSE_EVENT_TYPE;

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/web/types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AA+DD,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;AAyBf,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AAC/D,MAAM,OAAO,iBAAkB,SAAQ,WAErC;IACkB,IAAI,GAAG,wBAAwB,CAAC;CACnD;AAuGD,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,7 +1,11 @@
 {
   "name": "skybridge",
-  "version": "0.0.0-dev.b3151dc",
+  "version": "0.0.0-dev.b494eb4",
   "description": "Skybridge is a framework for building ChatGPT apps",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alpic-ai/skybridge.git"
+  },
   "type": "module",
   "files": [
     "dist"
@@ -16,10 +20,6 @@
       "default": "./dist/src/web/index.js"
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "test": "vitest run --silent"
-  },
   "keywords": [
     "chatgpt",
     "app",
@@ -29,29 +29,45 @@
   "author": "Frédéric Barthelet",
   "license": "ISC",
   "peerDependencies": {
+    "@modelcontextprotocol/sdk": ">=1.0.0",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.20.0",
+    "@babel/core": "^7.28.5",
     "cors": "^2.8.5",
-    "express": "^5.1.0",
+    "dequal": "^2.0.3",
+    "express": "^5.2.1",
     "handlebars": "^4.7.8",
-    "vite": "^7.1.11",
-    "zod": "^3.25.51"
+    "superjson": "^2.2.6",
+    "vite": "^7.3.1",
+    "zustand": "^5.0.9"
   },
   "devDependencies": {
+    "@modelcontextprotocol/ext-apps": "^0.2.2",
+    "@modelcontextprotocol/sdk": "^1.25.2",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.1",
     "@total-typescript/tsconfig": "^1.0.4",
+    "@types/babel__core": "^7.20.5",
     "@types/cors": "^2.8.19",
-    "@types/express": "^5.0.3",
-    "@types/node": "^22.15.30",
-    "@types/react": "^19.2.2",
-    "@types/react-dom": "^19.2.2",
-    "@types/jsdom": "^21.1.6",
-    "@vitest/ui": "^2.1.8",
-    "jsdom": "^25.0.1",
+    "@types/express": "^5.0.6",
+    "@types/jsdom": "^27.0.0",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitest/ui": "^4.0.16",
+    "jsdom": "^27.4.0",
     "typescript": "^5.9.3",
-    "vitest": "^2.1.8"
+    "vitest": "^4.0.16",
+    "zod": "^4.3.5"
   },
-  "packageManager": "pnpm@10.17.1"
-}
+  "scripts": {
+    "build": "tsc && pnpm run build:templates",
+    "build:templates": "cp -r src/server/templates dist/src/server/",
+    "format": "biome check --write --error-on-warnings",
+    "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
+    "test:unit": "vitest run",
+    "test:type": "tsc --noEmit",
+    "test:format": "biome ci"
+  }
+}

package/README.md

@@ -1,40 +0,0 @@
-# Skybridge
-
-Skybridge is a framework for building ChatGPT apps. It provides 2 packages:
-
-- `skybridge/server`: A drop-in replacement of the `@modelcontextprotocol/sdk` official `McpServer` class with extra features for widget development.
-- `skybridge/web`: A react library with hooks and components to build widgets on the underlying _OpenAI iFrame skybridge_ runtime.
-
-## Installation
-
-```bash
-pnpm add skybridge
-```
-
-## skybridge/server
-
-The `skybridge/server` package is a drop-in replacement of the `@modelcontextprotocol/sdk` official `McpServer` class with extra features for widget development. If you're already using the `@modelcontextprotocol/sdk`, you can simply replace your `McpServer` import with `skybridge/server` and you're good to go.
-
-## skybridge/web
-
-The `skybridge/web` package is a react library with hooks and components to build widgets on the underlying _OpenAI iFrame skybridge_ runtime.
-
-### Vite plugin
-
-The `skybridge/web` package comes with a Vite plugin that allows you to build your widgets as regular Vite apps.
-
-```ts
-import { defineConfig } from "vite";
-import { skybridge } from "skybridge/web";
-
-export default defineConfig({
-  plugins: [skybridge()],
-});
-```
-
-## Migrate your existing MCP server to a ChatGPT app
-
-If you're already using the `@modelcontextprotocol/sdk` to build a MCP server, you can migrate to a ChatGPT app by following these steps:
-
-1. Replace your `McpServer` import from `@modelcontextprotocol/sdk` with the same import from `skybridge/server`
-2. Create a new node project named `web` and install the `skybridge` package

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"}

package/dist/src/web/use-openai-global.d.ts

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

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

@@ -1,21 +0,0 @@
-import { useSyncExternalStore } from "react";
-import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent } from "./types.js";
-export function useOpenAiGlobal(key) {
-    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, {
-            passive: true,
-        });
-        return () => {
-            window.removeEventListener(SET_GLOBALS_EVENT_TYPE, handleSetGlobal);
-        };
-    }, () => window.openai?.[key]);
-}
-//# sourceMappingURL=use-openai-global.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"use-openai-global.js","sourceRoot":"","sources":["../../../src/web/use-openai-global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAsB,MAAM,YAAY,CAAC;AAEzF,MAAM,UAAU,eAAe,CAAgC,GAAM;IACnE,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"}

package/dist/src/web/use-tool-output.d.ts

@@ -1,3 +0,0 @@
-export declare function useToolOutput(): {
-    [x: string]: unknown;
-} | null | undefined;

package/dist/src/web/use-tool-output.js

@@ -1,5 +0,0 @@
-import { useOpenAiGlobal } from "./use-openai-global.js";
-export function useToolOutput() {
-    return useOpenAiGlobal("toolOutput");
-}
-//# sourceMappingURL=use-tool-output.js.map

package/dist/src/web/use-tool-output.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-tool-output.js","sourceRoot":"","sources":["../../../src/web/use-tool-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,UAAU,aAAa;IAC3B,OAAO,eAAe,CAAC,YAAY,CAAC,CAAC;AACvC,CAAC"}