skybridge 0.0.0-dev.eb4d79a → 0.0.0-dev.ff49e24

package/README.md

@@ -17,21 +17,74 @@ Skybridge comes with 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.
 
+## Quick start
+
+To get started in less than a minute, you can [create a new repository](https://github.com/new?template_name=apps-sdk-template&template_owner=alpic-ai) using our [ChatGPT SDK template](https://github.com/alpic-ai/apps-sdk-template). This template includes a basic setup for both the server and the widgets.
+
 ## Installation
 
 ```bash
 pnpm add skybridge
 ```
 
-## skybridge/server
+## Concepts
+
+### Widgets
+
+> A widget is a UI component that turns structured tool results into a human-friendly UI. Those are built using React components. They are rendered inside an iframe inline with the conversation on ChatGPT.
+
+Each widget in your app must have a unique name. The name is used to bridge the tool invocation result with the widget React component.
+
+For example, in order to register a new widget named `pokemon` on your ChatGPT app. You should have the following file structure and file contents:
+
+_Project structure_
+
+```
+server/
+└── src/
+    └── index.ts // Register the widget with McpServer.widget()
+web/
+└── src/
+    └── widgets/
+        └── pokemon.tsx // Use the same widget name as the file name
+```
+
+_server/src/index.ts_
+
+```ts
+import { McpServer } from "skybridge/server";
+
+const server = new McpServer();
+
+server.widget(
+  "pokemon"
+  // Remaining arguments...
+);
+```
+
+_web/src/widgets/pokemon.tsx_
+
+```ts
+import { mountWidget } from "skybridge/web";
+
+const Pokemon: React.FunctionComponent = () => {
+  // Your React component code goes here...
+};
+
+mountWidget(<Pokemon />);
+```
+
+## Packages
+
+### 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
+### 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
+**Vite plugin**
 
 The `skybridge/web` package comes with a Vite plugin that allows you to build your widgets as regular Vite apps.
 
@@ -44,9 +97,102 @@ export default defineConfig({
 });
 ```
 
+**Hooks**
+
+The `skybridge/web` package comes with a set of hooks to help you build your widgets :
+
+- `useOpenAiGlobal`: A generic hook to get any global data from the OpenAI iFrame skybridge runtime (in `window.openai`).
+- `useToolOutput`: A hook to get the initial tool `structuredContent` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
+- `useToolResponseMetadata`: A hook to get the initial tool `meta` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
+- `useCallTool`: A @tanstack/react-query inspired hook to send make additional tool calls inside a widget.
+
+_useOpenAiGlobal_
+
+```ts
+import { useOpenAiGlobal } from "skybridge/web";
+
+const theme = useOpenAiGlobal("theme");
+```
+
+_useToolOutput_
+
+```ts
+import { useToolOutput } from "skybridge/web";
+
+const toolOutput = useToolOutput();
+```
+
+_useToolResponseMetadata_
+
+```ts
+import { useToolResponseMetadata } from "skybridge/web";
+
+const toolResponseMetadata = useToolResponseMetadata();
+```
+
+_useCallTool_ in synchronous mode
+
+```ts
+import { useCallTool } from "skybridge/web";
+
+export const TestTool: React.FunctionComponent = () => {
+  const { callTool, isPending } = useCallTool("myToolName");
+
+  return (
+    <div>
+      <button
+        disabled={isPending}
+        onClick={() => {
+          callTool({ input: "test input" }, {
+            onSuccess: (data) => {
+              alert("Tool returned: " + data);
+            },
+          });
+      >
+        Call Tool inside a widget
+      </button>
+    </div>
+  );
+};
+```
+
+_useCallTool_ in asynchronous mode
+
+```ts
+import { useCallTool } from "skybridge/web";
+
+export const TestTool: React.FunctionComponent = () => {
+  const { callToolAsync, isPending } = useCallTool("myToolName");
+
+  return (
+    <div>
+      <button
+        disabled={isPending}
+        onClick={async () => {
+          const data = await callToolAsync({ input: "test input" });
+          alert("Tool returned: " + data);
+        }}
+      >
+        Call Tool inside a widget
+      </button>
+    </div>
+  );
+};
+```
+
 ## 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
+2. Create a new vite project in a folder named `web` and install the `skybridge` package
+3. Replace the `vite.config.ts` file with the following:
+
+```ts
+import { defineConfig } from "vite";
+import { skybridge } from "skybridge/web";
+
+export default defineConfig({
+  plugins: [skybridge()],
+});
+```

package/dist/src/server/templates/development.hbs

@@ -0,0 +1,11 @@
+<script type="module">
+  import { injectIntoGlobalHook } from "{{serverUrl}}/@react-refresh";
+  injectIntoGlobalHook(window); window.$RefreshReg$ = () => {};
+  window.$RefreshSig$ = () => (type) => type;
+  window.__vite_plugin_react_preamble_installed__ = true;
+</script>
+<script type="module" src="{{serverUrl}}/@vite/client"></script>
+<div id="root"></div>
+<script type="module">
+  import('{{serverUrl}}/src/widgets/{{widgetName}}.tsx');
+</script>

package/dist/src/server/templates/production.hbs

@@ -0,0 +1,5 @@
+<div id="root"></div>
+<script type="module">
+  import('{{serverUrl}}/assets/{{widgetName}}.js');
+</script>
+<link rel="stylesheet" crossorigin href="{{serverUrl}}/assets/style.css" />

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

@@ -1,4 +1,7 @@
 export { useOpenAiGlobal } from "./use-openai-global.js";
 export { useToolOutput } from "./use-tool-output.js";
+export { useToolResponseMetadata } from "./use-tool-response-metadata.js";
+export { useCallTool } from "./use-call-tool.js";
 export * from "./types.js";
 export { mountWidget } from "./mount-widget.js";
+export { skybridge } from "./plugin.js";

package/dist/src/web/index.js

@@ -1,5 +1,8 @@
 export { useOpenAiGlobal } from "./use-openai-global.js";
 export { useToolOutput } from "./use-tool-output.js";
+export { useToolResponseMetadata } from "./use-tool-response-metadata.js";
+export { useCallTool } from "./use-call-tool.js";
 export * from "./types.js";
 export { mountWidget } from "./mount-widget.js";
+export { skybridge } from "./plugin.js";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

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

@@ -0,0 +1,2 @@
+import type { Plugin } from "vite";
+export declare function skybridge(): Plugin;

package/dist/src/web/plugin.js

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

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

@@ -38,12 +38,20 @@ export type OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolO
     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: (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;

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"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;AA4BjC,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,aAAa,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;QACjD,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CACvC,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CACf,QAAkB,EAClB,WAGC,EACD,EAAE;QACF,aAAa,CAAC,QAAQ,CAAC;aACpB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,WAAW,EAAE,OAAO,EAAE,CAAC;gBACzB,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACG,CAAC;IAEjC,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}

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

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

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

@@ -0,0 +1,66 @@
+import { useCallTool } from "./use-call-tool.js";
+import { describe, it, expect, vi, beforeEach, afterEach, } from "vitest";
+import { renderHook, act, waitFor } from "@testing-library/react";
+describe("useCallTool - onSuccess callback", () => {
+    let OpenaiMock;
+    beforeEach(() => {
+        OpenaiMock = {
+            callTool: vi.fn(),
+        };
+        vi.stubGlobal("openai", OpenaiMock);
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        vi.resetAllMocks();
+    });
+    const toolName = "test-tool";
+    const args = { input: "test input" };
+    const data = {
+        content: [{ type: "text", text: "test result" }],
+        structuredContent: { result: "test" },
+        isError: false,
+        result: "test result",
+        meta: {},
+    };
+    const error = new Error("test error");
+    it("should call window.openai.callTool with correct arguments", async () => {
+        const { result } = renderHook(() => useCallTool(toolName));
+        act(() => {
+            result.current.callTool(args);
+        });
+        expect(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);
+    });
+    it("should call onSuccess callback with correct data and toolArgs on successful execution", async () => {
+        const onSuccess = vi.fn();
+        const onError = vi.fn();
+        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        const { result } = renderHook(() => useCallTool(toolName));
+        act(() => {
+            result.current.callTool(args, {
+                onSuccess,
+                onError,
+            });
+        });
+        await waitFor(() => {
+            expect(onSuccess).toHaveBeenCalledWith(data, args);
+            expect(onError).not.toHaveBeenCalled();
+        });
+    });
+    it("should call onError callback with error and toolArgs on failed execution", async () => {
+        const onSuccess = vi.fn();
+        const onError = vi.fn();
+        OpenaiMock.callTool.mockRejectedValueOnce(error);
+        const { result } = renderHook(() => useCallTool(toolName));
+        act(() => {
+            result.current.callTool(args, {
+                onSuccess,
+                onError,
+            });
+        });
+        await waitFor(() => {
+            expect(onSuccess).not.toHaveBeenCalled();
+            expect(onError).toHaveBeenCalledWith(error, args);
+        });
+    });
+});
+//# sourceMappingURL=use-call-tool.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../src/web/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAElE,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skybridge",
-  "version": "0.0.0-dev.eb4d79a",
+  "version": "0.0.0-dev.ff49e24",
   "description": "Skybridge is a framework for building ChatGPT apps",
   "type": "module",
   "files": [
@@ -17,8 +17,12 @@
     }
   },
   "scripts": {
-    "build": "tsc",
-    "test": "vitest run --silent"
+    "build": "tsc && pnpm run build:templates",
+    "build:templates": "cp -r src/server/templates dist/src/server/",
+    "test": "vitest run --silent",
+    "docs:dev": "pnpm --filter @skybridge/docs start",
+    "docs:build": "pnpm --filter @skybridge/docs build",
+    "docs:serve": "pnpm --filter @skybridge/docs serve"
   },
   "keywords": [
     "chatgpt",
@@ -41,13 +45,15 @@
     "zod": "^3.25.51"
   },
   "devDependencies": {
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.0",
     "@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",
-    "@types/jsdom": "^21.1.6",
     "@vitest/ui": "^2.1.8",
     "jsdom": "^25.0.1",
     "typescript": "^5.9.3",