@tap-payments/auth-jsconnect 1.0.86 → 1.0.89

package/README.md

@@ -0,0 +1,216 @@
+# Auth-JsConnect
+
+Handling user authentication and identification
+
+## Install
+
+This is a [React](https://reactjs.org/) module available through the
+[npm registry](https://www.npmjs.com/). Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```console
+npm install @tap-payments/auth-jsconnect
+```
+
+---------------------------- OR -------------------------
+
+```console
+yarn add @tap-payments/auth-jsconnect
+```
+
+## Features
+
+- [Connect](#Connect)
+- [Business](#Business)
+- [Password](#Password)
+- [Individual](#Individual)
+- [Bank](#Bank)
+- [Tax](#Tax)
+
+## Examples
+
+### ES6
+
+```js
+import { ConnectLib } from '@tap-payments/auth-jsconnect'
+
+const App = () => {
+	return (
+		<ConnectLib
+			open={true}
+			merchantDomain={'https://www.example.com'}
+			publicKey={'pk_test_xxxxxx'}
+			appInfo={{
+				identifier: 'tap_connect_demo',
+				name: 'Tap Connect Demo',
+				version: 'V2.0.0'
+			}}
+			businessCountryCode='SA'
+			language='en'
+			onError={(error) => {
+				alert(JSON.stringify({ error }))
+			}}
+			onFlowCompleted={(data) => {
+				console.log(data)
+			}}
+			onReady={() => {
+				console.log('ready!')
+			}}
+			onStepCompleted={(name, data) => {
+				console.log(name, data)
+			}}
+			onStepError={(name, error) => {
+				console.log(name, error)
+			}}
+			onStepStarted={(name) => {
+				console.log(name)
+			}}
+			scope={[]}
+		/>
+	)
+}
+```
+
+## ErrorObject
+
+- `statusCode`: the status code of the error. `required`
+- `message`: the error message. `required`
+- `description`: the error description. `optional`
+- `help`: the error url that can help the client to fix the api issue e.g
+  (<https://your-domain.example/integration/fixes/auth-api>) `optional`
+- `invalidParams`: the errors of request in case you need to validate the
+  request data. `optional`
+
+  - `message`: the error message. `required`
+  - `param`: the error parameter name e.g (email, password, name, etc). `optional`
+  - `location`: the location of parameter key. `required`
+
+- `errorKey`: the error key and the main purpose we can use it for localization part
+  and in this case we will have a generic errors we can catch any error message
+  by key `for example:` we can store local.en.json and local.en.json includes
+
+  ```json
+  { "bad_request": "invalid user request data" }
+  ```
+
+  and local.ar.json includes
+
+  ```json
+  { "bad_request": "بايانات غير صحيحة" }
+  ```
+
+  and the both files located in the
+  frontend so by using the response `errorKey` we can localize the error message
+  easily. `optional`
+
+## HttpError
+
+### Initializer
+
+it's a middleware should be used in the top of your app or at lest before your
+routes that include `HttpError`
+
+```js
+// in the beginning of your app (important)
+app.use(HttpError.initializer)
+// OR
+app.use((req, res, next) => {
+	HttpError.initializer(req, res, next)
+})
+```
+
+### Handler
+
+it's a middleware and it will handle all the errors returned by
+`HttpError` functions and it will send it back to the client but if the error
+not belong ot the lib it will pass it using next fun
+
+```js
+// in the end of your app (important)
+app.use(HttpError.handler)
+// OR
+app.use((err, req, res, next) => {
+	HttpError.handler(err, req, res, next)
+})
+```
+
+### customError
+
+it's a helper function can help you to create your custom error.
+
+### HttpError.{{ any function from the next list }}
+
+- they are helper functions allow you to send sepecific error to the client
+
+- `attrs` error object to customize your error response `optional`
+  - `message`: the error message. `required`
+  - `errorKey`: the error key. `optional`
+  - `help`: the error help location/url. `optional`
+  - `description`: the error description `optional`
+  - `invalidParams`: the request parameters errors `optional`
+
+| status code | function name                 |
+| ----------- | ----------------------------- |
+| 400         | BadRequest                    |
+| 401         | Unauthorized                  |
+| 402         | PaymentRequired               |
+| 403         | Forbidden                     |
+| 404         | NotFound                      |
+| 405         | MethodNotAllowed              |
+| 406         | NotAcceptable                 |
+| 407         | ProxyAuthenticationRequired   |
+| 408         | RequestTimeout                |
+| 409         | Conflict                      |
+| 410         | Gone                          |
+| 411         | LengthRequired                |
+| 412         | PreconditionFailed            |
+| 413         | PayloadTooLarge               |
+| 414         | URITooLong                    |
+| 415         | UnsupportedMediaType          |
+| 416         | RangeNotSatisfiable           |
+| 417         | ExpectationFailed             |
+| 418         | ImATeapot                     |
+| 421         | MisdirectedRequest            |
+| 422         | UnprocessableEntity           |
+| 423         | Locked                        |
+| 424         | FailedDependency              |
+| 425         | TooEarly                      |
+| 426         | UpgradeRequired               |
+| 428         | PreconditionRequired          |
+| 429         | TooManyRequests               |
+| 431         | RequestHeaderFieldsTooLarge   |
+| 451         | UnavailableForLegalReasons    |
+| 500         | InternalServerError           |
+| 501         | NotImplemented                |
+| 502         | BadGateway                    |
+| 503         | ServiceUnavailable            |
+| 504         | GatewayTimeout                |
+| 505         | HTTPVersionNotSupported       |
+| 506         | VariantAlsoNegotiates         |
+| 507         | InsufficientStorage           |
+| 508         | LoopDetected                  |
+| 509         | BandwidthLimitExceeded        |
+| 510         | NotExtended                   |
+| 511         | NetworkAuthenticationRequired |
+
+---
+
+## RequestValidator
+
+it's a middleware should be used after validating the request
+body/parameter/query using `express-validator` library
+
+```js
+import { body } from 'express-validator'
+import { RequestValidator } from 'http-error-handling'
+import express, { NextFunction, Request, Response } from 'express'
+let app = express()
+//sample API
+app.get('/validate', body('email').isEmail(), RequestValidator, (req: Request, res: Response, next: NextFunction) => {
+	return res.send(req.body)
+})
+```
+
+## License
+
+[MIT](LICENSE)

package/build/@types/app.d.ts

@@ -152,14 +152,16 @@ export interface DeviceInfo {
     entry: Entry;
 }
 export interface LocalProps {
-    en: {
-        translation: {
-            [key: string]: any;
+    [country: string]: {
+        ar: {
+            translation: {
+                [key: string]: string;
+            };
         };
-    };
-    ar: {
-        translation: {
-            [key: string]: any;
+        en: {
+            translation: {
+                [key: string]: string;
+            };
         };
     };
 }

package/build/app/settings.js

@@ -251,7 +251,7 @@ export var settingsSlice = createSlice({
             .addCase(getLocale.fulfilled, function (state, action) {
             state.loading = false;
             state.error = null;
-            updateLocale(action.payload);
+            updateLocale(action.payload, state.data.appConfig.businessCountryCode);
         })
             .addCase(getLocale.rejected, function (state, action) {
             state.loading = false;

package/build/components/AnimationFlow/BottomSheet.js

@@ -36,7 +36,9 @@ var BottomSheetStyled = styled(BottomSheet)(function (_a) {
             backgroundColor: 'transparent'
         },
         '[data-rsbs-header]': {
-            paddingBottom: theme.spacing(3)
+            paddingBottom: theme.spacing(6),
+            position: 'absolute',
+            width: '100vw'
         },
         '[data-rsbs-overlay]': {
             backgroundColor: theme.palette.background.paper

package/build/constants/api.js

@@ -22,7 +22,7 @@ var SIGNUP_PATH = '/signup';
 var SOURCE_INCOME_PATH = '/v2/sourceOfIncome';
 var MONTHLY_INCOME_PATH = '/v2/monthlyIncome';
 var BRAND_LIST_PATH = '/brand/list';
-var FIREBASE_URL = 'https://goconnect-195cd-default-rtdb.asia-southeast1.firebasedatabase.app/sandbox/local.json';
+var FIREBASE_URL = 'https://goconnect-195cd-default-rtdb.asia-southeast1.firebasedatabase.app/locale.json';
 export var ENDPOINT_PATHS = {
     BASE_URL: API_BASE_URL,
     BUSINESS_COUNTRIES: API_BUSINESS_COUNTRIES,

package/build/constants/app.d.ts

@@ -92,25 +92,22 @@ export declare const BUSINESS_STEP_NAMES: {
 };
 export declare const BANK_STEP_NAMES: {
     PHONE_AUTH: string;
-    IDENTITY_AUTH: string;
     BANK_INFO: string;
     BANK_SUCCESS: string;
 };
 export declare const TAX_STEP_NAMES: {
     PHONE_AUTH: string;
-    IDENTITY_AUTH: string;
     TAX_INFO: string;
     TAX_SUCCESS: string;
 };
 export declare const INDIVIDUAl_STEP_NAMES: {
     PHONE_AUTH: string;
-    IDENTITY_AUTH: string;
     INDIVIDUAl_INFO: string;
     INDIVIDUAl_SUCCESS: string;
 };
 export declare const PASSWORD_STEP_NAMES: {
+    PASSWORD_INFO: string;
     PHONE_AUTH: string;
-    IDENTITY_AUTH: string;
     PASSWORD_CREATE: string;
     PASSWORD_SUCCESS: string;
 };

package/build/constants/app.js

@@ -291,25 +291,22 @@ export var BUSINESS_STEP_NAMES = {
 };
 export var BANK_STEP_NAMES = {
     PHONE_AUTH: 'bank_phone_auth',
-    IDENTITY_AUTH: 'bank_identity_auth',
     BANK_INFO: 'bank_info',
     BANK_SUCCESS: 'bank_completed'
 };
 export var TAX_STEP_NAMES = {
     PHONE_AUTH: 'tax_phone_auth',
-    IDENTITY_AUTH: 'tax_identity_auth',
     TAX_INFO: 'tax_info',
     TAX_SUCCESS: 'tax_completed'
 };
 export var INDIVIDUAl_STEP_NAMES = {
     PHONE_AUTH: 'individual_phone_auth',
-    IDENTITY_AUTH: 'individual_identity_auth',
     INDIVIDUAl_INFO: 'individual_info',
     INDIVIDUAl_SUCCESS: 'individual_completed'
 };
 export var PASSWORD_STEP_NAMES = {
+    PASSWORD_INFO: 'password_info',
     PHONE_AUTH: 'password_phone_auth',
-    IDENTITY_AUTH: 'password_identity_auth',
     PASSWORD_CREATE: 'password_create',
     PASSWORD_SUCCESS: 'password_completed'
 };

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

@@ -48,13 +48,13 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 var _a;
 import { createAsyncThunk, createSlice } from '@reduxjs/toolkit';
 import API from '../../../api';
-import { removeRequestHeaders } from '../../../utils';
+import { hasKey, removeRequestHeaders } from '../../../utils';
 import { handleNextScreenStep } from '../../../app/settings';
 import { BANK_STEP_NAMES } from '../../../constants';
 export var verifyLeadToken = createAsyncThunk('verifyLeadToken', function (token, thunkApi) { return __awaiter(void 0, void 0, void 0, function () {
-    var payload, data, leadResponse;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
+    var payload, data, leadResponse, _a, steps, entity, hasCompleted;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
                 payload = {
                     service_name: 'tap_email',
@@ -62,22 +62,31 @@ export var verifyLeadToken = createAsyncThunk('verifyLeadToken', function (token
                 };
                 return [4, API.leadService.verifyLeadToken(payload)];
             case 1:
-                data = (_a.sent()).data;
+                data = (_b.sent()).data;
                 leadResponse = undefined;
-                if (!(!(data === null || data === void 0 ? void 0 : data.errors) && !(data === null || data === void 0 ? void 0 : data.mw_error))) return [3, 3];
+                if (!(!(data === null || data === void 0 ? void 0 : data.errors) && !(data === null || data === void 0 ? void 0 : data.mw_error))) return [3, 5];
                 return [4, API.leadService.retrieveLead(data === null || data === void 0 ? void 0 : data.id)];
             case 2:
-                leadResponse = _a.sent();
-                if (data.step_name === BANK_STEP_NAMES.IDENTITY_AUTH) {
-                    thunkApi.dispatch(handleNextScreenStep());
+                leadResponse = _b.sent();
+                _a = leadResponse.data, steps = _a.steps, entity = _a.entity;
+                hasCompleted = hasKey(steps, BANK_STEP_NAMES.BANK_SUCCESS);
+                if (!hasCompleted) return [3, 4];
+                return [4, thunkApi.dispatch(retrieveEntityInfo(entity === null || entity === void 0 ? void 0 : entity.id))];
+            case 3:
+                _b.sent();
+                thunkApi.dispatch(handleNextScreenStep('BANK_SUCCESS_FOUR_FLOWS_BUTTONS_STEP'));
+                return [3, 5];
+            case 4:
+                if (data.step_name === BANK_STEP_NAMES.BANK_INFO) {
+                    thunkApi.dispatch(handleNextScreenStep('BANK_BANK_DETAILS_STEP'));
                 }
-                _a.label = 3;
-            case 3: return [2, { data: data, leadData: leadResponse === null || leadResponse === void 0 ? void 0 : leadResponse.data, token: token }];
+                _b.label = 5;
+            case 5: return [2, { data: data, leadData: leadResponse === null || leadResponse === void 0 ? void 0 : leadResponse.data, token: token }];
         }
     });
 }); });
 export var verifyBankLeadOTP = createAsyncThunk('verifyBankLeadOTP', function (params, thunkApi) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, bank, settings, responseBody, payload, data, steps, hasBankCompleted;
+    var _a, bank, settings, responseBody, payload, data, steps, hasCompleted;
     var _b, _c, _d, _e;
     return __generator(this, function (_f) {
         switch (_f.label) {
@@ -97,8 +106,8 @@ export var verifyBankLeadOTP = createAsyncThunk('verifyBankLeadOTP', function (p
                 if (!!data.errors) return [3, 4];
                 (_d = (_c = settings.data.appConfig).onStepCompleted) === null || _d === void 0 ? void 0 : _d.call(_c, settings.data.activeScreen.name, { otp: params.otp });
                 steps = responseBody === null || responseBody === void 0 ? void 0 : responseBody.steps;
-                hasBankCompleted = Object.keys(steps).find(function (key) { return key === BANK_STEP_NAMES.BANK_SUCCESS; });
-                if (!hasBankCompleted) return [3, 3];
+                hasCompleted = hasKey(steps, BANK_STEP_NAMES.BANK_SUCCESS);
+                if (!hasCompleted) return [3, 3];
                 return [4, thunkApi.dispatch(retrieveEntityInfo((_e = responseBody === null || responseBody === void 0 ? void 0 : responseBody.entity) === null || _e === void 0 ? void 0 : _e.id))];
             case 2:
                 _f.sent();
@@ -175,9 +184,9 @@ export var checkIbanBank = createAsyncThunk('checkIbanBank', function (_a) {
 });
 export var updateLeadSuccess = createAsyncThunk('updateLeadBankSuccess', function (params, thunkApi) { return __awaiter(void 0, void 0, void 0, function () {
     var _a, settings, bank, id, payload, data;
-    var _b, _c, _d, _e, _f, _g;
-    return __generator(this, function (_h) {
-        switch (_h.label) {
+    var _b, _c, _d, _e, _f;
+    return __generator(this, function (_g) {
+        switch (_g.label) {
             case 0:
                 _a = thunkApi.getState(), settings = _a.settings, bank = _a.bank;
                 id = (bank.data.verify.responseBody || {}).id;
@@ -185,17 +194,17 @@ export var updateLeadSuccess = createAsyncThunk('updateLeadBankSuccess', functio
                     return [2];
                 payload = {
                     step_name: BANK_STEP_NAMES.BANK_SUCCESS,
-                    id: ((_b = bank.data.otpData.responseBody) === null || _b === void 0 ? void 0 : _b.id) || '',
+                    id: id,
                     encryption_contract: []
                 };
                 return [4, API.leadService.updateLead(payload)];
             case 1:
-                data = (_h.sent()).data;
-                return [4, thunkApi.dispatch(retrieveEntityInfo((_c = data.entity) === null || _c === void 0 ? void 0 : _c.id))];
+                data = (_g.sent()).data;
+                return [4, thunkApi.dispatch(retrieveEntityInfo((_b = data.entity) === null || _b === void 0 ? void 0 : _b.id))];
             case 2:
-                _h.sent();
-                (_e = (_d = settings.data.appConfig).onStepCompleted) === null || _e === void 0 ? void 0 : _e.call(_d, settings.data.activeScreen.name, params);
-                (_g = (_f = settings.data.appConfig).onFlowCompleted) === null || _g === void 0 ? void 0 : _g.call(_f, { data: data });
+                _g.sent();
+                (_d = (_c = settings.data.appConfig).onStepCompleted) === null || _d === void 0 ? void 0 : _d.call(_c, settings.data.activeScreen.name, params);
+                (_f = (_e = settings.data.appConfig).onFlowCompleted) === null || _f === void 0 ? void 0 : _f.call(_e, { data: data });
                 thunkApi.dispatch(handleNextScreenStep());
                 return [2, { response: data, formData: params }];
         }
@@ -249,7 +258,7 @@ export var bankSlice = createSlice({
                 state.error = description;
                 return;
             }
-            state.data.verify.responseBody = __assign(__assign({}, data), leadData);
+            state.data.verify.responseBody = __assign(__assign(__assign({}, data), leadData), state.data.verify.responseBody);
             state.data.verify.token = token;
         })
             .addCase(verifyLeadToken.rejected, function (state, action) {
@@ -307,7 +316,8 @@ export var bankSlice = createSlice({
                 state.error = description;
                 return;
             }
-            state.data.verify.responseBody = __assign(__assign({}, state.data.verify.responseBody), response);
+            var flows = response.flows, steps = response.steps;
+            state.data.verify.responseBody = __assign(__assign({}, state.data.verify.responseBody), { flows: flows, steps: steps });
             removeRequestHeaders();
         })
             .addCase(updateLeadSuccess.pending, function (state) {

package/build/features/app/business/businessStore.js

@@ -60,7 +60,7 @@ import moment from 'moment';
 import API from '../../../api';
 import { BusinessType } from '../../../@types';
 import { BUSINESS_STEP_NAMES, defaultCountry, IDENTIFICATION_TYPE, OTHER_CR_LICENSE, OTHER_FL_LICENSE } from '../../../constants';
-import { convertNumbers2English, getFlowUrl, removeRequestHeaders } from '../../../utils';
+import { convertNumbers2English, getFlowUrl, hasKey, removeRequestHeaders } from '../../../utils';
 import { handleNextScreenStep } from '../../../app/settings';
 export var getCountries = createAsyncThunk('getCountries', function (_, thunkApi) { return __awaiter(void 0, void 0, void 0, function () {
     var settings, countriesBody, businessCountry;
@@ -133,8 +133,8 @@ export var verifyLeadOTP = createAsyncThunk('verifyLeadOTP', function (params, t
             case 2:
                 _f.sent();
                 (_d = (_c = settings.data.appConfig).onStepCompleted) === null || _d === void 0 ? void 0 : _d.call(_c, settings.data.activeScreen.name, { otp: params.otp });
-                steps = (responseBody === null || responseBody === void 0 ? void 0 : responseBody.steps) || [];
-                hasBusinessCompleted = Object.keys(steps).find(function (key) { return key === BUSINESS_STEP_NAMES.BUSINESS_SUCCESS; });
+                steps = responseBody === null || responseBody === void 0 ? void 0 : responseBody.steps;
+                hasBusinessCompleted = hasKey(steps, BUSINESS_STEP_NAMES.BUSINESS_SUCCESS);
                 if (!isNID) return [3, 3];
                 thunkApi.dispatch(handleNextScreenStep());
                 return [3, 6];
@@ -294,7 +294,8 @@ export var updateActivitiesInfo = createAsyncThunk('updateActivitiesInfo', funct
                     activities: activities,
                     channel_services: channel,
                     business_operation_start_at: params.operationStartDate,
-                    step_name: stepName
+                    step_name: stepName,
+                    encryption_contract: ['business_operation_start_at']
                 };
                 return [4, API.entityService.createEntityInfo(requestBody)];
             case 1:
@@ -348,7 +349,8 @@ export var updateCustomersInfo = createAsyncThunk('updateCustomersInfo', functio
                     yearly_sales_range: ((_d = params.expectedSale) === null || _d === void 0 ? void 0 : _d.id) || '',
                     agree_refund: params.refundPolicy,
                     agree_chargeback: params.transactionPolicy,
-                    step_name: stepName
+                    step_name: stepName,
+                    encryption_contract: ['customers_base[0]', 'customers_served_monthly', 'yearly_sales_range']
                 };
                 return [4, API.entityService.updateEntityInfo(requestBody)];
             case 1:
@@ -541,10 +543,8 @@ export var businessSlice = createSlice({
             state.error = action.error.message;
         })
             .addCase(updateLeadIdentity.pending, function (state, action) {
-            var _a, _b;
-            if ((_a = action.meta.arg) === null || _a === void 0 ? void 0 : _a.isResend)
-                state.customLoading = true;
-            if (!((_b = action.meta.arg) === null || _b === void 0 ? void 0 : _b.isResend))
+            var _a;
+            if (!((_a = action.meta.arg) === null || _a === void 0 ? void 0 : _a.isResend))
                 state.loading = true;
             state.error = null;
         })

package/build/features/app/connect/connectStore.js

@@ -290,7 +290,14 @@ export var updateLeadBrand = createAsyncThunk('updateLeadBrand', function (param
                     id: (isExistingUser ? (_h = brandData.responseBody) === null || _h === void 0 ? void 0 : _h.lead_id : (_j = otpData.responseBody) === null || _j === void 0 ? void 0 : _j.lead_id) || '',
                     terms_conditions_accepted: params.termAndConditionChecked,
                     step_name: CONNECT_STEP_NAMES.UPDATE_LEAD_MERCHANT,
-                    encryption_contract: ['brand.name.en', 'brand.name.ar', 'brand.name.zh']
+                    encryption_contract: [
+                        'brand.name.en',
+                        'brand.name.ar',
+                        'brand.name.zh',
+                        'brand.website',
+                        'brand.social[0]',
+                        'brand.social[1]'
+                    ]
                 };
                 return [4, API.leadService.updateLead(payload)];
             case 1:

package/build/features/app/individual/individualStore.d.ts

@@ -12,7 +12,8 @@ export declare const verifyLeadToken: import("@reduxjs/toolkit").AsyncThunk<{
 export declare const retrieveDataList: import("@reduxjs/toolkit").AsyncThunk<{
     sourceIncome: any;
     monthlyIncome: any;
-}, void, {}>;
+    countryCode: string;
+}, string, {}>;
 export declare const retrieveEntityInfo: import("@reduxjs/toolkit").AsyncThunk<{
     data: any;
 }, string, {}>;