@rudderstack/analytics-js 3.8.0 → 3.9.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.9.0](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.8.0...@rudderstack/analytics-js@3.9.0) (2024-10-25)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-cookies` updated to version `0.3.13`
+* `@rudderstack/analytics-js-common` updated to version `3.11.0`
+* `@rudderstack/analytics-js-plugins` updated to version `3.5.1`
+
+### Features
+
+* gainsight PX destination ([#1852](https://github.com/rudderlabs/rudder-sdk-js/issues/1852)) ([#1889](https://github.com/rudderlabs/rudder-sdk-js/issues/1889)) ([3a705f0](https://github.com/rudderlabs/rudder-sdk-js/commit/3a705f063bcae99c7964495ff83ad9ce8d4eb5a3))
+* track time spent on a page ([#1876](https://github.com/rudderlabs/rudder-sdk-js/issues/1876)) ([5590af7](https://github.com/rudderlabs/rudder-sdk-js/commit/5590af712dd951ce9182c06d8042794c4fe6df2f))
+
 ## [3.8.0](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.7.19...@rudderstack/analytics-js@3.8.0) (2024-10-21)
 
 ### Dependency Updates

package/dist/npm/index.d.cts

@@ -226,6 +226,20 @@ type PreConsentOptions = {
     storage?: PreConsentStorageOptions;
     events?: PreConsentEventsOptions;
 };
+declare enum PageLifecycleEvents {
+    LOADED = "Page Loaded",
+    UNLOADED = "Page Unloaded"
+}
+type PageLifecycleOptions = {
+    enabled: boolean;
+    events?: PageLifecycleEvents[];
+    options?: ApiOptions;
+};
+type AutoTrackOptions = {
+    enabled?: boolean;
+    options?: ApiOptions;
+    pageLifecycle?: PageLifecycleOptions;
+};
 /**
  * Represents the options parameter in the load API
  */
@@ -266,6 +280,7 @@ type LoadOptions = {
     externalAnonymousIdCookieName?: string;
     useServerSideCookies?: boolean;
     dataServiceEndpoint?: string;
+    autoTrack?: AutoTrackOptions;
 };
 type ConsentOptions = {
     storage?: StorageOpts;
@@ -495,6 +510,11 @@ interface IRudderAnalytics<T = any> {
     consent(options?: ConsentOptions): void;
 }
 
+type PreloadedEventCall = Array<string | any>;
+type RudderAnalyticsPreloader = {
+    [index: string]: (...args: any[]) => any;
+};
+
 /**
  * A buffer queue to serve as a store for any type of data
  */
@@ -794,11 +814,6 @@ interface ICapabilitiesManager {
     onReady(): void;
 }
 
-type PreloadedEventCall = Array<string | any>;
-type RudderAnalyticsPreloader = {
-    [index: string]: (...args: any[]) => any;
-};
-
 interface IAnalytics {
     preloadBuffer: BufferQueue<PreloadedEventCall>;
     initialized: boolean;
@@ -968,6 +983,32 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
      * Create new analytics instance and trigger application lifecycle start
      */
     load(writeKey: string, dataPlaneUrl: string, loadOptions?: Partial<LoadOptions>): void;
+    /**
+     * A function to get preloaded events array from global object
+     * @returns preloaded events array
+     */
+    getPreloadedEvents(): PreloadedEventCall[];
+    /**
+     * A function to track page lifecycle events like page loaded and page unloaded
+     * @param preloadedEventsArray
+     * @param loadOptions
+     * @returns
+     */
+    trackPageLifecycleEvents(preloadedEventsArray: PreloadedEventCall[], loadOptions?: Partial<LoadOptions>): void;
+    /**
+     * Buffer the page loaded event in the preloaded events array
+     * @param events
+     * @param options
+     * @param preloadedEventsArray
+     */
+    private trackPageLoadedEvent;
+    /**
+     * Setup page unload tracking if enabled
+     * @param events
+     * @param useBeacon
+     * @param options
+     */
+    private setupPageUnloadTracking;
     /**
      * Trigger load event in buffer queue if exists and stores the
      * remaining preloaded events array in global object

package/dist/npm/index.d.mts

@@ -226,6 +226,20 @@ type PreConsentOptions = {
     storage?: PreConsentStorageOptions;
     events?: PreConsentEventsOptions;
 };
+declare enum PageLifecycleEvents {
+    LOADED = "Page Loaded",
+    UNLOADED = "Page Unloaded"
+}
+type PageLifecycleOptions = {
+    enabled: boolean;
+    events?: PageLifecycleEvents[];
+    options?: ApiOptions;
+};
+type AutoTrackOptions = {
+    enabled?: boolean;
+    options?: ApiOptions;
+    pageLifecycle?: PageLifecycleOptions;
+};
 /**
  * Represents the options parameter in the load API
  */
@@ -266,6 +280,7 @@ type LoadOptions = {
     externalAnonymousIdCookieName?: string;
     useServerSideCookies?: boolean;
     dataServiceEndpoint?: string;
+    autoTrack?: AutoTrackOptions;
 };
 type ConsentOptions = {
     storage?: StorageOpts;
@@ -495,6 +510,11 @@ interface IRudderAnalytics<T = any> {
     consent(options?: ConsentOptions): void;
 }
 
+type PreloadedEventCall = Array<string | any>;
+type RudderAnalyticsPreloader = {
+    [index: string]: (...args: any[]) => any;
+};
+
 /**
  * A buffer queue to serve as a store for any type of data
  */
@@ -794,11 +814,6 @@ interface ICapabilitiesManager {
     onReady(): void;
 }
 
-type PreloadedEventCall = Array<string | any>;
-type RudderAnalyticsPreloader = {
-    [index: string]: (...args: any[]) => any;
-};
-
 interface IAnalytics {
     preloadBuffer: BufferQueue<PreloadedEventCall>;
     initialized: boolean;
@@ -968,6 +983,32 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
      * Create new analytics instance and trigger application lifecycle start
      */
     load(writeKey: string, dataPlaneUrl: string, loadOptions?: Partial<LoadOptions>): void;
+    /**
+     * A function to get preloaded events array from global object
+     * @returns preloaded events array
+     */
+    getPreloadedEvents(): PreloadedEventCall[];
+    /**
+     * A function to track page lifecycle events like page loaded and page unloaded
+     * @param preloadedEventsArray
+     * @param loadOptions
+     * @returns
+     */
+    trackPageLifecycleEvents(preloadedEventsArray: PreloadedEventCall[], loadOptions?: Partial<LoadOptions>): void;
+    /**
+     * Buffer the page loaded event in the preloaded events array
+     * @param events
+     * @param options
+     * @param preloadedEventsArray
+     */
+    private trackPageLoadedEvent;
+    /**
+     * Setup page unload tracking if enabled
+     * @param events
+     * @param useBeacon
+     * @param options
+     */
+    private setupPageUnloadTracking;
     /**
      * Trigger load event in buffer queue if exists and stores the
      * remaining preloaded events array in global object