@rudderstack/analytics-js-plugins

The Customer Data Platform for Developers

Website · Documentation · Community Slack

@rudderstack/analytics-js-plugins

RudderStack Javascript SDK plugins code that is used within the related analytics package, bundles for the legacy packaging or as separate bundle chunks for dynamic imports.

For detailed documentation on the RudderStack JavaScript SDK, click here.

Table of Contents

• Installing the package
• List of plugins

Installing the package

To install the package via npm, run the following command:

npm install @rudderstack/analytics-js-plugins --save

Note that this NPM module is only meant to be used for a browser installation. If you want to integrate RudderStack with your Node.js application, refer to the RudderStack Node.js repository.

List of plugins

• BeaconQueue: This plugin uses browser’s Beacon utility to send a batch of events to the data plane instead of a single event per request. More info: here
• ConsentManager: This plugin acts as the manager of different consent providers such as OneTrust, Ketch, etc.
• DeviceModeDestinations: A plugin to load configured device mode destinations.
• DeviceModeTransformation: A plugin to transform events before sending them to device mode destinations. Only available for enterprise customers.
• ErrorReporting: This plugin report errors (and metrics in the future) to Rudderstack (only enabled for the free tier at the moment). Currently, it utilizes Bugsnag Native SDK to capture errors.
• ExternalAnonymousId: This plugin helps customers migrate their anonymous user Ids to Rudderstack’s anonymous Id. More info: here
• GoogleLinker: This plugin loads user session data and anonymousId with Google linker for AMP URL query params.
• NativeDestinationQueue: This plugin stores incoming events in a queue and sends them to the device mode destination.
• StorageEncryption: This plugin is a lightweight alternative to encrypt/decrypt data before storing it in cookies/local storage.
• StorageEncryptionLegacy: This plugin is the existing way to encrypt/decrypt data before storing it in cookies/local storage.
• StorageMigrator: This plugin helps stored data to migrate from one encryption type to another(StorageEncryption/StorageEncryptionLegacy).
• XhrQueue: This plugin stores incoming events in a queue and sends requests to the data plane as XMLHttpRequest with a localstorage retry mechanism**.**
• OneTrust: A plugin to integrate the OneTrust consent manager. More info: here
• Bugsnag: A plugin to integrate Bugsnag as an error reporting provider (only enabled for free tier at the moment).
• Ketch: A plugin to integrate the Ketch consent manager.

How to build the plugins

• 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:modern: This outputs dist/cdn folder that contains the cdn package contents.
  • npm run build:npm: This outputs dist/npm folder that contains the npm package contents.