Feature/eliminate circular dependencies in common library (#896)

* Eliminate circular dependencies

* Update changelog

CHANGELOG.md

@@ -23,6 +23,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Upgraded `Nx` from version `13.8.5` to `14.1.4`
 - Upgraded `storybook` from version `6.4.18` to `6.4.22`
 
+### Fixed
+
+- Eliminated the circular dependencies in the `@ghostfolio/common` library
+
 ## 1.145.0 - 07.05.2022
 
 ### Added

apps/api/src/app/portfolio/interfaces/portfolio-position-detail.interface.ts

@@ -1,4 +1,5 @@
 import { EnhancedSymbolProfile } from '@ghostfolio/api/services/interfaces/symbol-profile.interface';
+import { HistoricalDataItem } from '@ghostfolio/common/interfaces';
 import { OrderWithAccount } from '@ghostfolio/common/types';
 import { Tag } from '@prisma/client';
 
@@ -27,10 +28,3 @@ export interface HistoricalDataContainer {
   isAllTimeLow: boolean;
   items: HistoricalDataItem[];
 }
-
-export interface HistoricalDataItem {
-  averagePrice?: number;
-  date: string;
-  grossPerformancePercent?: number;
-  value: number;
-}

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

@@ -18,7 +18,6 @@ import { FeeRatioInitialInvestment } from '@ghostfolio/api/models/rules/fees/fee
 import { DataProviderService } from '@ghostfolio/api/services/data-provider/data-provider.service';
 import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data.service';
 import { ImpersonationService } from '@ghostfolio/api/services/impersonation.service';
-import { MarketState } from '@ghostfolio/api/services/interfaces/interfaces';
 import { EnhancedSymbolProfile } from '@ghostfolio/api/services/interfaces/symbol-profile.interface';
 import { SymbolProfileService } from '@ghostfolio/api/services/symbol-profile.service';
 import {
@@ -30,6 +29,7 @@ import { DATE_FORMAT, parseDate } from '@ghostfolio/common/helper';
 import {
   Accounts,
   Filter,
+  HistoricalDataItem,
   PortfolioDetails,
   PortfolioPerformanceResponse,
   PortfolioReport,
@@ -72,7 +72,6 @@ import { isEmpty, sortBy, uniqBy } from 'lodash';
 
 import {
   HistoricalDataContainer,
-  HistoricalDataItem,
   PortfolioPositionDetail
 } from './interfaces/portfolio-position-detail.interface';
 import { PortfolioCalculator } from './portfolio-calculator';
@@ -777,8 +776,7 @@ export class PortfolioService {
             position.grossPerformancePercentage?.toNumber() ?? null,
           investment: new Big(position.investment).toNumber(),
           marketState:
-            dataProviderResponses[position.symbol]?.marketState ??
-            MarketState.delayed,
+            dataProviderResponses[position.symbol]?.marketState ?? 'delayed',
           name: symbolProfileMap[position.symbol].name,
           netPerformance: position.netPerformance?.toNumber() ?? null,
           netPerformancePercentage:
@@ -1062,7 +1060,7 @@ export class PortfolioService {
           grossPerformancePercent: 0,
           investment: convertedBalance,
           marketPrice: 0,
-          marketState: MarketState.open,
+          marketState: 'open',
           name: account.currency,
           netPerformance: 0,
           netPerformancePercent: 0,

apps/api/src/app/symbol/interfaces/symbol-item.interface.ts

@@ -1,4 +1,4 @@
-import { HistoricalDataItem } from '@ghostfolio/api/app/portfolio/interfaces/portfolio-position-detail.interface';
+import { HistoricalDataItem } from '@ghostfolio/common/interfaces';
 import { DataSource } from '@prisma/client';
 
 export interface SymbolItem {

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

@@ -1,4 +1,3 @@
-import { HistoricalDataItem } from '@ghostfolio/api/app/portfolio/interfaces/portfolio-position-detail.interface';
 import { DataProviderService } from '@ghostfolio/api/services/data-provider/data-provider.service';
 import {
   IDataGatheringItem,
@@ -6,6 +5,7 @@ import {
 } from '@ghostfolio/api/services/interfaces/interfaces';
 import { MarketDataService } from '@ghostfolio/api/services/market-data.service';
 import { DATE_FORMAT } from '@ghostfolio/common/helper';
+import { HistoricalDataItem } from '@ghostfolio/common/interfaces';
 import { Injectable, Logger } from '@nestjs/common';
 import { DataSource } from '@prisma/client';
 import { format, subDays } from 'date-fns';

apps/api/src/app/user/interfaces/access.interface.ts

@@ -1,4 +0,0 @@
-export interface Access {
-  alias?: string;
-  id: string;
-}

apps/api/src/services/data-provider/ghostfolio-scraper-api/ghostfolio-scraper-api.service.ts

@@ -2,8 +2,7 @@ import { LookupItem } from '@ghostfolio/api/app/symbol/interfaces/lookup-item.in
 import { DataProviderInterface } from '@ghostfolio/api/services/data-provider/interfaces/data-provider.interface';
 import {
   IDataProviderHistoricalResponse,
-  IDataProviderResponse,
-  MarketState
+  IDataProviderResponse
 } from '@ghostfolio/api/services/interfaces/interfaces';
 import { PrismaService } from '@ghostfolio/api/services/prisma.service';
 import { SymbolProfileService } from '@ghostfolio/api/services/symbol-profile.service';
@@ -133,7 +132,7 @@ export class GhostfolioScraperApiService implements DataProviderInterface {
           marketPrice: marketData.find((marketDataItem) => {
             return marketDataItem.symbol === symbolProfile.symbol;
           }).marketPrice,
-          marketState: MarketState.delayed
+          marketState: 'delayed'
         };
       }
 

apps/api/src/services/data-provider/google-sheets/google-sheets.service.ts

@@ -3,8 +3,7 @@ import { ConfigurationService } from '@ghostfolio/api/services/configuration.ser
 import { DataProviderInterface } from '@ghostfolio/api/services/data-provider/interfaces/data-provider.interface';
 import {
   IDataProviderHistoricalResponse,
-  IDataProviderResponse,
-  MarketState
+  IDataProviderResponse
 } from '@ghostfolio/api/services/interfaces/interfaces';
 import { PrismaService } from '@ghostfolio/api/services/prisma.service';
 import { SymbolProfileService } from '@ghostfolio/api/services/symbol-profile.service';
@@ -114,7 +113,7 @@ export class GoogleSheetsService implements DataProviderInterface {
               return symbolProfile.symbol === symbol;
             })?.currency,
             dataSource: this.getName(),
-            marketState: MarketState.delayed
+            marketState: 'delayed'
           };
         }
       }

apps/api/src/services/data-provider/rakuten-rapid-api/rakuten-rapid-api.service.ts

@@ -3,8 +3,7 @@ import { ConfigurationService } from '@ghostfolio/api/services/configuration.ser
 import { DataProviderInterface } from '@ghostfolio/api/services/data-provider/interfaces/data-provider.interface';
 import {
   IDataProviderHistoricalResponse,
-  IDataProviderResponse,
-  MarketState
+  IDataProviderResponse
 } from '@ghostfolio/api/services/interfaces/interfaces';
 import { PrismaService } from '@ghostfolio/api/services/prisma.service';
 import { ghostfolioFearAndGreedIndexSymbol } from '@ghostfolio/common/config';
@@ -118,7 +117,7 @@ export class RakutenRapidApiService implements DataProviderInterface {
             currency: undefined,
             dataSource: this.getName(),
             marketPrice: fgi.now.value,
-            marketState: MarketState.open
+            marketState: 'open'
           }
         };
       }

