NOTICE: THERE IS NO STAGING BRANCH AS REPORTS REQUIRES A NPM PACKAGE FOR STAGING/MASTER SO ONLY MASTER BRANCH IS REQUIRED FOR THIS REPO

JS Api Client

Mock Server Data Calls

Please consult the Listen360 Grimoire for more information. Listen360 Grimoire

Testing

We use Jest for unit testing. Check out the Jest guide

We've adopted these common testing tips for writing specs.

All tests have been written in the 'spec' directory.

To run unit tests

yarn test

nock.back

When developing specs, nock and nock.back has been configured to record real api responses. The recording is mostly used for future developers to understand what the http requests and responses will look like when using JS Api Client. The recordings should be kept in the 'spec/fixtures' directory.

Release Package Building (DEPRECATED)

!!! Version releasing happens in the CI when merged to staging

There are 3 versions of release packag building available. Each command will:

1. run through the full lint and test harness
2. build the package
3. create, commit, push a git release tag

$ ver:patch
$ ver:minor
$ ver:major

Publish

npm publish

Local Development Package Inclusion

If you need to locally develop on this package and see the changes in reports

$ cd [JS_API_CLIENT_PATH]
$ yarn link
$ cd [REPORTS_REPO_PATH]
$ yarn link @listen360/js_api_client

This will now give you the ability to see whatever build occurs in js_api_client in real time via hot reloading the reports app loaded in the browser.

Building and Watching files during buids

If you would like to watch your build after performing local development package inclusion

$ yarn watch

For non watch builds

$ tsc

Additional Notes

This project uses typescript to produce strong definitions of method signatures and response values. As part of the build, type definition files (.d.ts) are created for use in other typescript projects.