Farzin/70772/Refactor cashier locked component

packages/cashier/src/components/cashier-locked/cashier-locked-provider.tsx

@@ -0,0 +1,366 @@
+import React from 'react';
+import { Localize, localize } from '@deriv/translations';
+import { formatDate } from '@deriv/shared';
+import { TEmptyStateProps } from 'Components/empty-state/empty-state';
+
+type TProps = {
+    cashier_validation: string[] | undefined;
+    is_crypto: boolean;
+    is_system_maintenance: boolean;
+    is_cashier_locked: boolean;
+    is_deposit_locked: boolean;
+    is_withdrawal_locked: boolean;
+    is_identity_verification_needed: boolean;
+    excluded_until: number | undefined;
+};
+
+const getMessage = ({
+    cashier_validation,
+    is_crypto,
+    is_system_maintenance,
+    is_cashier_locked,
+    is_deposit_locked,
+    is_withdrawal_locked,
+    is_identity_verification_needed,
+    excluded_until,
+}: TProps): TEmptyStateProps => {
+    const no_residence = cashier_validation?.includes('no_residence');
+    const unwelcome_status = cashier_validation?.includes('unwelcome_status');
+    const self_exclusion = cashier_validation?.includes('SelfExclusion');
+    const no_withdrawal_or_trading_status = cashier_validation?.includes('no_withdrawal_or_trading_status');
+    const only_pa_withdrawals_allowed_status = cashier_validation?.includes('only_pa_withdrawals_allowed_status');
+    const withdraw_service_unavailable_for_pa = cashier_validation?.includes('WithdrawServiceUnavailableForPA');
+    const withdrawal_locked_status = cashier_validation?.includes('withdrawal_locked_status');
+    const documents_expired = cashier_validation?.includes('documents_expired');
+    const cashier_locked_status = cashier_validation?.includes('cashier_locked_status');
+    const disabled_status = cashier_validation?.includes('disabled_status');
+    const financial_assessment_required = cashier_validation?.includes('FinancialAssessmentRequired');
+    const ask_currency = cashier_validation?.includes('ASK_CURRENCY');
+    const ask_authenticate = cashier_validation?.includes('ASK_AUTHENTICATE');
+    const ask_financial_risk_approval = cashier_validation?.includes('ASK_FINANCIAL_RISK_APPROVAL');
+    const ask_tin_information = cashier_validation?.includes('ASK_TIN_INFORMATION');
+    const ask_self_exclusion_max_turnover_set = cashier_validation?.includes('ASK_SELF_EXCLUSION_MAX_TURNOVER_SET');
+    const ask_fix_details = cashier_validation?.includes('ASK_FIX_DETAILS');
+    const ask_uk_funds_protection = cashier_validation?.includes('ASK_UK_FUNDS_PROTECTION');
+
+    if (is_system_maintenance) {
+        if (is_crypto && is_withdrawal_locked)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Withdrawals are locked'),
+                description: localize(
+                    'Withdrawals are temporarily unavailable due to system maintenance. You can make your withdrawals when the maintenance is complete.'
+                ),
+            };
+        if (is_crypto && is_deposit_locked)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'Deposits are temporarily unavailable due to system maintenance. You can make your deposits when the maintenance is complete.'
+                ),
+            };
+        if (is_crypto)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'Our cryptocurrency cashier is temporarily down due to system maintenance. You can access the Cashier in a few minutes when the maintenance is complete.'
+                ),
+            };
+        return {
+            icon: 'IcCashierLocked',
+            title: localize('Cashier is locked'),
+            description: localize(
+                'Our cashier is temporarily down due to system maintenance. You can access the Cashier in a few minutes when the maintenance is complete.'
+            ),
+        };
+    }
+
+    if (is_cashier_locked) {
+        if (no_residence)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'You’ve not set your country of residence. To access Cashier, please update your country of residence in the Personal details section in your account settings.'
+                ),
+            };
+        if (documents_expired)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'The identification documents you submitted have expired. Please submit valid identity documents to unlock Cashier. '
+                ),
+            };
+        if (cashier_locked_status)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'Your cashier is currently locked. Please contact us via live chat to find out how to unlock it.'
+                ),
+            };
+        if (disabled_status)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize(
+                    'Your account is temporarily disabled. Please contact us via live chat to enable deposits and withdrawals again.'
+                ),
+            };
+        if (ask_currency)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: localize('Please set your account currency to enable deposits and withdrawals.'),
+            };
+        if (ask_authenticate && is_identity_verification_needed)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Please submit your <0>proof of identity</0> to authenticate your account and access your Cashier.'
+                        components={[<a key={0} className='link' href={'/account/proof-of-identity'} />]}
+                    />
+                ),
+            };
+        if (ask_authenticate)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your account has not been authenticated. Please submit your <0>proof of identity</0> and <1>proof of address</1> to authenticate your account and access your cashier.'
+                        components={[
+                            <a
+                                key={0}
+                                className='link'
+                                rel='noopener noreferrer'
+                                href={'/account/proof-of-identity'}
+                            />,
+                            <a key={1} className='link' rel='noopener noreferrer' href={'/account/proof-of-address'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_financial_risk_approval)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Please complete the <0>Appropriateness Test</0> to access your cashier.'
+                        components={[
+                            <a
+                                key={0}
+                                className='link'
+                                rel='noopener noreferrer'
+                                href={'/account/financial-assessment'}
+                                data-testid='dt_financial_assessment_link'
+                            />,
+                        ]}
+                    />
+                ),
+            };
+        if (financial_assessment_required)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your cashier is locked. Please complete the <0>financial assessment</0> to unlock it.'
+                        components={[
+                            <a
+                                key={0}
+                                className='link'
+                                rel='noopener noreferrer'
+                                href={'/account/financial-assessment'}
+                                data-testid='dt_financial_assessment_link'
+                            />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_tin_information)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='You have not provided your tax identification number. This information is necessary for legal and regulatory requirements. Please go to <0>Personal details</0> in your account settings, and fill in your latest tax identification number.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/account/personal-details'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_uk_funds_protection)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your cashier is locked. See <0>how we protect your funds</0> before you proceed.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/cashier/deposit'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_self_exclusion_max_turnover_set)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your access to Cashier has been temporarily disabled as you have not set your 30-day turnover limit. Please go to <0>Self-exclusion</0> and set your 30-day turnover limit.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/account/self-exclusion'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_fix_details)
+            return {
+                icon: 'IcCashierLocked',
+                title: localize('Cashier is locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your <0>personal details</0> are incomplete. Please go to your account settings and complete your personal details to enable deposits and withdrawals.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/account/personal-details'} />,
+                        ]}
+                    />
+                ),
+            };
+    }
+
+    if (is_deposit_locked) {
+        if (ask_fix_details)
+            return {
+                icon: 'IcCashierDepositLock',
+                title: localize('Deposits are locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your <0>personal details</0> are incomplete. Please go to your account settings and complete your personal details to enable deposits.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/account/personal-details'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (self_exclusion)
+            return {
+                icon: 'IcCashierDepositLock',
+                title: localize('Deposits are locked'),
+                description: localize(
+                    'You have chosen to exclude yourself from trading on our website until {{exclude_until}}. If you are unable to place a trade or deposit after your self-exclusion period, please contact us via live chat.',
+                    {
+                        exclude_until: formatDate(excluded_until, 'DD MMM, YYYY'),
+                    }
+                ),
+            };
+        if (unwelcome_status)
+            return {
+                icon: 'IcCashierDepositLock',
+                title: localize('Deposits are locked'),
+                description: localize('Please contact us via live chat.'),
+            };
+    }
+
+    if (is_withdrawal_locked) {
+        if (financial_assessment_required)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='You can only make deposits. Please complete the <0>financial assessment</0> to unlock withdrawals.'
+                        components={[
+                            <a
+                                key={0}
+                                className='link'
+                                href={'/account/financial-assessment'}
+                                data-testid='dt_financial_assessment_link'
+                            />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_authenticate)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your account has not been authenticated. Please submit your <0>proof of identity</0> and <1>proof of address</1> to authenticate your account and request for withdrawals.'
+                        components={[
+                            <a
+                                key={0}
+                                className='link'
+                                rel='noopener noreferrer'
+                                href={'/account/proof-of-identity'}
+                            />,
+                            <a key={1} className='link' rel='noopener noreferrer' href={'/account/proof-of-address'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (ask_fix_details)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: (
+                    <Localize
+                        i18n_default_text='Your <0>personal details</0> are incomplete. Please go to your account settings and complete your personal details to enable withdrawals.'
+                        components={[
+                            <a key={0} className='link' rel='noopener noreferrer' href={'/account/personal-details'} />,
+                        ]}
+                    />
+                ),
+            };
+        if (withdraw_service_unavailable_for_pa)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: localize('This feature is not available for payment agents.'),
+            };
+        if (no_withdrawal_or_trading_status)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: localize(
+                    'Unfortunately, you can only make deposits. Please contact us via live chat to enable withdrawals.'
+                ),
+            };
+        if (withdrawal_locked_status)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: localize(
+                    'Unfortunately, you can only make deposits. Please contact us via live chat to enable withdrawals.'
+                ),
+            };
+        if (only_pa_withdrawals_allowed_status)
+            return {
+                icon: 'IcCashierWithdrawalLock',
+                title: localize('Withdrawals are locked'),
+                description: localize(
+                    'You can only make deposits. Please contact us via live chat for more information.'
+                ),
+            };
+    }
+
+    return {
+        icon: 'IcCashierLocked',
+        title: localize('Cashier is locked'),
+        description: localize(
+            'Your cashier is currently locked. Please contact us via live chat to find out how to unlock it.'
+        ),
+    };
+};
+
+export default getMessage;