skyflow-js 1.23.0 → 1.24.0

package/dist/sdkNodeBuild/index.js.LICENSE.txt

@@ -4,3 +4,12 @@
  * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
  * @license  MIT
  */
+
+/**
+ * @license
+ * Lodash <https://lodash.com/>
+ * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+ * Released under MIT license <https://lodash.com/license>
+ * Based on Underscore.js 1.8.3 <http://underscorejs.org/LICENSE>
+ * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
+ */

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.23.0",
+  "version": "1.24.0",
   "author": "Skyflow",
   "description": "Skyflow JavaScript SDK",
   "homepage": "https://github.com/skyflowapi/skyflow-js",
@@ -67,13 +67,13 @@
     "@types/node": "^14.0.5",
     "@typescript-eslint/eslint-plugin": "^4.31.2",
     "@typescript-eslint/parser": "^4.31.2",
-    "babel-loader": "^8.1.0",
+    "babel-loader": "^9.1.2",
     "clean-webpack-plugin": "^4.0.0-alpha.0",
     "compression-webpack-plugin": "^8.0.1",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-airbnb-typescript": "^14.0.0",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-import": "^2.26.0",
     "fork-ts-checker-webpack-plugin": "^6.3.2",
     "html-webpack-plugin": "^5.5.0",
     "jest": "^27.2.1",

package/types/core/constants.d.ts

