@mx-cartographer/experiences 4.1.2-alpha.sms-1 → 4.2.0-alpha.sms1

package/CHANGELOG.md

@@ -6,7 +6,7 @@
 
 - **ADDED** - `GoalsWidget`
 
-## [4.0.12] - 02-03-2025
+## [4.0.14] - 02-03-2025
 
 - **FIXED** - Projected income in budget widget
 

package/dist/accounts/stores/AccountStore.d.ts

@@ -1,14 +1,29 @@
 import { Account, GlobalStore, Institution, Member } from '../../common';
 import { AccountApi } from '../api/AccountApi';
 import { UiStore } from './UiStore';
+interface OptionalProps {
+    accounts?: Account[] | [];
+    institutions?: Institution[] | [];
+    members?: Member[] | [];
+    updateExternallyManagedAccounts?: (accounts: Account[]) => void;
+}
 export declare class AccountStore {
     api: AccountApi;
     globalStore: GlobalStore;
+    /**
+     * Required props if data is externally managed
+     * @property {Array} accounts array of accounts
+     * @property {Array} institutions array of institutions
+     * @property {Array} members array of members
+     * @property {function} updateExternallyManagedAccounts Updater function for external data manager
+     */
     accounts: Account[];
     institutions: Institution[];
     members: Member[];
+    updateExternallyManagedAccounts: ((accounts: Account[]) => void) | undefined;
+    shouldManageDataExternally: boolean;
     uiStore: UiStore;
-    constructor(globalStore: GlobalStore);
+    constructor(globalStore: GlobalStore, optionalProps?: OptionalProps);
     initialize: (endpoint: string, token: string) => Promise<void>;
     get cashAccounts(): Account[];
     get checkingAccounts(): Account[];
@@ -28,3 +43,4 @@ export declare class AccountStore {
     removeAccount: (accountGuid: string) => Promise<void>;
     updateAccount: (account: Account) => Promise<void>;
 }
+export {};

package/dist/common/context/hooks.d.ts

@@ -9,6 +9,7 @@ export declare const useGlobalStore: () => import('..').GlobalStore;
 export declare const useGlobalUiStore: () => import('../stores/GlobalUiStore').GlobalUiStore;
 export declare const useGlobalCopyStore: () => import('..').GlobalCopy;
 export declare const useGoalStore: () => import('../..').GoalStore;
+export declare const useHelpStore: () => import('../../help/store/HelpStore').HelpStore;
 export declare const useMerchantStore: () => import('../..').MerchantStore;
 export declare const useNetWorthStore: () => import('../..').NetWorthStore;
 export declare const useNotificationStore: () => import('../..').NotificationStore;

package/dist/common/context/index.d.ts

@@ -1,3 +1,3 @@
-export { useAccountStore, useBudgetsStore, useCashflowStore, useCategoryStore, useDebtStore, useEvent, useGlobalStore, useGlobalUiStore, useGlobalCopyStore, useGoalStore, useMerchantStore, useNetWorthStore, useNotificationStore, usePageView, useRecurringActivityStore, useTransactionStore, useUserStore, useWidgetContainerProvider, } from './hooks';
+export { useAccountStore, useBudgetsStore, useCashflowStore, useCategoryStore, useDebtStore, useEvent, useGlobalStore, useGlobalUiStore, useGlobalCopyStore, useGoalStore, useHelpStore, useMerchantStore, useNetWorthStore, useNotificationStore, usePageView, useRecurringActivityStore, useTransactionStore, useUserStore, useWidgetContainerProvider, } from './hooks';
 export { GlobalDataContext, GlobalDataProvider } from './GlobalDataProvider';
 export { WidgetContainerContext, WidgetContainerProvider } from './WidgetContainerProvider';

package/dist/common/stores/GlobalStore.d.ts

@@ -6,15 +6,16 @@ import { CashflowStore } from '../../cashflow';
 import { CategoryStore } from '../../categories';
 import { ConnectStore } from './ConnectStore';
 import { DebtsStore } from '../../debts';
+import { GlobalCopyStore } from './GlobalCopyStore';
 import { GlobalUiStore } from './GlobalUiStore';
 import { GoalStore } from '../../goals';
+import { HelpStore } from '../../help/store/HelpStore';
 import { MerchantStore } from '../../merchants';
 import { NetWorthStore } from '../../networth';
 import { NotificationStore } from '../../notifications';
 import { RecurringActivityStore } from '../../recurringactivity';
 import { TransactionStore } from '../../transactions';
 import { UserStore } from './UserStore';
-import { GlobalCopyStore } from './GlobalCopyStore';
 export declare class GlobalStore {
     accountStore: AccountStore;
     appDataStore: AppDataStore;
@@ -24,8 +25,9 @@ export declare class GlobalStore {
     categoryStore: CategoryStore;
     connectStore: ConnectStore;
     copyStore: GlobalCopyStore;
-    goalStore: GoalStore;
     debtsStore: DebtsStore;
+    goalStore: GoalStore;
+    helpStore: HelpStore;
     merchantStore: MerchantStore;
     netWorthStore: NetWorthStore;
     notificationStore: NotificationStore;
@@ -34,6 +36,9 @@ export declare class GlobalStore {
     userStore: UserStore;
     globalUiStore: GlobalUiStore;
     isInitialized: boolean;
-    constructor();
-    initialize: (endpoint: string, token: string) => Promise<void>;
+    constructor({ accountStoreProps, transactionStoreProps, }: {
+        accountStoreProps?: any;
+        transactionStoreProps?: any;
+    });
+    initialize: (endpoint: string, token: string, storesToInitialize?: string[]) => Promise<void>;
 }

package/dist/common/types/Debt.d.ts

@@ -4,12 +4,13 @@ export type Debt = {
     account: Account;
     balance: number;
     goal?: Goal;
-    guid?: string;
+    guid: string;
     interest_rate?: number;
     is_paid_off: boolean;
     is_impossible: boolean;
     monthly_payment?: number;
     name: string;
+    original_balance?: number;
     payment_due_date: number;
     priority?: number | string;
     projected_payoff_date?: Date;

package/dist/common/types/GlobalCopy.d.ts

@@ -1,4 +1,4 @@
-import { AccountsCopy, BudgetsCopy, CashflowCopy, CategoryCopy, CommonCopy, ConnectCopy, GoalsCopy, InsightsFeedCopy, MicroInsightsCopy, NetWorthCopy, NotificationsCopy, RecurringCopy, SpendingCopy, TransactionsCopy, TrendsCopy } from './localization';
+import { AccountsCopy, BudgetsCopy, CashflowCopy, CategoryCopy, CommonCopy, ConnectCopy, DebtsCopy, GoalsCopy, InsightsFeedCopy, MicroInsightsCopy, NetWorthCopy, NotificationsCopy, RecurringCopy, SettingsCopy, SpendingCopy, TransactionsCopy, TrendsCopy } from './localization';
 export interface GlobalCopy {
     accounts: AccountsCopy;
     budgets: BudgetsCopy;
@@ -6,12 +6,14 @@ export interface GlobalCopy {
     categories: CategoryCopy;
     common: CommonCopy;
     connect: ConnectCopy;
+    debts: DebtsCopy;
     goals: GoalsCopy;
     insights_feed: InsightsFeedCopy;
     micro_insights: MicroInsightsCopy;
     net_worth: NetWorthCopy;
     notifications: NotificationsCopy;
     recurring: RecurringCopy;
+    settings: SettingsCopy;
     spending: SpendingCopy;
     transactions: TransactionsCopy;
     trends: TrendsCopy;

package/dist/common/types/Help.d.ts

@@ -0,0 +1,22 @@
+import { ClientCommunicationProfile, ClientProfile } from './Client';
+export interface HelpCategory {
+    flags?: string[];
+    guid: string;
+    icon: string;
+    title: string;
+    topics: HelpTopic[];
+}
+export interface HelpListProps {
+    helpCategories: HelpCategory[];
+    helpContent: string;
+    helpTitle: string;
+    buttonText: string;
+    onRequestHelp: () => void;
+    onTopicSelect: (topicKey: string) => void;
+}
+export interface HelpTopic {
+    label: string;
+    topicKey: string;
+}
+export interface Profile extends ClientCommunicationProfile, ClientProfile {
+}

package/dist/common/types/localization/DebtsCopy.d.ts

@@ -0,0 +1,8 @@
+export interface DebtsCopy {
+    add_interest_rate: string;
+    add_monthly_payment: string;
+    add_original_balance: string;
+    details_interest_rate: string;
+    details_monthly_payment: string;
+    details_original_balance: string;
+}

package/dist/common/types/localization/SettingsCopy.d.ts

@@ -0,0 +1,20 @@
+export interface SettingsCopy {
+    birthdate: string;
+    credit_score: string;
+    email_address: string;
+    first_name: string;
+    last_name: string;
+    mobile_number: string;
+    profile_details: string;
+    profile_updated_error_alert: string;
+    profile_updated_success_alert: string;
+    send_verification: string;
+    update_profile_details: string;
+    verification_code_error_alert: string;
+    verification_code_success_alert: string;
+    verification_notice: string;
+    verify_contact: string;
+    verify_contact_detail: string;
+    verify_contact_button: string;
+    zip_code: string;
+}

package/dist/common/types/localization/index.d.ts

@@ -8,12 +8,14 @@ export type { CommonCopy } from './CommonCopy';
 export type { ConnectCopy } from './ConnectCopy';
 export type { CurrencyInputCopy } from './CurrencyInputCopy';
 export type { DateRangePickerCopy } from './DateRangePickerCopy';
+export type { DebtsCopy } from './DebtsCopy';
 export type { GoalsCopy } from './GoalsCopy';
 export type { InsightsFeedCopy } from './InsightsFeedCopy';
 export type { MicroInsightsCopy } from './MicroInsightsCopy';
 export type { NetWorthCopy } from './NetWorthCopy';
 export type { NotificationsCopy } from './NotificationsCopy';
 export type { RecurringCopy } from './RecurringCopy';
+export type { SettingsCopy } from './SettingsCopy';
 export type { SpendingCopy } from './SpendingCopy';
 export type { TransactionsCopy } from './TransactionsCopy';
 export type { TrendsCopy } from './TrendsCopy';

package/dist/debts/components/debtsdrawer/actions/InterestRateAction.d.ts

@@ -0,0 +1,8 @@
+import { DebtChartData } from '../../../utils/DebtsWidget';
+interface InterestRateActionProps {
+    debt: DebtChartData;
+}
+export declare const InterestRateAction: (({ debt }: InterestRateActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
+export {};

package/dist/debts/components/debtsdrawer/actions/MonthlyPaymentAction.d.ts

@@ -0,0 +1,8 @@
+import { DebtChartData } from '../../../utils/DebtsWidget';
+interface MonthlyPaymentActionProps {
+    debt: DebtChartData;
+}
+export declare const MonthlyPaymentAction: (({ debt }: MonthlyPaymentActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
+export {};

package/dist/debts/components/debtsdrawer/actions/OriginalBalanceAction.d.ts

@@ -0,0 +1,8 @@
+import { DebtChartData } from '../../../utils/DebtsWidget';
+interface OriginalBalanceActionProps {
+    debt: DebtChartData;
+}
+export declare const OriginalBalanceAction: (({ debt }: OriginalBalanceActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
+export {};

package/dist/goals/components/actions/AmountToSaveAction.d.ts

@@ -2,5 +2,7 @@ import { Goal } from '../../../common';
 interface AmountToSaveActionProps {
     goal: Goal;
 }
-export declare const AmountToSaveAction: ({ goal }: AmountToSaveActionProps) => import("react/jsx-runtime").JSX.Element;
+export declare const AmountToSaveAction: (({ goal }: AmountToSaveActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
 export {};

package/dist/goals/components/actions/InterestRateAction.d.ts

@@ -2,5 +2,7 @@ import { Goal } from '../../../common';
 interface InterestRateActionProps {
     goal: Goal;
 }
-export declare const InterestRateAction: ({ goal }: InterestRateActionProps) => import("react/jsx-runtime").JSX.Element;
+export declare const InterestRateAction: (({ goal }: InterestRateActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
 export {};

package/dist/goals/components/actions/MonthlyPaymentAction.d.ts

@@ -2,5 +2,7 @@ import { Goal } from '../../../common';
 interface MonthlyPaymentActionProps {
     goal: Goal;
 }
-export declare const MonthlyPaymentAction: ({ goal }: MonthlyPaymentActionProps) => import("react/jsx-runtime").JSX.Element;
+export declare const MonthlyPaymentAction: (({ goal }: MonthlyPaymentActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
 export {};

package/dist/goals/components/actions/OriginalBalanceAction.d.ts

@@ -2,5 +2,7 @@ import { Goal } from '../../../common';
 interface OriginalBalanceActionProps {
     goal: Goal;
 }
-export declare const OriginalBalanceAction: ({ goal }: OriginalBalanceActionProps) => import("react/jsx-runtime").JSX.Element;
+export declare const OriginalBalanceAction: (({ goal }: OriginalBalanceActionProps) => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};
 export {};

package/dist/goals/stores/GoalStore.d.ts

@@ -13,6 +13,8 @@ export declare class GoalStore {
     initialize: (endpoint: string, token: string) => Promise<void>;
     get orderedGoals(): Goal[];
     get debtGoals(): Goal[];
+    get retirmentGoals(): Goal[];
+    get savingGoals(): Goal[];
     addGoal: (goal: Goal) => Promise<void>;
     addRetirementGoal: (goal: Goal) => Promise<void>;
     addRetirementGoalAccount: (account: RetirementGoalAccount) => Promise<void>;

package/dist/help/HelpList.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import { HelpListProps } from '../common/types/Help';
+export declare const HelpList: React.FC<HelpListProps>;

package/dist/help/HelpWidget.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { SxProps } from '@mui/material/styles';
+interface HelpProps {
+    sx: SxProps;
+}
+declare const _default: React.FunctionComponent<HelpProps>;
+export default _default;

package/dist/help/constants/index.d.ts

@@ -0,0 +1,19 @@
+export declare const HELP_CATEGORIES: ({
+    flags: string[];
+    guid: string;
+    icon: string;
+    title: string;
+    topics: {
+        label: string;
+        topicKey: string;
+    }[];
+} | {
+    guid: string;
+    icon: string;
+    title: string;
+    topics: {
+        label: string;
+        topicKey: string;
+    }[];
+    flags?: undefined;
+})[];

package/dist/help/index.d.ts

@@ -0,0 +1,2 @@
+export { default as HelpWidget } from './HelpWidget';
+export { HelpList } from './HelpList';

package/dist/help/store/HelpStore.d.ts

@@ -0,0 +1,9 @@
+import { GlobalStore } from '../../common';
+import { Config } from '../../common/types/Global';
+export declare class HelpStore {
+    appConfig: Config | undefined;
+    globalStore: GlobalStore;
+    constructor(globalStore: GlobalStore);
+    loadAppConfig: (config: Config) => Config;
+    get helpCategories(): import('../../common/types/Help').HelpCategory[];
+}

package/dist/help/utils/index.d.ts

@@ -0,0 +1,2 @@
+import { HelpCategory, Profile } from '../../common/types/Help';
+export declare const getAccessibleHelpCategories: (profile: Profile) => HelpCategory[];

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './common';
 export * from './dashboard';
 export * from './debts';
 export * from './goals';
+export * from './help';
 export * from './insights';
 export * from './merchants';
 export * from './microinsights';