rudder-sdk-js 2.21.1 → 2.22.0

package/README.md

@@ -5,7 +5,7 @@ The [**RudderStack**](https://rudderstack.com/) JavaScript SDK leverages the `ru
 > For detailed documentation on the RudderStack JavaScript SDK, click [**here**](https://docs.rudderstack.com/stream-sources/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk).
 
 | **IMPORTANT**: We have deprecated the Autotrack feature for the RudderStack JavaScript SDK. If you still wish to use it for your project, refer to [**this repository**](https://github.com/rudderlabs/rudder-sdk-js-autotrack#autotrack). |
-| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 ## Installing the JavaScript SDK
 
@@ -68,7 +68,6 @@ The APIs exported by the module are:
 - `getAnonymousId`
 - `setAnonymousId`
 
-
 ### Sample implementations
 
 Refer to the following projects for a detailed walk-through of the above steps:
@@ -78,15 +77,15 @@ Refer to the following projects for a detailed walk-through of the above steps:
 
 ### Supported browser versions
 
-| **Browser**         | **Supported Versions** |
-| :------------------ | :--------------------- |
-| Safari              | v7 or later            |
-| IE                  | v10 or later           |
-| Edge                | v15 or later           |
-| Mozilla Firefox     | v40 or later           |
-| Chrome              | v37 or later           |
-| Opera               | v23 or later           |
-| Yandex              | v14.12 or later        |
+| **Browser**     | **Supported Versions** |
+| :-------------- | :--------------------- |
+| Safari          | v7 or later            |
+| IE              | v10 or later           |
+| Edge            | v15 or later           |
+| Mozilla Firefox | v40 or later           |
+| Chrome          | v37 or later           |
+| Opera           | v23 or later           |
+| Yandex          | v14.12 or later        |
 
 > If the SDK does not work on the browser versions that you are targeting, verify if adding the browser polyfills to your application solves the issue.
 
@@ -98,26 +97,27 @@ A sample `identify()` call is shown below:
 
 ```javascript
 rudderanalytics.identify(
-  "12345", {
-    email: "name@domain.com"
-  }, {
+  '12345',
+  {
+    email: 'name@domain.com',
+  },
+  {
     page: {
-      path: "",
-      referrer: "",
-      search: "",
-      title: "",
-      url: "",
+      path: '',
+      referrer: '',
+      search: '',
+      title: '',
+      url: '',
     },
   },
   () => {
-    console.log("in identify call");
-  }
+    console.log('in identify call');
+  },
 );
 ```
 
 In the above example, the user-related information like the `userId` and `email` along with the [**contextual information**](https://docs.rudderstack.com/rudderstack-api/api-specification/rudderstack-spec/common-fields#javascript-sdk) is captured.
 
-
 > There is no need to call `identify()` for anonymous visitors to your website. Such visitors are automatically assigned an `anonymousId`.
 
 For more information on how to use the `identify` call, refer to the [**JavaScript SDK documentation**](https://docs.rudderstack.com/stream-sources/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk).
@@ -130,14 +130,15 @@ A sample `track` call is shown below:
 
 ```javascript
 rudderanalytics.track(
-  "test track event GA3", {
+  'test track event GA3',
+  {
     revenue: 30,
-    currency: "USD",
+    currency: 'USD',
     user_actual_id: 12345,
   },
   () => {
-    console.log("in track call");
-  }
+    console.log('in track call');
+  },
 );
 ```
 
@@ -153,13 +154,12 @@ An example is shown in the following snippet:
 
 ```javascript
 rudderanalytics.ready(() => {
-  console.log("we are all set!!!");
+  console.log('we are all set!!!');
 });
 ```
 
 > For more information on the other supported methods, refer to the [**JavaScript SDK APIs**](https://docs.rudderstack.com/stream-sources/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk#supported-apis).
 
-
 ## Self-Hosted control plane
 
 If you are using a device mode destination like Heap, FullStory, etc., the JavaScript SDK needs to fetch the required configuration from the [**control plane**](https://docs.rudderstack.com/get-started/rudderstack-architecture#control-plane).
@@ -175,7 +175,7 @@ rudderanalytics.load(<WRITE_KEY>, <DATA_PLANE_URL>, {
 > More information on how to get the `CONTROL_PLANE_URL` can be found [**here**](https://docs.rudderstack.com/get-started/control-plane-lite#what-is-the-control-plane-url).
 
 | **For detailed technical documentation and troubleshooting guide on the RudderStack’s JavaScript SDK, check out our [docs](https://docs.rudderstack.com/stream-sources/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk).** |
-| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 ## Contact us
 

package/index.d.ts

@@ -1,4 +1,4 @@
-declare module "rudder-sdk-js" {
+declare module 'rudder-sdk-js' {
   /**
    * Represents the integration options object
    * Example usages:
@@ -69,16 +69,13 @@ declare module "rudder-sdk-js" {
     queueOptions?: queueOptions;
     // Defaults to true
     loadIntegration?: boolean;
+    lockIntegrationsVersion?: boolean;
     // Defaults to false
     secureCookie?: boolean;
     // Defaults to "Lax" (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite)
     sameSiteCookie?: string;
     logLevel?: string;
-    getSourceConfig?: () =>
-      | string
-      | apiObject
-      | Promise<apiObject>
-      | Promise<string>;
+    getSourceConfig?: () => string | apiObject | Promise<apiObject> | Promise<string>;
     setCookieDomain?: string;
     sendAdblockPage?: boolean;
     sendAdblockPageOptions?: apiOptions;
@@ -92,7 +89,7 @@ declare module "rudder-sdk-js" {
     sessions?: {
       autoTrack?: boolean; // Defaults to true
       timeout?: number; // Defaults to 30 mins
-    }
+    };
   }
 
   /**
@@ -139,11 +136,7 @@ declare module "rudder-sdk-js" {
    * @param dataPlaneUrl
    * @param options
    */
-  function load(
-    writeKey: string,
-    dataPlaneUrl: string,
-    options?: loadOptions
-  ): void;
+  function load(writeKey: string, dataPlaneUrl: string, options?: loadOptions): void;
 
   /**
    * To register a callback for SDK ready state
@@ -164,7 +157,7 @@ declare module "rudder-sdk-js" {
     name?: string,
     properties?: apiObject,
     options?: apiOptions,
-    callback?: apiCallback
+    callback?: apiCallback,
   ): void;
 
   /**
@@ -174,12 +167,7 @@ declare module "rudder-sdk-js" {
    * @param properties
    * @param callback
    */
-  function page(
-    category: string,
-    name: string,
-    properties: apiObject,
-    callback: apiCallback
-  ): void;
+  function page(category: string, name: string, properties: apiObject, callback: apiCallback): void;
 
   /**
    * To record a page view event
@@ -200,7 +188,7 @@ declare module "rudder-sdk-js" {
     name: string,
     properties?: apiObject,
     options?: apiOptions,
-    callback?: apiCallback
+    callback?: apiCallback,
   ): void;
 
   /**
@@ -209,11 +197,7 @@ declare module "rudder-sdk-js" {
    * @param properties
    * @param callback
    */
-  function page(
-    name: string,
-    properties: apiObject,
-    callback: apiCallback
-  ): void;
+  function page(name: string, properties: apiObject, callback: apiCallback): void;
 
   /**
    *
@@ -228,11 +212,7 @@ declare module "rudder-sdk-js" {
    * @param options
    * @param callback
    */
-  function page(
-    properties: apiObject,
-    options: apiOptions,
-    callback?: apiCallback
-  ): void;
+  function page(properties: apiObject, options: apiOptions, callback?: apiCallback): void;
 
   /**
    * To record a page view event
@@ -252,7 +232,7 @@ declare module "rudder-sdk-js" {
     event: string,
     properties?: apiObject,
     options?: apiOptions,
-    callback?: apiCallback
+    callback?: apiCallback,
   ): void;
 
   /**
@@ -261,11 +241,7 @@ declare module "rudder-sdk-js" {
    * @param properties
    * @param callback
    */
-  function track(
-    event: string,
-    properties: apiObject,
-    callback: apiCallback
-  ): void;
+  function track(event: string, properties: apiObject, callback: apiCallback): void;
 
   /**
    * To record a user track event
@@ -285,7 +261,7 @@ declare module "rudder-sdk-js" {
     userId?: string,
     traits?: apiObject,
     options?: apiOptions,
-    callback?: apiCallback
+    callback?: apiCallback,
   ): void;
 
   /**
@@ -294,11 +270,7 @@ declare module "rudder-sdk-js" {
    * @param traits
    * @param callback
    */
-  function identify(
-    userId: string,
-    traits: apiObject,
-    callback: apiCallback
-  ): void;
+  function identify(userId: string, traits: apiObject, callback: apiCallback): void;
 
   /**
    * To record a user identification event
@@ -313,11 +285,7 @@ declare module "rudder-sdk-js" {
    * @param options
    * @param callback
    */
-  function identify(
-    traits: apiObject,
-    options: apiOptions,
-    callback?: apiCallback
-  ): void;
+  function identify(traits: apiObject, options: apiOptions, callback?: apiCallback): void;
 
   /**
    *
@@ -333,12 +301,7 @@ declare module "rudder-sdk-js" {
    * @param options
    * @param callback
    */
-  function alias(
-    to: string,
-    from?: string,
-    options?: apiOptions,
-    callback?: apiCallback
-  ): void;
+  function alias(to: string, from?: string, options?: apiOptions, callback?: apiCallback): void;
 
   /**
    * To record a user alias event
@@ -374,7 +337,7 @@ declare module "rudder-sdk-js" {
     groupId: string,
     traits?: apiObject,
     options?: apiOptions,
-    callback?: apiCallback
+    callback?: apiCallback,
   ): void;
 
   /**
@@ -383,11 +346,7 @@ declare module "rudder-sdk-js" {
    * @param traits
    * @param callback
    */
-  function group(
-    groupId: string,
-    traits: apiObject,
-    callback: apiCallback
-  ): void;
+  function group(groupId: string, traits: apiObject, callback: apiCallback): void;
 
   /**
    * To record a user group event
@@ -402,11 +361,7 @@ declare module "rudder-sdk-js" {
    * @param options
    * @param callback
    */
-  function group(
-    traits: apiObject,
-    options: apiOptions,
-    callback?: apiCallback
-  ): void;
+  function group(traits: apiObject, options: apiOptions, callback?: apiCallback): void;
 
   /**
    * To record a user group event
@@ -425,10 +380,7 @@ declare module "rudder-sdk-js" {
    * @param anonymousId
    * @param rudderAmpLinkerParm AMP Linker ID string
    */
-  function setAnonymousId(
-    anonymousId?: string,
-    rudderAmpLinkerParm?: string
-  ): void;
+  function setAnonymousId(anonymousId?: string, rudderAmpLinkerParm?: string): void;
 
   /**
    * Clear user information
@@ -459,12 +411,17 @@ declare module "rudder-sdk-js" {
   /**
    * To manually start user session in the SDK
    */
-   function startSession(sessionId?: number): void;
+  function startSession(sessionId?: number): void;
 
-   /**
+  /**
    * To manually end user session in the SDK
    */
-   function endSession(): void;
+  function endSession(): void;
+
+  /**
+   * To fetch the current sessionId
+   */
+  function getSessionId(): number | null;
 
   export {
     integrationOptions,
@@ -490,5 +447,6 @@ declare module "rudder-sdk-js" {
     getGroupTraits,
     startSession,
     endSession,
+    getSessionId,
   };
 }