skyflow-js 2.6.0 → 2.7.0

package/package.json

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

package/types/client/index.d.ts

@@ -1,5 +1,6 @@
 import { ISkyflow } from '../skyflow';
 import { ClientMetadata } from '../core/internal/internal-types';
+import { ErrorMessages } from '../utils/common';
 export interface IClientRequest {
     body?: Document | XMLHttpRequestBodyInit | null;
     headers?: Record<string, string>;
@@ -17,7 +18,9 @@ export interface ClientToJSON {
 declare class Client {
     #private;
     config: ISkyflow;
+    errorMessagesList: Partial<ErrorMessages>;
     constructor(config: ISkyflow, metadata: ClientMetadata);
+    setErrorMessages(messages: ErrorMessages): void;
     toJSON(): ClientToJSON;
     static fromJSON(json: ClientToJSON): Client;
     request: (request: IClientRequest) => Promise<unknown>;

package/types/core/constants.d.ts

@@ -10,6 +10,7 @@ export declare const DOMAIN = "US2";
 export declare const CORALOGIX_DOMAIN = "https://cdn.rum-ingress-coralogix.com/coralogix/browser/latest/coralogix-browser-sdk.js";
 export declare const FRAME_ELEMENT = "element";
 export declare const COMPOSABLE_REVEAL = "reveal-composable";
+export declare const CUSTOM_ERROR_MESSAGES = "CUSTOM_ERROR_MESSAGES";
 export declare const ELEMENT_TYPES: {
     COLLECT: string;
     REVEAL: string;

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

@@ -1,4 +1,4 @@
-import { Context, CollectElementInput, CollectElementOptions, CollectResponse, ICollectOptions, UploadFilesResponse, ContainerOptions } from '../../../utils/common';
+import { Context, CollectElementInput, CollectElementOptions, CollectResponse, ICollectOptions, UploadFilesResponse, ContainerOptions, ErrorType } from '../../../utils/common';
 import { ElementType } from '../../constants';
 import Container from '../common/container';
 import CollectElement from './collect-element';
@@ -32,6 +32,7 @@ declare class CollectContainer extends Container {
     type: string;
     constructor(metaData: Metadata, skyflowElements: Array<SkyflowElementProps>, context: Context, options?: ContainerOptions);
     create: (input: CollectElementInput, options?: CollectElementOptions) => CollectElement;
+    setError(errors: Partial<Record<ErrorType, string>>): void;
     collect: (options?: ICollectOptions) => Promise<CollectResponse>;
     uploadFiles: (options?: ICollectOptions) => Promise<UploadFilesResponse>;
 }

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

@@ -1,4 +1,4 @@
-import { Context, CollectElementInput, CollectElementOptions, ICollectOptions, CollectResponse, InputStyles, ErrorTextStyles, ContainerOptions, UploadFilesResponse } from '../../../utils/common';
+import { Context, CollectElementInput, CollectElementOptions, ICollectOptions, CollectResponse, InputStyles, ErrorTextStyles, ContainerOptions, UploadFilesResponse, ErrorType } from '../../../utils/common';
 import Container from '../common/container';
 import ComposableElement from './compose-collect-element';
 import { ElementGroup } from './collect-container';
@@ -12,6 +12,7 @@ declare class ComposableContainer extends Container {
     type: string;
     constructor(metaData: Metadata, skyflowElements: Array<SkyflowElementProps>, context: Context, options: ContainerOptions);
     create: (input: CollectElementInput, options?: CollectElementOptions) => ComposableElement;
+    setError(errors: Partial<Record<ErrorType, string>>): void;
     on: (eventName: string, handler: Function) => void;
     mount: (domElement: HTMLElement | string) => void;
     unmount: () => void;

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

@@ -1,7 +1,7 @@
 import { Context } from '../../../utils/common';
 import Container from '../common/container';
 import ComposableRevealElement from './composable-reveal-element';
-import { ContainerOptions, RevealElementInput, RevealResponse } from '../../../index-node';
+import { ContainerOptions, ErrorType, RevealElementInput, RevealResponse } from '../../../index-node';
 import { IRevealElementOptions } from './reveal-container';
 import { Metadata, SkyflowElementProps } from '../../internal/internal-types';
 declare class ComposableRevealContainer extends Container {
@@ -9,6 +9,7 @@ declare class ComposableRevealContainer extends Container {
     type: string;
     constructor(metaData: Metadata, skyflowElements: Array<SkyflowElementProps>, context: Context, options?: ContainerOptions);
     create: (input: RevealElementInput, options?: IRevealElementOptions) => ComposableRevealElement;
+    setError(errors: Partial<Record<ErrorType, string>>): void;
     mount: (domElement: HTMLElement | string) => void;
     unmount: () => void;
     reveal(): Promise<RevealResponse>;

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

@@ -1,4 +1,4 @@
-import { ContainerOptions, Context, RedactionType, RevealResponse } from '../../../utils/common';
+import { ContainerOptions, Context, ErrorType, RedactionType, RevealResponse } from '../../../utils/common';
 import Container from '../common/container';
 import RevealElement from './reveal-element';
 import { Metadata, SkyflowElementProps } from '../../internal/internal-types';
@@ -24,6 +24,7 @@ declare class RevealContainer extends Container {
     type: string;
     constructor(metaData: Metadata, skyflowElements: Array<SkyflowElementProps>, context: Context, options?: ContainerOptions);
     create(record: IRevealElementInput, options?: IRevealElementOptions): RevealElement;
+    setError(errors: Partial<Record<ErrorType, string>>): void;
     reveal(): Promise<RevealResponse>;
 }
 export default RevealContainer;

package/types/core/internal/frame-element-init.d.ts

@@ -1,4 +1,4 @@
-import { Context } from '../../utils/common';
+import { Context, ErrorType } from '../../utils/common';
 import IFrameFormElement from './iframe-form';
 import FrameElement from '.';
 export default class FrameElementInit {
@@ -15,7 +15,7 @@ export default class FrameElementInit {
     constructor();
     private handleCollectCall;
     private parallelUploadFiles;
-    uploadFiles: (fileElement: any, clientConfig: any) => Promise<unknown>;
+    uploadFiles: (fileElement: any, clientConfig: any, errorMessages?: Record<ErrorType, string>) => Promise<unknown>;
     private tokenize;
     private multipleUploadFiles;
     private validateFiles;

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

@@ -3,7 +3,7 @@ import { IRevealRecord, IRevealResponseType, IGetRecord, ISkyflowIdRecord, IRend
 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 getFileURLFromVaultBySkyflowIDComposable: (skyflowIdRecord: IRevealRecord, client: Client, authToken: string) => Promise<IRenderResponseType>;
-export declare const fetchRecordsByTokenId: (tokenIdRecords: IRevealRecord[], client: Client) => Promise<IRevealResponseType>;
+export declare const fetchRecordsByTokenId: (tokenIdRecords: IRevealRecord[], client: Client, purejs: boolean) => Promise<IRevealResponseType>;
 export declare const fetchRecordsByTokenIdComposable: (tokenIdRecords: IRevealRecordComposable[], client: Client, authToken: string) => Promise<IRevealResponseType>;
 export declare const formatRecordsForIframe: (response: IRevealResponseType) => Record<string, string>;
 export declare const formatRecordsForRender: (response: IRenderResponseType, column: any, skyflowID: any) => {

package/types/index-node.d.ts

@@ -1,5 +1,5 @@
 import Skyflow from './skyflow';
-export { IInsertRecordInput as InsertRequest, IInsertRecord as InsertRecord, IInsertOptions as InsertOptions, IUpdateRequest as UpdateRequest, IUpdateOptions as UpdateOptions, UpdateResponse, 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 { IInsertRecordInput as InsertRequest, IInsertRecord as InsertRecord, IInsertOptions as InsertOptions, IUpdateRequest as UpdateRequest, IUpdateOptions as UpdateOptions, UpdateResponse, 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, ErrorType, ErrorMessages, } 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';

package/types/libs/skyflow-error.d.ts

@@ -1,6 +1,8 @@
+import { ErrorType } from '../utils/common';
 export interface ISkyflowError {
     code: string | number;
     description: string;
+    type?: ErrorType | string | undefined;
 }
 export default class SkyflowError extends Error {
     error?: ISkyflowError;

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 { RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IGetByIdInput, IInsertOptions, IDeleteRecordInput, IDeleteOptions, IGetOptions, InsertResponse, GetResponse, GetByIdResponse, DeleteResponse, ContainerOptions, DetokenizeResponse, IUpdateRequest, UpdateResponse, IUpdateOptions } from './utils/common';
+import { RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IGetByIdInput, IInsertOptions, IDeleteRecordInput, IDeleteOptions, IGetOptions, InsertResponse, GetResponse, GetByIdResponse, DeleteResponse, ContainerOptions, DetokenizeResponse, IUpdateRequest, UpdateResponse, IUpdateOptions, ErrorType } from './utils/common';
 import ComposableContainer from './core/external/collect/compose-collect-container';
 import ThreeDS from './core/external/threeds/threeds';
 import ComposableRevealContainer from './core/external/reveal/composable-reveal-container';
@@ -42,6 +42,7 @@ declare class Skyflow {
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;
+    static get ErrorType(): typeof ErrorType;
     static get RequestMethod(): typeof RequestMethod;
     static get LogLevel(): typeof LogLevel;
     static get EventName(): typeof EventName;

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

@@ -5,6 +5,24 @@ declare global {
         CoralogixRum: any;
     }
 }
+export declare enum ErrorType {
+    BAD_REQUEST = "400",
+    UNAUTHORIZED = "401",
+    FORBIDDEN = "403",
+    NOT_FOUND = "404",
+    TOO_MANY_REQUESTS = "429",
+    INTERNAL_SERVER_ERROR = "500",
+    BAD_GATEWAY = "502",
+    SERVICE_UNAVAILABLE = "503",
+    CONNECTION = "CONNECTION",
+    TIMEOUT = "TIMEOUT",
+    ABORT = "ABORT",
+    NETWORK_GENERIC = "NETWORK_GENERIC",
+    OFFLINE = "OFFLINE"
+}
+export type ErrorMessages = {
+    [key in ErrorType]: string;
+};
 export declare enum RedactionType {
     DEFAULT = "DEFAULT",
     PLAIN_TEXT = "PLAIN_TEXT",