skyflow-js 1.3.0 → 1.7.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.3.0",
+  "version": "1.7.0",
   "author": "Skyflow",
   "description": "Skyflow JavaScript SDK",
   "homepage": "https://github.com/skyflowapi/skyflow-js",
@@ -41,6 +41,7 @@
     "jss-preset-default": "^10.7.1",
     "jwt-decode": "^3.1.2",
     "lodash": "^4.17.21",
+    "regex-parser": "^2.2.11",
     "set-value": "^4.0.1"
   },
   "engines": {

package/types/Skyflow.d.ts

@@ -1,7 +1,7 @@
 import { ElementType } from './container/constants';
 import CollectContainer from './container/external/CollectContainer';
 import RevealContainer from './container/external/RevealContainer';
-import { IRevealResponseType, IGatewayConfig, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetByIdInput, RedactionType, EventName, Env, LogLevel } from './utils/common';
+import { IRevealResponseType, IConnectionConfig, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetByIdInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType } from './utils/common';
 export declare enum ContainerType {
     COLLECT = "COLLECT",
     REVEAL = "REVEAL"
@@ -16,11 +16,11 @@ declare class Skyflow {
     #private;
     constructor(config: ISkyflow);
     static init(config: ISkyflow): Skyflow;
-    container(type: ContainerType, options?: Record<string, any>): CollectContainer | RevealContainer;
+    container(type: ContainerType, options?: Record<string, any>): RevealContainer | CollectContainer;
     insert(records: IInsertRecordInput, options?: Record<string, any>): Promise<any>;
     detokenize(detokenizeInput: IDetokenizeInput): Promise<IRevealResponseType>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
-    invokeGateway(config: IGatewayConfig): Promise<unknown>;
+    invokeConnection(config: IConnectionConfig): Promise<unknown>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;
@@ -28,5 +28,6 @@ declare class Skyflow {
     static get LogLevel(): typeof LogLevel;
     static get EventName(): typeof EventName;
     static get Env(): typeof Env;
+    static get ValidationRuleType(): typeof ValidationRuleType;
 }
 export default Skyflow;

package/types/container/constants.d.ts

@@ -7,7 +7,7 @@ export declare const PUREJS_TYPES: {
     INSERT: string;
     DETOKENIZE: string;
     GET_BY_SKYFLOWID: string;
-    INVOKE_GATEWAY: string;
+    INVOKE_CONNECTION: string;
 };
 export declare const ELEMENT_EVENTS_TO_CLIENT: {
     CHANGE: string;
@@ -47,7 +47,9 @@ export declare enum ElementType {
     CVV = "CVV",
     EXPIRATION_DATE = "EXPIRATION_DATE",
     CARD_NUMBER = "CARD_NUMBER",
-    CARDHOLDER_NAME = "CARDHOLDER_NAME"
+    CARDHOLDER_NAME = "CARDHOLDER_NAME",
+    INPUT_FIELD = "INPUT_FIELD",
+    PIN = "PIN"
 }
 export declare const ELEMENTS: {
     text: {
@@ -233,6 +235,23 @@ export declare const ELEMENTS: {
         sensitive: boolean;
         regex: RegExp;
     };
+    INPUT_FIELD: {
+        name: string;
+        sensitive: boolean;
+        attributes: {
+            type: string;
+        };
+    };
+    PIN: {
+        name: string;
+        attributes: {
+            type: string;
+            maxLength: number;
+            minLength: number;
+        };
+        sensitive: boolean;
+        regex: RegExp;
+    };
 };
 export declare const IFRAME_DEFAULT_STYLES: {
     height: string;
@@ -262,6 +281,16 @@ export declare const INPUT_STYLES: {
     margin: string;
     outline: string;
 };
+export declare const INPUT_WITH_ICON_STYLES: {
+    'background-position': string;
+    'background-repeat': string;
+    'text-indent': string;
+};
+export declare const INPUT_WITH_ICON_DEFAULT_STYLES: {
+    'background-repeat': string;
+    'text-indent': string;
+    padding: string;
+};
 export declare const ERROR_TEXT_STYLES: {
     color: string;
     padding: string;
@@ -306,4 +335,76 @@ export declare const COLLECT_ELEMENT_LABEL_DEFAULT_STYLES: {
         marginBottom: string;
     };
 };
-export declare const gatewayConfigParseKeys: string[];
+export declare const connectionConfigParseKeys: string[];
+export declare enum CardType {
+    VISA = "VISA",
+    MASTERCARD = "MASTERCARD",
+    AMEX = "AMEX",
+    DINERS_CLUB = "DINERS_CLUB",
+    DISCOVER = "DISCOVER",
+    JCB = "JCB",
+    MAESTRO = "MAESTRO",
+    UNIONPAY = "UNIONPAY",
+    HIPERCARD = "HIPERCARD",
+    DEFAULT = "DEFAULT"
+}
+export declare const CARD_TYPE_REGEX: {
+    VISA: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    MASTERCARD: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    AMEX: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    DINERS_CLUB: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    DISCOVER: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    JCB: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    HIPERCARD: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    UNIONPAY: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+    MAESTRO: {
+        regex: RegExp;
+        maxCardLength: number;
+        cardLengthRange: number[];
+    };
+};
+export declare const DEFAULT_CARD_LENGTH_RANGE: number[];
+export declare const CARD_ENCODED_ICONS: {
+    DEFAULT: string;
+    AMEX: string;
+    DINERS_CLUB: string;
+    DISCOVER: string;
+    HIPERCARD: string;
+    JCB: string;
+    MAESTRO: string;
+    MASTERCARD: string;
+    UNIONPAY: string;
+    VISA: string;
+};

package/types/container/external/CollectContainer.d.ts

@@ -1,7 +1,7 @@
 import { ElementType } from '../constants';
 import Element from './element';
-import { IInsertRecordInput } from '../../utils/common';
-interface CollectElementInput {
+import { IInsertRecordInput, IValidationRule } from '../../utils/common';
+export interface CollectElementInput {
     table?: string;
     column?: string;
     inputStyles?: object;
@@ -11,6 +11,7 @@ interface CollectElementInput {
     placeholder?: string;
     type: ElementType;
     altText?: string;
+    validations?: IValidationRule[];
 }
 interface ICollectOptions {
     tokens?: boolean;

package/types/container/external/PureJsController.d.ts

@@ -1,10 +1,10 @@
-import { IDetokenizeInput, IGetByIdInput, IGatewayConfig } from '../../utils/common';
+import { IDetokenizeInput, IGetByIdInput, IConnectionConfig } from '../../utils/common';
 declare class PureJsController {
     #private;
     constructor(client: any, context: any);
     detokenize(detokenizeInput: IDetokenizeInput): Promise<any>;
     insert(records: any, options: any): Promise<any>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
-    invokeGateway(config: IGatewayConfig): Promise<unknown>;
+    invokeConnection(config: IConnectionConfig): Promise<unknown>;
 }
 export default PureJsController;

package/types/container/external/element/IFrame.d.ts

@@ -3,7 +3,7 @@ export default class IFrame {
     metadata: any;
     iframe: HTMLIFrameElement;
     container?: Element;
-    constructor(name: any, metadata: any, containerId: any);
+    constructor(name: any, metadata: any, containerId: any, logLevel: any);
     mount: (domElement: any) => void;
     unmount: () => void;
 }

package/types/container/internal/FrameElements.d.ts

@@ -1,9 +1,10 @@
+import { LogLevel } from '../../utils/common';
 export default class FrameElements {
     #private;
     private static group?;
     private static frameElements?;
     private getOrCreateIFrameFormElement;
-    constructor(getOrCreateIFrameFormElement: any, metaData: any);
+    constructor(getOrCreateIFrameFormElement: any, metaData: any, logLevel: LogLevel);
     static start: () => void;
     static init: (getOrCreateIFrameFormElement: Function, metaData: any) => void;
     setup: () => void;

package/types/container/internal/iFrameForm/index.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from '../../../event-emitter';
-import { Context } from '../../../utils/common';
+import { Context, IValidationRule, LogLevel } from '../../../utils/common';
 export declare class IFrameFormElement extends EventEmitter {
     state: {
         value: string | undefined;
@@ -16,15 +16,18 @@ export declare class IFrameFormElement extends EventEmitter {
     iFrameName: string;
     metaData: any;
     private regex?;
+    validations?: IValidationRule[];
+    errorText?: string;
     replacePattern?: [RegExp, string];
     mask?: any;
     context: Context;
-    constructor(name: string, metaData: any, context: Context);
+    label?: string;
+    constructor(name: string, label: string, metaData: any, context: Context);
     onFocusChange: (focus: boolean) => void;
     changeFocus: (focus: boolean) => void;
     setReplacePattern(pattern: string[]): void;
     setMask(mask: string[]): void;
-    setValidation(): void;
+    setValidation(validations: IValidationRule[] | undefined): void;
     setSensitive(sensitive?: boolean): void;
     setValue: (value?: string, valid?: boolean) => void;
     getValue: () => string | undefined;
@@ -37,6 +40,7 @@ export declare class IFrameFormElement extends EventEmitter {
         value: string | undefined;
     };
     validator(value: string): boolean;
+    validateCustomValidations(value: string): boolean;
     collectBusEvents: () => void;
     sendChangeStatus: (inputEvent?: boolean) => void;
     resetData(): void;
@@ -50,7 +54,8 @@ export declare class IFrameForm {
     private controllerId;
     private clientDomain;
     private context;
-    constructor(controllerId: string, clientDomain: string);
+    private logLevel;
+    constructor(controllerId: string, clientDomain: string, logLevel: LogLevel);
     setClient(client: any): void;
     setClientMetadata(clientMetaData: any): void;
     setContext(context: Context): void;

package/types/container/internal/index.d.ts

@@ -1,12 +1,13 @@
 import 'jquery-mask-plugin/dist/jquery.mask.min';
 import { IFrameFormElement } from './iFrameForm';
+import { LogLevel } from '../../utils/common';
 export declare class FrameController {
     #private;
     controller?: FrameController;
     controllerId: string;
     private clientDomain;
-    constructor(controllerId: string);
-    static init(uuid: string): FrameController;
+    constructor(controllerId: string, logLevel: LogLevel);
+    static init(uuid: string, logLevel: any): FrameController;
 }
 export declare class FrameElement {
     options: any;

package/types/container/internal/pureJs/PureJsFrameController.d.ts

@@ -1,9 +1,9 @@
-import { IGatewayConfig } from '../../../utils/common';
+import { IConnectionConfig } from '../../../utils/common';
 declare class PureJsFrameController {
     #private;
     constructor();
     static init(): PureJsFrameController;
     insertData(records: any, options: any): Promise<unknown>;
-    sendInvokeGateWayRequest(config: IGatewayConfig): Promise<unknown>;
+    sendInvokeConnectionRequest(config: IConnectionConfig): Promise<unknown>;
 }
 export default PureJsFrameController;

package/types/core/collect.d.ts

@@ -3,4 +3,6 @@ export declare const constructInsertRecordRequest: (records: IInsertRecordInput,
 export declare const constructInsertRecordResponse: (responseBody: any, tokens: boolean, records: IInsertRecord[]) => {
     records: any;
 };
-export declare const constructElementsInsertReq: (req: any, options: any) => any;
+export declare const constructElementsInsertReq: (req: any, options: any) => {
+    records: IInsertRecord[];
+};

package/types/libs/element-options.d.ts

@@ -1,4 +1,7 @@
+import { CollectElementInput } from '../container/external/CollectContainer';
+import { IValidationRule } from '../utils/common';
 export declare function validateElementOptions(elementType: string, oldOptions: any, newOptions?: any): void;
 export declare function validateAndSetupGroupOptions(oldGroup: any, newGroup?: any, setup?: boolean): any;
 export declare const getElements: (group: any) => string[];
 export declare const getValueAndItsUnit: (string?: string, defaultValue?: string, defaultUnit?: string) => string[];
+export declare const formatValidations: (input: CollectElementInput) => IValidationRule[] | undefined;

package/types/libs/objectParse.d.ts

@@ -1,2 +1,2 @@
-export declare function gatewayConfigParser(data: any, configKey: any): void;
-export declare function constructInvokeGatewayRequest(data: any): Promise<any>;
+export declare function connectionConfigParser(data: any, configKey: any): void;
+export declare function constructInvokeConnectionRequest(data: any): Promise<any>;

package/types/libs/styles.d.ts

@@ -1,4 +1,3 @@
-export declare function splitStyles(styles: any): {}[];
 export declare function buildStylesFromClassesAndStyles(classes: any, styles: any): void;
 export declare const getFlexGridStyles: (obj: any) => {
     'align-items': any;

package/types/utils/common/index.d.ts

@@ -32,6 +32,11 @@ export declare enum MessageType {
     WARN = "WARN",
     ERROR = "ERROR"
 }
+export declare enum ValidationRuleType {
+    REGEX_MATCH_RULE = "REGEX_MATCH_RULE",
+    LENGTH_MATCH_RULE = "LENGTH_MATCH_RULE",
+    ELEMENT_VALUE_MATCH_RULE = "ELEMENT_VALUE_MATCH_RULE"
+}
 export interface IInsertRecordInput {
     records: IInsertRecord[];
 }
@@ -62,8 +67,8 @@ export interface Context {
     logLevel: LogLevel;
     env: Env;
 }
-export interface IGatewayConfig {
-    gatewayURL: string;
+export interface IConnectionConfig {
+    connectionURL: string;
     methodName: RequestMethod;
     pathParams?: any;
     queryParams?: any;
@@ -71,3 +76,7 @@ export interface IGatewayConfig {
     requestHeader?: any;
     responseBody?: any;
 }
+export interface IValidationRule {
+    type: ValidationRuleType;
+    params: any;
+}

package/types/utils/constants.d.ts

@@ -119,15 +119,15 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
-    MISSING_GATEWAY_URL: {
+    MISSING_CONNECTION_URL: {
         code: number;
         description: string;
     };
-    INVALID_GATEWAY_URL_TYPE: {
+    INVALID_CONNECTION_URL_TYPE: {
         code: number;
         description: string;
     };
-    INVALID_GATEWAY_URL: {
+    INVALID_CONNECTION_URL: {
         code: number;
         description: string;
     };
@@ -175,5 +175,49 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    INVALID_VALIDATIONS_TYPE: {
+        code: number;
+        description: string;
+    };
+    MISSING_VALIDATION_RULE_TYPE: {
+        code: number;
+        description: string;
+    };
+    INVALID_VALIDATION_RULE_TYPE: {
+        code: number;
+        description: string;
+    };
+    MISSING_VALIDATION_RULE_PARAMS: {
+        code: number;
+        description: string;
+    };
+    INVALID_VALIDATION_RULE_PARAMS: {
+        code: number;
+        description: string;
+    };
+    MISSING_REGEX_IN_REGEX_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
+    INVALID_REGEX_IN_REGEX_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
+    MISSING_MIN_AND_MAX_IN_LENGTH_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
+    MISSING_ELEMENT_IN_ELEMENT_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
+    INVALID_ELEMENT_IN_ELEMENT_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
+    ELEMENT_NOT_MOUNTED_IN_ELEMENT_MATCH_RULE: {
+        code: number;
+        description: string;
+    };
 };
 export default SKYFLOW_ERROR_CODE;

package/types/utils/logs.d.ts

@@ -9,7 +9,7 @@ declare const logs: {
         VALIDATE_RECORDS: string;
         VALIDATE_DETOKENIZE_INPUT: string;
         VALIDATE_GET_BY_ID_INPUT: string;
-        VALIDATE_GATEWAY_CONFIG: string;
+        VALIDATE_CONNECTION_CONFIG: string;
         VALIDATE_COLLECT_RECORDS: string;
         VALIDATE_REVEAL_RECORDS: string;
         CREATED_ELEMENT: string;
@@ -30,7 +30,7 @@ declare const logs: {
         INSERT_TRIGGERED: string;
         DETOKENIZE_TRIGGERED: string;
         GET_BY_ID_TRIGGERED: string;
-        INVOKE_GATEWAY_TRIGGERED: string;
+        INVOKE_CONNECTION_TRIGGERED: string;
         EMIT_PURE_JS_REQUEST: string;
         CAPTURE_PURE_JS_REQUEST: string;
         LISTEN_PURE_JS_REQUEST: string;
@@ -38,9 +38,27 @@ declare const logs: {
         FETCH_RECORDS_RESOLVED: string;
         INSERT_RECORDS_RESOLVED: string;
         GET_BY_SKYFLOWID_RESOLVED: string;
-        SEND_INVOKE_GATEWAY_RESOLVED: string;
+        SEND_INVOKE_CONNECTION_RESOLVED: string;
         EMIT_EVENT: string;
         CAPTURE_EVENT: string;
+        LISTEN_COLLECT_FRAME_READY: string;
+        EMIT_COLLECT_ELEMENT_FRAME_READY: string;
+        ENTERED_COLLECT_FRAME_READY_CB: string;
+        EXECUTE_COLLECT_ELEMENT_FRAME_READY_CB: string;
+        CLIENT_METADATA_NOT_SET: string;
+        EXECUTE_COLLECT_ELEMENT_INIT: string;
+        INSIDE__COLLECT_ELEMENT_INIT: string;
+        CREATING_COLLECT_ELEMENT_FORM: string;
+        COLLECT_FRAME_READY_CB: string;
+        INSIDE_FRAME_ELEMENTS_CONSTRUCOTR: string;
+        SETUP_IN_START: string;
+        SETUP_IN_CONSTRUCTOR: string;
+        COLLECT_ELEMET_START: string;
+        REVEAL_ELEMENT_START: string;
+        EMIT_COLLECT_FRAME_CONTROLLER_EVENT: string;
+        EXECUTE_COLLECT_CONTROLLER_READY_CB: string;
+        IFRAMEFORM_CONSTRUCTOR_FRAME_READY_LISTNER: string;
+        IFRAMEFORM_CONSTRUCTOR_TOKENIZATION_LISTNER: string;
     };
     errorLogs: {
         CLIENT_CONNECTION: string;
@@ -64,7 +82,7 @@ declare const logs: {
         FETCH_RECORDS_REJECTED: string;
         INSERT_RECORDS_REJECTED: string;
         GET_BY_SKYFLOWID_REJECTED: string;
-        SEND_INVOKE_GATEWAY_REJECTED: string;
+        SEND_INVOKE_CONNECTION_REJECTED: string;
         FAILED_REVEAL: string;
         INVALID_TABLE_NAME: string;
         EMPTY_TABLE_NAME: string;
@@ -96,9 +114,9 @@ declare const logs: {
         INVALID_ELEMENT_TYPE: string;
         INVALID_ELEMENT_SELECTOR: string;
         CANNOT_CHANGE_ELEMENT: string;
-        MISSING_GATEWAY_URL: string;
-        INVALID_GATEWAY_URL_TYPE: string;
-        INVALID_GATEWAY_URL: string;
+        MISSING_CONNECTION_URL: string;
+        INVALID_CONNECTION_URL_TYPE: string;
+        INVALID_CONNECTION_URL: string;
         MISSING_METHODNAME_KEY: string;
         INVALID_METHODNAME_VALUE: string;
         INVALID_IFRAME: string;
@@ -113,6 +131,18 @@ declare const logs: {
         CONNECTION_ERROR: string;
         ERROR_OCCURED: string;
         RESPONSE_BODY_KEY_MISSING: string;
+        INVALID_VALIDATIONS_TYPE: string;
+        MISSING_VALIDATION_RULE_TYPE: string;
+        INVALID_VALIDATION_RULE_TYPE: string;
+        MISSING_VALIDATION_RULE_PARAMS: string;
+        INVALID_VALIDATION_RULE_PARAMS: string;
+        MISSING_REGEX_IN_REGEX_MATCH_RULE: string;
+        INVALID_REGEX_IN_REGEX_MATCH_RULE: string;
+        MISSING_MIN_AND_MAX_IN_LENGTH_MATCH_RULE: string;
+        MISSING_ELEMENT_IN_ELEMENT_MATCH_RULE: string;
+        INVALID_ELEMENT_IN_ELEMENT_MATCH_RULE: string;
+        ELEMENT_NOT_MOUNTED_IN_ELEMENT_MATCH_RULE: string;
+        VALIDATION_FAILED: string;
     };
 };
 export default logs;

package/types/utils/logsHelper/index.d.ts

@@ -35,4 +35,4 @@ export declare const EnvOptions: {
 };
 export declare const printLog: (message: string, messageType: MessageType, logLevel: LogLevel) => void;
 export declare const parameterizedString: (...args: any[]) => any;
-export declare const getElementName: (name: string) => string;
+export declare const getElementName: (name?: string) => string;

package/types/utils/validators/index.d.ts

@@ -1,10 +1,14 @@
+import { CardType } from '../../container/constants';
 import { IRevealElementInput } from '../../container/external/RevealContainer';
-import { IInsertRecordInput, IDetokenizeInput, IGetByIdInput, IGatewayConfig } from '../common';
+import { IInsertRecordInput, IDetokenizeInput, IGetByIdInput, IConnectionConfig } from '../common';
 export declare const validateCreditCardNumber: (cardNumber: string) => boolean;
+export declare const detectCardType: (cardNumber: string) => CardType.DEFAULT;
 export declare const validateExpiryDate: (date: string) => boolean;
 export declare const validateInsertRecords: (recordObj: IInsertRecordInput) => void;
 export declare const validateDetokenizeInput: (detokenizeInput: IDetokenizeInput) => void;
 export declare const validateGetByIdInput: (getByIdInput: IGetByIdInput) => void;
 export declare const validateRevealElementRecords: (records: IRevealElementInput[]) => void;
 export declare const isValidURL: (url: string) => boolean;
-export declare const validateGatewayConfig: (config: IGatewayConfig) => void;
+export declare const isValidRegExp: (input: any) => boolean;
+export declare const validateConnectionConfig: (config: IConnectionConfig) => void;
+export declare const validateCardNumberLengthCheck: (cardNumber: string) => boolean;

package/types/libs/strings.d.ts

@@ -1,4 +0,0 @@
-export declare const unMask: (value: string | undefined, maskObject: any) => string;
-export declare const splice: (string: string, index: number, removeCount: number, adder: string) => string;
-export declare const replaceAt: (str: string, index: number, replacer?: string) => string;
-export declare const mask: (value: string | undefined, prevValue: string | undefined, maskObject: any, focus: any) => string;