skyflow-js 1.6.0 → 1.7.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.6.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, IConnectionConfig, 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,7 +16,7 @@ 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>;
@@ -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

@@ -48,7 +48,8 @@ export declare enum ElementType {
     EXPIRATION_DATE = "EXPIRATION_DATE",
     CARD_NUMBER = "CARD_NUMBER",
     CARDHOLDER_NAME = "CARDHOLDER_NAME",
-    INPUT_FIELD = "INPUT_FIELD"
+    INPUT_FIELD = "INPUT_FIELD",
+    PIN = "PIN"
 }
 export declare const ELEMENTS: {
     text: {
@@ -236,10 +237,21 @@ export declare const ELEMENTS: {
     };
     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;
@@ -340,40 +352,50 @@ 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;

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/internal/iFrameForm/index.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from '../../../event-emitter';
-import { Context, LogLevel } 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;

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/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[];
 }
@@ -71,3 +76,7 @@ export interface IConnectionConfig {
     requestHeader?: any;
     responseBody?: any;
 }
+export interface IValidationRule {
+    type: ValidationRuleType;
+    params: any;
+}

package/types/utils/constants.d.ts

@@ -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

@@ -131,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

@@ -9,4 +9,6 @@ export declare const validateDetokenizeInput: (detokenizeInput: IDetokenizeInput
 export declare const validateGetByIdInput: (getByIdInput: IGetByIdInput) => void;
 export declare const validateRevealElementRecords: (records: IRevealElementInput[]) => void;
 export declare const isValidURL: (url: string) => boolean;
+export declare const isValidRegExp: (input: any) => boolean;
 export declare const validateConnectionConfig: (config: IConnectionConfig) => void;
+export declare const validateCardNumberLengthCheck: (cardNumber: string) => boolean;