rudder-sdk-js 2.42.4 → 2.43.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [2.43.0](https://github.com/rudderlabs/rudder-sdk-js/compare/rudder-sdk-js@2.42.4...rudder-sdk-js@2.43.0) (2023-10-16)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-common` updated to version `3.0.0-beta.11`
+
+### Features
+
+* **analytics-js-service-worker:** deprecate service worker export of rudder-sdk-js package  in favor of the new standalone package([#1437](https://github.com/rudderlabs/rudder-sdk-js/issues/1437)) ([1797d3e](https://github.com/rudderlabs/rudder-sdk-js/commit/1797d3ef356e947a528c2de9abcfde245cc28178))
+
 ## [2.42.4](https://github.com/rudderlabs/rudder-sdk-js/compare/rudder-sdk-js@2.42.3...rudder-sdk-js@2.42.4) (2023-10-02)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
   <a href="https://rudderstack.com/">
-    <img src="https://user-images.githubusercontent.com/59817155/121357083-1c571300-c94f-11eb-8cc7-ce6df13855c9.png">
+    <img alt="RudderStack" width="512" src="https://raw.githubusercontent.com/rudderlabs/rudder-sdk-js/develop/assets/rs-logo-full-light.jpg">
   </a>
   <br />
   <caption>The Customer Data Platform for Developers</caption>
@@ -19,7 +19,7 @@
 
 ---
 
-# [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#rudderstack-javascript-sdk)RudderStack JavaScript SDK
+# RudderStack JavaScript SDK
 
 The JavaScript SDK lets you track customer event data from your website and send it to your specified destinations via RudderStack.
 
@@ -27,12 +27,14 @@ The JavaScript SDK lets you track customer event data from your website and send
 
 ## Table of Contents
 
-- [**Installing the JavaScript SDK**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#installing-the-javascript-sdk)
-- [**Identifying your users**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#identifying-users)
-- [**Tracking user actions**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#tracking-user-actions)
-- [**The `ready` API**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#the-ready-api)
-- [**Self-hosted control plane**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#self-hosted-control-plane)
-- [**Adding your own integrations**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#adding-your-own-integrations)
+- [**Installing the JavaScript SDK**](#installing-the-javascript-sdk)
+- [**Identifying your users**](#identifying-users)
+- [**Tracking user actions**](#tracking-user-actions)
+- [**The `ready` API**](#the-ready-api)
+- [**Self-hosted control plane**](#self-hosted-control-plane)
+- [**Adding your own integrations**](#adding-your-own-integrations)
+- [**Usage in Chrome Extensions**](#usage-in-chrome-extensions)
+- [**Usage in Serverless Runtimes**](#usage-in-serverless-runtimes)
 
 | **IMPORTANT**: We have deprecated the service worker export from RudderStack JavaScript SDK npm package and decoupled it to a new package. <br/>If you still wish to use it for your project, refer to [**@rudderstack/analytics-js-service-worker package**](https://www.npmjs.com/package/@rudderstack/analytics-js-service-worker). |
 | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -192,7 +194,7 @@ Refer to the following projects for a detailed walk-through of the above steps:
 
 > 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.
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#identifying-users)Identifying users
+## Identifying users
 
 The `identify` call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.
 
@@ -225,7 +227,7 @@ In the above example, the user-related information like the `userId` and `email`
 
 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).
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#tracking-user-actions)Tracking user actions
+## Tracking user actions
 
 The `track` call lets you record the customer events, i.e. the actions that they perform, along with any associated properties.
 
@@ -249,7 +251,7 @@ In the above example, the `track` method tracks the user event ‘**test track e
 
 > You can use the `track` method to track various success metrics for your website like user signups, item purchases, article bookmarks, and more.
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#the-ready-api)The `ready` API
+## The `ready` API
 
 There are cases when you may want to tap into the features provided by the end-destination SDKs to enhance tracking and other functionalities. The JavaScript SDK exposes a `ready` API with a `callback` parameter that fires when the SDK is done initializing itself and the other third-party native SDK destinations.
 
@@ -263,7 +265,7 @@ rudderanalytics.ready(() => {
 
 > 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).
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#self-hosted-control-plane)Self-Hosted control plane
+## 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).
 
@@ -280,19 +282,36 @@ rudderanalytics.load(<WRITE_KEY>, <DATA_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).** |
 | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#adding-your-own-integrations)Adding your own integrations
+## Adding your own integrations
 
 You can start adding integrations of your choice for sending the data through their respective web (JavaScript) SDKs.
 
-### [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-v1.1/README.md#how-to-build-the-sdk)How to build the SDK
+### How to build the SDK
 
 - Look for run scripts in the `package.json` file for getting the browser minified and non-minified builds. The builds are updated in the `dist` folder of the directory. Among the others, some of the important ones are:
 
-  - `npm run build:browser`: This outputs **rudder-analytics.min.js**.
-  - `npm run build:npm`: This outputs **rudder-sdk-js** folder that contains the npm package contents.
+  - `npm run build:browser`: This outputs **dist/cdn/legacy/rudder-analytics.min.js**.
+  - `npm run build:package`: This outputs **dist/npm** folder that contains the npm package contents.
 
 > We use **rollup** to build our SDKs. The configuration for it is present in `rollup-configs` folder.
 
+## Usage in Chrome Extensions
+
+RudderStack JS SDK can be used in Chrome Extensions with manifest v3, both as a content script (via the JavaScript SDK package)
+or as a background script service worker (via the [service worker package](https://www.npmjs.com/package/@rudderstack/analytics-js-service-worker)).
+
+For examples and specific details look into [Chrome Extensions Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/chrome-extension/USAGE.md)
+
+## Usage in Serverless Runtimes
+
+RudderStack JS SDK [service worker](https://www.npmjs.com/package/@rudderstack/analytics-js-service-worker) can be used
+in serverless runtimes like Cloudflare Workers or Vercel Edge functions.
+
+For examples and specific details look into:
+
+- [Vercel Edge Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)
+- [Cloudflare Worker Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)
+
 ## Contribute
 
 We would love to see you contribute to this project. Get more information on how to contribute [**here**](./CONTRIBUTING.md).