alex-frontend-sdk-staging v4.5.0

Frontend SDK

About

This module is used to parse notifications from EPNS. It Provides an abstraction layer

It is written in typescript and requires node v10.0.0 or higher.

Most features will work with nodejs v6.0.0 and higher but using older versions than v10.0.0 is not recommended.

There are two ways which the SDK can be installed

Installation for General usage

In order to install this SDK on your existing web application or mobile application. If you want to use the SDK in your dapp or mobile application, this is the installation method to use.

It can be installed as an npm package via the following command.

npm install epns-frontend-sdk-staging

Installation for SDK Development

If as a developer, you feel the need to add more features to the frontend SDK, and wish to see your changes to the SDK's code immediately reflected, the following steps are for you. In order to install, test and develop the SDK locally, the following steps are required to set it up for testing with a react application you have previously set up.

- git clone https://github.com/ethereum-push-notification-service/epns-frontend-sdk-staging.git

- cd epns-frontend-sdk-staging // navigate to the project's directory

- npm install // to install all the packages

- npm start //to build the project and watch out for changes

- npm link // in order to test and be made available locally
// since we intend to test the functionality, we will assume that another react application is running which wants to leverage the components from the framework

- npm `link relative_path_to_react_application`/node_modules/react
  
- cd `relative_path_to_react_application`

- npm link epns-frontend-sdk
// then the library can be imported as normally would if installed using npm or yarn

More information on the local testing and development of NPM packages can be found here

Usage

The SDK comprises of three modules majorly, which are:

• Fetching the notifications from EPNS backend.
• Parsing the fetched notifications.
• Rendering the parsed notification on mobile and on web.

It is done this way in order to seperate the different layers from each other.

Fetching and parsing notifications from the api

A more comprehensive demo can be located at src/sample_codes/loadNotifications.

import { api, utils } from "epns-frontend-sdk-staging-local";

// define the variables required to make a request
const walletAddress = "0x1234567890abcdcdefghijklmnopqrstuvwxyz123";
const pageNumber = 1;
const itemsPerPage = 20;
// define the variables required to make a request

//fetch the notifications
const fetchedNotifications = await api.fetchNotifications(walletAddress, itemsPerPage, pageNumber)
console.log({fetchedNotifications]);
//fetch the notifications


//parse the notification fetched
const parsedResponse = utils.parseApiResponse(fetchedNotifications);
console.log(parsedResponse);
//parse the notification fetched

Rendering the parsed notification on the web

import { NotificationItem } from  "epns-frontend-sdk";

// This is used to render the text present in a notification body as a JSX element

	<NotificationItem
		notificationTitle={parsedResponse.title}
		notificationBody={parsedResponse.message}
		cta={parsedResponse.cta}
		app={parsedResponse.app}
		icon={parsedResponse.icon}
		image={parsedResponse.image}
	/>

Rendering the parsed notification on a react native mobile application.

import { NotificationItem} from  'epns-frontend-sdk-staging/dist/native';

	<NotificationItem
			notificationTitle={parsedResponse.title}
			notificationBody={parsedResponse.message}
			cta={parsedResponse.cta}
			app={parsedResponse.app}
			icon={parsedResponse.icon}
			image={parsedResponse.image}
	/>

Markdown Reference

This section contains the several markdown formats available and how to use them. They can be viewed live by running the react application in src/sample_codes/parseNotificationMarkdown.