@mx-cartographer/experiences 4.0.13 → 4.0.14-alpha.JB1

package/src/common/types/Category.ts

@@ -0,0 +1,68 @@
+export interface Category {
+  guid: string
+  income: boolean
+  is_default: boolean
+  is_income: boolean
+  metadata?: string
+  name: string
+  parent_guid?: string
+  revision?: number
+  user_guid?: string
+}
+
+export interface DateRangeCategoryTotals {
+  category_guid: string
+  end_date: number
+  start_date: number
+  total: number
+  user_guid: string
+}
+
+export interface MonthlyCategoryTotals {
+  category_guid: string
+  month: number
+  top_level_category_guid: string
+  total: number
+  user_guid: string
+  year: number
+  year_month: number
+}
+
+export interface MonthlyAmount {
+  amount: number
+  isoDate: string
+  label: string
+}
+
+/**
+ * @averageAmount - The average amount for this category
+ * @color - Color to represent this category
+ * @currentAmount - The amount of this category for the current month
+ * @monthlyAmounts - The past 12 monthly amounts for this category
+ * @icon - Icon to represent this category
+ * @isTransfer - Is this category for transfers
+ * @subCategories - Detailed subcategories for this category
+ * @totalAmount - The total amount (including subcategories) for the current month
+ * @totalAverageAmount - The total average amount (including subcategories) for this category
+ * @totalMonthlyAmounts - The past 12 total monthly amounts (including subcategories)
+ */
+export interface DetailedCategory extends Category {
+  averageAmount: number
+  color: string
+  currentAmount: number
+  monthlyAmounts: MonthlyAmount[]
+  icon: string
+  isTransfer: boolean
+  subCategories: DetailedCategory[]
+  totalAmount: number
+  totalAverageAmount: number
+  totalMonthlyAmounts: MonthlyAmount[]
+}
+
+// DEPRECATED - TODO: Replace usage with detailed categories with totals
+export interface CategoryTotal {
+  amount: number
+  category: Category
+  guid: string
+  subCategoryTotals: CategoryTotal[]
+}

package/src/common/types/Date.ts

@@ -0,0 +1,2 @@
+export type DateType = Date | [Date, Date]
+export type DateRange = { start: Date; end: Date }

package/src/common/types/Debt.ts

@@ -0,0 +1,19 @@
+import { Account } from './Account'
+import { Goal } from './Goal'
+
+export type Debt = {
+  account: Account
+  goal?: Goal
+  guid?: string
+  name: string
+  position?: number
+  balance: number
+  interest_rate: number
+  monthly_payment: number
+  current_amount: number
+  payment_due_date: number
+  projected_payoff_date?: number
+  is_excluded: boolean
+  is_paid_off: boolean
+  is_impossible?: boolean
+}

package/src/common/types/Expense.ts

@@ -0,0 +1,20 @@
+import { ScheduledPayment, Transaction } from '../index'
+
+export enum ExpenseStatus {
+  Missed = 'Missed',
+  Paid = 'Paid',
+  Upcoming = 'Upcoming expense',
+  Income = 'Income',
+}
+
+export interface Expense extends ScheduledPayment {
+  status: ExpenseStatus
+  payments: Transaction[]
+  transactions: Transaction[]
+}
+
+export enum ScheduledPaymentTypes {
+  Unknown = 0,
+  Subscription = 1,
+  Bill = 2,
+}

package/src/common/types/Global.ts

@@ -0,0 +1,13 @@
+export type Config = {
+  enable_renaming_home_accounts: boolean
+}
+
+export type App = {
+  config: Config
+}
+
+declare global {
+  interface Window {
+    app: App
+  }
+}

package/src/common/types/GlobalCopy.ts

@@ -0,0 +1,37 @@
+import {
+  AccountsCopy,
+  BudgetsCopy,
+  CashflowCopy,
+  CategoryCopy,
+  CommonCopy,
+  ConnectCopy,
+  GoalsCopy,
+  InsightsFeedCopy,
+  MicroInsightsCopy,
+  NetWorthCopy,
+  NotificationsCopy,
+  RecurringCopy,
+  SpendingCopy,
+  TransactionsCopy,
+  TrendsCopy,
+} from './localization'
+
+export interface GlobalCopy {
+  accounts: AccountsCopy
+  budgets: BudgetsCopy
+  cashflow: CashflowCopy
+  categories: CategoryCopy
+  common: CommonCopy
+  connect: ConnectCopy
+  goals: GoalsCopy
+  insights_feed: InsightsFeedCopy
+  micro_insights: MicroInsightsCopy
+  net_worth: NetWorthCopy
+  notifications: NotificationsCopy
+  recurring: RecurringCopy
+  spending: SpendingCopy
+  transactions: TransactionsCopy
+  trends: TrendsCopy
+}
+
+export type DynamicCopyElement = HTMLElement | React.ReactNode

