npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rudderstack/analytics-js-cookies

v0.3.13

Published

RudderStack JavaScript SDK Cookies Utilities

Downloads

2,367

Readme

TypeScript


@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".

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 { 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 { getDecryptedValue } from '@rudderstack/analytics-js-cookies';

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

getDecryptedCookieBrowser

:warning: Only for browser environments

This function takes the name of the RudderStack JavaScript SDK cookie and returns the decrypted value.

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":"[email protected]","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

License

This project is licensed under the Elastic License 2.0. See the LICENSE.md file for details. Review the license terms to understand your permissions and restrictions.

If you have any questions about licensing, please contact us or refer to the official Elastic licensing page.

Contribute

We invite you to contribute to this project. For more information on how to contribute, please see here.

Contact us

For more information on any of the sections covered in this readme, you can contact us or start a conversation on our Slack channel.

Follow Us

:clap: Our Supporters

Stargazers repo roster for @rudderlabs/rudder-sdk-js

Forkers repo roster for @rudderlabs/rudder-sdk-js