This package contains the Analytics Tracker used to send analytics to our data broker.

To start, make sure that your project is setup to use Airtame's private NPM repository:

echo @airtame:registry=https://gitlab.com/api/v4/packages/npm/ >> .npmrc

And the you can simply install the library:

npm install --save @airtame/analytics

Note:

You will need to set up your NPM config to log onto our Gitlab instance:

npm config set '//gitlab.com/api/v4/packages/npm/:_authToken' "<your token>"

But you should replace your token with a token that you generate here: https://gitlab.com/profile/personal_access_tokens.

Your token should have read_api and read_repository rights to work.

A few tests are included which showcase the usage of the AnalyticsTracker class:

• analytics-tracker.test.ts

To build the library:

# Install the dependencies
npm install

# Run the build script
npm run build

After that you have the artifacts in the dist/ folder.

This is the prefered option in case you need to make changes to the library, but would like to verify these changes in a consumer project before creating a real release.

Here's the suggested way to do it:

1. Decide on the impact level of your change, major, minor or patch and then start a new pre release for that version bump. Assuming e.g. minor, issue the following:

   npm version preminor

2. This will create a new commit with the minor version bumped, and a suffix for the prerelease iteration. E.g. v1.2.3 -> v1.3.0-0.

3. Push this change to have CI trigger a new build/release cycle.

4. Test out this version in the consumer project and verify everything works as expected.

5. If further changes are neded, make them and create a new prerelease iteration like so:

   npm version prerelease

   This will increment the prerelease iteration one each time:

   v1.3.0-1 v1.3.0-2 v1.3.0-3

   Etc.

6. Repeat step 5. until satisfied and then issue a new real release:

   npm version minor