TrackX Client

> !Status Warning: This is alpha software. Test thoroughly before using in production! Please report any bugs you find! Before version 1.0.0 there may be backwards incompatible changes.

Simple JavaScript exception tracking.

TODO: Explain why build output is to the package root instead of a dist/ dir -- cleaner CDN URLs and possibly less confusing for non-developer users

TODO: Write docs:

- Go over the 5 client variants; default, lite, extended, compat, and node
- Write up a whole page/section of documentation about the compat client and support for extreme/edge scenarios
- Would be fun to experiment with obscure browsers and non-browser JS environments
- We still need data around what info will be sent in headers etc. to make sure we support ingesting those events e.g., user-agent, origin
- Show a table with the features of each client and maybe event other project/services features
- Include client file size -- e.g., extended client aims to have the same base requirements as default but is larger in size due to generating better stack traces in certain scenarios
- CDN or local self-hosted
- Include crossorigin on

`

$3

`sh
npm i trackx
`

or

`sh
yarn add trackx
`

TODO: Explain why keep this minimal and include as separate script in head

`ts
import * as trackx from 'trackx';

trackx.setup('https://api.trackx.app/v1/xxxxxxxxxxx/event');
trackx.meta.version = process.env.npm_package_version;

export const { sendEvent } = trackx;
`

Additional considerations

$3

If you're using the Content-Security-Policy header, you'll also need to add https://api.trackx.app to the connect-src directive.

Example:

`html
http-equiv="Content-Security-Policy"
content="default-src 'self'; connect-src 'self' https://api.trackx.app"
/>
`

Licence

TrackX` is an MIT licensed open source project. See LICENCE.

---

© 2022 Max Milton