implements interface change

apps/api/src/app/portfolio/portfolio.controller.ts

@@ -655,8 +655,8 @@ export class PortfolioController {
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
       this.request.user.subscription.type === 'Basic'
     ) {
-      for (const rule in report.xRay.rules) {
+      for (const category of report.xRay.categories) {
-        report.xRay.rules[rule] = null;
+        category.rules = null;
       }
 
       report.xRay.statistics = {

apps/api/src/app/portfolio/portfolio.service.ts

@@ -50,6 +50,7 @@ import {
   PortfolioPerformanceResponse,
   PortfolioPosition,
   PortfolioReportResponse,
+  PortfolioReportRule,
   PortfolioSummary,
   UserSettings
 } from '@ghostfolio/common/interfaces';
@@ -1231,8 +1232,11 @@ export class PortfolioService {
       })
     ).toNumber();
 
-    const rules: PortfolioReportResponse['xRay']['rules'] = {
+    const categories: PortfolioReportResponse['xRay']['categories'] = [
-      accountClusterRisk:
+      {
+        key: 'accountClusterRisk',
+        name: 'accountClusterRisk',
+        rules:
           summary.activityCount > 0
             ? await this.rulesService.evaluate(
                 [
@@ -1251,8 +1255,12 @@ export class PortfolioService {
                 ],
                 userSettings
               )
-          : undefined,
+            : undefined
-      assetClassClusterRisk:
+      },
+      {
+        key: 'assetClassClusterRisk',
+        name: 'assetClassClusterRisk',
+        rules:
           summary.activityCount > 0
             ? await this.rulesService.evaluate(
                 [
@@ -1271,8 +1279,12 @@ export class PortfolioService {
                 ],
                 userSettings
               )
-          : undefined,
+            : undefined
-      currencyClusterRisk:
+      },
+      {
+        key: 'currencyClusterRisk',
+        name: 'currencyClusterRisk',
+        rules:
           summary.activityCount > 0
             ? await this.rulesService.evaluate(
                 [
@@ -1291,8 +1303,12 @@ export class PortfolioService {
                 ],
                 userSettings
               )
-          : undefined,
+            : undefined
-      economicMarketClusterRisk:
+      },
+      {
+        key: 'economicMarketClusterRisk',
+        name: 'economicMarketClusterRisk',
+        rules:
           summary.activityCount > 0
             ? await this.rulesService.evaluate(
                 [
@@ -1313,8 +1329,12 @@ export class PortfolioService {
                 ],
                 userSettings
               )
-          : undefined,
+            : undefined
-      emergencyFund: await this.rulesService.evaluate(
+      },
+      {
+        key: 'emergencyFund',
+        name: 'emergencyFund',
+        rules: await this.rulesService.evaluate(
           [
             new EmergencyFundSetup(
               this.exchangeRateDataService,
@@ -1328,8 +1348,12 @@ export class PortfolioService {
             )
           ],
           userSettings
-      ),
+        )
-      fees: await this.rulesService.evaluate(
+      },
+      {
+        key: 'fees',
+        name: 'fees',
+        rules: await this.rulesService.evaluate(
           [
             new FeeRatioInitialInvestment(
               this.exchangeRateDataService,
@@ -1340,8 +1364,12 @@ export class PortfolioService {
             )
           ],
           userSettings
-      ),
+        )
-      liquidity: await this.rulesService.evaluate(
+      },
+      {
+        key: 'liquidity',
+        name: 'liquidity',
+        rules: await this.rulesService.evaluate(
           [
             new BuyingPower(
               this.exchangeRateDataService,
@@ -1351,8 +1379,12 @@ export class PortfolioService {
             )
           ],
           userSettings
-      ),
+        )
-      regionalMarketClusterRisk:
+      },
+      {
+        key: 'regionalMarketClusterRisk',
+        name: 'regionalMarketClusterRisk',
+        rules:
           summary.activityCount > 0
             ? await this.rulesService.evaluate(
                 [
@@ -1395,12 +1427,15 @@ export class PortfolioService {
                 userSettings
               )
             : undefined
-    };
+      }
+    ];
 
     return {
       xRay: {
-        rules,
+        categories,
-        statistics: this.getReportStatistics(rules)
+        statistics: this.getReportStatistics(
+          categories.flatMap(({ rules }) => rules ?? [])
+        )
       }
     };
   }
@@ -1822,7 +1857,7 @@ export class PortfolioService {
   }
 
   private getReportStatistics(
-    evaluatedRules: PortfolioReportResponse['xRay']['rules']
+    evaluatedRules: PortfolioReportRule[]
   ): PortfolioReportResponse['xRay']['statistics'] {
     const rulesActiveCount = Object.values(evaluatedRules)
       .flat()

apps/api/src/app/portfolio/rules.service.ts

@@ -22,7 +22,6 @@ export class RulesService {
         return {
           evaluation,
           value,
-          categoryName: rule.getCategoryName(),
           configuration: rule.getConfiguration(),
           isActive: true,
           key: rule.getKey(),
@@ -30,7 +29,6 @@ export class RulesService {
         };
       } else {
         return {
-          categoryName: rule.getCategoryName(),
           isActive: false,
           key: rule.getKey(),
           name: rule.getName()

apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.ts

@@ -116,49 +116,49 @@ export class GfXRayPageComponent {
     this.dataService
       .fetchPortfolioReport()
       .pipe(takeUntil(this.unsubscribeSubject))
-      .subscribe(({ xRay: { rules, statistics } }) => {
+      .subscribe(({ xRay: { categories, statistics } }) => {
-        this.inactiveRules = this.mergeInactiveRules(rules);
+        this.inactiveRules = this.mergeInactiveRules(categories);
         this.statistics = statistics;
 
         this.accountClusterRiskRules =
-          rules['accountClusterRisk']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'accountClusterRisk')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.assetClassClusterRiskRules =
-          rules['assetClassClusterRisk']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'assetClassClusterRisk')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.currencyClusterRiskRules =
-          rules['currencyClusterRisk']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'currencyClusterRisk')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.economicMarketClusterRiskRules =
-          rules['economicMarketClusterRisk']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'economicMarketClusterRisk')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.emergencyFundRules =
-          rules['emergencyFund']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'emergencyFund')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.feeRules =
-          rules['fees']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'fees')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.liquidityRules =
-          rules['liquidity']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'liquidity')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.regionalMarketClusterRiskRules =
-          rules['regionalMarketClusterRisk']?.filter(({ isActive }) => {
+          categories
-            return isActive;
+            .find(({ key }) => key === 'regionalMarketClusterRisk')
-          }) ?? null;
+            ?.rules?.filter(({ isActive }) => isActive) ?? null;
 
         this.isLoading = false;
 
@@ -167,15 +167,13 @@ export class GfXRayPageComponent {
   }
 
   private mergeInactiveRules(
-    rules: PortfolioReportResponse['xRay']['rules']
+    categories: PortfolioReportResponse['xRay']['categories']
   ): PortfolioReportRule[] {
     let inactiveRules: PortfolioReportRule[] = [];
 
-    for (const category in rules) {
+    for (const category of categories) {
-      const rulesArray = rules[category] || [];
-
       inactiveRules = inactiveRules.concat(
-        rulesArray.filter(({ isActive }) => {
+        category.rules.filter(({ isActive }) => {
           return !isActive;
         })
       );

libs/common/src/lib/interfaces/portfolio-report-rule.interface.ts

@@ -1,5 +1,4 @@
 export interface PortfolioReportRule {
-  categoryName: string;
   configuration?: {
     threshold?: {
       max: number;

libs/common/src/lib/interfaces/responses/portfolio-report.interface.ts

@@ -2,7 +2,11 @@ import { PortfolioReportRule } from '../portfolio-report-rule.interface';
 
 export interface PortfolioReportResponse {
   xRay: {
-    rules: { [group: string]: PortfolioReportRule[] };
+    categories: {
+      key: string;
+      name: string;
+      rules: PortfolioReportRule[];
+    }[];
     statistics: {
       rulesActiveCount: number;
       rulesFulfilledCount: number;