Rebilly JS SDK library

Use this JS SDK library to consume the Rebilly API in both Node.js and browser environments.

PCI compliance note

If you need to handle raw payment card data, use Rebilly FramePay to generate tokens for your server-side logic.

Rebilly API

This library is a semantic representation of the Rebilly API. The API documentation includes SDK examples for each operation. For more information, see the most commonly used API operations or all API operations.

Usage

To install and use the JS SDK, see the JS SDK quickstart

Development

The resources in src/resources are generated from the API definitions by js-sdk-generator:generate-sdk-code and are not committed. Run the commands below through Nx, which generates them first.

Build development dist folder without sourcemap

pnpm nx run rebilly-js-sdk:build:dev

Build release dist folder with sourcemap and types

pnpm nx run rebilly-js-sdk:build

Run all unit tests

pnpm nx run rebilly-js-sdk:test:unit

Watch unit tests and re-run on change

pnpm nx run rebilly-js-sdk:test:unit:watch

Generate coverage report

pnpm nx run rebilly-js-sdk:test:unit:coverage

Check that the generated typescript type file is valid (build first, which also runs this check)

pnpm nx run rebilly-js-sdk:test:check-build-types

Typescript types generation

Types are automatically created because ts:bundle-types is called as part of build.