package/src/common/types/Goal.ts

@@ -0,0 +1,59 @@
+export interface Goal {
+  guid: string
+  account_guid: string
+  account_is_excluded_from_debts: boolean
+  amount: number
+  budget_guid: string
+  completed_at?: number
+  created_at: number
+  created_by: number
+  current_amount: number
+  goal_type: GoalType
+  has_been_spent: boolean
+  initial_amount: number
+  interest_rate?: number
+  is_complete: boolean
+  is_spendable: boolean
+  meta_type: MetaType
+  metadata?: string
+  monthly_payment?: number
+  name: string
+  payment_due_at?: number
+  position: number
+  projected_to_complete_at?: number
+  revision: number
+  track_type?: TrackType
+  updated_at: number
+  user_guid: string
+}
+
+export enum TrackType {
+  DEBT_TRACK = 1,
+  SAVINGS_TRACK = 2,
+  RETIREMENT_TRACK = 3,
+  EMERGENCY_FUND_TRACK = 4,
+}
+
+export enum GoalType {
+  SAVE_AMOUNT = 1,
+  KEEP_BALANCE_BELOW = 2,
+  KEEP_BALANCE_ABOVE = 3,
+  ACTION = 4,
+}
+
+export enum MetaType {
+  AUTOMOBILE = 1,
+  COLLEGE = 2,
+  HOUSE = 3,
+  RECREATIONAL_VEHICLE = 4,
+  VACATION = 5,
+  ELECTRONIC = 6,
+  OTHER = 7,
+  RETIREMENT = 8,
+  EMERGENCY_FUND = 9,
+  SETUP_BUDGETS = 10,
+  START_MONEY_MANAGEMENT = 11,
+  CREDIT_CARD = 12,
+  LINE_OF_CREDIT = 13,
+  LOANS = 14,
+}

package/src/common/types/Institution.ts

@@ -0,0 +1,11 @@
+export interface Institution {
+  account_verification_is_enabled: boolean
+  code?: string
+  guid: string
+  login_url?: string
+  name: string
+  popularity: number
+  supports_oauth: boolean
+  tax_statement_is_enabled: boolean
+  url?: string
+}

package/src/common/types/LocalizedContent.ts

@@ -0,0 +1,9 @@
+import { SettingsMenuContent } from '../../insights/settings/hiddeninsights/types'
+import { CashflowCopy } from './localization/CashflowCopy'
+
+export interface LocalizedContent {
+  insights_feed?: {
+    settings_menu: SettingsMenuContent
+  }
+  cashflow?: CashflowCopy
+}

package/src/common/types/Merchant.ts

@@ -0,0 +1,6 @@
+export interface Merchant {
+  guid: string
+  logo_url?: string
+  name: string
+  website_url?: string
+}

package/src/common/types/Notification.ts

@@ -0,0 +1,15 @@
+import { Account } from '../types/Account'
+
+export type Notification = {
+  account: Account
+  category_guid: string
+  color: string
+  content: string
+  delivered_at: number
+  entity_guid: string
+  guid: string
+  has_been_viewed: boolean
+  in_app_icon: string
+  merchant_guid: string
+  notification_type: number
+}

package/src/common/types/ScheduledPayment.ts

@@ -0,0 +1,15 @@
+import { RecurrenceTypes } from '../constants'
+
+export interface ScheduledPayment {
+  guid: string
+  amount: number
+  description: string
+  is_tracked_by_user: boolean
+  merchant_guid: string
+  occurs_on: string
+  recurrence_day: number
+  recurrence_type: RecurrenceTypes
+  user_guid: string
+  user_response_name: string
+  user_response_set_at: string | null
+}

package/src/common/types/ScreenSize.tsx

@@ -0,0 +1,4 @@
+export enum ScreenSize {
+  Desktop = 'Desktop',
+  Mobile = 'Mobile',
+}

