# JS Payment Card

##### Repository:

> - [GitLab](https://gitlab.com/trustpayments-public/stjs/js-payments-card)
> - [GitHub (old/deprecated)](https://gitlab.com/trustpayments-public/stjs/js-payments-card)

You can check JS Library in action by running it on your local environment. To do this, run commands below:

```
npm install
npm start
```

Then open address `https://localhost:8443` in your web browser.

## Private package registry (@trustpayments)

`@trustpayments/*` dependencies are pulled from the private GitLab group Package
Registry, not from public npmjs.org. The scope mapping is in the committed
`.npmrc` (no token in it). You configure the auth token once in your own
user-level `~/.npmrc`, outside this repo.

1. Create a GitLab token with `read_package_registry` scope on the
   `securetrading-gl/software-development-kit` group (a Group Access Token or a
   Personal Access Token both work).
2. Store it once in your user-level `~/.npmrc`:
   ```
   npm config set -- //gitlab.com/api/v4/groups/9992134/-/packages/npm/:_authToken=<token>
   ```
3. Run `npm install` as usual.

The token lives only in your `~/.npmrc` (never in this repo). The committed
`.npmrc` holds only the scope-to-registry mapping.

## Technology Stack:

##### Tools and languages:

- [TypeScript](https://www.typescriptlang.org/)
- [ES2020](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [Vite](https://vitejs.dev/)
- [npm](https://www.npmjs.com/)
- [Sass (SCSS + BEM)](https://sass-lang.com/)
- [Prettier](https://prettier.io/)
- [Stylelint](https://stylelint.io/)
- [ESLint](https://eslint.org/)

##### QA:

- [vitest](https://vitest.dev/) for unit testing

## Distribution

This library is distributed as an ES module and CommonJS module.

```js
// ES module import
import Card from "@trustpayments/js-payments-card";

// CommonJS require
const Card = require("@trustpayments/js-payments-card");
```

> **Note for UMD consumers:** If you were previously loading the library via a `<script>` UMD tag, migrate to an ES module bundler (Webpack, Rollup, Vite, etc.).
>
> **Node.js consumers:** This package supports both ESM (`import`) and CommonJS (`require`). Node.js 26+ is required.

##### Minimum supported browsers:

- Chrome 90+ (May 2021)
- Firefox 88+ (April 2021)
- Safari 14+ (September 2020)
- Edge 90+ (May 2021)
- iOS Safari 14+

##### Minimum supported Node.js version:

- Node.js 26+

## Testing how-to

Selenium tests are stored in `tests\selenium` directory and all the below actions are to be executed in that directory.

##### Application docker

Tests will require the docker in order to execute them.

Application docker will be pulled from gitlab's container registry

The address to an appropriate image is stored in `.env` file and can be edited.

##### Start up the docker containers

`docker-compose up -d`

The example page is available under address `https://merchant.securetrading.net/`. You should add this domain to your `hosts` file
and point to address `127.0.0.1` (here you can find how to do it https://support.rackspace.com/how-to/modify-your-hosts-file/).

The Wiremock is available under `https://webservices.securetrading.net:8443/` so to access it you should also add this address
to the `hosts` file.

##### To run the tests

`docker-compose run tests poetry run behave features`

##### To test a different branch

If you have multiple application images with different branches you can specify which image should be used for tests, eg.:

`APP_TAG=master docker-compose up -d`

##### To run with a remote browser via browserstack:

In directory `binary` execute
`BrowserStackLocal.exe --key <BROWSERSTACK_ACCESS_KEY> --local-identifier local_id --force-local`

Then, to run
`docker-compose run -e LOCAL=true -e REMOTE=true -e BROWSER=Chrome -e BROWSER_VERSION=80.0 -e OS=Windows -e OS_VERSION=10
 -e BS_USERNAME=<BROWSERSTACK_USERNAME> -e BS_ACCESS_KEY=<BROWSERSTACK_ACCESS_KEY> tests poetry run behave features`

## License

- [MIT](https://opensource.org/licenses/MIT)
