Umami Logger

A TypeScript client for Umami Analytics. Supports all tracker features including events, page views, session identification, revenue tracking, and more.

Installation

npm install @bitprojects/umami-logger-typescript

Quick Start

import Umami from '@bitprojects/umami-logger-typescript';

Umami.initialize({
    baseUrl: 'https://your-umami-instance.com',
    websiteId: 'your-website-id',
});

// Track page view
Umami.trackPageView();

// Track event
Umami.trackEvent('button-click', { buttonId: 'signup' });

Configuration Options

Umami.initialize({
    baseUrl: 'https://your-umami-instance.com',  // Required
    websiteId: 'your-website-id',                 // Required
    hostName: 'custom-hostname.com',              // Override hostname
    tag: 'marketing-campaign',                    // Tag all events
    domains: ['example.com', 'www.example.com'],  // Restrict to domains
    doNotTrack: true,                             // Honor browser DNT
    excludeSearch: true,                          // Exclude URL query params
    excludeHash: true,                            // Exclude URL hash
    beforeSend: (payload) => {                    // Modify/filter events
        if (payload.url.includes('/admin')) return null;
        return payload;
    },
});

API

Page Views

Umami.trackPageView();
Umami.trackPageView('/custom-path');
Umami.trackPageView('/custom-path', 'variant-b'); // with per-call tag override

Events

Umami.trackEvent('signup', { plan: 'premium' });
Umami.trackEvent('click', { buttonId: 'cta' }, 'variant-b'); // with per-call tag override

Generic Track (mirrors official umami.track())

Umami.track();                                    // Page view
Umami.track('event-name');                        // Named event
Umami.track('event-name', { key: 'value' });      // Event with data
Umami.track({ url: '/custom', title: 'Custom' }); // Custom payload
Umami.track(props => ({ ...props, url: '/new' }));// Callback

Revenue Tracking

Umami.trackRevenue('purchase', 99.99, 'USD');
Umami.trackRevenue('purchase', 99.99, 'EUR', { productId: 'prod-123' });

Distinct IDs

Set a distinct ID to link all subsequent events to a specific user without sending an identify event:

Umami.setDistinctId('user-123');

// All future trackEvent and trackPageView calls will include this ID
Umami.trackEvent('purchase', { item: 'widget' });

Session Identification

Umami.identify('user-123');
Umami.identify('user-123', { name: 'John', email: '[email protected]' });
Umami.identify({ plan: 'premium' });  // Data only
Umami.clearIdentity();

Tags

// Set global tag via config (see Configuration Options above)

// Set/clear tag dynamically
Umami.setTag('campaign-summer');
Umami.clearTag();

// Override tag for a specific call
Umami.trackEvent('click', { buttonId: 'cta' }, 'variant-b');
Umami.trackPageView('/landing', 'variant-b');

Vue Router Integration

import { createRouter } from 'vue-router';
import Umami from '@bitprojects/umami-logger-typescript';

const router = createRouter({ /* routes */ });

router.afterEach((to) => {
    Umami.trackPageView(to.fullPath);
});

TypeScript

All types are exported:

import Umami, {
    UmamiConfig,
    UmamiPayload,
    EventData,
    IdentifyData
} from '@bitprojects/umami-logger-typescript';

Author

Developed by Phil0xFF, on behalf of B.IT Projects GmbH.