package/src/common/types/SpendingPlan.ts

@@ -0,0 +1,48 @@
+import { IterationItemTypes, PlanTypes } from '../constants'
+
+export interface SpendingPlan {
+  current_iteration_number: number
+  guid: string
+  iteration_interval: string
+  iteration_interval_id: number
+  spending_plan_accounts: SpendingPlanAccount[]
+  spending_plan_type: PlanTypes
+  user_guid: string
+}
+
+export interface SpendingPlanAccount {
+  account_guid: string
+  created_at: number
+  guid: string
+  spending_plan_guid: string
+  status_code: number
+  updated_at: number
+  user_guid: string
+}
+
+export interface SpendingPlanIteration {
+  end_on: string
+  guid: string
+  iteration_interval: string
+  iteration_number: number
+  spending_plan_guid: string
+  start_on: string
+  user_guid: string
+}
+
+export interface IterationItem {
+  actual_amount: number
+  category_guid?: string
+  guid: string
+  is_one_time?: boolean
+  is_paid?: boolean
+  is_relevant_to_iteration?: boolean
+  item_type: IterationItemTypes
+  planned_amount?: number
+  scheduled_date?: string
+  scheduled_payment_guid?: string
+  spending_plan_iteration_guid: string
+  top_level_category_guid?: string
+  transaction_guids: string[]
+  user_guid: string
+}

package/src/common/types/Transaction.ts

@@ -0,0 +1,91 @@
+export interface Transaction {
+  guid: string
+  account_guid: string
+  amount: number
+  attachment_guid?: string | null
+  category_guid?: string
+  check_number?: string | null
+  currency_code: string | null
+  date: number
+  description: string
+  duplicate: boolean
+  external_guid?: string | null
+  feed_attachment_guid?: string | null
+  feed_description: string
+  feed_localized_description?: string | null
+  feed_posted_date?: number | null
+  feed_status: TransactionStatus | null
+  feed_transaction_date: number | null
+  flags?: number | null
+  has_been_split: boolean
+  has_been_viewed: boolean
+  is_cleared: boolean
+  is_flagged: boolean
+  is_hidden: boolean
+  is_international?: boolean | null
+  is_manual: boolean
+  is_personal: boolean
+  is_reimbursable: boolean
+  is_subscription: boolean
+  is_void: boolean
+  localized_description?: string | null
+  localized_memo?: string | null
+  memo?: string | null
+  metadata?: string | null
+  merchant_guid?: string | null
+  parent_guid?: string | null
+  posted_date?: number | null
+  reference?: string | null
+  revision: number
+  scheduled_payment_guid?: string | null
+  top_level_category_guid?: string
+  transaction_type: TransactionType
+  user_date?: number | null
+  user_guid: string
+  user_transaction_rule_guid?: string | null
+  is_duplicate: boolean
+  tags: string[]
+  feed_transacted_at: number | null
+
+  // Detailed Transaction fields
+  account?: string
+  accountIsClosed?: boolean
+  accountIsHidden?: boolean
+  category?: string
+  isIncome?: boolean
+  isPending?: boolean
+  number?: string
+  payee?: string
+}
+
+export enum TransactionType {
+  CREDIT = 1,
+  DEBIT = 2,
+}
+
+export enum TransactionStatus {
+  POSTED = 1,
+  PENDING = 2,
+}
+
+export interface Tag {
+  guid: string
+  is_default_tag: boolean
+  name: string
+  user_guid: string
+}
+
+export interface Tagging {
+  guid: string
+  user_guid: string
+  tag_guid: string
+  transaction_guid: string
+}
+
+export interface TransactionRule {
+  guid: string
+  user_guid: string
+  category_guid: string
+  match_description: string
+  description: string
+}

package/src/common/types/User.ts

@@ -0,0 +1,20 @@
+export interface UserProfile {
+  guid: string
+  has_completed_cash_flow_onboarding: boolean
+  has_completed_finstrong_onboarding: boolean
+  has_completed_guide_me_wizard: boolean
+  has_completed_budgets2_onboarding: boolean
+  has_completed_recurring_transactions_manager_onboarding: boolean
+  has_completed_spending_plan_onboarding: boolean
+  has_completed_widgets_wizard: boolean
+  has_closed_accounts_widget_help_state: boolean
+  has_closed_budgets_widget_help_state: boolean
+  has_closed_debts_widget_help_state: boolean
+  has_closed_goals_widget_help_state: boolean
+  has_closed_net_worth_widget_help_state: boolean
+  has_closed_spending_widget_help_state: boolean
+  has_closed_transactions_widget_help_state: boolean
+  has_closed_trends_widget_help_state: boolean
+  uses_detailed_notifications: boolean
+  user_guid: string
+}

