skyflow-react-js
Advanced tools
A React wrapper for Skyflow JS SDK
Using npm
npm install --save skyflow-react-js
React components are wrapped in skyflow provider which takes in config object and SDK internally initializes a skyflow client.
import { Skyflow, LogLevel, Env } from "skyflow-react-js"
const root = ReactDOM.createRoot(
document.getElementById('root') as HTMLElement
);
const config = {
vaultID: "string", //Id of the vault that the client should connect to
vaultURL: "string", //URL of the vault that the client should connect to
getBearerToken: helperFunc, //helper function that retrieves a Skyflow bearer token from your backend
options: {
logLevel: LogLevel.DEBUG, // optional, if not specified default is ERROR
env: Env.DEV // optional, if not specified default is PROD
}
}
root.render(
<SkyflowElements config={config}>
<App />
</SkyflowElements>
)
For the getBearerToken parameter, pass in a helper function that retrieves a Skyflow bearer token from your backend. This function will be invoked when the SDK needs to insert or retrieve data from the vault. A sample implementation is shown below:
For example, if the response of the consumer tokenAPI is in the below format
{
"accessToken": string,
"tokenType": string
}
then, your getBearerToken Implementation should be as below
getBearerToken: () => {
return new Promise((resolve, reject) => {
const Http = new XMLHttpRequest();
Http.onreadystatechange = () => {
if (Http.readyState == 4) {
if (Http.status == 200) {
const response = JSON.parse(Http.responseText);
resolve(response.accessToken);
} else {
reject("Error occured");
}
}
};
Http.onerror = (error) => {
reject("Error occured");
};
const url = "https://api.acmecorp.com/skyflowToken";
Http.open("GET", url);
Http.send();
})
}
For logLevel parameter, there are 4 accepted values in LogLevel
DEBUG
When LogLevel.DEBUG is passed, all level of logs will be printed(DEBUG, INFO, WARN, ERROR).
INFO
When LogLevel.INFO is passed, INFO logs for every event that has occurred during the SDK flow execution will be printed along with WARN and ERROR logs.
WARN
When LogLevel.WARN is passed, WARN and ERROR logs will be printed.
ERROR
When LogLevel.ERROR is passed, only ERROR logs will be printed.
Note:
logLevel is optional, by default the logLevel will be ERROR.For env parameter, there are 2 accepted values in Env
PROD
DEV
In Event Listeners, actual value of element can only be accessed inside the handler when the env is set to DEV.
Note:
env is optional, by default the env will be PROD.env option with caution, make sure the env is set to PROD when using skyflow-react-js in production.Skyflow Elements provide developers with pre-built form elements to securely collect sensitive data client-side. These elements are hosted by Skyflow and injected into your web page as iFrames. This reduces your PCI compliance scope by not exposing your front-end application to sensitive data. Follow the steps below to securely collect data with Skyflow Elements.
First create a container for the form elements using the useCollectContainer hook as show below:
const container = useCollectContainer()
import {
CardNumberElement,
} from "skyflow-react-js";
<CardNumberElement
table="<TABLE_NAME>"
container="<CONTAINER>"
column="<COLUMN_NAME>"
… props
/>
The following props can be passed to Skyflow collect Element:
{
conatiner: "CollectContainer" // required, the collect container
table: "string", //required, the table this data belongs to
column: "string", //required, the column into which this data should be inserted
id: string, //optioanl, id that can passed to the element
classes: {}, //optional, styles that should be applied to the element
label: "string", //optional, label for the form element
placeholder: "string", //optional, placeholder for the form element
validations: [] // optional array of validation rules
onChange: Function; //optional, function that is passed to trigger the onChange event
onFocus: Function; //optional, function that is passed to trigger the onChange event
onBlur: Function; //optional, function that is passed to trigger the onChange event
onReady: Function ; //optional, function that is passed to trigger the onChange event
}
The table and column fields indicate which table and column in the vault the Element corresponds to.
Note:
address.street.line1)All elements can be styled using JSS syntax.
An example of styling an element with makeSkyflowStyles hook :
import { makeSkyflowStyles } from "skyflow-react-js";
const useSkyflowStyles = makeSkyflowStyles({
inputStyles: {
base: {
color: "#013370",
// ...otherStyles
}
},
labelStyles: {
base: {
color: "#0D4370",
// ...otherStyles
}
}
errorStyles: {
base: {
color: "#0FE470",
// ...otherStyles
}
},
errorTextStyles: {
base: {
color: "#f44336",
// ...otherStyles
}
}
})
The inputStyles field accepts a style object which consists of CSS properties that should be applied to the form element in the following states:
base: all other variants inherit from these stylescomplete: applied when the Element has valid inputempty: applied when the Element has no inputfocus: applied when the Element has focusinvalid: applied when the Element has invalid inputThe states that are available for labelStyles are base and focus.
An example of a labelStyles object:
labelStyles: {
base: {
fontSize: "12px",
fontWeight: "bold"
},
focus: {
color: "#1d1d1d"
}
}
The state that is available for errorTextStyles is only the base state, it shows up when there is some error in the collect element.
An example of a errorTextStyles object:
errorTextStyles: {
base: {
color: "#f44336"
}
}
We support the following collect elements in the react SDK:
CardHolderNameElementCardNumberElementExpirationDateElementCVVElementPinElementExpirationDateElementExpirationMonthElementExpirationYearElementInputFieldElementThe InputFieldElement type is a custom UI element without any built-in validations. See the section on validations for more information on validations.
Along with Collect Element we can define other options which takes a object of optional parameters as described below:
const options = {
required: false, //optional, indicates whether the field is marked as required. Defaults to 'false'
enableCardIcon: true, // optional, indicates whether card icon should be enabled (only applicable for CARD_NUMBER ElementType)
format: String, //optional, format for the element (only applicable currently for EXPIRATION_DATE ElementType),
enableCopy: false // optional, enables the copy icon in collect and reveal elements to copy text to clipboard. Defaults to 'false')
}
required parameter indicates whether the field is marked as required or not. If not provided, it defaults to false
enableCardIcon parameter indicates whether the icon is visible for the CARD_NUMBER element, defaults to true
format parameter takes string value and indicates the format pattern applicable to the element type, It's currently only applicable to EXPIRATION_DATE and EXPIRATION_YEAR element types.
enableCopy parameter indicates whether the copy icon is visible in collect and reveal elements.
The values that are accepted for EXPIRATION_DATE are
MM/YY (default)MM/YYYYYY/MMYYYY/MMThe values that are accepted for EXPIRATION_YEAR are
YY (default)YYYYNOTE: If not specified or invalid value is passed to the format then it takes default value.
When the form is ready to be submitted, call the collect(options?) method on the container object. The options parameter takes a object of optional parameters as shown below:
tokens: indicates whether tokens for the collected data should be returned or not. Defaults to 'true'additionalFields: Non-PCI elements data to be inserted into the vault which should be in the records object format.const options = {
tokens: true //optional, indicates whether tokens for the collected data should be returned. Defaults to 'true'
additionalFields: {
records: [
{
table: "string", //table into which record should be inserted
fields: {
column1: "value", //column names should match vault column names
//...additional fields here
}
}
//...additional records here
]
} //optional
}
container.collect(options = {})
import React from 'react';
import { CardNumberElement, useCollectContainer, useMakeSkyflowStyles } from 'skyflow-react-js'
function App() {
const container = useCollectContainer()
const useStyles = useMakeSkyflowStyles({
inputStyles: {
base: {
border: '1px solid black',
borderRadius: '4px',
color: '#1d1d1d',
padding: '10px 16px',
},
complete: {
color: '#4caf50',
},
empty: {},
focus: {},
invalid: {
color: '#f44336',
},
},
labelStyles: {
base: {
fontSize: '16px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: 'blue',
},
},
})
const options = {
enableCopy: true,
};
const classes = useStyles()
return (
<div className="App">
<header className="App-header">
<CardNumberElement
container={container}
table={'cards'}
classes={classes}
column={'cardNumber'}
label={'Collect Card Number'}
options={options}
/>
</header>
</div>
)
}
export default App;
Sample Response :
{
"records": [
{
"table": "cards",
"fields": {
"cardNumber": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
}
}
]
}
Skyflow-React which internally uses Skyflow-JS SDK provides two types of validations on Collect Elements
Every Collect Element except of type InputFieldElement has a set of default validations listed below:
CARD_NUMBER: Card number validation with checkSum algorithm(Luhn algorithm).
Available card lengths for defined card types are [12, 13, 14, 15, 16, 17, 18, 19].
A valid 16 digit card number will be in the format - XXXX XXXX XXXX XXXXCARD_HOLDER_NAME: Name should be 2 or more symbols, valid characters should match pattern - ^([a-zA-Z\\ \\,\\.\\-\\']{2,})$CVV: Card CVV can have 3-4 digitsEXPIRATION_DATE: Any date starting from current month. By default valid expiration date should be in short year format - MM/YYPIN: Can have 4-12 digitsCustom validations can be added to any element which will be checked after the default validations have passed. The following Custom validation rules are currently supported:
REGEX_MATCH_RULE: You can use this rule to specify any Regular Expression to be matched with the input field valueconst regexMatchRule = {
type: REGEX_MATCH_RULE,
params: {
regex: RegExp,
error: string // optional, default error is "VALIDATION FAILED"
}
}
LENGTH_MATCH_RULE: You can use this rule to set the minimum and maximum permissible length of the input field valueconst lengthMatchRule = {
type: LENGTH_MATCH_RULE,
params: {
min: number, // optional
max: number, // optional
error: string // optional, default error is "VALIDATION FAILED"
}
}
The Sample for using custom validations:
/*
A simple example that illustrates custom validations.
Adding REGEX_MATCH_RULE , LENGTH_MATCH_RULE to collect element.
*/
import { CardNumberElement, REGEX_MATCH_RULE, LENGTH_MATCH_RULE} from "skyflow-react-js";
// This rule allows 1 or more alphabets
const alphabetsOnlyRegexRule = {
type: REGEX_MATCH_RULE,
params: {
regex: /^[A-Za-z]+$/,
error: "Only alphabets are allowed"
}
};
// This rule allows input length between 4 and 6 characters
const lengthRule = {
type: LENGTH_MATCH_RULE,
params: {
min: 4,
max: 6,
error: "Must be between 4 and 6 alphabets"
}
};
const form = (props) => {
return <CardNumberElement
container="COLLECT CONTAINER"
table="<TABLE_NAME>"
column="<COLUMN_NAME>"
validations= [alphabetsOnlyRegexRule, lengthRule]
...props
/>
}
Helps to communicate with skyflow elements / iframes by listening to an event. Event listeners can be triggered by passing the handler methods as props to the Element components.
There are 4 events which SDK supports:
CHANGE
Change event is triggered when the Element's value changes.
READY
Ready event is triggered when the Element is fully rendered
FOCUS
Focus event is triggered when the Element gains focus
BLUR
Blur event is triggered when the Element loses focus.
The handler function(state) => void is a callback function you provide, that will be called when the event is fired with the state object as shown below.
state : {
elementType: Skyflow.ElementType
isEmpty: boolean
isFocused: boolean
isValid: boolean
value: string
}
Note:
values of SkyflowElements will be returned in elementstate object only when env is DEV, else it is empty string i.e, ''
import React from 'react';
import { CardNumberElement } from 'skyflow-react-js'
function App() {
const container = useCollectContainer()
const handleCollect = () => {
const response = container.collect();
response.then((res: any) => {
console.log(JSON.stringify(res));
}).catch((e: any) => { console.log(e) })
}
const handleOnChange = (changeState: any) => {
console.log("Change", changeState)
}
const handleOnBlur = (changeState: any) => {
console.log("Blur", changeState)
}
return (
<div className="App">
<header className="App-header">
<CardNumberElement
container={container}
table={'table1'}
column={'card_number'}
label={"Collect Card Number"}
onChange={handleOnChange}
onBlur={handleOnBlur} />
<button onClick={handleCollect}>Collect</button>
</header>
</div>
)
}
export default App;
env is DEV{
elementType: "CARD_NUMBER"
isEmpty: false
isFocused: true
isValid: false
value: "411"
}
env is PROD{
elementType: "CARD_NUMBER"
isEmpty: false
isFocused: true
isValid: false
value: ''
}
Skyflow Elements can be used to securely reveal data in a browser without exposing your front end to the sensitive data. This is great for use cases like card issuance where you may want to reveal the card number to a user without increasing your PCI compliance scope.
To start, create a container using the useRevealContainer() method of the Skyflow client as shown below.
const revealContainer = useRevealContainer()
import {
RevealElement,
} from "skyflow-react-js";
<RevealElement
token="<DATA_TOKEN>"
container="<CONTAINER>"
… props
/>
The following props can be passed to Skyflow reveal element:
{
container: "RevealContainer" // required, the reveal container
token:"string" //required, the actual data token
id: string, //optional, id that can passed to the element
classes: {}, //optional, styles that should be applied to the element
label: "string", //optional, label for the form element
}
Note:
import React from 'react';
import { RevealElement, useRevealContainer, useMakeSkyflowStyles } from 'skyflow-react-js'
function App() {
const revealContainer = useRevealContainer()
const useStyles = useMakeSkyflowStyles({
inputStyles: {
base: {
border: '1px solid black',
borderRadius: '4px',
color: '#1d1d1d',
padding: '10px 16px',
},
complete: {
color: '#4caf50',
},
empty: {},
focus: {},
invalid: {
color: '#f44336',
},
},
labelStyles: {
base: {
fontSize: '16px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: 'red',
},
},
})
const handleReveal = () => {
revealContainer.reveal().then((res) => {
console.log(res);
}).catch((err) => {
console.log(err);
});
}
const classes = useStyles()
return (
<div className="App">
<header className="App-header">
<RevealElement
container={revealContainer}
token={"1404-8379-9069-7378"}
label={"Reveal Card Number"}
classes={classes} />
<button onClick={handleReveal}>Reveal</button>
</header>
</div>
)
}
export default App;
{
"success": [
{
"token": "b63ec4e0-bbad-4e43-96e6-6bd50f483f75"
}
],
"errors": [
{
"token": "89024714-6a26-4256-b9d4-55ad69aa4047",
"error": {
"code": 404,
"description": "Tokens not found for 89024714-6a26-4256-b9d4-55ad69aa4047"
}
}
]
}
If you discover a potential security issue in this project, please reach out to us at security@skyflow.com. Please do not create public GitHub issues or Pull Requests, as malicious actors could potentially view them.
This project is licensed under the MIT license. See the LICENSE file for more info.
[1.2.0] - 2022-09-13
INPUT_FIELD element typeFAQs
Skyflow React SDK
The npm package skyflow-react-js receives a total of 1,872 weekly downloads. As such, skyflow-react-js popularity was classified as popular.
We found that skyflow-react-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.