sunpeak 0.2.6 → 0.3.3

package/dist/index.d.ts

@@ -1,366 +1,5 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as React from 'react';
-import { SetStateAction } from 'react';
-import { ClassValue } from 'clsx';
-
-type Theme$1 = "light" | "dark";
-type ThemeProviderProps = {
-    children: React.ReactNode;
-    defaultTheme?: Theme$1;
-    theme?: Theme$1;
-};
-type ThemeProviderState = {
-    theme: Theme$1;
-};
-declare function ThemeProvider({ children, defaultTheme, theme: controlledTheme, ...props }: ThemeProviderProps): react_jsx_runtime.JSX.Element;
-declare const useThemeContext: () => ThemeProviderState;
-
-type UnknownObject = Record<string, unknown>;
-type Theme = 'light' | 'dark';
-type SafeAreaInsets = {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-};
-type SafeArea = {
-    insets: SafeAreaInsets;
-};
-type DeviceType = 'mobile' | 'tablet' | 'desktop' | 'unknown';
-type UserAgent = {
-    device: {
-        type: DeviceType;
-    };
-    capabilities: {
-        hover: boolean;
-        touch: boolean;
-    };
-};
-type DisplayMode = 'pip' | 'inline' | 'fullscreen';
-type RequestDisplayMode = (args: {
-    mode: DisplayMode;
-}) => Promise<{
-    mode: DisplayMode;
-}>;
-type ViewMode = 'modal' | 'default';
-type View = {
-    mode: ViewMode;
-    params?: UnknownObject;
-};
-type CallToolResponse = {
-    result: string;
-};
-type CallTool = (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
-type OpenAiGlobals<ToolInput = UnknownObject, ToolOutput = UnknownObject, ToolResponseMetadata = UnknownObject, WidgetState = UnknownObject> = {
-    theme: Theme;
-    userAgent: UserAgent;
-    locale: string;
-    maxHeight: number;
-    displayMode: DisplayMode;
-    safeArea: SafeArea;
-    view: View | null;
-    toolInput: ToolInput;
-    toolOutput: ToolOutput | null;
-    toolResponseMetadata: ToolResponseMetadata | null;
-    widgetState: WidgetState | null;
-    setWidgetState: (state: WidgetState) => Promise<void>;
-};
-type RequestModal = (args: {
-    mode: ViewMode;
-    params?: UnknownObject;
-}) => Promise<void>;
-type NotifyIntrinsicHeight = (height: number) => void;
-type OpenAiAPI = {
-    callTool: CallTool;
-    sendFollowUpMessage: (args: {
-        prompt: string;
-    }) => Promise<void>;
-    openExternal(payload: {
-        href: string;
-    }): void;
-    requestDisplayMode: RequestDisplayMode;
-    requestModal: RequestModal;
-    notifyIntrinsicHeight: NotifyIntrinsicHeight;
-};
-declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
-declare class SetGlobalsEvent extends CustomEvent<{
-    globals: Partial<OpenAiGlobals>;
-}> {
-    readonly type = "openai:set_globals";
-}
-declare global {
-    interface Window {
-        openai: OpenAiAPI & OpenAiGlobals;
-    }
-    interface WindowEventMap {
-        [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
-    }
-}
-
-/**
- * Provider-agnostic types for widget runtime environments.
- * These types abstract away the specific host (OpenAI/ChatGPT, etc.)
- */
-
-/**
- * Global state available from the widget runtime environment.
- * This is a provider-agnostic alias for OpenAiGlobals.
- */
-type WidgetGlobals<ToolInput = UnknownObject, ToolOutput = UnknownObject, ToolResponseMetadata = UnknownObject, WidgetState = UnknownObject> = {
-    theme: Theme;
-    userAgent: UserAgent;
-    locale: string;
-    maxHeight: number;
-    displayMode: DisplayMode;
-    safeArea: SafeArea;
-    view: View | null;
-    toolInput: ToolInput;
-    toolOutput: ToolOutput | null;
-    toolResponseMetadata: ToolResponseMetadata | null;
-    widgetState: WidgetState | null;
-    setWidgetState: (state: WidgetState) => Promise<void>;
-};
-/**
- * API methods available from the widget runtime environment.
- * This is a provider-agnostic alias for OpenAiAPI.
- */
-type WidgetAPI = {
-    callTool?: (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
-    sendFollowUpMessage?: (args: {
-        prompt: string;
-    }) => Promise<void>;
-    openExternal?: (payload: {
-        href: string;
-    }) => void;
-    requestDisplayMode?: (args: {
-        mode: DisplayMode;
-    }) => Promise<{
-        mode: DisplayMode;
-    }>;
-    requestModal?: (args: {
-        mode: ViewMode;
-        params?: UnknownObject;
-    }) => Promise<void>;
-    notifyIntrinsicHeight?: (height: number) => void;
-    setWidgetState?: (state: UnknownObject) => Promise<void>;
-};
-/**
- * Provider interface that abstracts the widget runtime environment.
- * Each host (OpenAI, etc.) implements this interface.
- */
-interface WidgetProvider {
-    /**
-     * Unique identifier for the provider.
-     */
-    readonly id: string;
-    /**
-     * Get the current value of a global property.
-     */
-    getGlobal<K extends keyof WidgetGlobals>(key: K): WidgetGlobals[K] | null;
-    /**
-     * Subscribe to changes for a specific global property.
-     * Returns an unsubscribe function.
-     */
-    subscribe(key: keyof WidgetGlobals, onChange: () => void): () => void;
-    /**
-     * Get the API methods, or null if not available.
-     */
-    getAPI(): WidgetAPI | null;
-}
-
-/**
- * OpenAI/ChatGPT provider implementation.
- * Bridges the OpenAI-specific window.openai API to the provider-agnostic interface.
- */
-
-/**
- * Check if the OpenAI provider is available.
- */
-declare function isOpenAiAvailable(): boolean;
-/**
- * OpenAI provider implementation.
- */
-declare class OpenAiProvider implements WidgetProvider {
-    readonly id = "openai";
-    getGlobal<K extends keyof WidgetGlobals>(key: K): WidgetGlobals[K] | null;
-    subscribe(key: keyof WidgetGlobals, onChange: () => void): () => void;
-    getAPI(): WidgetAPI | null;
-}
-/**
- * Get the OpenAI provider instance (singleton).
- */
-declare function getOpenAiProvider(): OpenAiProvider;
-
-/**
- * Provider detection and routing.
- *
- * This module automatically detects which widget runtime environment is available
- * and provides the appropriate provider. The detection happens once on first access,
- * and subsequent calls return the cached provider directly.
- */
-
-/**
- * Detect and return the appropriate provider for the current environment.
- * This function caches the result, so detection only happens once.
- *
- * @returns The detected provider, or null if no provider is available.
- */
-declare function getProvider(): WidgetProvider | null;
-/**
- * Check if any provider is available.
- */
-declare function isProviderAvailable(): boolean;
-/**
- * Get a global value from the detected provider.
- *
- * @param key - The global property key to retrieve.
- * @returns The value, or null if not available.
- */
-declare function getGlobal<K extends keyof WidgetGlobals>(key: K): WidgetGlobals[K] | null;
-/**
- * Subscribe to changes for a global property.
- *
- * @param key - The global property key to subscribe to.
- * @param onChange - Callback to invoke when the value changes.
- * @returns An unsubscribe function.
- */
-declare function subscribeToGlobal(key: keyof WidgetGlobals, onChange: () => void): () => void;
-/**
- * Get the API from the detected provider.
- *
- * @returns The API object, or null if not available.
- */
-declare function getAPI(): WidgetAPI | null;
-/**
- * Reset the provider detection cache.
- * Useful for testing or when the environment changes.
- */
-declare function resetProviderCache(): void;
-
-/**
- * Hook to read and subscribe to a global property from the widget runtime.
- * Automatically detects and uses the appropriate provider (OpenAI, etc.).
- *
- * @param key - The global property key to read.
- * @returns The current value, or null if not available.
- */
-declare function useWidgetGlobal<K extends keyof WidgetGlobals>(key: K): WidgetGlobals[K] | null;
-
-/**
- * Hook to get the widget runtime API.
- * Automatically detects and uses the appropriate provider (OpenAI, etc.).
- *
- * @returns The API object, or null if not available.
- */
-declare function useWidgetAPI(): WidgetAPI | null;
-
-type ScreenWidth = 'mobile-s' | 'mobile-l' | 'tablet' | 'full';
-type SimulatorConfig = {
-    theme: Theme;
-    displayMode: DisplayMode;
-    screenWidth: ScreenWidth;
-};
-declare const SCREEN_WIDTHS: Record<ScreenWidth, number>;
-
-declare const useDisplayMode: () => DisplayMode | null;
-
-declare const useLocale: () => string | null;
-
-declare const useMaxHeight: () => number | null;
-
-declare function useIsMobile(): boolean;
-
-declare const useSafeArea: () => SafeArea | null;
-
-declare const useTheme: () => Theme | null;
-
-declare function useToolInput<T extends UnknownObject = UnknownObject>(): T | null;
-
-declare function useToolResponseMetadata<T extends UnknownObject = UnknownObject>(): T | null;
-
-declare const useUserAgent: () => UserAgent | null;
-
-declare function useView(): View | null;
-
-declare function useWidgetProps<T extends Record<string, unknown>>(defaultState?: T | (() => T)): T;
-
-declare function useWidgetState<T extends UnknownObject>(defaultState: T | (() => T)): readonly [T, (state: SetStateAction<T>) => void];
-declare function useWidgetState<T extends UnknownObject>(defaultState?: T | (() => T | null) | null): readonly [T | null, (state: SetStateAction<T | null>) => void];
-
-interface ChatGPTSimulatorProps {
-    children: React.ReactNode;
-    appName?: string;
-    appIcon?: string;
-    userMessage?: string;
-    toolOutput?: Record<string, unknown> | null;
-    widgetState?: Record<string, unknown> | null;
-}
-declare function ChatGPTSimulator({ children, appName, appIcon, userMessage, toolOutput, widgetState, }: ChatGPTSimulatorProps): react_jsx_runtime.JSX.Element;
-
-declare class MockOpenAI implements OpenAiAPI, OpenAiGlobals {
-    theme: Theme;
-    userAgent: {
-        device: {
-            type: "desktop";
-        };
-        capabilities: {
-            hover: boolean;
-            touch: boolean;
-        };
-    };
-    locale: string;
-    maxHeight: number;
-    displayMode: DisplayMode;
-    safeArea: {
-        insets: {
-            top: number;
-            bottom: number;
-            left: number;
-            right: number;
-        };
-    };
-    view: View | null;
-    toolInput: Record<string, unknown>;
-    toolOutput: Record<string, unknown> | null;
-    toolResponseMetadata: Record<string, unknown> | null;
-    widgetState: Record<string, unknown> | null;
-    callTool(name: string, args: Record<string, unknown>): Promise<{
-        result: string;
-    }>;
-    sendFollowUpMessage(args: {
-        prompt: string;
-    }): Promise<void>;
-    openExternal(payload: {
-        href: string;
-    }): void;
-    requestDisplayMode(args: {
-        mode: DisplayMode;
-    }): Promise<{
-        mode: DisplayMode;
-    }>;
-    requestModal(args: {
-        mode: ViewMode;
-        params?: UnknownObject;
-    }): Promise<void>;
-    notifyIntrinsicHeight(height: number): void;
-    setWidgetState(state: Record<string, unknown>): Promise<void>;
-    setTheme(theme: Theme): void;
-    setDisplayMode(displayMode: DisplayMode): void;
-    setToolOutput(toolOutput: Record<string, unknown> | null): void;
-    setWidgetStateExternal(widgetState: Record<string, unknown> | null): void;
-    emitUpdate(globals: Partial<OpenAiGlobals>): void;
-}
-declare function initMockOpenAI(initialData?: {
-    theme?: Theme;
-    displayMode?: DisplayMode;
-    toolOutput?: Record<string, unknown> | null;
-    widgetState?: Record<string, unknown> | null;
-}): MockOpenAI;
-
-declare function cn(...inputs: ClassValue[]): string;
-
-declare const prefersReducedMotion: () => boolean;
-declare const isPrimarilyTouchDevice: () => boolean;
-declare const isHoverAvailable: () => boolean;
-
-export { type CallTool, type CallToolResponse, ChatGPTSimulator, type DeviceType, type DisplayMode, type NotifyIntrinsicHeight, type OpenAiAPI, type OpenAiGlobals, type RequestDisplayMode, type RequestModal, SCREEN_WIDTHS, SET_GLOBALS_EVENT_TYPE, type SafeArea, type SafeAreaInsets, type ScreenWidth, SetGlobalsEvent, type SimulatorConfig, type Theme, ThemeProvider, type UnknownObject, type UserAgent, type View, type ViewMode, type WidgetAPI, type WidgetGlobals, type WidgetProvider, cn, getAPI, getGlobal, getOpenAiProvider, getProvider, initMockOpenAI, isHoverAvailable, isOpenAiAvailable, isPrimarilyTouchDevice, isProviderAvailable, prefersReducedMotion, resetProviderCache, subscribeToGlobal, useDisplayMode, useIsMobile, useLocale, useMaxHeight, useSafeArea, useTheme, useThemeContext, useToolInput, useToolResponseMetadata, useUserAgent, useView, useWidgetAPI, useWidgetGlobal, useWidgetProps, useWidgetState };
+export * from './hooks';
+export * from './chatgpt';
+export * from './types';
+export * from './lib';
+export * from './providers';