@appfunnel-dev/sdk 0.5.0 → 0.7.0

package/dist/types-ChorYUCl.d.ts

@@ -1,255 +0,0 @@
-type VariableType = 'string' | 'number' | 'boolean' | 'stringArray';
-type VariableValue = string | number | boolean | string[] | null | undefined;
-interface AppFunnelConfig {
-    projectId: string;
-    name: string;
-    /** Page key to start on. Defaults to first entry in `pages`. */
-    initialPage?: string;
-    /**
-     * Response variables — user answers to quiz/survey questions.
-     * Stored internally as `answers.<key>`.
-     *
-     * ```ts
-     * responses: {
-     *   goal: { type: 'string', default: '' },
-     *   age_range: { type: 'string' },
-     *   interests: { type: 'stringArray', default: [] },
-     * }
-     * ```
-     */
-    responses?: Record<string, VariableConfig>;
-    /**
-     * Query param variables — captured from the URL at runtime.
-     * Stored internally as `query.<key>`.
-     * Listed here so the CLI build can emit them for analytics/database.
-     *
-     * ```ts
-     * queryParams: {
-     *   utm_source: { type: 'string' },
-     *   utm_medium: { type: 'string' },
-     *   ref: { type: 'string' },
-     * }
-     * ```
-     */
-    queryParams?: Record<string, VariableConfig>;
-    /**
-     * Data variables — arbitrary runtime state (not user answers or query params).
-     * Stored internally as `data.<key>`.
-     *
-     * ```ts
-     * data: {
-     *   selectedPlanTier: { type: 'string', default: 'free' },
-     *   hasSeenOnboarding: { type: 'boolean', default: false },
-     * }
-     * ```
-     */
-    data?: Record<string, VariableConfig>;
-    /** Default locale for translations. Defaults to 'en'. */
-    defaultLocale?: string;
-    products?: ProductsConfig;
-    settings?: FunnelSettings;
-    /**
-     * Integration configs (Meta Pixel, GTM, Clarity, etc.).
-     * Loaded from the API at runtime — the CLI build injects these
-     * from the project's dashboard settings.
-     */
-    integrations?: Record<string, Record<string, unknown>>;
-    /**
-     * Pages and routes can be defined here OR via `definePage()` in each page file.
-     * When using `definePage()`, the CLI build collects page definitions from the
-     * filesystem and merges them into the final config. These fields are populated
-     * by the build step — you don't need to set them manually.
-     */
-    pages?: Record<string, PageConfig>;
-    routes?: Record<string, RouteConfig[]>;
-}
-type PageType = 'default' | 'checkout' | 'finish' | 'auth' | 'paywall' | 'upsell';
-interface PageConfig {
-    name: string;
-    type: PageType;
-    /** URL slug for this page. Used for deep links, browser history, and reload persistence.
-     *  Defaults to the page key (filename) if not specified. */
-    slug?: string;
-}
-interface RouteConfig {
-    to: string;
-    when?: ConditionConfig | ConditionGroupConfig;
-}
-interface PageDefinition {
-    /** Display name shown in analytics and dashboard */
-    name: string;
-    /** Page type — determines behavior (e.g. checkout pages trigger payment flow) */
-    type?: PageType;
-    /** URL slug for this page. Defaults to the page key (filename) if not specified.
-     *  Used for deep links, browser history (pushState), and reload persistence. */
-    slug?: string;
-    /** Routes from this page. Evaluated in order; first match wins. */
-    routes?: RouteConfig[];
-}
-interface ConditionConfig {
-    variable: string;
-    equals?: VariableValue;
-    notEquals?: VariableValue;
-    contains?: string;
-    greaterThan?: number;
-    lessThan?: number;
-    exists?: boolean;
-    isEmpty?: boolean;
-    includes?: string;
-}
-interface ConditionGroupConfig {
-    operator: 'AND' | 'OR';
-    rules: (ConditionConfig | ConditionGroupConfig)[];
-}
-interface VariableConfig {
-    type: VariableType;
-    default?: VariableValue;
-    persist?: boolean;
-}
-interface ProductsConfig {
-    items: ProductConfig[];
-    defaultId?: string;
-}
-interface ProductConfig {
-    id: string;
-    name: string;
-    storePriceId: string;
-}
-interface FunnelSettings {
-    /** API base URL override (defaults to AppFunnel production API) */
-    apiBaseUrl?: string;
-}
-interface RuntimeProduct {
-    id: string;
-    name: string;
-    price: string;
-    rawPrice: number;
-    monthlyPrice: string;
-    dailyPrice: string;
-    weeklyPrice: string;
-    yearlyPrice: string;
-    period: string;
-    periodly: string;
-    currencyCode: string;
-    hasTrial: boolean;
-    trialDays: number;
-    trialPrice: string;
-    paidTrial: boolean;
-    trialRawPrice: number;
-    trialDailyPrice: string;
-    trialCurrencyCode: string;
-    trialStorePriceId: string;
-    storePriceId: string;
-    stripePriceId: string;
-    stripeProductId: string;
-    paddlePriceId: string;
-    paddleProductId: string;
-    displayName: string;
-    periodDays: number;
-    periodMonths: number;
-    periodWeeks: number;
-}
-interface PageState {
-    key: string;
-    name: string;
-    type: string;
-    slug: string;
-    index: number;
-}
-interface Progress {
-    current: number;
-    total: number;
-    percentage: number;
-}
-/** Enriched price data from API (matches getFunnelByIdentifier response) */
-interface EnrichedPriceData {
-    amount: number;
-    currency: string;
-    interval: string | null;
-    intervalCount: number | null;
-    stripePriceId?: string;
-    stripeProductId?: string;
-    paddlePriceId?: string;
-    paddleProductId?: string;
-    displayName?: string;
-    priceName?: string;
-    name?: string;
-}
-/** Hook return types */
-interface TranslationState {
-    /** Translate a key, with optional interpolation: t('welcome', { name: 'John' }) */
-    t: (key: string, params?: Record<string, string | number>) => string;
-    /** Current locale code */
-    locale: string;
-    /** Switch locale at runtime */
-    setLocale: (locale: string) => void;
-    /** List of locales that have translations loaded */
-    availableLocales: string[];
-}
-interface LocaleState {
-    /** Full locale string, e.g. 'en-US' */
-    locale: string;
-    /** Language code, e.g. 'en' */
-    language: string;
-    /** Region code, e.g. 'US' */
-    region: string;
-    /** All preferred languages from navigator.languages */
-    languages: string[];
-    /** IANA timezone, e.g. 'America/New_York' */
-    timeZone: string;
-    /** Whether the locale uses 24-hour clock */
-    is24Hour: boolean;
-}
-interface UserState {
-    email: string;
-    name: string;
-    stripeCustomerId: string;
-    paddleCustomerId: string;
-    /** Set email and auto-fire identify event */
-    setEmail: (email: string) => void;
-    setName: (name: string) => void;
-}
-interface NavigationState {
-    goToNextPage: () => void;
-    goBack: () => void;
-    goToPage: (pageKey: string) => void;
-    currentPage: PageState | null;
-    pageHistory: string[];
-    progress: Progress;
-}
-interface ProductsState {
-    products: RuntimeProduct[];
-    selected: RuntimeProduct | null;
-    select: (productId: string) => void;
-}
-interface TrackingState {
-    track: (eventName: string, data?: Record<string, unknown>) => void;
-    identify: (email: string) => void;
-}
-interface PaymentState {
-    customerId: string | null;
-    isAuthorized: boolean;
-    loading: boolean;
-    error: string | null;
-    cardDetails: {
-        last4: string;
-        brand: string;
-        expMonth: number;
-        expYear: number;
-    } | null;
-}
-interface FunnelState {
-    funnelId: string;
-    campaignId: string;
-    sessionId: string | null;
-    variables: Record<string, VariableValue>;
-    user: UserState;
-    responses: Record<string, VariableValue>;
-    queryParams: Record<string, string>;
-    navigation: NavigationState;
-    products: ProductsState;
-    tracking: TrackingState;
-    payment: PaymentState;
-}
-
-export type { AppFunnelConfig as A, ConditionConfig as C, EnrichedPriceData as E, FunnelState as F, LocaleState as L, NavigationState as N, PageDefinition as P, RouteConfig as R, TranslationState as T, UserState as U, VariableValue as V, ProductsState as a, TrackingState as b, PaymentState as c, ConditionGroupConfig as d, FunnelSettings as e, PageConfig as f, PageState as g, PageType as h, ProductConfig as i, ProductsConfig as j, Progress as k, RuntimeProduct as l, VariableConfig as m, VariableType as n };