npmpackage.info

@rudderstack/analytics-js-cookies

JavaScript SDK for RudderStack - the Customer Data Platform for Developers.

0.4.17

145

NOASSERTION

TypeScript

1.28 kB

10,488 5.4

Installations

npm install @rudderstack/analytics-js-cookies

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

20.11.1

NPM Version

10.2.4 Score

74.5

Supply Chain

98.9

Quality

97.6

Maintenance

100

Vulnerability

93.6

License

Pull Requests

Open

13

Total

1,849

Closed

238

Merged

1,598

Issues

Open

0

Total

88

Closed

88

Releases

622

rudderstack/analytics-js-service-worker@3.2.17

@rudderstack/analytics-js-service-worker@3.2.17

Published on 17 Dec 2024

@rudderstack/analytics-js-integrations@3.11.14

Published on 17 Dec 2024

@rudderstack/analytics-js-loading-scripts@3.0.59

Published on 17 Dec 2024

rudder-sdk-js@2.48.42

Published on 17 Dec 2024

@rudderstack/analytics-js@3.11.16

Published on 17 Dec 2024

@rudderstack/analytics-js-plugins@3.6.20

Published on 17 Dec 2024

View all 622 releases

Contributors

View all 88 contributors

Languages

TypeScript

JavaScript

HTML

Shell

TypeScript (48.61%)

JavaScript (44.44%)

HTML (6.7%)

Shell (0.24%)

Developer

rudderlabs

Download Statistics

Total Downloads

10,488

Last Day

Last Week

365

Last Month

2,290

Last Year

10,488

GitHub Statistics

145 Stars

4,074 Commits

83 Forks

13 Watching

18 Branches

88 Contributors

Bundle Size

3.09 kB

Minified

1.28 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.4.17

Package Id

@rudderstack/analytics-js-cookies@0.4.17

Unpacked Size

79.20 kB

Size

13.91 kB

File Count

NPM Version

10.2.4

Node Version

20.11.1

Publised On

17 Dec 2024

Total Downloads

Cumulative downloads

Total Downloads

10,488

Last day

-78.7%

Compared to previous day

Last week

-15.1%

365

Compared to previous week

Last month

-29%

2,290

Compared to previous month

Last year

10,488

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

Versions

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

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.

1import { getDecryptedValueBrowser } from '@rudderstack/analytics-js-cookies';
2
3const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI=';
4const decryptedCookieValue = getDecryptedValueBrowser(encryptedCookieValue);
5console.log('Decrypted Cookie Value: ', decryptedCookieValue);
6// Output:
7// 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.

1import { getDecryptedValue } from '@rudderstack/analytics-js-cookies';
2
3const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI=';
4const decryptedCookieValue = getDecryptedValue(encryptedCookieValue);
5console.log('Decrypted Cookie Value: ', decryptedCookieValue);
6// Output:
7// 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.

1import {
2  getDecryptedCookieBrowser,
3  anonymousUserIdKey,
4  userTraitsKey,
5} from '@rudderstack/analytics-js-cookies';
6
7const anonymousId = getDecryptedCookieBrowser(anonymousUserIdKey);
8console.log('Anonymous User ID: ', anonymousId);
9// Output:
10// Anonymous User ID: 2c5b6d48-ea90-43a2-a2f6-457d27f90328
11
12const userTraits = getDecryptedCookieBrowser(userTraitsKey);
13console.log('User Traits: ', userTraits);
14// Output:
15// User Traits: {"email":"abc@xyz.com","name":"John Doe"}
16
17const invalidCookie = getDecryptedCookieBrowser('invalid-cookie-name');
18console.log('Invalid Cookie: ', invalidCookie);
19// Output:
20// Invalid Cookie: null

Debugging

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

1import { getDecryptedValue } from '@rudderstack/analytics-js-cookies';
2
3const encryptedCookieValue = 'RS_ENC_v3_InRlc3QtZGF0YSI-some-random-data';
4
5// Set the debug flag to true
6const decryptedCookieValue = getDecryptedValue(encryptedCookieValue, true);
7console.log('Decrypted Cookie Value: ', decryptedCookieValue);
8
9// Output:
10// Error occurred during decryption: Unexpected non-whitespace character after JSON at position 11
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.

:clap: Our Supporters

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/check_pr_title.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/check_pr_title.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-hotfix-branch.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/create-hotfix-branch.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:148: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:198: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:248: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:146: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:243: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:108: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/housekeeping.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/housekeeping.yaml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/housekeeping.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/housekeeping.yaml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/housekeeping.yaml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/housekeeping.yaml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/trigger-sanity-suite.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/trigger-sanity-suite.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-cache-policy.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/update-cache-policy.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-cache-policy.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/update-cache-policy.yml/develop?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/draft-new-release.yml:98
Info: 0 out of 20 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 20 third-party GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.4

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@rudderstack/analytics-js-cookies

Installations

Developer Guide

Yes

ESM

20.11.1

10.2.4

Score

Pull Requests

13

1,849

238

1,598

Issues

0

88

88

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

3.09 kB

1.28 kB

Maintainers

Package Meta Information

Total Downloads

10,488

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

@rudderstack/analytics-js-cookies

APIs

getDecryptedValueBrowser

getDecryptedValue

getDecryptedCookieBrowser

Debugging

License

Contribute

Contact us

Follow Us

:clap: Our Supporters

10

10

10

10

9

8

5

2

0

0

0

0

0

5.4

/10

`getDecryptedValueBrowser`

`getDecryptedValue`

`getDecryptedCookieBrowser`