Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Feature/refactor portfolio calculator factory (#4454)

Thomas Kaul6036547cf54f
diff --git a/apps/api/src/app/portfolio/calculator/mwr/portfolio-calculator.ts b/apps/api/src/app/portfolio/calculator/mwr/portfolio-calculator.ts
index e54f63422b..fab15e6e7d 100644
--- a/apps/api/src/app/portfolio/calculator/mwr/portfolio-calculator.ts
+++ b/apps/api/src/app/portfolio/calculator/mwr/portfolio-calculator.ts
@@ -5,7 +5,7 @@ import {
} from '@ghostfolio/common/interfaces';
import { PortfolioSnapshot } from '@ghostfolio/common/models';
-export class MWRPortfolioCalculator extends PortfolioCalculator {
+export class MwrPortfolioCalculator extends PortfolioCalculator {
protected calculateOverallPerformance(): PortfolioSnapshot {
throw new Error('Method not implemented.');
}
diff --git a/apps/api/src/app/portfolio/calculator/portfolio-calculator.factory.ts b/apps/api/src/app/portfolio/calculator/portfolio-calculator.factory.ts
index 70f27fe7b6..6cc5edeaf6 100644
--- a/apps/api/src/app/portfolio/calculator/portfolio-calculator.factory.ts
+++ b/apps/api/src/app/portfolio/calculator/portfolio-calculator.factory.ts
@@ -8,13 +8,15 @@ import { Filter, HistoricalDataItem } from '@ghostfolio/common/interfaces';
import { Injectable } from '@nestjs/common';
-import { MWRPortfolioCalculator } from './mwr/portfolio-calculator';
+import { MwrPortfolioCalculator } from './mwr/portfolio-calculator';
import { PortfolioCalculator } from './portfolio-calculator';
import { RoaiPortfolioCalculator } from './roai/portfolio-calculator';
+import { TwrPortfolioCalculator } from './twr/portfolio-calculator';
export enum PerformanceCalculationType {
MWR = 'MWR', // Money-Weighted Rate of Return
- ROAI = 'ROAI' // Return on Average Investment
+ ROAI = 'ROAI', // Return on Average Investment
+ TWR = 'TWR' // Time-Weighted Rate of Return
}
@Injectable()
@@ -44,7 +46,7 @@ export class PortfolioCalculatorFactory {
}): PortfolioCalculator {
switch (calculationType) {
case PerformanceCalculationType.MWR:
- return new MWRPortfolioCalculator({
+ return new MwrPortfolioCalculator({
accountBalanceItems,
activities,
currency,
@@ -61,10 +63,23 @@ export class PortfolioCalculatorFactory {
accountBalanceItems,
activities,
currency,
+ filters,
+ userId,
+ configurationService: this.configurationService,
currentRateService: this.currentRateService,
+ exchangeRateDataService: this.exchangeRateDataService,
+ portfolioSnapshotService: this.portfolioSnapshotService,
+ redisCacheService: this.redisCacheService
+ });
+ case PerformanceCalculationType.TWR:
+ return new TwrPortfolioCalculator({
+ accountBalanceItems,
+ activities,
+ currency,
filters,
userId,
configurationService: this.configurationService,
+ currentRateService: this.currentRateService,
exchangeRateDataService: this.exchangeRateDataService,
portfolioSnapshotService: this.portfolioSnapshotService,
redisCacheService: this.redisCacheService
diff --git a/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator.ts b/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator.ts
new file mode 100644
index 0000000000..6499ca3dbf
--- /dev/null
+++ b/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator.ts
@@ -0,0 +1,24 @@
+import { PortfolioCalculator } from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator';
+import {
+ AssetProfileIdentifier,
+ SymbolMetrics
+} from '@ghostfolio/common/interfaces';
+import { PortfolioSnapshot } from '@ghostfolio/common/models';
+
+export class TwrPortfolioCalculator extends PortfolioCalculator {
+ protected calculateOverallPerformance(): PortfolioSnapshot {
+ throw new Error('Method not implemented.');
+ }
+
+ protected getSymbolMetrics({}: {
+ end: Date;
+ exchangeRates: { [dateString: string]: number };
+ marketSymbolMap: {
+ [date: string]: { [symbol: string]: Big };
+ };
+ start: Date;
+ step?: number;
+ } & AssetProfileIdentifier): SymbolMetrics {
+ throw new Error('Method not implemented.');
+ }
+}