Installations

npm install @chapeaux/cpx-reporter

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

18.14.2

NPM Version

9.5.0 Score

74.8

Supply Chain

86.6

Quality

78.4

Maintenance

100

Vulnerability

80.8

License

Pull Requests

Open

1

Total

19

Closed

8

Merged

10

Issues

Open

8

Total

8

Closed

0

Releases

Unable to fetch releases

Contributors

4

Unable to fetch Contributors

View all 4 contributors

Languages

6

JavaScript

TypeScript

HTML

Makefile

CSS

Dockerfile

JavaScript (51.17%)

TypeScript (31.27%)

HTML (17.24%)

Makefile (0.24%)

CSS (0.04%)

Dockerfile (0.04%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

chapeaux

Download Statistics

Total Downloads

36,808

Last Day

31

Last Week

143

Last Month

638

Last Year

17,986

GitHub Statistics

1 Stars

283 Commits

1 Forks

4 Branches

4 Contributors

Bundle Size

5.54 kB

Minified

2.13 kB

Minified + Gzipped

Bundlephobia

Maintainers

2

Package Meta Information

Latest Version

0.14.0

Package Id

@chapeaux/cpx-reporter@0.14.0

Unpacked Size

77.64 kB

Size

18.98 kB

File Count

13

NPM Version

9.5.0

Node Version

18.14.2

Publised On

08 Mar 2023

Total Downloads

Cumulative downloads

Total Downloads

36,808

Last day

121.4%

31

Compared to previous day

Last week

-39.1%

143

Compared to previous week

Last month

-6.2%

638

Compared to previous month

Last year

33.7%

17,986

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

Versions

CPX-REPORTER

Goals

Allow developers and content creators a consolidated mechanism to interact with the Event-Driven Data Layer (EDDL). The ReporterEvent is used to attach meaningful data to the event and forward it on to the Newsdesk listening for event reports. The CPXReporter component is used as a declarative means to listen for specific events or to fire off specific EDDL events automatically.

Installation

npm install @chapeaux/cpx-reporter
{FUTURE CDN URL}

Usage

ReporterEvent

<script type="module" src="path/to/@chapeaux/cpx-reporter/reporter.js"></script>
import { ReporterEvent } from "path/to/@chapeaux/cpx-reporter/reporter.js";
<script type="module" data-emit="cpx-report" data-event="Page Load Started" src="path/to/@chapeaux/cpx-reporter/reporter.js"></script>

cpx-reporter

<script type="module" src="path/to/@chapeaux/cpx-reporter/cpx-reporter.js></script>
import {CPXReporter} from "path/to/@chapeaux/cpx-reporter/cpx-reporter.js;
<cpx-reporter debug auto event="Page Load Completed"></cpx-reporter>
<cpx-reporter event="User Signed In" beat="kc-token-ready">...</cpx-reporter>

Contributing

Provide feedback on usage
Submit an issue or PR
Feature requests flow through CPCORE Jira Project
- Use "chapeaux" component
- Priority will be reviewed against all other requests
- No timeframe promised upon submission

To-Do

Sync all data structures with formal EDDL declarations

Events

Page Load Start
Page Load Complete
Click Events (using data-analytics-* attributes)
- Navigation Links
- Download Links
- Footer Links
- Social Links
- Tab Links
- Internal Campaign Links
Form Viewed
Form Submission Succeeded
Form Submission Failed
User Signed In
User Detected
Content Listing Displayed
Content Listing Item Clicked
Internal Campaign Clicked
Internal Campaigns Displayed
CTA Link Clicked
Download Complete
Video Started
Video Milestone Reached
Video Completed

No vulnerabilities found.

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.

3

Code-Review

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

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2025-02-03

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