@affinidi/affinidi-uaf-client-lib v1.4.0

Affinidi UAF Client Lib Frontend Integration

This library allows you to seamlessly integrate the Affinidi Universal Loan Application in your client-side application.

Installing the package

npm i @affinidi/affinidi-uaf-service-lib  --save

How to Use

Initializing the Service

const uaf = new UAFBannerIntegration({
  affinidiLoanFormContainerId: '', // ID of the container element (typically a div element) where the Affinidi Loan Banner will be displayed
  affinidiLoanBannerContainerId: '', // ID of the banner element (typically a div element) where the Affinidi Loan Banner will be displayed
  affinidiLoanFormUrl: '', // URL of the Loan Form provided by Affinidi team
})

Set up the user metadata

The first three values phoneNumber, employeeId, and employerId are dynamic and are used to uniquely identify a user in the system.

uaf.setUser({
  phoneNumber: '',
  employeeId: '',
  employerId: '', // Also referred as client id in the source HRMS systems
  sourcePlatformId: '', // Issuer unique identifier provided by Affinidi team during onboarding
})

Creating and Showing the Banner

Javascript

import { IUserParams } from '@affinidi/affinidi-uaf-client-lib/dist'

const handleBannerClick = (param: IUserParams) => {
    ...
}

uaf.createBanner({
   onBannerClick: handleBannerClick
})

HTML

<div id="banner-container-id"></div>

The createBanner function will create a banner in the div element selected by the ID which was filled while creating the class instance.

onBannerClick accepts a callback function which is executed on click of the banner.

Creating and Showing the Form

import { RequestDataEvent } from '@affinidi/affinidi-uaf-client-lib'

const handleMessage = (event: RequestDataEvent) => {
    ...
}

const handleClose = () => {
    ...
}

uaf.createForm({
      onMessage: handleMessage,
      onClose: handleClose,
})

HTML

<div id="container-id"></div>

The createForm function works similar to the createBanner function. It will also create the form in the div element selected by the ID which was filled while creating the class instance. It also adds an event listener to the window element to listen to messages posted by the UAF form.

It accepts two parameters onMessage and onClose.

onMessage callback function is used for handling whenever a user has given consent to the form, with all the details of the user. onClose callback function is used when the user has requested the form to be closed or has pressed on the cross button.

Preventing Adding Multiple Event Listeners

While working with re-rendering components, there is a need to remove event listeners if they are demounted. In such case, you can use the uaf.removeListener() method. This will only work for the listener which has been initialized using uaf.createForm().

uaf.removeListener()

For instance, while working with React, to prevent having multiple listeners being added to your page/component, you can use this in useEffect as follows:

useEffect(() => {
    uaf.createForm({
      onMessage,
      onClose,
    })
    return () => {
      uaf.removeListener()
    }
}, [])