@womp/openai-plugin 0.1.2 → 0.2.1

package/dist/index.d.ts

@@ -40,7 +40,17 @@ interface Build {
     title?: string;
     picture: Picture | null;
 }
+/**
+ * The design live in 3D, for the card to frame: a page on the host's own origin (the
+ * `liveViewOrigin` option) and when its key stops working. The URL carries a credential, so it goes to
+ * the card alone, never into text the model reads.
+ */
+interface LiveView {
+    url: string;
+    expiresAt: string;
+}
 interface WompBackend {
+    /** `live` is optional: a host that cannot offer a live view leaves it out and the card shows its picture. */
     openScene(subject: string, input: {
         designId?: string;
         title?: string;
@@ -48,6 +58,7 @@ interface WompBackend {
         designId: string;
         buildId: string;
         title: string;
+        live?: LiveView;
     }>;
     getSceneApi(): Promise<SceneApi>;
     runScript(subject: string, input: {
@@ -77,7 +88,13 @@ interface ServerOptions {
     subject?: string;
     onError?: (tool: string, error: unknown) => void;
     instructions?: string;
+    /**
+     * The one origin the card may frame for a live view, such as "https://app.womp.com". Without it the
+     * card allows no frames and `live` from the backend is ignored; an `http:` origin, a path or anything
+     * that is not an origin is the same as none.
+     */
+    liveViewOrigin?: string;
 }
-declare function createServer({ backend, subject, onError, instructions }: ServerOptions): McpServer;
+declare function createServer({ backend, subject, onError, instructions, liveViewOrigin }: ServerOptions): McpServer;
 
-export { BackendRefusal, type WompBackend, createServer };
+export { BackendRefusal, type LiveView, type WompBackend, createServer };