New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

plausible-tracker

Package Overview
Dependencies
Maintainers
2
Versions
21
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

plausible-tracker - npm Package Compare versions

Comparing version 0.2.2 to 0.3.0

9

build/main/lib/request.d.ts
export declare type EventOptions = {
/**
* Callback called when the event is successfully sent.
*/
readonly callback?: () => void;
/**
* Properties to be bound to the event.
*/
readonly props?: {
readonly [propName: string]: string;
};
};

3

build/main/lib/request.js

@@ -23,2 +23,3 @@ "use strict";

h: data.hashMode ? 1 : 0,
p: options && options.props ? JSON.stringify(options.props) : undefined,
};

@@ -39,2 +40,2 @@ const req = new XMLHttpRequest();

exports.sendEvent = sendEvent;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvcmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFrQkE7Ozs7OztHQU1HO0FBQ0gsU0FBZ0IsU0FBUyxDQUN2QixTQUFpQixFQUNqQixJQUFnQyxFQUNoQyxPQUFzQjtJQUV0QixNQUFNLFdBQVcsR0FDZiw2REFBNkQsQ0FBQyxJQUFJLENBQ2hFLFFBQVEsQ0FBQyxRQUFRLENBQ2xCLElBQUksUUFBUSxDQUFDLFFBQVEsS0FBSyxPQUFPLENBQUM7SUFFckMsSUFBSSxDQUFDLElBQUksQ0FBQyxjQUFjLElBQUksV0FBVyxFQUFFO1FBQ3ZDLE9BQU8sT0FBTyxDQUFDLElBQUksQ0FDakIsK0RBQStELENBQ2hFLENBQUM7S0FDSDtJQUVELE1BQU0sT0FBTyxHQUFpQjtRQUM1QixDQUFDLEVBQUUsU0FBUztRQUNaLENBQUMsRUFBRSxJQUFJLENBQUMsR0FBRztRQUNYLENBQUMsRUFBRSxJQUFJLENBQUMsTUFBTTtRQUNkLENBQUMsRUFBRSxJQUFJLENBQUMsUUFBUTtRQUNoQixDQUFDLEVBQUUsSUFBSSxDQUFDLFdBQVc7UUFDbkIsQ0FBQyxFQUFFLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUN6QixDQUFDO0lBRUYsTUFBTSxHQUFHLEdBQUcsSUFBSSxjQUFjLEVBQUUsQ0FBQztJQUNqQyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxPQUFPLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNwRCxHQUFHLENBQUMsZ0JBQWdCLENBQUMsY0FBYyxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBQ25ELEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBQ2xDLHFEQUFxRDtJQUNyRCxHQUFHLENBQUMsa0JBQWtCLEdBQUcsR0FBRyxFQUFFO1FBQzVCLElBQUksR0FBRyxDQUFDLFVBQVUsS0FBSyxDQUFDO1lBQUUsT0FBTztRQUNqQyxJQUFJLE9BQU8sSUFBSSxPQUFPLENBQUMsUUFBUSxFQUFFO1lBQy9CLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBQztTQUNwQjtJQUNILENBQUMsQ0FBQztBQUNKLENBQUM7QUFwQ0QsOEJBb0NDIn0=
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvcmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUEyQkE7Ozs7OztHQU1HO0FBQ0gsU0FBZ0IsU0FBUyxDQUN2QixTQUFpQixFQUNqQixJQUFnQyxFQUNoQyxPQUFzQjtJQUV0QixNQUFNLFdBQVcsR0FDZiw2REFBNkQsQ0FBQyxJQUFJLENBQ2hFLFFBQVEsQ0FBQyxRQUFRLENBQ2xCLElBQUksUUFBUSxDQUFDLFFBQVEsS0FBSyxPQUFPLENBQUM7SUFFckMsSUFBSSxDQUFDLElBQUksQ0FBQyxjQUFjLElBQUksV0FBVyxFQUFFO1FBQ3ZDLE9BQU8sT0FBTyxDQUFDLElBQUksQ0FDakIsK0RBQStELENBQ2hFLENBQUM7S0FDSDtJQUVELE1BQU0sT0FBTyxHQUFpQjtRQUM1QixDQUFDLEVBQUUsU0FBUztRQUNaLENBQUMsRUFBRSxJQUFJLENBQUMsR0FBRztRQUNYLENBQUMsRUFBRSxJQUFJLENBQUMsTUFBTTtRQUNkLENBQUMsRUFBRSxJQUFJLENBQUMsUUFBUTtRQUNoQixDQUFDLEVBQUUsSUFBSSxDQUFDLFdBQVc7UUFDbkIsQ0FBQyxFQUFFLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN4QixDQUFDLEVBQUUsT0FBTyxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTO0tBQ3hFLENBQUM7SUFFRixNQUFNLEdBQUcsR0FBRyxJQUFJLGNBQWMsRUFBRSxDQUFDO0lBQ2pDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLE9BQU8sWUFBWSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3BELEdBQUcsQ0FBQyxnQkFBZ0IsQ0FBQyxjQUFjLEVBQUUsWUFBWSxDQUFDLENBQUM7SUFDbkQsR0FBRyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDbEMscURBQXFEO0lBQ3JELEdBQUcsQ0FBQyxrQkFBa0IsR0FBRyxHQUFHLEVBQUU7UUFDNUIsSUFBSSxHQUFHLENBQUMsVUFBVSxLQUFLLENBQUM7WUFBRSxPQUFPO1FBQ2pDLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxRQUFRLEVBQUU7WUFDL0IsT0FBTyxDQUFDLFFBQVEsRUFBRSxDQUFDO1NBQ3BCO0lBQ0gsQ0FBQyxDQUFDO0FBQ0osQ0FBQztBQXJDRCw4QkFxQ0MifQ==

