skyflow-js
Advanced tools
Skyflow’s JavaScript SDK can be used to securely collect, tokenize, and reveal sensitive data in the browser without exposing your front-end infrastructure to sensitive data.
Using script tag
<script src="https://js.skyflow.com/v1/index.js"></script>
Using npm
npm install skyflow-js
Use the init() method to initialize a Skyflow client as shown below.
import Skyflow from 'skyflow-js' // If using script tag, this line is not required.
const skyflowClient = Skyflow.init({
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: Skyflow.LogLevel, // Optional, if not specified default is ERROR.
env: Skyflow.Env // Optional, if not specified default is PROD.
}
});
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
const 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 Skyflow.LogLevel
DEBUG
When Skyflow.LogLevel.DEBUG is passed, all level of logs will be printed(DEBUG, INFO, WARN, ERROR).
INFO
When Skyflow.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 Skyflow.LogLevel.WARN is passed, WARN and ERROR logs will be printed.
ERROR
When Skyflow.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 Skyflow.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-js in production.To insert data into the vault, use the insert(records, options?) method of the Skyflow client. The records parameter takes a JSON object of the records to insert into the below format. The options parameter takes a dictionary of optional parameters for the insertion. The insert method also supports upsert operations.
const records = {
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.
],
};
const options = {
tokens: true, // Indicates whether or not tokens should be returned for the inserted data. Defaults to 'true'
upsert: [ // Upsert operations support in the vault
{
table: 'string', // Table name
column: 'value', // Unique column in the table
}
]
}
skyflowClient.insert(records, options);
An example of an insert call:
skyflowClient.insert({
records: [
{
table: 'cards',
fields: {
cardNumber: '41111111111',
cvv: '123',
},
},
],
});
The sample response:
{
"records": [
{
"table": "cards",
"fields":{
"cardNumber": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
"cvv": "1989cb56-63da-4482-a2df-1f74cd0dd1a5"
}
}
]
}
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 on your web page.
First create a container for the form elements using the container(Skyflow.ContainerType) method of the Skyflow client as show below:
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT)
A Skyflow collect Element is defined as shown below:
const collectElement = {
table: 'string', // Required, the table this data belongs to.
column: 'string', // Required, the column into which this data should be inserted.
type: Skyflow.ElementType, // Skyflow.ElementType enum.
inputStyles: {}, // Optional, styles that should be applied to the form element.
labelStyles: {}, // Optional, styles that will be applied to the label of the collect element.
errorTextStyles: {}, // Optional, styles that will be applied to the errorText of the collect element.
label: 'string', // Optional, label for the form element.
placeholder: 'string', // Optional, placeholder for the form element.
altText: 'string', // (DEPRECATED) string that acts as an initial value for the collect element.
validations: [], // Optional, array of validation rules.
}
The table and column fields indicate which table and column in the vault the Element corresponds to.
Note:
address.street.line1)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 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 inputcardIcon: applied to the card type icon in CARD_NUMBER ElementcopyIcon: applied to copy icon in Elements when enableCopy option is trueStyles are specified with JSS.
An example of a inputStyles object:
inputStyles: {
base: {
border: '1px solid #eae8ee',
padding: '10px 16px',
borderRadius: '4px',
color: '#1d1d1d',
},
complete: {
color: '#4caf50',
},
empty: {},
focus: {},
invalid: {
color: '#f44336',
},
cardIcon: {
position: 'absolute',
left: '8px',
bottom: 'calc(50% - 12px)',
},
copyIcon: {
position: 'absolute',
right: '8px',
},
},
The 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',
},
},
Finally, the type field takes a Skyflow ElementType. Each type applies the appropriate regex and validations to the form element. There are currently 8 types:
CARDHOLDER_NAMECARD_NUMBEREXPIRATION_DATEEXPIRATION_MONTHEXPIRATION_YEARCVVINPUT_FIELDPINFILE_INPUTThe INPUT_FIELD type is a custom UI element without any built-in validations. For information on validations, see validations.
Along with CollectElement 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.
Once the Element object and options has been defined, add it to the container using the create(element, options) method as shown below. The element param takes a Skyflow Element object and options as defined above:
const collectElement = {
table: 'string', // Required, the table this data belongs to.
column: 'string', // Required, the column into which this data should be inserted.
type: Skyflow.ElementType, // Skyflow.ElementType enum.
inputStyles: {}, // Optional, styles that should be applied to the form element.
labelStyles: {}, // Optional, styles that will be applied to the label of the collect element.
errorTextStyles: {}, // Optional, styles that will be applied to the errorText of the collect element.
label: 'string', // Optional, label for the form element.
placeholder: 'string', // Optional, placeholder for the form element.
altText: 'string', // (DEPRECATED) string that acts as an initial value for the collect element.
validations: [], // Optional, array of validation rules.
}
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').
};
const element = container.create(collectElement, options);
To specify where the Elements will be rendered on your page, create placeholder <div> elements with unique id tags. For instance, the form below has 4 empty divs with unique ids as placeholders for 4 Skyflow Elements.
<form>
<div id="cardNumber"/>
<br/>
<div id="expireDate"/>
<br/>
<div id="cvv"/>
<br/>
<div id="pin"/>
<button type="submit">Submit</button>
</form>
Now, when the mount(domElement) method of the Element is called, the Element will be inserted in the specified div. For instance, the call below will insert the Element into the div with the id "#cardNumber".
element.mount('#cardNumber');
you can use the unmount method to reset any collect element to it's initial state.
element.unmount();
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 as described in the above Insert data into vault section.upsert: To support upsert operations while collecting data from Skyflow elements, pass the table and column marked as unique in the table.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
upsert: [ // Upsert operations support in the vault
{
table: 'string', // Table name
column: 'value', // Unique column in the table
},
], // Optional
};
container.collect(options);
//Step 1
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT);
//Step 2
const element = container.create({
table: 'cards',
column: 'cardNumber',
inputstyles: {
base: {
color: '#1d1d1d',
},
cardIcon: {
position: 'absolute',
left: '8px',
bottom: 'calc(50% - 12px)',
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: '#f44336',
},
},
placeholder: 'Card Number',
label: 'card_number',
type: Skyflow.ElementType.CARD_NUMBER,
});
// Step 3
element.mount('#cardNumber'); // Assumes there is a div with id='#cardNumber' in the webpage.
// Step 4
const nonPCIRecords = {
records: [
{
table: 'cards',
fields: {
gender: 'MALE',
},
},
],
};
container.collect({
tokens: true,
additionalFields: nonPCIRecords,
});
Sample Response :
{
"records": [
{
"table": "cards",
"fields": {
"cardNumber": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
"gender": "12f670af-6c7d-4837-83fb-30365fbc0b1e"
}
}
]
}
Sample Code
//Step 1
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT)
//Step 2
const cardNumberElement = container.create({
table: 'cards',
column: 'card_number',
inputStyles: {
base: {
color: '#1d1d1d',
},
cardIcon:{
position: 'absolute',
left:'8px',
bottom:'calc(50% - 12px)'
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold'
}
},
errorTextStyles: {
base: {
color: '#f44336'
}
},
placeholder: 'Card Number',
label: 'card_number',
type: Skyflow.ElementType.CARD_NUMBER
})
const cvvElement = container.create({
table: 'cards',
column: 'cvv',
inputStyles: {
base: {
color: '#1d1d1d',
},
cardIcon:{
position: 'absolute',
left:'8px',
bottom:'calc(50% - 12px)'
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold'
}
},
errorTextStyles: {
base: {
color: '#f44336'
}
},
placeholder: 'CVV',
label: 'cvv',
type: Skyflow.ElementType.CVV
})
// Step 3
cardNumberElement.mount('#cardNumber') //Assumes there is a div with id='#cardNumber' in the webpage.
cvvElement.mount('#cvv'); //Assumes there is a div with id='#cvv' in the webpage.
// Step 4
container.collect({
tokens: true,
upsert: [
{
table: 'cards',
column: 'card_number',
}
]
})
Skyflow returns tokens for the record you just inserted.
{
"records": [
{
"table": "cards",
"fields": {
"cardNumber": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
"gender": "12f670af-6c7d-4837-83fb-30365fbc0b1e"
}
}
]
}
Skyflow-JS provides two types of validations on Collect Elements
Every Collect Element except of type INPUT_FIELD 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: Skyflow.ValidationRuleType.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: Skyflow.ValidationRuleType.LENGTH_MATCH_RULE,
params: {
min : number, // Optional.
max : number, // Optional.
error: string // Optional, default error is 'VALIDATION FAILED'.
}
}
ELEMENT_VALUE_MATCH_RULE: You can use this rule to match the value of one element with another elementconst elementValueMatchRule = {
type: Skyflow.ValidationRuleType.ELEMENT_VALUE_MATCH_RULE,
params: {
element: CollectElement,
error: string // Optional, default error is 'VALIDATION FAILED'.
}
}
The Sample code snippet for using custom validations:
/*
A simple example that illustrates custom validations.
Adding REGEX_MATCH_RULE , LENGTH_MATCH_RULE to collect element.
*/
// This rule allows 1 or more alphabets.
const alphabetsOnlyRegexRule = {
type: Skyflow.ValidationRuleType.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: Skyflow.ValidationRuleType.LENGTH_MATCH_RULE,
params: {
min: 4,
max: 6,
error: 'Must be between 4 and 6 alphabets',
},
};
const cardHolderNameElement = collectContainer.create({
table: 'pii_fields',
column: 'first_name',
...collectStylesOptions,
label: 'Card Holder Name',
placeholder: 'cardholder name',
type: Skyflow.ElementType.INPUT_FIELD,
validations: [alphabetsOnlyRegexRule, lengthRule],
});
/*
Reset PIN - A simple example that illustrates custom validations.
The below code shows an example of ELEMENT_VALUE_MATCH_RULE
*/
// For the PIN element
const pinElement = collectContainer.create({
label: 'PIN',
placeholder: '****',
type: Skyflow.ElementType.PIN,
});
// This rule allows to match the value with pinElement.
const elementMatchRule = {
type: Skyflow.ValidationRuleType.ELEMENT_VALUE_MATCH_RULE,
params: {
element: pinElement,
error: 'PIN does not match',
},
};
const confirmPinElement = collectContainer.create({
label: 'Confirm PIN',
placeholder: '****',
type: Skyflow.ElementType.PIN,
validations: [elementMatchRule],
});
// Mount elements on screen - errors will be shown if any of the validaitons fail.
pinElement.mount('#collectPIN');
confirmPinElement.mount('#collectConfirmPIN');
Helps to communicate with Skyflow elements / iframes by listening to an event
element.on(Skyflow.EventName,handler:function)
There are 4 events in Skyflow.EventName
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 element state object only when env is DEV, else it is empty string i.e, '', but in case of CARD_NUMBER type element when the env is PROD for all the card types except AMEX, it will return first eight digits, for AMEX it will return first six digits and rest all digits in masked format.
// Create Skyflow client.
const skyflowClient = Skyflow.init({
vaultID: '<VAULT_ID>',
vaultURL: '<VAULT_URL>',
getBearerToken: () => {},
options: {
env: Skyflow.Env.DEV,
},
});
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT);
const cardHolderName = container.create({
table: 'pii_fields',
column: 'first_name',
type: Skyflow.ElementType.CARDHOLDER_NAME,
});
const cardNumber = container.create({
table: 'pii_fields',
column: 'primary_card.card_number',
type: Skyflow.ElementType.CARD_NUMBER,
});
cardNumber.mount('#cardNumberContainer');
cardHolderName.mount('#cardHolderNameContainer');
// Subscribing to CHANGE event, which gets triggered when element changes.
cardHolderName.on(Skyflow.EventName.CHANGE, state => {
// Your implementation when Change event occurs.
console.log(state);
});
// Subscribing to CHANGE event, which gets triggered when element changes.
cardNumber.on(Skyflow.EventName.CHANGE, state => {
// Your implementation when Change event occurs.
console.log(state);
});
env is DEV{
elementType: 'CARDHOLDER_NAME',
isEmpty: false,
isFocused: true,
isValid: false,
value: 'John',
};
{
elementType: 'CARD_NUMBER',
isEmpty: false,
isFocused: true,
isValid: false,
value: '4111-1111-1111-1111',
};
env is PROD{
elementType: 'CARDHOLDER_NAME',
isEmpty: false,
isFocused: true,
isValid: false,
value: '',
};
{
elementType: 'CARD_NUMBER',
isEmpty: false,
isFocused: true,
isValid: false,
value: '4111-1111-XXXX-XXXX',
};
Helps to display custom error messages on the Skyflow Elements through the methods setError and resetError on the elements.
setError(error: string) method is used to set the error text for the element, when this method is triggered, all the current errors present on the element will be overridden with the custom error message passed. This error will be displayed on the element until resetError() is triggered on the same element.
resetError() method is used to clear the custom error message that is set using setError.
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT);
const cardNumber = container.create({
table: 'pii_fields',
column: 'primary_card.card_number',
type: Skyflow.ElementType.CARD_NUMBER,
});
// Set custom error.
cardNumber.setError('custom error');
// Reset custom error.
cardNumber.resetError();
setValue(value: string) method is used to set the value of the element. This method will override any previous value present in the element.
clearValue() method is used to reset the value of the element.
Note: This methods are only available in DEV env for testing/developmental purposes and MUST NOT be used in PROD env.
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT);
const cardNumber = container.create({
table: 'pii_fields',
column: 'primary_card.card_number',
type: Skyflow.ElementType.CARD_NUMBER,
});
// Set a value programatically.
cardNumber.setValue('4111111111111111');
// Clear the value.
cardNumber.clearValue();
Composable Elements combine multiple Skyflow Elements in a single iframe, letting you create multiple Skyflow Elements in a single row. The following steps create a composable element and securely collect data through it.
Create a container for the composable element using the container(Skyflow.ContainerType) method of the Skyflow client:
const collectContainer = skyflow.container(Skyflow.ContainerType.COMPOSABLE,containerOptions);
The container requires an options object that contains the following keys:
layout: An array that indicates the number of rows in the container and the number of elements in each row. The index value of the array defines the number of rows, and each value in the array represents the number of elements in that row, in order.
For example: [2,1] means the container has two rows, with two elements in the first row and one element in the second row.
Note: The sum of values in the layout array should be equal to the number of elements created
styles: CSS styles to apply to the composable container.
errorTextStyles: CSS styles to apply if an error is encountered.
const options = {
layout: [2, 1], // Required
styles: { // Optional
base: {
border: '1px solid #DFE3EB',
padding: '8px',
borderRadius: '4px',
margin: '12px 2px',
},
},
errorTextStyles: { // Optional
base: {
color: 'red',
},
},
};
Composable Elements use the following schema:
const composableElement = {
table: 'string', // Required. The table this data belongs to.
column: 'string', // Required. The column this data belongs to.
type: Skyflow.ElementType, // Skyflow.ElementType enum.
inputStyles: {}, // Optional. Styles applied to the form element.
labelStyles: {}, // Optional. Styles for the label of the collect element.
errorTextStyles: {}, // Optional. Styles for the errorText of the collect element.
label: 'string', // Optional. Label for the form element.
placeholder: 'string', // Optional. Placeholder for the form element.
altText: 'string', // (DEPRECATED) Initial value for the collect element.
validations: [], // Optional. Array of validation rules.
}
The table and column fields indicate which table and column in the vault the Element correspond to.
Note: Use dot-delimited strings to specify columns nested inside JSON fields (for example, address.street.line1).
All elements can be styled with JSS syntax.
The inputStyles field accepts an object of CSS properties to apply to the form element in the following states:
base: all 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 inputcardIcon: applied to the card type icon in CARD_NUMBER ElementcopyIcon: applied to copy icon in Elements when enableCopy option is trueAn example of an inputStyles object:
inputStyles: {
base: {
border: '1px solid #eae8ee',
padding: '10px 16px',
borderRadius: '4px',
color: '#1d1d1d',
},
complete: {
color: '#4caf50',
},
empty: {},
focus: {},
invalid: {
color: '#f44336',
},
cardIcon: {
position: 'absolute',
left: '8px',
bottom: 'calc(50% - 12px)',
},
copyIcon: {
position: 'absolute',
right: '8px',
},
}
The labelStyles field supports the base and focus states.
An example labelStyles object:
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold'
},
focus: {
color: '#1d1d1d'
}
}
The errorTextStyles field only supports the base state, which appears when there is an error in the composable element.
An example errorTextStyles object:
errorTextStyles: {
base: {
color: '#f44336'
}
}
The JS SDK supports the following composable elements:
CARDHOLDER_NAMECARD_NUMBEREXPIRATION_DATEEXPIRATION_MONTHEXPIRATION_YEARCVVINPUT_FIELDPINNote: Only when the entered value in the below composable elements is valid, the focus shifts automatically. The element types are:
CARD_NUMBEREXPIRATION_DATEEXPIRATION_MONTHEXPIRATION_YEARThe INPUT_FIELD type is a custom UI element without any built-in validations. For information on validations, see validations.
Along with the Composable Element definition, you can define additional options for the element:
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: Whether or not the field is marked as required. Defaults to false.enableCardIcon: Whether or not the icon is visible for the CARD_NUMBER element. Defaults to true.format: Format pattern for the element. Only applicable to EXPIRATION_DATE and EXPIRATION_YEAR element types.enableCopy: Whether or not the copy icon is visible in collect and reveal elements. Defaults to false.The accepted EXPIRATION_DATE values are
MM/YY (default)MM/YYYYYY/MMYYYY/MMThe accepted EXPIRATION_YEAR values are
YY (default)YYYYOnce you define the Element object and options, add it to the container using the create(element, options) method:
const composableElement = {
table: 'string', // Required, the table this data belongs to.
column: 'string', // Required, the column into which this data should be inserted.
type: Skyflow.ElementType, // Skyflow.ElementType enum.
inputStyles: {}, // Optional, styles that should be applied to the form element.
labelStyles: {}, // Optional, styles that will be applied to the label of the collect element.
errorTextStyles: {}, // Optional, styles that will be applied to the errorText of the collect element.
label: 'string', // Optional, label for the form element.
placeholder: 'string', // Optional, placeholder for the form element.
altText: 'string', // (DEPRECATED) string that acts as an initial value for the collect element.
validations: [], // Optional, array of validation rules.
}
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').
};
const element = container.create(composableElement, options);
To specify where the Elements are rendered on your page, create a placeholder <div> element with unique id attribute. Use this empty <div> placeholder to mount the composable container.
<form>
<div id="composableContainer"/>
<br/>
<div id="button-id"/>
<button type="submit">Submit</button>
</form>
Use the composable container's mount(domElement) method to insert the container's Elements into the specified <div>. For instance, the following call inserts Elements into the <div> with the id "#composableContainer".
container.mount('#composableContainer');
When the form is ready to be submitted, call the container's collect(options?) method. The options parameter takes an object of optional parameters as follows:
tokens: Whether or not tokens for the collected data are returned. Defaults to 'true'additionalFields: Non-PCI elements data to insert into the vault, specified in the records object format.upsert: To support upsert operations, the table containing the data and a column marked as unique in that table.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
upsert: [ // Upsert operations support in the vault
{
table: 'string', // Table name
column: 'value', // Unique column in the table
},
], // Optional
};
// Step 1
const containerOptions = {
layout: [2, 1],
styles: {
base: {
border: '1px solid #eae8ee',
padding: '10px 16px',
borderRadius: '4px',
margin: '12px 2px',
},
},
errorTextStyles: {
base: {
color: 'red',
},
},
};
const composableContainer = skyflow.container(
Skyflow.ContainerType.COMPOSABLE,
containerOptions
);
// Step 2
const collectStylesOptions = {
inputStyles: {
base: {
fontFamily: 'Inter',
fontStyle: 'normal',
fontWeight: 400,
fontSize: '14px',
lineHeight: '21px',
width: '294px',
},
},
labelStyles: {},
errorTextStyles: {
base: {},
},
};
const cardHolderNameElement = composableContainer.create({
table: 'pii_fields',
column: 'first_name',
...collectStylesOptions,
placeholder: 'Cardholder Name',
type: Skyflow.ElementType.CARDHOLDER_NAME,
});
const cardNumberElement = composableContainer.create({
table: 'pii_fields',
column: 'card_number',
...collectStylesOptions,
placeholder: 'Card Number',
type: Skyflow.ElementType.CARD_NUMBER,
});
const cvvElement = composableContainer.create({
table: 'pii_fields',
column: 'cvv',
...collectStylesOptions,
placeholder: 'CVV',
type: Skyflow.ElementType.CVV,
});
// Step 3
composableContainer.mount('#composableContainer'); // Assumes there is a div with id='#composableContainer' in the webpage.
// Step 4
composableContainer.collect({
tokens: true,
});
{
"records": [
{
"table": "pii_fields",
"fields": {
"first_name": "63b5eeee-3624-493f-825e-137a9336f882",
"card_number": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
"cvv": "7baf5bda-aa22-4587-a5c5-412f6f783a19",
}
}
]
}
For information on validations, see validations.
You can communicate with Skyflow Elements by listening to element events:
element.on(Skyflow.EventName,handler:function)
The SDK supports four events:
CHANGE: Triggered when the Element's value changes.READY: Triggered when the Element is fully rendered.FOCUS: Triggered when the Element gains focus.BLUR: Triggered when the Element loses focus.The handler function(state) => void is a callback function you provide that's called when the event is fired with a state object that uses the following schema:
state : {
elementType: Skyflow.ElementType
isEmpty: boolean
isFocused: boolean
isValid: boolean
value: string
}
Note: Events only include element values when in the state object when env is DEV. By default, value is an empty string.
const containerOptions = {
layout: [1],
styles: {
base: {
border: '1px solid #eae8ee',
padding: '10px 16px',
borderRadius: '4px',
margin: '12px 2px',
}
},
errorTextStyles: {
base: {
color: 'red'
}
}
}
const composableContainer = skyflow.container(Skyflow.ContainerType.COMPOSABLE, containerOptions);
const cvv = composableContainer.create({
table: 'pii_fields',
column: 'primary_card.cvv',
type: Skyflow.ElementType.CVV,
});
composableContainer.mount('#cvvContainer');
// Subscribing to CHANGE event, which gets triggered when element changes.
cvv.on(Skyflow.EventName.CHANGE, state => {
// Your implementation when Change event occurs.
console.log(state);
});
Sample Element state object when env is DEV
{
elementType: 'CVV'
isEmpty: false
isFocused: true
isValid: false
value: '411'
}
Sample Element state object when env is PROD
{
elementType: 'CVV'
isEmpty: false
isFocused: true
isValid: false
value: ''
}
For non-PCI use-cases, retrieving data from the vault and revealing it in the browser can be done either using the SkyflowID's or tokens as described below
detokenize(records) method. The records parameter takes a JSON object that contains records to be fetched as shown below.const records = {
records: [
{
token: 'string', // Token for the record to be fetched.
redaction: RedactionType // Optional. Redaction to be applied for retrieved data.
},
],
};
Note: If you do not provide a redaction type, RedactionType.PLAIN_TEXT is the default.
skyflow.detokenize(records);
An example of a detokenize call:
skyflow.detokenize({
records: [
{
token: '131e70dc-6f76-4319-bdd3-96281e051051',
},
{
token: '1r434532-6f76-4319-bdd3-96281e051051',
redaction: Skyflow.RedactionType.MASKED
}
],
});
The sample response:
{
"records": [
{
"token": "131e70dc-6f76-4319-bdd3-96281e051051",
"value": "1990-01-01",
},
{
"token": "1r434532-6f76-4319-bdd3-96281e051051",
"value": "xxxxxxer",
}
]
}
getById(records) method.The records parameter takes a JSON object that contains records to be fetched as shown below.{
records: [
{
ids: string[], // Array of SkyflowID's of the records to be fetched.
table: string, // Table holding the above skyflow_id's.
redaction: Skyflow.RedactionType, // Redaction to be applied to retrieved data.
}
]
}
There are 4 accepted values in Skyflow.RedactionTypes:
PLAIN_TEXTMASKEDREDACTEDDEFAULTAn example of getById call:
skyflow.getById({
records: [
{
ids: ['f8d8a622-b557-4c6b-a12c-c5ebe0b0bfd9'],
table: 'cards',
redaction: Skyflow.RedactionType.PLAIN_TEXT,
},
{
ids: ['da26de53-95d5-4bdb-99db-8d8c66a35ff9'],
table: 'contacts',
redaction: Skyflow.RedactionType.PLAIN_TEXT,
},
],
});
The sample response:
{
"records": [
{
"fields": {
"card_number": "4111111111111111",
"cvv": "127",
"expiry_date": "11/2035",
"fullname": "myname",
"id": "f8d8a622-b557-4c6b-a12c-c5ebe0b0bfd9"
},
"table": "cards"
}
],
"errors": [
{
"error": {
"code": "404",
"description": "No Records Found"
},
"ids": ["da26de53-95d5-4bdb-99db-8d8c66a35ff9"]
}
]
}
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 container(Skyflow.ContainerType) method of the Skyflow client as shown below.
const container = skyflowClient.container(Skyflow.ContainerType.REVEAL)
Then define a Skyflow Element to reveal data as shown below.
const revealElement = {
token: 'string', // Required, token of the data being revealed.
inputStyles: {}, // Optional, styles to be applied to the element.
labelStyles: {}, // Optional, styles to be applied to the label of the reveal element.
errorTextStyles: {}, // Optional, styles that will be applied to the errorText of the reveal element.
label: 'string', // Optional, label for the form element.
altText: 'string', // Optional, string that is shown before reveal, will show token if altText is not provided.
redaction: RedactionType, //Optional, Redaction Type to be applied to data, RedactionType.PLAIN_TEXT will be applied if not provided.
};
Note: If you don't provide a redaction type, RedactionType.PLAIN_TEXT will apply by default.
The inputStyles, labelStyles and errorTextStyles parameters accepts a styles object as described in the previous section for collecting data. But for reveal element, inputStyles accepts only base variant and copyIcon style object.
An example of a inputStyles object:
inputStyles: {
base: {
color: '#1d1d1d',
},
copyIcon: {
position: 'absolute',
right: '8px',
top: 'calc(50% - 10px)',
},
},
An example of a labelStyles object:
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold',
},
},
An example of a errorTextStyles object:
errorTextStyles: {
base: {
color: '#f44336',
},
},
Once you've defined a Skyflow Element, you can use the create(element) method of the container to create the Element as shown below:
const element = container.create(revealElement)
Elements used for revealing data are mounted to the DOM the same way as Elements used for collecting data. Refer to Step 3 of the section above.
When the sensitive data is ready to be retrieved and revealed, call the reveal() method on the container as shown below:
container
.reveal()
.then(data => {
// Handle success.
})
.catch(err => {
// Handle error.
});
// Step 1.
const container = skyflowClient.container(Skyflow.ContainerType.REVEAL);
// Step 2.
const cardNumberElement = container.create({
token: 'b63ec4e0-bbad-4e43-96e6-6bd50f483f75',
inputStyles: {
base: {
color: '#1d1d1d',
},
},
labelStyles: {
base: {
fontSize: '12px',
},
},
errorTextStyles: {
base: {
color: '#f44336',
},
},
label: 'card_number',
altText: 'XXXX XXXX XXXX XXXX',
redaction: SKyflow.RedactionType.MASKED
});
const cvvElement = container.create({
token: '89024714-6a26-4256-b9d4-55ad69aa4047',
inputStyles: {
base: {
color: '#1d1d1d',
},
},
label: 'cvv',
altText: 'XXX',
});
const expiryDate= container.create({
token: 'a4b24714-6a26-4256-b9d4-55ad69aa4047',
inputStyles: {
base: {
color: '#1d1d1d',
},
},
label: 'expiryDate',
altText: 'MM/YYYY',
});
// Step 3.
cardNumberElement.mount('#cardNumber'); // Assumes there is a placeholder div with id='cardNumber' on the page
cvvElement.mount('#cvv'); // Assumes there is a placeholder div with id='cvv' on the page
expiryDate.mount('#expiryDate'); // Assumes there is a placeholder div with id='expiryDate' on the page
// Step 4.
container
.reveal()
.then(data => {
// Handle success.
})
.catch(err => {
// Handle error.
});
The response below shows that some tokens assigned to the reveal elements get revealed successfully, while others fail and remain unrevealed.
{
"success": [
{
"token": "b63ec4e0-bbad-4e43-96e6-6bd50f483f75",
"value": "xxxxxxxxx4163"
},
{
"token": "a4b24714-6a26-4256-b9d4-55ad69aa4047",
"value": "12/2098"
}
],
"errors": [
{
"token": "89024714-6a26-4256-b9d4-55ad69aa4047",
"error": {
"code": 404,
"description": "Tokens not found for 89024714-6a26-4256-b9d4-55ad69aa4047"
}
}
]
}
Helps to display custom error messages on the Skyflow Elements through the methods setError and resetError on the elements.
setError(error: string) method is used to set the error text for the element, when this method is triggered, all the current errors present on the element will be overridden with the custom error message passed. This error will be displayed on the element until resetError() is triggered on the same element.
resetError() method is used to clear the custom error message that is set using setError.
const container = skyflowClient.container(Skyflow.ContainerType.REVEAL);
const cardNumber = container.create({
token: '89024714-6a26-4256-b9d4-55ad69aa4047',
});
// Set custom error.
cardNumber.setError('custom error');
// Reset custom error.
cardNumber.resetError();
The setToken(value: string) method can be used to set the token of the Reveal Element. If no altText is set, the set token will be displayed on the UI as well. If altText is set, then there will be no change in the UI but the token of the element will be internally updated.
const container = skyflowClient.container(Skyflow.ContainerType.REVEAL);
const cardNumber = container.create({
altText: 'Card Number',
});
// Set token.
cardNumber.setToken('89024714-6a26-4256-b9d4-55ad69aa4047');
The setAltText(value: string) method can be used to set the altText of the Reveal Element. This will cause the altText to be displayed in the UI regardless of whether the token or value is currently being displayed.
clearAltText() method can be used to clear the altText, this will cause the element to display the token or actual value of the element. If the element has no token, the element will be empty.
const container = skyflowClient.container(Skyflow.ContainerType.REVEAL);
const cardNumber = container.create({
token: '89024714-6a26-4256-b9d4-55ad69aa4047',
});
// Set altText.
cardNumber.setAltText('Card Number');
// Clear altText.
cardNumber.clearAltText();
You can upload binary files to a vault using the Skyflow File Element. Use the following steps to securely upload a file.
Create a container for the form elements using the container(Skyflow.ContainerType) method of the Skyflow client:
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT)
Skyflow Collect Elements are defined as follows:
const collectElement = {
type: Skyflow.ElementType.FILE_INPUT, // Skyflow.ElementType enum.
table: 'string', // The table this data belongs to.
column: 'string', // The column into which this data should be inserted.
skyflowID: 'string', // The skyflow_id of the record.
inputStyles: {}, // Optional, styles that should be applied to the form element.
labelStyles: {}, // Optional, styles that will be applied to the label of the collect element.
errorTextStyles:{}, // Optional, styles that will be applied to the errorText of the collect element.
}
The table and column fields indicate which table and column the Element corresponds to.
skyflowID indicates the record that stores the file.
Notes:
skyflowID is required while creating File elementaddress.street.line1).To specify where to render Elements on your page, create placeholder <div> elements with unique id tags. For instance, the form below has an empty div with a unique id as a placeholder for a Skyflow Element.
<form>
<div id="file"/>
<br/>
<button type="submit">Submit</button>
</form>
Now, when the mount(domElement) method of the Element is called, the Element is inserted in the specified div. For instance, the call below inserts the Element into the div with the id "#file".
element.mount('#file');
Use the unmount method to reset a Collect Element to its initial state.
element.unmount();
When the file is ready to be uploaded, call the uploadFiles() method on the container object.
container.uploadFiles();
// Step 1.
const container = skyflowClient.container(Skyflow.ContainerType.COLLECT);
// Step 2.
const element = container.create({
table: 'pii_fields',
column: 'file',
skyflowID: '431eaa6c-5c15-4513-aa15-29f50babe882',
inputstyles: {
base: {
color: '#1d1d1d',
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: '#f44336',
},
},
type: Skyflow.ElementType.FILE_INPUT,
});
// Step 3.
element.mount('#file'); // Assumes there is a div with id='#file' in the webpage.
// Step 4.
container.uploadFiles();
Sample Response :
{
fileUploadResponse: [
{
"skyflow_id": "431eaa6c-5c15-4513-aa15-29f50babe882"
}
]
}
// Create collect Container.
const collectContainer = skyflow.container(Skyflow.ContainerType.COLLECT);
// Create collect elements.
const cardNumberElement = collectContainer.create({
table: 'newTable',
column: 'card_number',
inputstyles: {
base: {
color: '#1d1d1d',
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: '#f44336',
},
},
placeholder: 'card number',
label: 'Card Number',
type: Skyflow.ElementType.CARD_NUMBER,
});
const fileElement = collectContainer.create({
table: 'newTable',
column: 'file',
skyflowID: '431eaa6c-5c15-4513-aa15-29f50babe882',
inputstyles: {
base: {
color: '#1d1d1d',
},
},
labelStyles: {
base: {
fontSize: '12px',
fontWeight: 'bold',
},
},
errorTextStyles: {
base: {
color: '#f44336',
},
},
type: Skyflow.ElementType.FILE_INPUT,
});
// Mount the elements.
cardNumberElement.mount('#collectCardNumber');
fileElement.mount('#collectFile');
// Collect and upload methods.
container.collect({});
container.uploadFiles();
Sample Response for collect():
{
"records": [
{
"table": "newTable",
"fields": {
"card_number": "f3907186-e7e2-466f-91e5-48e12c2bcbc1",
}
}
]
}
Sample Response for file uploadFiles() :
{
"fileUploadResponse": [
{
"skyflow_id": "431eaa6c-5c15-4513-aa15-29f50babe882"
}
]
}
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.
[1.27.0] - 2023-02-20
FAQs
Skyflow JavaScript SDK
The npm package skyflow-js receives a total of 2,539 weekly downloads. As such, skyflow-js popularity was classified as popular.
We found that skyflow-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
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."