skybridge 0.0.0-dev.4eb7532 → 0.0.0-dev.50d83cf

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

@@ -1,14 +1,22 @@
-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";
+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,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 = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> = {
+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;
@@ -34,7 +42,9 @@ export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolO
     displayMode: DisplayMode;
     safeArea: SafeArea;
     toolInput: ToolInput;
-    toolOutput: ToolOutput | null;
+    toolOutput: ToolOutput | {
+        text: string;
+    } | null;
     toolResponseMetadata: ToolResponseMetadata | null;
     widgetState: WidgetState | null;
 };
@@ -49,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 */
@@ -57,7 +67,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 */
@@ -70,11 +80,31 @@ 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<{
-    globals: Partial<OpenAiGlobals>;
+    globals: Partial<OpenAiProperties>;
 }> {
     readonly type = "openai:set_globals";
 }

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;AA2ED,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/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.4eb7532",
+  "version": "0.0.0-dev.50d83cf",
   "description": "Skybridge is a framework for building ChatGPT apps",
   "type": "module",
   "files": [
@@ -19,7 +19,14 @@
   "scripts": {
     "build": "tsc && pnpm run build:templates",
     "build:templates": "cp -r src/server/templates dist/src/server/",
-    "test": "vitest run --silent"
+    "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",
+    "docs:dev": "pnpm --filter @skybridge/docs start",
+    "docs:build": "pnpm --filter @skybridge/docs build",
+    "docs:serve": "pnpm --filter @skybridge/docs serve"
   },
   "keywords": [
     "chatgpt",
@@ -30,19 +37,26 @@
   "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",
     "handlebars": "^4.7.8",
+    "superjson": "^2.2.6",
     "vite": "^7.1.11",
-    "zod": "^3.25.51"
+    "zustand": "^5.0.9"
   },
   "devDependencies": {
+    "@biomejs/biome": "2.3.8",
+    "@modelcontextprotocol/sdk": "^1.24.3",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.0",
     "@total-typescript/tsconfig": "^1.0.4",
+    "@types/babel__core": "^7.20.5",
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.3",
     "@types/jsdom": "^21.1.6",
@@ -52,7 +66,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"
 }

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/plugin.js

@@ -1,30 +0,0 @@
-export function skybridge() {
-    return {
-        name: "skybridge",
-        async config(config) {
-            // Dynamic imports to ensure Node modules are only loaded in Node.js context
-            const { globSync } = await import("node:fs");
-            const { resolve } = await import("node:path");
-            const projectRoot = config.root || process.cwd();
-            const widgetsPattern = resolve(projectRoot, "src/widgets/*.{js,ts,jsx,tsx,html}");
-            const input = Object.fromEntries(globSync(widgetsPattern).map((file) => [
-                file.match(/src\/widgets\/(.+)\.tsx$/)?.[1],
-                file,
-            ]));
-            return {
-                build: {
-                    minify: true,
-                    cssCodeSplit: false,
-                    rollupOptions: {
-                        input,
-                        output: {
-                            entryFileNames: "[name].js",
-                            assetFileNames: "[name][extname]",
-                        },
-                    },
-                },
-            };
-        },
-    };
-}
-//# sourceMappingURL=plugin.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/web/plugin.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,SAAS;IACvB,OAAO;QACL,IAAI,EAAE,WAAW;QAEjB,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,4EAA4E;YAC5E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;YAC7C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;YAE9C,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACjD,MAAM,cAAc,GAAG,OAAO,CAC5B,WAAW,EACX,oCAAoC,CACrC,CAAC;YAEF,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAC9B,QAAQ,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;gBACrC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC3C,IAAI;aACL,CAAC,CACH,CAAC;YAEF,OAAO;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,IAAI;oBACZ,YAAY,EAAE,KAAK;oBACnB,aAAa,EAAE;wBACb,KAAK;wBACL,MAAM,EAAE;4BACN,cAAc,EAAE,WAAW;4BAC3B,cAAc,EAAE,iBAAiB;yBAClC;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

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

@@ -1,39 +0,0 @@
-import type { CallToolArgs, CallToolResponse } from "./types.js";
-export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends CallToolResponse = CallToolResponse>(name: string) => {
-    callTool: (toolArgs: ToolArgs) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse | undefined>;
-    status: "idle";
-    response: undefined;
-    isIdle: true;
-    isPending: false;
-    isSuccess: false;
-    isError: false;
-} | {
-    callTool: (toolArgs: ToolArgs) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse | undefined>;
-    status: "pending";
-    response: undefined;
-    isIdle: false;
-    isPending: true;
-    isSuccess: false;
-    isError: false;
-} | {
-    callTool: (toolArgs: ToolArgs) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse | undefined>;
-    status: "error";
-    error: unknown;
-    response: undefined;
-    isIdle: false;
-    isPending: false;
-    isSuccess: false;
-    isError: true;
-} | {
-    callTool: (toolArgs: ToolArgs) => void;
-    callToolAsync: (toolArgs: ToolArgs) => Promise<ToolResponse | undefined>;
-    status: "success";
-    response: ToolResponse;
-    isIdle: false;
-    isPending: false;
-    isSuccess: true;
-    isError: false;
-};

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

@@ -1,53 +0,0 @@
-import { useState } from "react";
-export const useCallTool = (name) => {
-    const [callToolState, setCallToolState] = useState({
-        status: "idle",
-        response: undefined,
-        isIdle: true,
-        isPending: false,
-        isSuccess: false,
-        isError: false,
-    });
-    const callToolAsync = async (toolArgs) => {
-        setCallToolState({
-            status: "pending",
-            response: undefined,
-            isIdle: false,
-            isPending: true,
-            isSuccess: false,
-            isError: false,
-        });
-        try {
-            const response = await window.openai.callTool(name, toolArgs);
-            setCallToolState({
-                status: "success",
-                response,
-                isIdle: false,
-                isPending: false,
-                isSuccess: true,
-                isError: false,
-            });
-            return response;
-        }
-        catch (error) {
-            setCallToolState({
-                status: "error",
-                response: undefined,
-                error,
-                isIdle: false,
-                isPending: false,
-                isSuccess: false,
-                isError: true,
-            });
-        }
-    };
-    const callTool = (toolArgs) => {
-        void callToolAsync(toolArgs);
-    };
-    return {
-        ...callToolState,
-        callTool,
-        callToolAsync,
-    };
-};
-//# sourceMappingURL=use-call-tool.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../src/web/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA4CjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IACF,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAEhD;QACA,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;QACjD,gBAAgB,CAAC;YACf,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,KAAK;YACb,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAC3C,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,gBAAgB,CAAC;gBACf,MAAM,EAAE,SAAS;gBACjB,QAAQ;gBACR,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,CAAC;gBACf,MAAM,EAAE,OAAO;gBACf,QAAQ,EAAE,SAAS;gBACnB,KAAK;gBACL,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,KAAK;gBAChB,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,QAAkB,EAAE,EAAE;QACtC,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,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.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"}

package/dist/src/web/use-tool-response-metadata.d.ts

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

package/dist/src/web/use-tool-response-metadata.js

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

package/dist/src/web/use-tool-response-metadata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-tool-response-metadata.js","sourceRoot":"","sources":["../../../src/web/use-tool-response-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,UAAU,uBAAuB;IACrC,OAAO,eAAe,CAAC,sBAAsB,CAAC,CAAC;AACjD,CAAC"}