@epigraph/epigraph-analytics
TypeScript icon, indicating that this package has built-in type declarations

0.5.0 • Public • Published

Epigraph-Analytics User Guide

Quick Start Guide

In order to install Epigraph-Analytics into your project, run the following command in your terminal: npm i @epigraph/epigraph-analytics --save-dev

Next import it into your project using import {EpigraphAnalytics, GA3AnalyticsPlugin, GA4AnalyticsPlugin} from '@epigraph/epigraph-analytics'; and save an instance of it to a variable in the constructor:

   constructor() {
    super();
    this[$epigraphAnalytics] = new EpigraphAnalytics();
  }

Next you can add any amount of analytics plugins that you wish. If using Lit, it is typically good to do this in connectedCallback().

public connectedCallback() {
  this[$epigraphAnalytics].addEventPlugin(new GA3AnalyticsPlugin(this.uaCode, this.verboseLogging, 'user name', 'tracker name'));
  this[$epigraphAnalytics].addEventPlugin(new GA4AnalyticsPlugin(this.gaMeasurementId, this.verboseLogging));
}

To set up analytics events that you wish to send, they need to be in the following format:

const EVENT_EXAMPLE: AnalyticsEvent = {
  type: 'event',
  category: 'Event Category',
  action: 'Event Action',
  label: 'Event Label',
  interaction: {'nonInteraction': false}
};

NOTE: Make sure to set 'noninteraction':true for events that don't trigger on user interaction, like page load, otherwise they may not report the data correctly.

In order to send your events, use the following method:

this[$epigraphAnalytics].sendEvent(EVENT_EXAMPLE);

This will automatically send the event to every plugin you have set up.

Methods

Method Type Description
addEventPlugin (plugin: IAnalyticsPlugin): void public method to add Google Analytics 3 or Google Analytics 4 plugin
sendEvent (eventData: AnalyticsEvent): void public method to send AnalyticsEvent from plugin

Plugin Parameters

Parameter Type Description
trackingID string tracking ID associated with your Universal Analytics or Google Analytics 4 property (likely a ua-code or ga-measurement-id)
verboseLogging boolean enables error logging for analytics methods
user string name of the user for the analytics events (for example, 'client' or 'epigraph')
verboseLogging boolean enables error logging for analytics methods
trackerName string name of the tracker (Google Analytics 3 only)

TSDX User Guide

Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.

This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use ts-node-dev, plain ts-node, or simple tsc.

If you’re new to TypeScript, checkout this handy cheatsheet

Commands

TSDX scaffolds your new library inside /src.

To run TSDX, use:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Setup Files

This is the folder structure we set up for you:

/src
  index.tsx       # EDIT THIS
/test
  blah.test.tsx   # EDIT THIS
.gitignore
package.json
README.md         # EDIT THIS
tsconfig.json

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

  • main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
  • size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Including Styles

There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

For vanilla CSS, you can include it at the root directory and add it to the files section in your package.json, so that it can be imported separately by your users and run through their bundler's loader.

Publishing to NPM

We recommend using np.

Readme

Keywords

none

Package Sidebar

Install

npm i @epigraph/epigraph-analytics

Weekly Downloads

18

Version

0.5.0

License

MIT

Unpacked Size

167 kB

Total Files

30

Last publish

Collaborators

  • cpiggott
  • puneet_epigraph
  • bruno-epigraph
  • tanay-dimri