@vpnht/sdk

Node wrapper for VPN.ht Desktop.

Table Of Contents

• Installation
• Quick Example
• API

Installation

With Yarn:

$ yarn add @vpnht/sdk

With NPM:

$ npm install @vpnht/sdk

Usage

const VPNht = require("@vpnht/sdk");

Quick Example

Run commands

const VPNht = require("@vpnht/sdk");

const isConnected = await VPNht.isConnected();

if (!VPNht.isInstalled()) {
  const installer = await VPNht.install();

  installer.on("download", ({ percent, time }) => {
    console.log({ percent, time });
  });

  installer.on("error", data => {
    console.log(data);
  });
}

if (!isConnected) {
  VPNht.open();
}

API

isConnected()

Return a Promise with true when the VPN is connected.

isInstalled()

Return a Boolean with true when the VPN Client is installed and ready.

open()

Open the VPN.ht Desktop client and detach it from the opening process.

signup({ email, password })

Create a new customer and return a Promise.

signin({ email, password })

Check the credentials and return a Promise with an auth token to be used on the API.

pickPlan({ plan, processor, authToken })

Pick a plan and create an invoice and return a Promise with a direct payment link.

plan = "MONTHLY" || "ANNUALLY"
processor = "PAYMENTWALL" || "PAYPAL" || "CRYPTO"
authToken = token collected from signup or signin

isActiveService({ authToken })

Return a Promise with true if the customer have an active service (paid)

install()

Return a Promise with an EventEmitter who expose the following events name.

ATTENTION: When you call the install() function, the download is initialized right away.

const installer = await VPNht.install();

.on('download', function (data) {})

Return the download progress with the following elements:

{
  "percent": 0.5,
  "speed": 554732,
  "size": {
    "total": 90044871,
    "transferred": 27610959
  },
  "time": {
    "elapsed": 36.235,
    "remaining": 81.403
  }
}

.on('downloaded', function (data) {})

Triggered when the download is complete.

ATTENTION: The sdk will automatically open the installer when ready. You shouldn't have to handle anything here, but the event is exposed in case you may need it.

{
  "path": "/var/tmp",
  "file": "/var/tmp/install.pkg"
}

.on('installed', function () {})

Triggered when the install is completed and the client ready.

We suggest to call open().

.on('error', function (error) {})

Triggered when something went wrong with the install procedure.

status()

Return a EventEmitter who expose the following events name.

ATTENTION: When you call the status() function, the service need to be ready. You can validate it with isInstalled function.

const status = VPNht.status();

.on('connected', function () {})

Triggered when the VPN status changed to connected.

.on('disconnected', function () {})

Triggered when the VPN status changed to connected.

.on('error', function (error) {})

Triggered when something went wrong with the service connection.