@rudderstack/analytics-js 3.10.1 → 3.11.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.11.0](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.10.2...@rudderstack/analytics-js@3.11.0) (2024-11-18)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-cookies` updated to version `0.4.3`
+* `@rudderstack/analytics-js-common` updated to version `3.14.0`
+* `@rudderstack/analytics-js-plugins` updated to version `3.6.3`
+
+### Features
+
+* error handle public apis ([295793a](https://github.com/rudderlabs/rudder-sdk-js/commit/295793a2cc60172b001c3fb1bc2624bb19fa8546))
+
+## [3.10.2](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.10.1...@rudderstack/analytics-js@3.10.2) (2024-11-18)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-cookies` updated to version `0.4.2`
+* `@rudderstack/analytics-js-common` updated to version `3.13.0`
+* `@rudderstack/analytics-js-plugins` updated to version `3.6.2`
 ## [3.10.1](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.10.0...@rudderstack/analytics-js@3.10.1) (2024-11-12)
 
 ### Dependency Updates

package/dist/npm/index.d.cts

@@ -44,7 +44,7 @@ type Nullable<T> = T | null;
  * Use for parameters like properties, traits etc.
  */
 type ApiObject = {
-    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
+    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject | undefined)[] | undefined;
 };
 
 type DestinationIntgConfig = boolean | undefined | ApiObject;
@@ -418,7 +418,7 @@ interface IRudderAnalytics<T = any> {
     /**
      * Get the instance of Analytics that is set as default
      */
-    getAnalyticsInstance(writeKey?: string): T;
+    getAnalyticsInstance(writeKey?: string): T | undefined;
     /**
      * Trigger load event in buffer queue if exists
      */
@@ -502,7 +502,7 @@ interface IRudderAnalytics<T = any> {
     /**
      * To fetch the current sessionId
      */
-    getSessionId(): Nullable<number>;
+    getSessionId(): Nullable<number> | undefined;
     /**
      * To provide consent
      * @param options Consent API options
@@ -978,9 +978,13 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     /**
      * Retrieve an existing analytics instance
      */
-    getAnalyticsInstance(writeKey?: string): IAnalytics;
+    getAnalyticsInstance(writeKey?: string): IAnalytics | undefined;
     /**
-     * Create new analytics instance and trigger application lifecycle start
+     * Loads the SDK
+     * @param writeKey Source write key
+     * @param dataPlaneUrl Data plane URL
+     * @param loadOptions Additional options for loading the SDK
+     * @returns none
      */
     load(writeKey: string, dataPlaneUrl: string, loadOptions?: Partial<LoadOptions>): void;
     /**
@@ -1001,14 +1005,14 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
      * @param options
      * @param preloadedEventsArray
      */
-    private trackPageLoadedEvent;
+    trackPageLoadedEvent(events: PageLifecycleEvents[], options: ApiOptions, preloadedEventsArray: PreloadedEventCall[]): void;
     /**
      * Setup page unload tracking if enabled
      * @param events
      * @param useBeacon
      * @param options
      */
-    private setupPageUnloadTracking;
+    setupPageUnloadTracking(events: PageLifecycleEvents[], useBeacon: boolean | undefined, options: ApiOptions): void;
     /**
      * Trigger load event in buffer queue if exists and stores the
      * remaining preloaded events array in global object
@@ -1068,7 +1072,7 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     getGroupTraits(): Nullable<ApiObject> | undefined;
     startSession(sessionId?: number): void;
     endSession(): void;
-    getSessionId(): Nullable<number>;
+    getSessionId(): Nullable<number> | undefined;
     setAuthToken(token: string): void;
     consent(options?: ConsentOptions): void;
 }

package/dist/npm/index.d.mts

@@ -44,7 +44,7 @@ type Nullable<T> = T | null;
  * Use for parameters like properties, traits etc.
  */
 type ApiObject = {
-    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
+    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject | undefined)[] | undefined;
 };
 
 type DestinationIntgConfig = boolean | undefined | ApiObject;
@@ -418,7 +418,7 @@ interface IRudderAnalytics<T = any> {
     /**
      * Get the instance of Analytics that is set as default
      */
-    getAnalyticsInstance(writeKey?: string): T;
+    getAnalyticsInstance(writeKey?: string): T | undefined;
     /**
      * Trigger load event in buffer queue if exists
      */
@@ -502,7 +502,7 @@ interface IRudderAnalytics<T = any> {
     /**
      * To fetch the current sessionId
      */
-    getSessionId(): Nullable<number>;
+    getSessionId(): Nullable<number> | undefined;
     /**
      * To provide consent
      * @param options Consent API options
@@ -978,9 +978,13 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     /**
      * Retrieve an existing analytics instance
      */
-    getAnalyticsInstance(writeKey?: string): IAnalytics;
+    getAnalyticsInstance(writeKey?: string): IAnalytics | undefined;
     /**
-     * Create new analytics instance and trigger application lifecycle start
+     * Loads the SDK
+     * @param writeKey Source write key
+     * @param dataPlaneUrl Data plane URL
+     * @param loadOptions Additional options for loading the SDK
+     * @returns none
      */
     load(writeKey: string, dataPlaneUrl: string, loadOptions?: Partial<LoadOptions>): void;
     /**
@@ -1001,14 +1005,14 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
      * @param options
      * @param preloadedEventsArray
      */
-    private trackPageLoadedEvent;
+    trackPageLoadedEvent(events: PageLifecycleEvents[], options: ApiOptions, preloadedEventsArray: PreloadedEventCall[]): void;
     /**
      * Setup page unload tracking if enabled
      * @param events
      * @param useBeacon
      * @param options
      */
-    private setupPageUnloadTracking;
+    setupPageUnloadTracking(events: PageLifecycleEvents[], useBeacon: boolean | undefined, options: ApiOptions): void;
     /**
      * Trigger load event in buffer queue if exists and stores the
      * remaining preloaded events array in global object
@@ -1068,7 +1072,7 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     getGroupTraits(): Nullable<ApiObject> | undefined;
     startSession(sessionId?: number): void;
     endSession(): void;
-    getSessionId(): Nullable<number>;
+    getSessionId(): Nullable<number> | undefined;
     setAuthToken(token: string): void;
     consent(options?: ConsentOptions): void;
 }