Merge pull request #294 from tahmid-saj/dev-ts-utils

migrating savings utils to ts

src/components/shared/market-view/market-data-graph/market-data-graph.component.jsx

@@ -5,7 +5,7 @@ import ReactApexChart from 'react-apexcharts';
 import { MarketDataContext } from "../../../../contexts/shared/market-data/market-data.context";
 import { Fragment, useContext } from "react";
 
-import { MARKET_DATA_INTERVALS } from "../../../../utils/constants/market-data.constants";
+import { MARKET_DATA_INTERVALS } from "../../../../utils/constants/market-data.constants.js";
 import { Divider } from "@mui/material";
 import { COLOR_CODES, COMMON_SPACING } from "../../../../utils/constants/shared.constants.js";
 import SimplePaper from "../../mui/paper/paper.component.jsx";

src/contexts/shared/savings-goal-calculator/savings-goal-calculator.context.tsx

@@ -21,7 +21,7 @@ const calculateSavingsGoalHelper = (savingsGoalResult: SavingsGoalResult | undef
   })
 }
 
-const calculateSavingsGoalScheduleHelper = (savingsGoalResult: SavingsGoalResult | undefined): SavingsGoalScheduleResult[] | undefined => {
+const calculateSavingsGoalScheduleHelper = (savingsGoalResult: SavingsGoalResult): SavingsGoalScheduleResult[] | undefined => {
   return calculateSavingsGoalSchedule(savingsGoalResult)
 }
 

src/contexts/shared/savings-goal-calculator/savings-goal-calculator.types.ts

@@ -41,4 +41,5 @@ export type SavingsGoalScheduleResult = {
   interestEarned: number,
   totalInterestEarned: number,
   balance: number
-}
+}
+

src/contexts/signed-in/savings/savings.context.tsx

@@ -11,7 +11,7 @@ import { DEFAULT_SAVINGS_ACCOUNTS, DEFAULT_SAVINGS_ACCOUNTS_SUMMARY } from "../.
 
 import { useSelector } from "react-redux";
 import { selectCurrentUser } from "../../../store/shared/user/user.selector";
-import { SavingsAccount, SavingsAccountsSummary, SavingsContextType, SavingsProviderProps } from "./savings.types";
+import { SavingsAccount, SavingsAccountInfo, SavingsAccountsSummary, SavingsContextType, SavingsProviderProps } from "./savings.types";
 
 // helper functions
 
@@ -89,8 +89,8 @@ const updateSavingsAccountHelper = (savingsAccounts: SavingsAccount[], originalS
     return savingsAccount.savingsAccountName === originalSavingsAccountName;
   });
 
