skyflow-js 2.3.3 → 2.4.0

package/package.json

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

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

@@ -1,32 +1,12 @@
-import { IUpsertOptions } from '../../../core-utils/collect';
-import { IValidationRule, IInsertRecordInput } from '../../../utils/common';
-import { ElementType } from '../../constants';
+import { CollectElementInput, CollectElementOptions, CollectResponse, ICollectOptions, UploadFilesResponse } from '../../../utils/common';
 import Container from '../common/container';
 import CollectElement from './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 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<any>;
-    uploadFiles: (options: any) => Promise<any>;
+    create: (input: CollectElementInput, options?: CollectElementOptions) => CollectElement;
+    collect: (options?: ICollectOptions) => Promise<CollectResponse>;
+    uploadFiles: (options: ICollectOptions) => Promise<UploadFilesResponse>;
 }
 export default CollectContainer;

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

@@ -1,5 +1,5 @@
 import EventEmitter from '../../../event-emitter';
-import { Context } from '../../../utils/common';
+import { CollectElementUpdateOptions, Context } from '../../../utils/common';
 import SkyflowElement from '../common/skyflow-element';
 declare class CollectElement extends SkyflowElement {
     #private;
@@ -9,11 +9,11 @@ declare class CollectElement extends SkyflowElement {
     resizeObserver: ResizeObserver | null;
     constructor(elementId: string, elementGroup: any, metaData: any, container: any, isSingleElementAPI: boolean | undefined, destroyCallback: Function, updateCallback: Function, context: Context, groupEventEmitter?: EventEmitter);
     getID: () => string;
-    mount: (domElement: any) => void;
+    mount: (domElement: HTMLElement | string) => void;
     unmount: () => void;
     updateElementGroup: (group: any) => void;
     updateElement: (elementOptions: any) => void;
-    update: (options: any) => void;
+    update: (options: CollectElementUpdateOptions) => void;
     getState: () => {
         isEmpty: boolean;
         isComplete: boolean;
@@ -24,7 +24,7 @@ declare class CollectElement extends SkyflowElement {
         selectedCardScheme: string;
     };
     getOptions: () => any;
-    on(eventName: string, handler: any): void;
+    on(eventName: string, handler: Function): void;
     iframeName(): string;
     isMounted(): boolean;
     isUpdateCalled(): boolean;

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

@@ -1,34 +1,14 @@
-import { IUpsertOptions } from '../../../core-utils/collect';
-import { IValidationRule, IInsertRecordInput } from '../../../utils/common';
-import { ElementType } from '../../constants';
+import { CollectElementInput, CollectElementOptions, ICollectOptions, CollectResponse } from '../../../utils/common';
 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;
-    on: (eventName: string, handler: any) => void;
-    mount: (domElement: any) => void;
+    create: (input: CollectElementInput, options?: CollectElementOptions) => ComposableElement;
+    on: (eventName: string, handler: Function) => void;
+    mount: (domElement: HTMLElement | string) => void;
     unmount: () => void;
-    collect: (options?: ICollectOptions) => Promise<any>;
+    collect: (options?: ICollectOptions) => Promise<CollectResponse>;
 }
 export default ComposableContainer;

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

@@ -1,10 +1,11 @@
+import { CollectElementUpdateOptions } from '../../../utils/common';
 declare class ComposableElement {
     #private;
     type: string;
     constructor(name: any, eventEmitter: any, iframeName: any);
-    on(eventName: string, handler: any): void;
+    on(eventName: string, handler: Function): void;
     iframeName(): string;
     getID(): string;
-    update: (options: any) => void;
+    update: (options: CollectElementUpdateOptions) => void;
 }
 export default ComposableElement;

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

@@ -1,4 +1,4 @@
-import { RedactionType } from '../../../utils/common';
+import { RedactionType, RevealResponse } from '../../../utils/common';
 import Container from '../common/container';
 import RevealElement from './reveal-element';
 export interface IRevealElementInput {
@@ -23,6 +23,6 @@ declare class RevealContainer extends Container {
     type: string;
     constructor(metaData: any, skyflowElements: any, context: any, options?: {});
     create(record: IRevealElementInput, options?: IRevealElementOptions): RevealElement;
-    reveal(): Promise<unknown>;
+    reveal(): Promise<RevealResponse>;
 }
 export default RevealContainer;

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

@@ -1,12 +1,12 @@
-import { Context } from '../../../utils/common';
+import { Context, RenderFileResponse } from '../../../utils/common';
 import SkyflowElement from '../common/skyflow-element';
 import { IRevealElementInput, IRevealElementOptions } from './reveal-container';
 declare class RevealElement extends SkyflowElement {
     #private;
     constructor(record: IRevealElementInput, options: IRevealElementOptions | undefined, metaData: any, container: any, elementId: string, context: Context);
     getID(): string;
-    mount(domElementSelector: any): void;
-    renderFile(): Promise<unknown>;
+    mount(domElementSelector: HTMLElement | string): void;
+    renderFile(): Promise<RenderFileResponse>;
     iframeName(): string;
     isMounted(): boolean;
     hasToken(): boolean;
@@ -19,6 +19,6 @@ declare class RevealElement extends SkyflowElement {
     clearAltText(): void;
     setToken(token: string): void;
     unmount(): void;
-    update(options: any): void;
+    update(options: IRevealElementInput): void;
 }
 export default RevealElement;

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

@@ -1,12 +1,12 @@
-import { IDetokenizeInput, IGetInput, IGetByIdInput, IInsertOptions, IDeleteOptions, IDeleteRecordInput, IGetOptions } from '../../utils/common';
+import { IDetokenizeInput, IGetInput, IGetByIdInput, IInsertOptions, IDeleteOptions, IDeleteRecordInput, IGetOptions, InsertResponse, GetByIdResponse, GetResponse, DeleteResponse, IInsertRecordInput, DetokenizeResponse } from '../../utils/common';
 declare class SkyflowContainer {
     #private;
     isControllerFrameReady: boolean;
     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, options?: IGetOptions): Promise<unknown>;
-    delete(records: IDeleteRecordInput, options?: IDeleteOptions): Promise<unknown>;
+    detokenize(detokenizeInput: IDetokenizeInput): Promise<DetokenizeResponse>;
+    insert(records: IInsertRecordInput, options?: IInsertOptions): Promise<InsertResponse>;
+    getById(getByIdInput: IGetByIdInput): Promise<GetByIdResponse>;
+    get(getInput: IGetInput, options?: IGetOptions): Promise<GetResponse>;
+    delete(records: IDeleteRecordInput, options?: IDeleteOptions): Promise<DeleteResponse>;
 }
 export default SkyflowContainer;

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

@@ -1,5 +1,5 @@
 import Client from '../client';
-import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord, IRenderResponseType, IGetOptions } from '../utils/common';
+import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord, IRenderResponseType, IGetOptions, RenderFileResponse } 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>;
@@ -9,12 +9,7 @@ export declare const formatRecordsForRender: (response: IRenderResponseType, col
     skyflowID: any;
     url: string;
 };
-export declare const formatForRenderClient: (response: IRenderResponseType, column: string) => IRenderResponseType | {
-    success: {
-        skyflow_id: any;
-        column: string;
-    };
-};
+export declare const formatForRenderClient: (response: IRenderResponseType, column: string) => RenderFileResponse;
 export declare const formatRecordsForClient: (response: IRevealResponseType) => {
     success: {
         token: string;

package/types/index-node.d.ts

@@ -1,2 +1,14 @@
 import Skyflow from './skyflow';
+export { IInsertRecordInput as InsertRequest, IInsertRecord as InsertRecord, IInsertOptions as InsertOptions, InsertResponse, IDetokenizeInput as DetokenizeRequest, DetokenizeRecord, DetokenizeResponse, IDeleteRecordInput as DeleteRequest, IDeleteRecord as DeleteRecord, IDeleteOptions as DeleteOptions, DeleteResponse, IGetInput as GetRequest, IGetRecord as GetRecord, IGetOptions as GetOptions, GetResponse, IGetByIdInput as GetByIdRequest, GetByIdResponse, ContainerOptions, CollectElementInput, CollectElementUpdateOptions, CollectElementOptions, ICollectOptions as CollectOptions, CollectResponse, UploadFilesResponse, CardMetadata, InputStyles, LabelStyles, ErrorTextStyles, RedactionType, IRevealRecord as RevealRecord, RevealResponse, RenderFileResponse, IValidationRule as ValidationRule, ValidationRuleType, EventName, LogLevel, Env, ElementState, } from './utils/common';
+export { IRevealElementInput as RevealElementInput, IRevealElementOptions as RevealElementOptions, } from './core/external/reveal/reveal-container';
+export { ThreeDSBrowserDetails } from './core/external/threeds/threeds';
+export { CardType, ElementType, } from './core/constants';
+export { ContainerType, ISkyflow as SkyflowConfig, } from './skyflow';
+export { default as CollectElement } from './core/external/collect/collect-element';
+export { default as CollectContainer } from './core/external/collect/collect-container';
+export { default as ComposableContainer } from './core/external/collect/compose-collect-container';
+export { default as ComposableElement } from './core/external/collect/compose-collect-element';
+export { default as RevealContainer } from './core/external/reveal/reveal-container';
+export { default as RevealElement } from './core/external/reveal/reveal-element';
+export { default as ThreeDS } from './core/external/threeds/threeds';
 export default Skyflow;

package/types/skyflow.d.ts

@@ -2,7 +2,7 @@ import { ElementType, CardType } from './core/constants';
 import RevealContainer from './core/external/reveal/reveal-container';
 import CollectContainer from './core/external/collect/collect-container';
 import SkyflowError from './libs/skyflow-error';
-import { IRevealResponseType, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IGetByIdInput, IInsertOptions, IDeleteRecordInput, IDeleteOptions, IGetOptions } from './utils/common';
+import { RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IGetByIdInput, IInsertOptions, IDeleteRecordInput, IDeleteOptions, IGetOptions, InsertResponse, GetResponse, GetByIdResponse, DeleteResponse, ContainerOptions, DetokenizeResponse } from './utils/common';
 import ComposableContainer from './core/external/collect/compose-collect-container';
 import ThreeDS from './core/external/threeds/threeds';
 export declare enum ContainerType {
@@ -20,14 +20,14 @@ declare class Skyflow {
     #private;
     constructor(config: ISkyflow);
     static init(config: ISkyflow): Skyflow;
-    container(type: ContainerType.COLLECT, options?: Record<string, any>): CollectContainer;
-    container(type: ContainerType.COMPOSABLE, options?: Record<string, any>): ComposableContainer;
-    container(type: ContainerType.REVEAL, options?: Record<string, any>): RevealContainer;
-    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>;
+    container(type: ContainerType.COLLECT, options?: ContainerOptions): CollectContainer;
+    container(type: ContainerType.COMPOSABLE, options?: ContainerOptions): ComposableContainer;
+    container(type: ContainerType.REVEAL, options?: ContainerOptions): RevealContainer;
+    insert(records: IInsertRecordInput, options?: IInsertOptions): Promise<InsertResponse>;
+    detokenize(detokenizeInput: IDetokenizeInput): Promise<DetokenizeResponse>;
+    getById(getByIdInput: IGetByIdInput): Promise<GetByIdResponse>;
+    get(getInput: IGetInput, options?: IGetOptions): Promise<GetResponse>;
+    delete(records: IDeleteRecordInput, options?: IDeleteOptions): Promise<DeleteResponse>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;

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

@@ -1,3 +1,5 @@
+import { IUpsertOptions } from '../../core-utils/collect';
+import { CardType, ElementType } from '../../core/constants';
 declare global {
     interface Window {
         CoralogixRum: any;
@@ -121,7 +123,6 @@ export interface IDeleteRecord {
 export interface IDeleteOptions {
 }
 export interface IDeleteRecordInput {
-    options?: IDeleteOptions;
     records: IDeleteRecord[];
 }
 export interface IDeleteResponseType {
@@ -153,3 +154,143 @@ export interface MeticsObjectType {
 export interface SharedMeticsObjectType {
     records: MeticsObjectType[];
 }
+export interface InsertResponse {
+    records?: InsertResponseRecords[];
+    errors?: ErrorRecord[];
+}
+export interface CollectResponse extends InsertResponse {
+}
+export interface DetokenizeRecord extends IRevealRecord {
+}
+export interface DetokenizeResponse extends IRevealResponseType {
+}
+export interface InsertResponseRecords {
+    fields: Record<string, any>;
+    table: string;
+}
+export interface ErrorRecord {
+    code: number;
+    description: string;
+}
+export interface GetByIdResponse {
+    records?: GetByIdResponseRecord[];
+    errors?: ErrorRecord[];
+}
+export interface GetByIdResponseRecord {
+    fields: Record<string, any>;
+    table: string;
+}
+export interface GetResponse {
+    records?: GetResponseRecord[];
+    errors?: ErrorRecord[];
+}
+export interface GetResponseRecord {
+    fields: Record<string, any>;
+    table: string;
+}
+export interface DeleteResponse {
+    records?: DeleteResponseRecord[];
+    errors?: DeleteErrorRecords[];
+}
+export interface DeleteResponseRecord {
+    skyflow_id: string;
+    deleted: boolean;
+}
+export interface DeleteErrorRecords {
+    id: string;
+    error: ErrorRecord;
+}
+export interface ContainerOptions {
+    layout: number[];
+    styles?: InputStyles;
+    errorTextStyles?: ErrorTextStyles;
+}
+export interface ErrorTextStyles {
+    base?: Record<string, string>;
+    global?: Record<string, string>;
+}
+export interface LabelStyles extends ErrorTextStyles {
+    focus?: Record<string, string>;
+    requiredAsterisk?: Record<string, string>;
+}
+export interface InputStyles extends ErrorTextStyles {
+    focus?: Record<string, string>;
+    complete?: Record<string, string>;
+    empty?: Record<string, string>;
+    invalid?: Record<string, string>;
+    cardIcon?: Record<string, string>;
+    copyIcon?: Record<string, string>;
+}
+export interface CollectElementOptions {
+    required?: boolean;
+    format?: string;
+    translation?: Record<string, string>;
+    enableCardIcon?: boolean;
+    enableCopy?: boolean;
+    cardMetadata?: CardMetadata;
+    preserveFileName?: boolean;
+    allowedFileType?: string[];
+    blockEmptyFiles?: boolean;
+    masking?: boolean;
+    maskingChar?: string;
+}
+export interface CardMetadata {
+    scheme: CardType[];
+}
+export interface CollectElementUpdateOptions {
+    table?: string;
+    column?: string;
+    label?: string;
+    inputStyles?: InputStyles;
+    labelStyles?: LabelStyles;
+    errorTextStyles?: ErrorTextStyles;
+    placeholder?: string;
+    altText?: string;
+    validations?: IValidationRule[];
+    skyflowID?: string;
+}
+export interface CollectElementInput extends CollectElementUpdateOptions {
+    type: ElementType;
+}
+export interface ICollectOptions {
+    tokens?: boolean;
+    additionalFields?: IInsertRecordInput;
+    upsert?: Array<IUpsertOptions>;
+}
+export interface UploadFilesResponse {
+    fileUploadResponse: [{
+        skyflow_id: string;
+    }];
+    errorResponse: [{
+        error: ErrorRecord;
+    }];
+}
+export interface RevealResponse {
+    success?: {
+        token: string;
+        valueType: string;
+    };
+    errors?: {
+        error: ErrorRecord;
+        token: string;
+    };
+}
+export interface RenderFileResponse {
+    success?: {
+        skyflow_id: string;
+        column: string;
+    };
+    errors?: {
+        skyflowId: string;
+        error: ErrorRecord;
+        column: string;
+    };
+}
+export interface ElementState {
+    isEmpty: boolean;
+    isValid: boolean;
+    isFocused: boolean;
+    value: string | Object | Blob | undefined;
+    isRequired: boolean;
+    selectedCardScheme?: string;
+}

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

@@ -1,8 +1,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, IGetInput, IGetByIdInput, IDeleteRecordInput, IGetOptions } from '../common';
+import { IInsertRecordInput, IDetokenizeInput, IGetInput, IGetByIdInput, IDeleteRecordInput, IGetOptions, CollectElementInput } 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;