@magensa/token-exchange-js

v1.0.0

Published

3 years ago

JS Markup module used to interact with Token Exchange PII utility

Downloads

0High
0Medium
0Low

magensa-admin-team

luketurpin

Token Exchange Connect (PII) JS Module

JavaScript module designed to utilize TEConnect's PII (Personally Identifiable Information) utility.
If you are looking for TEConnect Payment - the README there will get you started.

Prerequisites

This document will guide you through how to integrate Token Exchange Connect (PII) into your web application.
While this code will get you up and running right away - in order to successfully create tokens - you will need a few items that are out of scope of this document. These prerequisites involve a valid Magensa™ account.

For assistance, and more information on obtaining these prerequisites, please contact your Magensa™ representative, or Magensa™ support staff.
The prerequisites are:

A TEConnect Public Key (contains public credentials for Magensa™ Services), also referred to as a 'pubkey'.
- As a note to interested developers who have not yet obtained a valid pubKey- If you supply any valid Base64 encoded string - you can get the application up and running. So an example of a temp key to run the application (but not to successfully create tokens) would be:
```
const tempPubKey = btoa("__publicKeyGoesHere__");
```
- Once you obtain a valid pubKey - you will also have another set of credentials associated with your account. The pubKey, is not sensative - and is intended for use in your web application. The other set of credentials (Customer Code, Username, Password) are sensative, and should remain private.
Pre-existing containers to store the tokens.
- Each input box must have a valid container name (where the data entered into the input will be tokenized and stored). This container must be created by your account in advance (using your private credentials).
  - It's important to note that this container must be marked as "shared" upon creation. The "shared" allows the public credentials to use a container created by the private credentials. "containerTypeID": 1
- Here is more information on how to create containers using TokenV2 Web Service.
- Bear in mind that every input will use the containerName supplied. You may choose to store all the tokens in the same container or seperately.

Getting Started

Via npmjs:

npm install @magensa/token-exchange @magensa/token-exchange-js

yarn add @magensa/token-exchange @magensa/te-connect-js

Via CDN:

<script src="https://cdn.magensa.net/token-exchange/1.0.0/token-exchange.js"></script>
<script src="https://cdn.magensa.net/token-exchange-js/1.0.0/token-exchange-js.js"></script>

If you would prefer to let the code speak, below we have two example implementations. One is using npmjs - while the other uses our CDN

Step By Step

The first step is to build your teInputsMap. This map is essentially a selection of which inputs you would like displayed - along with the 'containerName' for each input.

TEConnect supports various different PII data points to render in your form. There are two different types of inputs available to choose from:

Managed Inputs, which are input boxes that come loaded with validation, error handling, and input masks.
Generic Inputs, which are unvalidated inputs that can be used for various use-cases that the managed inputs do not account for.

Please see this list below for all the currently available managed input boxes. In order to render a chosen input box, you must include the input object in the teInputsMap. An example of how to include the 'firstName' input in your web app would look like this:

const exampleInputsMap = [{
    inputName: "firstName",
    containerName: "exampleContainerName"
  }];

Input Boxes Available (Managed Inputs)

`teInputsMap` Object Properties and Overrides

The next step is to create a TokenExchangeConnect instance and feed that instance, along with the 'teInputsMap', to a new TokenExchangeJs constructor.

main.js

import { createTokenInstance } from '@magensa/token-exchange';
import { TokenExchangeJs } from '@magensa/token-exchange-js';

const tokenExchangeInstance = createTokenInstance("__publicKeyGoesHere__");
const teConnectInputs = [
  {
    inputName: "firstName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "middleName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "lastName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "ssn",
    containerName: "anotherContainerName"
  }
];

function demoInit() {
    var teConnect = new TokenExchangeJs(tokenExchangeInstance, teConnectInputs);
}

demoInit();

Next, design your page according to your specifications - and create a <div> with a unique id. Mount the TokenInputs on that div.

index.html

<body>
    <div id="example-div"></div>
    <script src='main.bundle.js'></script>
</body>

