@simula/ads 1.2.0 → 1.3.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import React$1 from 'react';
 
 type AccentOption = 'blue' | 'red' | 'green' | 'yellow' | 'purple' | 'pink' | 'orange' | 'neutral' | 'gray' | 'tan' | 'transparent' | 'image';
 type FontOption = 'san-serif' | 'serif' | 'monospace';
-interface SimulaTheme {
+interface InChatTheme {
     mode?: 'light' | 'dark' | 'auto';
     theme?: 'light' | 'dark' | 'auto';
     accent?: AccentOption | AccentOption[];
@@ -32,12 +32,13 @@ interface AdData {
     id: string;
     format: string;
     iframeUrl?: string;
+    html?: string;
 }
 interface InChatAdSlotProps {
     messages: Message[];
     trigger?: Promise<any>;
     formats?: string | string[];
-    theme?: SimulaTheme;
+    theme?: InChatTheme;
     debounceMs?: number;
     charDesc?: string;
     onImpression?: (ad: AdData) => void;
@@ -49,11 +50,27 @@ interface SimulaProviderProps {
     children: React.ReactNode;
     devMode?: boolean;
     primaryUserID?: string;
+    /** Privacy consent flag. When false, suppresses collection of PII (primaryUserID). Defaults to true. */
+    hasPrivacyConsent?: boolean;
 }
 interface SimulaContextValue {
     apiKey: string;
     devMode: boolean;
     sessionId?: string;
+    /** Privacy consent flag. When false, PII should not be collected. */
+    hasPrivacyConsent: boolean;
+    /** Get cached ad for a slot/position */
+    getCachedAd: (slot: string, position: number) => AdData | null;
+    /** Cache an ad for a slot/position */
+    cacheAd: (slot: string, position: number, ad: AdData) => void;
+    /** Get cached height for a slot/position */
+    getCachedHeight: (slot: string, position: number) => number | null;
+    /** Cache height for a slot/position */
+    cacheHeight: (slot: string, position: number, height: number) => void;
+    /** Check if a slot/position has no fill */
+    hasNoFill: (slot: string, position: number) => boolean;
+    /** Mark a slot/position as having no fill */
+    markNoFill: (slot: string, position: number) => void;
 }
 interface BotDetectionResult {
     isBot: boolean;
@@ -82,12 +99,111 @@ interface ViewabilityResult {
     hasBeenViewed: boolean;
     impressionTracked: boolean;
 }
+interface MiniGameTheme {
+    backgroundColor?: string;
+    headerColor?: string;
+    borderColor?: string;
+    titleFont?: string;
+    secondaryFont?: string;
+    titleFontColor?: string;
+    secondaryFontColor?: string;
+    iconCornerRadius?: number;
+    /** Unified accent color for interactive elements (search bar focus, pagination). Default: '#3B82F6' (blue-500) */
+    accentColor?: string;
+    /**
+     * Controls the height of the Mini Game iframe (not the ad).
+     * - number: pixel value (e.g., 500 = 500px)
+     * - string with %: percentage of screen height (e.g., "80%")
+     * - undefined/null: full screen (default behavior)
+     * Minimum height is 500px.
+     */
+    playableHeight?: number | string;
+    /**
+     * Controls the background color of the curved border area above the playable
+     * when playableHeight is set (bottom sheet mode). Default: '#262626'
+     */
+    playableBorderColor?: string;
+}
+interface GameData {
+    id: string;
+    name: string;
+    iconUrl: string;
+    description: string;
+    iconFallback?: string;
+}
+interface MiniGameMenuProps {
+    isOpen: boolean;
+    onClose: () => void;
+    charName: string;
+    charID: string;
+    charImage: string;
+    messages?: Message[];
+    charDesc?: string;
+    maxGamesToShow?: 3 | 6 | 9;
+    theme?: MiniGameTheme;
+    delegateChar?: boolean;
+}
+interface NativeContext {
+    searchTerm?: string;
+    tags?: string[];
+    category?: string;
+    title?: string;
+    description?: string;
+    userProfile?: string;
+    /** User email (requires privacy consent) */
+    userEmail?: string;
+    /** NSFW content flag */
+    nsfw?: boolean;
+    customContext?: Record<string, string | string[]>;
+}
+/**
+ * Filter NativeContext for privacy - removes PII fields when consent is not granted.
+ * When hasPrivacyConsent is false, removes userEmail and userProfile.
+ */
+declare const filterContextForPrivacy: (context: NativeContext, hasPrivacyConsent: boolean) => NativeContext;
+interface NativeBannerProps {
+    slot: string;
+    /**
+     * Ad width. Supports multiple formats:
+     * - number < 1: percentage as decimal (e.g., 0.8 = 80%)
+     * - number >= 1: pixels (e.g., 500 = 500px)
+     * - string with %: percentage (e.g., "10%" = 10%)
+     * - string with number: pixels (e.g., "500" = 500px)
+     * - "auto" or null: fills container width (min 130px)
+     */
+    width?: number | string | null;
+    position: number;
+    context: NativeContext;
+    /**
+     * Custom loading component to display while the ad is loading.
+     * - undefined: uses the default RadialLinesSpinner
+     * - null: disables the loading indicator entirely
+     * - React.ComponentType: renders your custom component
+     */
+    loadingComponent?: React.ComponentType | null;
+    /** Called when the ad content has finished loading and is ready to display */
+    onLoad?: (ad: AdData) => void;
+    /** Called when the ad has been viewable for 1 second (MRC standard) */
+    onImpression?: (ad: AdData) => void;
+    /** Called when an error occurs fetching or loading the ad */
+    onError?: (error: Error) => void;
+}
 
 declare const useSimula: () => SimulaContextValue;
 declare const SimulaProvider: React$1.FC<SimulaProviderProps>;
 
 declare const InChatAdSlot: React$1.FC<InChatAdSlotProps>;
 
+declare const MiniGameMenu: React$1.FC<MiniGameMenuProps>;
+
+declare const NativeBanner: React$1.FC<NativeBannerProps>;
+
+/**
+ * Radial lines spinner component (matching Flutter SDK).
+ * Displays 12 radial lines that animate around a circle.
+ */
+declare const RadialLinesSpinner: React$1.FC;
+
 declare const useBotDetection: () => BotDetectionResult;
 
 declare const useViewability: (options?: ViewabilityOptions) => ViewabilityResult & {
@@ -139,5 +255,5 @@ declare const getBorderLight: (colors: ColorPalette) => string;
 declare const getShadow: (colors: ColorPalette) => string;
 declare const getFontStyles: (font?: string) => FontPalette;
 
-export { InChatAdSlot, SimulaProvider, fonts, getBackgroundGradient, getBorderLight, getColorTheme, getFontStyles, getShadow, getSolidBackground, getTextMuted, getTextSecondary, useBotDetection, useOMIDViewability, useSimula, useViewability };
-export type { AdData, BotDetectionResult, ColorPalette$1 as ColorPalette, FontPalette$1 as FontPalette, InChatAdSlotProps, Message, OMIDViewabilityOptions, OMIDViewabilityResult$1 as OMIDViewabilityResult, SimulaContextValue, SimulaProviderProps, SimulaTheme, ViewabilityOptions, ViewabilityResult };
+export { InChatAdSlot, MiniGameMenu, NativeBanner, RadialLinesSpinner, SimulaProvider, filterContextForPrivacy, fonts, getBackgroundGradient, getBorderLight, getColorTheme, getFontStyles, getShadow, getSolidBackground, getTextMuted, getTextSecondary, useBotDetection, useOMIDViewability, useSimula, useViewability };
+export type { AdData, BotDetectionResult, ColorPalette$1 as ColorPalette, FontPalette$1 as FontPalette, GameData, InChatAdSlotProps, InChatTheme, Message, MiniGameMenuProps, MiniGameTheme, NativeBannerProps, NativeContext, OMIDViewabilityOptions, OMIDViewabilityResult$1 as OMIDViewabilityResult, SimulaContextValue, SimulaProviderProps, ViewabilityOptions, ViewabilityResult };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGhE,OAAO,EACL,aAAa,EACb,aAAa,EACb,KAAK,EACL,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,SAAS,EACV,MAAM,qBAAqB,CAAC;AAI7B,YAAY,EACV,WAAW,EACX,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACZ,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wDAAwD,CAAC;AAC9F,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGhE,OAAO,EACL,aAAa,EACb,aAAa,EACb,KAAK,EACL,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,SAAS,EACV,MAAM,qBAAqB,CAAC;AAI7B,YAAY,EACV,WAAW,EACX,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,QAAQ,EACR,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,SAAS,CAAC"}