README.md

Aifi Node.js Library

The AiFi Node library provides convenient access to the AiFi API from applications written in server-side JavaScript.

Requirements

Node 12 or higher.

Installation

Install the package with:

npm install aifi --save
# or
yarn add aifi

Usage

The package needs to be configured with your account's token.

const aifi = require('aifi')('aifi_test_...');

aifi.admin.customers.create({
  email: '[email protected]',
  password: '123456789',
})
  .then(customer => console.log(customer.id))
  .catch(error => console.error(error));

Or using ES modules and async/await:

import Aifi from 'aifi';
const aifi = new Aifi('aifi_test_...');

(async () => {
  const customer = await aifi.admin.customers.create({
    email: '[email protected]',
    password: '123456789',
  });

  console.log(customer.id);
})();

Usage with TypeScript

Aifi maintains types for the latest API version

Import Aifi as a default import and instantiate it as new Aifi()

import Aifi from 'aifi';
const aifi = new Aifi('aifi_token_...');

const createCustomer = async () => {
  const params: Aifi.CustomerCreateParams = {
    email: '[email protected]',
    password: '123456789',
  };

  const customer: Aifi.Customer = await aifi.admin.customers.create(params);

  console.log(customer.id);
};
createCustomer();

request and response events

The Aifi object emits request and response events. You can use them like this:

const aifi = require('aifi')('aifi_token_...');

const onRequest = (request) => {
  // Do something.
};

// Add the event handler function:
aifi.on('request', onRequest);

// Remove the event handler function:
aifi.off('request', onRequest);

request object

{
  method: 'POST',
  path: '/v1/customers',
}

response object

{
  method: 'POST',
  path: '/v1/customers',
  status: 402,
}

Using with a custom fetch client

const Aifi = require("aifi");

const aifi = Aifi('<API Token>', {
  // Cloudflare Workers use the Fetch API for their API requests.
  httpClient: Aifi.createFetchHttpClient()
});

Development

Run all tests:

$ yarn install
$ yarn test

If you do not have yarn installed, you can get it with npm install --global yarn.

Run a single test suite without a coverage report:

$ yarn mocha-only test/Error.spec.js

Run a single test (case sensitive) in watch mode:

$ yarn mocha-only test/Error.spec.js --grep 'Populates with type' --watch

If you wish, you may run tests using your Aifi Test API key by setting the environment variable AIFI_TEST_API_KEY before running the tests:

$ export AIFI_TEST_API_KEY='aifi_test....'
$ yarn test

Run prettier:

Add an editor integration or:

$ yarn fix