skyflow-js 1.33.0-beta.2 → 1.33.0

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

@@ -4,3 +4,5 @@
  * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
  * @license  MIT
  */
+
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.33.0-beta.2",
+  "version": "1.33.0",
   "author": "Skyflow",
   "description": "Skyflow JavaScript SDK",
   "homepage": "https://github.com/skyflowapi/skyflow-js",

package/types/core/constants.d.ts

@@ -11,6 +11,7 @@ export declare const PUREJS_TYPES: {
     GET_BY_SKYFLOWID: string;
     GET: string;
     DELETE: string;
+    FILE_RENDER: string;
 };
 export declare const ELEMENT_EVENTS_TO_CLIENT: {
     CHANGE: string;
@@ -50,6 +51,8 @@ export declare const ELEMENT_EVENTS_TO_IFRAME: {
     REVEAL_ELEMENT_UPDATE_OPTIONS: string;
     FILE_UPLOAD: string;
     COMPOSABLE_UPDATE_OPTIONS: string;
+    RENDER_FILE_RESPONSE_READY: string;
+    RENDER_FILE_REQUEST: string;
 };
 export declare const REVEAL_ELEMENT_OPTIONS_TYPES: {
     TOKEN: string;
@@ -61,6 +64,7 @@ export declare const ELEMENT_EVENTS_TO_CONTAINER: {
     COMPOSABLE_CONTAINER_MOUNTED: string;
     COLLECT_CONTAINER_MOUNTED: string;
     REVEAL_CONTAINER_MOUNTED: string;
+    RENDER_FILE_REQUEST: string;
 };
 export declare enum ElementType {
     CVV = "CVV",
@@ -321,6 +325,14 @@ export declare const REVEAL_ELEMENT_LABEL_DEFAULT_STYLES: {
         'margin-bottom': string;
     };
 };
+export declare const RENDER_FILE_ELEMENT_ALT_TEXT_DEFAULT_STYLES: {
+    [x: string]: {
+        'margin-bottom': string;
+        display: string;
+        flexDirection: string;
+        justifyContent: string;
+    };
+};
 export declare const REVEAL_ELEMENT_ERROR_TEXT_DEFAULT_STYLES: {
     [x: string]: {
         marginTop: string;
@@ -473,3 +485,5 @@ export declare const CARD_NUMBER_HYPEN_SEPERATOR = "-";
 export declare const DEFAULT_INPUT_FORMAT_TRANSLATION: {
     X: string;
 };
+export declare const DEFAULT_FILE_RENDER_ERROR = "File rendering failed. Please try again later.";
+export declare const FILE_DOWNLOAD_URL_PARAM = "downloadURL=true&contentDisposition=INLINE";

package/types/core/external/common/iframe.d.ts

@@ -4,6 +4,7 @@ export default class IFrame {
     iframe: HTMLIFrameElement;
     container?: Element;
     constructor(name: any, metadata: any, containerId: any, logLevel: any);
+    setAttributess: (responseValue: any) => void;
     mount: (domElement: any) => void;
     setIframeHeight: (height: any) => void;
     unmount: () => void;

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

@@ -3,6 +3,9 @@ import Container from '../common/container';
 import RevealElement from './reveal-element';
 export interface IRevealElementInput {
     token?: string;
+    skyflowID?: string;
+    table?: string;
+    column?: string;
     redaction?: RedactionType;
     inputStyles?: object;
     label?: string;

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

@@ -6,6 +6,7 @@ declare class RevealElement extends SkyflowElement {
     constructor(record: IRevealElementInput, options: IRevealElementOptions | undefined, metaData: any, container: any, elementId: string, context: Context);
     getID(): string;
     mount(domElementSelector: any): void;
+    renderFile(): Promise<unknown>;
     iframeName(): string;
     isMounted(): boolean;
     hasToken(): boolean;

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

@@ -3,9 +3,9 @@ declare class SkyflowContainer {
     #private;
     constructor(client: any, context: any);
     detokenize(detokenizeInput: IDetokenizeInput): Promise<any>;
-    insert(records: any, options: IInsertOptions): Promise<any>;
+    insert(records: any, options?: IInsertOptions): Promise<any>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
     get(getInput: IGetInput, options?: IGetOptions): Promise<unknown>;
-    delete(records: IDeleteRecordInput, options: IDeleteOptions): Promise<unknown>;
+    delete(records: IDeleteRecordInput, options?: IDeleteOptions): Promise<unknown>;
 }
 export default SkyflowContainer;

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

@@ -1,3 +1,7 @@
+/// <reference types="jquery" />
+/// <reference types="jquery" />
+/// <reference types="jquery-mask-plugin" />
+import 'jquery-mask-plugin/dist/jquery.mask.min';
 import { IFrameFormElement } from './iframe-form';
 import { LogLevel } from '../../utils/common';
 export declare class FrameController {
@@ -33,7 +37,7 @@ export declare class FrameElement {
     findPreviousElement: (currentInput: any) => HTMLInputElement;
     findNextElement: (currentInput: any) => HTMLInputElement;
     onSubmit: () => void;
-    onArrowKeys: (keyBoardEvent: KeyboardEvent) => void;
+    onArrowKeys: (event: JQuery.TriggeredEvent) => void;
     focusChange: (focus: boolean) => void;
     destroy: () => void;
     injectInputStyles(styles: any, preText?: string): void;

package/types/core/internal/reveal/reveal-frame.d.ts

@@ -1,3 +1,4 @@
+import 'jquery-mask-plugin/dist/jquery.mask.min';
 declare class RevealFrame {
     #private;
     static revealFrame: RevealFrame;

package/types/core/internal/skyflow-frame/skyflow-frame-controller.d.ts

@@ -1,7 +1,9 @@
+import { IRevealRecord } from '../../../utils/common';
 declare class SkyflowFrameController {
     #private;
     constructor(clientId: any);
     static init(clientId: any): SkyflowFrameController;
     insertData(records: any, options: any): Promise<unknown>;
+    renderFile(data: IRevealRecord): Promise<unknown>;
 }
 export default SkyflowFrameController;

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

@@ -1,7 +1,20 @@
 import Client from '../client';
-import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord, IGetOptions } from '../utils/common';
+import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord, IRenderResponseType, IGetOptions } from '../utils/common';
+export declare const getFileURLForRender: (skyflowIdRecord: IRevealRecord, client: Client, authToken: string) => Promise<any>;
+export declare const getFileURLFromVaultBySkyflowID: (skyflowIdRecord: IRevealRecord, client: Client) => Promise<IRenderResponseType>;
 export declare const fetchRecordsByTokenId: (tokenIdRecords: IRevealRecord[], client: Client) => Promise<IRevealResponseType>;
 export declare const formatRecordsForIframe: (response: IRevealResponseType) => Record<string, string>;
+export declare const formatRecordsForRender: (response: IRenderResponseType, column: any, skyflowID: any) => {
+    column: any;
+    skyflowID: any;
+    url: string;
+};
+export declare const formatForRenderClient: (response: IRenderResponseType, column: string) => IRenderResponseType | {
+    success: {
+        skyflow_id: any;
+        column: string;
+    };
+};
 export declare const formatRecordsForClient: (response: IRevealResponseType) => {
     success: {
         token: string;

package/types/skyflow.d.ts

@@ -19,11 +19,11 @@ declare class Skyflow {
     constructor(config: ISkyflow);
     static init(config: ISkyflow): Skyflow;
     container(type: ContainerType, options?: Record<string, any>): CollectContainer | RevealContainer | ComposableContainer;
-    insert(records: IInsertRecordInput, options: IInsertOptions): Promise<any>;
+    insert(records: IInsertRecordInput, options?: IInsertOptions): Promise<any>;
     detokenize(detokenizeInput: IDetokenizeInput): Promise<IRevealResponseType>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
     get(getInput: IGetInput, options?: IGetOptions): Promise<unknown>;
-    delete(records: IDeleteRecordInput, options: IDeleteOptions): Promise<unknown>;
+    delete(records: IDeleteRecordInput, options?: IDeleteOptions): Promise<unknown>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;

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

@@ -47,8 +47,11 @@ export interface IInsertRecord {
     skyflowID?: string;
 }
 export interface IRevealRecord {
-    token: string;
+    token?: string;
     redaction?: RedactionType;
+    column?: string;
+    skyflowID?: string;
+    table?: string;
 }
 export interface IInsertResponse {
     records: IInsertResponseReocrds[];
@@ -62,6 +65,10 @@ export interface IRevealResponseType {
     records?: Record<string, string>[];
     errors?: Record<string, any>[];
 }
+export interface IRenderResponseType {
+    fields?: Record<string, any>;
+    errors?: Record<string, any>;
+}
 export interface IDetokenizeInput {
     records: IRevealRecord[];
 }

package/types/utils/constants.d.ts

@@ -47,6 +47,10 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    MISSING_SKYFLOWID_KEY_REVEAL: {
+        code: number;
+        description: string;
+    };
     EMPTY_TABLE_IN_COLLECT: {
         code: number;
         description: string;
@@ -299,6 +303,10 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    INVALID_ALT_TEXT_RENDER: {
+        code: number;
+        description: string;
+    };
     INVALID_FORMAT_REVEAL: {
         code: number;
         description: string;
@@ -547,6 +555,42 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    SKYFLOW_IDS_AND_TOKEN_BOTH_SPECIFIED: {
+        code: number;
+        description: string;
+    };
+    MISSING_TABLE_KEY_REVEAL: {
+        code: number;
+        description: string;
+    };
+    MISSING_COLUMN_KEY_REVEAL: {
+        code: number;
+        description: string;
+    };
+    INVALID_SKYFLOW_ID_REVEAL: {
+        code: number;
+        description: string;
+    };
+    INVALID_TABLE_REVEAL: {
+        code: number;
+        description: string;
+    };
+    INVALID_COLUMN_NAME_REVEAL: {
+        code: number;
+        description: string;
+    };
+    EMPTY_SKYFLOW_ID_REVEAL: {
+        code: number;
+        description: string;
+    };
+    EMPTY_TABLE_REVEAL: {
+        code: number;
+        description: string;
+    };
+    EMPTY_COLUMN_NAME_REVEAL: {
+        code: number;
+        description: string;
+    };
     RECORDS_KEY_NOT_FOUND_GETBYID: {
         code: number;
         description: string;

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

@@ -19,8 +19,6 @@ export declare const appendMonthTwoDigitYears: (value: any) => {
     value: any;
 };
 export declare const getReturnValue: (value: string | Blob, element: string, doesReturnValue: boolean) => string | Blob | undefined;
-export declare function domReady(fn: any): void;
-export declare const getMaskedOutput: (input: string, format: string, translation: any) => string;
 export declare const copyToClipboard: (text: string) => void;
 export declare const handleCopyIconClick: (textToCopy: string, domCopy: any) => void;
 export declare const fileValidation: (value: any, required?: Boolean) => boolean;

package/types/utils/logs.d.ts

@@ -12,11 +12,14 @@ declare const logs: {
         VALIDATE_DELETE_INPUT: string;
         VALIDATE_COLLECT_RECORDS: string;
         VALIDATE_REVEAL_RECORDS: string;
+        VALIDATE_RENDER_RECORDS: string;
         CREATED_ELEMENT: string;
         ELEMENT_MOUNTED: string;
         ELEMENT_REVEALED: string;
+        FILE_RENDERED: string;
         COLLECT_SUBMIT_SUCCESS: string;
         REVEAL_SUBMIT_SUCCESS: string;
+        RENDER_SUBMIT_SUCCESS: string;
         INSERT_DATA_SUCCESS: string;
         DETOKENIZE_SUCCESS: string;
         GET_SUCCESS: string;
@@ -135,14 +138,25 @@ declare const logs: {
         INVALID_REDACTION_TYPE_IN_DETOKENIZE: string;
         EMPTY_RECORDS_REVEAL: string;
         MISSING_TOKEN_KEY_REVEAL: string;
+        MISSING_SKYFLOWID_KEY_REVEAL: string;
+        MISSING_TABLE_KEY_REVEAL: string;
+        MISSING_COLUMN_KEY_REVEAL: string;
+        INVALID_SKYFLOW_ID_REVEAL: string;
+        INVALID_TABLE_REVEAL: string;
+        INVALID_COLUMN_NAME_REVEAL: string;
+        EMPTY_SKYFLOW_ID_REVEAL: string;
+        EMPTY_TABLE_REVEAL: string;
+        EMPTY_COLUMN_NAME_REVEAL: string;
         INVALID_TOKEN_ID_REVEAL: string;
         INVALID_LABEL_REVEAL: string;
         INVALID_ALT_TEXT_REVEAL: string;
+        INVALID_ALT_TEXT_RENDER: string;
         INVALID_FORMAT_REVEAL: string;
         EMPTY_FORMAT_REVEAL: string;
         INVALID_FORMAT_VALUE_REVEAL: string;
         INVALID_REDACTION_TYPE_REVEAL: string;
         ELEMENTS_NOT_MOUNTED_REVEAL: string;
+        ELEMENT_NOT_MOUNTED_RENDER: string;
         EMPTY_TABLE_IN_ADDITIONAL_FIELDS: string;
         EMPTY_FIELDS_IN_ADDITIONAL_FIELDS: string;
         EMPTY_TOKEN_IN_DETOKENIZE: string;
@@ -154,6 +168,8 @@ declare const logs: {
         INSERT_RECORDS_REJECTED: string;
         GET_REJECTED: string;
         FAILED_REVEAL: string;
+        FAILED_RENDER: string;
+        SKYFLOW_IDS_AND_TOKEN_BOTH_SPECIFIED: string;
         MISSING_TABLE_IN_COLLECT: string;
         EMPTY_TABLE_IN_COLLECT: string;
         EMPTY_SKYFLOW_ID_IN_ADDITIONAL_FIELDS: string;

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

@@ -17,6 +17,7 @@ export declare const validateGetInput: (getInput: IGetInput, options?: IGetOptio
 export declare const validateGetByIdInput: (getByIdInput: IGetByIdInput) => void;
 export declare const validateDeleteRecords: (recordObj: IDeleteRecordInput, options: any) => void;
 export declare const validateRevealElementRecords: (records: IRevealElementInput[]) => void;
+export declare const validateRenderElementRecord: (record: IRevealElementInput) => void;
 export declare const isValidURL: (url: string) => boolean;
 export declare const isValidRegExp: (input: any) => boolean;
 export declare const validateCardNumberLengthCheck: (cardNumber?: string) => boolean;