@databuddy/sdk 2.3.0 → 2.3.2

package/dist/shared/@databuddy/sdk.B6nwxnPC.d.mts

@@ -0,0 +1,128 @@
+/** Flag evaluation result from API */
+interface FlagResult {
+    enabled: boolean;
+    value: boolean | string | number;
+    payload: Record<string, unknown> | null;
+    reason: string;
+    variant?: string;
+}
+/** User context for flag evaluation */
+interface UserContext {
+    userId?: string;
+    email?: string;
+    properties?: Record<string, unknown>;
+}
+/** SDK configuration */
+interface FlagsConfig {
+    /** Client ID (website or organization ID) */
+    clientId: string;
+    /** API URL (default: https://api.databuddy.cc) */
+    apiUrl?: string;
+    /** User context for evaluation */
+    user?: UserContext;
+    /** Disable flag evaluation entirely */
+    disabled?: boolean;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Skip persistent storage (browser only) */
+    skipStorage?: boolean;
+    /** Session is loading - defer evaluation */
+    isPending?: boolean;
+    /** Auto-fetch all flags on init (default: true) */
+    autoFetch?: boolean;
+    /** Environment name */
+    environment?: string;
+    /** Cache TTL in ms - after this, cache is invalid (default: 60000) */
+    cacheTtl?: number;
+    /** Stale time in ms - after this, revalidate in background (default: cacheTtl/2) */
+    staleTime?: number;
+}
+/** Flag status for clear state management */
+type FlagStatus = "loading" | "ready" | "error" | "pending";
+/** Synchronous flag state for React hooks */
+interface FlagState {
+    /** Whether the flag is enabled (true/false) */
+    on: boolean;
+    /** @deprecated Use `on` instead */
+    enabled: boolean;
+    /**  Current status: loading, ready, error, or pending  */
+    status: FlagStatus;
+    /** Whether the flag is still loading */
+    loading: boolean;
+    /** @deprecated Use `status === 'ready'` instead */
+    isLoading: boolean;
+    /** @deprecated Use `status === 'ready'` instead */
+    isReady: boolean;
+    /** The flag's value (boolean, string, or number) */
+    value?: boolean | string | number;
+    /** Variant name for multivariate flags */
+    variant?: string;
+}
+/** Feature state returned by useFeature hook */
+interface FeatureState {
+    /** Whether the feature is enabled */
+    on: boolean;
+    /** Whether the flag is loading */
+    loading: boolean;
+    /** Current status */
+    status: FlagStatus;
+    /** The flag's value */
+    value?: boolean | string | number;
+    /** Variant for A/B tests */
+    variant?: string;
+}
+/** Context returned by useFlags hook */
+interface FlagsContext {
+    /** @deprecated Use getFlag instead - confusing name */
+    isEnabled: (key: string) => FlagState;
+    /** Get a flag's full state */
+    getFlag: (key: string) => FlagState;
+    /** Get a flag's value with type safety */
+    getValue: <T extends boolean | string | number = boolean>(key: string, defaultValue?: T) => T;
+    /** Check if a flag is on (simple boolean) */
+    isOn: (key: string) => boolean;
+    /** Async fetch a specific flag */
+    fetchFlag: (key: string) => Promise<FlagResult>;
+    /** Fetch all flags */
+    fetchAllFlags: () => Promise<void>;
+    /** Update user context */
+    updateUser: (user: UserContext) => void;
+    /** Refresh all flags */
+    refresh: (forceClear?: boolean) => Promise<void>;
+    /** Whether the SDK is ready */
+    isReady: boolean;
+}
+/** Storage interface for persistence */
+interface StorageInterface {
+    get(key: string): FlagResult | null;
+    set(key: string, value: FlagResult): void;
+    getAll(): Record<string, FlagResult>;
+    setAll(flags: Record<string, FlagResult>): void;
+    delete?(key: string): void;
+    deleteMultiple?(keys: string[]): void;
+    clear(): void;
+    cleanupExpired(): void;
+}
+/** Manager constructor options */
+interface FlagsManagerOptions {
+    config: FlagsConfig;
+    storage?: StorageInterface;
+    onFlagsUpdate?: (flags: Record<string, FlagResult>) => void;
+    onConfigUpdate?: (config: FlagsConfig) => void;
+    onReady?: () => void;
+}
+/** Flags manager interface */
+interface FlagsManager {
+    getFlag: (key: string, user?: UserContext) => Promise<FlagResult>;
+    isEnabled: (key: string) => FlagState;
+    getValue: <T = boolean | string | number>(key: string, defaultValue?: T) => T;
+    fetchAllFlags: (user?: UserContext) => Promise<void>;
+    updateUser: (user: UserContext) => void;
+    refresh: (forceClear?: boolean) => Promise<void>;
+    updateConfig: (config: FlagsConfig) => void;
+    getMemoryFlags: () => Record<string, FlagResult>;
+    isReady: () => boolean;
+    destroy?: () => void;
+}
+
+export type { FlagsConfig as F, UserContext as U, FeatureState as a, FlagState as b, FlagsContext as c, FlagResult as d, FlagsManager as e, FlagsManagerOptions as f };