main.js

import { createTokenInstance } from '@magensa/token-exchange';
import { TokenExchangeJs } from '@magensa/token-exchange-js';

const tokenExchangeInstance = createTokenInstance("__publicKeyGoesHere__");
const teConnectInputs = [
  {
    inputName: "firstName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "middleName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "lastName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "ssn",
    containerName: "anotherContainerName"
  }
];

function demoInit() {
   var teConnect = new TokenExchangeJs(tokenExchangeInstance, teConnectInputs);

    teConnect.mountTeInputs('example-div');
}

demoInit();

Finally, to submit the inputs and tokenize the data, utilize the createTokens function (property of TokenExchangeJs) and attach to your click handler.

index.html

<body>
    <div id="example-div"></div>
    <button type="button" id="create-tokens">Create Tokens</button>
    <script src='main.bundle.js'></script>
</body>

main.js

import { createTokenInstance } from '@magensa/token-exchange';
import { TokenExchangeJs } from '@magensa/token-exchange-js';

const tokenExchangeInstance = createTokenInstance("__publicKeyGoesHere__");
const teConnectInputs = [
  {
    inputName: "firstName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "middleName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "lastName",
    containerName: "exampleContainerName"
  },
  {
    inputName: "ssn",
    containerName: "anotherContainerName"
  }
];

function demoInit() {
   var teConnect = new TokenExchangeJs(tokenExchangeInstance, teConnectInputs);

    teConnect.mountTeInputs('example-div');

    function createTokensHandler() {
        return teConnect.createTokens()
            .then(resp => {
                if (resp.error) {
                    //Not successful - see error
                }
                else {
                    //Successful - see response
                }
            })
            .catch(err => console.error(err));
    }

    document.getElementById("create-tokens").addEventListener('click', createTokensHandler);
}

demoInit();

There are two ways to inject your own styles into the inputs. One method is static (define styles when mounting, as a second argument to mountTeInputs), while the other is dynamic (utilize the setStyles method, property of TokenExchangeJs). The example implementation uses both of these methods to demonstrate various ways you can control your custom styles. See the complete styles API for more details.

Generic Inputs

TEConnect supports the use of generic input boxes. Unlike the managed inputs, these input boxes do not have any validation or input handling. When building a map that includes generic input boxes, the process is slightly different from the managed inputs. First, to opt-in to a generic input - supply the string "_teconnect_generic" as the inputName property. There are two additional required properties (containerName and labelText, respectively), but it is also recommended to provide a tokenName as well.

With managed inputs, the inputName becomes the tokenName at creation. This is easy to manage as the "email" input box would become the "email" token. With generic inputs, however, you may include as few or as many as you would like. It is therefore recommended to provide a tokenName of your choosing to assist in managing your created tokens. The tokenName is not required and will generate under the name "_teconnect_generic", if not provided.

{
    inputName: "_teconnect_generic", // id that signals use of generic input
    containerName: "preferredContainerName", // required for all inputs
    labelText: "Label For Input", // required for generic input boxes
    tokenName: "example_generic_token_name" //not required, but recommended
}

createTokens Return Objects

These are the possible objects that will be returned successfully from the createTokens function. Thrown errors will be thrown as any other async method.

Success:

type TokenResponse = {
    code: String
    containerName: String
    customerTranRef: String
    magTranID: String
    message: String
    timestamp: String
    tokenKey: null | String
    tokenName: String
    tokenStatusCode: Number,
    error?: String
}

type TokenResponses = {
    status: Number,
    tokenResponses: Array<TokenResponse>    
}

Bad Request

Bad Request is possible on two layers, and will have different properties depending on wether or not the call reached the Token service. The optional properties below demonstrate all possible properties of both Bad Request objects, with the mandatory properties being shared amongst the two.

type TokenResponse = {
    error: String,
    tokenName: String,
    tokenStatusCode: Number,
    code?: Number,
    containerName?: String,
    customerTranRef?: String,
    magTranID?: String,
    message?: String,
    timestamp?: String
}

