@billdog.io/react-native 1.0.0-beta.2

package/dist/survey-core/types.d.ts

@@ -0,0 +1,215 @@
+/**
+ * BDSurvey Types — Standalone survey SDK types
+ *
+ * These types are the canonical definitions for the BDSurvey system.
+ * The BillDog SDK re-exports these for backward compatibility.
+ */
+export type SurveyQuestionType = 'multiple_choice' | 'multi_select' | 'text' | 'rating' | 'nps' | 'boolean' | 'dropdown' | 'matrix' | 'ranking' | 'slider' | 'emoji' | 'thumbs' | 'link';
+export interface SurveyChoice {
+    id: string;
+    label: string;
+    value: string | null;
+    is_other: boolean;
+    choice_order: number;
+    image_url?: string | null;
+    metadata: Record<string, unknown>;
+}
+export type SurveyLogicOperator = 'equals' | 'not_equals' | 'contains' | 'is_any_of' | 'greater_than' | 'less_than';
+export interface SurveyLogicCondition {
+    operator: SurveyLogicOperator;
+    value?: string | number;
+    choice_id?: string;
+}
+export interface SurveyLogicRule {
+    id: string;
+    /**
+     * Single condition (legacy / simple rules). Retained for backward compatibility.
+     * When `conditions` is present and non-empty it takes precedence over `condition`.
+     */
+    condition?: SurveyLogicCondition;
+    /**
+     * Compound conditions (PostHog-parity, added). Combined per `condition_logic`.
+     * Evaluators prefer this over `condition` when present.
+     */
+    conditions?: SurveyLogicCondition[];
+    /** How to combine `conditions`. Defaults to 'and'. */
+    condition_logic?: 'and' | 'or';
+    action_type: 'skip_to_question' | 'skip_to_page' | 'end_survey';
+    target_id?: string;
+    rule_order: number;
+}
+export interface SurveyQuestion {
+    id: string;
+    type: SurveyQuestionType;
+    text: string;
+    description: string | null;
+    is_required: boolean;
+    question_order: number;
+    config: Record<string, unknown>;
+    settings: Record<string, unknown>;
+    choices: SurveyChoice[];
+    logic_rules?: SurveyLogicRule[];
+}
+export interface SurveyPage {
+    id: string;
+    title: string | null;
+    description: string | null;
+    page_order: number;
+    settings: Record<string, unknown>;
+    questions: SurveyQuestion[];
+}
+export interface SurveyMobileDisplayConfig {
+    displayStyle?: 'full_screen' | 'sheet' | 'push_navigation' | 'no_transition' | 'side_drawer' | 'overlay_popup';
+    allowScrolling?: boolean;
+    interceptBackButton?: boolean;
+    accessControl?: 'restricted' | 'unrestricted';
+    safeAreaInsets?: boolean;
+    sheetConfig?: {
+        heightPercent?: number;
+        cornerRadius?: number;
+    };
+    popupConfig?: {
+        widthPercent?: number;
+        heightPercent?: number;
+        cornerRadius?: number;
+    };
+    drawerConfig?: {
+        widthPercent?: number;
+        cornerRadius?: number;
+    };
+}
+export interface SurveyConfiguration {
+    id: string;
+    name: string;
+    description: string | null;
+    type: string;
+    settings: SurveySettings;
+    pages: SurveyPage[];
+    mobile_display?: SurveyMobileDisplayConfig;
+    version?: number;
+    variant_group?: string | null;
+    variant_name?: string | null;
+    should_show?: boolean;
+    presentation_percentage?: number;
+    /** Display/targeting conditions (PostHog-parity, added). */
+    display_conditions?: SurveyDisplayConditions;
+}
+/**
+ * Display/targeting conditions evaluated client-side before a survey is shown
+ * (PostHog-parity, added). All present conditions must pass (logical AND).
+ */
+export interface SurveyDisplayConditions {
+    /** Restrict to device categories. Empty/undefined = all devices. */
+    device_types?: SurveyDeviceType[];
+    /** Only show when a feature flag is enabled (optionally a specific variant). */
+    feature_flag?: {
+        key: string;
+        variant?: string | null;
+    };
+    /** Web/screen targeting: match the current URL/route. */
+    url_match?: {
+        operator: 'exact' | 'contains' | 'regex' | 'not_contains';
+        value: string;
+    };
+    /** Only show after an event fires during the session (optional property filters). */
+    event_trigger?: {
+        event_name: string;
+        property_filters?: Record<string, unknown>;
+    };
+    /** Delay before showing, in milliseconds. */
+    delay_ms?: number;
+    [key: string]: unknown;
+}
+export type SurveyDeviceType = 'phone' | 'tablet' | 'desktop' | 'tv' | 'watch';
+/**
+ * Recurrence/repeat policy (PostHog-parity, added).
+ * `show_once` is the legacy single-show flag; `recurring` supersedes it when enabled.
+ */
+export interface SurveyRecurrence {
+    enabled: boolean;
+    /** Maximum number of times the survey may be shown to a user. */
+    max_repeats?: number;
+    /** Minimum days between repeated showings. */
+    interval_days?: number;
+    /** Re-show every time the trigger event fires (ignores interval_days when true). */
+    on_every_trigger?: boolean;
+}
+export interface SurveySettings {
+    show_once?: boolean;
+    shuffle_options?: boolean;
+    /** Randomize question order (PostHog-parity, added). */
+    shuffle_questions?: boolean;
+    /** Recurring/repeat policy (PostHog-parity, added). */
+    recurring?: SurveyRecurrence;
+    /** Global wait period: don't show if the user saw ANY survey in the last N days (added). */
+    wait_period_days?: number;
+    presentation_percentage?: number;
+    locale?: string | null;
+    theme?: SurveyTheme;
+    thankYouMessage?: {
+        title: string;
+        body?: string | null;
+    } | null;
+    welcomeScreen?: {
+        title: string;
+        body?: string | null;
+        buttonText?: string | null;
+    } | null;
+    [key: string]: unknown;
+}
+export interface SurveyTheme {
+    primaryColor?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    borderRadius?: number;
+    fontFamily?: string;
+    [key: string]: unknown;
+}
+export interface SurveyAnswer {
+    question_id: string;
+    choice_id?: string | null;
+    answer_text?: string | null;
+    answer_number?: number | null;
+    answer_json?: Record<string, unknown> | null;
+}
+export interface SurveyContext {
+    customer_id?: string;
+    anonymous_id?: string;
+    platform?: string;
+    session_id?: string;
+    device_info?: Record<string, unknown>;
+    custom_variables?: Record<string, string>;
+    [key: string]: unknown;
+}
+export interface SurveySubmitResult {
+    respondent_id: string;
+    survey_id: string;
+    status: string;
+    /** Submitted answers — included so host apps can implement conditional post-submit flows */
+    answers?: SurveyAnswer[];
+}
+export interface SurveyPresentationOptions {
+    customerId?: string;
+    anonymousId?: string;
+    platform?: string;
+    customVariables?: Record<string, string>;
+    onPresent?: (surveyId: string) => void;
+    onDismiss?: (surveyId: string) => void;
+    onComplete?: (surveyId: string, result: SurveySubmitResult) => void;
+    onError?: (error: Error) => void;
+    onAnswerChanged?: (answer: SurveyAnswer) => void;
+}
+export interface SurveyCacheEntry {
+    config: SurveyConfiguration;
+    fetchedAt: number;
+}
+export interface SurveyListItem {
+    id: string;
+    name: string;
+    description: string | null;
+    type: string;
+    status: string;
+}
+export interface SurveyListResult {
+    surveys: SurveyListItem[];
+}

