Here are the steps to test:

• Run yarn link in user-data-for-fraud-prevention
• Clone the demo project, in there:

• Run yarn
• Run yarn start
• Run yarn demo
• Run yarn link "user-data-for-fraud-prevention"

Now you can make changes in user-data-for-fraud-prevention locally and they will instantly reflect in the demo project.

You can check the browser console for errors.

https://circleci.com/docs/2.0/code-coverage/#javascript

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Window-Size header. Add the functionality to call getWindowSize function and construct Gov-Client-Window-Size header value in the format required by HMRC.

Remove the demo label, create a new section "How to test" and move the "Steps for testing" section to a new file (DEMO.md) similar to how it is done for the Usage section https://github.com/intuit/user-data-for-fraud-prevention/blob/master/USAGE.md

We created a global utils file so we could easily inject mocked global objects (like document, window etc).

This was purely to help with testing. Instead we should acces the globals where we want them, and update the tests to use jest's global object.

See https://github.com/intuit/user-data-for-fraud-prevention/blob/master/tests/unit/common/browserInfoHelper.test.js#L229 for an example.

It would be good if the PR template had a place to fill in what issue the PR relates to.

It would be good to have the linting a separate step so it reports separately to the tests on the PR.

I created a demo project for the purposes of a talk about this project, so it could be easily demo'd.

Here it is https://github.com/reubenae/user-data-demo

It would be good to link to this repo from the README.md

Please check the list of contributors here: https://github.com/intuit/user-data-for-fraud-prevention/graphs/contributors

And update the contributors on readme by following the instructions in the "How contributors get added to the README" section in the readme file.

Point 6 of Contributing section in ReadMe can be improved by adding links for documentation directly under yarn link and npm linkdirectly.

Also it would be good to add an additional point there with a link to our demo project:

Test your changes in your consuming code or using our demo project by running yarn link or npm link.

Add this: https://github.com/semantic-release/semantic-release

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Screens header. Add the functionality to call getScreenData function and construct Gov-Client-Screens header value in the format required by HMRC.

https://allcontributors.org/docs/en/bot/installation

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:
1.
1.
1.

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Info (please complete the following information):
Any information about your environment you believe is relevant e.g. node version

Additional context
Add any other context about the problem here.

Is your feature request related to a problem? Please describe.
As an engineer, I want to be able to write my code in typescript, so I can find out possible bugs at compile time.