-  const savingsAccountInfo = {
-    originalSavingsAccountInfo: originalSavingsAccount,
+  const savingsAccountInfo: SavingsAccountInfo = {
+    originalSavingsAccountInfo: originalSavingsAccount as SavingsAccount,
     updatedSavingsAccountInfo: {
       ...updatedSavingsAccount,
 

src/contexts/signed-in/savings/savings.types.ts

@@ -18,6 +18,14 @@ export type SavingsAccount = {
   savings: SavingsCalculationRecord[];
 }
 
+export type SavingsAccountCalculated = {
+  totalSavings: number;
+  totalContribution: number;
+  totalInterest: number;
+
+  savings: SavingsCalculationRecord[];
+}
+
 export interface SavingsContextType {
   savingsAccounts: SavingsAccount[];
 
@@ -48,4 +56,9 @@ export type SavingsAccountsSummary = {
   currentAllSavingsAccountsBalance?: number;
   totalAllContribution?: number;
   totalAllInterest?: number;
+}
+
+export type SavingsAccountInfo = {
+  originalSavingsAccountInfo: SavingsAccount;
+  updatedSavingsAccountInfo: SavingsAccount;
 }

src/contexts/signed-out/savings/savings.types.ts

@@ -18,6 +18,14 @@ export type SavingsAccount = {
   savings: SavingsCalculationRecord[];
 }
 
+export type SavingsAccountCalculated = {
+  totalSavings: number;
+  totalContribution: number;
+  totalInterest: number;
+
+  savings: SavingsCalculationRecord[];
+}
+
 export interface SavingsContextType {
   savingsAccounts: SavingsAccount[];
 

src/store/shared/savings-goal-calculator/savings-goal-calculator.action.ts

@@ -6,7 +6,7 @@ import { calculateSavingsGoal as _calculateSavingsGoal,
 import { ActionWithPayload, createAction, withMatcher } from "../../../utils/reducer/reducer.utils";
 import { SAVINGS_GOAL_CALCULATOR_ACTION_TYPES, SavingsGoalResult, SavingsGoalScheduleResult } from "./savings-goal-calculator.types";
 
-export type CalculateSavingsGoal = ActionWithPayload<SAVINGS_GOAL_CALCULATOR_ACTION_TYPES.SET_SAVINGS_GOAL_RESULT, SavingsGoalResult>
+export type CalculateSavingsGoal = ActionWithPayload<SAVINGS_GOAL_CALCULATOR_ACTION_TYPES.SET_SAVINGS_GOAL_RESULT, SavingsGoalResult | undefined>
 export type CalculateSavingsGoalSchedule = ActionWithPayload<SAVINGS_GOAL_CALCULATOR_ACTION_TYPES.SET_SAVINGS_GOAL_SCHEDULE_RESULT, SavingsGoalScheduleResult[]>
 
 type SavingsGoalInput = {
@@ -19,7 +19,7 @@ type SavingsGoalInput = {
 }
 
 // helper functions
-const calculateSavingsGoalHelper = (savingsGoalResult: SavingsGoalResult, savingsGoalInput: SavingsGoalInput): SavingsGoalResult => {
+const calculateSavingsGoalHelper = (savingsGoalResult: SavingsGoalResult, savingsGoalInput: SavingsGoalInput): SavingsGoalResult | undefined => {
   if (validateSavingsGoalInput(savingsGoalInput)) {
     return savingsGoalResult
   }

src/utils/api-requests/market-data.requests.js → src/utils/api-requests/market-data.requests.ts

@@ -1,8 +1,9 @@
+import { MarketDataQuery } from "../../contexts/shared/market-data/market-data.types";
 import { errorOnGetStocksMarketData, errorOnGetIndicesMarketData, 
   errorOnGetCryptoMarketData, errorOnGetForexMarketData } from "../errors/market-data.errors";
 
 // stocks
-export async function getStocksMarketData(marketDataQuery) {
+export async function getStocksMarketData(marketDataQuery: MarketDataQuery): Promise<any> {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_MARKET_DATA}${process.env.REACT_APP_API_URL_MARKET_DATA_STOCKS}`, {
@@ -22,7 +23,7 @@ export async function getStocksMarketData(marketDataQuery) {
 }
 
 // indices
-export async function getIndicesMarketData(marketDataQuery) {
+export async function getIndicesMarketData(marketDataQuery: MarketDataQuery): Promise<any> {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_MARKET_DATA}${process.env.REACT_APP_API_URL_MARKET_DATA_INDICES}`, {
@@ -42,7 +43,7 @@ export async function getIndicesMarketData(marketDataQuery) {
 }
 
 // crypto
-export async function getCryptoMarketData(marketDataQuery) {
+export async function getCryptoMarketData(marketDataQuery: MarketDataQuery): Promise<any> {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_MARKET_DATA}${process.env.REACT_APP_API_URL_MARKET_DATA_CRYPTO}`, {
@@ -62,7 +63,7 @@ export async function getCryptoMarketData(marketDataQuery) {
 }
 
 // forex
-export async function getForexMarketData(marketDataQuery) {
+export async function getForexMarketData(marketDataQuery: MarketDataQuery): Promise<any> {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_MARKET_DATA}${process.env.REACT_APP_API_URL_MARKET_DATA_FOREX}`, {

src/utils/api-requests/savings.requests.js → src/utils/api-requests/savings.requests.ts

@@ -1,11 +1,12 @@
+import { SavingsAccount, SavingsAccountInfo, SavingsAccountsSummary } from "../../contexts/signed-in/savings/savings.types";
 import { errorOnGetSavingsAccountsData, errorOnGetSavingsAccountsSummaryData,
   errorOnPostSavingsAccountCreate, errorOnPutSavingsAccountData, errorOnSavingsAccountInvestment,
   errorOnPutSavingsAccountsData, errorOnPutSavingsAccountsSummaryData } from "../errors/savings.errors";
 
 // savings accounts api requests
 
 // getting savings accounts and summary data on sign in
-export const getSavingsAccountsData = async (userId, email) => {
+export const getSavingsAccountsData = async (userId: string | null | undefined, email: string | null | undefined): Promise<any> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`);
@@ -17,7 +18,7 @@ export const getSavingsAccountsData = async (userId, email) => {
   }
 };
 
-export const getSavingsAccountsSummaryData = async (userId, email) => {
+export const getSavingsAccountsSummaryData = async (userId: string | null | undefined, email: string | null | undefined): Promise<any> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS_SUMMARY}/${userId}/${email}`);
@@ -30,7 +31,8 @@ export const getSavingsAccountsSummaryData = async (userId, email) => {
 };
 
 // saving accounts operations
-export const postSavingsAccountCreate = async (userId, email, savingsAccountInfo) => {
+export const postSavingsAccountCreate = async (userId: string | null | undefined, email: string | null | undefined, 
+  savingsAccountInfo: SavingsAccount): Promise<number | undefined> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`, {
@@ -48,7 +50,8 @@ export const postSavingsAccountCreate = async (userId, email, savingsAccountInfo
   }
 };
 
-export const putSavingsAccountData = async (userId, email, savingsAccountInfo) => {
+export const putSavingsAccountData = async (userId: string | null | undefined, email: string | null | undefined, 
+  savingsAccountInfo: SavingsAccountInfo): Promise<number | undefined> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`, {
@@ -66,7 +69,8 @@ export const putSavingsAccountData = async (userId, email, savingsAccountInfo) =
   }
 };
 
-export const deleteSavingsAccount = async (userId, email, closingSavingsAccountName) => {
+export const deleteSavingsAccount = async (userId: string | null | undefined, email: string | null | undefined, 
+  closingSavingsAccountName: string): Promise<number | undefined> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`, {
@@ -77,15 +81,16 @@ export const deleteSavingsAccount = async (userId, email, closingSavingsAccountN
       body: String(closingSavingsAccountName)
     });
 
-    return response.statusCode;
+    return response.status;
   } catch (error) {
     errorOnSavingsAccountInvestment();
 
   }
 };
 
 // updating savings accounts and summary data on sign out
-export const putSavingsAccountsData = async (userId, email, savingsAccounts) => {
+export const putSavingsAccountsData = async (userId: string | null | undefined, email: string | null | undefined, 
+  savingsAccounts: SavingsAccount[]): Promise<number | undefined> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`, {
@@ -105,7 +110,8 @@ export const putSavingsAccountsData = async (userId, email, savingsAccounts) =>
   }
 };
 
-export const putSavingsAccountsSummaryData = async (userId, email, savingsAccountsSummary) => {
+export const putSavingsAccountsSummaryData = async (userId: string | null | undefined, email: string | null | undefined, 
+  savingsAccountsSummary: SavingsAccountsSummary): Promise<number | undefined> => {
   try {
 
     const response = await fetch(`${process.env.REACT_APP_API_URL_SAVINGS_ACCOUNTS}/${userId}/${email}`, {

src/utils/calculations/savings.calculations.ts

@@ -1,18 +1,38 @@
+import { SavingsGoalInput, SavingsGoalResult, SavingsGoalScheduleResult } from "../../contexts/shared/savings-goal-calculator/savings-goal-calculator.types";
+import { SavingsAccount } from "../../contexts/signed-in/savings/savings.types";
+import { SavingsAccountCalculated } from "../../contexts/signed-out/savings/savings.types";
 import { SAVINGS_CONTRIBUTION_INTERVALS, SAVINGS_GOAL_COMPOUNDED,
   AVERAGE_DAYS_IN_MONTH
 } from "../constants/savings.constants";
 import date from 'date-and-time'
 
+type CompoundedInterestInput = {
+  A: number;
+  P: number;
+  r: number;
+  t: number;
+  n: number;
+}
+
+type SavingsAccountCalculationInput = {
+  initialDeposit: number;
+  startDate: string;
+  monthlyContribution: number;
+  contributionPeriod: number;
+  contributionInterval: string;
+  apy: number;
+}
+
 // helper functions
-const calculateCompoundedInterestPMT = (compoundedInterestInput) => {
+const calculateCompoundedInterestPMT = (compoundedInterestInput: CompoundedInterestInput): number => {
   let res = compoundedInterestInput.A
   res -= compoundedInterestInput.P * (Math.pow(1 + (compoundedInterestInput.r / compoundedInterestInput.n), compoundedInterestInput.n * compoundedInterestInput.t))
   res /= (Math.pow(1 + (compoundedInterestInput.r / compoundedInterestInput.n), compoundedInterestInput.n * compoundedInterestInput.t) - 1) / (compoundedInterestInput.r / compoundedInterestInput.n)
 
   return res
 }
 
-const calculateCompoundedInterestA = (compoundedInterestInput, PMT) => {
+const calculateCompoundedInterestA = (compoundedInterestInput: CompoundedInterestInput, PMT: number): { interestEarned: number, balance: number } => {
   const interestEarned = compoundedInterestInput.P * Math.pow(compoundedInterestInput.r / compoundedInterestInput.n, compoundedInterestInput.n * compoundedInterestInput.t)
   const compoundedResult = compoundedInterestInput.P * Math.pow(1 + (compoundedInterestInput.r / compoundedInterestInput.n), compoundedInterestInput.n * compoundedInterestInput.t)
   const balance = compoundedResult + PMT
@@ -23,7 +43,7 @@ const calculateCompoundedInterestA = (compoundedInterestInput, PMT) => {
   }
 }
 
-const calculatePMTCompoundedInterestA = (compoundedInterestInput, PMT) => {
+const calculatePMTCompoundedInterestA = (compoundedInterestInput: CompoundedInterestInput, PMT: number): number => {
   let res = compoundedInterestInput.P
   res *= Math.pow(1 + (compoundedInterestInput.r / compoundedInterestInput.n), compoundedInterestInput.n * compoundedInterestInput.t)
   res += PMT * ((Math.pow(1 + (compoundedInterestInput.r / compoundedInterestInput.n), compoundedInterestInput.n * compoundedInterestInput.t) - 1) / (compoundedInterestInput.r / compoundedInterestInput.n))
@@ -33,13 +53,14 @@ const calculatePMTCompoundedInterestA = (compoundedInterestInput, PMT) => {
 
 // savings calculations
 
-export const calculateSavings = (savingsAccount) => {
+export const calculateSavings = (savingsAccount: SavingsAccountCalculationInput): SavingsAccountCalculated => {
   // return calculated totalSavings, totalContribution, totalInterest
 
   let resSavings = []
   const startDate = new Date(savingsAccount.startDate)
 
-  let compoundedInterestInput = {
+  let compoundedInterestInput: CompoundedInterestInput = {
+    A: 0,
     P: savingsAccount.initialDeposit,
     r: savingsAccount.apy / 100,
     t: 0,
@@ -96,7 +117,7 @@ export const calculateSavings = (savingsAccount) => {
 
 
 // savings goal
-export const calculateSavingsGoal = (savingsGoalInput) => {
+export const calculateSavingsGoal = (savingsGoalInput: SavingsGoalInput): SavingsGoalResult | undefined => {
 
 
   let compoundedInterestInput = {
@@ -132,12 +153,13 @@ export const calculateSavingsGoal = (savingsGoalInput) => {
   }
 }
 
-export const calculateSavingsGoalSchedule = (savingsGoalResult) => {
+export const calculateSavingsGoalSchedule = (savingsGoalResult: SavingsGoalResult): SavingsGoalScheduleResult[] => {
   let res = []
   let totalInterest = 0
   const startDate = new Date(savingsGoalResult.dateFirstDeposit)
 
-  let compoundedInterestInput = {
+  let compoundedInterestInput: CompoundedInterestInput = {
+    A: 0,
     P: savingsGoalResult.amountFirstDeposit,
     r: savingsGoalResult.interestRatePerYear / 100,
     t: (1 / 12),

src/utils/constants/investments.constants.ts

@@ -82,8 +82,6 @@ export enum INVESTMENT_COMPOUNDING_PERIOD_MONTHS {
 //   },
 // }
 
-const AVERAGE_DAYS_IN_MONTH = 30.437; // Example value for AVERAGE_DAYS_IN_MONTH, replace with actual value if needed
-
 // Define enum for compounding types
 export enum InvestmentCompoundingType {
   Annually = "Annually",

src/utils/constants/market-data.constants.ts

@@ -0,0 +1,22 @@
+// market data constants
+
+export enum MARKET_DATA_TYPES {
+  stocks = "Stocks",
+  indices = "Indices",
+  crypto = "Crypto",
+  currencies = "Currencies"
+}
+
+export const DEFAULT_MARKET_DATA = undefined
+
+export const MARKET_DATA_SEARCH_QUERY_MULTIPLIER = 1
+
+export const MARKET_DATA_CRYPTO_PREFIX = "X:"
+export const MARKET_DATA_FOREX_PREFIX = "C:"
+
+export enum MARKET_DATA_INTERVALS {
+  "Hour" = "Hourly",
+  "Day" = "Daily",
+  "Week" = "Weekly",
+  "Month" = "Monthly" 
+}