@waniwani/sdk 0.12.1 → 0.12.2

package/dist/legacy/index.d.ts

@@ -6,7 +6,7 @@ export { ZodRawShapeCompat } from '@modelcontextprotocol/sdk/server/zod-compat.j
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ContentBlock, CallToolResult } from '@modelcontextprotocol/sdk/types.js';
 import * as React$1 from 'react';
-import React__default, { ReactNode, SetStateAction } from 'react';
+import React__default, { ReactNode, JSX, SetStateAction } from 'react';
 import * as ai from 'ai';
 import { UIMessage } from 'ai';
 
@@ -528,6 +528,91 @@ type ModelContextUpdate = {
     structuredContent?: Record<string, unknown>;
 };
 
+interface SendFollowUpOptions {
+    modelContext?: ModelContextUpdate | null;
+}
+/**
+ * Get a function to send follow-up messages to the AI.
+ * Works on both OpenAI widgets and MCP Apps.
+ *
+ * @deprecated Legacy MCP-widget-in-host stack. Preserved for back-compat; will move to
+ *   `@waniwani/sdk/legacy/react` in a future minor release.
+ * @returns A function that sends a follow-up message
+ */
+declare function useSendFollowUp(): (prompt: string, options?: SendFollowUpOptions) => void;
+
+interface UnstableSendFollowUpWithGhostGuardResult {
+    /** Wrapped `sendFollowUp`. Same signature as the one you passed in. */
+    sendFollowUp: (prompt: string, options?: SendFollowUpOptions) => void;
+    /**
+     * Wrap your widget's root render with this so the suppression can take
+     * effect. On non-ChatGPT hosts it is a transparent pass-through.
+     */
+    Guard: (props: {
+        children: ReactNode;
+    }) => JSX.Element | null;
+}
+/**
+ * ⚠️ EXPERIMENTAL — DO NOT USE UNLESS YOU UNDERSTAND THE TRADE-OFFS ⚠️
+ *
+ * Wraps an existing `sendFollowUp` with ghost-guard suppression specific
+ * to ChatGPT. ChatGPT renders the source widget a SECOND time alongside
+ * the new user message a widget emits via `sendFollowUpMessage`. The
+ * second iframe is a brand-new React tree with no link to the original;
+ * skybridge's `useViewState` persistence does not survive across them.
+ * The result is a visible duplicate widget for ~1s before ChatGPT
+ * collapses one of them.
+ *
+ * On ChatGPT the hook adds a per-`viewUUID` `localStorage` write before
+ * each `sendFollowUp` call, and the returned `Guard` checks that record
+ * on mount — if it sees a record set by a different `mountId` within
+ * `ADVANCED_WINDOW_MS`, it collapses the iframe to 0×0.
+ *
+ * On every other host (WaniWani embed, MCP Apps, etc.) the hook is a
+ * pure pass-through: `sendFollowUp` is your function unchanged and
+ * `Guard` is a transparent fragment.
+ *
+ * The hook does NOT require `WidgetProvider`. It reads the widget's
+ * `viewUUID` from `WidgetClientContext` when one is available and falls
+ * back to `window.openai.toolResponseMetadata.viewUUID` otherwise.
+ *
+ * Caveats:
+ *  - Relies on ChatGPT's widget iframes sharing a single `localStorage`
+ *    scope — verified at the time of writing but not guaranteed.
+ *  - 10s suppression window per `viewUUID`. Two unrelated `sendFollowUp`
+ *    calls inside 10s with the same viewUUID could mistakenly suppress one.
+ *  - The `Guard` MUST wrap the widget's root render. If you forget it,
+ *    the localStorage write happens but nothing is suppressed.
+ *
+ * @param sendFollowUp - The underlying `sendFollowUp` to wrap. On ChatGPT the
+ *   hook adds the per-`viewUUID` localStorage write before delegating; on any
+ *   other host the hook is a pure pass-through. Typically the value of
+ *   `useSendFollowUpMessage()` from `skybridge/web` or `useSendFollowUp()`
+ *   from this module.
+ *
+ * @example
+ *   function MyWidget() {
+ *     const sendFollowUpMessage = useSendFollowUpMessage(); // skybridge/web
+ *     const { sendFollowUp, Guard } =
+ *       unstable_useSendFollowUpWithGhostGuard(sendFollowUpMessage);
+ *
+ *     // The Guard MUST wrap the widget's root render, otherwise the ghost
+ *     // iframe will not be suppressed.
+ *     return (
+ *       <Guard>
+ *         <div className="my-widget">
+ *           <button onClick={() => sendFollowUp("I uploaded my bill")}>
+ *             Continue
+ *           </button>
+ *         </div>
+ *       </Guard>
+ *     );
+ *   }
+ *
+ * @experimental Subject to change or removal without notice.
+ */
+declare function unstable_useSendFollowUpWithGhostGuard(sendFollowUp: (prompt: string) => void | Promise<void>): UnstableSendFollowUpWithGhostGuardResult;
+
 /**
  * Result from calling a tool
  */
