import { EventOptions } from './request';
/**
 * Options used when initializing the tracker.
 */
export declare type PlausibleInitOptions = {
    /**
     * If true, pageviews will be tracked when the URL hash changes.
     * Enable this if you are using a frontend that uses hash-based routing.
     */
    readonly hashMode?: boolean;
    /**
     * Set to true if you want events to be tracked when running the site locally.
     */
    readonly trackLocalhost?: boolean;
    /**
     * The domain to bind the event to.
     * Defaults to `location.hostname`
     */
    readonly domain?: Location['hostname'];
    /**
     * The API host where the events will be sent.
     * Defaults to `'https://plausible.io'`
     */
    readonly apiHost?: string;
};
/**
 * Data passed to Plausible as events.
 */
export declare type PlausibleEventData = {
    /**
     * The URL to bind the event to.
     * Defaults to `location.href`.
     */
    readonly url?: Location['href'];
    /**
     * The referrer to bind the event to.
     * Defaults to `document.referrer`
     */
    readonly referrer?: Document['referrer'] | null;
    /**
     * The current device's width.
     * Defaults to `window.innerWidth`
     */
    readonly deviceWidth?: Window['innerWidth'];
};
/**
 * Options used when tracking Plausible events.
 */
export declare type PlausibleOptions = PlausibleInitOptions & PlausibleEventData;
/**
 * Tracks a custom event.
 *
 * Use it to track your defined goals by providing the goal's name as `eventName`.
 *
 * ### Example
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { trackEvent } = Plausible()
 *
 * // Tracks the 'signup' goal
 * 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.
 */
declare type TrackEvent = (eventName: string, options?: EventOptions, eventData?: PlausibleOptions) => void;
declare global {
    interface Window {
        plausible: TrackEvent;
    }
}
/**
 * Manually tracks a page view.
 *
 * ### Example
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { trackPageview } = Plausible()
 *
 * // Track a page view
 * trackPageview()
 * ```
 *
 * @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.
 */
declare type TrackPageview = (eventData?: PlausibleOptions, options?: EventOptions) => void;
/**
 * Cleans up all event listeners attached.
 */
declare type Cleanup = () => void;
/**
 * Tracks the current page and all further pages automatically.
 *
 * Call this if you don't want to manually manage pageview tracking.
 *
 * ### Example
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { enableAutoPageviews } = Plausible()
 *
 * // This tracks the current page view and all future ones as well
 * enableAutoPageviews()
 * ```
 *
 * The returned value is a callback that removes the added event listeners and restores `history.pushState`
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { enableAutoPageviews } = Plausible()
 *
 * const cleanup = enableAutoPageviews()
 *
 * // Remove event listeners and restore `history.pushState`
 * cleanup()
 * ```
 */
declare type EnableAutoPageviews = () => Cleanup;
/**
 * Tracks all outbound link clicks automatically
 *
 * Call this if you don't want to manually manage these links.
 *
 * It works using a **[MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)** to automagically detect link nodes throughout your application and bind `click` events to them.
 *
 * Optionally takes the same parameters as [`MutationObserver.observe`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver/observe).
 *
 * ### Example
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { enableAutoOutboundTracking } = Plausible()
 *
 * // This tracks all the existing and future outbound links on your page.
 * enableAutoOutboundTracking()
 * ```
 *
 * The returned value is a callback that removes the added event listeners and disconnects the observer
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { enableAutoOutboundTracking } = Plausible()
 *
 * const cleanup = enableAutoOutboundTracking()
 *
 * // Remove event listeners and disconnect the observer
 * cleanup()
 * ```
 */
declare type EnableAutoOutboundTracking = (targetNode?: Node & ParentNode, observerInit?: MutationObserverInit) => Cleanup;
/**
 * Initializes the tracker with your default values.
 *
 * ### Example (es module)
 * ```js
 * import Plausible from 'plausible-tracker'
 *
 * const { enableAutoPageviews, trackEvent } = Plausible({
 *   domain: 'my-app-domain.com',
 *   hashMode: true
 * })
 *
 * enableAutoPageviews()
 *
 * function onUserRegister() {
 *   trackEvent('register')
 * }
 * ```
 *
 * ### Example (commonjs)
 * ```js
 * var Plausible = require('plausible-tracker');
 *
 * var { enableAutoPageviews, trackEvent } = Plausible({
 *   domain: 'my-app-domain.com',
 *   hashMode: true
 * })
 *
 * enableAutoPageviews()
 *
 * function onUserRegister() {
 *   trackEvent('register')
 * }
 * ```
 *
 * @param defaults - Default event parameters that will be applied to all requests.
 */
export default function Plausible(defaults?: PlausibleInitOptions): {
    readonly trackEvent: TrackEvent;
    readonly trackPageview: TrackPageview;
    readonly enableAutoPageviews: EnableAutoPageviews;
    readonly enableAutoOutboundTracking: EnableAutoOutboundTracking;
};
export {};