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

@bugster/bugster-js

v1.1.3

Published

An SDK to capture user interactions on web applications

Downloads

284

Readme

bugster-js

bugster-js is an open-source SDK for capturing user interactions in frontend web applications. It provides a robust and flexible solution for tracking user behavior, events, and page views, helping you gain valuable insights into how users interact with your web application.

Features

  • Event Tracking: Capture custom events and user interactions.
  • Automatic Tracking: Built-in tracking for page views, clicks, form submissions, and more.
  • Session Management: Automatically manage user sessions with configurable timeout.
  • User Identification: Easy user identification and property assignment.
  • Batched Event Sending: Efficiently send events in batches to reduce network requests.
  • Flexible Storage: Choose between localStorage, cookies, or in-memory storage for persisting user data.
  • Privacy-Focused: Configurable input sanitization to protect user data.
  • Customizable: Extensive configuration options to tailor the SDK to your needs.

Installation

You can install bugster-js using npm:

npm i @bugster/bugster-js

Or using yarn:

yarn add @bugster/bugster-js

Usage

Basic Setup

import  BugsterTracker  from '@bugster/bugster-js';

const bugster = new BugsterTracker({
  apiKey: 'YOUR_API_KEY',
  endpoint: 'https://your-endpoint.bugster.app'
});

Tracking Events

// Track a custom event
bugster.capture('Button Clicked', {
  buttonId: 'submit-form',
  pageSection: 'header'
});

// Identify a user
bugster.identify('user123', {
  name: 'John Doe',
  email: '[email protected]'
});

Configuration Options

When initializing BugsterTracker, you can pass various configuration options:

const bugster = new BugsterTracker({
  apiKey: 'YOUR_API_KEY',
  endpoint: 'https://your-endpoint.bugster.app',
  batchSize: 30,
  flushInterval: 300000, // 5 minutes
  sessionTimeout: 1800000, // 30 minutes
  persistence: 'localStorage',
  capturePageview: true,
  capturePageleave: true,
  captureUtm: true,
  captureReferrer: true,
  inputDebounceTime: 500
});

API Reference

capture(eventName: string, properties: Record<string, any>)

Captures a custom event with the given name and properties.

identify(distinctId: string, properties: Record<string, any>)

Identifies a user with a unique ID and optional properties.

flush()

Manually sends all queued events to the server.

Privacy and Data Protection

bugster-js is designed with privacy in mind:

  • Sensitive input fields (e.g., passwords) are automatically sanitized.
  • You can configure which data to capture and which to ignore.
  • User data is stored securely based on your chosen persistence method.

Contributing

We welcome contributions to bugster-js! Please see our Contributing Guide for more details.

License

bugster-js is released under the MIT License.

Support

For issues, feature requests, or questions, please open an issue on our GitHub repository.