package/dist/shared/@databuddy/sdk.B6nwxnPC.d.ts

@@ -0,0 +1,128 @@
+/** Flag evaluation result from API */
+interface FlagResult {
+    enabled: boolean;
+    value: boolean | string | number;
+    payload: Record<string, unknown> | null;
+    reason: string;
+    variant?: string;
+}
+/** User context for flag evaluation */
+interface UserContext {
+    userId?: string;
+    email?: string;
+    properties?: Record<string, unknown>;
+}
+/** SDK configuration */
+interface FlagsConfig {
+    /** Client ID (website or organization ID) */
+    clientId: string;
+    /** API URL (default: https://api.databuddy.cc) */
+    apiUrl?: string;
+    /** User context for evaluation */
+    user?: UserContext;
+    /** Disable flag evaluation entirely */
+    disabled?: boolean;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Skip persistent storage (browser only) */
+    skipStorage?: boolean;
+    /** Session is loading - defer evaluation */
+    isPending?: boolean;
+    /** Auto-fetch all flags on init (default: true) */
+    autoFetch?: boolean;
+    /** Environment name */
+    environment?: string;
+    /** Cache TTL in ms - after this, cache is invalid (default: 60000) */
+    cacheTtl?: number;
+    /** Stale time in ms - after this, revalidate in background (default: cacheTtl/2) */
+    staleTime?: number;
+}
+/** Flag status for clear state management */
+type FlagStatus = "loading" | "ready" | "error" | "pending";
+/** Synchronous flag state for React hooks */
+interface FlagState {
+    /** Whether the flag is enabled (true/false) */
+    on: boolean;
+    /** @deprecated Use `on` instead */
+    enabled: boolean;
+    /**  Current status: loading, ready, error, or pending  */
+    status: FlagStatus;
+    /** Whether the flag is still loading */
+    loading: boolean;
+    /** @deprecated Use `status === 'ready'` instead */
+    isLoading: boolean;
+    /** @deprecated Use `status === 'ready'` instead */
+    isReady: boolean;
+    /** The flag's value (boolean, string, or number) */
+    value?: boolean | string | number;
+    /** Variant name for multivariate flags */
+    variant?: string;
+}
+/** Feature state returned by useFeature hook */
+interface FeatureState {
+    /** Whether the feature is enabled */
+    on: boolean;
+    /** Whether the flag is loading */
+    loading: boolean;
+    /** Current status */
+    status: FlagStatus;
+    /** The flag's value */
+    value?: boolean | string | number;
+    /** Variant for A/B tests */
+    variant?: string;
+}
+/** Context returned by useFlags hook */
+interface FlagsContext {
+    /** @deprecated Use getFlag instead - confusing name */
+    isEnabled: (key: string) => FlagState;
+    /** Get a flag's full state */
+    getFlag: (key: string) => FlagState;
+    /** Get a flag's value with type safety */
+    getValue: <T extends boolean | string | number = boolean>(key: string, defaultValue?: T) => T;
+    /** Check if a flag is on (simple boolean) */
+    isOn: (key: string) => boolean;
+    /** Async fetch a specific flag */
+    fetchFlag: (key: string) => Promise<FlagResult>;
+    /** Fetch all flags */
+    fetchAllFlags: () => Promise<void>;
+    /** Update user context */
+    updateUser: (user: UserContext) => void;
+    /** Refresh all flags */
+    refresh: (forceClear?: boolean) => Promise<void>;
+    /** Whether the SDK is ready */
+    isReady: boolean;
+}
+/** Storage interface for persistence */
+interface StorageInterface {
+    get(key: string): FlagResult | null;
+    set(key: string, value: FlagResult): void;
+    getAll(): Record<string, FlagResult>;
+    setAll(flags: Record<string, FlagResult>): void;
+    delete?(key: string): void;
+    deleteMultiple?(keys: string[]): void;
+    clear(): void;
+    cleanupExpired(): void;
+}
+/** Manager constructor options */
+interface FlagsManagerOptions {
+    config: FlagsConfig;
+    storage?: StorageInterface;
+    onFlagsUpdate?: (flags: Record<string, FlagResult>) => void;
+    onConfigUpdate?: (config: FlagsConfig) => void;
+    onReady?: () => void;
+}
+/** Flags manager interface */
+interface FlagsManager {
+    getFlag: (key: string, user?: UserContext) => Promise<FlagResult>;
+    isEnabled: (key: string) => FlagState;
+    getValue: <T = boolean | string | number>(key: string, defaultValue?: T) => T;
+    fetchAllFlags: (user?: UserContext) => Promise<void>;
+    updateUser: (user: UserContext) => void;
+    refresh: (forceClear?: boolean) => Promise<void>;
+    updateConfig: (config: FlagsConfig) => void;
+    getMemoryFlags: () => Record<string, FlagResult>;
+    isReady: () => boolean;
+    destroy?: () => void;
+}
+
+export type { FlagsConfig as F, UserContext as U, FeatureState as a, FlagState as b, FlagsContext as c, FlagResult as d, FlagsManager as e, FlagsManagerOptions as f };