9

build/main/lib/tracker.d.ts

@@ -63,9 +63,12 @@ import { EventOptions } from './request';

* trackEvent('signup')
*
* // Tracks the 'Download' goal passing a 'method' property.
* trackEvent('Download', { props: { method: 'HTTP' } })
* ```
*
* @param eventName - Name of the event to track
* @param options - Event options.
* @param eventData - Optional event data to send. Defaults to the current page's data merged with the default options provided earlier.
* @param options - Event options. The only supported option at the moment is `callback` – a function that is called once the event is logged successfully.
*/
declare type TrackEvent = (eventName: string, eventData?: PlausibleOptions, options?: EventOptions) => void;
declare type TrackEvent = (eventName: string, options?: EventOptions, eventData?: PlausibleOptions) => void;
/**

@@ -85,3 +88,3 @@ * Manually tracks a page view.

* @param eventData - Optional event data to send. Defaults to the current page's data merged with the default options provided earlier.
* @param options - Event options. The only supported option at the moment is `callback` – a function that is called once the event is logged successfully.
* @param options - Event options.
*/

@@ -88,0 +91,0 @@ declare type TrackPageview = (eventData?: PlausibleOptions, options?: EventOptions) => void;

6

build/main/lib/tracker.js

@@ -43,7 +43,7 @@ "use strict";

const getConfig = () => (Object.assign({ hashMode: false, trackLocalhost: false, url: location.href, domain: location.hostname, referrer: document.referrer || null, deviceWidth: window.innerWidth, apiHost: 'https://plausible.io' }, defaults));
const trackEvent = (eventName, eventData, options) => {
const trackEvent = (eventName, options, eventData) => {
request_1.sendEvent(eventName, Object.assign(Object.assign({}, getConfig()), eventData), options);
};
const trackPageview = (eventData, options) => {
trackEvent('pageview', eventData, options);
trackEvent('pageview', options, eventData);
};

@@ -82,2 +82,2 @@ const enableAutoPageviews = () => {

exports.default = Plausible;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHJhY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHVDQUFvRDtBQXFJcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9DRztBQUNILFNBQXdCLFNBQVMsQ0FDL0IsUUFBK0I7SUFNL0IsTUFBTSxTQUFTLEdBQUcsR0FBK0IsRUFBRSxDQUFDLGlCQUNsRCxRQUFRLEVBQUUsS0FBSyxFQUNmLGNBQWMsRUFBRSxLQUFLLEVBQ3JCLEdBQUcsRUFBRSxRQUFRLENBQUMsSUFBSSxFQUNsQixNQUFNLEVBQUUsUUFBUSxDQUFDLFFBQVEsRUFDekIsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLElBQUksSUFBSSxFQUNuQyxXQUFXLEVBQUUsTUFBTSxDQUFDLFVBQVUsRUFDOUIsT0FBTyxFQUFFLHNCQUFzQixJQUM1QixRQUFRLEVBQ1gsQ0FBQztJQUVILE1BQU0sVUFBVSxHQUFlLENBQUMsU0FBUyxFQUFFLFNBQVMsRUFBRSxPQUFPLEVBQUUsRUFBRTtRQUMvRCxtQkFBUyxDQUFDLFNBQVMsa0NBQU8sU0FBUyxFQUFFLEdBQUssU0FBUyxHQUFJLE9BQU8sQ0FBQyxDQUFDO0lBQ2xFLENBQUMsQ0FBQztJQUVGLE1BQU0sYUFBYSxHQUFrQixDQUFDLFNBQVMsRUFBRSxPQUFPLEVBQUUsRUFBRTtRQUMxRCxVQUFVLENBQUMsVUFBVSxFQUFFLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUM3QyxDQUFDLENBQUM7SUFFRixNQUFNLG1CQUFtQixHQUF3QixHQUFHLEVBQUU7UUFDcEQsTUFBTSxJQUFJLEdBQUcsR0FBRyxFQUFFLENBQUMsYUFBYSxFQUFFLENBQUM7UUFDbkMsMENBQTBDO1FBQzFDLE1BQU0saUJBQWlCLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQztRQUM1QyxJQUFJLGlCQUFpQixFQUFFO1lBQ3JCLHFEQUFxRDtZQUNyRCxPQUFPLENBQUMsU0FBUyxHQUFHLFVBQVUsSUFBSSxFQUFFLEtBQUssRUFBRSxHQUFHO2dCQUM1QyxpQkFBaUIsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO2dCQUNsRCxJQUFJLEVBQUUsQ0FBQztZQUNULENBQUMsQ0FBQztZQUNGLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQztTQUNwQztRQUVELDZCQUE2QjtRQUM3QixJQUFJLFFBQVEsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFO1lBQ2pDLGdCQUFnQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQztTQUN0QztRQUVELDBCQUEwQjtRQUMxQixhQUFhLEVBQUUsQ0FBQztRQUVoQixPQUFPLFNBQVMsT0FBTztZQUNyQixJQUFJLGlCQUFpQixFQUFFO2dCQUNyQixxREFBcUQ7Z0JBQ3JELE9BQU8sQ0FBQyxTQUFTLEdBQUcsaUJBQWlCLENBQUM7Z0JBQ3RDLG1CQUFtQixDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQzthQUN2QztZQUNELElBQUksUUFBUSxJQUFJLFFBQVEsQ0FBQyxRQUFRLEVBQUU7Z0JBQ2pDLG1CQUFtQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQzthQUN6QztRQUNILENBQUMsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGLE9BQU8sRUFBRSxVQUFVLEVBQUUsYUFBYSxFQUFFLG1CQUFtQixFQUFFLENBQUM7QUFDNUQsQ0FBQztBQTVERCw0QkE0REMifQ==
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHJhY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHVDQUFvRDtBQXdJcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9DRztBQUNILFNBQXdCLFNBQVMsQ0FDL0IsUUFBK0I7SUFNL0IsTUFBTSxTQUFTLEdBQUcsR0FBK0IsRUFBRSxDQUFDLGlCQUNsRCxRQUFRLEVBQUUsS0FBSyxFQUNmLGNBQWMsRUFBRSxLQUFLLEVBQ3JCLEdBQUcsRUFBRSxRQUFRLENBQUMsSUFBSSxFQUNsQixNQUFNLEVBQUUsUUFBUSxDQUFDLFFBQVEsRUFDekIsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLElBQUksSUFBSSxFQUNuQyxXQUFXLEVBQUUsTUFBTSxDQUFDLFVBQVUsRUFDOUIsT0FBTyxFQUFFLHNCQUFzQixJQUM1QixRQUFRLEVBQ1gsQ0FBQztJQUVILE1BQU0sVUFBVSxHQUFlLENBQUMsU0FBUyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsRUFBRTtRQUMvRCxtQkFBUyxDQUFDLFNBQVMsa0NBQU8sU0FBUyxFQUFFLEdBQUssU0FBUyxHQUFJLE9BQU8sQ0FBQyxDQUFDO0lBQ2xFLENBQUMsQ0FBQztJQUVGLE1BQU0sYUFBYSxHQUFrQixDQUFDLFNBQVMsRUFBRSxPQUFPLEVBQUUsRUFBRTtRQUMxRCxVQUFVLENBQUMsVUFBVSxFQUFFLE9BQU8sRUFBRSxTQUFTLENBQUMsQ0FBQztJQUM3QyxDQUFDLENBQUM7SUFFRixNQUFNLG1CQUFtQixHQUF3QixHQUFHLEVBQUU7UUFDcEQsTUFBTSxJQUFJLEdBQUcsR0FBRyxFQUFFLENBQUMsYUFBYSxFQUFFLENBQUM7UUFDbkMsMENBQTBDO1FBQzFDLE1BQU0saUJBQWlCLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQztRQUM1QyxJQUFJLGlCQUFpQixFQUFFO1lBQ3JCLHFEQUFxRDtZQUNyRCxPQUFPLENBQUMsU0FBUyxHQUFHLFVBQVUsSUFBSSxFQUFFLEtBQUssRUFBRSxHQUFHO2dCQUM1QyxpQkFBaUIsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO2dCQUNsRCxJQUFJLEVBQUUsQ0FBQztZQUNULENBQUMsQ0FBQztZQUNGLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQztTQUNwQztRQUVELDZCQUE2QjtRQUM3QixJQUFJLFFBQVEsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFO1lBQ2pDLGdCQUFnQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQztTQUN0QztRQUVELDBCQUEwQjtRQUMxQixhQUFhLEVBQUUsQ0FBQztRQUVoQixPQUFPLFNBQVMsT0FBTztZQUNyQixJQUFJLGlCQUFpQixFQUFFO2dCQUNyQixxREFBcUQ7Z0JBQ3JELE9BQU8sQ0FBQyxTQUFTLEdBQUcsaUJBQWlCLENBQUM7Z0JBQ3RDLG1CQUFtQixDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQzthQUN2QztZQUNELElBQUksUUFBUSxJQUFJLFFBQVEsQ0FBQyxRQUFRLEVBQUU7Z0JBQ2pDLG1CQUFtQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQzthQUN6QztRQUNILENBQUMsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGLE9BQU8sRUFBRSxVQUFVLEVBQUUsYUFBYSxFQUFFLG1CQUFtQixFQUFFLENBQUM7QUFDNUQsQ0FBQztBQTVERCw0QkE0REMifQ==

9

build/module/lib/request.d.ts
export declare type EventOptions = {
/**
* Callback called when the event is successfully sent.
*/
readonly callback?: () => void;
/**
* Properties to be bound to the event.
*/
readonly props?: {
readonly [propName: string]: string;
};
};

3

build/module/lib/request.js

@@ -20,2 +20,3 @@ /**

h: data.hashMode ? 1 : 0,
p: options && options.props ? JSON.stringify(options.props) : undefined,
};

@@ -35,2 +36,2 @@ const req = new XMLHttpRequest();

}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvcmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFrQkE7Ozs7OztHQU1HO0FBQ0gsTUFBTSxVQUFVLFNBQVMsQ0FDdkIsU0FBaUIsRUFDakIsSUFBZ0MsRUFDaEMsT0FBc0I7SUFFdEIsTUFBTSxXQUFXLEdBQ2YsNkRBQTZELENBQUMsSUFBSSxDQUNoRSxRQUFRLENBQUMsUUFBUSxDQUNsQixJQUFJLFFBQVEsQ0FBQyxRQUFRLEtBQUssT0FBTyxDQUFDO0lBRXJDLElBQUksQ0FBQyxJQUFJLENBQUMsY0FBYyxJQUFJLFdBQVcsRUFBRTtRQUN2QyxPQUFPLE9BQU8sQ0FBQyxJQUFJLENBQ2pCLCtEQUErRCxDQUNoRSxDQUFDO0tBQ0g7SUFFRCxNQUFNLE9BQU8sR0FBaUI7UUFDNUIsQ0FBQyxFQUFFLFNBQVM7UUFDWixDQUFDLEVBQUUsSUFBSSxDQUFDLEdBQUc7UUFDWCxDQUFDLEVBQUUsSUFBSSxDQUFDLE1BQU07UUFDZCxDQUFDLEVBQUUsSUFBSSxDQUFDLFFBQVE7UUFDaEIsQ0FBQyxFQUFFLElBQUksQ0FBQyxXQUFXO1FBQ25CLENBQUMsRUFBRSxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7S0FDekIsQ0FBQztJQUVGLE1BQU0sR0FBRyxHQUFHLElBQUksY0FBYyxFQUFFLENBQUM7SUFDakMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsR0FBRyxJQUFJLENBQUMsT0FBTyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDcEQsR0FBRyxDQUFDLGdCQUFnQixDQUFDLGNBQWMsRUFBRSxZQUFZLENBQUMsQ0FBQztJQUNuRCxHQUFHLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUNsQyxxREFBcUQ7SUFDckQsR0FBRyxDQUFDLGtCQUFrQixHQUFHLEdBQUcsRUFBRTtRQUM1QixJQUFJLEdBQUcsQ0FBQyxVQUFVLEtBQUssQ0FBQztZQUFFLE9BQU87UUFDakMsSUFBSSxPQUFPLElBQUksT0FBTyxDQUFDLFFBQVEsRUFBRTtZQUMvQixPQUFPLENBQUMsUUFBUSxFQUFFLENBQUM7U0FDcEI7SUFDSCxDQUFDLENBQUM7QUFDSixDQUFDIn0=
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvcmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUEyQkE7Ozs7OztHQU1HO0FBQ0gsTUFBTSxVQUFVLFNBQVMsQ0FDdkIsU0FBaUIsRUFDakIsSUFBZ0MsRUFDaEMsT0FBc0I7SUFFdEIsTUFBTSxXQUFXLEdBQ2YsNkRBQTZELENBQUMsSUFBSSxDQUNoRSxRQUFRLENBQUMsUUFBUSxDQUNsQixJQUFJLFFBQVEsQ0FBQyxRQUFRLEtBQUssT0FBTyxDQUFDO0lBRXJDLElBQUksQ0FBQyxJQUFJLENBQUMsY0FBYyxJQUFJLFdBQVcsRUFBRTtRQUN2QyxPQUFPLE9BQU8sQ0FBQyxJQUFJLENBQ2pCLCtEQUErRCxDQUNoRSxDQUFDO0tBQ0g7SUFFRCxNQUFNLE9BQU8sR0FBaUI7UUFDNUIsQ0FBQyxFQUFFLFNBQVM7UUFDWixDQUFDLEVBQUUsSUFBSSxDQUFDLEdBQUc7UUFDWCxDQUFDLEVBQUUsSUFBSSxDQUFDLE1BQU07UUFDZCxDQUFDLEVBQUUsSUFBSSxDQUFDLFFBQVE7UUFDaEIsQ0FBQyxFQUFFLElBQUksQ0FBQyxXQUFXO1FBQ25CLENBQUMsRUFBRSxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDeEIsQ0FBQyxFQUFFLE9BQU8sSUFBSSxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsU0FBUztLQUN4RSxDQUFDO0lBRUYsTUFBTSxHQUFHLEdBQUcsSUFBSSxjQUFjLEVBQUUsQ0FBQztJQUNqQyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxPQUFPLFlBQVksRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNwRCxHQUFHLENBQUMsZ0JBQWdCLENBQUMsY0FBYyxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBQ25ELEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBQ2xDLHFEQUFxRDtJQUNyRCxHQUFHLENBQUMsa0JBQWtCLEdBQUcsR0FBRyxFQUFFO1FBQzVCLElBQUksR0FBRyxDQUFDLFVBQVUsS0FBSyxDQUFDO1lBQUUsT0FBTztRQUNqQyxJQUFJLE9BQU8sSUFBSSxPQUFPLENBQUMsUUFBUSxFQUFFO1lBQy9CLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBQztTQUNwQjtJQUNILENBQUMsQ0FBQztBQUNKLENBQUMifQ==

9

build/module/lib/tracker.d.ts

@@ -63,9 +63,12 @@ import { EventOptions } from './request';

* trackEvent('signup')
*
* // Tracks the 'Download' goal passing a 'method' property.
* trackEvent('Download', { props: { method: 'HTTP' } })
* ```
*
* @param eventName - Name of the event to track
* @param options - Event options.
* @param eventData - Optional event data to send. Defaults to the current page's data merged with the default options provided earlier.
* @param options - Event options. The only supported option at the moment is `callback` – a function that is called once the event is logged successfully.
*/
declare type TrackEvent = (eventName: string, eventData?: PlausibleOptions, options?: EventOptions) => void;
declare type TrackEvent = (eventName: string, options?: EventOptions, eventData?: PlausibleOptions) => void;
/**

@@ -85,3 +88,3 @@ * Manually tracks a page view.

* @param eventData - Optional event data to send. Defaults to the current page's data merged with the default options provided earlier.
* @param options - Event options. The only supported option at the moment is `callback` – a function that is called once the event is logged successfully.
* @param options - Event options.
*/