package/src/common/types/Widgets.ts

@@ -0,0 +1,11 @@
+import type { SxProps } from '@mui/material/styles'
+
+export interface MiniWidgetProps {
+  onPrimaryCtaClick?: () => void
+  sx?: SxProps
+}
+
+export interface WidgetProps {
+  onBackClick?: () => void
+  sx?: SxProps
+}

package/src/common/types/index.ts

@@ -0,0 +1,93 @@
+export type { Account, DetailedAccount, Member, MonthlyAccountBalance } from './Account'
+
+export {
+  AccountIcon,
+  AccountIconVariants,
+  AccountSubType,
+  AccountType,
+  AccountTypeName,
+  ConnectionStatus,
+  ConnectionStatusEnums,
+  ErrorStatuses,
+  MfaStatuses,
+  NonConnectedStatuses,
+  ProcessingStatuses,
+  PropertyType,
+  PropertyTypeName,
+  StatusName,
+} from './Account'
+
+export { type Activity, ActivityStatus, ActivityType } from './Activity'
+
+export type {
+  AnalyticsEvent,
+  AnalyticsPageview,
+  BasicAnalyticsEvent,
+  BasicAnalyticsPageview,
+  AnalyticsSession,
+  AnalyticEventFunction,
+  AnalyticPageviewFunction,
+} from './Analytics'
+
+export type { Beat, DataSeries } from './Beat'
+
+export { UserVerification } from './Beat'
+
+export type { Budget, BudgetColors, DetailedBudget } from './Budget'
+
+export type {
+  CashflowEvent,
+  CashflowSequence,
+  RepeatDay,
+  RepeatInterval,
+  RepeatMonth,
+  RepeatWeekday,
+} from './Cashflow'
+
+export type {
+  Category,
+  CategoryTotal,
+  DateRangeCategoryTotals,
+  DetailedCategory,
+  MonthlyAmount,
+  MonthlyCategoryTotals,
+} from './Category'
+
+export type { DateType, DateRange } from './Date'
+
+export type { Expense } from './Expense'
+export { ExpenseStatus, ScheduledPaymentTypes } from './Expense'
+
+export type { DynamicCopyElement, GlobalCopy } from './GlobalCopy'
+
+export { TrackType } from './Goal'
+export type { Goal } from './Goal'
+export type { Debt } from './Debt'
+
+export type { Institution } from './Institution'
+
+export * from './localization'
+export type { LocalizedContent } from './LocalizedContent'
+
+export type { Notification } from './Notification'
+
+export type { Merchant } from './Merchant'
+
+export type { ScheduledPayment } from './ScheduledPayment'
+
+export type {
+  SpendingPlan,
+  SpendingPlanAccount,
+  SpendingPlanIteration,
+  IterationItem,
+} from './SpendingPlan'
+
+export type { Tag, Tagging, Transaction, TransactionRule } from './Transaction'
+
+export { TransactionStatus, TransactionType } from './Transaction'
+
+export type { UserProfile } from './User'
+
+export { ScreenSize } from './ScreenSize'
+
+export type { MiniWidgetProps, WidgetProps } from './Widgets'

package/src/common/types/localization/AccountFilterCopy.ts

@@ -0,0 +1,12 @@
+export interface AccountFilterCopy {
+  account_type_accounts: string
+  filter_button_aria: string
+  filter_button_generic_aria: string
+  select_all_accounts: string
+  title: string
+  toggle_account_type_accounts: string
+  unselect_all_accounts: string
+  zero_state_button: string
+  zero_state_description: string
+  zero_state_title: string
+}

package/src/common/types/localization/AccountTypeCopy.ts

@@ -0,0 +1,16 @@
+export interface AccountTypeCopy {
+  any: string
+  cash: string
+  checking: string
+  checking_line_of_credit: string
+  credit_card: string
+  digital_wallet: string
+  insurance: string
+  investment: string
+  line_of_credit: string
+  loan: string
+  mortgage: string
+  prepaid: string
+  property: string
+  savings: string
+}