From 83af7f97d4c2ccd305db7dcfdb14b1f91484aadb Mon Sep 17 00:00:00 2001
From: Shaunak Das <51281688+shaun-ak@users.noreply.github.com>
Date: Sun, 2 Feb 2025 09:45:10 +0530
Subject: [PATCH] add regional cluster market risk for europe

---
 .../src/app/portfolio/portfolio.service.ts    |  6 ++
 .../regional-market-cluster-risk/europe.ts    | 82 +++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 apps/api/src/models/rules/regional-market-cluster-risk/europe.ts

diff --git a/apps/api/src/app/portfolio/portfolio.service.ts b/apps/api/src/app/portfolio/portfolio.service.ts
index a14f97d26..754794d94 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/model
 import { 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 { RegionalMarketClusterRiskEurope } from '@ghostfolio/api/models/rules/regional-market-cluster-risk/europe';
 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';
@@ -1282,6 +1283,11 @@ export class PortfolioService {
                   this.exchangeRateDataService,
                   marketsAdvancedTotalInBaseCurrency,
                   marketsAdvanced.northAmerica.valueInBaseCurrency
+                ),
+                new RegionalMarketClusterRiskEurope(
+                  this.exchangeRateDataService,
+                  marketsAdvancedTotalInBaseCurrency,
+                  marketsAdvanced.europe.valueInBaseCurrency
                 )
               ],
               userSettings
diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/europe.ts b/apps/api/src/models/rules/regional-market-cluster-risk/europe.ts
new file mode 100644
index 000000000..e43f2f6d9
--- /dev/null
+++ b/apps/api/src/models/rules/regional-market-cluster-risk/europe.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 RegionalMarketClusterRiskEurope extends Rule<Settings> {
+  private currentValueInBaseCurrency: number;
+  private europeValueInBaseCurrency: number;
+
+  public constructor(
+    protected exchangeRateDataService: ExchangeRateDataService,
+    currentValueInBaseCurrency: number,
+    valueInBaseCurrency: number
+  ) {
+    super(exchangeRateDataService, {
+      key: RegionalMarketClusterRiskEurope.name,
+      name: 'Europe'
+    });
+
+    this.currentValueInBaseCurrency = currentValueInBaseCurrency;
+    this.europeValueInBaseCurrency = valueInBaseCurrency;
+  }
+
+  public evaluate(ruleSettings: Settings) {
+    const europeMarketValueRatio = this.currentValueInBaseCurrency
+      ? this.europeValueInBaseCurrency / this.currentValueInBaseCurrency
+      : 0;
+
+    if (europeMarketValueRatio > ruleSettings.thresholdMax) {
+      return {
+        evaluation: `The Europe market contribution of your current investment (${(europeMarketValueRatio * 100).toPrecision(3)}%) exceeds ${(
+          ruleSettings.thresholdMax * 100
+        ).toPrecision(3)}%`,
+        value: false
+      };
+    } else if (europeMarketValueRatio < ruleSettings.thresholdMin) {
+      return {
+        evaluation: `The Europe market contribution of your current investment (${(europeMarketValueRatio * 100).toPrecision(3)}%) is below ${(
+          ruleSettings.thresholdMin * 100
+        ).toPrecision(3)}%`,
+        value: false
+      };
+    }
+
+    return {
+      evaluation: `The Europe market contribution of your current investment (${(europeMarketValueRatio * 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.15,
+      thresholdMin: xRayRules?.[this.getKey()]?.thresholdMin ?? 0.11
+    };
+  }
+}
+
+interface Settings extends RuleSettings {
+  baseCurrency: string;
+  thresholdMin: number;
+  thresholdMax: number;
+}