Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍
TypeScript angularetffinancefintechghostfoliohacktoberfestinvestingnestjsosspersonal-financeportfolioprismasoftwarestocktrackertradingtypescriptwealth-managementweb
Feature/add regional market cluster risk for north america (#4240)
Shaunak Das8bd869e1b2e1
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 10a290ae70..e124c7857a 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 new static portfolio analysis rule: _Regional Market Cluster Risk_ (North America)+### Changed- Migrated the database seeding to _TypeScript_diff --git a/apps/api/src/app/portfolio/portfolio.service.ts b/apps/api/src/app/portfolio/portfolio.service.tsindex 8b295aad40..a14f97d267 100644--- a/apps/api/src/app/portfolio/portfolio.service.ts+++ b/apps/api/src/app/portfolio/portfolio.service.ts@@ -15,6 +15,7 @@ import { EconomicMarketClusterRiskDevelopedMarkets } from '@ghostfolio/api/modelimport { EconomicMarketClusterRiskEmergingMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/emerging-markets';import { EmergencyFundSetup } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-setup';import { FeeRatioInitialInvestment } from '@ghostfolio/api/models/rules/fees/fee-ratio-initial-investment';+import { RegionalMarketClusterRiskNorthAmerica } from '@ghostfolio/api/models/rules/regional-market-cluster-risk/north-america';import { DataProviderService } from '@ghostfolio/api/services/data-provider/data-provider.service';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { ImpersonationService } from '@ghostfolio/api/services/impersonation/impersonation.service';@@ -1167,12 +1168,19 @@ export class PortfolioService {const userId = await this.getUserId(impersonationId, this.request.user.id);const userSettings = this.request.user.Settings.settings as UserSettings;- const { accounts, holdings, markets, summary } = await this.getDetails({- impersonationId,- userId,- withMarkets: true,- withSummary: true- });+ const { accounts, holdings, markets, marketsAdvanced, summary } =+ await this.getDetails({+ impersonationId,+ userId,+ withMarkets: true,+ withSummary: true+ });++ const marketsAdvancedTotalInBaseCurrency = getSum(+ Object.values(marketsAdvanced).map(({ valueInBaseCurrency }) => {+ return new Big(valueInBaseCurrency);+ })+ ).toNumber();const marketsTotalInBaseCurrency = getSum(Object.values(markets).map(({ valueInBaseCurrency }) => {@@ -1265,7 +1273,20 @@ export class PortfolioService {)],userSettings- )+ ),+ regionalMarketClusterRisk:+ summary.ordersCount > 0+ ? await this.rulesService.evaluate(+ [+ new RegionalMarketClusterRiskNorthAmerica(+ this.exchangeRateDataService,+ marketsAdvancedTotalInBaseCurrency,+ marketsAdvanced.northAmerica.valueInBaseCurrency+ )+ ],+ userSettings+ )+ : undefined};return { rules, statistics: this.getReportStatistics(rules) };diff --git a/apps/api/src/app/user/user.service.ts b/apps/api/src/app/user/user.service.tsindex b5c71179ff..415cbc99df 100644--- a/apps/api/src/app/user/user.service.ts+++ b/apps/api/src/app/user/user.service.ts@@ -13,6 +13,7 @@ import { EconomicMarketClusterRiskDevelopedMarkets } from '@ghostfolio/api/modelimport { EconomicMarketClusterRiskEmergingMarkets } from '@ghostfolio/api/models/rules/economic-market-cluster-risk/emerging-markets';import { EmergencyFundSetup } from '@ghostfolio/api/models/rules/emergency-fund/emergency-fund-setup';import { FeeRatioInitialInvestment } from '@ghostfolio/api/models/rules/fees/fee-ratio-initial-investment';+import { RegionalMarketClusterRiskNorthAmerica } from '@ghostfolio/api/models/rules/regional-market-cluster-risk/north-america';import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';import { PrismaService } from '@ghostfolio/api/services/prisma/prisma.service';@@ -268,7 +269,13 @@ export class UserService {undefined,undefined,undefined- ).getSettings(user.Settings.settings)+ ).getSettings(user.Settings.settings),+ RegionalMarketClusterRiskNorthAmerica:+ new RegionalMarketClusterRiskNorthAmerica(+ undefined,+ undefined,+ undefined+ ).getSettings(user.Settings.settings)};let currentPermissions = getPermissions(user.role);diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/north-america.ts b/apps/api/src/models/rules/regional-market-cluster-risk/north-america.tsnew file mode 100644index 0000000000..a137f7abfa--- /dev/null+++ b/apps/api/src/models/rules/regional-market-cluster-risk/north-america.ts@@ -0,0 +1,82 @@+import { RuleSettings } from '@ghostfolio/api/models/interfaces/rule-settings.interface';+import { Rule } from '@ghostfolio/api/models/rule';+import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';+import { UserSettings } from '@ghostfolio/common/interfaces';++export class RegionalMarketClusterRiskNorthAmerica extends Rule<Settings> {+ private currentValueInBaseCurrency: number;+ private northAmericaValueInBaseCurrency: number;++ public constructor(+ protected exchangeRateDataService: ExchangeRateDataService,+ currentValueInBaseCurrency: number,+ valueInBaseCurrency+ ) {+ super(exchangeRateDataService, {+ key: RegionalMarketClusterRiskNorthAmerica.name,+ name: 'North America'+ });++ this.currentValueInBaseCurrency = currentValueInBaseCurrency;+ this.northAmericaValueInBaseCurrency = valueInBaseCurrency;+ }++ public evaluate(ruleSettings: Settings) {+ const northAmericaMarketValueRatio = this.currentValueInBaseCurrency+ ? this.northAmericaValueInBaseCurrency / this.currentValueInBaseCurrency+ : 0;++ if (northAmericaMarketValueRatio > ruleSettings.thresholdMax) {+ return {+ evaluation: `The North America market contribution of your current investment (${(northAmericaMarketValueRatio * 100).toPrecision(3)}%) exceeds ${(+ ruleSettings.thresholdMax * 100+ ).toPrecision(3)}%`,+ value: false+ };+ } else if (northAmericaMarketValueRatio < ruleSettings.thresholdMin) {+ return {+ evaluation: `The North America market contribution of your current investment (${(northAmericaMarketValueRatio * 100).toPrecision(3)}%) is below ${(+ ruleSettings.thresholdMin * 100+ ).toPrecision(3)}%`,+ value: false+ };+ }++ return {+ evaluation: `The North America market contribution of your current investment (${(northAmericaMarketValueRatio * 100).toPrecision(3)}%) is within the range of ${(+ ruleSettings.thresholdMin * 100+ ).toPrecision(+ 3+ )}% and ${(ruleSettings.thresholdMax * 100).toPrecision(3)}%`,+ value: true+ };+ }++ public getConfiguration() {+ return {+ threshold: {+ max: 1,+ min: 0,+ step: 0.01,+ unit: '%'+ },+ thresholdMax: true,+ thresholdMin: true+ };+ }++ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {+ return {+ baseCurrency,+ isActive: xRayRules?.[this.getKey()]?.isActive ?? true,+ thresholdMax: xRayRules?.[this.getKey()]?.thresholdMax ?? 0.69,+ thresholdMin: xRayRules?.[this.getKey()]?.thresholdMin ?? 0.65+ };+ }+}++interface Settings extends RuleSettings {+ baseCurrency: string;+ thresholdMin: number;+ thresholdMax: number;+}diff --git a/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.html b/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.htmlindex ceba5f52cf..6ec5722b7d 100644--- a/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.html+++ b/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.html@@ -144,6 +144,30 @@(rulesUpdated)="onRulesUpdated($event)"/></div>+ <div+ class="mb-4"+ [ngClass]="{+ 'd-none': regionalMarketClusterRiskRules?.length === 0+ }"+ >+ <h4 class="align-items-center d-flex m-0">+ <span i18n>Regional Market Cluster Risks</span>+ @if (user?.subscription?.type === 'Basic') {+ <gf-premium-indicator class="ml-1" />+ }+ </h4>+ <gf-rules+ [hasPermissionToUpdateUserSettings]="+ !hasImpersonationId &&+ hasPermissionToUpdateUserSettings &&+ user?.settings?.isExperimentalFeatures+ "+ [isLoading]="isLoading"+ [rules]="regionalMarketClusterRiskRules"+ [settings]="user?.settings?.xRayRules"+ (rulesUpdated)="onRulesUpdated($event)"+ />+ </div><divclass="mb-4"[ngClass]="{diff --git a/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.ts b/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.tsindex 0207545c22..877d0377db 100644--- a/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.ts+++ b/apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.ts@@ -29,6 +29,7 @@ export class XRayPageComponent {public hasPermissionToUpdateUserSettings: boolean;public inactiveRules: PortfolioReportRule[];public isLoading = false;+ public regionalMarketClusterRiskRules: PortfolioReportRule[];public statistics: PortfolioReportResponse['statistics'];public user: User;@@ -129,6 +130,11 @@ export class XRayPageComponent {return isActive;}) ?? null;+ this.regionalMarketClusterRiskRules =+ rules['regionalMarketClusterRisk']?.filter(({ isActive }) => {+ return isActive;+ }) ?? null;+this.isLoading = false;this.changeDetectorRef.markForCheck();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 858ffa31b6..61f79d65f9 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@@ -9,6 +9,7 @@ export interface XRayRulesSettings {EconomicMarketClusterRiskEmergingMarkets?: RuleSettings;EmergencyFundSetup?: RuleSettings;FeeRatioInitialInvestment?: RuleSettings;+ RegionalMarketClusterRiskNorthAmerica?: RuleSettings;}interface RuleSettings {