@kelvininc/web-client-sdk NPM

Web Getting Started

Kelvin SDK Client provides a simple way to integrate our Authentication, Services and Models inside your project.

Requirements

To run our SDK inside your project you need to support the following versions:

Rxjs: ~6.6.X
Axios: >=1.0.0
Optionally, keycloak-js to handle the authentication

Installation

Install the Kelvin SDK Client, RxJS and Axios Client:

npm install @kelvininc/web-client-sdk axios rxjs@~6.6.7  --save

Setup without Keycloak

Next, you need to setup the main.js file:

import KelvinSDK from "@kelvininc/web-client-sdk";
import axios from "axios";

const configuration = {
    baseUrl: '<your-base-url>',
    authConfig: {
        clientId: '<your-kelvin-client>',
        realm: '<your-kelvin-realm>',
        url: '<your-authentication-url>'
    }
}

KelvinSDK.initialize(configuration, axios);

The Kelvin SDK Client is now ready to use. If you need to initialize our SDK services, this example can run inside your Application:

Usage

You can import service and modules from Kelvin Core.

import { AuthService, ACPService } from "@kelvininc/web-client-sdk";

Authentication process

AuthService.login({
	username: '<username or email>',
	password: '<password>'
}).subscribe(({ accessToken, refreshToken }) => doSomething());

Get a list of ACPs

ACPService.listACP({
	pageSize: 20
}).subscribe(acpList => doSomething(acpList));

Promise transformation (if you prefer)

ACPService.listACP({ pageSize: 20 }).toPromise()
  .then(acpList => doSomething(acpList));

Abort Requests

This library uses axios as HTTP Client to communicate with the server-side. Since we encapsulate the request into an observable, we have two options to abort a request:

Unsubscribe from the Subscription

const sub = ACPService.listACP({ pageSize: 20 })
  .subscribe(acpList => doSomething(acpList));

sub.unsubcribe();

Abort the request using KvRequestAbortController. To use this approach it's necessary to declare the class and pass it through the request options as requestController. After the request is built in the SDK we can access the cancel option from the class.

const requestController = new KvRequestAbortController();

await ACPService.listACP(
  { pageSize: 20 },
  { requestController } as IKvWebHttpRequestOptions
)
  .toPromise()
  .then(acpList => doSomething(acpList));

// To cancel the request
requestController.cancel();