import type { MorningstarConverterOptions, MorningstarMetadata, MorningstarOptions } from '../Shared/MorningstarOptions'; export interface GoalAnalysisConverterOptions extends MorningstarConverterOptions { } export interface GoalAnalysisMetadata extends MorningstarMetadata { /** * Annualised required return percentage. */ annualisedRequiredReturn: number; /** * Expected return on initial investment. */ expectedReturn: number; /** * Target investment goal amount. */ financialGoal: number; /** * Probability percentage of reaching investment goal. */ probabilityOfReachingTarget: number; /** * Required return percentage. */ requiredReturn: number; /** * Required return value. */ requiredReturnValue: number; /** * Standard deviation value. */ standardDeviation: number; /** * Total gain percentage. */ totalGain: number; /** * Total investment value at end of time period. */ totalInvestment: number; /** * Total return percentage. */ totalReturn: number; /** * Number of years to reach goal. */ years: number; } export interface GoalAnalysisOptions extends MorningstarOptions { /** * Amount investor invests yearly. * * **Note:** Required when `includeDetailedInvestmentGrowthGraph`option is * set to `true`. */ annualInvestment?: number; /** * Weight list of individual asset classes. */ assetClassWeights?: Array; /** * Investor’s current savings amount. * * **Note:** Required when `includeDetailedInvestmentGrowthGraph`option is * set to `true`. */ currentSavings?: number; /** * Returns time series data for charting purposes. */ includeDetailedInvestmentGrowthGraph?: boolean; requestProbability?: number; /** * Investor’s target goal amount. * * **Note:** Required when `includeDetailedInvestmentGrowthGraph`option is * set to `true`. */ target?: number; /** * Time horizon in years. * * **Note:** Required when `includeDetailedInvestmentGrowthGraph`option is * set to `true`. */ timeHorizon?: number; } export default GoalAnalysisOptions;