package/dist/survey-core/types.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * BDSurvey Types — Standalone survey SDK types
+ *
+ * These types are the canonical definitions for the BDSurvey system.
+ * The BillDog SDK re-exports these for backward compatibility.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,438 @@
+/**
+ * Type definitions matching the web PaywallComponent structure
+ */
+export type ComponentType = 'text' | 'image' | 'button' | 'stack' | 'feature-list' | 'price' | 'badge' | 'divider' | 'spacer' | 'icon' | 'video' | 'carousel' | 'tabs' | 'footer' | 'social-proof' | 'progress-loader' | 'chart-curve' | 'single-choice-grid' | 'multi-choice-grid' | 'checkbox' | 'toggle' | 'segmented-picker' | 'countdown' | 'accordion' | 'accordion-header' | 'slider' | 'navigation' | 'confetti' | 'delayed-x' | 'haptic-feedback' | 'shape' | 'webp' | 'gif' | 'lottie' | 'drawer-modal' | 'timeline' | 'text-input' | 'star-rating-input' | 'nps-scale' | 'oauth-button' | 'progress-stepper' | 'share-code' | 'share-buttons' | 'vertical-products' | 'horizontal-products' | 'accolade-cps' | 'sticker-composite';
+/** Carousel transition animation types */
+export type CarouselTransition = 'scroll' | 'fade' | 'slide' | 'push' | 'none';
+export type NotificationChannel = 'push' | 'email' | 'sms' | 'live_activity';
+export type LayoutType = 'fill' | 'fixed' | 'hug' | 'fit';
+/** Size value as exported by web builder */
+export interface SizeValue {
+    type: 'fill' | 'fixed' | 'fit' | 'hug';
+    value?: number;
+}
+export interface Size {
+    width: SizeValue | number | string;
+    height: SizeValue | number | string;
+}
+export interface Position {
+    x: number;
+    y: number;
+}
+export interface Layout {
+    width?: LayoutType;
+    height?: LayoutType;
+    padding?: {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+    margin?: {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+}
+/** Gradient stop definition */
+export interface GradientStop {
+    color: string;
+    position: number;
+    resolvedColor?: string;
+}
+/** Gradient configuration */
+export interface GradientConfig {
+    type: 'linear' | 'radial';
+    angle?: number;
+    stops: GradientStop[];
+}
+/** Image fill configuration */
+export interface ImageFillConfig {
+    url: string;
+    fit?: 'fill' | 'fit' | 'stretch' | 'tile';
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+}
+/** Fill value from web builder (source of truth) */
+export type FillValue = string | {
+    type: 'color' | 'gradient' | 'image';
+    color?: string;
+    /** Pre-resolved hex color from the web exporter */
+    resolvedColor?: string;
+    opacity?: number;
+    gradient?: GradientConfig;
+    image?: ImageFillConfig;
+};
+/** Background color object (SDK-compatible format from web exporter) */
+export interface BackgroundColorObject {
+    type: 'color' | 'gradient' | 'image';
+    color?: string;
+    resolvedColor?: string;
+    opacity?: number;
+    gradient?: GradientConfig;
+}
+/** Background color can be a string or complex object from web builder */
+export type BackgroundColorValue = string | {
+    type: 'color' | 'gradient' | 'image';
+    color?: string;
+    opacity?: number;
+    resolvedColor?: string;
+    gradient?: {
+        type: 'linear' | 'radial';
+        angle?: number;
+        stops: Array<{
+            color: string;
+            position: number;
+            resolvedColor?: string;
+        }>;
+    };
+    imageUrl?: string;
+};
+export interface Appearance {
+    /** Original fill value from web builder (source of truth) */
+    fill?: FillValue;
+    /** Pre-resolved background color string for SDK compatibility */
+    backgroundColor?: BackgroundColorValue;
+    /** Structured background color object for gradients */
+    backgroundColorObj?: BackgroundColorObject;
+    borderColor?: string | {
+        type: string;
+        color?: string;
+        resolvedColor?: string;
+    };
+    /** Pre-resolved hex border color from the web exporter */
+    borderColorResolved?: string;
+    borderWidth?: number;
+    borderRadius?: number;
+    cornerRadius?: number;
+    opacity?: number;
+    shape?: 'rectangle' | 'pill' | 'circle';
+    transform?: Transform;
+    border?: Border;
+    shadow?: Shadow;
+    borderBottom?: LegacyBorderSide;
+    borderTop?: LegacyBorderSide;
+    borderLeft?: LegacyBorderSide;
+    borderRight?: LegacyBorderSide;
+}
+/**
+ * Get effective background color from appearance
+ * Priority: fill.color → backgroundColorObj.resolvedColor → backgroundColor
+ */
+export declare function getEffectiveBackgroundColor(appearance: Appearance): string | undefined;
+/**
+ * Check if appearance has a gradient background
+ */
+export declare function hasGradientBackground(appearance: Appearance): boolean;
+/**
+ * Get gradient config from appearance
+ */
+export declare function getGradientConfig(appearance: Appearance): GradientConfig | undefined;
+/** Text color object for structured text styling */
+export interface TextColorObject {
+    type: 'color' | 'gradient';
+    color?: string;
+    resolvedColor?: string;
+    gradient?: GradientConfig;
+}
+/** Typography configuration for text components */
+export interface Typography {
+    fontFamily?: string;
+    fontSize?: number;
+    fontWeight?: number;
+    fontStyle?: 'normal' | 'italic';
+    lineHeight?: number;
+    letterSpacing?: number;
+    textAlign?: 'left' | 'center' | 'right' | 'justify';
+    textDecoration?: 'none' | 'underline' | 'line-through';
+    textTransform?: 'none' | 'uppercase' | 'lowercase' | 'capitalize';
+    color?: string;
+    resolvedColor?: string;
+    textColorObj?: TextColorObject;
+}
+/** Transform configuration for component transformations */
+export interface Transform {
+    rotation?: number;
+    rotationX?: number;
+    rotationY?: number;
+    scaleX?: number;
+    scaleY?: number;
+    translateX?: number;
+    translateY?: number;
+    skewX?: number;
+    skewY?: number;
+    anchorX?: number;
+    anchorY?: number;
+}
+/** Border side configuration */
+export interface BorderSide {
+    width?: number;
+    color?: string;
+    resolvedColor?: string;
+    style?: 'solid' | 'dashed' | 'dotted' | 'none';
+}
+/** Border radius configuration */
+export interface BorderRadius {
+    topLeft?: number;
+    topRight?: number;
+    bottomLeft?: number;
+    bottomRight?: number;
+    uniform?: number;
+}
+/** Border configuration */
+export interface Border {
+    width?: number;
+    color?: string;
+    resolvedColor?: string;
+    style?: 'solid' | 'dashed' | 'dotted' | 'none';
+    top?: BorderSide;
+    right?: BorderSide;
+    bottom?: BorderSide;
+    left?: BorderSide;
+    radius?: BorderRadius;
+}
+/** Shadow configuration */
+export interface Shadow {
+    offsetX?: number;
+    offsetY?: number;
+    /** Legacy/web-builder aliases for offsetX/offsetY */
+    x?: number;
+    y?: number;
+    blur?: number;
+    spread?: number;
+    color?: string;
+    resolvedColor?: string;
+    opacity?: number;
+    inset?: boolean;
+}
+/** Legacy border side for appearance (backward compat) */
+export interface LegacyBorderSide {
+    color?: string;
+    width?: number;
+}
+/** Border configuration from web builder (root-level on component) */
+export interface BorderConfig {
+    color?: string;
+    /** Pre-resolved hex border color from the web exporter */
+    resolvedColor?: string;
+    width?: number;
+    style?: 'solid' | 'dashed' | 'dotted';
+    radius?: BorderRadius;
+}
+/** Get effective typography color */
+export declare function getEffectiveTypographyColor(typography: Typography): string | undefined;
+/** Check if transform has any transformation applied */
+export declare function hasTransform(transform: Transform): boolean;
+/** Get effective border color */
+export declare function getEffectiveBorderColor(border: Border): string | undefined;
+/** Get effective shadow color */
+export declare function getEffectiveShadowColor(shadow: Shadow): string | undefined;
+export interface ContainerLayout {
+    type?: 'row' | 'column' | 'grid' | 'wrap' | 'absolute';
+    axis?: 'horizontal' | 'vertical' | 'layered';
+    gap?: {
+        value: number;
+        unit: string;
+    } | number;
+    horizontalAlignment?: 'start' | 'center' | 'end' | 'stretch' | 'space-between';
+    verticalAlignment?: 'start' | 'center' | 'end' | 'stretch';
+    distribution?: string;
+    overflow?: string;
+    columns?: number;
+    rows?: number;
+}
+export interface PaywallComponent {
+    id: string;
+    type: ComponentType;
+    name: string;
+    componentLevel?: 'primitive' | 'composite' | 'custom';
+    isSnippet?: boolean;
+    shareStatus?: 'private' | 'public';
+    createdBy?: string;
+    snippetCategory?: string;
+    position: Position;
+    size: Size;
+    layout: Layout;
+    appearance: Appearance;
+    properties: Record<string, any>;
+    children?: PaywallComponent[];
+    visible?: boolean;
+    locked?: boolean;
+    border?: BorderConfig;
+    absolutePosition?: {
+        x: number;
+        y: number;
+    };
+    zIndex?: number;
+    compositeType?: string;
+    containerLayout?: ContainerLayout;
+    role?: string;
+    /** Selected state properties - mirrors the `properties` map structure */
+    selectedProperties?: Record<string, any>;
+    /** Selected state appearance - full appearance for selected state */
+    selectedAppearance?: Appearance;
+    /** Selected state layout - padding/margin for selected state */
+    selectedLayout?: Layout;
+    /** Selected state size - width/height for selected state */
+    selectedSize?: Size;
+    /** Selected state container layout - axis/gap/alignment for selected state */
+    selectedContainerLayout?: ContainerLayout;
+}
+export interface Product {
+    id: string;
+    product_identifier: string;
+    display_name: string;
+    description?: string;
+    type: string;
+    platform: string;
+    price_usd?: number;
+    currency?: string;
+    intro_price_usd?: number;
+    intro_duration?: number;
+    intro_period?: string;
+    intro_cycles?: number;
+}
+export interface OfferingPackage {
+    id: string;
+    package_identifier: string;
+    package_type?: string;
+    position: number;
+    metadata?: Record<string, any>;
+    product_id?: string;
+    product?: Product;
+}
+export type DisplayStyle = 'full_screen' | 'sheet' | 'push_navigation' | 'no_transition' | 'side_drawer' | 'overlay_popup';
+export type AccessControl = 'restricted' | 'unrestricted';
+export interface ScreenLayout {
+    alignment: 'start' | 'center' | 'end';
+    gap: number;
+    padding: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+    safeAreaInsets?: boolean;
+}
+export interface ControllerMapping {
+    upButton?: string;
+    downButton?: string;
+    selectButton?: string;
+    dismissButton?: string;
+}
+export interface MobileDisplayConfig {
+    displayStyle: DisplayStyle;
+    allowScrolling: boolean;
+    gameControllerEnabled: boolean;
+    controllerMapping?: ControllerMapping;
+    interceptBackButton: boolean;
+    accessControl: AccessControl;
+    requirements?: {
+        minIosVersion?: string;
+        minAndroidVersion?: string;
+        requiredFeatures?: string[];
+    };
+}
+export interface EmailPayload {
+    to: string;
+    subject: string;
+    html_body: string;
+    text_body?: string;
+    from?: string;
+    reply_to?: string;
+    notification_id?: string;
+}
+export interface SMSPayload {
+    to: string;
+    body: string;
+    from?: string;
+    notification_id?: string;
+}
+export interface LiveActivityPayload {
+    activity_token: string;
+    event: 'start' | 'update' | 'end';
+    content_state: Record<string, any>;
+    stale_date?: Date;
+    dismissal_date?: Date;
+    notification_id?: string;
+}
+/**
+ * Canonical theme colors — 26 fields matching paywall-renderer ThemeColors.
+ * All values are pre-resolved hex strings from the exporter.
+ */
+export interface ThemeColors {
+    primary: string;
+    primaryForeground: string;
+    secondary: string;
+    secondaryForeground: string;
+    background: string;
+    foreground: string;
+    card: string;
+    cardForeground: string;
+    muted: string;
+    mutedForeground: string;
+    border: string;
+    accent: string;
+    accentForeground: string;
+    destructive: string;
+    destructiveForeground: string;
+    input: string;
+    ring: string;
+    popover: string;
+    popoverForeground: string;
+    success: string;
+    successForeground: string;
+    warning: string;
+    warningForeground: string;
+    info: string;
+    infoForeground: string;
+}
+/** Theme configuration with resolved colors */
+export interface ThemeConfig {
+    /** Canonical typed colors (preferred) */
+    colors?: Partial<ThemeColors>;
+    /** Legacy color fields — mapped to canonical names by normalizeThemeColors() */
+    primaryColor?: string;
+    secondaryColor?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    cardColor?: string;
+    mutedColor?: string;
+    borderColor?: string;
+    accentColor?: string;
+    themingMode?: 'full' | 'component-priority' | 'disabled';
+    resolvedColors?: Record<string, string>;
+    fonts?: Record<string, any>;
+    screenLayout?: ScreenLayout;
+}
+/**
+ * Normalize any theme config (legacy or canonical) into the 26-field ThemeColors.
+ * Maps legacy field names (primaryColor, backgroundColor, etc.) to canonical names.
+ */
+export declare function normalizeThemeColors(config: ThemeConfig | undefined): ThemeColors;
+export type OfferDisplayMode = 'automatic' | 'always' | 'never';
+export interface AppStoreIntegration {
+    showIntroPrice: OfferDisplayMode;
+    showFreeTrial: OfferDisplayMode;
+    autoSelectBestOffer?: boolean;
+    promoOfferIdentifier?: string;
+}
+export interface PaywallConfiguration {
+    components: PaywallComponent[];
+    theme?: ThemeConfig;
+    variables?: Record<string, string>;
+    localizations?: Record<string, Record<string, string>>;
+    /** Per-variable locale overrides: { variableName: { locale: value } } */
+    variableLocalizations?: Record<string, Record<string, string>>;
+    offeringId?: string;
+    /** Base locale for translations (source language), defaults to 'en' */
+    baseLocale?: string;
+    mobileDisplay?: MobileDisplayConfig;
+    appStoreIntegration?: AppStoreIntegration;
+    /**
+     * Resolved store packages/products bound to this paywall, when available.
+     * Shape is store-dependent (StoreKit/Play) and accessed structurally by
+     * product components, so it is typed loosely here.
+     */
+    packages?: any[];
+}