@@ -88,0 +91,0 @@ declare type TrackPageview = (eventData?: PlausibleOptions, options?: EventOptions) => void;

6

build/module/lib/tracker.js

@@ -50,7 +50,7 @@ import { sendEvent } from './request';

});
const trackEvent = (eventName, eventData, options) => {
const trackEvent = (eventName, options, eventData) => {
sendEvent(eventName, { ...getConfig(), ...eventData }, options);
};
const trackPageview = (eventData, options) => {
trackEvent('pageview', eventData, options);
trackEvent('pageview', options, eventData);
};

@@ -88,2 +88,2 @@ const enableAutoPageviews = () => {

}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHJhY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQWdCLFNBQVMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQXFJcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9DRztBQUNILE1BQU0sQ0FBQyxPQUFPLFVBQVUsU0FBUyxDQUMvQixRQUErQjtJQU0vQixNQUFNLFNBQVMsR0FBRyxHQUErQixFQUFFLENBQUMsQ0FBQztRQUNuRCxRQUFRLEVBQUUsS0FBSztRQUNmLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLEdBQUcsRUFBRSxRQUFRLENBQUMsSUFBSTtRQUNsQixNQUFNLEVBQUUsUUFBUSxDQUFDLFFBQVE7UUFDekIsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLElBQUksSUFBSTtRQUNuQyxXQUFXLEVBQUUsTUFBTSxDQUFDLFVBQVU7UUFDOUIsT0FBTyxFQUFFLHNCQUFzQjtRQUMvQixHQUFHLFFBQVE7S0FDWixDQUFDLENBQUM7SUFFSCxNQUFNLFVBQVUsR0FBZSxDQUFDLFNBQVMsRUFBRSxTQUFTLEVBQUUsT0FBTyxFQUFFLEVBQUU7UUFDL0QsU0FBUyxDQUFDLFNBQVMsRUFBRSxFQUFFLEdBQUcsU0FBUyxFQUFFLEVBQUUsR0FBRyxTQUFTLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNsRSxDQUFDLENBQUM7SUFFRixNQUFNLGFBQWEsR0FBa0IsQ0FBQyxTQUFTLEVBQUUsT0FBTyxFQUFFLEVBQUU7UUFDMUQsVUFBVSxDQUFDLFVBQVUsRUFBRSxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDN0MsQ0FBQyxDQUFDO0lBRUYsTUFBTSxtQkFBbUIsR0FBd0IsR0FBRyxFQUFFO1FBQ3BELE1BQU0sSUFBSSxHQUFHLEdBQUcsRUFBRSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ25DLDBDQUEwQztRQUMxQyxNQUFNLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUM7UUFDNUMsSUFBSSxpQkFBaUIsRUFBRTtZQUNyQixxREFBcUQ7WUFDckQsT0FBTyxDQUFDLFNBQVMsR0FBRyxVQUFVLElBQUksRUFBRSxLQUFLLEVBQUUsR0FBRztnQkFDNUMsaUJBQWlCLENBQUMsS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFDbEQsSUFBSSxFQUFFLENBQUM7WUFDVCxDQUFDLENBQUM7WUFDRixnQkFBZ0IsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLENBQUM7U0FDcEM7UUFFRCw2QkFBNkI7UUFDN0IsSUFBSSxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsRUFBRTtZQUNqQyxnQkFBZ0IsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7U0FDdEM7UUFFRCwwQkFBMEI7UUFDMUIsYUFBYSxFQUFFLENBQUM7UUFFaEIsT0FBTyxTQUFTLE9BQU87WUFDckIsSUFBSSxpQkFBaUIsRUFBRTtnQkFDckIscURBQXFEO2dCQUNyRCxPQUFPLENBQUMsU0FBUyxHQUFHLGlCQUFpQixDQUFDO2dCQUN0QyxtQkFBbUIsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLENBQUM7YUFDdkM7WUFDRCxJQUFJLFFBQVEsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFO2dCQUNqQyxtQkFBbUIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7YUFDekM7UUFDSCxDQUFDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRixPQUFPLEVBQUUsVUFBVSxFQUFFLGFBQWEsRUFBRSxtQkFBbUIsRUFBRSxDQUFDO0FBQzVELENBQUMifQ==
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHJhY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQWdCLFNBQVMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQXdJcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9DRztBQUNILE1BQU0sQ0FBQyxPQUFPLFVBQVUsU0FBUyxDQUMvQixRQUErQjtJQU0vQixNQUFNLFNBQVMsR0FBRyxHQUErQixFQUFFLENBQUMsQ0FBQztRQUNuRCxRQUFRLEVBQUUsS0FBSztRQUNmLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLEdBQUcsRUFBRSxRQUFRLENBQUMsSUFBSTtRQUNsQixNQUFNLEVBQUUsUUFBUSxDQUFDLFFBQVE7UUFDekIsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLElBQUksSUFBSTtRQUNuQyxXQUFXLEVBQUUsTUFBTSxDQUFDLFVBQVU7UUFDOUIsT0FBTyxFQUFFLHNCQUFzQjtRQUMvQixHQUFHLFFBQVE7S0FDWixDQUFDLENBQUM7SUFFSCxNQUFNLFVBQVUsR0FBZSxDQUFDLFNBQVMsRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEVBQUU7UUFDL0QsU0FBUyxDQUFDLFNBQVMsRUFBRSxFQUFFLEdBQUcsU0FBUyxFQUFFLEVBQUUsR0FBRyxTQUFTLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNsRSxDQUFDLENBQUM7SUFFRixNQUFNLGFBQWEsR0FBa0IsQ0FBQyxTQUFTLEVBQUUsT0FBTyxFQUFFLEVBQUU7UUFDMUQsVUFBVSxDQUFDLFVBQVUsRUFBRSxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUM7SUFDN0MsQ0FBQyxDQUFDO0lBRUYsTUFBTSxtQkFBbUIsR0FBd0IsR0FBRyxFQUFFO1FBQ3BELE1BQU0sSUFBSSxHQUFHLEdBQUcsRUFBRSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ25DLDBDQUEwQztRQUMxQyxNQUFNLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUM7UUFDNUMsSUFBSSxpQkFBaUIsRUFBRTtZQUNyQixxREFBcUQ7WUFDckQsT0FBTyxDQUFDLFNBQVMsR0FBRyxVQUFVLElBQUksRUFBRSxLQUFLLEVBQUUsR0FBRztnQkFDNUMsaUJBQWlCLENBQUMsS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFDbEQsSUFBSSxFQUFFLENBQUM7WUFDVCxDQUFDLENBQUM7WUFDRixnQkFBZ0IsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLENBQUM7U0FDcEM7UUFFRCw2QkFBNkI7UUFDN0IsSUFBSSxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsRUFBRTtZQUNqQyxnQkFBZ0IsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7U0FDdEM7UUFFRCwwQkFBMEI7UUFDMUIsYUFBYSxFQUFFLENBQUM7UUFFaEIsT0FBTyxTQUFTLE9BQU87WUFDckIsSUFBSSxpQkFBaUIsRUFBRTtnQkFDckIscURBQXFEO2dCQUNyRCxPQUFPLENBQUMsU0FBUyxHQUFHLGlCQUFpQixDQUFDO2dCQUN0QyxtQkFBbUIsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLENBQUM7YUFDdkM7WUFDRCxJQUFJLFFBQVEsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFO2dCQUNqQyxtQkFBbUIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7YUFDekM7UUFDSCxDQUFDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRixPQUFPLEVBQUUsVUFBVSxFQUFFLGFBQWEsRUFBRSxtQkFBbUIsRUFBRSxDQUFDO0FBQzVELENBQUMifQ==

13

CHANGELOG.md

@@ -5,2 +5,15 @@ # Changelog

## [0.3.0](https://github.com/Maronato/plausible-tracker/compare/v0.2.2...v0.3.0) (2020-11-08)
### ⚠ BREAKING CHANGES
* **tracker:** `trackEvent`'s argument order was changed. `options` became the second argument and
`eventData` became the third.
### Features
* **request:** adds support for custom event properties ([2e4b8eb](https://github.com/Maronato/plausible-tracker/commit/2e4b8eb96aa2644caf4accd2148393c2552974fd)), closes [#2](https://github.com/Maronato/plausible-tracker/issues/2)
* **tracker:** trackEvent's EventOptions are now its second parameter ([13a5999](https://github.com/Maronato/plausible-tracker/commit/13a5999660935a3537fe1d2fb381d988777e812f))
### [0.2.2](https://github.com/Maronato/plausible-tracker/compare/v0.2.1...v0.2.2) (2020-10-15)

@@ -7,0 +20,0 @@

2

package.json
{
"name": "plausible-tracker",
"version": "0.2.2",
"version": "0.3.0",
"description": "Unofficial frontend tracker to interact with Plausible Analytics",

@@ -5,0 +5,0 @@ "main": "build/main/index.js",

44

README.md

@@ -5,9 +5,10 @@ # Plausible Analytics Tracker

[![Build Status](https://travis-ci.com/Maronato/plausible-tracker.svg?branch=master)](https://travis-ci.com/Maronato/plausible-tracker) [![codecov](https://codecov.io/gh/Maronato/plausible-tracker/branch/master/graph/badge.svg)](https://codecov.io/gh/Maronato/plausible-tracker)
[![Build Status](https://travis-ci.com/plausible/plausible-tracker.svg?branch=master)](https://travis-ci.com/plausible/plausible-tracker) [![codecov](https://codecov.io/gh/plausible/plausible-tracker/branch/master/graph/badge.svg)](https://codecov.io/gh/plausible/plausible-tracker) [![Netlify Status](https://api.netlify.com/api/v1/badges/d29c0d49-6ba4-412b-af90-d21865eb40f2/deploy-status)](https://app.netlify.com/sites/plausible-tracker/deploys)
[![dependencies Status](https://david-dm.org/maronato/plausible-tracker/status.svg)](https://david-dm.org/maronato/plausible-tracker) [![devDependencies Status](https://david-dm.org/maronato/plausible-tracker/dev-status.svg)](https://david-dm.org/maronato/plausible-tracker?type=dev)
[![dependencies Status](https://david-dm.org/plausible/plausible-tracker/status.svg)](https://david-dm.org/maronato/plausible-tracker) [![devDependencies Status](https://david-dm.org/plausible/plausible-tracker/dev-status.svg)](https://david-dm.org/maronato/plausible-tracker?type=dev)
Unofficial frontend library to interact with [Plausible Analytics](https://plausible.io/).
Frontend library to interact with [Plausible Analytics](https://plausible.io/).
- [Plausible Analytics Tracker](#plausible-analytics-tracker)

@@ -53,3 +54,3 @@ - [Features](#features)

`Plausible()` accepts some [options](https://maronato.github.io/plausible-tracker/globals.html#plausibleinitoptions) that you may want to provide:
`Plausible()` accepts some [options](https://plausible-tracker.netlify.app/globals.html#plausibleinitoptions) that you may want to provide:

@@ -65,7 +66,7 @@ | Option | Type | Description | Default |

- [`trackPageview()`](https://maronato.github.io/plausible-tracker/globals.html#trackpageview): Tracks a single page view.
- [`trackEvent()`](https://maronato.github.io/plausible-tracker/globals.html#trackevent): Tracks custom events and goals
- [`enableAutoPageviews()`](https://maronato.github.io/plausible-tracker/globals.html#enableautopageviews): Enables automatic page view tracking for SPAs
- [`trackPageview()`](https://plausible-tracker.netlify.app/globals.html#trackpageview): Tracks a single page view.
- [`trackEvent()`](https://plausible-tracker.netlify.app/globals.html#trackevent): Tracks custom events and goals
- [`enableAutoPageviews()`](https://plausible-tracker.netlify.app/globals.html#enableautopageviews): Enables automatic page view tracking for SPAs
For the complete documentation on these functions and their parameters, check out the [reference documentation](https://maronato.github.io/plausible-tracker/).
For the complete documentation on these functions and their parameters, check out the [reference documentation](https://plausible-tracker.netlify.app/).

@@ -85,3 +86,3 @@ ### Tracking page views

You may also override the values you provided when initializing the tracker by passing a [similar object](https://maronato.github.io/plausible-tracker/globals.html#plausibleoptions) as the first parameter.
You may also override the values you provided when initializing the tracker by passing a [similar object](https://plausible-tracker.netlify.app/globals.html#plausibleoptions) as the first parameter.

@@ -112,6 +113,4 @@ This object takes the same options as the initialization one, plus the following:

The second parameter is an object with [some options](https://maronato.github.io/plausible-tracker/globals.html#eventoptions) similar to the ones provided by the [official Plausible script](https://docs.plausible.io/custom-event-goals).
The second parameter is an object with [some options](https://plausible-tracker.netlify.app/globals.html#eventoptions) similar to the ones provided by the [official Plausible script](https://docs.plausible.io/custom-event-goals).
The only supported option at the moment is `callback` – a function that is called once the event is logged successfully.
```ts

@@ -184,4 +183,10 @@ import Plausible from 'plausible-tracker'

As with [`trackPageview`](#tracking-page-views), you may also provide override values and a callback as the second and third parameters respectively:
Custom props can be provided using the second parameter:
```ts
// Tracks the 'Download' goal and provides a 'method' property.
trackEvent('signup', { props: { method: 'HTTP' } })
```
As with [`trackPageview`](#tracking-page-views), you may also provide override values but now through the third parameter:
```ts

@@ -194,7 +199,12 @@ import Plausible from 'plausible-tracker'

// Tracks the 'signup' goal with a different referrer and a callback
// Tracks the 'signup' goal with a callback, props and a different referrer.
trackEvent(
'signup',
{ trackLocalhost: true },
{ callback: () => console.log('done') }
{
callback: () => console.log('done'),
props: {
variation: 'button A'
}
},
{ trackLocalhost: true }
);

@@ -204,2 +214,2 @@ ```

## Reference documentation
For the full method and type documentation, check out the [reference documentation](https://maronato.github.io/plausible-tracker).
For the full method and type documentation, check out the [reference documentation](https://plausible-tracker.netlify.app).
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc