@rudderstack/analytics-js-cookies

The Customer Data Platform for Developers

Website · Documentation · Community Slack

---

@rudderstack/analytics-js-cookies

RudderStack JavaScript SDK utilities for cookies in browser and Node.js environments. Use the appropriate functions for your environment.

APIs

getDecryptedValueBrowser

:warning: Only for browser environments

This function decrypts the provided encrypted RudderStack JavaScript cookie value using the RudderStack JavaScript SDK encryption version "v3".

The encrypted value should be a string starting with RS_ENC_v3_.

:warning: Any errors during decryption are swallowed by the function, returning null.

import { getDecryptedValueBrowser } from '@rudderstack/analytics-js-cookies';

const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI=';
const decryptedCookieValue = getDecryptedValueBrowser(encryptedCookieValue);
console.log('Decrypted Cookie Value: ', decryptedCookieValue);
// Output:
// Decrypted Cookie Value: test-data

getDecryptedValue

:warning: Only for Node.js environments

This function decrypts the provided encrypted RudderStack JavaScript cookie value using the RudderStack JavaScript SDK encryption version "v3".

If the provided value is either not encrypted or not properly encrypted, the function returns null.

:warning: Any errors during decryption are swallowed by the function, returning null.

import { decrypt } from '@rudderstack/analytics-js-cookies';

const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI=';
const decryptedCookieValue = decrypt(encryptedCookieValue);
console.log('Decrypted Cookie Value: ', decryptedCookieValue);
// Output:
// Decrypted Cookie Value: test-data

getDecryptedCookieBrowser

:warning: Only for browser environments

This function decrypts and returns the RudderStack JavaScript SDK cookie values.

The return type is either a string or an object as some cookies like user ID, anonymous user ID have string values while user traits are objects.

It returns null in either of the following scenarios:

• If the cookie is not present.
• If the cookie is not properly encrypted.
  • It only decrypts the cookies that are created by the RudderStack JavaScript SDK encryption version "v3".
• If the decrypted cookie value is not a valid JSON string.
• If the provided cookie name is not a valid RudderStack JavaScript SDK cookie name.

:warning: Any errors during decryption are swallowed by the function, returning null.

The following cookie keys are exported which can be used with this function:

• userIdKey: The key for the user ID cookie.
• userTraitsKey: The key for the user traits cookie.
• anonymousUserIdKey: The key for the anonymous user ID cookie.
• groupIdKey: The key for the group ID cookie.
• groupTraitsKey: The key for the group traits cookie.
• pageInitialReferrerKey: The key for the page initial referrer cookie.
• pageInitialReferringDomainKey: The key for the page initial referring domain cookie.
• sessionInfoKey: The key for the session ID cookie.
• authTokenKey: The key for the auth token cookie.

import {
  getDecryptedCookieBrowser,
  anonymousUserIdKey,
  userTraitsKey,
} from '@rudderstack/analytics-js-cookies';

const anonymousId = getDecryptedCookieBrowser(anonymousUserIdKey);
console.log('Anonymous User ID: ', anonymousId);
// Output:
// Anonymous User ID: 2c5b6d48-ea90-43a2-a2f6-457d27f90328

const userTraits = getDecryptedCookieBrowser(userTraitsKey);
console.log('User Traits: ', userTraits);
// Output:
// User Traits: {"email":"[e-mail]","name":"John Doe"}

const invalidCookie = getDecryptedCookieBrowser('invalid-cookie-name');
console.log('Invalid Cookie: ', invalidCookie);
// Output:
// Invalid Cookie: null

Debugging

As all the above APIs swallow the errors, you can set the debug argument to true to log the errors.

import { getDecryptedValue } from '@rudderstack/analytics-js-cookies';

const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI-some-random-data';

// Set the debug flag to true
const decryptedCookieValue = getDecryptedValue(encryptedCookieValue, true);
console.log('Decrypted Cookie Value: ', decryptedCookieValue);

// Output:
// Error occurred during decryption: Unexpected non-whitespace character after JSON at position 11
// Decrypted Cookie Value: null

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