npmpackage.info

@snowplow/browser-plugin-web-vitals

Snowplow event tracker for client-side and server-side JavaScript. Add analytics to your websites, web apps and servers.

4.1.0

557

BSD-3-Clause

TypeScript

3.44 kB

137,960 3.9

Installations

npm install @snowplow/browser-plugin-web-vitals

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.20.5

NPM Version

10.8.2 Score

70.8

Supply Chain

89.3

Quality

96.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

6

Total

431

Closed

104

Merged

321

Issues

Open

89

Total

966

Closed

877

Releases

142

Version 4.1.0

4.1.0

Published on 28 Nov 2024

Version 4.0.4

4.0.4

Published on 21 Nov 2024

Version 4.0.3

4.0.3

Published on 20 Nov 2024

Version 4.0.2

4.0.2

Published on 11 Nov 2024

Version 4.0.1

4.0.1

Published on 01 Nov 2024

Version 4.0.0

4.0.0

Published on 28 Oct 2024

View all 142 releases

Contributors

View all 79 contributors

Languages

TypeScript

JavaScript

HTML

CSS

Shell

TypeScript (87.48%)

JavaScript (7.66%)

HTML (4.68%)

CSS (0.11%)

Shell (0.07%)

Developer

snowplow

Download Statistics

Total Downloads

137,960

Last Day

173

Last Week

589

Last Month

8,489

Last Year

123,138

GitHub Statistics

557 Stars

1,544 Commits

222 Forks

50 Watching

30 Branches

79 Contributors

Bundle Size

8.19 kB

Minified

3.44 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.1.0

Package Id

@snowplow/browser-plugin-web-vitals@4.1.0

Unpacked Size

617.93 kB

Size

116.64 kB

File Count

NPM Version

10.8.2

Node Version

18.20.5

Publised On

28 Nov 2024

Total Downloads

Cumulative downloads

Total Downloads

137,960

Last day

13.1%

173

Compared to previous day

Last week

-71.1%

589

Compared to previous week

Last month

-10.7%

8,489

Compared to previous month

Last year

730.8%

123,138

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Snowplow Web Vitals Tracking

Browser Plugin to be used with @snowplow/browser-tracker.

The plugin adds the capability to track web performance metrics categorized as Web Vitals. These metrics are tracked with an event based on the web_vitals schema.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

Setup repository

1npm install -g @microsoft/rush 
2git clone https://github.com/snowplow/snowplow-javascript-tracker.git
3rush update

Package Installation

With npm:

1npm install @snowplow/browser-plugin-web-vitals

Usage

Initialize your tracker with the WebVitalsPlugin:

1import { newTracker } from '@snowplow/browser-tracker';
2import { WebVitalsPlugin } from '@snowplow/browser-plugin-web-vitals';
3
4newTracker('sp1', '{{collector}}', { plugins: [ WebVitalsPlugin(/* pluginOptions */) ] });
5
6/* 
7 * Available plugin options `WebVitalsPluginOptions`:
8 * {
9 *  loadWebVitalsScript: Should the plugin immediately load the Core Web Vitals measurement script from UNPKG CDN.
10 *  webVitalsSource: The URL endpoint the Web Vitals script should be loaded from. Defaults to the UNPKG CDN.
11 *  context: Array of entity objects or entity-generating functions (the web_vitals payload is passed as a parameter) to attach to the web_vitals event.
12 * }
13 */

Choosing a Web Vitals measurement source

The default Web Vitals measurement script is loaded from the UNPKG CDN. This choice is chosen as a default but you should consider your own setup when choosing the script source. Selecting a script source from a CDN which might already be used in your website might save you from yet another connection startup time (Queueing,DNS lookup,TCP, SSL).

Another reasonable choice could be jsDelivr.

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

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.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

2

Code-Review

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

0

Token-Permissions

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

0

CII-Best-Practices

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

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: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/change_check.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/change_check.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/change_check.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/change_check.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/change_check.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/change_check.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/docs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_branch.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_branch.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_branch.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_branch.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_branch.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_branch.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_branch.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_branch.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_prerelease.yml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/publish_prerelease.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snyk.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/snyk.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snyk.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/snyk.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snyk.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/snyk.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/snyk.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/snowplow/snowplow-javascript-tracker/snyk.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/change_check.yml:44
Warn: npmCommand not pinned by hash: .github/workflows/docs.yml:24
Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:65
Warn: npmCommand not pinned by hash: .github/workflows/publish_prerelease.yml:65
Info: 0 out of 24 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 10 third-party GitHubAction dependencies pinned
Info: 0 out of 4 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

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

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.9

/10

Last Scanned on 2024-12-30

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

@snowplow/browser-plugin-web-vitals

Installations

Developer Guide

Yes

CommonJS

18.20.5

10.8.2

Score

Pull Requests

6

431

104

321

Issues

89

966

877

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

8.19 kB

3.44 kB

Maintainers

Package Meta Information

Total Downloads

137,960

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Snowplow Web Vitals Tracking

Maintainer quick start

Setup repository

Package Installation

Usage

Choosing a Web Vitals measurement source

Copyright and license

10

10

10

10

10

2

0

0

0

0

0

0

0

0

3.9

/10