@tap-payments/auth-jsconnect 2.12.6-development → 2.12.6-sandbox

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/file.d.ts

@@ -10,5 +10,6 @@ declare const fileService: {
     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, {}>>;
+    retrieveFileInfo: (fileId: string) => Promise<any>;
 };
 export { fileService };

package/build/api/file.js

@@ -29,9 +29,17 @@ var downloadFile = function (id, name, config) {
         return response;
     });
 };
+var retrieveFileInfo = function (fileId) {
+    return httpClient({
+        method: 'get',
+        url: "".concat(ENDPOINT_PATHS.FILES_PATH, "/content?fileId=").concat(fileId),
+        responseType: 'blob'
+    });
+};
 var fileService = {
     uploadFile: uploadFile,
     uploadFileInfo: uploadFileInfo,
-    downloadFile: downloadFile
+    downloadFile: downloadFile,
+    retrieveFileInfo: retrieveFileInfo
 };
 export { fileService };

package/build/api/index.d.ts

@@ -157,6 +157,7 @@ declare const API: {
         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, {}>>;
+        retrieveFileInfo: (fileId: string) => Promise<any>;
     };
     documentService: {
         updateDocumentInfo: (data: DocumentUpdateBody) => Promise<any>;

package/build/components/Tooltip/Tooltip.js

@@ -33,7 +33,7 @@ var StyledTooltip = styled(function (_a) {
     var _b;
     var theme = _a.theme;
     return (_b = {},
-        _b["& .".concat(tooltipClasses.tooltip)] = __assign(__assign({ color: alpha(theme.palette.text.primary, 0.5), width: 'fit-content', maxHeight: 'fit-content' }, theme.typography.body2), { fontWeight: theme.typography.fontWeightLight, backgroundColor: theme.palette.secondary.light, border: "1px solid ".concat(alpha(theme.palette.divider, 0.8)) }),
+        _b["& .".concat(tooltipClasses.tooltip)] = __assign(__assign({ color: alpha(theme.palette.text.primary, 0.5), width: 'fit-content', maxHeight: 'fit-content' }, theme.typography.body2), { fontWeight: theme.typography.fontWeightLight, backgroundColor: theme.palette.secondary.light, border: "1px solid ".concat(alpha(theme.palette.divider, 0.8)), zIndex: 2147483647 }),
         _b);
 });
 var TextStyled = styled(Text, { shouldForwardProp: function (prop) { return prop !== 'isAr'; } })(function (_a) {

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 API_BUSINESS_COUNTRIES = 'https://godata.sandbox.tap.company/api/v1/business/country/list';
 var API_COUNTRIES = 'https://utilities.tap.company/api/v1/country/list';

package/build/constants/app.d.ts

@@ -1,5 +1,6 @@
 import { ScreenStepNavigation, BusinessType, POSInfo, TerminalInfo } from '../@types';
 export declare const CONNECT_DEV_URL = "https://connect.dev.tap.company";
+export declare const CONNECT_SANDBOX_URL = "https://connect.sandbox.tap.company";
 export declare const CONNECT_PROD_URL = "https://connect.tap.company";
 export declare const CLIENT_ORIGIN: string;
 export declare const TAP_WEBSITE = "https://www.tap.company/";
@@ -130,6 +131,8 @@ export declare const AUTH_STEP_NAMES: {
 export declare const CONNECT_EXPRESS_STEP_NAMES: {
     CREATE_AUTH_MOBILE: string;
     VERIFY_AUTH_MOBILE: string;
+    CREATE_AUTH_EMAIL: string;
+    VERIFY_AUTH_EMAIL: string;
     CREATE_AUTH_CIVIL_ID: string;
     VERIFY_AUTH_CIVIL_ID: string;
     CREATE_AUTH_NID: string;

package/build/constants/app.js

@@ -1,6 +1,7 @@
 import { BusinessType } from '../@types';
 import { CONNECT_FLOWS } from './flows';
 export var CONNECT_DEV_URL = 'https://connect.dev.tap.company';
+export var CONNECT_SANDBOX_URL = 'https://connect.sandbox.tap.company';
 export var CONNECT_PROD_URL = 'https://connect.tap.company';
 export var CLIENT_ORIGIN = window.location.origin;
 export var TAP_WEBSITE = 'https://www.tap.company/';
@@ -151,9 +152,15 @@ export var CONNECT_EXPRESS_SCREENS_NAVIGATION = [
         prev: ['CONNECT_EXPRESS_NID_STEP', 'CONNECT_EXPRESS_CIVIL_ID_STEP'],
         order: 1
     },
+    {
+        name: 'CONNECT_EXPRESS_EMAIL_STEP',
+        next: 'CONNECT_EXPRESS_OTP_STEP',
+        prev: 'CONNECT_EXPRESS_BUSINESS_COUNTRY_STEP',
+        order: 1
+    },
     {
         name: 'CONNECT_EXPRESS_BUSINESS_COUNTRY_STEP',
-        next: ['CONNECT_EXPRESS_NID_STEP', 'CONNECT_EXPRESS_MOBILE_STEP'],
+        next: ['CONNECT_EXPRESS_NID_STEP', 'CONNECT_EXPRESS_MOBILE_STEP', 'CONNECT_EXPRESS_EMAIL_STEP'],
         prev: '',
         order: 1
     },
@@ -196,20 +203,19 @@ export var CONNECT_EXPRESS_SCREENS_NAVIGATION = [
             'CONNECT_EXPRESS_AUTHENTICATION_LIST_STEP',
             'CONNECT_EXPRESS_OTP_VERIFY_SECURITY_ERROR_STEP'
         ],
-        prev: 'CONNECT_EXPRESS_MOBILE_STEP',
-        order: 2,
-        back: 'CONNECT_EXPRESS_MOBILE_STEP'
+        prev: ['CONNECT_EXPRESS_MOBILE_STEP', 'CONNECT_EXPRESS_EMAIL_STEP'],
+        order: 2
     },
     {
         name: 'CONNECT_EXPRESS_AUTHENTICATION_LIST_STEP',
         next: ['CONNECT_EXPRESS_AUTH_MERCHANT_LIST_STEP', 'CONNECT_EXPRESS_AUTH_ACCOUNT_CREATED_STEP'],
-        prev: ['CONNECT_EXPRESS_MOBILE_STEP', 'CONNECT_EXPRESS_NID_STEP', 'CONNECT_EXPRESS_CIVIL_ID_STEP'],
+        prev: ['CONNECT_EXPRESS_MOBILE_STEP', 'CONNECT_EXPRESS_EMAIL_STEP', 'CONNECT_EXPRESS_NID_STEP', 'CONNECT_EXPRESS_CIVIL_ID_STEP'],
         order: 3
     },
     {
         name: 'CONNECT_EXPRESS_NID_MISSED_STEP',
         next: ['CONNECT_EXPRESS_IDENTITY_VERIFY_NAFATH_STEP', 'CONNECT_EXPRESS_COLLECT_INDIVIDUAL_INFO_STEP'],
-        prev: 'CONNECT_EXPRESS_MOBILE_STEP',
+        prev: ['CONNECT_EXPRESS_MOBILE_STEP', 'CONNECT_EXPRESS_EMAIL_STEP'],
         order: 3
     },
     {
@@ -270,6 +276,7 @@ export var CONNECT_EXPRESS_SCREENS_NAVIGATION = [
         ],
         prev: [
             'CONNECT_EXPRESS_MOBILE_STEP',
+            'CONNECT_EXPRESS_EMAIL_STEP',
             'CONNECT_EXPRESS_NID_STEP',
             'CONNECT_EXPRESS_CIVIL_ID_STEP',
             'CONNECT_EXPRESS_CIVIL_ID_MISSED_STEP',
@@ -1314,6 +1321,8 @@ export var AUTH_STEP_NAMES = {
 export var CONNECT_EXPRESS_STEP_NAMES = {
     CREATE_AUTH_MOBILE: 'connect_express_create_auth_mobile',
     VERIFY_AUTH_MOBILE: 'connect_express_verify_auth_mobile',
+    CREATE_AUTH_EMAIL: 'connect_express_create_auth_email',
+    VERIFY_AUTH_EMAIL: 'connect_express_verify_auth_email',
     CREATE_AUTH_CIVIL_ID: 'connect_express_create_auth_civil_id',
     VERIFY_AUTH_CIVIL_ID: 'connect_express_verify_auth_civil_id',
     CREATE_AUTH_NID: 'connect_express_create_auth_nid',

package/build/features/app/bank/bankStore.js

@@ -266,14 +266,16 @@ export var retrieveBoardStatus = createAsyncThunk('bank/retrieveBoardStatus', fu
         }
     });
 }); });
-export var retrieveBoardDetails = createAsyncThunk('bank/retrieveBoardDetails', function (_a) {
+export var retrieveBoardDetails = createAsyncThunk('bank/retrieveBoardDetails', function (_a, thunkApi) {
     var boardId = _a.boardId, id = _a.individualId, type = _a.individualType;
     return __awaiter(void 0, void 0, void 0, function () {
-        var data, individualData, boardData, serviceCallBack, _b, boardRes, individualRes;
+        var responseBody, data, individualData, boardData, serviceCallBack, _b, boardRes, individualRes;
         var _c, _d, _e;
         return __generator(this, function (_f) {
             switch (_f.label) {
-                case 0: return [4, API.boardService.retrieveBoardDetails(boardId)];
+                case 0:
+                    responseBody = thunkApi.getState().bank.data.verify.responseBody;
+                    return [4, API.boardService.retrieveBoardDetails(boardId)];
                 case 1:
                     data = _f.sent();
                     individualData = data === null || data === void 0 ? void 0 : data.user;
@@ -286,7 +288,7 @@ export var retrieveBoardDetails = createAsyncThunk('bank/retrieveBoardDetails',
                     individualData = individualRes;
                     boardData = boardRes;
                     _f.label = 3;
-                case 3: return [2, __assign(__assign({}, boardData), { brand: boardData === null || boardData === void 0 ? void 0 : boardData.brand, bank_account: boardData === null || boardData === void 0 ? void 0 : boardData.bank_account, entity: boardData === null || boardData === void 0 ? void 0 : boardData.entity, merchant: boardData === null || boardData === void 0 ? void 0 : boardData.merchant, name: (_d = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _d === void 0 ? void 0 : _d.names, business: boardData === null || boardData === void 0 ? void 0 : boardData.business, individuals: boardData === null || boardData === void 0 ? void 0 : boardData.individuals, contact: (_e = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _e === void 0 ? void 0 : _e.contact, user: individualData, board_status: boardData === null || boardData === void 0 ? void 0 : boardData.status })];
+                case 3: return [2, __assign(__assign({}, boardData), { brand: boardData === null || boardData === void 0 ? void 0 : boardData.brand, bank_account: __assign(__assign({}, responseBody === null || responseBody === void 0 ? void 0 : responseBody.bank_account), boardData === null || boardData === void 0 ? void 0 : boardData.bank_account), entity: boardData === null || boardData === void 0 ? void 0 : boardData.entity, merchant: boardData === null || boardData === void 0 ? void 0 : boardData.merchant, name: (_d = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _d === void 0 ? void 0 : _d.names, business: boardData === null || boardData === void 0 ? void 0 : boardData.business, individuals: boardData === null || boardData === void 0 ? void 0 : boardData.individuals, contact: (_e = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _e === void 0 ? void 0 : _e.contact, user: individualData, board_status: boardData === null || boardData === void 0 ? void 0 : boardData.status })];
             }
         });
     });

package/build/features/app/brand/brandStore.js

@@ -296,14 +296,16 @@ export var retrieveBoardStatus = createAsyncThunk('brand/retrieveBoardStatus', f
         }
     });
 }); });
-export var retrieveBoardDetails = createAsyncThunk('brand/retrieveBoardDetails', function (_a) {
+export var retrieveBoardDetails = createAsyncThunk('brand/retrieveBoardDetails', function (_a, thunkApi) {
     var boardId = _a.boardId, id = _a.individualId, type = _a.individualType;
     return __awaiter(void 0, void 0, void 0, function () {
-        var data, individualData, boardData, serviceCallBack, _b, boardRes, individualRes;
+        var responseBody, data, individualData, boardData, serviceCallBack, _b, boardRes, individualRes;
         var _c, _d, _e;
         return __generator(this, function (_f) {
             switch (_f.label) {
-                case 0: return [4, API.boardService.retrieveBoardDetails(boardId)];
+                case 0:
+                    responseBody = thunkApi.getState().brand.data.verify.responseBody;
+                    return [4, API.boardService.retrieveBoardDetails(boardId)];
                 case 1:
                     data = _f.sent();
                     individualData = data === null || data === void 0 ? void 0 : data.user;
@@ -316,7 +318,7 @@ export var retrieveBoardDetails = createAsyncThunk('brand/retrieveBoardDetails',
                     individualData = individualRes;
                     boardData = boardRes;
                     _f.label = 3;
-                case 3: return [2, __assign(__assign({}, boardData), { brand: boardData === null || boardData === void 0 ? void 0 : boardData.brand, bank_account: boardData === null || boardData === void 0 ? void 0 : boardData.bank_account, entity: boardData === null || boardData === void 0 ? void 0 : boardData.entity, merchant: boardData === null || boardData === void 0 ? void 0 : boardData.merchant, name: (_d = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _d === void 0 ? void 0 : _d.names, individuals: boardData === null || boardData === void 0 ? void 0 : boardData.individuals, contact: (_e = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _e === void 0 ? void 0 : _e.contact, user: individualData, board_status: boardData === null || boardData === void 0 ? void 0 : boardData.status })];
+                case 3: return [2, __assign(__assign({}, boardData), { brand: __assign(__assign({}, responseBody === null || responseBody === void 0 ? void 0 : responseBody.brand), boardData === null || boardData === void 0 ? void 0 : boardData.brand), bank_account: boardData === null || boardData === void 0 ? void 0 : boardData.bank_account, entity: boardData === null || boardData === void 0 ? void 0 : boardData.entity, merchant: boardData === null || boardData === void 0 ? void 0 : boardData.merchant, name: (_d = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _d === void 0 ? void 0 : _d.names, individuals: boardData === null || boardData === void 0 ? void 0 : boardData.individuals, contact: (_e = boardData === null || boardData === void 0 ? void 0 : boardData.user) === null || _e === void 0 ? void 0 : _e.contact, user: individualData, board_status: boardData === null || boardData === void 0 ? void 0 : boardData.status })];
             }
         });
     });

package/build/features/app/connectExpress/connectExpressStore.d.ts

@@ -1,5 +1,5 @@
 import { RootState } from '../../../app/store';
-import { MobileFormValues, NIDFormValues, CivilFormValues, OTPFormValues, IndividualFormValues, SharedState, FlowsTypes, ActionState, CountryCode, AuthForType, BusinessDataFormValues, AsyncThunkParams, AuthenticationListFormValues, AuthMerchantFormValues, DOBFormValues, MobileOwnershipFormValues, AuthForScreen } from '../../../@types';
+import { MobileFormValues, NIDFormValues, CivilFormValues, OTPFormValues, IndividualFormValues, SharedState, FlowsTypes, ActionState, CountryCode, AuthForType, BusinessDataFormValues, AsyncThunkParams, AuthenticationListFormValues, AuthMerchantFormValues, DOBFormValues, MobileOwnershipFormValues, AuthForScreen, AuthEmailFormValues } from '../../../@types';
 import { CancelToken } from 'axios';
 export declare const updateBusinessCountryAsync: import("@reduxjs/toolkit").AsyncThunk<any, string, {}>;
 export declare const retrieveLeadIdentityByIdAsync: import("@reduxjs/toolkit").AsyncThunk<{
@@ -37,6 +37,14 @@ export declare const resendMobileAuthOTP: import("@reduxjs/toolkit").AsyncThunk<
     response: any;
     formData: MobileFormValues;
 }, MobileFormValues, {}>;
+export declare const createEmailAuthAsync: import("@reduxjs/toolkit").AsyncThunk<{
+    response: any;
+    formData: AuthEmailFormValues;
+}, AuthEmailFormValues, {}>;
+export declare const resendEmailAuthOTP: import("@reduxjs/toolkit").AsyncThunk<{
+    response: any;
+    formData: AuthEmailFormValues;
+}, AuthEmailFormValues, {}>;
 export declare const createAuthSessionExpiredAsync: import("@reduxjs/toolkit").AsyncThunk<{
     data: any;
 }, boolean, {}>;
@@ -65,6 +73,7 @@ export declare const createCivilIdAuthAsync: import("@reduxjs/toolkit").AsyncThu
     formData: CivilFormValues;
 }, CivilFormValues, {}>;
 export declare const verifyMobileOtpAsync: import("@reduxjs/toolkit").AsyncThunk<any, OTPFormValues, {}>;
+export declare const verifyEmailOtpAsync: import("@reduxjs/toolkit").AsyncThunk<any, OTPFormValues, {}>;
 export declare const verifyPACIAsync: import("@reduxjs/toolkit").AsyncThunk<any, verifyPACIAsyncParams, {}>;
 export declare const createCivilIDAuthIdentityAsync: import("@reduxjs/toolkit").AsyncThunk<{
     response: any;
@@ -157,6 +166,7 @@ interface ResponseData {
 export interface ConnectExpressData {
     isLeadIdPassed: boolean;
     mobileData: MobileFormValues;
+    emailData: AuthEmailFormValues;
     nidData: NIDFormValues;
     civilIdData: CivilFormValues;
     otpData: OTPFormValues & {