skyflow-js 1.4.0 → 1.8.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.4.0",
+  "version": "1.8.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,14 +1,14 @@
 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"
 }
 export interface ISkyflow {
-    vaultID: string;
-    vaultURL: string;
+    vaultID?: string;
+    vaultURL?: string;
     getBearerToken: () => Promise<string>;
     options?: Record<string, any>;
 }
@@ -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;
@@ -38,6 +38,13 @@ export declare const ELEMENT_EVENTS_TO_IFRAME: {
     GET_BEARER_TOKEN: string;
     GET_COLLECT_ELEMENT: string;
     GET_REVEAL_ELEMENT: string;
+    COLLECT_ELEMENT_SET_ERROR: string;
+    REVEAL_ELEMENT_SET_ERROR: string;
+    REVEAL_ELEMENT_UPDATE_OPTIONS: string;
+};
+export declare const REVEAL_ELEMENT_OPTIONS_TYPES: {
+    TOKEN: string;
+    ALT_TEXT: string;
 };
 export declare const ELEMENT_EVENTS_TO_CONTAINER: {
     ELEMENT_MOUNTED: string;
@@ -47,8 +54,54 @@ 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 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_NUMBER_MASK: {
+    AMEX: (string | {
+        X: string;
+    })[];
+    VISA: (string | {
+        X: string;
+    })[];
+    MASTERCARD: (string | {
+        X: string;
+    })[];
+    DISCOVER: (string | {
+        X: string;
+    })[];
+    DINERS_CLUB: (string | {
+        X: string;
+    })[];
+    JCB: (string | {
+        X: string;
+    })[];
+    MAESTRO: (string | {
+        X: string;
+    })[];
+    UNIONPAY: (string | {
+        X: string;
+    })[];
+    HIPERCARD: (string | {
+        X: string;
+    })[];
+    DEFAULT: (string | {
+        X: string;
+    })[];
+};
 export declare const ELEMENTS: {
     text: {
         name: string;
@@ -214,6 +267,9 @@ export declare const ELEMENTS: {
             type: string;
         };
         sensitive: boolean;
+        mask: (string | {
+            X: string;
+        })[];
         regex: RegExp;
     };
     EXPIRATION_DATE: {
@@ -222,7 +278,6 @@ export declare const ELEMENTS: {
             type: string;
         };
         sensitive: boolean;
-        regex: RegExp;
     };
     CVV: {
         name: string;
@@ -233,6 +288,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;
@@ -267,6 +339,11 @@ export declare const INPUT_WITH_ICON_STYLES: {
     '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;
@@ -311,57 +388,55 @@ export declare const COLLECT_ELEMENT_LABEL_DEFAULT_STYLES: {
         marginBottom: string;
     };
 };
-export declare const gatewayConfigParseKeys: 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 connectionConfigParseKeys: string[];
 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;
@@ -374,3 +449,23 @@ export declare const CARD_ENCODED_ICONS: {
     UNIONPAY: string;
     VISA: string;
 };
+export declare const EXPIRY_DATE_MASK: {
+    'MM/YYYY': (string | {
+        X: string;
+        Y: string;
+    })[];
+    'MM/YY': (string | {
+        X: string;
+        Y: string;
+    })[];
+    'YYYY/MM': (string | {
+        X: string;
+        Y: string;
+    })[];
+    'YY/MM': (string | {
+        X: string;
+        Y: string;
+    })[];
+};
+export declare const DEFAULT_EXPIRATION_DATE_FORMAT = "MM/YY";
+export declare const ALLOWED_EXPIRY_DATE_FORMATS: 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/external/element/index.d.ts

@@ -19,5 +19,9 @@ declare class Element {
     iframeName(): string;
     isMounted(): boolean;
     isValidElement(): boolean;
+    setError(clientErrorText: string): void;
+    resetError(): void;
+    setValue(elementValue: string): void;
+    clearValue(): void;
 }
 export default Element;

package/types/container/external/reveal/RevealElement.d.ts

@@ -7,5 +7,13 @@ declare class RevealElement {
     iframeName(): string;
     isMounted(): boolean;
     hasToken(): boolean;
+    isClientSetError(): boolean;
+    getRecordData(): any;
+    setError(clientErrorText: string): void;
+    resetError(): void;
+    setAltText(altText: string): void;
+    clearAltText(): void;
+    setToken(token: string): void;
+    unmount(): void;
 }
 export default RevealElement;

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,22 @@ 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;
+    doesClientHasError: boolean;
+    clientErrorText: string | undefined;
+    expirationDateFormat: 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;
+    setExpirationDateFormat(format: string): void;
     setSensitive(sensitive?: boolean): void;
     setValue: (value?: string, valid?: boolean) => void;
     getValue: () => string | undefined;
@@ -37,6 +44,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 +58,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,14 @@
 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;
+    private CLASS_NAME;
+    constructor(controllerId: string, logLevel: LogLevel);
+    static init(uuid: string, logLevel: any): FrameController;
 }
 export declare class FrameElement {
     options: any;
@@ -33,4 +35,5 @@ export declare class FrameElement {
     }): void;
     setClass(types: string[], dom?: HTMLElement, preText?: string): void;
     updateOptions(options: any): void;
+    private applyMask;
 }

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/container/internal/reveal/RevealFrame.d.ts

@@ -3,5 +3,8 @@ declare class RevealFrame {
     static revealFrame: RevealFrame;
     static init(): void;
     constructor(record: any, context: any);
+    private setRevealError;
+    private updateRevealElementOptions;
+    private updateDataView;
 }
 export default RevealFrame;

package/types/core/collect.d.ts

@@ -1,4 +1,4 @@
-import { IInsertRecordInput, IInsertRecord } from '../utils/common';
+import { IInsertRecordInput, IInsertRecord, IValidationRule } from '../utils/common';
 export declare const constructInsertRecordRequest: (records: IInsertRecordInput, options?: Record<string, any>) => any;
 export declare const constructInsertRecordResponse: (responseBody: any, tokens: boolean, records: IInsertRecord[]) => {
     records: any;
@@ -6,3 +6,4 @@ export declare const constructInsertRecordResponse: (responseBody: any, tokens:
 export declare const constructElementsInsertReq: (req: any, options: any) => {
     records: IInsertRecord[];
 };
+export declare const checkForElementMatchRule: (validations: IValidationRule[]) => boolean;

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

@@ -1,4 +1,8 @@
+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;
+export declare const formatOptions: (elementType: any, options: any, logLevel: any) => any;

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/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;
+}