Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍
TypeScript angularetffinancefintechghostfoliohacktoberfestinvestingnestjsosspersonal-financeportfolioprismasoftwarestocktrackertradingtypescriptwealth-managementweb
Task/improve type safety in rule models (#7422)
Kenrick Tandrianc197806e6b1b
diff --git a/apps/api/src/models/rule.ts b/apps/api/src/models/rule.tsindex 66cda1d78f..d47ea30f20 100644--- a/apps/api/src/models/rule.ts+++ b/apps/api/src/models/rule.ts@@ -59,7 +59,7 @@ export abstract class Rule<T extends RuleSettings> implements RuleInterface<T> {new Big(currentValue.quantity).mul(currentValue.marketPrice ?? 0).toNumber(),- currentValue.assetProfile.currency,+ currentValue.assetProfile.currency ?? baseCurrency,baseCurrency),0diff --git a/apps/api/src/models/rules/account-cluster-risk/current-investment.ts b/apps/api/src/models/rules/account-cluster-risk/current-investment.tsindex 11727e118d..1b967c5dbe 100644--- a/apps/api/src/models/rules/account-cluster-risk/current-investment.ts+++ b/apps/api/src/models/rules/account-cluster-risk/current-investment.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioDetails,RuleSettings,@@ -50,7 +51,7 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {};}- let maxAccount: (typeof accounts)[0];+ let maxAccount: (typeof accounts)[0] | undefined;let totalInvestment = 0;for (const account of Object.values(accounts)) {@@ -67,7 +68,8 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {}}- const maxInvestmentRatio = maxAccount?.investment / totalInvestment || 0;+ const maxInvestmentRatio =+ (maxAccount?.investment ?? 0) / totalInvestment || 0;if (maxInvestmentRatio > ruleSettings.thresholdMax) {return {@@ -75,7 +77,7 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {id: 'rule.accountClusterRiskCurrentInvestment.false',languageCode: this.getLanguageCode(),placeholders: {- maxAccountName: maxAccount.name,+ maxAccountName: maxAccount?.name ?? '',maxInvestmentRatio: (maxInvestmentRatio * 100).toPrecision(3),thresholdMax: ruleSettings.thresholdMax * 100}@@ -89,7 +91,7 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {id: 'rule.accountClusterRiskCurrentInvestment.true',languageCode: this.getLanguageCode(),placeholders: {- maxAccountName: maxAccount.name,+ maxAccountName: maxAccount?.name ?? '',maxInvestmentRatio: (maxInvestmentRatio * 100).toPrecision(3),thresholdMax: ruleSettings.thresholdMax * 100}@@ -118,8 +120,8 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/account-cluster-risk/single-account.ts b/apps/api/src/models/rules/account-cluster-risk/single-account.tsindex 75f0503163..9a6224ac29 100644--- a/apps/api/src/models/rules/account-cluster-risk/single-account.ts+++ b/apps/api/src/models/rules/account-cluster-risk/single-account.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioDetails,RuleSettings,@@ -68,7 +69,10 @@ export class AccountClusterRiskSingleAccount extends Rule<RuleSettings> {});}- public getSettings({ locale, xRayRules }: UserSettings): RuleSettings {+ public getSettings({+ locale = DEFAULT_LOCALE,+ xRayRules+ }: UserSettings): RuleSettings {return {locale,isActive: xRayRules?.[this.getKey()]?.isActive ?? truediff --git a/apps/api/src/models/rules/asset-class-cluster-risk/equity.ts b/apps/api/src/models/rules/asset-class-cluster-risk/equity.tsindex ad5c820479..0e054f1846 100644--- a/apps/api/src/models/rules/asset-class-cluster-risk/equity.ts+++ b/apps/api/src/models/rules/asset-class-cluster-risk/equity.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioPosition,RuleSettings,@@ -107,8 +108,8 @@ export class AssetClassClusterRiskEquity extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/asset-class-cluster-risk/fixed-income.ts b/apps/api/src/models/rules/asset-class-cluster-risk/fixed-income.tsindex 3bc8984db3..94f3598091 100644--- a/apps/api/src/models/rules/asset-class-cluster-risk/fixed-income.ts+++ b/apps/api/src/models/rules/asset-class-cluster-risk/fixed-income.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioPosition,RuleSettings,@@ -107,8 +108,8 @@ export class AssetClassClusterRiskFixedIncome extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts b/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.tsindex 96819e4d51..588c50ca11 100644--- a/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts+++ b/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioPosition,RuleSettings,@@ -94,8 +95,8 @@ export class CurrencyClusterRiskBaseCurrencyCurrentInvestment extends Rule<Setti}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts b/apps/api/src/models/rules/currency-cluster-risk/current-investment.tsindex af9fb12f57..b5e22839a0 100644--- a/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts+++ b/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import {PortfolioPosition,RuleSettings,@@ -95,8 +96,8 @@ export class CurrencyClusterRiskCurrentInvestment extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/economic-market-cluster-risk/developed-markets.ts b/apps/api/src/models/rules/economic-market-cluster-risk/developed-markets.tsindex ffab8c4c65..c3b8e618c9 100644--- a/apps/api/src/models/rules/economic-market-cluster-risk/developed-markets.ts+++ b/apps/api/src/models/rules/economic-market-cluster-risk/developed-markets.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';export class EconomicMarketClusterRiskDevelopedMarkets extends Rule<Settings> {@@ -97,8 +98,8 @@ export class EconomicMarketClusterRiskDevelopedMarkets extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/economic-market-cluster-risk/emerging-markets.ts b/apps/api/src/models/rules/economic-market-cluster-risk/emerging-markets.tsindex 6b834b52ae..ad91bc554c 100644--- a/apps/api/src/models/rules/economic-market-cluster-risk/emerging-markets.ts+++ b/apps/api/src/models/rules/economic-market-cluster-risk/emerging-markets.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';export class EconomicMarketClusterRiskEmergingMarkets extends Rule<Settings> {@@ -97,8 +98,8 @@ export class EconomicMarketClusterRiskEmergingMarkets extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts b/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.tsindex fc1d8b0c00..1efd224efb 100644--- a/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts+++ b/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';export class EmergencyFundSetup extends Rule<Settings> {@@ -52,8 +53,8 @@ export class EmergencyFundSetup extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/fees/fee-ratio-total-investment-volume.ts b/apps/api/src/models/rules/fees/fee-ratio-total-investment-volume.tsindex 8be31e6d4e..1786c2f8e5 100644--- a/apps/api/src/models/rules/fees/fee-ratio-total-investment-volume.ts+++ b/apps/api/src/models/rules/fees/fee-ratio-total-investment-volume.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';export class FeeRatioTotalInvestmentVolume extends Rule<Settings> {@@ -76,8 +77,8 @@ export class FeeRatioTotalInvestmentVolume extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/liquidity/buying-power.ts b/apps/api/src/models/rules/liquidity/buying-power.tsindex 83493aabf9..4017516cff 100644--- a/apps/api/src/models/rules/liquidity/buying-power.ts+++ b/apps/api/src/models/rules/liquidity/buying-power.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { RuleSettings, UserSettings } from '@ghostfolio/common/interfaces';export class BuyingPower extends Rule<Settings> {@@ -83,8 +84,8 @@ export class BuyingPower extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/asia-pacific.ts b/apps/api/src/models/rules/regional-market-cluster-risk/asia-pacific.tsindex bf19fc7343..b244641aeb 100644--- a/apps/api/src/models/rules/regional-market-cluster-risk/asia-pacific.ts+++ b/apps/api/src/models/rules/regional-market-cluster-risk/asia-pacific.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { UserSettings } from '@ghostfolio/common/interfaces';import { Settings } from './interfaces/rule-settings.interface';@@ -91,8 +92,8 @@ export class RegionalMarketClusterRiskAsiaPacific extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/emerging-markets.ts b/apps/api/src/models/rules/regional-market-cluster-risk/emerging-markets.tsindex 7f37abecd2..eb7ed7815f 100644--- a/apps/api/src/models/rules/regional-market-cluster-risk/emerging-markets.ts+++ b/apps/api/src/models/rules/regional-market-cluster-risk/emerging-markets.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { UserSettings } from '@ghostfolio/common/interfaces';import { Settings } from './interfaces/rule-settings.interface';@@ -93,8 +94,8 @@ export class RegionalMarketClusterRiskEmergingMarkets extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {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.tsindex 1e10c29bfb..24e0825a3f 100644--- a/apps/api/src/models/rules/regional-market-cluster-risk/europe.ts+++ b/apps/api/src/models/rules/regional-market-cluster-risk/europe.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { UserSettings } from '@ghostfolio/common/interfaces';import { Settings } from './interfaces/rule-settings.interface';@@ -91,8 +92,8 @@ export class RegionalMarketClusterRiskEurope extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/japan.ts b/apps/api/src/models/rules/regional-market-cluster-risk/japan.tsindex 22d6164450..301cebf23c 100644--- a/apps/api/src/models/rules/regional-market-cluster-risk/japan.ts+++ b/apps/api/src/models/rules/regional-market-cluster-risk/japan.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { UserSettings } from '@ghostfolio/common/interfaces';import { Settings } from './interfaces/rule-settings.interface';@@ -91,8 +92,8 @@ export class RegionalMarketClusterRiskJapan extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/models/rules/regional-market-cluster-risk/north-america.ts b/apps/api/src/models/rules/regional-market-cluster-risk/north-america.tsindex aa88dac7b1..eda446f9aa 100644--- a/apps/api/src/models/rules/regional-market-cluster-risk/north-america.ts+++ b/apps/api/src/models/rules/regional-market-cluster-risk/north-america.ts@@ -1,6 +1,7 @@import { Rule } from '@ghostfolio/api/models/rule';import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';import { I18nService } from '@ghostfolio/api/services/i18n/i18n.service';+import { DEFAULT_CURRENCY, DEFAULT_LOCALE } from '@ghostfolio/common/config';import { UserSettings } from '@ghostfolio/common/interfaces';import { Settings } from './interfaces/rule-settings.interface';@@ -91,8 +92,8 @@ export class RegionalMarketClusterRiskNorthAmerica extends Rule<Settings> {}public getSettings({- baseCurrency,- locale,+ baseCurrency = DEFAULT_CURRENCY,+ locale = DEFAULT_LOCALE,xRayRules}: UserSettings): Settings {return {diff --git a/apps/api/src/services/interfaces/environment.interface.ts b/apps/api/src/services/interfaces/environment.interface.tsindex bb58b01ab5..7d9bfd1d40 100644--- a/apps/api/src/services/interfaces/environment.interface.ts+++ b/apps/api/src/services/interfaces/environment.interface.ts@@ -38,9 +38,9 @@ export interface Environment extends CleanedEnvAccessors {MAX_CHART_ITEMS: number;OIDC_AUTHORIZATION_URL: string;OIDC_CALLBACK_URL: string;- OIDC_CLIENT_ID: string;- OIDC_CLIENT_SECRET: string;- OIDC_ISSUER: string;+ OIDC_CLIENT_ID?: string;+ OIDC_CLIENT_SECRET?: string;+ OIDC_ISSUER?: string;OIDC_SCOPE: string[];OIDC_TOKEN_URL: string;OIDC_USER_INFO_URL: string;