Task/refactor BenchmarkMarketDataDetails to BenchmarkMarketDataDetailsResponse

Move BenchmarkMarketDataDetails interface to responses directory and rename to BenchmarkMarketDataDetailsResponse to follow the established naming convention for API response interfaces.

Closes #5769

apps/api/src/app/endpoints/benchmarks/benchmarks.controller.ts

@@ -8,7 +8,7 @@ import { getIntervalFromDateRange } from '@ghostfolio/common/calculation-helper'
 import { HEADER_KEY_IMPERSONATION } from '@ghostfolio/common/config';
 import type {
   AssetProfileIdentifier,
-  BenchmarkMarketDataDetails,
+  BenchmarkMarketDataDetailsResponse,
   BenchmarkResponse
 } from '@ghostfolio/common/interfaces';
 import { permissions } from '@ghostfolio/common/permissions';
@@ -125,7 +125,7 @@ export class BenchmarksController {
     @Query('symbol') filterBySymbol?: string,
     @Query('tags') filterByTags?: string,
     @Query('withExcludedAccounts') withExcludedAccountsParam = 'false'
-  ): Promise<BenchmarkMarketDataDetails> {
+  ): Promise<BenchmarkMarketDataDetailsResponse> {
     const { endDate, startDate } = getIntervalFromDateRange(
       dateRange,
       new Date(startDateString)

apps/api/src/app/endpoints/benchmarks/benchmarks.service.ts

@@ -6,7 +6,7 @@ import { MarketDataService } from '@ghostfolio/api/services/market-data/market-d
 import { DATE_FORMAT, parseDate, resetHours } from '@ghostfolio/common/helper';
 import {
   AssetProfileIdentifier,
-  BenchmarkMarketDataDetails,
+  BenchmarkMarketDataDetailsResponse,
   Filter
 } from '@ghostfolio/common/interfaces';
 import { DateRange, UserWithSettings } from '@ghostfolio/common/types';
@@ -43,7 +43,7 @@ export class BenchmarksService {
     startDate: Date;
     user: UserWithSettings;
     withExcludedAccounts?: boolean;
-  } & AssetProfileIdentifier): Promise<BenchmarkMarketDataDetails> {
+  } & AssetProfileIdentifier): Promise<BenchmarkMarketDataDetailsResponse> {
     const marketData: { date: string; value: number }[] = [];
     const userCurrency = user.settings.settings.baseCurrency;
     const userId = user.id;

apps/client/src/app/services/data.service.ts

@@ -30,7 +30,7 @@ import {
   AiPromptResponse,
   ApiKeyResponse,
   AssetProfileIdentifier,
-  BenchmarkMarketDataDetails,
+  BenchmarkMarketDataDetailsResponse,
   BenchmarkResponse,
   DataProviderHealthResponse,
   Export,
@@ -365,7 +365,7 @@ export class DataService {
     range: DateRange;
     startDate: Date;
     withExcludedAccounts?: boolean;
-  } & AssetProfileIdentifier): Observable<BenchmarkMarketDataDetails> {
+  } & AssetProfileIdentifier): Observable<BenchmarkMarketDataDetailsResponse> {
     let params = this.buildFiltersAsQueryParams({ filters });
 
     params = params.append('range', range);
@@ -374,7 +374,7 @@ export class DataService {
       params = params.append('withExcludedAccounts', withExcludedAccounts);
     }
 
-    return this.http.get<BenchmarkMarketDataDetails>(
+    return this.http.get<BenchmarkMarketDataDetailsResponse>(
       `/api/v1/benchmarks/${dataSource}/${symbol}/${format(startDate, DATE_FORMAT, { in: utc })}`,
       { params }
     );

libs/common/src/lib/interfaces/index.ts

@@ -10,7 +10,6 @@ import type {
 import type { AdminUsers } from './admin-users.interface';
 import type { AssetClassSelectorOption } from './asset-class-selector-option.interface';
 import type { AssetProfileIdentifier } from './asset-profile-identifier.interface';
-import type { BenchmarkMarketDataDetails } from './benchmark-market-data-details.interface';
 import type { BenchmarkProperty } from './benchmark-property.interface';
 import type { Benchmark } from './benchmark.interface';
 import type { Coupon } from './coupon.interface';
@@ -43,6 +42,7 @@ import type { AccountBalancesResponse } from './responses/account-balances-respo
 import type { AccountsResponse } from './responses/accounts-response.interface';
 import type { AiPromptResponse } from './responses/ai-prompt-response.interface';
 import type { ApiKeyResponse } from './responses/api-key-response.interface';
+import type { BenchmarkMarketDataDetailsResponse } from './responses/benchmark-market-data-details-response.interface';
 import type { BenchmarkResponse } from './responses/benchmark-response.interface';
 import type { DataEnhancerHealthResponse } from './responses/data-enhancer-health-response.interface';
 import type { DataProviderGhostfolioAssetProfileResponse } from './responses/data-provider-ghostfolio-asset-profile-response.interface';
@@ -91,7 +91,7 @@ export {
   AssetClassSelectorOption,
   AssetProfileIdentifier,
   Benchmark,
-  BenchmarkMarketDataDetails,
+  BenchmarkMarketDataDetailsResponse,
   BenchmarkProperty,
   BenchmarkResponse,
   Coupon,

libs/common/src/lib/interfaces/benchmark-market-data-details.interface.ts → libs/common/src/lib/interfaces/responses/benchmark-market-data-details-response.interface.ts

@@ -1,5 +1,5 @@
 import { LineChartItem } from '@ghostfolio/common/interfaces';
 
-export interface BenchmarkMarketDataDetails {
+export interface BenchmarkMarketDataDetailsResponse {
   marketData: LineChartItem[];
 }