Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

adyenthreeds2-js-utils

1.0.2 • Public • Published

3DS 2.0 JavaScript utilities

These utilities are helper functions to get 3DS 2.0 integrated on to your webpage.

Requirements

3DS 2.0 Back-end integration with Adyen: https://docs.adyen.com/classic-integration/3d-secure-2-classic-integration/browser-based-integration/

Installation

Option A: Clone the repo and import functions directly through UMD / ES2015

import collectBrowserInfo from "./browser";
import base64Url from "./base64url";
import createIframe from "./iframe";
import createForm from "./form";
import config from "./config.js";

Option B: Build the file, link to it and use ThreeDS2Utils on the global scope

Install the development dependencies:

npm install

Build the file:

npm run build

Embed it on your page:

<script type="text/javascript" src="YOUR_PATH/threeds2-js-utils.js">

Functionality can then be accessed via:

window.ThreedDS2Utils

e.g.

window.ThreedDS2Utils.getBrowserInfo()

Usage

N.B. The following code snippets are based on installation via Approach 1:

Gathering browser information

Collects available frontend browser info and store it in the properties dictated by EMVCo specification. EMV® 3-D Secure Protocol and Core Functions Specification

/**
 * @function collectBrowserInfo
 * @returns {Object} - browserInfo an object containing the retrieved browser properties
 */
const browserInfo = collectBrowserInfo();

This returns an object with the following keys:

{
    screenWidth,
    screenHeight,
    colorDepth,
    userAgent,
    timeZoneOffset,
    language,
    javaEnabled
}

Base64Url encoding and decoding

base64Url.encode

returns a base64URL encoded string

base64Url.decode

returns a base64URL decoded string

/**
 * @function base64Url
 * @param { String } - string to be encoded/decoded
 * @returns {String} - a regular string
 */
const base64URLencodedString = base64Url.encode('STRING');
const base64URLdecodedString = base64Url.decode('ENCODED_STRING')

Creating an iframe

Creates an iframe of specified size element with an onload listener and adds the iframe to the passed container element

/**
 * @function createIframe
 * @param container {HTMLElement} - the container to place the iframe into, defaults to document body
 * @param name {String} - the name for the iframe element
 * @param width {String} - the width of the iframe, defaults to 0
 * @param height {String} - the height of the iframe, defaults to 0
 * @param callback { Function } - optional, the callback to fire after the iframe loads content
 *
 * @returns {Element} - Created iframe element
 */
const iframe = createIframe(
    container,
    'IFRAME_NAME',
    '400',
    '600'
);

Creating a form

Creates a form element with a target attribute

/**
 * @function createForm
 * @param name {String} - the name of the form element
 * @param action {String} - the action for the form element
 * @param target {String} - the target for the form element (specifies where the submitted result will open i.e. an iframe)
 * @param inputName {String} - the name of the input element holding the base64Url encoded JSON
 * @param inputValue {String} - the base64Url encoded JSON
 *
 * @returns {Element} - Created form element
 */
 
const form = createForm(
    'FORM_ELEMENT NAME',
    "FORM_ACTION",
    "TARGET_NAME",
    "INPUT_ELEMENT_NAME",
    "DATA_TO_POST");

Validating and retrieving challenge window sizes

config.validateChallengeWindowSize
 

ensures that the passed string is one of values that the ACS expects, else returns '01'

config.getChallengeWindowSize

returns an array of pixel values based on the validated challenge window size e.g. ['250px', '400px']

/**
 * @function config.validateChallengeWindowSize
 * @param sizeStr - a size string to confirm as valid
 * @returns {String} - a valid size string
 */
const validWindowSize = config.validateChallengeWindowSize('STRING');
/**
 * @function config.getChallengeWindowSize
 * @param sizeStr - a size string to confirm as valid
 * @returns {array} - an array of values [WIDTH, HEIGHT]
 */
const windowSizesArray = config.getChallengeWindowSize('STRING');

Documentation

3DS 2.0 Helper Functions Implementation

Support

You can open tickets for any issues with the helper functions. In case of specific problems with your account or generic 3DS 2.0 issues and questions, please contact support@adyen.com.

License

MIT license. For more information, see the LICENSE file.

Install

npm i adyenthreeds2-js-utils

DownloadsWeekly Downloads

112

Version

1.0.2

License

MIT

Unpacked Size

28.3 kB

Total Files

18

Last publish

Collaborators

  • avatar