skybridge 0.0.1 → 0.2.0

package/README.md

@@ -1,3 +1,198 @@
+<div align="center">
+
 # Skybridge
 
-Skybridge is a framework for building ChatGPT apps
+**Skybridge is the TypeScript framework for building ChatGPT apps**
+
+[![By Alpic](https://img.shields.io/badge/Made%20by%20Alpic-f6ffed?logo=alpic)](https://alpic.ai)
+
+![NPM Downloads](https://img.shields.io/npm/dm/skybridge?color=e90060)
+![NPM Version](https://img.shields.io/npm/v/skybridge?color=e90060)
+![GitHub License](https://img.shields.io/github/license/alpic-ai/skybridge?color=e90060)
+
+</div>
+
+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
+```
+
+## 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
+
+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()],
+});
+```
+
+**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 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/index.d.ts

@@ -0,0 +1,2 @@
+export { McpServer } from "./server.js";
+export { widgetsDevServer } from "./widgetsDevServer.js";

package/dist/src/server/index.js

@@ -0,0 +1,3 @@
+export { McpServer } from "./server.js";
+export { widgetsDevServer } from "./widgetsDevServer.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/src/server/server.d.ts

@@ -0,0 +1,12 @@
+import { McpServer as McpServerBase, type ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { Resource } from "@modelcontextprotocol/sdk/types.js";
+import type { ZodRawShape } from "zod";
+type McpServerOriginalResourceConfig = Omit<Resource, "uri" | "name" | "mimeType">;
+type McpServerOriginalToolConfig = Omit<Parameters<McpServer["registerTool"]>[1], "inputSchema" | "outputSchema">;
+export declare class McpServer extends McpServerBase {
+    widget<InputArgs extends ZodRawShape, OutputArgs extends ZodRawShape>(name: string, resourceConfig: McpServerOriginalResourceConfig, toolConfig: McpServerOriginalToolConfig & {
+        inputSchema?: InputArgs;
+        outputSchema?: OutputArgs;
+    }, toolCallback: ToolCallback<InputArgs>): void;
+}
+export {};

package/dist/src/server/server.js

@@ -0,0 +1,45 @@
+import { McpServer as McpServerBase, } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { templateHelper } from "./templateHelper.js";
+export class McpServer extends McpServerBase {
+    widget(name, resourceConfig, toolConfig, toolCallback) {
+        const uri = `ui://widgets/${name}.html`;
+        const resourceMetadata = { ...(resourceConfig._meta ?? {}) };
+        if (toolConfig.description !== undefined) {
+            resourceMetadata["openai/widgetDescription"] = toolConfig.description;
+        }
+        this.resource(name, uri, {
+            ...resourceConfig,
+            _meta: resourceMetadata,
+        }, async (_uri, extra) => {
+            const serverUrl = process.env.NODE_ENV === "production"
+                ? `https://${extra?.requestInfo?.headers?.["x-forwarded-host"] ??
+                    extra?.requestInfo?.headers?.host}`
+                : `http://localhost:3000`;
+            const templateData = {
+                serverUrl,
+                widgetName: name,
+            };
+            const html = process.env.NODE_ENV === "production"
+                ? templateHelper.renderProduction(templateData)
+                : templateHelper.renderDevelopment(templateData);
+            return {
+                contents: [
+                    {
+                        uri,
+                        mimeType: "text/html+skybridge",
+                        text: html,
+                    },
+                ],
+            };
+        });
+        const toolMeta = {
+            ...toolConfig._meta,
+            "openai/outputTemplate": uri,
+        };
+        this.registerTool(name, {
+            ...toolConfig,
+            _meta: toolMeta,
+        }, toolCallback);
+    }
+}
+//# sourceMappingURL=server.js.map

package/dist/src/server/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,IAAI,aAAa,GAE3B,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AA4BrD,MAAM,OAAO,SAAU,SAAQ,aAAa;IAC1C,MAAM,CACJ,IAAY,EACZ,cAA+C,EAC/C,UAGC,EACD,YAAqC;QAErC,MAAM,GAAG,GAAG,gBAAgB,IAAI,OAAO,CAAC;QACxC,MAAM,gBAAgB,GAAiB,EAAE,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3E,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,gBAAgB,CAAC,0BAA0B,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,QAAQ,CACX,IAAI,EACJ,GAAG,EACH;YACE,GAAG,cAAc;YACjB,KAAK,EAAE,gBAAgB;SACxB,EACD,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACpB,MAAM,SAAS,GACb,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,WACE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC;oBACjD,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,IAC/B,EAAE;gBACJ,CAAC,CAAC,uBAAuB,CAAC;YAE9B,MAAM,YAAY,GAAG;gBACnB,SAAS;gBACT,UAAU,EAAE,IAAI;aACjB,CAAC;YAEF,MAAM,IAAI,GACR,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,YAAY,CAAC;gBAC/C,CAAC,CAAC,cAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAErD,OAAO;gBACL,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,QAAQ,EAAE,qBAAqB;wBAC/B,IAAI,EAAE,IAAI;qBACX;iBACF;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,MAAM,QAAQ,GAAa;YACzB,GAAG,UAAU,CAAC,KAAK;YACnB,uBAAuB,EAAE,GAAG;SAC7B,CAAC;QAEF,IAAI,CAAC,YAAY,CACf,IAAI,EACJ;YACE,GAAG,UAAU;YACb,KAAK,EAAE,QAAQ;SAChB,EACD,YAAY,CACb,CAAC;IACJ,CAAC;CACF"}

package/dist/src/server/templateHelper.d.ts

@@ -0,0 +1,14 @@
+type TemplateData = {
+    serverUrl: string;
+    widgetName: string;
+};
+declare class TemplateHelper {
+    private templateCache;
+    private loadTemplate;
+    renderProduction(data: TemplateData): string;
+    renderDevelopment(data: TemplateData): string;
+    renderViteClient(data: TemplateData): string;
+    injectViteClient(html: string, data: TemplateData): string;
+}
+export declare const templateHelper: TemplateHelper;
+export {};

package/dist/src/server/templateHelper.js

@@ -0,0 +1,37 @@
+import Handlebars from "handlebars";
+import { readFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+class TemplateHelper {
+    templateCache = new Map();
+    loadTemplate(templateName) {
+        if (this.templateCache.has(templateName)) {
+            return this.templateCache.get(templateName);
+        }
+        const templatePath = join(__dirname, "templates", `${templateName}.hbs`);
+        const templateSource = readFileSync(templatePath, "utf-8");
+        const template = Handlebars.compile(templateSource);
+        this.templateCache.set(templateName, template);
+        return template;
+    }
+    renderProduction(data) {
+        const template = this.loadTemplate("production");
+        return template(data);
+    }
+    renderDevelopment(data) {
+        const template = this.loadTemplate("development");
+        return template(data);
+    }
+    renderViteClient(data) {
+        const template = this.loadTemplate("vite-client");
+        return template(data);
+    }
+    injectViteClient(html, data) {
+        const viteClientScript = this.renderViteClient(data);
+        return viteClientScript + html;
+    }
+}
+export const templateHelper = new TemplateHelper();
+//# sourceMappingURL=templateHelper.js.map

package/dist/src/server/templateHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateHelper.js","sourceRoot":"","sources":["../../../src/server/templateHelper.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAOtC,MAAM,cAAc;IACV,aAAa,GAAG,IAAI,GAAG,EAAsC,CAAC;IAE9D,YAAY,CAAC,YAAoB;QACvC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAE,CAAC;QAC/C,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,YAAY,MAAM,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB,CAAC,IAAkB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,iBAAiB,CAAC,IAAkB;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,gBAAgB,CAAC,IAAkB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,gBAAgB,CAAC,IAAY,EAAE,IAAkB;QAC/C,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,gBAAgB,GAAG,IAAI,CAAC;IACjC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC"}

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/server/widgetsDevServer.d.ts

@@ -0,0 +1,12 @@
+import { type RequestHandler } from "express";
+/**
+ * Install Vite dev server
+ * This router MUST be installed at the application root, like so:
+ *
+ *  const app = express();
+ *
+ * if (env.NODE_ENV !== "production") {
+ *   app.use(await widgetsRouter());
+ * }
+ */
+export declare const widgetsDevServer: () => Promise<RequestHandler>;

package/dist/src/server/widgetsDevServer.js

@@ -0,0 +1,39 @@
+import express, {} from "express";
+import cors from "cors";
+import path from "node:path";
+/**
+ * Install Vite dev server
+ * This router MUST be installed at the application root, like so:
+ *
+ *  const app = express();
+ *
+ * if (env.NODE_ENV !== "production") {
+ *   app.use(await widgetsRouter());
+ * }
+ */
+export const widgetsDevServer = async () => {
+    const router = express.Router();
+    const { createServer, searchForWorkspaceRoot, loadConfigFromFile } = await import("vite");
+    const workspaceRoot = searchForWorkspaceRoot(process.cwd());
+    const webAppRoot = path.join(workspaceRoot, "web");
+    const configResult = await loadConfigFromFile({ command: "serve", mode: "development" }, path.join(webAppRoot, "vite.config.ts"), webAppRoot);
+    // Remove build-specific options that don't apply to dev server
+    const { build, preview, ...devConfig } = configResult?.config || {};
+    const vite = await createServer({
+        ...devConfig,
+        configFile: false, // Keep this to prevent vite from trying to resolve path in the target config file
+        appType: "custom",
+        server: {
+            allowedHosts: true,
+            middlewareMode: true,
+        },
+        root: webAppRoot,
+        optimizeDeps: {
+            include: ["react", "react-dom/client"],
+        },
+    });
+    router.use(cors());
+    router.use("/", vite.middlewares);
+    return router;
+};
+//# sourceMappingURL=widgetsDevServer.js.map

package/dist/src/server/widgetsDevServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widgetsDevServer.js","sourceRoot":"","sources":["../../../src/server/widgetsDevServer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAuB,MAAM,SAAS,CAAC;AACvD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,IAA6B,EAAE;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAEhC,MAAM,EAAE,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,GAChE,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;IACvB,MAAM,aAAa,GAAG,sBAAsB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IAEnD,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAC3C,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EACzC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,EACvC,UAAU,CACX,CAAC;IAEF,+DAA+D;IAC/D,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,YAAY,EAAE,MAAM,IAAI,EAAE,CAAC;IAEpE,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC;QAC9B,GAAG,SAAS;QACZ,UAAU,EAAE,KAAK,EAAE,kFAAkF;QACrG,OAAO,EAAE,QAAQ;QACjB,MAAM,EAAE;YACN,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;SACrB;QACD,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE;YACZ,OAAO,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC;SACvC;KACF,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACnB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAElC,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/src/test/setup.d.ts

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

package/dist/src/test/setup.js

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

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

@@ -0,0 +1,28 @@
+import { type MockInstance } from "vitest";
+import { McpServer } from "../server/server.js";
+/**
+ * Creates a real McpServer instance for testing
+ */
+export declare function createMockMcpServer(): {
+    server: McpServer;
+    mockResource: MockInstance<McpServer["resource"]>;
+    mockRegisterTool: MockInstance<McpServer["registerTool"]>;
+};
+/**
+ * Mock extra parameter for resource callback
+ */
+export declare function createMockExtra(host: string): {
+    requestInfo: {
+        headers: {
+            host: string;
+        };
+    };
+};
+/**
+ * Sets up environment variables for testing
+ */
+export declare function setTestEnv(env: Record<string, string>): void;
+/**
+ * Resets environment variables
+ */
+export declare function resetTestEnv(): void;

package/dist/src/test/utils.js

@@ -0,0 +1,43 @@
+import { vi } from "vitest";
+import { McpServer, McpServer as McpServerBase } from "../server/server.js";
+/**
+ * Creates a real McpServer instance for testing
+ */
+export function createMockMcpServer() {
+    // Create a real McpServer instance
+    const server = new McpServer({
+        name: "alpic-openai-app",
+        version: "0.0.1",
+    }, { capabilities: {} });
+    // Mock the underlying methods to track calls
+    const mockResource = vi.spyOn(server, "resource");
+    const mockRegisterTool = vi.spyOn(server, "registerTool");
+    return {
+        server,
+        mockResource,
+        mockRegisterTool,
+    };
+}
+/**
+ * Mock extra parameter for resource callback
+ */
+export function createMockExtra(host) {
+    return {
+        requestInfo: {
+            headers: { host },
+        },
+    };
+}
+/**
+ * Sets up environment variables for testing
+ */
+export function setTestEnv(env) {
+    Object.assign(process.env, env);
+}
+/**
+ * Resets environment variables
+ */
+export function resetTestEnv() {
+    delete process.env.NODE_ENV;
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/test/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAqB,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAE5E;;GAEG;AACH,MAAM,UAAU,mBAAmB;IAKjC,mCAAmC;IACnC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,OAAO;KACjB,EACD,EAAE,YAAY,EAAE,EAAE,EAAE,CACrB,CAAC;IAEF,6CAA6C;IAC7C,MAAM,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClD,MAAM,gBAAgB,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE1D,OAAO;QACL,MAAM;QACN,YAAY;QACZ,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,EAAE,IAAI,EAAE;SAClB;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAA2B;IACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC9B,CAAC"}

package/dist/src/test/widget.test.d.ts

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

package/dist/src/test/widget.test.js

@@ -0,0 +1,69 @@
+import { describe, it, expect, vi, beforeEach, afterEach, } from "vitest";
+import { McpServer } from "../server/server.js";
+import { createMockMcpServer, createMockExtra, setTestEnv, resetTestEnv, } from "./utils.js";
+describe("McpServer.widget", () => {
+    let server;
+    let mockResource;
+    let mockRegisterTool;
+    beforeEach(() => {
+        ({ server, mockResource, mockRegisterTool } = createMockMcpServer());
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+        resetTestEnv();
+    });
+    it("should generate correct HTML for development mode", async () => {
+        setTestEnv({ NODE_ENV: "development" });
+        const mockToolCallback = vi.fn();
+        const mockResourceConfig = { description: "Test widget" };
+        const mockToolConfig = { description: "Test tool" };
+        server.widget("my-widget", mockResourceConfig, mockToolConfig, mockToolCallback);
+        // Get the resource callback function
+        const resourceCallback = mockResource.mock.calls[0]?.[3];
+        expect(resourceCallback).toBeDefined();
+        const serverUrl = "http://localhost:3000";
+        const mockExtra = createMockExtra("__not_used__");
+        const result = await resourceCallback(new URL("ui://widgets/my-widget.html"), mockExtra);
+        expect(result).toEqual({
+            contents: [
+                {
+                    uri: "ui://widgets/my-widget.html",
+                    mimeType: "text/html+skybridge",
+                    text: expect.stringContaining('<div id="root"></div>'),
+                },
+            ],
+        });
+        // Check development-specific content
+        expect(result.contents[0]?.text).toContain(serverUrl + "/@react-refresh");
+        expect(result.contents[0]?.text).toContain(serverUrl + "/@vite/client");
+        expect(result.contents[0]?.text).toContain(serverUrl + "/src/widgets/my-widget.tsx");
+    });
+    it("should generate correct HTML for production mode", async () => {
+        setTestEnv({ NODE_ENV: "production" });
+        const mockToolCallback = vi.fn();
+        const mockResourceConfig = { description: "Test widget" };
+        const mockToolConfig = { description: "Test tool" };
+        server.widget("my-widget", mockResourceConfig, mockToolConfig, mockToolCallback);
+        // Get the resource callback function
+        const resourceCallback = mockResource.mock.calls[0]?.[3];
+        expect(resourceCallback).toBeDefined();
+        const serverUrl = "https://myapp.com";
+        const mockExtra = createMockExtra(serverUrl);
+        const result = await resourceCallback(new URL("ui://widgets/my-widget.html"), mockExtra);
+        expect(result).toEqual({
+            contents: [
+                {
+                    uri: "ui://widgets/my-widget.html",
+                    mimeType: "text/html+skybridge",
+                    text: expect.stringContaining('<div id="root"></div>'),
+                },
+            ],
+        });
+        // Check production-specific content
+        expect(result.contents[0]?.text).not.toContain(serverUrl + "@react-refresh");
+        expect(result.contents[0]?.text).not.toContain(serverUrl + "@vite/client");
+        expect(result.contents[0]?.text).toContain(serverUrl + "/assets/my-widget.js");
+        expect(result.contents[0]?.text).toContain(serverUrl + "/assets/style.css");
+    });
+});
+//# sourceMappingURL=widget.test.js.map

package/dist/src/test/widget.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.test.js","sourceRoot":"","sources":["../../../src/test/widget.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,UAAU,EACV,YAAY,GACb,MAAM,YAAY,CAAC;AAEpB,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,MAAiB,CAAC;IACtB,IAAI,YAAiD,CAAC;IACtD,IAAI,gBAAyD,CAAC;IAE9D,UAAU,CAAC,GAAG,EAAE;QACd,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,mBAAmB,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,YAAY,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,UAAU,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QAExC,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,kBAAkB,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAC1D,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,MAAM,CACX,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAG/C,CAAC;QACT,MAAM,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAEvC,MAAM,SAAS,GAAG,uBAAuB,CAAC;QAC1C,MAAM,SAAS,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,IAAI,GAAG,CAAC,6BAA6B,CAAC,EACtC,SAAS,CACV,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,6BAA6B;oBAClC,QAAQ,EAAE,qBAAqB;oBAC/B,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;iBACvD;aACF;SACF,CAAC,CAAC;QAEH,qCAAqC;QACrC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,GAAG,iBAAiB,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,GAAG,eAAe,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,SAAS,GAAG,4BAA4B,CACzC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,UAAU,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;QAEvC,MAAM,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,kBAAkB,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAC1D,MAAM,cAAc,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAEpD,MAAM,CAAC,MAAM,CACX,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,gBAAgB,CACjB,CAAC;QAEF,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAG/C,CAAC;QACT,MAAM,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAEvC,MAAM,SAAS,GAAG,mBAAmB,CAAC;QACtC,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,gBAAiB,CACpC,IAAI,GAAG,CAAC,6BAA6B,CAAC,EACtC,SAAS,CACV,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,6BAA6B;oBAClC,QAAQ,EAAE,qBAAqB;oBAC/B,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;iBACvD;aACF;SACF,CAAC,CAAC;QAEH,oCAAoC;QACpC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAC5C,SAAS,GAAG,gBAAgB,CAC7B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CACxC,SAAS,GAAG,sBAAsB,CACnC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,GAAG,mBAAmB,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

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

@@ -0,0 +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,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/mount-widget.d.ts

@@ -0,0 +1 @@
+export declare const mountWidget: (component: React.ReactNode) => void;

package/dist/src/web/mount-widget.js

@@ -0,0 +1,14 @@
+import { createElement, StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+let rootInstance = null;
+export const mountWidget = (component) => {
+    const rootElement = document.getElementById("root");
+    if (!rootElement) {
+        throw new Error("Root element not found");
+    }
+    if (!rootInstance) {
+        rootInstance = createRoot(rootElement);
+    }
+    rootInstance.render(createElement(StrictMode, null, component));
+};
+//# sourceMappingURL=mount-widget.js.map

package/dist/src/web/mount-widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount-widget.js","sourceRoot":"","sources":["../../../src/web/mount-widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AAEzD,IAAI,YAAY,GAAgB,IAAI,CAAC;AAErC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAA0B,EAAE,EAAE;IACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACpD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC"}

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

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