connect-sdk-nodejs

Worldlline Connect Node.js SDK

Introduction

The Node.js SDK helps you to communicate with the Worldline Connect Server API. Its primary features are:

• convenient JavaScript wrapper around the API calls,
• authentication of all calls
• logging support by proxying log calls to a custom user defined logger instance
• validation of input and
• a logfile obfuscater

See the Worldline Connect Developer Hub for more information on how to use the API.

Structure of this repository

This repository consists out of three main components:

1. The source code of the SDK itself: /src
2. The JSON schemas used to validate requests: /schemas
3. Unit and integration tests: /__tests__

Requirements

Node.js 8 or higher is required.

Installation

From the folder where your package.json is located, run the following command to install the SDK:

npm i connect-sdk-nodejs

Building the repository

From the root of the project install all dependencies, then compile the code:

npm install
npm run build

Testing

There are two types of tests:

1. Unit tests. These will work out-of-the-box.
   Run these tests as follows:

   npm run test:unit
   

2. Integration tests. Before you can run these, you first need to copy file __tests__/config.json.dist to __tests__/config.json and replace all values as needed. If needed, a proxy property can be added with nested properties host, scheme (defaults to http), port (defaults to 3128) and credentials (optional, in the format <username>:<password>).
   Run these tests as follows:

   npm run test:integration
   

You can also run both types of tests together as follows:

npm run test