react-otp-dynamodb

An OTP component from the sign in flow, uses dynamodb as the backend

Note

This component is under active development. Expect frequent updates.

Overview

This is a single page responsive component that provides the otp functionality, in a password-less otp based sign in flow. It is a ready-to-use component.

Install

npm install --save react-otp-dynamodb

Then install the dependencies.

Dependencies

npm install --save aws-sdk
npm install --save bootstrap
npm install --save react-bootstrap
npm install --save react-dynamodb-helper
npm install --save react-ses-helper
npm install --save react-ui-components-superflows

Review the configuration now.

Configuration

AWS SES Sender Receiver

The sender (source) email address should be configured and verified. If SES is in sandbox mode, the receiver email address(es) should also be configured and verified. A test email should be sent from the SES console and ensured that the intended receiver receives it.

AWS SES Template

This is required if you are planning to send templated emails. An html template should be created. As of July 22, SES console does not support adding email templates. They can only be done through the apis. Best way is to do it via aws command line interface.

AWS DynamoDB

This component uses dynamodb as the backend. Please create a table as follows:

• Name: Account_Credentials
• Partition Key: email
• Sort Key: none

Create a sample record for testing as follows:

• email: some_valid_email
• firstName: some_firstname
• lastName: some_lastname

AWS Credentials

AWS region, secret and access key form the credentials. These are required to use this package. It is crucial that these credentials are given the following permissions:

• SES email sending permissions
• Create, Update, Delete, View permissions for the Account_Credentials table in dynamodb

Usage

import React from 'react'
import 'bootstrap/dist/css/bootstrap.min.css';
import Themes from 'react-ui-themes-superflows';

import { Otp } from 'react-otp-dynamodb'

const App = () => {

  function processAccount(email, exists) {
    console.log(email, exists);
  }

  return  (
  
    /*

      imageUrl: logo URL
      imageAlt: alternative text for logo
      buttonCaption: caption of the button
      onSubmitResult: called after user clicks submit
      awsRegion: aws region (recommended to store in env)
      awsSecret: aws secret (recommended to store in env)
      awsKey: aws access key (recommended to store in env)
      template: email template comfigured in aws ses
      project: name of the project
      emailerSource: source email configured to send emails in aws ses
      email: email that has come from the sign in screen
      captionInfo: information block
      theme: ui theme

    */

    <Otp  
      imageUrl="https://**********/superflows_black.png" 
      imageAlt="This is a test image"
      buttonCaption="Verify"
      onSubmitResult={processAccount}
      awsRegion="aws_region"
      awsSecret="aws_secret"
      awsKey="aws_key"
      template="TemplateOtp1"
      project="SF-21"
      emailerSource="sup****************@****ail.com"
      email="hru********n**e@***ail.com"
      captionInfo={"One time password (otp) has been sent to hr********@**il.com"}
      theme={Themes.getTheme("Default")}
    />

  )
}

export default App

Tests

PASS src/index.test.js (29.32s)
  ✓ Render (41ms)
  ✓ Auto focus on input (8ms)
  ✓ Verify button should be initially disabled (7ms)
  ✓ Submit button should be initially disabled (12ms)
  ✓ Submit button should enable / disable after valid / invalid otp value (4072ms)
  ✓ email not found (2017ms)
  ✓ otp has expired (2017ms)
  ✓ otp has not expired, but is incorrect (2019ms)
  ✓ otp has not expired, and is correct (2017ms)
  ✓ Resend button should enable after 30 seconds (14019ms)

--------------|----------|----------|----------|----------|-------------------|
File          |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
--------------|----------|----------|----------|----------|-------------------|
All files     |    80.56 |    63.33 |    64.29 |    81.82 |                   |
 constants.js |      100 |      100 |      100 |      100 |                   |
 index.js     |    86.89 |    63.33 |       80 |    89.09 |51,52,65,88,89,146 |
 services.js  |       40 |      100 |       25 |       40 | 22,38,43,61,67,83 |
--------------|----------|----------|----------|----------|-------------------|
Test Suites: 1 passed, 1 total
Tests:       10 passed, 10 total
Snapshots:   0 total
Time:        30.532s
Ran all test suites.

License

MIT © superflows-dev