@andex/analytics v1.0.0

Andex Protocol Analytics

The @andex/analytics package is a npm package of React components and functions used to provide Analytics capability to Andex Protocol products.

This package is intended to be used with the @andex/analytics-events package, which provides the constant definitions used inside this package.

Installation

Install via npm or yarn.

yarn add @andex/analytics

npm i --save @andex/analytics

Make sure the environment variable REACT_APP_STAGING is set to false in production.

Release

Releasing is performed manually using the release Github workflow.

This repository uses semantic-release for the release process, which in turn uses the Angular commit message suggestions to identify the type of release.

Documentation

The client should be initialized before it is used. To initialize the client, pass in the API key of the application, as well as the name of the application. If the application name is not listed under OriginApplication, it should be added under the enum. An additional configuration object can be passed.

import { initializeAnalytics, OriginApplication } from '@andex/analytics'

initializeAnalytics(MY_API_KEY, OriginApplication.INTERFACE, {
    proxyUrl: MY_PROXY_URL
})

Note that an Error is thrown if the client is initialized more than once.

Before logging an event, make sure to add it under the EventName enum in the @andex/analytics-events package. To log an analytics event:

import { sendAnalyticsEvent } from '@andex/analytics'
import { EventName, ElementName } from '@andex/analytics-events'

sendAnalyticsEvent(EventName.PAGE_CLICKED, {
    elementName: ElementName.TOP_MENU
})

There is also a built in React component that logs an event when it is first mounted. You may use it as a wrapper:

import { Trace } from '@andex/analytics'
import { EventName, ModalName } from '@andex/analytics-events'


<Trace name={EventName.TOKEN_SELECTOR_OPENED} modal={ModalName.TOKEN_SELECTOR}>
    <SomeComponent/>
</Trace>

Depending on the context that <Trace/> is used in, you may have to define new values in @andex/analytics-events for the enums that are passed in as arguments such: BrowserEvent, EventName, ModalName, ElementName.

There is a React component that wraps event callbacks with logging logic:

import { TraceEvent } from '@andex/analytics'
import { EventName, ElementName } from '@andex/analytics-events'

<TraceEvent events={[Event.onClick]} name={EventName.SWAP_MAX_TOKEN_AMOUNT_SELECTED} element={ElementName.MAX_TOKEN_AMOUNT_BUTTON}>
    <SomeButton onClick={onClickHandler}/>
</TraceEvent>

Finally, you can set properties about the user of the application:

import { user } from 'analytics'
import { CustomUserProperties } from '@andex/analytics-events'

user.set(CUSTOM_USER_PROPERTIES.DARK_MODE, isDarkMode)

Example Apps

This package is used into a few of Andex Protocol repos:

• Interface
• Docs

Legal notice

Aptex Protocol encourages integrators to evaluate their own regulatory obligations when integrating this package into their products, including, but not limited to, those related to economic or trade sanctions compliance.