@bugster/bugster-js NPM

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: 'john@example.com'
});

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
});