Describe the solution you'd like
Typescript being a supported language in this repo

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
This was attempted before (#28) but due to a series of merge conflicts, was closed without merging. I recommend approaching this in a piecemeal fashion. However, the previous PR is a good reference point for this work still.

https://github.com/intuit/user-data-for-fraud-prevention/tree/master/src/js/hmrc

Update readme to add details for a new header we added recently.

Gov-Client-Local-IPs-Timestamp - A timestamp to show when Gov-Client-Local-IPs header value is collected.

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Browser-Plugins header. Add the functionality to fetch browser plugins and construct Gov-Client-Browser-Plugins header value in the format required by HMRC.

Is your feature request related to a problem? Please describe.
Refer to HMRC documentation here to know the info we need to send as part of this header: https://developer.service.hmrc.gov.uk/guides/fraud-prevention/connection-method/web-app-via-server/#gov-client-public-ip-timestamp

Describe the solution you'd like
Add a function to fetch timestamp when public IP address is collected using https://api.ipify.org as part of Gov-Client-Public-IP header and use that function to generate Gov-Client-Public-IP-Timestamp header needed by HMRC for fraud prevention.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Enhance this library to generate value for a new HMRC header: Gov-Client-Device-ID

You can generate an universally unique identifier (UUID), also known as a globally unique identifier (GUID), to use as a device ID

HMRC's documentation for this header can be found here: https://developer.service.hmrc.gov.uk/guides/fraud-prevention/connection-method/web-app-via-server/

Expected format:
Gov-Client-Device-ID: beec798b-b366-47fa-b1f8-92cede14a1ce

Is your feature request related to a problem? Please describe.

Linting is a step during the build that can cause the build to break. While this is definitely a good thing that helps keep the code quality high, it could easily catch contributors off guard since the documentation does not mention it anywhere and it is not automatically enforced before build time.

Describe the solution you'd like

I would like to see the linting run automatically before code is pushed so that contributors know what to expect from the build.

Describe alternatives you've considered

Alternatively, we could also add it as a step to the documentation, however I am more in favour of automating things when we can.

Additional context

Linting is done in the build here.

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Browser-JS-User-Agent header. Add the functionality to call getUserAgent() and construct Gov-Client-Browser-JS-User-Agent value in the format required by HMRC.

Currently for the errors in getDeviceLocalIPAsString function

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Timezone header. Add the functionality to call getTimezone() and construct Gov-Client-Timezone header value in the format required by HMRC.

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Browser-Do-Not-Track header. Add the functionality to call getBrowserDoNotTrackStatus function and construct Gov-Client-Browser-Do-Not-Track header value in the format required by HMRC.

Is your feature request related to a problem? Please describe.

Refer to HMRC documentation here to know the info we need to send as part of this header: https://developer.service.hmrc.gov.uk/guides/fraud-prevention/connection-method/web-app-via-server/#gov-client-browser-js-user-agent

Describe the solution you'd like
Add a function to fetch useragent using navigator.userAgent and use that function to generate Gov-Client-Browser-JS-User-Agent header needed by HMRC for fraud prevention.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

At the moment, information on how to use the HMRC fraud headers functions are contained within the project's main README. It would be best to have a seperate one and link to it from the main.

Generate releases based on semantic version labels on pull requests using Intuit's Auto: https://github.com/intuit/auto

Eg: https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/common/globalsUtil.js

Is your feature request related to a problem? Please describe.
As a engineer trying to add a new implementation for my problem space, I'd like a generator to automatically scaffold out the files for me

Describe the solution you'd like
Say california state taxes require similar information to HMRC about the user's device. You want to leverage the work in js/common, but you need to format it differently to how HMRC want it.

Essentially you need to clone the HMRC folder https://github.com/intuit/user-data-for-fraud-prevention/tree/master/src/js/hmrc but with your own name and then rewrite the functions.

It would be good to have a yeoman generator script you can call which automatically scaffolds this all out.

https://yeoman.io/learning/index.html

Describe alternatives you've considered
A good MVP would be a README section for this specific problem more clearly detailing out the structure required.

Additional context
Add any other context or screenshots about the feature request here.

Context: @skodamarthi and I co-founded this repo, including all the work to open source it from a previously internal only repo at Intuit.

I am no longer at Intuit, and no longer even work within a domain in which I can use this repo. Recently, @pmaidens has taken on the overwhelming bulk of work in improving the quality of this repository.

I propose that we add @pmaidens as a co-owner of this repo. I am happy to either remain or step down.

Describe the bug
When downloading the distributed package from npm repository using npm or yarn, many babel dependencies are downloaded as well. This slows down installation and also adds a lot of files which aren't needed to use the library.
A second issue is the src files are only partially downloaded, so if a user wants to read the source, or directly use the src to reduce bundling uuid dependency twice for example, it throws an error as required files are not found.

To Reproduce
Steps to reproduce the behavior:

1. run yarn add user-data-for-fraud-prevention

Expected behavior
Only the required node modules are downloaded
Either all or no source files are downloaded

Screenshots
Package json:

Downloaded node modules:

None of these are required except for user-data-for-fraud-prevention as the distributed code has been completely bundled by webpack. uuid may make sense if the src files are intended to be used.

Info (please complete the following information):
Any information about your environment you believe is relevant e.g. node version

Additional context
Add any other context about the problem here.

At the moment we use module.exports in this repo occasionally, for example here https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/index.js#L6 . It would be better to have ES6 style export const ... instead.

A stack overflow on this topic https://stackoverflow.com/questions/40294870/module-exports-vs-export-default-in-node-js-and-es6 likely this will require some babel configuration.

Tutorial https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-adding-es6-support

This can be tested with using yarn-link locally.

We would like to remove our dependency on sinon and instead rely on jest.

Partial migration is valid and helpful!

Integrate commitlint https://github.com/conventional-changelog/commitlint and configure automatically semantic version releases.

Please add jsDocs to document all the exported functions that are missing docs.

Is your feature request related to a problem? Please describe.
Refer to HMRC documentation here to know the info we need to send as part of this header: https://developer.service.hmrc.gov.uk/guides/fraud-prevention/connection-method/web-app-via-server/#gov-client-public-ip

Describe the solution you'd like
Add a function to fetch public IP address using https://api.ipify.org and use that function to generate Gov-Client-Public-IP header needed by HMRC for fraud prevention.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Device-ID header. Add the functionality to call generateClientDeviceID() and construct Gov-Client-Device-ID header value in the format required by HMRC.

https://www.npmjs.com/package/renovate

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Local-IPs header. Add the functionality to call getDeviceLocalIPAsString() and construct Gov-Client-Local-IPs header value in the format required by HMRC.

Is your feature request related to a problem? Please describe.
This project could be more inclusive if the readme was available in multiple languages.

Describe the solution you'd like
Create copies of README.md in the project root, named appropriately e.g. README_SPANISH.md and linked to from the main readme. Something is better than nothing, so provided a single section of the readme is fully translated, that is sufficient to create a new file.

Describe alternatives you've considered
I'm open to other ideas on how we can make this project more inclusive, and any improvements to the process described above.

Additional context
Add any other context or screenshots about the feature request here.

MVP of #16

The vision for this repo is to have common functionality (in the common folder) but then multiple implementations tweaking the formatting etc for that specific problem space, e.g. HMRC in UK, California state taxes, Ireland personal taxes and so on.

This structure should be detailed in the readme or its own file and linked from the readme.

Started this work here #6 as an example

We use a single function from moment's massive library. The benefit here is to reduce the bundle size; ideally by removing any dependency on moment.js

Is your feature request related to a problem? Please describe.
Sometimes we need to send the details of the screen and window as separate headers, at the moment we get a single screen and window value from the headers.

Describe the solution you'd like
I want to have the possibility to get screen width, hight, color depth and scaling as well as the window width and height.

Describe alternatives you've considered
Splitting the value supplied in the SCREEN and WINDOW headers.

Additional context
Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe.
Currently, we are constructing all the HMRC headers as part of getFraudPreventionHeaders function in https://github.com/intuit/user-data-for-fraud-prevention/blob/master/src/js/hmrc/mtdFraudPrevention.js.

We want to provide the flexibility for users to choose the headers they want from this library independently, instead of providing all of them as a bunch.

Describe the solution you'd like
We want an exported function for Gov-Client-Local-IPs-Timestamp header. Add the functionality to fetch timestamp details for local IP address collection and construct Gov-Client-Local-IPs-Timestamp header value in the format required by HMRC.

We tried adding "auto" to auto-generate releases, but it didn't work as expected. We reverted the changes done to circleCI config file as part of #74 for this. However, the changes done in package.json were not reverted. Please remove all "auto" related code in package.json as we are not using this.

If a PR build passes, it should publish to npm as a canary version, so the developer can test it out in their own repo without having to use yarn link.

https://circleci.com/orbs/registry/orb/auto/release#commands-canary

And only use yarn. E.g. should not have a yarn.lock file and a package-lock.json file.