Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍
TypeScript angularetffinancefintechghostfoliohacktoberfestinvestingnestjsosspersonal-financeportfolioprismasoftwarestocktrackertradingtypescriptwealth-managementweb
Feature/add coverage rule to emergency fund section on X-ray page (#7538)
Thomas Kaul9b58da04d41d
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 7f342e4050..509009e6f3 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0## Unreleased+### Added++- Added a _Coverage_ rule to the _Emergency Fund_ section on the _X-ray_ page+### Changed- Improved the check for duplicates in the preview step of the activities import (regardless of the account)diff --git a/apps/api/src/app/portfolio/portfolio.service.ts b/apps/api/src/app/portfolio/portfolio.service.tsindex 48ea66dacc..b665b635aa 100644--- a/apps/api/src/app/portfolio/portfolio.service.ts+++ b/apps/api/src/app/portfolio/portfolio.service.ts@@ -12,6 +12,7 @@ import { CurrencyClusterRiskBaseCurrencyCurrentInvestment } from '@ghostfolio/apimport { CurrencyClusterRiskCurrentInvestment } from '@ghostfolio/api/models/rules/currency-cluster-risk/current-investment';import { EconomicMarketClusterRiskDevelopedMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/developed-markets';import { EconomicMarketClusterRiskEmergingMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/emerging-markets';+import { EmergencyFundCoverage } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-coverage';import { EmergencyFundSetup } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-setup';import { FeeRatioTotalInvestmentVolume } from '@ghostfolio/api/models/rules/fees/fee-ratio-total-investment-volume';import { BuyingPower } from '@ghostfolio/api/models/rules/liquidity/buying-power';@@ -1135,6 +1136,22 @@ export class PortfolioService {withSummary: true});+ // The cash balance of the summary is split into the emergency fund and+ // the remainder, both denominated in the base currency of the user+ const cashBalanceInBaseCurrency = new Big(summary.cash)+ .plus(summary.emergencyFund.cash)+ .toNumber();++ const emergencyFundInBaseCurrency = userSettings.emergencyFund ?? 0;++ const emergencyFundHoldingsValueInBaseCurrency =+ this.getEmergencyFundHoldingsValueInBaseCurrency({ holdings });++ const totalEmergencyFundInBaseCurrency = this.getTotalEmergencyFund({+ emergencyFundHoldingsValueInBaseCurrency,+ userSettings+ }).toNumber();+const hasOpenHoldings = Object.keys(holdings).length > 0;const marketsAdvancedTotalInBaseCurrency = getSum(@@ -1180,12 +1197,22 @@ export class PortfolioService {this.exchangeRateDataService,this.i18nService,userSettings.language,- this.getTotalEmergencyFund({- userSettings,- emergencyFundHoldingsValueInBaseCurrency:- this.getEmergencyFundHoldingsValueInBaseCurrency({ holdings })- }).toNumber()- )+ totalEmergencyFundInBaseCurrency+ ),+ // The coverage is only meaningful once an emergency fund has been+ // set up, either by an amount or by the tagged holdings+ ...(totalEmergencyFundInBaseCurrency > 0+ ? [+ new EmergencyFundCoverage(+ this.exchangeRateDataService,+ this.i18nService,+ userSettings.language,+ emergencyFundInBaseCurrency,+ emergencyFundHoldingsValueInBaseCurrency,+ cashBalanceInBaseCurrency+ )+ ]+ : [])],userSettings)diff --git a/apps/api/src/app/user/user.service.ts b/apps/api/src/app/user/user.service.tsindex 8fb11ad345..516b68e8e5 100644--- a/apps/api/src/app/user/user.service.ts+++ b/apps/api/src/app/user/user.service.ts@@ -11,6 +11,7 @@ import { CurrencyClusterRiskBaseCurrencyCurrentInvestment } from '@ghostfolio/apimport { CurrencyClusterRiskCurrentInvestment } from '@ghostfolio/api/models/rules/currency-cluster-risk/current-investment';import { EconomicMarketClusterRiskDevelopedMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/developed-markets';import { EconomicMarketClusterRiskEmergingMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/emerging-markets';+import { EmergencyFundCoverage } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-coverage';import { EmergencyFundSetup } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-setup';import { FeeRatioTotalInvestmentVolume } from '@ghostfolio/api/models/rules/fees/fee-ratio-total-investment-volume';import { BuyingPower } from '@ghostfolio/api/models/rules/liquidity/buying-power';@@ -448,6 +449,14 @@ export class UserService {undefined,undefined).getSettings(user.settings.settings),+ EmergencyFundCoverage: new EmergencyFundCoverage(+ undefined,+ undefined,+ undefined,+ undefined,+ undefined,+ undefined+ ).getSettings(user.settings.settings),EmergencyFundSetup: new EmergencyFundSetup(undefined,undefined,diff --git a/apps/api/src/models/rules/emergency-fund/emergency-fund-coverage.ts b/apps/api/src/models/rules/emergency-fund/emergency-fund-coverage.tsnew file mode 100644index 0000000000..7f9bbba09b--- /dev/null+++ b/apps/api/src/models/rules/emergency-fund/emergency-fund-coverage.ts@@ -0,0 +1,110 @@+import { Rule } from '@ghostfolio/api/models/rule';+import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';+import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';+import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';++import { Big } from 'big.js';++export class EmergencyFundCoverage extends Rule<Settings> {+ public constructor(+ exchangeRateDataService: ExchangeRateDataService,+ private i18nService: I18nService,+ languageCode: string,+ private emergencyFundInBaseCurrency: number,+ private emergencyFundHoldingsValueInBaseCurrency: number,+ private cashBalanceInBaseCurrency: number+ ) {+ super(exchangeRateDataService, {+ languageCode,+ key: EmergencyFundCoverage.name+ });+ }++ public evaluate(ruleSettings: Settings) {+ if (!this.emergencyFundInBaseCurrency) {+ return {+ evaluation: this.i18nService.getTranslation({+ id: 'rule.emergencyFundCoverage.false.unset',+ languageCode: this.getLanguageCode()+ }),+ value: false+ };+ }++ const placeholders = {+ baseCurrency: ruleSettings.baseCurrency,+ emergencyFund: this.emergencyFundInBaseCurrency.toLocaleString(+ ruleSettings.locale+ )+ };++ // Only the holdings tagged as emergency fund are an explicit commitment,+ // the cash balance covers the remainder+ if (+ new Big(this.emergencyFundHoldingsValueInBaseCurrency).gt(+ this.emergencyFundInBaseCurrency+ )+ ) {+ return {+ evaluation: this.i18nService.getTranslation({+ placeholders,+ id: 'rule.emergencyFundCoverage.false.over',+ languageCode: this.getLanguageCode()+ }),+ value: false+ };+ }++ const coverageInBaseCurrency = new Big(+ this.emergencyFundHoldingsValueInBaseCurrency+ ).plus(this.cashBalanceInBaseCurrency);++ if (coverageInBaseCurrency.lt(this.emergencyFundInBaseCurrency)) {+ return {+ evaluation: this.i18nService.getTranslation({+ placeholders,+ id: 'rule.emergencyFundCoverage.false.under',+ languageCode: this.getLanguageCode()+ }),+ value: false+ };+ }++ return {+ evaluation: this.i18nService.getTranslation({+ placeholders,+ id: 'rule.emergencyFundCoverage.true',+ languageCode: this.getLanguageCode()+ }),+ value: true+ };+ }++ public getConfiguration() {+ return undefined;+ }++ public getName() {+ return this.i18nService.getTranslation({+ id: 'rule.emergencyFundCoverage',+ languageCode: this.getLanguageCode()+ });+ }++ public getSettings({+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,+ xRayRules+ }: UserSettings): Settings {+ return {+ baseCurrency,+ locale,+ isActive: xRayRules?.[this.getKey()]?.isActive ?? true+ };+ }+}++interface Settings extends RuleSettings {+ baseCurrency: string;+}diff --git a/apps/api/src/services/i18n/i18n.service.ts b/apps/api/src/services/i18n/i18n.service.tsindex 65c51b2f09..83eb3a3acc 100644--- a/apps/api/src/services/i18n/i18n.service.ts+++ b/apps/api/src/services/i18n/i18n.service.ts@@ -45,7 +45,10 @@ export class I18nService implements OnModuleInit {if (placeholders) {for (const [key, value] of Object.entries(placeholders)) {- translatedText = translatedText.replace(`\${${key}}`, String(value));+ translatedText = translatedText.replace(+ new RegExp(`\\$\\{${key}\\}`, 'g'),+ String(value)+ );}}diff --git a/apps/client/src/app/pages/i18n/i18n-page.html b/apps/client/src/app/pages/i18n/i18n-page.htmlindex 99ef3039ea..a685074ee5 100644--- a/apps/client/src/app/pages/i18n/i18n-page.html+++ b/apps/client/src/app/pages/i18n/i18n-page.html@@ -142,7 +142,23 @@${thresholdMin}% and ${thresholdMax}%</li><li i18n="@@rule.emergencyFund.category">Emergency Fund</li>- <li i18n="@@rule.emergencyFundSetup">Set up</li>+ <li i18n="@@rule.emergencyFundCoverage">Coverage</li>+ <li i18n="@@rule.emergencyFundCoverage.false.over">+ The assets tagged as emergency fund exceed your emergency fund of+ ${emergencyFund} ${baseCurrency}+ </li>+ <li i18n="@@rule.emergencyFundCoverage.false.under">+ Your emergency fund of ${emergencyFund}+ ${baseCurrency} is not covered+ </li>+ <li i18n="@@rule.emergencyFundCoverage.false.unset">+ No emergency fund amount has been set to determine the coverage+ </li>+ <li i18n="@@rule.emergencyFundCoverage.true">+ Your emergency fund of ${emergencyFund}+ ${baseCurrency} is covered+ </li>+ <li i18n="@@rule.emergencyFundSetup">Setup</li><li i18n="@@rule.emergencyFundSetup.false">No emergency fund has been set up</li>diff --git a/libs/common/src/lib/interfaces/x-ray-rules-settings.interface.ts b/libs/common/src/lib/interfaces/x-ray-rules-settings.interface.tsindex 60a76d4685..cf0324f238 100644--- a/libs/common/src/lib/interfaces/x-ray-rules-settings.interface.ts+++ b/libs/common/src/lib/interfaces/x-ray-rules-settings.interface.ts@@ -8,6 +8,7 @@ export interface XRayRulesSettings {CurrencyClusterRiskCurrentInvestment?: RuleSettings;EconomicMarketClusterRiskDevelopedMarkets?: RuleSettings;EconomicMarketClusterRiskEmergingMarkets?: RuleSettings;+ EmergencyFundCoverage?: RuleSettings;EmergencyFundSetup?: RuleSettings;FeeRatioTotalInvestmentVolume?: RuleSettings;RegionalMarketClusterRiskAsiaPacific?: RuleSettings;