apps/api/src/services/data-provider/yahoo-finance/yahoo-finance.service.ts

@@ -3,8 +3,7 @@ import { CryptocurrencyService } from '@ghostfolio/api/services/cryptocurrency/c
 import { DataProviderInterface } from '@ghostfolio/api/services/data-provider/interfaces/data-provider.interface';
 import {
   IDataProviderHistoricalResponse,
-  IDataProviderResponse,
-  MarketState
+  IDataProviderResponse
 } from '@ghostfolio/api/services/interfaces/interfaces';
 import { baseCurrency } from '@ghostfolio/common/config';
 import { DATE_FORMAT, isCurrency } from '@ghostfolio/common/helper';
@@ -216,8 +215,8 @@ export class YahooFinanceService implements DataProviderInterface {
           marketState:
             quote.marketState === 'REGULAR' ||
             this.cryptocurrencyService.isCryptocurrency(symbol)
-              ? MarketState.open
-              : MarketState.closed,
+              ? 'open'
+              : 'closed',
           marketPrice: quote.regularMarketPrice || 0
         };
 

apps/api/src/services/interfaces/interfaces.ts

@@ -1,18 +1,11 @@
+import { MarketState } from '@ghostfolio/common/types';
 import {
   Account,
-  AssetClass,
-  AssetSubClass,
   DataSource,
   SymbolProfile,
   Type as TypeOfOrder
 } from '@prisma/client';
 
