@li2/analytics 0.1.9 → 0.2.1

package/dist/index.d.mts

@@ -25,8 +25,8 @@ interface TrackLeadParams {
     clickId?: string;
     /** The name of the lead event (required) */
     eventName: string;
-    /** The unique customer ID in your system (required) */
-    customerExternalId: string;
+    /** The unique customer ID in your system (optional for anonymous tracking) */
+    customerExternalId?: string;
     /** The name of the customer */
     customerName?: string;
     /** The email address of the customer */
@@ -93,8 +93,8 @@ interface ServerTrackLeadParams {
     clickId: string;
     /** The name of the lead event (required) */
     eventName: string;
-    /** The unique customer ID in your system (required) */
-    customerExternalId: string;
+    /** The unique customer ID in your system (optional for anonymous tracking) */
+    customerExternalId?: string;
     /** The name of the customer */
     customerName?: string;
     /** The email address of the customer */
@@ -164,12 +164,26 @@ declare class Li2Analytics {
     isTrackingAvailable(): boolean;
     /**
      * Track a lead conversion event
+     * Supports both identified (with customerExternalId) and anonymous (without) tracking
      */
     trackLead(params: TrackLeadParams): Promise<TrackLeadResponse>;
     /**
      * Track a sale conversion event
      */
     trackSale(params: TrackSaleParams): Promise<TrackSaleResponse>;
+    /**
+     * Identify an anonymous user by linking them to a customer ID
+     * This triggers a merge of any anonymous tracking data into the identified customer
+     */
+    identify(params: {
+        customerExternalId: string;
+        customerEmail?: string;
+        customerName?: string;
+    }): Promise<{
+        success: boolean;
+        customerId?: string;
+        message?: string;
+    }>;
 }
 /**
  * Server-side Li2 Analytics SDK
@@ -181,6 +195,7 @@ declare class Li2ServerAnalytics {
     private log;
     /**
      * Track a lead conversion event (server-side)
+     * Supports both identified (with customerExternalId) and anonymous (without) tracking
      * @param params - Lead tracking parameters (clickId is REQUIRED)
      */
     trackLead(params: ServerTrackLeadParams): Promise<TrackLeadResponse>;
@@ -189,6 +204,21 @@ declare class Li2ServerAnalytics {
      * @param params - Sale tracking parameters (clickId is REQUIRED)
      */
     trackSale(params: ServerTrackSaleParams): Promise<TrackSaleResponse>;
+    /**
+     * Identify an anonymous user by linking them to a customer ID (server-side)
+     * This triggers a merge of any anonymous tracking data into the identified customer
+     * @param params - Identification parameters (clickId and customerExternalId are REQUIRED)
+     */
+    identify(params: {
+        clickId: string;
+        customerExternalId: string;
+        customerEmail?: string;
+        customerName?: string;
+    }): Promise<{
+        success: boolean;
+        customerId?: string;
+        message?: string;
+    }>;
 }
 /**
  * Initialize the Li2 Analytics SDK
@@ -218,6 +248,19 @@ declare function isTrackingAvailable(): boolean;
  * Convenience function that uses the singleton instance
  */
 declare function getClickId(): string | null;
+/**
+ * Identify an anonymous user
+ * Convenience function that uses the singleton instance
+ */
+declare function identify(params: {
+    customerExternalId: string;
+    customerEmail?: string;
+    customerName?: string;
+}): Promise<{
+    success: boolean;
+    customerId?: string;
+    message?: string;
+}>;
 
 /**
  * Initialize the server-side Li2 Analytics SDK
@@ -229,9 +272,10 @@ declare const _default: {
     getInstance: typeof getInstance;
     trackLead: typeof trackLead;
     trackSale: typeof trackSale;
+    identify: typeof identify;
     isTrackingAvailable: typeof isTrackingAvailable;
     getClickId: typeof getClickId;
     initServer: typeof initServer;
 };
 
-export { type CookieOptions, Li2Analytics, type Li2Config, Li2ServerAnalytics, type Li2ServerConfig, type ServerTrackLeadParams, type ServerTrackSaleParams, type TrackLeadParams, type TrackLeadResponse, type TrackSaleParams, type TrackSaleResponse, _default as default, getClickId, getInstance, init, initServer, isTrackingAvailable, trackLead, trackSale };
+export { type CookieOptions, Li2Analytics, type Li2Config, Li2ServerAnalytics, type Li2ServerConfig, type ServerTrackLeadParams, type ServerTrackSaleParams, type TrackLeadParams, type TrackLeadResponse, type TrackSaleParams, type TrackSaleResponse, _default as default, getClickId, getInstance, identify, init, initServer, isTrackingAvailable, trackLead, trackSale };

package/dist/index.d.ts

@@ -25,8 +25,8 @@ interface TrackLeadParams {
     clickId?: string;
     /** The name of the lead event (required) */
     eventName: string;
-    /** The unique customer ID in your system (required) */
-    customerExternalId: string;
+    /** The unique customer ID in your system (optional for anonymous tracking) */
+    customerExternalId?: string;
     /** The name of the customer */
     customerName?: string;
     /** The email address of the customer */
@@ -93,8 +93,8 @@ interface ServerTrackLeadParams {
     clickId: string;
     /** The name of the lead event (required) */
     eventName: string;
-    /** The unique customer ID in your system (required) */
-    customerExternalId: string;
+    /** The unique customer ID in your system (optional for anonymous tracking) */
+    customerExternalId?: string;
     /** The name of the customer */
     customerName?: string;
     /** The email address of the customer */
@@ -164,12 +164,26 @@ declare class Li2Analytics {
     isTrackingAvailable(): boolean;
     /**
      * Track a lead conversion event
+     * Supports both identified (with customerExternalId) and anonymous (without) tracking
      */
     trackLead(params: TrackLeadParams): Promise<TrackLeadResponse>;
     /**
      * Track a sale conversion event
      */
     trackSale(params: TrackSaleParams): Promise<TrackSaleResponse>;
+    /**
+     * Identify an anonymous user by linking them to a customer ID
+     * This triggers a merge of any anonymous tracking data into the identified customer
+     */
+    identify(params: {
+        customerExternalId: string;
+        customerEmail?: string;
+        customerName?: string;
+    }): Promise<{
+        success: boolean;
+        customerId?: string;
+        message?: string;
+    }>;
 }
 /**
  * Server-side Li2 Analytics SDK
@@ -181,6 +195,7 @@ declare class Li2ServerAnalytics {
     private log;
     /**
      * Track a lead conversion event (server-side)
+     * Supports both identified (with customerExternalId) and anonymous (without) tracking
      * @param params - Lead tracking parameters (clickId is REQUIRED)
      */
     trackLead(params: ServerTrackLeadParams): Promise<TrackLeadResponse>;
@@ -189,6 +204,21 @@ declare class Li2ServerAnalytics {
      * @param params - Sale tracking parameters (clickId is REQUIRED)
      */
     trackSale(params: ServerTrackSaleParams): Promise<TrackSaleResponse>;
+    /**
+     * Identify an anonymous user by linking them to a customer ID (server-side)
+     * This triggers a merge of any anonymous tracking data into the identified customer
+     * @param params - Identification parameters (clickId and customerExternalId are REQUIRED)
+     */
+    identify(params: {
+        clickId: string;
+        customerExternalId: string;
+        customerEmail?: string;
+        customerName?: string;
+    }): Promise<{
+        success: boolean;
+        customerId?: string;
+        message?: string;
+    }>;
 }
 /**
  * Initialize the Li2 Analytics SDK
@@ -218,6 +248,19 @@ declare function isTrackingAvailable(): boolean;
  * Convenience function that uses the singleton instance
  */
 declare function getClickId(): string | null;
+/**
+ * Identify an anonymous user
+ * Convenience function that uses the singleton instance
+ */
+declare function identify(params: {
+    customerExternalId: string;
+    customerEmail?: string;
+    customerName?: string;
+}): Promise<{
+    success: boolean;
+    customerId?: string;
+    message?: string;
+}>;
 
 /**
  * Initialize the server-side Li2 Analytics SDK
@@ -229,9 +272,10 @@ declare const _default: {
     getInstance: typeof getInstance;
     trackLead: typeof trackLead;
     trackSale: typeof trackSale;
+    identify: typeof identify;
     isTrackingAvailable: typeof isTrackingAvailable;
     getClickId: typeof getClickId;
     initServer: typeof initServer;
 };
 
-export { type CookieOptions, Li2Analytics, type Li2Config, Li2ServerAnalytics, type Li2ServerConfig, type ServerTrackLeadParams, type ServerTrackSaleParams, type TrackLeadParams, type TrackLeadResponse, type TrackSaleParams, type TrackSaleResponse, _default as default, getClickId, getInstance, init, initServer, isTrackingAvailable, trackLead, trackSale };
+export { type CookieOptions, Li2Analytics, type Li2Config, Li2ServerAnalytics, type Li2ServerConfig, type ServerTrackLeadParams, type ServerTrackSaleParams, type TrackLeadParams, type TrackLeadResponse, type TrackSaleParams, type TrackSaleResponse, _default as default, getClickId, getInstance, identify, init, initServer, isTrackingAvailable, trackLead, trackSale };