skyflow-js 1.0.1 → 1.2.0

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

@@ -0,0 +1,27 @@
+/*!
+ * is-plain-object <https://github.com/jonschlinkert/is-plain-object>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * is-primitive <https://github.com/jonschlinkert/is-primitive>
+ *
+ * Copyright (c) 2014-present, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * isobject <https://github.com/jonschlinkert/isobject>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * set-value <https://github.com/jonschlinkert/set-value>
+ *
+ * Copyright (c) Jon Schlinkert (https://github.com/jonschlinkert).
+ * Released under the MIT License.
+ */

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.0.1",
+  "version": "1.2.0",
   "author": "Skyflow",
   "description": "Skyflow JavaScript SDK",
   "homepage": "https://github.com/skyflowapi/skyflow-js",
@@ -40,6 +40,7 @@
     "jss": "^10.7.1",
     "jss-preset-default": "^10.7.1",
     "jwt-decode": "^3.1.2",
+    "lodash": "^4.17.21",
     "set-value": "^4.0.1"
   },
   "engines": {
@@ -58,12 +59,18 @@
     "@types/jest": "^27.0.1",
     "@types/jquery-mask-plugin": "^1.14.3",
     "@types/node": "^14.0.5",
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.31.2",
     "babel-loader": "^8.1.0",
     "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.24.2",
     "fork-ts-checker-webpack-plugin": "^6.3.2",
     "html-webpack-plugin": "^5.3.2",
-    "jest": "^27.0.6",
+    "jest": "^27.2.1",
     "typescript": "^3.9.3",
     "webpack": "^5.51.1",
     "webpack-bundle-analyzer": "^4.4.2",

package/types/Skyflow.d.ts

@@ -1,6 +1,6 @@
-import CollectContainer from "./container/external/CollectContainer";
-import RevealContainer from "./container/external/RevealContainer";
-import { ElementType } from "./container/constants";
+import CollectContainer from './container/external/CollectContainer';
+import RevealContainer from './container/external/RevealContainer';
+import { ElementType } from './container/constants';
 export interface IInsertRecord {
     table: string;
     fields: Record<string, any>;
@@ -25,12 +25,39 @@ export declare enum RedactionType {
     REDACTED = "REDACTED"
 }
 export interface IRevealRecord {
-    id: string;
+    token: string;
     redaction: RedactionType;
 }
-export interface revealResponseType {
-    records: Record<string, string>[];
-    errors: Record<string, any>[];
+export interface IRevealResponseType {
+    records?: Record<string, string>[];
+    errors?: Record<string, any>[];
+}
+export interface IDetokenizeInput {
+    records: IRevealRecord[];
+}
+export interface ISkyflowIdRecord {
+    ids: string[];
+    redaction: RedactionType;
+    table: string;
+}
+export interface IGetByIdInput {
+    records: ISkyflowIdRecord[];
+}
+export declare enum RequestMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH",
+    DELETE = "DELETE"
+}
+export interface IGatewayConfig {
+    gatewayURL: string;
+    methodName: RequestMethod;
+    pathParams?: any;
+    queryParams?: any;
+    requestBody?: any;
+    requestHeader?: any;
+    responseBody?: any;
 }
 declare class Skyflow {
     #private;
@@ -38,9 +65,12 @@ declare class Skyflow {
     static init(config: ISkyflow): Skyflow;
     container(type: ContainerType, options?: Record<string, any>): CollectContainer | RevealContainer;
     insert(records: IInsertRecordInput, options?: Record<string, any>): Promise<any>;
-    get(records: IRevealRecord[], options?: any): Promise<revealResponseType>;
+    detokenize(detokenizeInput: IDetokenizeInput): Promise<IRevealResponseType>;
+    getById(getByIdInput: IGetByIdInput): Promise<unknown>;
+    invokeGateway(config: IGatewayConfig): Promise<unknown>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;
+    static get RequestMethod(): typeof RequestMethod;
 }
 export default Skyflow;

package/types/client/index.d.ts

@@ -1,14 +1,13 @@
-import { ISkyflow } from "../Skyflow";
+import { ISkyflow } from '../Skyflow';
 export interface IClientRequest {
     body?: Record<string, any>;
     headers?: Record<string, string>;
-    requestMethod: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "PATCH";
+    requestMethod: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'PATCH';
     url: string;
 }
 declare class Client {
     #private;
     config: ISkyflow;
-    accessToken: string;
     constructor(config: ISkyflow, metadata: any);
     toJSON(): {
         config: ISkyflow;

package/types/container/constants.d.ts

@@ -5,7 +5,9 @@ export declare const FRAME_REVEAL = "reveal";
 export declare const FRAME_ELEMENT = "element";
 export declare const PUREJS_TYPES: {
     INSERT: string;
-    GET: string;
+    DETOKENIZE: string;
+    GET_BY_SKYFLOWID: string;
+    INVOKE_GATEWAY: string;
 };
 export declare const ELEMENT_EVENTS_TO_CLIENT: {
     CHANGE: string;
@@ -33,6 +35,9 @@ export declare const ELEMENT_EVENTS_TO_IFRAME: {
     PUREJS_REQUEST: string;
     PUREJS_FRAME_READY: string;
     PUREJS_GET_ACCESS_TOKEN: string;
+    GET_BEARER_TOKEN: string;
+    GET_COLLECT_ELEMENT: string;
+    GET_REVEAL_ELEMENT: string;
 };
 export declare const ELEMENT_EVENTS_TO_CONTAINER: {
     ELEMENT_MOUNTED: string;
@@ -238,7 +243,7 @@ export declare const IFRAME_DEFAULT_STYLES: {
     position: string;
     top: number;
     left: number;
-    "user-select": string;
+    'user-select': string;
 };
 export declare const CONTROLLER_STYLES: {
     position: string;
@@ -247,7 +252,7 @@ export declare const CONTROLLER_STYLES: {
     height: number;
     visibility: string;
     left: string;
-    "user-select": string;
+    'user-select': string;
 };
 export declare const INPUT_STYLES: {
     width: string;
@@ -262,8 +267,8 @@ export declare const ERROR_TEXT_STYLES: {
     padding: string;
 };
 export declare const ALLOWED_ATTRIBUTES: {
-    "aria-invalid": string;
-    "aria-required": string;
+    'aria-invalid': string;
+    'aria-required': string;
     disabled: string;
     placeholder: string;
 };
@@ -278,13 +283,27 @@ export declare const STYLE_TYPE: {
     EMPTY: string;
     INVALID: string;
 };
-export declare const REVEAL_ELEMENT_DEFAULT_STYLES: {
+export declare const REVEAL_ELEMENT_DIV_STYLE: {
     container: {
         display: string;
         flexDirection: string;
         justifyContent: string;
     };
-    label: {
+};
+export declare const REVEAL_ELEMENT_LABEL_DEFAULT_STYLES: {
+    [x: string]: {
+        'margin-bottom': string;
+    };
+};
+export declare const REVEAL_ELEMENT_ERROR_TEXT_DEFAULT_STYLES: {
+    [x: string]: {
+        marginTop: string;
+    };
+};
+export declare const REVEAL_ELEMENT_ERROR_TEXT = "Invalid Token";
+export declare const COLLECT_ELEMENT_LABEL_DEFAULT_STYLES: {
+    [x: string]: {
         marginBottom: string;
     };
 };
+export declare const gatewayConfigParseKeys: string[];

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

@@ -1,17 +1,25 @@
-import { ElementType } from "../constants";
-import Element from "./element";
+import { IInsertRecordInput } from '../../Skyflow';
+import { ElementType } from '../constants';
+import Element from './element';
 interface CollectElementInput {
-    table: string;
-    column: string;
-    styles?: any;
+    table?: string;
+    column?: string;
+    inputStyles?: object;
     label?: string;
+    labelStyles?: object;
+    errorTextStyles?: object;
     placeholder?: string;
     type: ElementType;
+    altText?: string;
+}
+interface ICollectOptions {
+    tokens?: boolean;
+    additionalFields?: IInsertRecordInput;
 }
 declare class CollectContainer {
     #private;
     constructor(options: any, metaData: any);
     create: (input: CollectElementInput, options?: any) => Element;
-    collect: (options?: any) => Promise<unknown>;
+    collect: (options?: ICollectOptions) => Promise<unknown>;
 }
 export default CollectContainer;

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

@@ -1,8 +1,10 @@
-import { IRevealRecord } from "../../Skyflow";
+import { IGatewayConfig, IRevealRecord, ISkyflowIdRecord } from '../../Skyflow';
 declare class PureJsController {
     #private;
     constructor(client: any);
-    _get(records: IRevealRecord[]): Promise<any>;
-    _insert(records: any, options: any): Promise<any>;
+    detokenize(records: IRevealRecord[]): Promise<any>;
+    insert(records: any, options: any): Promise<any>;
+    getById(records: ISkyflowIdRecord[]): Promise<unknown>;
+    invokeGateway(config: IGatewayConfig): Promise<unknown>;
 }
 export default PureJsController;

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

@@ -1,16 +1,18 @@
-import { RedactionType } from "../../Skyflow";
-import RevealElement from "./reveal/RevealElement";
+import { RedactionType } from '../../Skyflow';
+import RevealElement from './reveal/RevealElement';
 export interface IRevealElementInput {
-    id: string;
-    styles?: object;
+    token?: string;
+    redaction?: RedactionType;
+    inputStyles?: object;
     label?: string;
-    redaction: RedactionType;
+    labelStyles?: object;
+    altText?: string;
+    errorTextStyles?: object;
 }
 declare class RevealContainer {
     #private;
     constructor(metaData: any);
     create(record: IRevealElementInput): RevealElement;
     reveal(): Promise<unknown>;
-    private validateRevealElementInput;
 }
 export default RevealContainer;

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

@@ -15,5 +15,8 @@ declare class Element {
     };
     getOptions: () => any;
     on(eventName: string, handler: any): void;
+    iframeName(): string;
+    isMounted(): boolean;
+    isValidElement(): boolean;
 }
 export default Element;

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

@@ -1,7 +1,10 @@
-import { IRevealElementInput } from "../RevealContainer";
+import { IRevealElementInput } from '../RevealContainer';
 declare class RevealElement {
     #private;
     constructor(record: IRevealElementInput, metaData: any, containerId: string);
     mount(domElementSelector: any): void;
+    iframeName(): string;
+    isMounted(): boolean;
+    hasToken(): boolean;
 }
 export default RevealElement;

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

@@ -1,18 +1,4 @@
-import EventEmitter from "../../../event-emitter";
-export declare class IFrameForm {
-    private iFrameFormElements;
-    private client?;
-    private clientMetaData?;
-    private callbacks;
-    private controllerId;
-    private clientDomain;
-    constructor(controllerId: string, clientDomain: string);
-    setClient(client: any): void;
-    setClientMetadata(clientMetaData: any): void;
-    private getOrCreateIFrameFormElement;
-    tokenize: (options: any) => Promise<unknown>;
-    private initializeFrame;
-}
+import EventEmitter from '../../../event-emitter';
 export declare class IFrameFormElement extends EventEmitter {
     state: {
         value: string | undefined;
@@ -54,3 +40,17 @@ export declare class IFrameFormElement extends EventEmitter {
     resetData(): void;
     destroy(): void;
 }
+export declare class IFrameForm {
+    private iFrameFormElements;
+    private client?;
+    private clientMetaData?;
+    private callbacks;
+    private controllerId;
+    private clientDomain;
+    constructor(controllerId: string, clientDomain: string);
+    setClient(client: any): void;
+    setClientMetadata(clientMetaData: any): void;
+    private getOrCreateIFrameFormElement;
+    tokenize: (options: any) => Promise<unknown>;
+    private initializeFrame;
+}

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

@@ -1,5 +1,5 @@
-import "jquery-mask-plugin/dist/jquery.mask.min";
-import { IFrameFormElement } from "./iFrameForm";
+import 'jquery-mask-plugin/dist/jquery.mask.min';
+import { IFrameFormElement } from './iFrameForm';
 export declare class FrameController {
     #private;
     controller?: FrameController;

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

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

package/types/container/internal/reveal/RevealFrameController.d.ts

@@ -1,4 +1,4 @@
-import { IRevealRecord } from "../../../Skyflow";
+import { IRevealRecord } from '../../../Skyflow';
 declare class RevealFrameController {
     #private;
     constructor(containerId: any);

package/types/core/collect.d.ts

@@ -1,4 +1,4 @@
-import { IInsertRecordInput, IInsertRecord } from "../Skyflow";
+import { IInsertRecordInput, IInsertRecord } from '../Skyflow';
 export declare const constructInsertRecordRequest: (records: IInsertRecordInput, options?: Record<string, any>) => any;
 export declare const constructInsertRecordResponse: (responseBody: any, tokens: boolean, records: IInsertRecord[]) => {
     records: any;

package/types/core/reveal.d.ts

@@ -1,10 +1,19 @@
-import Client from "../client";
-import { IRevealRecord, revealResponseType } from "../Skyflow";
-export declare const fetchRecordsByTokenId: (tokenIdRecords: IRevealRecord[], client: Client) => Promise<revealResponseType>;
-export declare const formatRecordsForIframe: (response: revealResponseType) => Record<string, string>;
-export declare const formatRecordsForClient: (response: revealResponseType) => {
+import Client from '../client';
+import { IRevealRecord, ISkyflowIdRecord, IRevealResponseType } from '../Skyflow';
+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) => {
     success: {
-        id: string;
+        token: string;
     }[];
     errors: Record<string, any>[];
+} | {
+    success: {
+        token: string;
+    }[];
+    errors?: undefined;
+} | {
+    errors: Record<string, any>[] | undefined;
+    success?: undefined;
 };
+export declare const fetchRecordsBySkyflowID: (skyflowIdRecords: ISkyflowIdRecord[], client: Client) => Promise<unknown>;

package/types/event-emitter/index.d.ts

@@ -1,5 +1,5 @@
 declare class EventEmitter {
-    _events: Record<string, {
+    events: Record<string, {
         priority: boolean;
         callback: Function;
     }[]>;

package/types/iframe-libs/iframer.d.ts

@@ -1,5 +1,3 @@
-declare const _default: (options?: {}) => HTMLIFrameElement;
-export default _default;
 export declare const iframeDefaultAttributes: {
     src: string;
     frameBorder: number;
@@ -7,6 +5,8 @@ export declare const iframeDefaultAttributes: {
     scrolling: string;
     style: string;
 };
-export declare const getIframeSrc: (uuid: any) => string;
 export declare const setAttributes: (element: any, attributes: any) => void;
+declare const _default: (options?: {}) => HTMLIFrameElement;
+export default _default;
+export declare const getIframeSrc: () => string;
 export declare const setStyles: (element: HTMLElement, styles: any) => void;

package/types/index-internal.d.ts

@@ -1,2 +1 @@
-import "core-js/stable";
-import "core-js/stable";
+import 'core-js/stable';

package/types/index-node.d.ts

@@ -1,2 +1,2 @@
-import Skyflow from "./Skyflow";
+import Skyflow from './Skyflow';
 export default Skyflow;

package/types/index.d.ts

@@ -1 +1 @@
-import "core-js/stable";
+import 'core-js/stable';

package/types/libs/Bus.d.ts

@@ -1,7 +1,7 @@
-import { FramebusOnHandler, FramebusReplyHandler } from "framebus/dist/lib/types";
+import { FramebusOnHandler, FramebusReplyHandler } from 'framebus/dist/lib/types';
 declare class Bus {
-    _listeners: any[];
-    _isDestroyed: boolean;
+    listeners: any[];
+    isDestroyed: boolean;
     constructor();
     on(eventName: string, callback: FramebusOnHandler): void;
     off(eventName: string, callback: FramebusOnHandler): void;

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

@@ -1,4 +1,4 @@
-export declare function validateAndSetupGroupOptions(oldGroup: any, newGroup?: any, setup?: boolean): any;
 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[];

package/types/libs/jss-styles.d.ts

@@ -1 +1 @@
-export declare function getCssClassesFromJss(styles: any, name: any): Record<string | number | symbol, string>;
+export default function getCssClassesFromJss(styles: any, name: any): Record<string | number | symbol, string>;

package/types/libs/objectParse.d.ts

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

package/types/libs/regex.d.ts

@@ -1 +1,2 @@
-export declare const regExFromString: (regExString: string) => RegExp;
+declare const regExFromString: (regExString: string) => RegExp;
+export default regExFromString;

package/types/libs/strings.d.ts

@@ -1,4 +1,4 @@
-export declare const mask: (value: string | undefined, prevValue: string | undefined, maskObject: any, focus: any) => string;
 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;

package/types/libs/styles.d.ts

@@ -1,8 +1,8 @@
 export declare function splitStyles(styles: any): {}[];
 export declare function buildStylesFromClassesAndStyles(classes: any, styles: any): void;
 export declare const getFlexGridStyles: (obj: any) => {
-    "align-items": any;
-    "justify-content": any;
+    'align-items': any;
+    'justify-content': any;
     height: string;
     width: string;
     margin: string;

package/types/properties.d.ts

@@ -1,4 +1,5 @@
-export declare const properties: {
+declare const properties: {
     IFRAME_SECURE_SITE: string;
     IFRAME_SECURE_ORGIN: string;
 };
+export default properties;

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

@@ -0,0 +1,3 @@
+export declare function getCollectElementValue(key: any, elementIframename: any): Promise<unknown>;
+export declare function getRevealElementValue(key: any, revealFrameName: any): Promise<unknown>;
+export declare function getAccessToken(): Promise<unknown>;

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

@@ -0,0 +1,5 @@
+export declare const flattenObject: (obj: any, roots?: any, sep?: string) => any;
+export declare function deletePropertyPath(obj: any, path: any): void;
+export declare function clearEmpties(o: any): void;
+export declare function formatFrameNameToId(name: string): string;
+export declare function fillUrlWithPathAndQueryParams(url: string, pathParams?: object, queryParams?: object): string;

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

@@ -1 +1,2 @@
-export declare const isTokenValid: (token: string) => boolean;
+declare const isTokenValid: (token: string) => boolean;
+export default isTokenValid;

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

@@ -1,5 +1,10 @@
-import { IInsertRecordInput, IRevealRecord } from "../../Skyflow";
+import { IRevealElementInput } from '../../container/external/RevealContainer';
+import { IGatewayConfig, IDetokenizeInput, IGetByIdInput, IInsertRecordInput } from '../../Skyflow';
 export declare const validateCreditCardNumber: (cardNumber: string) => boolean;
 export declare const validateExpiryDate: (date: string) => boolean;
 export declare const validateInsertRecords: (recordObj: IInsertRecordInput) => void;
-export declare const validateGetRecords: (records: IRevealRecord[]) => 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;

package/types/libs/NewBus.d.ts

@@ -1,13 +0,0 @@
-import { FramebusOnHandler, FramebusReplyHandler } from "framebus/dist/lib/types";
-declare class NewBus {
-    static _unlistnedEmitters: any[];
-    static _listeners: any[];
-    _isDestroyed: boolean;
-    constructor();
-    on(eventName: string, callback: FramebusOnHandler): void;
-    off(eventName: string, callback: FramebusOnHandler): void;
-    emit(eventName: string, data: Record<string, unknown> | undefined, callback?: FramebusReplyHandler | undefined): void;
-    hasListener(eventName: string): boolean;
-    hasUnListened(eventName: string): boolean;
-}
-export default NewBus;