skybridge 0.0.1 → 0.1.0

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

@@ -0,0 +1,95 @@
+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 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 = 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 | null;
+    toolResponseMetadata: ToolResponseMetadata | null;
+    widgetState: WidgetState | null;
+};
+export type CallToolResponse = {
+    result: string;
+};
+type API<WidgetState extends UnknownObject> = {
+    /** Calls a tool on your MCP. Returns the full response. */
+    callTool: (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
+    /** 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: {
+        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;
+    }>;
+    setWidgetState: (state: WidgetState) => Promise<void>;
+};
+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

@@ -0,0 +1,10 @@
+export const TOOL_RESPONSE_EVENT_TYPE = "openai:tool_response";
+export class ToolResponseEvent extends CustomEvent {
+    type = TOOL_RESPONSE_EVENT_TYPE;
+}
+// Dispatched when any global changes in the host page
+export const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
+export class SetGlobalsEvent extends CustomEvent {
+    type = SET_GLOBALS_EVENT_TYPE;
+}
+//# sourceMappingURL=types.js.map

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

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

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

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

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

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

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

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

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

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

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

package/dist/vitest.config.js

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

package/dist/vitest.config.js.map

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

package/package.json

@@ -1,8 +1,26 @@
 {
   "name": "skybridge",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Skybridge is a framework for building ChatGPT apps",
-  "main": "index.js",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./server": {
+      "types": "./dist/src/server/index.d.ts",
+      "default": "./dist/src/server/index.js"
+    },
+    "./web": {
+      "types": "./dist/src/web/index.d.ts",
+      "default": "./dist/src/web/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc && pnpm run build:templates",
+    "build:templates": "cp -r src/server/templates dist/src/server/",
+    "test": "vitest run --silent"
+  },
   "keywords": [
     "chatgpt",
     "app",
@@ -11,10 +29,30 @@
   ],
   "author": "Frédéric Barthelet",
   "license": "ISC",
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "dependencies": {
+    "@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"
+  },
   "devDependencies": {
-    "typescript": "^5.9.3"
+    "@total-typescript/tsconfig": "^1.0.4",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.3",
+    "@types/jsdom": "^21.1.6",
+    "@types/node": "^22.15.30",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "@vitest/ui": "^2.1.8",
+    "jsdom": "^25.0.1",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.8"
   },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}
+  "packageManager": "pnpm@10.17.1"
+}