-export const MarketState = {
-  closed: 'closed',
-  delayed: 'delayed',
-  open: 'open'
-};
-
 export interface IOrder {
   account: Account;
   currency: string;
@@ -44,5 +37,3 @@ export interface IDataGatheringItem {
   date?: Date;
   symbol: string;
 }
-
-export type MarketState = typeof MarketState[keyof typeof MarketState];

apps/client/src/app/components/home-market/home-market.component.ts

@@ -1,10 +1,13 @@
 import { ChangeDetectorRef, Component, OnDestroy, OnInit } from '@angular/core';
-import { HistoricalDataItem } from '@ghostfolio/api/app/portfolio/interfaces/portfolio-position-detail.interface';
 import { DataService } from '@ghostfolio/client/services/data.service';
 import { UserService } from '@ghostfolio/client/services/user/user.service';
 import { ghostfolioFearAndGreedIndexSymbol } from '@ghostfolio/common/config';
 import { resetHours } from '@ghostfolio/common/helper';
-import { InfoItem, User } from '@ghostfolio/common/interfaces';
+import {
+  HistoricalDataItem,
+  InfoItem,
+  User
+} from '@ghostfolio/common/interfaces';
 import { hasPermission, permissions } from '@ghostfolio/common/permissions';
 import { Subject } from 'rxjs';
 import { takeUntil } from 'rxjs/operators';

apps/client/src/app/components/positions/positions.component.ts

@@ -5,7 +5,6 @@ import {
   OnChanges,
   OnInit
 } from '@angular/core';
-import { MarketState } from '@ghostfolio/api/services/interfaces/interfaces';
 import { Position } from '@ghostfolio/common/interfaces';
 
 @Component({
@@ -42,10 +41,7 @@ export class PositionsComponent implements OnChanges, OnInit {
       this.positionsWithPriority = [];
 
       for (const portfolioPosition of this.positions) {
-        if (
-          portfolioPosition.marketState === MarketState.open ||
-          this.range !== '1d'
-        ) {
+        if (portfolioPosition.marketState === 'open' || this.range !== '1d') {
           // Only show positions where the market is open in today's view
           this.positionsWithPriority.push(portfolioPosition);
         } else {

libs/common/src/lib/interfaces/historical-data-item.interface.ts

@@ -0,0 +1,6 @@
+export interface HistoricalDataItem {
+  averagePrice?: number;
+  date: string;
+  grossPerformancePercent?: number;
+  value: number;
+}

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

@@ -9,6 +9,7 @@ import {
 import { Coupon } from './coupon.interface';
 import { Export } from './export.interface';
 import { Filter } from './filter.interface';
+import { HistoricalDataItem } from './historical-data-item.interface';
 import { InfoItem } from './info-item.interface';
 import { PortfolioChart } from './portfolio-chart.interface';
 import { PortfolioDetails } from './portfolio-details.interface';
@@ -40,6 +41,7 @@ export {
   Coupon,
   Export,
   Filter,
+  HistoricalDataItem,
   InfoItem,
   PortfolioChart,
   PortfolioDetails,

libs/common/src/lib/interfaces/portfolio-chart.interface.ts

@@ -1,4 +1,4 @@
-import { HistoricalDataItem } from '@ghostfolio/api/app/portfolio/interfaces/portfolio-position-detail.interface';
+import { HistoricalDataItem } from './historical-data-item.interface';
 
 export interface PortfolioChart {
   hasError: boolean;

libs/common/src/lib/interfaces/portfolio-position.interface.ts

@@ -1,7 +1,6 @@
-import { MarketState } from '@ghostfolio/api/services/interfaces/interfaces';
 import { AssetClass, AssetSubClass, DataSource } from '@prisma/client';
 
-import { Market } from '../types';
+import { Market, MarketState } from '../types';
 import { Country } from './country.interface';
 import { Sector } from './sector.interface';
 

libs/common/src/lib/interfaces/position.interface.ts

@@ -1,5 +1,5 @@
-import { MarketState } from '@ghostfolio/api/services/interfaces/interfaces';
 import { AssetClass, DataSource } from '@prisma/client';
+import { MarketState } from '../types';
 
 export interface Position {
   assetClass: AssetClass;

libs/common/src/lib/interfaces/user.interface.ts

@@ -1,10 +1,12 @@
-import { Access } from '@ghostfolio/api/app/user/interfaces/access.interface';
 import { Account, Tag } from '@prisma/client';
 
 import { UserSettings } from './user-settings.interface';
 
 export interface User {
-  access: Access[];
+  access: {
+    alias?: string;
+    id: string;
+  }[];
   accounts: Account[];
   alias?: string;
   id: string;

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

@@ -2,6 +2,7 @@ import type { AccessWithGranteeUser } from './access-with-grantee-user.type';
 import { AccountWithValue } from './account-with-value.type';
 import type { DateRange } from './date-range.type';
 import type { Granularity } from './granularity.type';
+import { MarketState } from './market-state-type';
 import { Market } from './market.type';
 import type { OrderWithAccount } from './order-with-account.type';
 import type { RequestWithUser } from './request-with-user.type';
@@ -13,6 +14,7 @@ export type {
   DateRange,
   Granularity,
   Market,
+  MarketState,
   OrderWithAccount,
   RequestWithUser,
   ToggleOption

libs/common/src/lib/types/market-state-type.ts

@@ -0,0 +1 @@
+export type MarketState = 'closed' | 'delayed' | 'open';

libs/ui/src/lib/trend-indicator/trend-indicator.component.ts

@@ -1,6 +1,5 @@
 import { ChangeDetectionStrategy, Component, Input } from '@angular/core';
-import { MarketState } from '@ghostfolio/api/services/interfaces/interfaces';
-import { DateRange } from '@ghostfolio/common/types';
+import { DateRange, MarketState } from '@ghostfolio/common/types';
 
 @Component({
   selector: 'gf-trend-indicator',