type TokenResponses = {
    status: Number,
    tokenResponses: Array<TokenResponse>    
}

Error (Failed Validation, Timeout, Mixed Protocol, etc)

type ClientError = { 
    error: String 
}

Styles API

The styles object injected is composed of two main properties:

base
- General styles applied to the container.
boxes
- Styles applied to the input elements.

Below we have the complete API with examples of default values for each.

Base

Default Base Object:

{
    base: {
        wrapper: {
            margin: '1rem',
            padding: '1rem'
        },
        variants: {
            inputType: 'outlined',
            inputMargin: 'normal',
            autoMinHeight: false
        },
        backgroundColor: '#fff'
    }
}

Boxes

Default Boxes Object:

{
    boxes: {
        labelColor: "#3f51b5",
        textColor: "rgba(0, 0, 0, 0.87)",
        borderRadius: 4,
        errorColor: "#f44336",
        inputColor: "#fff"
    }
}

Example Implementation

index.html

<body>
    <h1>Token Exchange Connect (PII) Example</h1>

    <div id="example-div"></div>
    <button type="button" id="create-tokens">Create Tokens</button>
    <button type="button" id="change-styles">Change Styles</button>
    <script src='main.bundle.js'></script>
</body>

main.js

import { createTokenInstance } from '@magensa/token-exchange';
import { TokenExchangeJs } from '@magensa/token-exchange-js';

const tokenExchangeInstance = createTokenInstance("__publicKeyGoesHere__");
const teConnectInputs = [
    {
        inputName: "firstName",
        containerName: "exampleContainerName"
    },
    {
        inputName: "middleName",
        containerName: "exampleContainerName"
    },
    {
        inputName: "lastName",
        containerName: "exampleContainerName",
        tokenName: "custom_last_name_token_name",
        colSpacingLg: 3,
        colSpacingMd: 4,
        colSpacingSm: 5
    },
    {
        inputName: "ssn",
        containerName: "anotherContainerName"
    },
    {
        inputName: "_teconnect_generic",
        labelText: "Custom Text for Label",
        containerName: "exampleContainerName",
        tokenName: "custom_token_name"
    }
];

var exampleStyles = {
    base: {
        wrapper: { 
            margin: 0, 
            padding: 0
        },
        variants: {
            inputType: 'outlined',
            inputMargin: 'dense',
            autoMinHeight: true
        },
        backgroundColor: 'rgb(66, 66, 66)'
    },
    boxes: {
        labelColor: "#BB86FC",
        textColor: "#BB86FC",
        borderRadius: 10,
        errorColor: "#CF6679",
        inputColor: '#121212'
    }
};

function demoInit() {
    var teConnect = new TokenExchangeJs(tokenExchangeInstance, teConnectInputs);

    teConnect.mountTeInputs('example-div', exampleStyles);

    function createTokensHandler() {
        return teConnect.createTokens()
            .then(resp => {
                if (resp.error) {
                    //Not successful - see error
                }
                else {
                    //Successful - see response
                }
            })
            .catch(err => console.error(err));
    }

    function changeStyles() {
        var colorful = {
            base: {
                wrapper: { 
                    margin: 0, 
                    padding: 0
                },
                variants: {
                    inputType: 'filled',//'outlined', 'filled', 'standard'
                    inputMargin: 'dense',  //'dense', 'none', 'normal'
                    autoMinHeight: true
                },
               backgroundColor: '#f44336'
            },
            boxes: {
                textColor: "#90ee02",
                borderRadius: 2,
                errorColor: "#2196f3",
                inputColor: '#ff7961'
            }
        };

        teConnect.setStyles(colorful);
    }

    document.getElementById("create-tokens").addEventListener('click', createTokensHandler);
    document.getElementById('change-styles').addEventListener('click', changeStyles);
}

demoInit();

Example Implementation CDN

An important note about CDN versioning:

