@growth-rail/react 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,50 @@
+# @growth-rail/react
+
+## 2.1.0
+
+### Minor Changes
+
+- Fixed issues and modified usage
+
+### Patch Changes
+
+- Updated dependencies
+  - @growth-rail/core@2.2.0
+
+## 2.0.2
+
+### Patch Changes
+
+- added read me
+- Updated dependencies
+  - @growth-rail/core@2.0.1
+
+## 2.0.1
+
+### Patch Changes
+
+- dependency fixed
+
+## 2.0.0
+
+### Major Changes
+
+- option type changes
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [d4cc14b]
+  - @growth-rail/core@2.0.0
+
+## 1.0.0
+
+### Major Changes
+
+- Initial SDK Version
+
+### Patch Changes
+
+- Updated dependencies
+  - @growth-rail/core@1.0.0

package/README.md

@@ -0,0 +1,122 @@
+# @growth-rail/react
+
+The Official Growth Rail React SDK. Easily integrate referral programs, track user growth, and display referral dashboards in your React applications.
+
+## 🚀 Features
+
+-   **Context-based Initialization**: Seamless setup with `GrowthRailProvider`.
+-   **Hooks for Ease of Use**: Access the SDK anywhere with the `useGrowthRail` hook.
+-   **Built-in UI Components**: Drop-in widgets like `ReferralDashboard` to get started instantly.
+-   **Fully Type-Safe**: Written in TypeScript with complete definition support.
+-   **Small Footprint**: Optimized for performance and minimal bundle size.
+
+## 📦 Installation
+
+This package requires `@growth-rail/core` as a dependency and `react` as a peer dependency.
+
+```bash
+# npm
+npm install @growth-rail/react @growth-rail/core
+
+# yarn
+yarn add @growth-rail/react @growth-rail/core
+
+# pnpm
+pnpm add @growth-rail/react @growth-rail/core
+```
+
+## 🛠 Usage
+
+### 1. Wrap your App with `GrowthRailProvider`
+
+Initialize the SDK at the root of your application. Provide your Project Secret Key and optionally a `userId` if the user is already authenticated.
+
+```tsx
+import { GrowthRailProvider } from '@growth-rail/react';
+
+function App() {
+  return (
+    <GrowthRailProvider 
+      projectSecretKey="your_project_secret_key_here" 
+      userId="user_123" // Optional: initialize for a specific user
+    >
+      <your-application-code />
+    </GrowthRailProvider>
+  );
+}
+```
+
+### 2. Track Events and Get User Info
+
+Use the `useGrowthRail` hook in any child component to track events or initialize users.
+
+```tsx
+import { useGrowthRail } from '@growth-rail/react';
+
+export function ActionButton() {
+  const { trackRewardEvent, isLoading } = useGrowthRail();
+
+  const handleAction = async () => {
+    await trackRewardEvent('purchase_completed');
+    console.log('Action tracked!');
+  };
+
+  return (
+    <button onClick={handleAction} disabled={isLoading}>
+      {isLoading ? 'Processing...' : 'Complete Action'}
+    </button>
+  );
+}
+```
+
+### 3. Display the Referral Dashboard
+
+Use the `ReferralDashboard` component to provide a white-labeled UI where users can see their referral link and rewards.
+
+```tsx
+import { ReferralDashboard } from '@growth-rail/react';
+
+export function DashboardPage() {
+  return (
+    <div style={{ padding: '20px' }}>
+      <h1>My Rewards</h1>
+      <ReferralDashboard 
+        title="Invite your friends and earn!" 
+        onLinkCopied={() => alert('Link copied!')}
+      />
+    </div>
+  );
+}
+```
+
+## 📖 API Reference
+
+### `useGrowthRail()`
+
+The main hook for interacting with the Growth Rail SDK.
+
+**Methods:**
+- `initAppUser(userId)`: Initializes the SDK for a specific user.
+- `trackRewardEvent(eventName?)`: Tracks a custom event for attribution and rewards.
+- `showReferralDashboard(options?)`: Programmatically triggers the referral dashboard modal.
+- `showFloatingButton(options)`: Displays the floating referral trigger button.
+- `hideFloatingButton()`: Removes the floating referral trigger button.
+
+**State:**
+- `isLoading`: Boolean indicating if an async operation is pending.
+- `error`: The last error that occurred (if any).
+
+### `ReferralDashboard`
+
+An inline dashboard component for your application.
+
+| Prop | Type | Description |
+| :--- | :--- | :--- |
+| `title` | `string` | Optional title for the dashboard. |
+| `onLinkCopied` | `() => void` | Callback when the referral link is copied. |
+
+For full documentation, visit [docs.growthrail.com](https://docs.growthrail.com).
+
+## 📄 License
+
+MIT © [Growth Rail](https://growthrail.com)

package/dist/index.d.mts

@@ -1,29 +1,90 @@
 import React, { ReactNode } from 'react';
 import { GrowthRailOptions, AppUserType, GrowthRail, ReferrerTriggerButton, ReferrerModalOptions } from '@growth-rail/core';
-export { AppUserType, GrowthRailOptions } from '@growth-rail/core';
+export { AppUserType, GrowthRailOptions, ReferrerExperience, ReferrerModalOptions, ReferrerTriggerButton } from '@growth-rail/core';
 
+/**
+ * Props for the GrowthRailProvider component.
+ */
 interface GrowthRailProviderProps extends GrowthRailOptions {
+    /** The unique ID for the current application user. */
     userId?: string;
+    /** Your application components. */
     children: ReactNode;
 }
+/**
+ * Root provider component for GrowthRail in React applications.
+ * This component initializes the SDK and manages the user's authentication state.
+ *
+ * Wrap your app (or a specific feature tree) with this provider.
+ *
+ * @example
+ * <GrowthRailProvider projectSecretKey="your-api-key" userId="user-123">
+ *   <App />
+ * </GrowthRailProvider>
+ */
 declare const GrowthRailProvider: React.FC<GrowthRailProviderProps>;
 
+/**
+ * The return type of the useGrowthRail hook.
+ */
 interface UseGrowthRailReturn {
-    initUser: (userId: string) => Promise<AppUserType>;
-    trackReward: (eventName?: string) => Promise<void>;
+    /**
+     * Initializes a user in the GrowthRail system.
+     * @param userId - Unique identifier for the user.
+     */
+    initAppUser: (userId: string) => Promise<AppUserType>;
+    /**
+     * Tracks a reward-eligible event for the current user.
+     * @param eventName - Optional name of the event.
+     */
+    trackRewardEvent: (eventName?: string) => Promise<void>;
+    /**
+     * Manually triggers the referral dashboard modal.
+     * @param options - Customization options for the modal.
+     */
     showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;
+    /**
+     * Manually shows or updates the floating referral trigger button.
+     * @param options - Configuration for the button.
+     */
     showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;
+    /** Hides the floating referral trigger button. */
     hideFloatingButton: () => void;
+    /** Whether an asynchronous operation (like init or track) is in progress. */
     isLoading: boolean;
+    /** The last error that occurred during an operation. */
     error: Error | null;
 }
+/**
+ * A hook that provides access to GrowthRail SDK methods and state.
+ *
+ * @returns An object containing methods to manage referrals and track state.
+ *
+ * @example
+ * const { showReferralDashboard, trackRewardEvent } = useGrowthRail();
+ */
 declare const useGrowthRail: () => UseGrowthRailReturn;
 
+/**
+ * Props for the ReferralDashboard component.
+ */
 interface ReferralDashboardProps {
+    /** Optional override for the dashboard title. */
     title?: string;
+    /** Customization options for the dashboard's appearance. */
     appearance?: ReferrerModalOptions;
+    /** Callback fired when the referral link is copied to the clipboard. */
     onLinkCopied?: () => void;
 }
+/**
+ * An inline referral dashboard component.
+ * Unlike the global modal, this component renders directly within your layout.
+ *
+ * @example
+ * <div style={{ height: '500px' }}>
+ *   <ReferralDashboard title="Invite your team" />
+ * </div>
+ */
 declare const ReferralDashboard: React.FC<ReferralDashboardProps>;
 
 export { GrowthRailProvider, ReferralDashboard, type ReferralDashboardProps, type UseGrowthRailReturn, useGrowthRail };

package/dist/index.d.ts

@@ -1,29 +1,90 @@
 import React, { ReactNode } from 'react';
 import { GrowthRailOptions, AppUserType, GrowthRail, ReferrerTriggerButton, ReferrerModalOptions } from '@growth-rail/core';
-export { AppUserType, GrowthRailOptions } from '@growth-rail/core';
+export { AppUserType, GrowthRailOptions, ReferrerExperience, ReferrerModalOptions, ReferrerTriggerButton } from '@growth-rail/core';
 
+/**
+ * Props for the GrowthRailProvider component.
+ */
 interface GrowthRailProviderProps extends GrowthRailOptions {
+    /** The unique ID for the current application user. */
     userId?: string;
+    /** Your application components. */
     children: ReactNode;
 }
+/**
+ * Root provider component for GrowthRail in React applications.
+ * This component initializes the SDK and manages the user's authentication state.
+ *
+ * Wrap your app (or a specific feature tree) with this provider.
+ *
+ * @example
+ * <GrowthRailProvider projectSecretKey="your-api-key" userId="user-123">
+ *   <App />
+ * </GrowthRailProvider>
+ */
 declare const GrowthRailProvider: React.FC<GrowthRailProviderProps>;
 
+/**
+ * The return type of the useGrowthRail hook.
+ */
 interface UseGrowthRailReturn {
-    initUser: (userId: string) => Promise<AppUserType>;
-    trackReward: (eventName?: string) => Promise<void>;
+    /**
+     * Initializes a user in the GrowthRail system.
+     * @param userId - Unique identifier for the user.
+     */
+    initAppUser: (userId: string) => Promise<AppUserType>;
+    /**
+     * Tracks a reward-eligible event for the current user.
+     * @param eventName - Optional name of the event.
+     */
+    trackRewardEvent: (eventName?: string) => Promise<void>;
+    /**
+     * Manually triggers the referral dashboard modal.
+     * @param options - Customization options for the modal.
+     */
     showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;
+    /**
+     * Manually shows or updates the floating referral trigger button.
+     * @param options - Configuration for the button.
+     */
     showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;
+    /** Hides the floating referral trigger button. */
     hideFloatingButton: () => void;
+    /** Whether an asynchronous operation (like init or track) is in progress. */
     isLoading: boolean;
+    /** The last error that occurred during an operation. */
     error: Error | null;
 }
+/**
+ * A hook that provides access to GrowthRail SDK methods and state.
+ *
+ * @returns An object containing methods to manage referrals and track state.
+ *
+ * @example
+ * const { showReferralDashboard, trackRewardEvent } = useGrowthRail();
+ */
 declare const useGrowthRail: () => UseGrowthRailReturn;
 
+/**
+ * Props for the ReferralDashboard component.
+ */
 interface ReferralDashboardProps {
+    /** Optional override for the dashboard title. */
     title?: string;
+    /** Customization options for the dashboard's appearance. */
     appearance?: ReferrerModalOptions;
+    /** Callback fired when the referral link is copied to the clipboard. */
     onLinkCopied?: () => void;
 }
+/**
+ * An inline referral dashboard component.
+ * Unlike the global modal, this component renders directly within your layout.
+ *
+ * @example
+ * <div style={{ height: '500px' }}>
+ *   <ReferralDashboard title="Invite your team" />
+ * </div>
+ */
 declare const ReferralDashboard: React.FC<ReferralDashboardProps>;
 
 export { GrowthRailProvider, ReferralDashboard, type ReferralDashboardProps, type UseGrowthRailReturn, useGrowthRail };

package/dist/index.js

@@ -61,7 +61,7 @@ var import_core2 = require("@growth-rail/core");
 var useGrowthRail = () => {
   const [isLoading, setIsLoading] = (0, import_react2.useState)(false);
   const [error, setError] = (0, import_react2.useState)(null);
-  const initUser = (0, import_react2.useCallback)(async (userId) => {
+  const initAppUser = (0, import_react2.useCallback)(async (userId) => {
     setIsLoading(true);
     setError(null);
     try {
@@ -75,7 +75,7 @@ var useGrowthRail = () => {
       setIsLoading(false);
     }
   }, []);
-  const trackReward = (0, import_react2.useCallback)(async (eventName) => {
+  const trackRewardEvent = (0, import_react2.useCallback)(async (eventName) => {
     setIsLoading(true);
     setError(null);
     try {
@@ -98,8 +98,8 @@ var useGrowthRail = () => {
     import_core2.GrowthRail.destroyTriggerButton();
   }, []);
   return {
-    initUser,
-    trackReward,
+    initAppUser,
+    trackRewardEvent,
     showReferralDashboard,
     showFloatingButton,
     hideFloatingButton,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.tsx","../src/GrowthRailProvider.tsx","../src/useGrowthRail.ts","../src/ReferralDashboard.tsx"],"sourcesContent":["export { GrowthRailProvider } from './GrowthRailProvider';\nexport { useGrowthRail, type UseGrowthRailReturn } from './useGrowthRail';\nexport { \n  ReferralDashboard, \n  type ReferralDashboardProps,\n} from './ReferralDashboard';\n\nexport type { GrowthRailOptions, AppUserType } from '@growth-rail/core';\n","import React, { useEffect, useRef, useState, ReactNode } from 'react';\nimport { GrowthRail, GrowthRailOptions } from '@growth-rail/core';\n\ninterface GrowthRailProviderProps extends GrowthRailOptions {\n  userId?: string;\n  children: ReactNode;\n}\n\nexport const GrowthRailProvider: React.FC<GrowthRailProviderProps> = ({ \n  children, \n  userId,\n  ...options \n}) => {\n  const [isReady, setIsReady] = useState(GrowthRail.isInitialized());\n  const initialized = useRef(false);\n\n  useEffect(() => {\n    if (initialized.current) return;\n    initialized.current = true;\n\n    GrowthRail.init(options);\n    if (userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n    setIsReady(true);\n  }, []);\n\n  useEffect(() => {\n    if (initialized.current && userId && GrowthRail.getUserId() !== userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n  }, [userId]);\n\n  if (!isReady) return null;\n\n  return <>{children}</>;\n};\n","import { useState, useCallback } from 'react';\nimport { GrowthRail, AppUserType, ReferrerTriggerButton } from '@growth-rail/core';\n\nexport interface UseGrowthRailReturn {\n  initUser: (userId: string) => Promise<AppUserType>;\n  trackReward: (eventName?: string) => Promise<void>;\n  showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;\n  showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;\n  hideFloatingButton: () => void;\n  isLoading: boolean;\n  error: Error | null;\n}\n\nexport const useGrowthRail = (): UseGrowthRailReturn => {\n  const [isLoading, setIsLoading] = useState(false);\n  const [error, setError] = useState<Error | null>(null);\n\n  const initUser = useCallback(async (userId: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      const user = await GrowthRail.initAppUser(userId);\n      return user;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const trackReward = useCallback(async (eventName?: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      await GrowthRail.trackRewardEvent(eventName);\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const showReferralDashboard = useCallback((options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => {\n    GrowthRail.showReferralDashboard(options);\n  }, []);\n\n  const showFloatingButton = useCallback((options: Partial<ReferrerTriggerButton>) => {\n    GrowthRail.createTriggerButton(options);\n  }, []);\n\n  const hideFloatingButton = useCallback(() => {\n    GrowthRail.destroyTriggerButton();\n  }, []);\n\n  return {\n    initUser,\n    trackReward,\n    showReferralDashboard,\n    showFloatingButton,\n    hideFloatingButton,\n    isLoading,\n    error,\n  };\n};\n","import React, { useEffect, useRef } from 'react';\nimport { GrowthRail, ReferrerModalOptions, ReferralModal, ReferrerExperience } from '@growth-rail/core';\n\nexport interface ReferralDashboardProps {\n  title?: string;\n  appearance?: ReferrerModalOptions;\n  onLinkCopied?: () => void;\n}\n\nexport const ReferralDashboard: React.FC<ReferralDashboardProps> = ({\n  title,\n  appearance = {},\n  onLinkCopied,\n}) => {\n  const containerRef = useRef<HTMLDivElement>(null);\n  const modalRef = useRef<ReferralModal | null>(null);\n\n  useEffect(() => {\n    let mounted = true;\n    if (!containerRef.current) return;\n\n    GrowthRail.ensureUserReady().then((user) => {\n      if (!mounted || !containerRef.current) return;\n\n      const deps = {\n        isUserReady: () => GrowthRail.isUserReady(),\n        getReferralLink: () => {\n          try {\n            return GrowthRail.getReferralLink();\n          } catch {\n            return '';\n          }\n        },\n      };\n\n      // Construct experience config directly from BE\n      const experience: ReferrerExperience = {\n        trigger: user.referrerExperience.trigger,\n        modal: {\n          ...user.referrerExperience.modal,\n          ...(title ? { title } : {}),\n          ...appearance,\n        },\n      };\n\n      modalRef.current = new ReferralModal(deps, experience);\n      modalRef.current.show(appearance, containerRef.current);\n    }).catch((err) => {\n      console.error('GrowthRail: User initialization failed', err);\n    });\n\n    return () => {\n      mounted = false;\n      if (modalRef.current) {\n        modalRef.current.hide();\n        modalRef.current = null;\n      }\n    };\n  }, [title, appearance]);\n\n  return (\n    <div \n      ref={containerRef} \n      style={{ \n        width: '100%', \n        height: '100%', \n        minHeight: '400px',\n        position: 'relative' \n      }} \n    />\n  );\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA8D;AAC9D,kBAA8C;AAkCrC;AA3BF,IAAM,qBAAwD,CAAC;AAAA,EACpE;AAAA,EACA;AAAA,EACA,GAAG;AACL,MAAM;AACJ,QAAM,CAAC,SAAS,UAAU,QAAI,uBAAS,uBAAW,cAAc,CAAC;AACjE,QAAM,kBAAc,qBAAO,KAAK;AAEhC,8BAAU,MAAM;AACd,QAAI,YAAY,QAAS;AACzB,gBAAY,UAAU;AAEtB,2BAAW,KAAK,OAAO;AACvB,QAAI,QAAQ;AACV,6BAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AACA,eAAW,IAAI;AAAA,EACjB,GAAG,CAAC,CAAC;AAEL,8BAAU,MAAM;AACd,QAAI,YAAY,WAAW,UAAU,uBAAW,UAAU,MAAM,QAAQ;AACtE,6BAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,MAAI,CAAC,QAAS,QAAO;AAErB,SAAO,2EAAG,UAAS;AACrB;;;ACpCA,IAAAA,gBAAsC;AACtC,IAAAC,eAA+D;AAYxD,IAAM,gBAAgB,MAA2B;AACtD,QAAM,CAAC,WAAW,YAAY,QAAI,wBAAS,KAAK;AAChD,QAAM,CAAC,OAAO,QAAQ,QAAI,wBAAuB,IAAI;AAErD,QAAM,eAAW,2BAAY,OAAO,WAAmB;AACrD,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,OAAO,MAAM,wBAAW,YAAY,MAAM;AAChD,aAAO;AAAA,IACT,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,kBAAc,2BAAY,OAAO,cAAuB;AAC5D,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,wBAAW,iBAAiB,SAAS;AAAA,IAC7C,SAAS,KAAK;AACZ,YAAMA,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,4BAAwB,2BAAY,CAAC,YAAqE;AAC9G,4BAAW,sBAAsB,OAAO;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,yBAAqB,2BAAY,CAAC,YAA4C;AAClF,4BAAW,oBAAoB,OAAO;AAAA,EACxC,GAAG,CAAC,CAAC;AAEL,QAAM,yBAAqB,2BAAY,MAAM;AAC3C,4BAAW,qBAAqB;AAAA,EAClC,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;ACnEA,IAAAC,gBAAyC;AACzC,IAAAC,eAAoF;AA4DhF,IAAAC,sBAAA;AApDG,IAAM,oBAAsD,CAAC;AAAA,EAClE;AAAA,EACA,aAAa,CAAC;AAAA,EACd;AACF,MAAM;AACJ,QAAM,mBAAe,sBAAuB,IAAI;AAChD,QAAM,eAAW,sBAA6B,IAAI;AAElD,+BAAU,MAAM;AACd,QAAI,UAAU;AACd,QAAI,CAAC,aAAa,QAAS;AAE3B,4BAAW,gBAAgB,EAAE,KAAK,CAAC,SAAS;AAC1C,UAAI,CAAC,WAAW,CAAC,aAAa,QAAS;AAEvC,YAAM,OAAO;AAAA,QACX,aAAa,MAAM,wBAAW,YAAY;AAAA,QAC1C,iBAAiB,MAAM;AACrB,cAAI;AACF,mBAAO,wBAAW,gBAAgB;AAAA,UACpC,QAAQ;AACN,mBAAO;AAAA,UACT;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAiC;AAAA,QACrC,SAAS,KAAK,mBAAmB;AAAA,QACjC,OAAO;AAAA,UACL,GAAG,KAAK,mBAAmB;AAAA,UAC3B,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;AAAA,UACzB,GAAG;AAAA,QACL;AAAA,MACF;AAEA,eAAS,UAAU,IAAI,2BAAc,MAAM,UAAU;AACrD,eAAS,QAAQ,KAAK,YAAY,aAAa,OAAO;AAAA,IACxD,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,cAAQ,MAAM,0CAA0C,GAAG;AAAA,IAC7D,CAAC;AAED,WAAO,MAAM;AACX,gBAAU;AACV,UAAI,SAAS,SAAS;AACpB,iBAAS,QAAQ,KAAK;AACtB,iBAAS,UAAU;AAAA,MACrB;AAAA,IACF;AAAA,EACF,GAAG,CAAC,OAAO,UAAU,CAAC;AAEtB,SACE;AAAA,IAAC;AAAA;AAAA,MACC,KAAK;AAAA,MACL,OAAO;AAAA,QACL,OAAO;AAAA,QACP,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,UAAU;AAAA,MACZ;AAAA;AAAA,EACF;AAEJ;","names":["import_react","import_core","error","import_react","import_core","import_jsx_runtime"]}
+{"version":3,"sources":["../src/index.tsx","../src/GrowthRailProvider.tsx","../src/useGrowthRail.ts","../src/ReferralDashboard.tsx"],"sourcesContent":["/**\n * GrowthRail React SDK\n * \n * This package provide React components and hooks for the GrowthRail referral system.\n * It is built on top of the `@growth-rail/core` package.\n */\n\n/** Root provider component for initializing GrowthRail. */\nexport { GrowthRailProvider } from './GrowthRailProvider';\n\n/** Hook for accessing GrowthRail methods and state. */\nexport { useGrowthRail, type UseGrowthRailReturn } from './useGrowthRail';\n\n/** Inline referral dashboard component. */\nexport { \n  ReferralDashboard, \n  type ReferralDashboardProps,\n} from './ReferralDashboard';\n\n/** Re-exported core types. */\nexport type { \n  GrowthRailOptions, \n  AppUserType,\n  ReferrerModalOptions,\n  ReferrerExperience,\n  ReferrerTriggerButton \n} from '@growth-rail/core';\n","import React, { useEffect, useRef, useState, ReactNode } from 'react';\nimport { GrowthRail, GrowthRailOptions } from '@growth-rail/core';\n\n/**\n * Props for the GrowthRailProvider component.\n */\ninterface GrowthRailProviderProps extends GrowthRailOptions {\n  /** The unique ID for the current application user. */\n  userId?: string;\n  /** Your application components. */\n  children: ReactNode;\n}\n\n/**\n * Root provider component for GrowthRail in React applications.\n * This component initializes the SDK and manages the user's authentication state.\n * \n * Wrap your app (or a specific feature tree) with this provider.\n * \n * @example\n * <GrowthRailProvider projectSecretKey=\"your-api-key\" userId=\"user-123\">\n *   <App />\n * </GrowthRailProvider>\n */\nexport const GrowthRailProvider: React.FC<GrowthRailProviderProps> = ({ \n  children, \n  userId,\n  ...options \n}) => {\n\n  const [isReady, setIsReady] = useState(GrowthRail.isInitialized());\n  const initialized = useRef(false);\n\n  useEffect(() => {\n    if (initialized.current) return;\n    initialized.current = true;\n\n    GrowthRail.init(options);\n    if (userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n    setIsReady(true);\n  }, []);\n\n  useEffect(() => {\n    if (initialized.current && userId && GrowthRail.getUserId() !== userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n  }, [userId]);\n\n  if (!isReady) return null;\n\n  return <>{children}</>;\n};\n","import { useState, useCallback } from 'react';\nimport { GrowthRail, AppUserType, ReferrerTriggerButton } from '@growth-rail/core';\n\n/**\n * The return type of the useGrowthRail hook.\n */\nexport interface UseGrowthRailReturn {\n  /** \n   * Initializes a user in the GrowthRail system. \n   * @param userId - Unique identifier for the user.\n   */\n  initAppUser: (userId: string) => Promise<AppUserType>;\n  /** \n   * Tracks a reward-eligible event for the current user.\n   * @param eventName - Optional name of the event.\n   */\n  trackRewardEvent: (eventName?: string) => Promise<void>;\n  /** \n   * Manually triggers the referral dashboard modal.\n   * @param options - Customization options for the modal.\n   */\n  showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;\n  /** \n   * Manually shows or updates the floating referral trigger button.\n   * @param options - Configuration for the button.\n   */\n  showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;\n  /** Hides the floating referral trigger button. */\n  hideFloatingButton: () => void;\n  /** Whether an asynchronous operation (like init or track) is in progress. */\n  isLoading: boolean;\n  /** The last error that occurred during an operation. */\n  error: Error | null;\n}\n\n/**\n * A hook that provides access to GrowthRail SDK methods and state.\n * \n * @returns An object containing methods to manage referrals and track state.\n * \n * @example\n * const { showReferralDashboard, trackRewardEvent } = useGrowthRail();\n */\nexport const useGrowthRail = (): UseGrowthRailReturn => {\n\n  const [isLoading, setIsLoading] = useState(false);\n  const [error, setError] = useState<Error | null>(null);\n\n  const initAppUser = useCallback(async (userId: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      const user = await GrowthRail.initAppUser(userId);\n      return user;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const trackRewardEvent = useCallback(async (eventName?: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      await GrowthRail.trackRewardEvent(eventName);\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const showReferralDashboard = useCallback((options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => {\n    GrowthRail.showReferralDashboard(options);\n  }, []);\n\n  const showFloatingButton = useCallback((options: Partial<ReferrerTriggerButton>) => {\n    GrowthRail.createTriggerButton(options);\n  }, []);\n\n  const hideFloatingButton = useCallback(() => {\n    GrowthRail.destroyTriggerButton();\n  }, []);\n\n  return {\n    initAppUser,\n    trackRewardEvent,\n    showReferralDashboard,\n    showFloatingButton,\n    hideFloatingButton,\n    isLoading,\n    error,\n  };\n};\n","import React, { useEffect, useRef } from 'react';\nimport { GrowthRail, ReferrerModalOptions, ReferralModal, ReferrerExperience } from '@growth-rail/core';\n\n/**\n * Props for the ReferralDashboard component.\n */\nexport interface ReferralDashboardProps {\n  /** Optional override for the dashboard title. */\n  title?: string;\n  /** Customization options for the dashboard's appearance. */\n  appearance?: ReferrerModalOptions;\n  /** Callback fired when the referral link is copied to the clipboard. */\n  onLinkCopied?: () => void;\n}\n\n/**\n * An inline referral dashboard component.\n * Unlike the global modal, this component renders directly within your layout.\n * \n * @example\n * <div style={{ height: '500px' }}>\n *   <ReferralDashboard title=\"Invite your team\" />\n * </div>\n */\nexport const ReferralDashboard: React.FC<ReferralDashboardProps> = ({\n  title,\n  appearance = {},\n  onLinkCopied,\n}) => {\n\n  const containerRef = useRef<HTMLDivElement>(null);\n  const modalRef = useRef<ReferralModal | null>(null);\n\n  useEffect(() => {\n    let mounted = true;\n    if (!containerRef.current) return;\n\n    GrowthRail.ensureUserReady().then((user) => {\n      if (!mounted || !containerRef.current) return;\n\n      const deps = {\n        isUserReady: () => GrowthRail.isUserReady(),\n        getReferralLink: () => {\n          try {\n            return GrowthRail.getReferralLink();\n          } catch {\n            return '';\n          }\n        },\n      };\n\n      // Construct experience config directly from BE\n      const experience: ReferrerExperience = {\n        trigger: user.referrerExperience.trigger,\n        modal: {\n          ...user.referrerExperience.modal,\n          ...(title ? { title } : {}),\n          ...appearance,\n        },\n      };\n\n      modalRef.current = new ReferralModal(deps, experience);\n      modalRef.current.show(appearance, containerRef.current);\n    }).catch((err) => {\n      console.error('GrowthRail: User initialization failed', err);\n    });\n\n    return () => {\n      mounted = false;\n      if (modalRef.current) {\n        modalRef.current.hide();\n        modalRef.current = null;\n      }\n    };\n  }, [title, appearance]);\n\n  return (\n    <div \n      ref={containerRef} \n      style={{ \n        width: '100%', \n        height: '100%', \n        minHeight: '400px',\n        position: 'relative' \n      }} \n    />\n  );\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA8D;AAC9D,kBAA8C;AAmDrC;AA5BF,IAAM,qBAAwD,CAAC;AAAA,EACpE;AAAA,EACA;AAAA,EACA,GAAG;AACL,MAAM;AAEJ,QAAM,CAAC,SAAS,UAAU,QAAI,uBAAS,uBAAW,cAAc,CAAC;AACjE,QAAM,kBAAc,qBAAO,KAAK;AAEhC,8BAAU,MAAM;AACd,QAAI,YAAY,QAAS;AACzB,gBAAY,UAAU;AAEtB,2BAAW,KAAK,OAAO;AACvB,QAAI,QAAQ;AACV,6BAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AACA,eAAW,IAAI;AAAA,EACjB,GAAG,CAAC,CAAC;AAEL,8BAAU,MAAM;AACd,QAAI,YAAY,WAAW,UAAU,uBAAW,UAAU,MAAM,QAAQ;AACtE,6BAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,MAAI,CAAC,QAAS,QAAO;AAErB,SAAO,2EAAG,UAAS;AACrB;;;ACrDA,IAAAA,gBAAsC;AACtC,IAAAC,eAA+D;AA0CxD,IAAM,gBAAgB,MAA2B;AAEtD,QAAM,CAAC,WAAW,YAAY,QAAI,wBAAS,KAAK;AAChD,QAAM,CAAC,OAAO,QAAQ,QAAI,wBAAuB,IAAI;AAErD,QAAM,kBAAc,2BAAY,OAAO,WAAmB;AACxD,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,OAAO,MAAM,wBAAW,YAAY,MAAM;AAChD,aAAO;AAAA,IACT,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,uBAAmB,2BAAY,OAAO,cAAuB;AACjE,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,wBAAW,iBAAiB,SAAS;AAAA,IAC7C,SAAS,KAAK;AACZ,YAAMA,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,4BAAwB,2BAAY,CAAC,YAAqE;AAC9G,4BAAW,sBAAsB,OAAO;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,yBAAqB,2BAAY,CAAC,YAA4C;AAClF,4BAAW,oBAAoB,OAAO;AAAA,EACxC,GAAG,CAAC,CAAC;AAEL,QAAM,yBAAqB,2BAAY,MAAM;AAC3C,4BAAW,qBAAqB;AAAA,EAClC,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;AClGA,IAAAC,gBAAyC;AACzC,IAAAC,eAAoF;AA4EhF,IAAAC,sBAAA;AArDG,IAAM,oBAAsD,CAAC;AAAA,EAClE;AAAA,EACA,aAAa,CAAC;AAAA,EACd;AACF,MAAM;AAEJ,QAAM,mBAAe,sBAAuB,IAAI;AAChD,QAAM,eAAW,sBAA6B,IAAI;AAElD,+BAAU,MAAM;AACd,QAAI,UAAU;AACd,QAAI,CAAC,aAAa,QAAS;AAE3B,4BAAW,gBAAgB,EAAE,KAAK,CAAC,SAAS;AAC1C,UAAI,CAAC,WAAW,CAAC,aAAa,QAAS;AAEvC,YAAM,OAAO;AAAA,QACX,aAAa,MAAM,wBAAW,YAAY;AAAA,QAC1C,iBAAiB,MAAM;AACrB,cAAI;AACF,mBAAO,wBAAW,gBAAgB;AAAA,UACpC,QAAQ;AACN,mBAAO;AAAA,UACT;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAiC;AAAA,QACrC,SAAS,KAAK,mBAAmB;AAAA,QACjC,OAAO;AAAA,UACL,GAAG,KAAK,mBAAmB;AAAA,UAC3B,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;AAAA,UACzB,GAAG;AAAA,QACL;AAAA,MACF;AAEA,eAAS,UAAU,IAAI,2BAAc,MAAM,UAAU;AACrD,eAAS,QAAQ,KAAK,YAAY,aAAa,OAAO;AAAA,IACxD,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,cAAQ,MAAM,0CAA0C,GAAG;AAAA,IAC7D,CAAC;AAED,WAAO,MAAM;AACX,gBAAU;AACV,UAAI,SAAS,SAAS;AACpB,iBAAS,QAAQ,KAAK;AACtB,iBAAS,UAAU;AAAA,MACrB;AAAA,IACF;AAAA,EACF,GAAG,CAAC,OAAO,UAAU,CAAC;AAEtB,SACE;AAAA,IAAC;AAAA;AAAA,MACC,KAAK;AAAA,MACL,OAAO;AAAA,QACL,OAAO;AAAA,QACP,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,UAAU;AAAA,MACZ;AAAA;AAAA,EACF;AAEJ;","names":["import_react","import_core","error","import_react","import_core","import_jsx_runtime"]}

package/dist/index.mjs

@@ -33,7 +33,7 @@ import { GrowthRail as GrowthRail2 } from "@growth-rail/core";
 var useGrowthRail = () => {
   const [isLoading, setIsLoading] = useState2(false);
   const [error, setError] = useState2(null);
-  const initUser = useCallback(async (userId) => {
+  const initAppUser = useCallback(async (userId) => {
     setIsLoading(true);
     setError(null);
     try {
@@ -47,7 +47,7 @@ var useGrowthRail = () => {
       setIsLoading(false);
     }
   }, []);
-  const trackReward = useCallback(async (eventName) => {
+  const trackRewardEvent = useCallback(async (eventName) => {
     setIsLoading(true);
     setError(null);
     try {
@@ -70,8 +70,8 @@ var useGrowthRail = () => {
     GrowthRail2.destroyTriggerButton();
   }, []);
   return {
-    initUser,
-    trackReward,
+    initAppUser,
+    trackRewardEvent,
     showReferralDashboard,
     showFloatingButton,
     hideFloatingButton,

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/GrowthRailProvider.tsx","../src/useGrowthRail.ts","../src/ReferralDashboard.tsx"],"sourcesContent":["import React, { useEffect, useRef, useState, ReactNode } from 'react';\nimport { GrowthRail, GrowthRailOptions } from '@growth-rail/core';\n\ninterface GrowthRailProviderProps extends GrowthRailOptions {\n  userId?: string;\n  children: ReactNode;\n}\n\nexport const GrowthRailProvider: React.FC<GrowthRailProviderProps> = ({ \n  children, \n  userId,\n  ...options \n}) => {\n  const [isReady, setIsReady] = useState(GrowthRail.isInitialized());\n  const initialized = useRef(false);\n\n  useEffect(() => {\n    if (initialized.current) return;\n    initialized.current = true;\n\n    GrowthRail.init(options);\n    if (userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n    setIsReady(true);\n  }, []);\n\n  useEffect(() => {\n    if (initialized.current && userId && GrowthRail.getUserId() !== userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n  }, [userId]);\n\n  if (!isReady) return null;\n\n  return <>{children}</>;\n};\n","import { useState, useCallback } from 'react';\nimport { GrowthRail, AppUserType, ReferrerTriggerButton } from '@growth-rail/core';\n\nexport interface UseGrowthRailReturn {\n  initUser: (userId: string) => Promise<AppUserType>;\n  trackReward: (eventName?: string) => Promise<void>;\n  showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;\n  showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;\n  hideFloatingButton: () => void;\n  isLoading: boolean;\n  error: Error | null;\n}\n\nexport const useGrowthRail = (): UseGrowthRailReturn => {\n  const [isLoading, setIsLoading] = useState(false);\n  const [error, setError] = useState<Error | null>(null);\n\n  const initUser = useCallback(async (userId: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      const user = await GrowthRail.initAppUser(userId);\n      return user;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const trackReward = useCallback(async (eventName?: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      await GrowthRail.trackRewardEvent(eventName);\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const showReferralDashboard = useCallback((options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => {\n    GrowthRail.showReferralDashboard(options);\n  }, []);\n\n  const showFloatingButton = useCallback((options: Partial<ReferrerTriggerButton>) => {\n    GrowthRail.createTriggerButton(options);\n  }, []);\n\n  const hideFloatingButton = useCallback(() => {\n    GrowthRail.destroyTriggerButton();\n  }, []);\n\n  return {\n    initUser,\n    trackReward,\n    showReferralDashboard,\n    showFloatingButton,\n    hideFloatingButton,\n    isLoading,\n    error,\n  };\n};\n","import React, { useEffect, useRef } from 'react';\nimport { GrowthRail, ReferrerModalOptions, ReferralModal, ReferrerExperience } from '@growth-rail/core';\n\nexport interface ReferralDashboardProps {\n  title?: string;\n  appearance?: ReferrerModalOptions;\n  onLinkCopied?: () => void;\n}\n\nexport const ReferralDashboard: React.FC<ReferralDashboardProps> = ({\n  title,\n  appearance = {},\n  onLinkCopied,\n}) => {\n  const containerRef = useRef<HTMLDivElement>(null);\n  const modalRef = useRef<ReferralModal | null>(null);\n\n  useEffect(() => {\n    let mounted = true;\n    if (!containerRef.current) return;\n\n    GrowthRail.ensureUserReady().then((user) => {\n      if (!mounted || !containerRef.current) return;\n\n      const deps = {\n        isUserReady: () => GrowthRail.isUserReady(),\n        getReferralLink: () => {\n          try {\n            return GrowthRail.getReferralLink();\n          } catch {\n            return '';\n          }\n        },\n      };\n\n      // Construct experience config directly from BE\n      const experience: ReferrerExperience = {\n        trigger: user.referrerExperience.trigger,\n        modal: {\n          ...user.referrerExperience.modal,\n          ...(title ? { title } : {}),\n          ...appearance,\n        },\n      };\n\n      modalRef.current = new ReferralModal(deps, experience);\n      modalRef.current.show(appearance, containerRef.current);\n    }).catch((err) => {\n      console.error('GrowthRail: User initialization failed', err);\n    });\n\n    return () => {\n      mounted = false;\n      if (modalRef.current) {\n        modalRef.current.hide();\n        modalRef.current = null;\n      }\n    };\n  }, [title, appearance]);\n\n  return (\n    <div \n      ref={containerRef} \n      style={{ \n        width: '100%', \n        height: '100%', \n        minHeight: '400px',\n        position: 'relative' \n      }} \n    />\n  );\n};\n"],"mappings":";AAAA,SAAgB,WAAW,QAAQ,gBAA2B;AAC9D,SAAS,kBAAqC;AAkCrC;AA3BF,IAAM,qBAAwD,CAAC;AAAA,EACpE;AAAA,EACA;AAAA,EACA,GAAG;AACL,MAAM;AACJ,QAAM,CAAC,SAAS,UAAU,IAAI,SAAS,WAAW,cAAc,CAAC;AACjE,QAAM,cAAc,OAAO,KAAK;AAEhC,YAAU,MAAM;AACd,QAAI,YAAY,QAAS;AACzB,gBAAY,UAAU;AAEtB,eAAW,KAAK,OAAO;AACvB,QAAI,QAAQ;AACV,iBAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AACA,eAAW,IAAI;AAAA,EACjB,GAAG,CAAC,CAAC;AAEL,YAAU,MAAM;AACd,QAAI,YAAY,WAAW,UAAU,WAAW,UAAU,MAAM,QAAQ;AACtE,iBAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,MAAI,CAAC,QAAS,QAAO;AAErB,SAAO,gCAAG,UAAS;AACrB;;;ACpCA,SAAS,YAAAA,WAAU,mBAAmB;AACtC,SAAS,cAAAC,mBAAsD;AAYxD,IAAM,gBAAgB,MAA2B;AACtD,QAAM,CAAC,WAAW,YAAY,IAAID,UAAS,KAAK;AAChD,QAAM,CAAC,OAAO,QAAQ,IAAIA,UAAuB,IAAI;AAErD,QAAM,WAAW,YAAY,OAAO,WAAmB;AACrD,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,OAAO,MAAMC,YAAW,YAAY,MAAM;AAChD,aAAO;AAAA,IACT,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,cAAc,YAAY,OAAO,cAAuB;AAC5D,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAMD,YAAW,iBAAiB,SAAS;AAAA,IAC7C,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,wBAAwB,YAAY,CAAC,YAAqE;AAC9G,IAAAD,YAAW,sBAAsB,OAAO;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,qBAAqB,YAAY,CAAC,YAA4C;AAClF,IAAAA,YAAW,oBAAoB,OAAO;AAAA,EACxC,GAAG,CAAC,CAAC;AAEL,QAAM,qBAAqB,YAAY,MAAM;AAC3C,IAAAA,YAAW,qBAAqB;AAAA,EAClC,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;ACnEA,SAAgB,aAAAE,YAAW,UAAAC,eAAc;AACzC,SAAS,cAAAC,aAAkC,qBAAyC;AA4DhF,gBAAAC,YAAA;AApDG,IAAM,oBAAsD,CAAC;AAAA,EAClE;AAAA,EACA,aAAa,CAAC;AAAA,EACd;AACF,MAAM;AACJ,QAAM,eAAeF,QAAuB,IAAI;AAChD,QAAM,WAAWA,QAA6B,IAAI;AAElD,EAAAD,WAAU,MAAM;AACd,QAAI,UAAU;AACd,QAAI,CAAC,aAAa,QAAS;AAE3B,IAAAE,YAAW,gBAAgB,EAAE,KAAK,CAAC,SAAS;AAC1C,UAAI,CAAC,WAAW,CAAC,aAAa,QAAS;AAEvC,YAAM,OAAO;AAAA,QACX,aAAa,MAAMA,YAAW,YAAY;AAAA,QAC1C,iBAAiB,MAAM;AACrB,cAAI;AACF,mBAAOA,YAAW,gBAAgB;AAAA,UACpC,QAAQ;AACN,mBAAO;AAAA,UACT;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAiC;AAAA,QACrC,SAAS,KAAK,mBAAmB;AAAA,QACjC,OAAO;AAAA,UACL,GAAG,KAAK,mBAAmB;AAAA,UAC3B,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;AAAA,UACzB,GAAG;AAAA,QACL;AAAA,MACF;AAEA,eAAS,UAAU,IAAI,cAAc,MAAM,UAAU;AACrD,eAAS,QAAQ,KAAK,YAAY,aAAa,OAAO;AAAA,IACxD,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,cAAQ,MAAM,0CAA0C,GAAG;AAAA,IAC7D,CAAC;AAED,WAAO,MAAM;AACX,gBAAU;AACV,UAAI,SAAS,SAAS;AACpB,iBAAS,QAAQ,KAAK;AACtB,iBAAS,UAAU;AAAA,MACrB;AAAA,IACF;AAAA,EACF,GAAG,CAAC,OAAO,UAAU,CAAC;AAEtB,SACE,gBAAAC;AAAA,IAAC;AAAA;AAAA,MACC,KAAK;AAAA,MACL,OAAO;AAAA,QACL,OAAO;AAAA,QACP,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,UAAU;AAAA,MACZ;AAAA;AAAA,EACF;AAEJ;","names":["useState","GrowthRail","error","useEffect","useRef","GrowthRail","jsx"]}
+{"version":3,"sources":["../src/GrowthRailProvider.tsx","../src/useGrowthRail.ts","../src/ReferralDashboard.tsx"],"sourcesContent":["import React, { useEffect, useRef, useState, ReactNode } from 'react';\nimport { GrowthRail, GrowthRailOptions } from '@growth-rail/core';\n\n/**\n * Props for the GrowthRailProvider component.\n */\ninterface GrowthRailProviderProps extends GrowthRailOptions {\n  /** The unique ID for the current application user. */\n  userId?: string;\n  /** Your application components. */\n  children: ReactNode;\n}\n\n/**\n * Root provider component for GrowthRail in React applications.\n * This component initializes the SDK and manages the user's authentication state.\n * \n * Wrap your app (or a specific feature tree) with this provider.\n * \n * @example\n * <GrowthRailProvider projectSecretKey=\"your-api-key\" userId=\"user-123\">\n *   <App />\n * </GrowthRailProvider>\n */\nexport const GrowthRailProvider: React.FC<GrowthRailProviderProps> = ({ \n  children, \n  userId,\n  ...options \n}) => {\n\n  const [isReady, setIsReady] = useState(GrowthRail.isInitialized());\n  const initialized = useRef(false);\n\n  useEffect(() => {\n    if (initialized.current) return;\n    initialized.current = true;\n\n    GrowthRail.init(options);\n    if (userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n    setIsReady(true);\n  }, []);\n\n  useEffect(() => {\n    if (initialized.current && userId && GrowthRail.getUserId() !== userId) {\n      GrowthRail.initAppUser(userId).catch(console.error);\n    }\n  }, [userId]);\n\n  if (!isReady) return null;\n\n  return <>{children}</>;\n};\n","import { useState, useCallback } from 'react';\nimport { GrowthRail, AppUserType, ReferrerTriggerButton } from '@growth-rail/core';\n\n/**\n * The return type of the useGrowthRail hook.\n */\nexport interface UseGrowthRailReturn {\n  /** \n   * Initializes a user in the GrowthRail system. \n   * @param userId - Unique identifier for the user.\n   */\n  initAppUser: (userId: string) => Promise<AppUserType>;\n  /** \n   * Tracks a reward-eligible event for the current user.\n   * @param eventName - Optional name of the event.\n   */\n  trackRewardEvent: (eventName?: string) => Promise<void>;\n  /** \n   * Manually triggers the referral dashboard modal.\n   * @param options - Customization options for the modal.\n   */\n  showReferralDashboard: (options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => void;\n  /** \n   * Manually shows or updates the floating referral trigger button.\n   * @param options - Configuration for the button.\n   */\n  showFloatingButton: (options: Partial<ReferrerTriggerButton>) => void;\n  /** Hides the floating referral trigger button. */\n  hideFloatingButton: () => void;\n  /** Whether an asynchronous operation (like init or track) is in progress. */\n  isLoading: boolean;\n  /** The last error that occurred during an operation. */\n  error: Error | null;\n}\n\n/**\n * A hook that provides access to GrowthRail SDK methods and state.\n * \n * @returns An object containing methods to manage referrals and track state.\n * \n * @example\n * const { showReferralDashboard, trackRewardEvent } = useGrowthRail();\n */\nexport const useGrowthRail = (): UseGrowthRailReturn => {\n\n  const [isLoading, setIsLoading] = useState(false);\n  const [error, setError] = useState<Error | null>(null);\n\n  const initAppUser = useCallback(async (userId: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      const user = await GrowthRail.initAppUser(userId);\n      return user;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const trackRewardEvent = useCallback(async (eventName?: string) => {\n    setIsLoading(true);\n    setError(null);\n    try {\n      await GrowthRail.trackRewardEvent(eventName);\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      setError(error);\n      throw error;\n    } finally {\n      setIsLoading(false);\n    }\n  }, []);\n\n  const showReferralDashboard = useCallback((options?: Parameters<typeof GrowthRail.showReferralDashboard>[0]) => {\n    GrowthRail.showReferralDashboard(options);\n  }, []);\n\n  const showFloatingButton = useCallback((options: Partial<ReferrerTriggerButton>) => {\n    GrowthRail.createTriggerButton(options);\n  }, []);\n\n  const hideFloatingButton = useCallback(() => {\n    GrowthRail.destroyTriggerButton();\n  }, []);\n\n  return {\n    initAppUser,\n    trackRewardEvent,\n    showReferralDashboard,\n    showFloatingButton,\n    hideFloatingButton,\n    isLoading,\n    error,\n  };\n};\n","import React, { useEffect, useRef } from 'react';\nimport { GrowthRail, ReferrerModalOptions, ReferralModal, ReferrerExperience } from '@growth-rail/core';\n\n/**\n * Props for the ReferralDashboard component.\n */\nexport interface ReferralDashboardProps {\n  /** Optional override for the dashboard title. */\n  title?: string;\n  /** Customization options for the dashboard's appearance. */\n  appearance?: ReferrerModalOptions;\n  /** Callback fired when the referral link is copied to the clipboard. */\n  onLinkCopied?: () => void;\n}\n\n/**\n * An inline referral dashboard component.\n * Unlike the global modal, this component renders directly within your layout.\n * \n * @example\n * <div style={{ height: '500px' }}>\n *   <ReferralDashboard title=\"Invite your team\" />\n * </div>\n */\nexport const ReferralDashboard: React.FC<ReferralDashboardProps> = ({\n  title,\n  appearance = {},\n  onLinkCopied,\n}) => {\n\n  const containerRef = useRef<HTMLDivElement>(null);\n  const modalRef = useRef<ReferralModal | null>(null);\n\n  useEffect(() => {\n    let mounted = true;\n    if (!containerRef.current) return;\n\n    GrowthRail.ensureUserReady().then((user) => {\n      if (!mounted || !containerRef.current) return;\n\n      const deps = {\n        isUserReady: () => GrowthRail.isUserReady(),\n        getReferralLink: () => {\n          try {\n            return GrowthRail.getReferralLink();\n          } catch {\n            return '';\n          }\n        },\n      };\n\n      // Construct experience config directly from BE\n      const experience: ReferrerExperience = {\n        trigger: user.referrerExperience.trigger,\n        modal: {\n          ...user.referrerExperience.modal,\n          ...(title ? { title } : {}),\n          ...appearance,\n        },\n      };\n\n      modalRef.current = new ReferralModal(deps, experience);\n      modalRef.current.show(appearance, containerRef.current);\n    }).catch((err) => {\n      console.error('GrowthRail: User initialization failed', err);\n    });\n\n    return () => {\n      mounted = false;\n      if (modalRef.current) {\n        modalRef.current.hide();\n        modalRef.current = null;\n      }\n    };\n  }, [title, appearance]);\n\n  return (\n    <div \n      ref={containerRef} \n      style={{ \n        width: '100%', \n        height: '100%', \n        minHeight: '400px',\n        position: 'relative' \n      }} \n    />\n  );\n};\n"],"mappings":";AAAA,SAAgB,WAAW,QAAQ,gBAA2B;AAC9D,SAAS,kBAAqC;AAmDrC;AA5BF,IAAM,qBAAwD,CAAC;AAAA,EACpE;AAAA,EACA;AAAA,EACA,GAAG;AACL,MAAM;AAEJ,QAAM,CAAC,SAAS,UAAU,IAAI,SAAS,WAAW,cAAc,CAAC;AACjE,QAAM,cAAc,OAAO,KAAK;AAEhC,YAAU,MAAM;AACd,QAAI,YAAY,QAAS;AACzB,gBAAY,UAAU;AAEtB,eAAW,KAAK,OAAO;AACvB,QAAI,QAAQ;AACV,iBAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AACA,eAAW,IAAI;AAAA,EACjB,GAAG,CAAC,CAAC;AAEL,YAAU,MAAM;AACd,QAAI,YAAY,WAAW,UAAU,WAAW,UAAU,MAAM,QAAQ;AACtE,iBAAW,YAAY,MAAM,EAAE,MAAM,QAAQ,KAAK;AAAA,IACpD;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,MAAI,CAAC,QAAS,QAAO;AAErB,SAAO,gCAAG,UAAS;AACrB;;;ACrDA,SAAS,YAAAA,WAAU,mBAAmB;AACtC,SAAS,cAAAC,mBAAsD;AA0CxD,IAAM,gBAAgB,MAA2B;AAEtD,QAAM,CAAC,WAAW,YAAY,IAAID,UAAS,KAAK;AAChD,QAAM,CAAC,OAAO,QAAQ,IAAIA,UAAuB,IAAI;AAErD,QAAM,cAAc,YAAY,OAAO,WAAmB;AACxD,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAM,OAAO,MAAMC,YAAW,YAAY,MAAM;AAChD,aAAO;AAAA,IACT,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmB,YAAY,OAAO,cAAuB;AACjE,iBAAa,IAAI;AACjB,aAAS,IAAI;AACb,QAAI;AACF,YAAMD,YAAW,iBAAiB,SAAS;AAAA,IAC7C,SAAS,KAAK;AACZ,YAAMC,SAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAASA,MAAK;AACd,YAAMA;AAAA,IACR,UAAE;AACA,mBAAa,KAAK;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,wBAAwB,YAAY,CAAC,YAAqE;AAC9G,IAAAD,YAAW,sBAAsB,OAAO;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,qBAAqB,YAAY,CAAC,YAA4C;AAClF,IAAAA,YAAW,oBAAoB,OAAO;AAAA,EACxC,GAAG,CAAC,CAAC;AAEL,QAAM,qBAAqB,YAAY,MAAM;AAC3C,IAAAA,YAAW,qBAAqB;AAAA,EAClC,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;AClGA,SAAgB,aAAAE,YAAW,UAAAC,eAAc;AACzC,SAAS,cAAAC,aAAkC,qBAAyC;AA4EhF,gBAAAC,YAAA;AArDG,IAAM,oBAAsD,CAAC;AAAA,EAClE;AAAA,EACA,aAAa,CAAC;AAAA,EACd;AACF,MAAM;AAEJ,QAAM,eAAeF,QAAuB,IAAI;AAChD,QAAM,WAAWA,QAA6B,IAAI;AAElD,EAAAD,WAAU,MAAM;AACd,QAAI,UAAU;AACd,QAAI,CAAC,aAAa,QAAS;AAE3B,IAAAE,YAAW,gBAAgB,EAAE,KAAK,CAAC,SAAS;AAC1C,UAAI,CAAC,WAAW,CAAC,aAAa,QAAS;AAEvC,YAAM,OAAO;AAAA,QACX,aAAa,MAAMA,YAAW,YAAY;AAAA,QAC1C,iBAAiB,MAAM;AACrB,cAAI;AACF,mBAAOA,YAAW,gBAAgB;AAAA,UACpC,QAAQ;AACN,mBAAO;AAAA,UACT;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAiC;AAAA,QACrC,SAAS,KAAK,mBAAmB;AAAA,QACjC,OAAO;AAAA,UACL,GAAG,KAAK,mBAAmB;AAAA,UAC3B,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;AAAA,UACzB,GAAG;AAAA,QACL;AAAA,MACF;AAEA,eAAS,UAAU,IAAI,cAAc,MAAM,UAAU;AACrD,eAAS,QAAQ,KAAK,YAAY,aAAa,OAAO;AAAA,IACxD,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,cAAQ,MAAM,0CAA0C,GAAG;AAAA,IAC7D,CAAC;AAED,WAAO,MAAM;AACX,gBAAU;AACV,UAAI,SAAS,SAAS;AACpB,iBAAS,QAAQ,KAAK;AACtB,iBAAS,UAAU;AAAA,MACrB;AAAA,IACF;AAAA,EACF,GAAG,CAAC,OAAO,UAAU,CAAC;AAEtB,SACE,gBAAAC;AAAA,IAAC;AAAA;AAAA,MACC,KAAK;AAAA,MACL,OAAO;AAAA,QACL,OAAO;AAAA,QACP,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,UAAU;AAAA,MACZ;AAAA;AAAA,EACF;AAEJ;","names":["useState","GrowthRail","error","useEffect","useRef","GrowthRail","jsx"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@growth-rail/react",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "description": "Growth Rail React SDK",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",
@@ -13,7 +13,9 @@
         }
     },
     "files": [
-        "dist"
+        "dist",
+        "README.md",
+        "CHANGELOG.md"
     ],
     "scripts": {
         "build": "tsup",
@@ -27,7 +29,7 @@
         "react-dom": ">=16.8"
     },
     "dependencies": {
-        "@growth-rail/core": "^2.0.0"
+        "@growth-rail/core": "^2.2.0"
     },
     "devDependencies": {
         "@growth-rail/eslint-config": "*",