@bytem/bytem-tracker-app 0.0.6 → 0.0.8

package/README.md

@@ -16,50 +16,6 @@ Don't forget to install pods for iOS:
 cd ios && pod install
 ```
 
-## Development
-
-This project uses **Yarn** for dependency management.
-
-### Setup
-
-```bash
-yarn install
-```
-
-### Running Tests
-
-```bash
-yarn test
-```
-
-### Build
-
-```bash
-yarn build
-```
-
-## Release & Publish
-
-Automate version bump and publish via npm scripts:
-
-```bash
-# Patch release (1.0.0 -> 1.0.1)
-npm run release:patch
-
-# Minor release (1.0.0 -> 1.1.0)
-npm run release:minor
-
-# Major release (1.0.0 -> 2.0.0)
-npm run release:major
-
-# Beta prerelease (1.0.0 -> 1.0.1-beta.0)
-npm run release:beta
-```
-
-Notes:
-- These scripts bump package.json version and publish to npm.
-- `prepublishOnly` builds the package before publishing.
-- Configure auth via user-level `~/.npmrc`. Do not commit tokens in the repo.
 ## Usage
 
 ### Initialization
@@ -93,7 +49,7 @@ Track user identification when a user logs in or updates their profile.
 
 ```typescript
 // Signature: trackUser(userId: string, traits?: object)
-BytemTracker.trackUser('user_12345', {
+await BytemTracker.trackUser('user_12345', {
   email: 'user@example.com',
   age: 25,
   membership: 'gold'
@@ -104,7 +60,7 @@ BytemTracker.trackUser('user_12345', {
 Track when a user views a product details page.
 
 ```typescript
-BytemTracker.trackViewProduct({
+await BytemTracker.trackViewProduct({
   productId: 'prod_001',
   name: 'Awesome Gadget',
   price: 99.99,
@@ -117,7 +73,7 @@ BytemTracker.trackViewProduct({
 Track when a user initiates checkout.
 
 ```typescript
-BytemTracker.trackCheckOutOrder({
+await BytemTracker.trackCheckOutOrder({
   orderId: 'order_abc123',
   total: 150.00,
   currency: 'USD',
@@ -132,7 +88,7 @@ BytemTracker.trackCheckOutOrder({
 Track when a user completes a payment.
 
 ```typescript
-BytemTracker.trackPayOrder({
+await BytemTracker.trackPayOrder({
   orderId: 'order_abc123',
   total: 150.00,
   currency: 'USD',

package/dist/src/BytemTracker.d.ts

@@ -1,18 +1,139 @@
 import { TrackerConfig, Product, Order, UserTraits } from './types';
 declare class BytemTracker {
     private static instance;
-    private config;
-    private isInitialized;
-    private visitorId;
+    private readonly SDK_NAME;
+    private readonly SDK_VERSION;
     private readonly DEFAULT_ENDPOINT;
+    private readonly DEFAULT_API_PATH;
+    private appKey;
+    private baseUrl;
+    private debug;
+    private visitorId;
+    private deviceIdType;
+    private appScheme;
+    private apiPath;
+    private isInitialized;
+    private sessionStarted;
+    private useSessionCookie;
+    private sessionCookieTimeout;
+    private lastBeat;
+    private trackTime;
+    private storedDuration;
+    private lastViewTime;
+    private lastViewStoredDuration;
     private constructor();
     static getInstance(): BytemTracker;
+    /**
+     * Initializes the BytemTracker SDK with the provided configuration.
+     * This method must be called before any other tracking methods.
+     *
+     * @param config - The configuration object for the tracker.
+     * @returns A promise that resolves when initialization is complete.
+     */
     init(config: TrackerConfig): Promise<void>;
-    private track;
-    trackViewProduct(product: Product): void;
-    trackCheckOutOrder(order: Order): void;
-    trackPayOrder(order: Order): void;
-    trackUser(userId: string, traits?: UserTraits): void;
+    private ensureInitialized;
+    /**
+     * Begins a new user session.
+     * Handles session cookie logic to prevent excessive session starts if one is already active.
+     *
+     * @param force - If true, forces a new session start request even if the session cookie is valid.
+     */
+    beginSession(force?: boolean): Promise<void>;
+    /**
+     * Reports session duration to the server.
+     * Usually called internally or when app state changes.
+     *
+     * @param sec - The duration in seconds to report.
+     */
+    sessionDuration(sec: number): Promise<void>;
+    /**
+     * Ends the current user session.
+     *
+     * @param sec - Optional duration of the session in seconds. If not provided, it's calculated from the last beat.
+     * @param force - If true, forces the end session request even if using session cookies.
+     */
+    endSession(sec?: number, force?: boolean): Promise<void>;
+    /**
+     * Manually tracks or extends a session.
+     * If a session is active, it reports duration. If not, it begins a new session.
+     */
+    trackSessions(): Promise<void>;
+    /**
+     * Resumes time tracking for session duration.
+     */
+    startTime(): void;
+    /**
+     * Pauses time tracking for session duration.
+     */
+    stopTime(): void;
+    /**
+     * Tracks a custom event.
+     *
+     * @param eventKey - The unique key/name for the event.
+     * @param segmentation - Optional key-value pairs to attach to the event.
+     * @param count - The number of times this event occurred (default: 1).
+     * @param sum - Optional numeric value associated with the event (e.g., purchase amount).
+     * @param duration - Optional duration associated with the event.
+     */
+    trackEvent(eventKey: string, segmentation?: Record<string, any>, count?: number, sum?: number, duration?: number): Promise<void>;
+    /**
+     * Tracks a page view.
+     * Automatically handles reporting the duration of the previous page view.
+     *
+     * @param current - The name or path of the current page.
+     * @param referrer - Optional name or path of the previous page.
+     */
+    trackPageview(current: string, referrer?: string): Promise<void>;
+    /**
+     * Tracks a click on a product/goods item.
+     *
+     * @param params - The parameters for the goods click event.
+     */
+    trackGoodsClick(params: {
+        gid?: string;
+        skuid?: string;
+        url: string;
+        source?: string;
+        position?: string;
+        current?: string;
+        referrer?: string;
+    }): Promise<void>;
+    private reportViewDuration;
+    private getRealDeviceId;
+    private getMetrics;
+    private buildBaseRequestParams;
+    private extendSession;
+    private sendRequest;
+    /**
+     * Tracks a product view event.
+     * Maps the product details to a 'view_product' event.
+     *
+     * @param product - The product object to track.
+     */
+    trackViewProduct(product: Product): Promise<void>;
+    /**
+     * Tracks a checkout order event.
+     * Automatically splits product lists into parallel arrays (gids, prices, quantities)
+     * to match the backend requirement.
+     *
+     * @param order - The order object containing products to checkout.
+     */
+    trackCheckOutOrder(order: Order): Promise<void>;
+    /**
+     * Tracks a payment order event.
+     * Maps product list to a 'goods' array structure expected by the backend.
+     *
+     * @param order - The order object that was paid for.
+     */
+    trackPayOrder(order: Order): Promise<void>;
+    /**
+     * Tracks user details/profile updates.
+     *
+     * @param userId - The unique identifier for the user.
+     * @param traits - Additional user properties (email, name, custom fields).
+     */
+    trackUser(userId: string, traits?: UserTraits): Promise<void>;
+    private sendUserDetails;
 }
 declare const _default: BytemTracker;
 export default _default;