Allow changing any Matomo configuration

[An-dz]

This commit adds a configurations key in the instance that allows passing any key/value pair.

It allows passing any Matomo configuration without the need to write a specific case for each Matomo config.

I wrote this to be able to pass setSecureCookie and setRequestMethod and noticed that it would not be optimal to write a specific case for each configuration possible. I remove the userId feature because it can be passed through this new object.

[fcandi]

This looks like exactly what I am needing. So I can for example disable cookies, what I need to!!

[chrisvanmook]

This would introduce a breaking change, so I think for now we should leave it. The way we initialise the instance isn't perfect though, so we're going to think about how we can improve this.

[An-dz]

Since the version is v0 I would expect breaking changes in the API, but it can be reverted, no problem.

[jonkoops]

Yeah, we will probably change the API soon so this can be done more explicitly with chained calls on the instance rather than passing all the possible options in a config. We don't want to put more breaking changes before that as it might confuse users.

[An-dz]

Do you mean that the new API will be something like this?

instance
    .urlBase('https://LINK.TO.DOMAIN')
    .siteId(3)
    .setUserId('example_id')
    .disableCookies()
    .setSecureCookie(true)
    .setRequestMethod('POST');

[fcandi]

This would be awesome, too!

[jonkoops]

Yeah, that is basically what I have in mind as well. That and some better JSDoc for the functions plus a generic function to push entries into window._paq in case we don't have the method in our library.

[chrisvanmook]

I think that's really nice! Created an issue: #176

[chrisvanmook]

Could you add an example of a configuration here?

[fcandi]

For exmaple, like so:

const matomoInstance = createInstance({
        urlBase: 'https://matomo.example.com',
        siteId: example_id,
        configurations: [
            ['setUserId', 'example_id'],
            ['disableCookies', true]
        ]
    })

Alternatively, it could be an Array of objects. The official syntax for disabling cookies is:

window._paq.push(['disableCookies']);

So maybe, it would be nice to make the second element of the array optional.

Andreas

[An-dz]

@fcandi With this code the current way is like this:

const matomoInstance = createInstance({
    urlBase: 'https://matomo.example.com',
    siteId: example_id,
    configurations: {
        setUserId: 'example_id',
        disableCookies: true,
        setSecureCookie: true,
        setRequestMethod: 'POST',
    }
});

[fcandi]

Ok, its nice this way 👍

[chrisvanmook]

@An-dz Nice! could you add that to the readme?

[chrisvanmook]

This looks like exactly what I am needing. So I can for example disable cookies, what I need to!!

Could you perhaps add an example how you would do this in the configuration object?

[An-dz]

UserId has been reverted and added examples in the README.