@@ -7,6 +7,7 @@ export declare const PUREJS_TYPES: {
     INSERT: string;
     DETOKENIZE: string;
     GET_BY_SKYFLOWID: string;
+    GET: string;
 };
 export declare const ELEMENT_EVENTS_TO_CLIENT: {
     CHANGE: string;
@@ -406,3 +407,26 @@ export declare enum ContentType {
     FORMURLENCODED = "application/x-www-form-urlencoded",
     FORMDATA = "multipart/form-data"
 }
+export declare const ALLOWED_FOCUS_AUTO_SHIFT_ELEMENT_TYPES: ElementType[];
+export declare const DEFAULT_ERROR_TEXT_ELEMENT_TYPES: {
+    CVV: string;
+    EXPIRATION_DATE: string;
+    CARD_NUMBER: string;
+    CARDHOLDER_NAME: string;
+    INPUT_FIELD: string;
+    PIN: string;
+    EXPIRATION_MONTH: string;
+    EXPIRATION_YEAR: string;
+    FILE_INPUT: string;
+};
+export declare const DEFAULT_REQUIRED_TEXT_ELEMENT_TYPES: {
+    CVV: string;
+    EXPIRATION_DATE: string;
+    CARD_NUMBER: string;
+    CARDHOLDER_NAME: string;
+    INPUT_FIELD: string;
+    PIN: string;
+    EXPIRATION_MONTH: string;
+    EXPIRATION_YEAR: string;
+    FILE_INPUT: string;
+};

package/types/core/external/collect/collect-container.d.ts

@@ -23,6 +23,7 @@ interface ICollectOptions {
 }
 declare class CollectContainer extends Container {
     #private;
+    type: string;
     constructor(options: any, metaData: any, skyflowElements: any, context: any);
     create: (input: CollectElementInput, options?: any) => CollectElement;
     collect: (options?: ICollectOptions) => Promise<unknown>;

package/types/core/external/collect/collect-element.d.ts

@@ -1,10 +1,12 @@
+import EventEmitter from '../../../event-emitter';
 import { Context } from '../../../utils/common';
 import SkyflowElement from '../common/skyflow-element';
 declare class CollectElement extends SkyflowElement {
     #private;
     elementType: string;
+    type: string;
     containerId: string;
-    constructor(elementId: string, elementGroup: any, metaData: any, containerId: string, isSingleElementAPI: boolean | undefined, destroyCallback: Function, updateCallback: Function, context: Context);
+    constructor(elementId: string, elementGroup: any, metaData: any, containerId: string, isSingleElementAPI: boolean | undefined, destroyCallback: Function, updateCallback: Function, context: Context, groupEventEmitter?: EventEmitter);
     getID: () => string;
     mount: (domElement: any) => void;
     unmount: () => void;

package/types/core/external/collect/compose-collect-container.d.ts

@@ -0,0 +1,32 @@
+import { IUpsertOptions } from '../../../core-utils/collect';
+import { IValidationRule, IInsertRecordInput } from '../../../utils/common';
+import { ElementType } from '../../constants';
+import Container from '../common/container';
+import ComposableElement from './compose-collect-element';
+export interface CollectElementInput {
+    table?: string;
+    column?: string;
+    inputStyles?: object;
+    label?: string;
+    labelStyles?: object;
+    errorTextStyles?: object;
+    placeholder?: string;
+    type: ElementType;
+    altText?: string;
+    validations?: IValidationRule[];
+    skyflowID?: string;
+}
+interface ICollectOptions {
+    tokens?: boolean;
+    additionalFields?: IInsertRecordInput;
+    upsert?: Array<IUpsertOptions>;
+}
+declare class ComposableContainer extends Container {
+    #private;
+    type: string;
+    constructor(options: any, metaData: any, skyflowElements: any, context: any);
+    create: (input: CollectElementInput, options?: any) => ComposableElement;
+    mount: (domElement: any) => void;
+    collect: (options?: ICollectOptions) => Promise<unknown>;
+}
+export default ComposableContainer;

package/types/core/external/collect/compose-collect-element.d.ts

@@ -0,0 +1,7 @@
+declare class ComposableElement {
+    #private;
+    type: string;
+    constructor(name: any, eventEmitter: any);
+    on(eventName: string, handler: any): void;
+}
+export default ComposableElement;

package/types/core/external/reveal/reveal-container.d.ts

@@ -15,6 +15,7 @@ export interface IRevealElementOptions {
 }
 declare class RevealContainer extends Container {
     #private;
+    type: string;
     constructor(metaData: any, skyflowElements: any, context: any);
     create(record: IRevealElementInput, options?: IRevealElementOptions): RevealElement;
     reveal(): Promise<unknown>;

package/types/core/external/skyflow-container.d.ts

@@ -1,9 +1,10 @@
-import { IDetokenizeInput, IGetByIdInput, IInsertOptions } from '../../utils/common';
+import { IDetokenizeInput, IGetInput, IGetByIdInput, IInsertOptions } from '../../utils/common';
 declare class SkyflowContainer {
     #private;
     constructor(client: any, context: any);
     detokenize(detokenizeInput: IDetokenizeInput): Promise<any>;
     insert(records: any, options: IInsertOptions): Promise<any>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
+    get(getInput: IGetInput): Promise<unknown>;
 }
 export default SkyflowContainer;

package/types/core/internal/iframe-form/index.d.ts

@@ -27,6 +27,7 @@ export declare class IFrameFormElement extends EventEmitter {
     clientErrorText: string | undefined;
     format: string;
     skyflowID?: string;
+    containerType: string;
     constructor(name: string, label: string, metaData: any, context: Context, skyflowID?: string);
     onFocusChange: (focus: boolean) => void;
     changeFocus: (focus: boolean) => void;

package/types/core-utils/reveal.d.ts

@@ -1,5 +1,5 @@
 import Client from '../client';
-import { ISkyflowIdRecord, IRevealRecord, IRevealResponseType } from '../utils/common';
+import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord } from '../utils/common';
 export declare const fetchRecordsByTokenId: (tokenIdRecords: IRevealRecord[], client: Client) => Promise<IRevealResponseType>;
 export declare const formatRecordsForIframe: (response: IRevealResponseType) => Record<string, string>;
 export declare const formatRecordsForClient: (response: IRevealResponseType) => {
@@ -16,4 +16,5 @@ export declare const formatRecordsForClient: (response: IRevealResponseType) =>
     errors: Record<string, any>[] | undefined;
     success?: undefined;
 };
+export declare const fetchRecordsGET: (skyflowIdRecords: IGetRecord[], client: Client) => Promise<unknown>;
 export declare const fetchRecordsBySkyflowID: (skyflowIdRecords: ISkyflowIdRecord[], client: Client) => Promise<unknown>;

package/types/skyflow.d.ts

@@ -1,10 +1,12 @@
 import { ElementType } from './core/constants';
 import RevealContainer from './core/external/reveal/reveal-container';
 import CollectContainer from './core/external/collect/collect-container';
-import { IRevealResponseType, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetByIdInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IInsertOptions } from './utils/common';
+import { IRevealResponseType, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IGetByIdInput, IInsertOptions } from './utils/common';
+import ComposableContainer from './core/external/collect/compose-collect-container';
 export declare enum ContainerType {
     COLLECT = "COLLECT",
-    REVEAL = "REVEAL"
+    REVEAL = "REVEAL",
+    COMPOSABLE = "COMPOSABLE"
 }
 export interface ISkyflow {
     vaultID?: string;
@@ -16,11 +18,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>): CollectContainer | RevealContainer | ComposableContainer;
     insert(records: IInsertRecordInput, options: IInsertOptions): Promise<any>;
     detokenize(detokenizeInput: IDetokenizeInput): Promise<IRevealResponseType>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
-    get(getByIdInput: IGetByIdInput): Promise<unknown>;
+    get(getInput: IGetInput): Promise<unknown>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;

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

@@ -55,13 +55,21 @@ export interface IRevealResponseType {
 export interface IDetokenizeInput {
     records: IRevealRecord[];
 }
-export interface ISkyflowIdRecord {
+export interface IGetRecord {
     ids?: string[];
     redaction: RedactionType;
     table: string;
     columnName?: string;
     columnValues?: string[];
 }
+export interface IGetInput {
+    records: IGetRecord[];
+}
+export interface ISkyflowIdRecord {
+    ids: string[];
+    redaction: RedactionType;
+    table: string;
+}
 export interface IGetByIdInput {
     records: ISkyflowIdRecord[];
 }

package/types/utils/constants.d.ts

@@ -443,5 +443,93 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    RECORDS_KEY_NOT_FOUND_GETBYID: {
+        code: number;
+        description: string;
+    };
+    INVALID_RECORDS_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    EMPTY_RECORDS_GETBYID: {
+        code: number;
+        description: string;
+    };
+    MISSING_IDS_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    INVALID_IDS_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    EMPTY_IDS_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    INVALID_SKYFLOWID_TYPE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    MISSING_TABLE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    INVALID_TABLE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    MISSING_REDACTION_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    INVALID_REDACTION_TYPE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    EMPTY_SKYFLOWID_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    EMPTY_TABLE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    EMPTY_REDACTION_TYPE_IN_GETBYID: {
+        code: number;
+        description: string;
+    };
+    MISSING_COMPOSABLE_LAYOUT_KEY: {
+        code: number;
+        description: string;
+    };
+    EMPTY_COMPOSABLE_LAYOUT_ARRAY: {
+        code: number;
+        description: string;
+    };
+    INVALID_COMPOSABLE_LAYOUT_TYPE: {
+        code: number;
+        description: string;
+    };
+    NEGATIVE_VALUES_COMPOSABLE_LAYOUT: {
+        code: number;
+        description: string;
+    };
+    MISMATCH_ELEMENT_COUNT_LAYOUT_SUM: {
+        code: number;
+        description: string;
+    };
+    MISSING_COMPOSABLE_CONTAINER_OPTIONS: {
+        code: number;
+        description: string;
+    };
+    INVALID_COMPOSABLE_CONTAINER_OPTIONS: {
+        code: number;
+        description: string;
+    };
+    COMPOSABLE_CONTAINER_NOT_MOUNTED: {
+        code: number;
+        description: string;
+    };
 };
 export default SKYFLOW_ERROR_CODE;

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

@@ -1,3 +1,4 @@
+import { ContainerType } from '../../skyflow';
 export declare const flattenObject: (obj: any, roots?: any, sep?: string) => any;
 export declare function formatFrameNameToId(name: string): string;
 export declare function removeSpaces(inputString: string): string;
@@ -9,3 +10,4 @@ export declare const copyToClipboard: (text: string) => void;
 export declare const handleCopyIconClick: (textToCopy: string, domCopy: any) => void;
 export declare const fileValidation: (value: any) => boolean;
 export declare const styleToString: (style: any) => string;
+export declare const getContainerType: (frameName: string) => ContainerType;

package/types/utils/logs.d.ts

@@ -29,6 +29,7 @@ declare const logs: {
         INSERT_TRIGGERED: string;
         DETOKENIZE_TRIGGERED: string;
         GET_TRIGGERED: string;
+        GET_BY_ID_TRIGGERED: string;
         EMIT_PURE_JS_REQUEST: string;
         CAPTURE_PURE_JS_REQUEST: string;
         LISTEN_PURE_JS_REQUEST: string;
@@ -36,6 +37,7 @@ declare const logs: {
         FETCH_RECORDS_RESOLVED: string;
         INSERT_RECORDS_RESOLVED: string;
         GET_RESOLVED: string;
+        GET_BY_SKYFLOWID_RESOLVED: string;
         EMIT_EVENT: string;
         CAPTURE_EVENT: string;
         LISTEN_COLLECT_FRAME_READY: string;
@@ -58,6 +60,7 @@ declare const logs: {
         IFRAMEFORM_CONSTRUCTOR_TOKENIZATION_LISTNER: string;
         CURRENT_ENV: string;
         CURRENT_LOG_LEVEL: string;
+        VALIDATE_GET_BY_ID_INPUT: string;
     };
     errorLogs: {
         CLIENT_CONNECTION: string;
@@ -186,6 +189,30 @@ declare const logs: {
         EMPTY_COLUMN_VALUE: string;
         MISSING_IDS_OR_COLUMN_VALUES_IN_GET: string;
         SKYFLOW_IDS_AND_COLUMN_NAME_BOTH_SPECIFIED: string;
+        GET_BY_SKYFLOWID_RESOLVED: string;
+        RECORDS_KEY_NOT_FOUND_GETBYID: string;
+        INVALID_RECORDS_IN_GETBYID: string;
+        EMPTY_RECORDS_GETBYID: string;
+        MISSING_IDS_IN_GETBYID: string;
+        INVALID_IDS_IN_GETBYID: string;
+        EMPTY_IDS_IN_GETBYID: string;
+        INVALID_SKYFLOWID_TYPE_IN_GETBYID: string;
+        MISSING_TABLE_IN_GETBYID: string;
+        INVALID_TABLE_IN_GETBYID: string;
+        MISSING_REDACTION_IN_GETBYID: string;
+        INVALID_REDACTION_TYPE_IN_GETBYID: string;
+        EMPTY_SKYFLOWID_IN_GETBYID: string;
+        EMPTY_TABLE_IN_GETBYID: string;
+        EMPTY_REDACTION_TYPE_IN_GETBYID: string;
+        GET_BY_SKYFLOWID_REJECTED: string;
+        MISSING_COMPOSABLE_LAYOUT_KEY: string;
+        EMPTY_COMPOSABLE_LAYOUT_ARRAY: string;
+        INVALID_COMPOSABLE_LAYOUT_TYPE: string;
+        NEGATIVE_VALUES_COMPOSABLE_LAYOUT: string;
+        MISMATCH_ELEMENT_COUNT_LAYOUT_SUM: string;
+        MISSING_COMPOSABLE_CONTAINER_OPTIONS: string;
+        INVALID_COMPOSABLE_CONTAINER_OPTIONS: string;
+        COMPOSABLE_CONTAINER_NOT_MOUNTED: string;
     };
     warnLogs: {
         INVALID_EXPIRATION_DATE_FORMAT: string;

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

@@ -2,7 +2,7 @@ import { CardType } from '../../core/constants';
 import { CollectElementInput } from '../../core/external/collect/collect-container';
 import { IRevealElementInput } from '../../core/external/reveal/reveal-container';
 import { ISkyflow } from '../../skyflow';
-import { IInsertRecordInput, IDetokenizeInput, IGetByIdInput } from '../common';
+import { IInsertRecordInput, IDetokenizeInput, IGetInput, IGetByIdInput } from '../common';
 export declare const validateCreditCardNumber: (cardNumber: string) => boolean;
 export declare const detectCardType: (cardNumber?: string) => CardType.DEFAULT;
 export declare const validateExpiryDate: (date: string, format: string) => boolean;
@@ -13,6 +13,7 @@ export declare const isValidExpiryYearFormat: (format: string) => boolean;
 export declare const validateInsertRecords: (recordObj: IInsertRecordInput, options: any) => void;
 export declare const validateAdditionalFieldsInCollect: (recordObj: IInsertRecordInput) => void;
 export declare const validateDetokenizeInput: (detokenizeInput: IDetokenizeInput) => void;
+export declare const validateGetInput: (getInput: IGetInput) => void;
 export declare const validateGetByIdInput: (getByIdInput: IGetByIdInput) => void;
 export declare const validateRevealElementRecords: (records: IRevealElementInput[]) => void;
 export declare const isValidURL: (url: string) => boolean;
@@ -21,3 +22,4 @@ export declare const validateCardNumberLengthCheck: (cardNumber?: string) => boo
 export declare const validateInitConfig: (initConfig: ISkyflow) => void;
 export declare const validateCollectElementInput: (input: CollectElementInput, logLevel: any) => void;
 export declare const validateUpsertOptions: (upsertOptions: any) => void;
+export declare const validateComposableContainerOptions: (options: any) => void;