package/dist/shared/@databuddy/{sdk.CeYE_kaj.d.mts → sdk.C9b3SVYK.d.mts}

@@ -13,7 +13,7 @@
  * />
  * ```
  */
-type DatabuddyConfig = {
+interface DatabuddyConfig {
     /**
      * Your Databuddy project client ID.
      * If not provided, will automatically detect from NEXT_PUBLIC_DATABUDDY_CLIENT_ID environment variable.
@@ -149,11 +149,11 @@ type DatabuddyConfig = {
     skipPatterns?: string[];
     /** Array of glob patterns to mask sensitive paths (e.g., ['/users/*']) */
     maskPatterns?: string[];
-};
+}
 /**
  * Base event properties that can be attached to any event
  */
-type BaseEventProperties = {
+interface BaseEventProperties {
     /** Page URL */
     __path?: string;
     /** Page title */
@@ -180,7 +180,7 @@ type BaseEventProperties = {
     utm_campaign?: string;
     utm_term?: string;
     utm_content?: string;
-};
+}
 /**
  * Custom event properties that can be attached to any event
  */
@@ -191,7 +191,7 @@ interface EventProperties extends BaseEventProperties {
 /**
  * Pre-defined event types with their specific properties
  */
-type EventTypeMap = {
+interface EventTypeMap {
     screen_view: {
         time_on_page?: number;
         scroll_depth?: number;
@@ -244,7 +244,7 @@ type EventTypeMap = {
         error_type?: string;
     };
     [eventName: string]: EventProperties;
-};
+}
 /**
  * Available event names
  */
@@ -266,7 +266,7 @@ type PropertiesForEvent<T extends EventName> = T extends keyof EventTypeMap ? Ev
  * const options = window.databuddy.options;
  * ```
  */
-type DatabuddyTracker = {
+interface DatabuddyTracker {
     /**
      * Track a custom event.
      * @param eventName - Name of the event (e.g., "purchase", "signup")
@@ -305,7 +305,7 @@ type DatabuddyTracker = {
      * Current tracker configuration options.
      */
     options: DatabuddyConfig;
-};
+}
 /**
  * Global window interface extensions
  */
@@ -348,12 +348,12 @@ declare global {
  * </a>
  * ```
  */
-type DataAttributes = {
+interface DataAttributes {
     /** Event name to track when element is clicked */
     "data-track": string;
     /** Additional data attributes (auto-converted from kebab-case to camelCase) */
     [key: `data-${string}`]: string;
-};
+}
 /**
  * Utility types for creating typed event tracking functions
  */

package/dist/shared/@databuddy/{sdk.CeYE_kaj.d.ts → sdk.C9b3SVYK.d.ts}

@@ -13,7 +13,7 @@
  * />
  * ```
  */
-type DatabuddyConfig = {
+interface DatabuddyConfig {
     /**
      * Your Databuddy project client ID.
      * If not provided, will automatically detect from NEXT_PUBLIC_DATABUDDY_CLIENT_ID environment variable.
@@ -149,11 +149,11 @@ type DatabuddyConfig = {
     skipPatterns?: string[];
     /** Array of glob patterns to mask sensitive paths (e.g., ['/users/*']) */
     maskPatterns?: string[];
-};
+}
 /**
  * Base event properties that can be attached to any event
  */
-type BaseEventProperties = {
+interface BaseEventProperties {
     /** Page URL */
     __path?: string;
     /** Page title */
@@ -180,7 +180,7 @@ type BaseEventProperties = {
     utm_campaign?: string;
     utm_term?: string;
     utm_content?: string;
-};
+}
 /**
  * Custom event properties that can be attached to any event
  */
@@ -191,7 +191,7 @@ interface EventProperties extends BaseEventProperties {
 /**
  * Pre-defined event types with their specific properties
  */
-type EventTypeMap = {
+interface EventTypeMap {
     screen_view: {
         time_on_page?: number;
         scroll_depth?: number;
@@ -244,7 +244,7 @@ type EventTypeMap = {
         error_type?: string;
     };
     [eventName: string]: EventProperties;
-};
+}
 /**
  * Available event names
  */
@@ -266,7 +266,7 @@ type PropertiesForEvent<T extends EventName> = T extends keyof EventTypeMap ? Ev
  * const options = window.databuddy.options;
  * ```
  */
-type DatabuddyTracker = {
+interface DatabuddyTracker {
     /**
      * Track a custom event.
      * @param eventName - Name of the event (e.g., "purchase", "signup")
@@ -305,7 +305,7 @@ type DatabuddyTracker = {
      * Current tracker configuration options.
      */
     options: DatabuddyConfig;
-};
+}
 /**
  * Global window interface extensions
  */
@@ -348,12 +348,12 @@ declare global {
  * </a>
  * ```
  */
-type DataAttributes = {
+interface DataAttributes {
     /** Event name to track when element is clicked */
     "data-track": string;
     /** Additional data attributes (auto-converted from kebab-case to camelCase) */
     [key: `data-${string}`]: string;
-};
+}
 /**
  * Utility types for creating typed event tracking functions
  */