@@ -786,19 +871,6 @@ declare function useRequestDisplayMode(): (mode: DisplayMode) => Promise<Display
  */
 declare function useSafeArea(): SafeArea | null;
 
-interface SendFollowUpOptions {
-    modelContext?: ModelContextUpdate | null;
-}
-/**
- * Get a function to send follow-up messages to the AI.
- * Works on both OpenAI widgets and MCP Apps.
- *
- * @deprecated Legacy MCP-widget-in-host stack. Preserved for back-compat; will move to
- *   `@waniwani/sdk/legacy/react` in a future minor release.
- * @returns A function that sends a follow-up message
- */
-declare function useSendFollowUp(): (prompt: string, options?: SendFollowUpOptions) => void;
-
 /**
  * Get the current theme.
  * Works on both OpenAI widgets and MCP Apps.
@@ -1351,4 +1423,4 @@ interface ChatCardProps extends ChatBaseProps {
  */
 declare const ChatCard: React$1.ForwardRefExoticComponent<ChatCardProps & React$1.RefAttributes<ChatHandle>>;
 
-export { ChatCard, type ChatCardProps, DevModeProvider, type DeviceType, type DisplayMode, type FlowActionResult, type HostContext, InitializeNextJsInIframe, LoadingWidget, type ModelContextContentBlock, type ModelContextUpdate, type NextJsHandlerOptions, type NextJsHandlerResult, type RegisteredResource, type RegisteredTool, type ResourceConfig, type SafeArea, type SafeAreaInsets, type SendFollowUpOptions, type Theme, type ToolCallResult, type ToolConfig, type ToolHandler, type ToolHandlerContext, type ToolResult, type ToolToolCallback, type UnifiedWidgetClient, type UnknownObject, type UserAgent, type WidgetCSP, type WidgetPlatform, WidgetProvider, createResource, createTool, detectPlatform, getMockState, initializeMockOpenAI, isMCPApps, isOpenAI, registerTools, toNextJsHandler, updateMockDisplayMode, updateMockGlobal, updateMockTheme, updateMockToolOutput, useCallTool, useDisplayMode, useFlowAction, useIsChatGptApp, useLocale, useMaxHeight, useOpenExternal, useRequestDisplayMode, useSafeArea, useSendFollowUp, useTheme, useToolOutput, useToolResponseMetadata, useUpdateModelContext, useWidgetClient, useWidgetState };
+export { ChatCard, type ChatCardProps, DevModeProvider, type DeviceType, type DisplayMode, type FlowActionResult, type HostContext, InitializeNextJsInIframe, LoadingWidget, type ModelContextContentBlock, type ModelContextUpdate, type NextJsHandlerOptions, type NextJsHandlerResult, type RegisteredResource, type RegisteredTool, type ResourceConfig, type SafeArea, type SafeAreaInsets, type SendFollowUpOptions, type Theme, type ToolCallResult, type ToolConfig, type ToolHandler, type ToolHandlerContext, type ToolResult, type ToolToolCallback, type UnifiedWidgetClient, type UnknownObject, type UnstableSendFollowUpWithGhostGuardResult, type UserAgent, type WidgetCSP, type WidgetPlatform, WidgetProvider, createResource, createTool, detectPlatform, getMockState, initializeMockOpenAI, isMCPApps, isOpenAI, registerTools, toNextJsHandler, unstable_useSendFollowUpWithGhostGuard, updateMockDisplayMode, updateMockGlobal, updateMockTheme, updateMockToolOutput, useCallTool, useDisplayMode, useFlowAction, useIsChatGptApp, useLocale, useMaxHeight, useOpenExternal, useRequestDisplayMode, useSafeArea, useSendFollowUp, useTheme, useToolOutput, useToolResponseMetadata, useUpdateModelContext, useWidgetClient, useWidgetState };