tpg / inuminate-js

JavaScript tracker for Inuminate Analytics

Inuminate

Privacy first, cookie-free web traffic monitor and analyser.

For multi-page sites and HTML projects, it's very simple:

<script
    src="https://cdn.jsdelivr.net/npm/@thepublicgood/[email protected]/dist/inuminate.js"
    data-inuminate-site="INUMINATE_SITE_KEY"
></script>

For SPA, you can import our library into your project:

yarn add -D "@thepublicgood/inuminate"

Import the library:

import Inuminate from '@thepublicgood/inuminate/build/Inuminate.js'

If you're using TypeScript, you can import the source:

import Inuminate from '@thepublicgood/inuminate/src/Inuminate';

If you're using Inertia JS, it's useful to update your HandleInertiaRequests.php to include your Inertia KEY in every response:

public function share(Request $request): array
{
    return array_merge(parent::share($request), [
        'inuminate' => [
            'site' => 'INUMINATE_SITE_KEY',
            // 'url' => 'https://inuminate.mysite.com', // if you are self hosting
        ]
    ]);
}

The library exposes an Inuminate class. Update your application's entry with by adding to the setup method that is passed to createInertiaApp.

import {Inuminate} from 'https://inuminate.com/tracker/inuminate';
import {Inertia} from '@inertiajs/inertia'
import {createInertiaApp, usePage} from '@inertiajs/inertia-vue3'

createInertiaApp({
    resolve: async (name) {
        //...
    },
    setup ({el, app, props, plugin}) {
        createApp({ render: () => h(app, props)})
            .use(plugin)
            .mount(el);
        
        const settings = usePage().props.value.inuminate;
        const inuminate = new Inuminate(settings.site, settings.url);

        Inertia.on('navigate', (e) => {
            inuminate.track();
        })

    }
});

Don't create a new instance of Inuminate inside the navigate event otherwise you'll lose referrer data.

If you need to pass in the referrer URL, you can do so using the withReferrer method:

inuminate.withReferrer(url).track();