@tap-payments/auth-jsconnect 2.12.3 → 2.12.4

package/README.md

@@ -20,12 +20,17 @@ yarn add @tap-payments/auth-jsconnect
 
 ## Features
 
-- [Connect](#Connect)
-- [Business](#Business)
-- [Password](#Password)
-- [Individual](#Individual)
-- [Bank](#Bank)
-- [Tax](#Tax)
+- [Connect](#Connect) - Create a new account with Tap Payments
+- [ConnectExpress](#ConnectExpress) - Simplified connect flow
+- [Business](#Business) - Business entity onboarding and verification
+- [Individual](#Individual) - Individual entity onboarding and verification
+- [Entity](#Entity) - Entity management and verification
+- [Password](#Password) - Password management and recovery
+- [Bank](#Bank) - Bank account management
+- [Tax](#Tax) - Tax information management
+- [Terminal](#Terminal) - Terminal kit for point-of-sale operations
+- [Auth](#Auth) - Authentication module
+- [KYC](#KYC) - Know Your Customer verification
 
 ## Examples
 
@@ -135,17 +140,48 @@ const App = () => {
 ```
 
 ## Connect
-- Help our merchants to create a account with Tap Payments
+- Help merchants create an account with Tap Payments
 
-## Business
+## ConnectExpress
+- Streamlined onboarding flow with simplified user experience
 
-## Password
+## Business
+- Business entity registration and verification
+- License number validation
+- Support for creating new sessions after expiry
 
 ## Individual
+- Individual entity registration and verification
+- Arabic name validation (English names only accepted)
+- Support for creating new sessions after expiry
+
+## Entity
+- Entity information management
+- Frontend-editable fields even when non-editable from backend
+- Entity verification workflows
+
+## Password
+- Password management and recovery
+- Session expiry handling with new session creation support
 
 ## Bank
+- Bank account information management and verification
 
 ## Tax
+- Tax identification and information management
+- Support for creating new sessions after expiry
+- UNN Collection logic improvements
+
+## Terminal
+- Point-of-sale terminal operations
+- Session expiry management with new session creation support
+- Hotfix for improved session handling
+
+## Auth
+- Core authentication module for the library
+
+## KYC
+- Know Your Customer verification processes
 
 ```
 
@@ -164,4 +200,18 @@ const App = () => {
 | onFlowCompleted `required` - `function`   | callback function will called after completing the flow                 |
 | onReady `required` - `function`           | callback function will call after loading library configuration         |
 | onStepError `required` - `function`       | callback function will call in case if any error happened in the screen |
-| onStepStarted `required` - `function`     | callback function will call in the begging of each step                 |
+| onStepCompleted `optional` - `function`   | callback function will call after completing each step                  |
+| onStepStarted `required` - `function`     | callback function will call in the beginning of each step               |
+
+## Branch Information
+
+This repository maintains multiple branches for different environments and stages:
+
+| Branch        | Purpose                        | Environment |
+| ------------- | ------------------------------ | ----------- |
+| `main`        | Production releases            | Production  |
+| `beta`        | Beta features and testing      | Beta        |
+| `sandbox`     | Sandbox environment testing    | Sandbox     |
+| `development` | Development features and fixes | Development |
+
+**Workflow**: `development` → `sandbox` → `beta` → `main` (production)

package/build/api/availabilityServices.d.ts

@@ -14,8 +14,8 @@ export declare type CheckIBanBody = {
     encryption_contract?: Array<string>;
 };
 declare const availabilityServices: {
-    checkEmail: (data: CheckEmailBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-    checkBrand: (data: CheckBrandBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-    checkIbanBank: (data: CheckIBanBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    checkEmail: (data: CheckEmailBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    checkBrand: (data: CheckBrandBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    checkIbanBank: (data: CheckIBanBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
 };
 export default availabilityServices;

package/build/api/document.d.ts

@@ -20,6 +20,6 @@ export interface DocumentBody {
 declare const documentService: {
     updateDocumentInfo: (data: DocumentUpdateBody) => Promise<any>;
     addFilesToExistingDocument: ({ id, ...data }: DocumentBody) => Promise<any>;
-    removeFilesFromDocument: ({ id, ...data }: DocumentBody) => Promise<import("axios").AxiosResponse<any, any>>;
+    removeFilesFromDocument: ({ id, ...data }: DocumentBody) => Promise<import("axios").AxiosResponse<any, any, {}>>;
 };
 export { documentService };

package/build/api/entity.d.ts

@@ -142,11 +142,11 @@ export declare type CreateEntityBody = {
     };
 };
 declare const entityService: {
-    createEntityInfo: ({ id, ...data }: EntityInfoBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    createEntityInfo: ({ id, ...data }: EntityInfoBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     updateEntityInfo: ({ id, ...data }: EntityInfoBody) => Promise<any>;
     createBankAccount: (data: EntityBankUpdateBody) => Promise<any>;
     retrieveBankAccount: (id: string) => Promise<any>;
-    retrieveEntityInfo: (entity_id: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    retrieveEntityInfo: (entity_id: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     updateIndividualInfo: ({ id, ...data }: EntityInfoBody) => Promise<any>;
     retrieveEntity: (entity_id: string) => Promise<any>;
     updateEntity: ({ id, ...data }: UpdateEntityBody) => Promise<any>;

package/build/api/file.d.ts

@@ -7,8 +7,8 @@ export declare type UploadFileBody = {
     type?: string;
 };
 declare const fileService: {
-    uploadFile: (data: UploadFileBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    uploadFile: (data: UploadFileBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     uploadFileInfo: (data: UploadFileBody, config?: AxiosRequestConfig) => Promise<any>;
-    downloadFile: (id: string, name: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    downloadFile: (id: string, name: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
 };
 export { fileService };

package/build/api/index.d.ts

@@ -47,26 +47,26 @@ declare const API: {
         generateConfigToken: (body: ConfigBody) => Promise<any>;
     };
     leadService: {
-        createLead: (data: CreateLeadBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        createLead: (data: CreateLeadBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         updateLead: ({ id, ...data }: UpdateLeadBody) => Promise<any>;
-        retrieveLead: (leadId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+        retrieveLead: (leadId: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         getLeadById: (leadId: string) => Promise<any>;
-        verifyLeadToken: (data: LeadVerifyBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        verifyLeadToken: (data: LeadVerifyBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         verifyToken: (data: LeadVerifyBody) => Promise<any>;
-        verifyLeadOTP: (data: LeadOTPVerifyBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        verifyLeadOTP: (data: LeadOTPVerifyBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         verifyTokenOTP: (data: LeadOTPVerifyBody) => Promise<any>;
-        retrieveEntityList: (leadId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+        retrieveEntityList: (leadId: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         retrieveLeadIdentity: (leadId: string) => Promise<any>;
         updateLeadExpress: ({ id, ...data }: UpdateLeadBody) => Promise<any>;
         verifyExpressLeadToken: (data: ExpressLeadVerifyBody) => Promise<any>;
         createVerifyTokenByBoardId: (data: import("./lead").CreateVerifyTokenBody) => Promise<any>;
     };
     entityService: {
-        createEntityInfo: ({ id, ...data }: EntityInfoBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        createEntityInfo: ({ id, ...data }: EntityInfoBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         updateEntityInfo: ({ id, ...data }: EntityInfoBody) => Promise<any>;
         createBankAccount: (data: EntityBankUpdateBody) => Promise<any>;
         retrieveBankAccount: (id: string) => Promise<any>;
-        retrieveEntityInfo: (entity_id: string, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        retrieveEntityInfo: (entity_id: string, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         updateIndividualInfo: ({ id, ...data }: EntityInfoBody) => Promise<any>;
         retrieveEntity: (entity_id: string) => Promise<any>;
         updateEntity: ({ id, ...data }: UpdateEntityBody) => Promise<any>;
@@ -82,9 +82,9 @@ declare const API: {
         createEntity: (data: CreateEntityBody) => Promise<any>;
     };
     availabilityServices: {
-        checkEmail: (data: CheckEmailBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
-        checkBrand: (data: CheckBrandBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
-        checkIbanBank: (data: import("./availabilityServices").CheckIBanBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        checkEmail: (data: CheckEmailBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        checkBrand: (data: CheckBrandBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        checkIbanBank: (data: import("./availabilityServices").CheckIBanBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     };
     firebaseService: {
         getLocale: (disableLocale?: boolean | undefined) => Promise<any>;
@@ -154,14 +154,14 @@ declare const API: {
         removeBrandActivity: ({ id, ...data }: RemoveBrandActivity) => Promise<any>;
     };
     fileService: {
-        uploadFile: (data: UploadFileBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        uploadFile: (data: UploadFileBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         uploadFileInfo: (data: UploadFileBody, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<any>;
-        downloadFile: (id: string, name: string, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any>>;
+        downloadFile: (id: string, name: string, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     };
     documentService: {
         updateDocumentInfo: (data: DocumentUpdateBody) => Promise<any>;
         addFilesToExistingDocument: ({ id, ...data }: DocumentBody) => Promise<any>;
-        removeFilesFromDocument: ({ id, ...data }: DocumentBody) => Promise<import("axios").AxiosResponse<any, any>>;
+        removeFilesFromDocument: ({ id, ...data }: DocumentBody) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     };
     initService: {
         getInitialData: (body: InitBody) => Promise<any>;

package/build/api/lead.d.ts

@@ -117,15 +117,15 @@ export declare type LeadIdentityUpdateBody = {
     encryption_contract: Array<string>;
 };
 declare const leadService: {
-    createLead: (data: CreateLeadBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    createLead: (data: CreateLeadBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     updateLead: ({ id, ...data }: UpdateLeadBody) => Promise<any>;
-    retrieveLead: (leadId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    retrieveLead: (leadId: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     getLeadById: (leadId: string) => Promise<any>;
-    verifyLeadToken: (data: LeadVerifyBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    verifyLeadToken: (data: LeadVerifyBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     verifyToken: (data: LeadVerifyBody) => Promise<any>;
-    verifyLeadOTP: (data: LeadOTPVerifyBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+    verifyLeadOTP: (data: LeadOTPVerifyBody, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     verifyTokenOTP: (data: LeadOTPVerifyBody) => Promise<any>;
-    retrieveEntityList: (leadId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    retrieveEntityList: (leadId: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
     retrieveLeadIdentity: (leadId: string) => Promise<any>;
     updateLeadExpress: ({ id, ...data }: UpdateLeadBody) => Promise<any>;
     verifyExpressLeadToken: (data: ExpressLeadVerifyBody) => Promise<any>;

package/build/constants/api.js

@@ -1,7 +1,7 @@
 var SANDBOX_BASE_URL = 'https://connect-mw.sandbox.tap.company/middleware';
 var PRODUCTION_BASE_URL = 'https://connect-mw.tap.company/middleware';
 var PRODUCTION_BASE_URL_SA = 'https://connect-mw.tap.com.sa/middleware';
-var PRODUCTION_BASE_URL_SA_DR = 'https://connect-mw.tap.com.sa/middleware';
+var PRODUCTION_BASE_URL_SA_DR = 'https://connect-mw-tmp.tap.com.sa/middleware';
 var DEV_BASE_URL = 'https://connect-mw.dev.tap.company/middleware';
 var BETA_BASE_URL = 'https://connect-mw.beta.tap.company/middleware';
 var API_BUSINESS_COUNTRIES = 'https://godata.sandbox.tap.company/api/v1/business/country/list';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tap-payments/auth-jsconnect",
-	"version": "2.12.3",
+	"version": "2.12.4",
 	"description": "connect library, auth",
 	"private": false,
 	"main": "build/index.js",