All token-exchange and token-exchange-js versions will be available via CDN. You can see the version in the path below.
If you are starting a new project - it is recommended to start with the most recent version. Therefore, even if you are not using npmjs, it is still recommended to view the most recent published version at npmjs, so that you may target the most recent version. CDN and npm packages are versioned simultaneously.
Alternatively - if your project requires a specific version - you may target that version in the CDN path.

index.html

<body>
   <h1>Token Exchange Connect (PII) Example</h1>

    <div id="example-div"></div>
    <button type="button" id="create-tokens">Create Tokens</button>
    <button type="button" id="change-styles">Change Styles</button>

    <script src="https://cdn.magensa.net/token-exchange/1.0.0/token-exchange.js"></script>
    <script src="https://cdn.magensa.net/token-exchange-js/1.0.0/token-exchange-js.js"></script>

    <script>
        const tokenExchangeInstance = window["token-exchange"].createTokenInstance("__publicKeyGoesHere__");

        const teConnectInputs = [
            {
                inputName: "firstName",
                containerName: "exampleContainerName"
            },
            {
                inputName: "middleName",
                containerName: "exampleContainerName"
            },
            {
                inputName: "lastName",
                containerName: "exampleContainerName",
                tokenName: "custom_last_name_token_name",
                colSpacingLg: 3,
                colSpacingMd: 4,
                colSpacingSm: 5
            },
            {
                inputName: "ssn",
                containerName: "anotherContainerName"
            },
            {
                inputName: "_teconnect_generic",
                labelText: "Custom Text for Label",
                containerName: "exampleContainerName",
                tokenName: "custom_token_name"
            }
        ];

        var exampleStyles = {
            base: {
                wrapper: { 
                    margin: 0, 
                    padding: 0
                },
                variants: {
                    inputType: 'outlined',
                    inputMargin: 'dense',
                    autoMinHeight: true
                },
                backgroundColor: 'rgb(66, 66, 66)'
            },
            boxes: {
                labelColor: "#BB86FC",
                textColor: "#BB86FC",
                borderRadius: 10,
                errorColor: "#CF6679",
                inputColor: '#121212'
            }
        };

        function demoInit() {
            var teConnect = new window["token-exchange-js"].TokenExchangeJs(tokenExchangeInstance, teConnectInputs);

            teConnect.mountTeInputs('example-div', exampleStyles);

            function createTokensHandler() {
                return teConnect.createTokens()
                    .then(resp => {
                        if (resp.error) {
                            //Not successful - see error
                        }
                        else {
                            //Successful - see response
                        }
                    })
                    .catch(err => console.error(err));
            }

            function changeStyles() {
                var colorful = {
                    base: {
                        wrapper: { 
                            margin: 0, 
                            padding: 0
                        },
                        variants: {
                            inputType: 'filled',//'outlined', 'filled', 'standard'
                            inputMargin: 'dense',  //'dense', 'none', 'normal'
                            autoMinHeight: true
                        },
                    backgroundColor: '#f44336'
                    },
                    boxes: {
                        textColor: "#90ee02",
                        borderRadius: 2,
                        errorColor: "#2196f3",
                        inputColor: '#ff7961'
                    }
                };

                teConnect.setStyles(colorful);
            }

            document.getElementById("create-tokens").addEventListener('click', createTokensHandler);
            document.getElementById('change-styles').addEventListener('click', changeStyles);
        }

        demoInit();
    </script>
</body>

Minimum Requirements

TEConnect core logic utilizes the uuid library. Please include a version greater than 3.4.0 in your project to meet the peer dependency for @magensa/token-exchange.

uuid ^3.4.0

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Token Exchange Connect (PII) JS Module

Prerequisites

Getting Started

Step By Step

Input Boxes Available (Managed Inputs)

teInputsMap Object Properties and Overrides

Generic Inputs

createTokens Return Objects

Success:

Bad Request

Error (Failed Validation, Timeout, Mixed Protocol, etc)

Styles API

Base

Default Base Object:

Boxes

Default Boxes Object:

Example Implementation

Example Implementation CDN

An important note about CDN versioning:

Minimum Requirements

`teInputsMap` Object Properties and Overrides