@pfm-platform/goals-data-access 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,523 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryOptions, UseMutationOptions } from '@tanstack/react-query';
+import { SavingsGoalsResponse, SavingsGoal, GoalImagesResponse, GoalCreate, GoalUpdate, PayoffGoalsResponse, PayoffGoal } from '@pfm-platform/shared';
+import * as axios from 'axios';
+
+/**
+ * Parameters for useSavingsGoals query hook
+ */
+interface UseSavingsGoalsParams {
+    userId: string;
+}
+/**
+ * Query hook for fetching all savings goals for a user
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = useSavingsGoals({ userId: 'user123' });
+ * ```
+ */
+declare function useSavingsGoals(params: UseSavingsGoalsParams, options?: Omit<UseQueryOptions<SavingsGoalsResponse>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    savings_goals: {
+        id: number;
+        name: string;
+        state: "active" | "archived" | "completed";
+        status: "complete" | "under" | "risk" | "over";
+        image_name: string;
+        image_url: string;
+        percent_complete: number;
+        complete: boolean;
+        initial_value: string;
+        current_value: string;
+        target_value: string;
+        monthly_contribution: string;
+        remaining_monthly_contribution: string;
+        target_completion_on: string;
+        created_at: string;
+        updated_at: string;
+        links: {
+            accounts: number[];
+        };
+        current_progress?: string | undefined;
+        target_contribution?: string | undefined;
+        weight?: number | undefined;
+    }[];
+}, Error>;
+
+/**
+ * Parameters for useSavingsGoal query hook
+ */
+interface UseSavingsGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Query hook for fetching a single savings goal by ID
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = useSavingsGoal({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function useSavingsGoal(params: UseSavingsGoalParams, options?: Omit<UseQueryOptions<SavingsGoal>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+    weight?: number | undefined;
+}, Error>;
+
+/**
+ * Query hook for fetching savings goal image catalog
+ * This is a global resource (no userId required)
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = useSavingsGoalImages();
+ * ```
+ */
+declare function useSavingsGoalImages(options?: Omit<UseQueryOptions<GoalImagesResponse>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    images: {
+        id: number;
+        name: string;
+        url: string;
+    }[];
+}, Error>;
+
+/**
+ * Parameters for useCreateSavingsGoal mutation
+ */
+interface CreateSavingsGoalParams {
+    userId: string;
+    data: GoalCreate;
+}
+/**
+ * Mutation hook for creating a savings goal
+ *
+ * @example
+ * ```tsx
+ * const createSavingsGoal = useCreateSavingsGoal();
+ *
+ * createSavingsGoal.mutate({
+ *   userId: 'user123',
+ *   data: {
+ *     name: 'Emergency Fund',
+ *     image_name: 'piggy_bank',
+ *     target_value: '5000.00',
+ *     target_completion_on: '2026-12-31',
+ *   }
+ * });
+ * ```
+ */
+declare function useCreateSavingsGoal(options?: Omit<UseMutationOptions<SavingsGoal, Error, CreateSavingsGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+    weight?: number | undefined;
+}, Error, CreateSavingsGoalParams, unknown>;
+
+/**
+ * Parameters for useUpdateSavingsGoal mutation
+ */
+interface UpdateSavingsGoalParams {
+    userId: string;
+    goalId: number;
+    data: GoalUpdate;
+}
+/**
+ * Mutation hook for updating a savings goal
+ *
+ * @example
+ * ```tsx
+ * const updateSavingsGoal = useUpdateSavingsGoal();
+ *
+ * updateSavingsGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456,
+ *   data: {
+ *     id: 456,
+ *     name: 'Updated Emergency Fund',
+ *     image_name: 'piggy_bank',
+ *     target_value: '6000.00'
+ *   }
+ * });
+ * ```
+ */
+declare function useUpdateSavingsGoal(options?: Omit<UseMutationOptions<SavingsGoal, Error, UpdateSavingsGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+    weight?: number | undefined;
+}, Error, UpdateSavingsGoalParams, unknown>;
+
+/**
+ * Parameters for useArchiveSavingsGoal mutation
+ */
+interface ArchiveSavingsGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Mutation hook for archiving a savings goal
+ * Archived goals remain in system but marked as inactive
+ *
+ * @example
+ * ```tsx
+ * const archiveSavingsGoal = useArchiveSavingsGoal();
+ *
+ * archiveSavingsGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function useArchiveSavingsGoal(options?: Omit<UseMutationOptions<void, Error, ArchiveSavingsGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<void, Error, ArchiveSavingsGoalParams, unknown>;
+
+/**
+ * Parameters for useDeleteSavingsGoal mutation
+ */
+interface DeleteSavingsGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Mutation hook for deleting a savings goal permanently
+ *
+ * @example
+ * ```tsx
+ * const deleteSavingsGoal = useDeleteSavingsGoal();
+ *
+ * deleteSavingsGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function useDeleteSavingsGoal(options?: Omit<UseMutationOptions<void, Error, DeleteSavingsGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<void, Error, DeleteSavingsGoalParams, unknown>;
+
+/**
+ * Parameters for usePayoffGoals query hook
+ */
+interface UsePayoffGoalsParams {
+    userId: string;
+}
+/**
+ * Query hook for fetching all payoff goals for a user
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = usePayoffGoals({ userId: 'user123' });
+ * ```
+ */
+declare function usePayoffGoals(params: UsePayoffGoalsParams, options?: Omit<UseQueryOptions<PayoffGoalsResponse>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    payoff_goals: {
+        id: number;
+        name: string;
+        state: "active" | "archived" | "completed";
+        status: "complete" | "under" | "risk" | "over";
+        image_name: string;
+        image_url: string;
+        percent_complete: number;
+        complete: boolean;
+        initial_value: string;
+        current_value: string;
+        target_value: string;
+        monthly_contribution: string;
+        remaining_monthly_contribution: string;
+        target_completion_on: string;
+        created_at: string;
+        updated_at: string;
+        links: {
+            accounts: number[];
+        };
+        current_progress?: string | undefined;
+        target_contribution?: string | undefined;
+    }[];
+}, Error>;
+
+/**
+ * Parameters for usePayoffGoal query hook
+ */
+interface UsePayoffGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Query hook for fetching a single payoff goal by ID
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = usePayoffGoal({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function usePayoffGoal(params: UsePayoffGoalParams, options?: Omit<UseQueryOptions<PayoffGoal>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+}, Error>;
+
+/**
+ * Query hook for fetching payoff goal image catalog
+ * This is a global resource (no userId required)
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = usePayoffGoalImages();
+ * ```
+ */
+declare function usePayoffGoalImages(options?: Omit<UseQueryOptions<GoalImagesResponse>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<{
+    images: {
+        id: number;
+        name: string;
+        url: string;
+    }[];
+}, Error>;
+
+/**
+ * Parameters for useCreatePayoffGoal mutation
+ */
+interface CreatePayoffGoalParams {
+    userId: string;
+    data: GoalCreate;
+}
+/**
+ * Mutation hook for creating a payoff goal
+ *
+ * @example
+ * ```tsx
+ * const createPayoffGoal = useCreatePayoffGoal();
+ *
+ * createPayoffGoal.mutate({
+ *   userId: 'user123',
+ *   data: {
+ *     name: 'Credit Card Debt',
+ *     image_name: 'credit_card',
+ *     target_value: '3000.00',
+ *     target_completion_on: '2026-06-30',
+ *   }
+ * });
+ * ```
+ */
+declare function useCreatePayoffGoal(options?: Omit<UseMutationOptions<PayoffGoal, Error, CreatePayoffGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+}, Error, CreatePayoffGoalParams, unknown>;
+
+/**
+ * Parameters for useUpdatePayoffGoal mutation
+ */
+interface UpdatePayoffGoalParams {
+    userId: string;
+    goalId: number;
+    data: GoalUpdate;
+}
+/**
+ * Mutation hook for updating a payoff goal
+ *
+ * @example
+ * ```tsx
+ * const updatePayoffGoal = useUpdatePayoffGoal();
+ *
+ * updatePayoffGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456,
+ *   data: {
+ *     id: 456,
+ *     name: 'Updated Credit Card',
+ *     image_name: 'credit_card',
+ *     target_value: '2500.00'
+ *   }
+ * });
+ * ```
+ */
+declare function useUpdatePayoffGoal(options?: Omit<UseMutationOptions<PayoffGoal, Error, UpdatePayoffGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<{
+    id: number;
+    name: string;
+    state: "active" | "archived" | "completed";
+    status: "complete" | "under" | "risk" | "over";
+    image_name: string;
+    image_url: string;
+    percent_complete: number;
+    complete: boolean;
+    initial_value: string;
+    current_value: string;
+    target_value: string;
+    monthly_contribution: string;
+    remaining_monthly_contribution: string;
+    target_completion_on: string;
+    created_at: string;
+    updated_at: string;
+    links: {
+        accounts: number[];
+    };
+    current_progress?: string | undefined;
+    target_contribution?: string | undefined;
+}, Error, UpdatePayoffGoalParams, unknown>;
+
+/**
+ * Parameters for useArchivePayoffGoal mutation
+ */
+interface ArchivePayoffGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Mutation hook for archiving a payoff goal
+ * Archived goals remain in system but marked as inactive
+ *
+ * @example
+ * ```tsx
+ * const archivePayoffGoal = useArchivePayoffGoal();
+ *
+ * archivePayoffGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function useArchivePayoffGoal(options?: Omit<UseMutationOptions<void, Error, ArchivePayoffGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<void, Error, ArchivePayoffGoalParams, unknown>;
+
+/**
+ * Parameters for useDeletePayoffGoal mutation
+ */
+interface DeletePayoffGoalParams {
+    userId: string;
+    goalId: number;
+}
+/**
+ * Mutation hook for deleting a payoff goal permanently
+ *
+ * @example
+ * ```tsx
+ * const deletePayoffGoal = useDeletePayoffGoal();
+ *
+ * deletePayoffGoal.mutate({
+ *   userId: 'user123',
+ *   goalId: 456
+ * });
+ * ```
+ */
+declare function useDeletePayoffGoal(options?: Omit<UseMutationOptions<void, Error, DeletePayoffGoalParams>, 'mutationFn'>): _tanstack_react_query.UseMutationResult<void, Error, DeletePayoffGoalParams, unknown>;
+
+/**
+ * Query key factory for Goals domain
+ * Handles both Savings goals and Payoff goals with shared structure
+ */
+type GoalType = 'savings' | 'payoff';
+declare const goalKeys: {
+    all: readonly ["goals"];
+    savingsLists: () => readonly ["goals", "savings", "list"];
+    savingsList: (userId: string) => readonly ["goals", "savings", "list", string];
+    savingsDetails: () => readonly ["goals", "savings", "detail"];
+    savingsDetail: (userId: string, goalId: number) => readonly ["goals", "savings", "detail", string, number];
+    payoffLists: () => readonly ["goals", "payoff", "list"];
+    payoffList: (userId: string) => readonly ["goals", "payoff", "list", string];
+    payoffDetails: () => readonly ["goals", "payoff", "detail"];
+    payoffDetail: (userId: string, goalId: number) => readonly ["goals", "payoff", "detail", string, number];
+    savingsImages: () => readonly ["goals", "savings", "images"];
+    payoffImages: () => readonly ["goals", "payoff", "images"];
+};
+
+/**
+ * Axios instance for Goals API
+ * Base URL configured through environment variables or defaults to relative path
+ */
+declare const api: axios.AxiosInstance;
+
+export { type ArchivePayoffGoalParams, type ArchiveSavingsGoalParams, type CreatePayoffGoalParams, type CreateSavingsGoalParams, type DeletePayoffGoalParams, type DeleteSavingsGoalParams, type GoalType, type UpdatePayoffGoalParams, type UpdateSavingsGoalParams, type UsePayoffGoalParams, type UsePayoffGoalsParams, type UseSavingsGoalParams, type UseSavingsGoalsParams, api, goalKeys, useArchivePayoffGoal, useArchiveSavingsGoal, useCreatePayoffGoal, useCreateSavingsGoal, useDeletePayoffGoal, useDeleteSavingsGoal, usePayoffGoal, usePayoffGoalImages, usePayoffGoals, useSavingsGoal, useSavingsGoalImages, useSavingsGoals, useUpdatePayoffGoal, useUpdateSavingsGoal };