DEVELOPERS GUIDE

Getting Started

• Clone the application with ssh git clone [email protected]:bcasterltd/bcaster-api-wrapper.git.

Dependencies

• NPM 6.x

Description

A Tiny utility wrapping bcaster api calls

NPM

This package has been published on NPM and is freely available for all bcaster developers according to the ISC license. To install via npm simply run npm install @bcaster/bcaster-api-wrapper. This package exposes two methods, callWithAuth and callWithoutAuth which encapsulates the two variants of api calls made to bcaster. As usual, this requires certain configuration options and a map of available endpoints. For any specific questions please reach out to Maintainer of this package

Usage

The below is an example usage script and does not reflect any file structure or real endpoint. This example assumes the all files are in the root folder and the required config file and endpoints map have already been sorted. For more explicit details please contact Maintainer of this package.

const ApiWrapper = require('@bcaster/bcaster-api-wrapper');
const config = require('./config');
const endpoints = require('./endpoints');
const api = new ApiWrapper(config, endpoints);

/**
 * Example Function for BCaster login
 * @param {*} req The request object
 * @param {*} res The response object
 */
const loginToBCaster = (req, res) => {
  const {body} = req;
  api.callWithoutAuth(req, res, {body}, 'POST', '/bcaster/api/login');
};

CHANGELOG

Version 1.2.2

1. Update pacakge dependencies for axios due to security vulnerability
2. Updat package dev dependency jest due to security vulnerabilities

Version 1.2.1

1. Fix bug related to missing verb params not passed.

Version 1.2.0

1. Add support for specifying Regular expression in endpoints path to support restful api calls.

Version 1.1.1

1. Add bitbucket pipelines to project.

Version 1.1.0

1. Minor patch refactor for index.js.

Version 1.0.0

1. Bcaster API Wrapper utility for api calls.