@warmio/mcp 5.0.1 → 7.0.0

package/dist/warm-api-client.d.ts

@@ -1,184 +1,243 @@
-type NormalizedAccountType = 'depository' | 'credit' | 'loan' | 'investment' | 'other';
+import { type WarmApiAudience } from './config-paths.js';
 export interface WarmApiClientOptions {
+    audience?: WarmApiAudience;
     apiKeyResolver?: () => string | null;
     apiUrl?: string;
     fetchImplementation?: typeof fetch;
     requestTimeoutMs?: number;
 }
-export interface WarmApiAccount {
-    account_id?: string | null;
-    available_balance?: number | null;
-    current_balance?: number | null;
-    institution_name?: string | null;
-    mask?: string | null;
-    name?: string | null;
-    subtype?: string | null;
-    type?: string | null;
-}
-export interface WarmApiTransaction {
-    account_id?: string | null;
-    amount?: number | null;
-    date?: string | null;
-    detailed_category?: string | null;
-    id?: string | null;
-    merchant_name?: string | null;
-    name?: string | null;
-    primary_category?: string | null;
-}
-export interface WarmApiBudget {
-    amount?: number | null;
-    name?: string | null;
-    period?: string | null;
-    percent_used?: number | null;
-    remaining?: number | null;
-    spent?: number | null;
-    status?: string | null;
-}
-export interface WarmApiGoal {
-    category?: string | null;
-    current?: number | null;
-    monthly_contribution_needed?: number | null;
-    name?: string | null;
-    progress_percent?: number | null;
-    status?: string | null;
-    target?: number | null;
-    target_date?: string | null;
-}
-export interface WarmFinancialState extends Record<string, unknown> {
-    budgets: Array<{
-        amount: number;
-        name: string;
-        percent_used: number;
-        period: string;
-        remaining: number;
-        spent: number;
-        status: string | null;
-    }>;
-    category_spending: Array<{
-        amount: number;
-        category: string;
-    }>;
-    generated_at: string;
-    goals: Array<{
-        category: string | null;
-        current: number;
-        monthly_contribution_needed: number | null;
-        name: string;
-        progress_percent: number;
-        status: string | null;
-        target: number;
-        target_date: string | null;
-    }>;
-    health: {
-        data_completeness: number | null;
-        label: string | null;
-        message: string | null;
-        pillars: {
-            borrow: number | null;
-            build: number | null;
-            save: number | null;
-            spend: number | null;
-        } | null;
-        score: number | null;
-    };
-    holdings: Array<{
-        account_id: string;
-        cost_basis: number | null;
-        quantity: number;
-        security_name: string | null;
-        symbol: string | null;
-        type: string | null;
-        value: number | null;
-    }>;
-    liabilities: Array<{
-        account_id: string;
-        apr_percentage: number | null;
-        balance: number | null;
-        is_overdue: boolean | null;
-        minimum_payment: number | null;
-        next_payment_due_date: string | null;
-        type: string;
-    }>;
-    recurring: Array<{
-        active: boolean;
-        amount: number;
-        frequency: string;
-        merchant: string;
-        next_date: string | null;
-        type: string | null;
-    }>;
-    snapshots: Array<{
-        date: string;
-        net_worth: number;
-        total_assets: number;
-        total_liabilities: number;
+export interface TransactionIndex {
+    total: number;
+    months: Array<{
+        month: string;
+        count: number;
     }>;
 }
-export interface GetTransactionsInput {
-    cursor?: string;
-    last_knowledge?: string;
-    limit: number;
-    search?: string;
-}
-export interface GetTransactionsOutput extends Record<string, unknown> {
-    generated_at: string | null;
-    next_knowledge: string | null;
-    pagination: {
-        has_more: boolean;
-        limit: number;
-        next_cursor: string | null;
-    };
-    txns: Array<{
-        amount: number;
-        category: string | null;
-        date: string | null;
-        description: string | null;
-        detailed_category: string | null;
-        id: string | null;
-        merchant: string | null;
-    }>;
+export interface Position {
+    date: string | null;
+    net_worth: number | null;
+    cash: number | null;
+    debt: number | null;
+    investments: number | null;
+    other_assets: number | null;
+    total_assets: number | null;
 }
-export interface GetAccountsOutput extends Record<string, unknown> {
-    accounts: Array<{
-        balance: number;
-        institution: string | null;
-        mask: string | null;
-        name: string;
-        subtype: string | null;
-        type: NormalizedAccountType;
-    }>;
+export interface Account {
+    id: string;
+    name: string;
+    type: 'depository' | 'credit' | 'loan' | 'investment' | 'brokerage' | 'other';
+    subtype: string | null;
+    group: 'cash' | 'debt' | 'investments' | null;
+    institution: string | null;
+    mask: string | null;
+    balance: number | null;
+    available: number | null;
+    currency: string | null;
+    updated_at: string | null;
+}
+export interface Status {
+    position: Position | null;
+    accounts: Account[];
+}
+export interface Recurring {
+    id: string;
+    account_id: string | null;
+    direction: 'inflow' | 'outflow' | null;
+    frequency: 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'ANNUALLY' | null;
+    status: 'active' | 'inactive' | 'dismissed' | null;
+    merchant: string | null;
+    amount: number | null;
+    next_date: string | null;
+}
+export interface Budget {
+    id: string;
+    name: string;
+    type: 'category' | 'merchant';
+    period: 'weekly' | 'biweekly' | 'monthly';
+    status: 'under' | 'warning' | 'over';
+    amount: number;
+    spent: number;
+    remaining: number;
+    used_percent: number;
+}
+export interface Goal {
+    id: string;
+    name: string;
+    category: string;
+    status: 'not_started' | 'in_progress' | 'on_track' | 'behind' | 'completed';
+    target: number;
+    current: number;
+    progress_percent: number;
+    target_date: string | null;
+}
+export interface Snapshot {
+    date: string;
+    net_worth: number | null;
+    cash: number | null;
+    debt: number | null;
+    income: number | null;
+    expenses: number | null;
+    cash_flow: number | null;
+    savings_rate: number | null;
+    investments: number | null;
+    assets: number | null;
+    health_score: number | null;
+}
+export interface Liability {
+    account_id: string | null;
+    type: 'credit' | 'student' | 'mortgage' | 'other' | null;
+    balance: number | null;
+    minimum_payment: number | null;
+    due_date: string | null;
+    interest_rate: number | null;
+    rate_type: 'fixed' | 'variable' | null;
+    overdue: boolean | null;
+}
+export interface Holding {
+    account_id: string | null;
+    symbol: string | null;
+    name: string | null;
+    type: 'cash' | 'derivative' | 'equity' | 'etf' | 'fixed_income' | 'mutual_fund' | 'other' | null;
+    quantity: number | null;
+    value: number | null;
+    cost_basis: number | null;
+}
+export interface Health {
+    score: number;
+    label: 'Needs Attention' | 'Good' | 'Strong';
+    level: 'critical' | 'poor' | 'fair' | 'good' | 'strong';
+    summary: string;
+    data_completeness: number;
+    pillars: {
+        spend: number | null;
+        save: number | null;
+        borrow: number | null;
+        build: number | null;
+    } | null;
+}
+export interface FinancialContext extends Record<string, unknown> {
+    version: 'v1';
+    updated_at: string;
+    currency: 'USD';
+    status: Status;
+    transactions: TransactionIndex;
+    recurring: Recurring[];
+    budgets: Budget[];
+    goals: Goal[];
+    snapshots: Snapshot[];
+    liabilities: Liability[];
+    holdings: Holding[];
+    health: Health | null;
+}
+export interface Transaction {
+    id: string;
+    account_id: string | null;
+    date: string | null;
+    amount: number;
+    merchant: string | null;
+    name: string | null;
+    category: string | null;
+    subcategory: string | null;
+    pending: boolean | null;
+    currency: string | null;
+}
+export interface TransactionMonth extends Record<string, unknown> {
+    month: string;
+    start_date: string;
+    end_date: string;
+    count: number;
+    items: Transaction[];
+}
+export interface LatestTransactions extends Record<string, unknown> {
+    since: string;
+    window_days: 10;
+    count: number;
+    items: Transaction[];
+}
+export type GetTransactionsInput = {
+    month: string;
+    latest?: never;
+} | {
+    latest: true;
+    month?: never;
+};
+export type GetTransactionsOutput = TransactionMonth | LatestTransactions;
+export interface FinancialContextMeta extends Record<string, unknown> {
+    version: 'v1';
+    user_id: string;
+    context_id: string;
+    generated_at: string;
+    updated_at: string;
+    content_hash: string;
+    byte_length: number;
+    counts: {
+        accounts: number;
+        transaction_months: number;
+        transactions: number;
+        snapshots: number;
+    };
 }
 export interface VerifyKeyOutput extends Record<string, unknown> {
+    audience?: 'automation' | 'context' | 'oauth';
     status: string;
     valid: boolean;
 }
+export interface AutomationOperation extends Record<string, unknown> {
+    confirmation_required: boolean;
+    description: string;
+    method: 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+    operation_id: string;
+    path: string;
+    risk: Array<'read' | 'write' | 'destructive' | 'external_effect'>;
+    summary: string;
+}
+export interface AutomationInput {
+    body?: Record<string, unknown>;
+    params?: Record<string, string>;
+}
+export interface AutomationOperationDescription extends AutomationOperation {
+    input_schema: Record<string, unknown>;
+}
+export interface DescribeOperationOutput extends Record<string, unknown> {
+    approval?: {
+        approval_url: string;
+        expires_at: string;
+        id: string;
+        status: string;
+    };
+    operation: AutomationOperationDescription;
+}
+export interface InvokeOperationOutput extends Record<string, unknown> {
+    body: unknown;
+    headers: Record<string, string>;
+    operation_id: string;
+    status: number;
+}
 export interface WarmApiClient {
-    getAccounts(): Promise<GetAccountsOutput>;
-    getFinancialState(): Promise<WarmFinancialState>;
+    getFinancialContext(): Promise<FinancialContext>;
+    getFinancialContextMeta(): Promise<FinancialContextMeta>;
     getTransactions(input: GetTransactionsInput): Promise<GetTransactionsOutput>;
+    searchOperations(query?: string): Promise<{
+        operations: AutomationOperation[];
+    }>;
+    describeOperation(operationId: string, input?: AutomationInput): Promise<DescribeOperationOutput>;
+    invokeOperation(operationId: string, input?: AutomationInput, approvalId?: string): Promise<InvokeOperationOutput>;
+    validateAudience(): Promise<VerifyKeyOutput>;
     verifyKey(): Promise<VerifyKeyOutput>;
 }
-export interface WarmApiLiability {
-    account_id?: string | null;
-    apr_percentage?: number | null;
-    balance?: number | null;
-    is_overdue?: boolean | null;
-    minimum_payment?: number | null;
-    next_payment_due_date?: string | null;
-    type?: string | null;
-}
-export interface WarmApiHolding {
-    account_id?: string | null;
-    cost_basis?: number | null;
-    quantity?: number | null;
-    security_name?: string | null;
-    symbol?: string | null;
-    type?: string | null;
-    value?: number | null;
-}
-export declare function getConfiguredApiKey(): string | null;
+export declare function getConfiguredApiKey(audience?: WarmApiAudience): string | null;
 export declare function resetConfiguredApiKeyCache(): void;
-export declare function apiRequest<TResponse>(endpoint: string, params?: Record<string, string | undefined>, options?: WarmApiClientOptions): Promise<TResponse>;
+interface WarmApiResponse<TBody> {
+    body: TBody;
+    headers: Record<string, string>;
+    status: number;
+}
+export declare class WarmApiError extends Error {
+    readonly body: unknown;
+    readonly headers: Record<string, string>;
+    readonly status: number;
+    constructor(message: string, response: WarmApiResponse<unknown>);
+}
 export declare function createWarmApiClient(options?: WarmApiClientOptions): WarmApiClient;
-export declare function verifyWarmApiKey(apiKey: string): Promise<VerifyKeyOutput>;
+export declare function verifyWarmApiKey(apiKey: string, audience?: WarmApiAudience): Promise<VerifyKeyOutput>;
 export {};