@wealthfolio/addon-sdk 2.0.0 → 3.0.0

package/dist/src/data-types.d.ts

@@ -5,19 +5,75 @@
 export declare const ActivityType: {
     readonly BUY: "BUY";
     readonly SELL: "SELL";
+    readonly SPLIT: "SPLIT";
     readonly DIVIDEND: "DIVIDEND";
     readonly INTEREST: "INTEREST";
     readonly DEPOSIT: "DEPOSIT";
     readonly WITHDRAWAL: "WITHDRAWAL";
-    readonly ADD_HOLDING: "ADD_HOLDING";
-    readonly REMOVE_HOLDING: "REMOVE_HOLDING";
     readonly TRANSFER_IN: "TRANSFER_IN";
     readonly TRANSFER_OUT: "TRANSFER_OUT";
     readonly FEE: "FEE";
     readonly TAX: "TAX";
-    readonly SPLIT: "SPLIT";
+    readonly CREDIT: "CREDIT";
+    readonly ADJUSTMENT: "ADJUSTMENT";
+    readonly UNKNOWN: "UNKNOWN";
 };
 export type ActivityType = (typeof ActivityType)[keyof typeof ActivityType];
+export declare const ACTIVITY_TYPES: readonly ["BUY", "SELL", "SPLIT", "DIVIDEND", "INTEREST", "DEPOSIT", "WITHDRAWAL", "TRANSFER_IN", "TRANSFER_OUT", "FEE", "TAX", "CREDIT", "ADJUSTMENT", "UNKNOWN"];
+export declare const ActivityStatus: {
+    readonly POSTED: "POSTED";
+    readonly PENDING: "PENDING";
+    readonly DRAFT: "DRAFT";
+    readonly VOID: "VOID";
+};
+export type ActivityStatus = (typeof ActivityStatus)[keyof typeof ActivityStatus];
+export declare const ACTIVITY_SUBTYPES: {
+    readonly DRIP: "DRIP";
+    readonly QUALIFIED: "QUALIFIED";
+    readonly ORDINARY: "ORDINARY";
+    readonly RETURN_OF_CAPITAL: "RETURN_OF_CAPITAL";
+    readonly DIVIDEND_IN_KIND: "DIVIDEND_IN_KIND";
+    readonly STAKING_REWARD: "STAKING_REWARD";
+    readonly LENDING_INTEREST: "LENDING_INTEREST";
+    readonly COUPON: "COUPON";
+    readonly REVERSE_SPLIT: "REVERSE_SPLIT";
+    readonly OPTION_OPEN: "OPTION_OPEN";
+    readonly OPTION_CLOSE: "OPTION_CLOSE";
+    readonly OPTION_EXPIRE: "OPTION_EXPIRE";
+    readonly OPTION_ASSIGNMENT: "OPTION_ASSIGNMENT";
+    readonly OPTION_EXERCISE: "OPTION_EXERCISE";
+    readonly MANAGEMENT_FEE: "MANAGEMENT_FEE";
+    readonly ADR_FEE: "ADR_FEE";
+    readonly INTEREST_CHARGE: "INTEREST_CHARGE";
+    readonly WITHHOLDING: "WITHHOLDING";
+    readonly NRA_WITHHOLDING: "NRA_WITHHOLDING";
+    readonly FEE_REFUND: "FEE_REFUND";
+    readonly TAX_REFUND: "TAX_REFUND";
+    readonly BONUS: "BONUS";
+    readonly ADJUSTMENT: "ADJUSTMENT";
+    readonly REBATE: "REBATE";
+    readonly REVERSAL: "REVERSAL";
+    readonly LIABILITY_INTEREST_ACCRUAL: "LIABILITY_INTEREST_ACCRUAL";
+    readonly LIABILITY_PRINCIPAL_PAYMENT: "LIABILITY_PRINCIPAL_PAYMENT";
+};
+export type ActivitySubtype = (typeof ACTIVITY_SUBTYPES)[keyof typeof ACTIVITY_SUBTYPES];
+export declare const AssetKind: {
+    readonly INVESTMENT: "INVESTMENT";
+    readonly PROPERTY: "PROPERTY";
+    readonly VEHICLE: "VEHICLE";
+    readonly COLLECTIBLE: "COLLECTIBLE";
+    readonly PRECIOUS_METAL: "PRECIOUS_METAL";
+    readonly PRIVATE_EQUITY: "PRIVATE_EQUITY";
+    readonly LIABILITY: "LIABILITY";
+    readonly OTHER: "OTHER";
+    readonly FX: "FX";
+};
+export type AssetKind = (typeof AssetKind)[keyof typeof AssetKind];
+export declare const QuoteMode: {
+    readonly MARKET: "MARKET";
+    readonly MANUAL: "MANUAL";
+};
+export type QuoteMode = (typeof QuoteMode)[keyof typeof QuoteMode];
 export declare const DataSource: {
     readonly YAHOO: "YAHOO";
     readonly MANUAL: "MANUAL";
@@ -32,6 +88,7 @@ export type AccountType = (typeof AccountType)[keyof typeof AccountType];
 export declare const HoldingType: {
     readonly CASH: "cash";
     readonly SECURITY: "security";
+    readonly ALTERNATIVE_ASSET: "AlternativeAsset";
 };
 export type HoldingType = (typeof HoldingType)[keyof typeof HoldingType];
 export type ImportRequiredField = 'symbol' | 'quantity' | 'price' | 'date' | 'type';
@@ -44,36 +101,70 @@ export interface Account {
     currency: string;
     isDefault: boolean;
     isActive: boolean;
+    isArchived: boolean;
+    trackingMode: 'TRANSACTIONS' | 'HOLDINGS' | 'NOT_SET';
     createdAt: Date;
     updatedAt: Date;
     platformId?: string;
+    accountNumber?: string;
+    meta?: string;
+    provider?: string;
+    providerAccountId?: string;
 }
+/**
+ * Activity interface matching the v3 backend model
+ */
 export interface Activity {
     id: string;
-    type: ActivityType;
-    date: Date | string;
-    quantity: number;
-    unitPrice: number;
+    accountId: string;
+    assetId?: string;
+    activityType: string;
+    activityTypeOverride?: string;
+    sourceType?: string;
+    subtype?: string;
+    status: ActivityStatus;
+    activityDate: string;
+    settlementDate?: string;
+    quantity?: string;
+    unitPrice?: string;
+    amount?: string;
+    fee?: string;
     currency: string;
-    fee: number;
-    isDraft: boolean;
-    comment?: string | null;
-    accountId?: string | null;
-    createdAt: Date | string;
-    symbolProfileId: string;
-    updatedAt: Date | string;
+    fxRate?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+    sourceSystem?: string;
+    sourceRecordId?: string;
+    sourceGroupId?: string;
+    idempotencyKey?: string;
+    importRunId?: string;
+    isUserModified: boolean;
+    needsReview: boolean;
+    createdAt: string;
+    updatedAt: string;
 }
+/**
+ * Helper to get effective type (respects user override)
+ */
+export declare function getEffectiveType(activity: Activity): string;
+/**
+ * Check if activity has user override
+ */
+export declare function hasUserOverride(activity: Activity): boolean;
 export interface ActivityDetails {
     id: string;
     activityType: ActivityType;
+    subtype?: string | null;
+    status?: ActivityStatus;
     date: Date;
-    quantity: number;
-    unitPrice: number;
-    amount: number;
-    fee: number;
+    quantity: string | null;
+    unitPrice: string | null;
+    amount: string | null;
+    fee: string | null;
     currency: string;
-    isDraft: boolean;
+    needsReview: boolean;
     comment?: string;
+    fxRate?: string | null;
     createdAt: Date;
     assetId: string;
     updatedAt: Date;
@@ -82,7 +173,14 @@ export interface ActivityDetails {
     accountCurrency: string;
     assetSymbol: string;
     assetName?: string;
-    assetDataSource?: DataSource;
+    assetQuoteMode?: QuoteMode;
+    exchangeMic?: string;
+    sourceSystem?: string;
+    sourceRecordId?: string;
+    idempotencyKey?: string;
+    importRunId?: string;
+    isUserModified?: boolean;
+    metadata?: Record<string, unknown>;
     subRows?: ActivityDetails[];
 }
 export interface ActivitySearchResponse {
@@ -91,22 +189,47 @@ export interface ActivitySearchResponse {
         totalRowCount: number;
     };
 }
+export interface SymbolInput {
+    id?: string;
+    symbol?: string;
+    exchangeMic?: string;
+    kind?: string;
+    name?: string;
+    quoteMode?: QuoteMode;
+}
 export interface ActivityCreate {
     id?: string;
     accountId: string;
     activityType: string;
+    subtype?: string | null;
     activityDate: string | Date;
-    assetId?: string;
-    quantity?: number;
-    unitPrice?: number;
-    amount?: number;
+    sourceGroupId?: string;
+    symbol?: SymbolInput;
+    quantity?: string | number | null;
+    unitPrice?: string | number | null;
+    amount?: string | number | null;
     currency?: string;
-    fee?: number;
-    isDraft: boolean;
+    fee?: string | number | null;
     comment?: string | null;
+    fxRate?: string | number | null;
+    metadata?: string | Record<string, unknown>;
 }
-export interface ActivityUpdate extends ActivityCreate {
+export interface ActivityUpdate {
     id: string;
+    accountId: string;
+    activityType: string;
+    subtype?: string | null;
+    activityDate: string | Date;
+    sourceGroupId?: string;
+    symbol?: SymbolInput;
+    quantity?: string | number | null;
+    unitPrice?: string | number | null;
+    amount?: string | number | null;
+    currency?: string;
+    fee?: string | number | null;
+    comment?: string | null;
+    fxRate?: string | number | null;
+    metadata?: string | Record<string, unknown>;
 }
 export interface ActivityBulkMutationRequest {
     creates?: ActivityCreate[];
@@ -134,20 +257,37 @@ export interface ActivityImport {
     accountId: string;
     currency?: string;
     activityType: ActivityType;
+    subtype?: string;
     date?: Date | string;
     symbol: string;
     amount?: number;
     quantity?: number;
     unitPrice?: number;
     fee?: number;
+    fxRate?: number;
     accountName?: string;
     symbolName?: string;
+    /** Resolved exchange MIC for the symbol (populated during validation) */
+    exchangeMic?: string;
     errors?: Record<string, string[]>;
     isValid: boolean;
     lineNumber?: number;
     isDraft: boolean;
     comment?: string;
 }
+export interface ImportActivitiesSummary {
+    total: number;
+    imported: number;
+    skipped: number;
+    duplicates: number;
+    assetsCreated: number;
+    success: boolean;
+}
+export interface ImportActivitiesResult {
+    activities: ActivityImport[];
+    importRunId: string;
+    summary: ImportActivitiesSummary;
+}
 export interface ImportMappingData {
     accountId: string;
     fieldMappings: Record<string, string>;
@@ -155,29 +295,14 @@ export interface ImportMappingData {
     symbolMappings: Record<string, string>;
     accountMappings: Record<string, string>;
 }
-export interface AssetProfile {
-    id: string;
-    isin: string | null;
-    name: string | null;
-    assetType: string | null;
-    symbol: string;
-    symbolMapping: string | null;
-    assetClass: string | null;
-    assetSubClass: string | null;
-    notes: string | null;
-    countries: string | null;
-    categories: string | null;
-    classes: string | null;
-    attributes: string | null;
-    createdAt: Date;
-    currency: string;
-    dataSource: string;
-    updatedAt: Date;
-    sectors: string | null;
-    url: string | null;
-}
-export interface QuoteSummary {
+export interface SymbolSearchResult {
     exchange: string;
+    /** Canonical exchange MIC code (e.g., "XNAS", "XTSE") */
+    exchangeMic?: string;
+    /** Friendly exchange name (e.g., "NASDAQ" instead of "NMS" or "XNAS") */
+    exchangeName?: string;
+    /** Currency derived from exchange (e.g., "USD", "CAD") */
+    currency?: string;
     shortName: string;
     quoteType: string;
     symbol: string;
@@ -185,9 +310,13 @@ export interface QuoteSummary {
     score: number;
     typeDisplay: string;
     longName: string;
-    sector?: string;
-    industry?: string;
-    dataSource?: boolean;
+    dataSource?: string;
+    /** Asset kind for custom assets (e.g., "INVESTMENT", "OTHER") */
+    assetKind?: string;
+    /** True if this asset already exists in user's database */
+    isExisting?: boolean;
+    /** The existing asset ID if found */
+    existingAssetId?: string;
 }
 export interface MarketDataProviderInfo {
     id: string;
@@ -195,16 +324,6 @@ export interface MarketDataProviderInfo {
     logoFilename: string;
     lastSyncedDate: string | null;
 }
-export interface MarketData {
-    createdAt: Date;
-    dataSource: string;
-    date: Date;
-    id: string;
-    marketPrice: number;
-    state: 'CLOSE';
-    symbol: string;
-    symbolProfileId: string;
-}
 export interface Tag {
     id: string;
     name: string;
@@ -224,25 +343,44 @@ export type ValidationResult = {
     status: 'error';
     errors: string[];
 };
-export interface Sector {
-    name: string;
-    weight: number;
-}
-export interface Country {
-    name: string;
-    weight: number;
-}
 export interface Instrument {
     id: string;
     symbol: string;
     name?: string | null;
     currency: string;
     notes?: string | null;
-    dataSource?: string | null;
-    assetClass?: string | null;
-    assetSubclass?: string | null;
-    countries?: Country[] | null;
-    sectors?: Sector[] | null;
+    quoteMode: QuoteMode;
+    preferredProvider?: string | null;
+    classifications?: AssetClassifications | null;
+}
+export interface AssetClassifications {
+    assetType?: TaxonomyCategory | null;
+    riskCategory?: TaxonomyCategory | null;
+    assetClasses: CategoryWithWeight[];
+    sectors: CategoryWithWeight[];
+    regions: CategoryWithWeight[];
+    customGroups: CategoryWithWeight[];
+}
+export interface TaxonomyCategory {
+    id: string;
+    taxonomyId: string;
+    parentId?: string | null;
+    name: string;
+    key: string;
+    color: string;
+    description?: string | null;
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CategoryRef {
+    id: string;
+    name: string;
+}
+export interface CategoryWithWeight {
+    category: TaxonomyCategory;
+    topLevelCategory: CategoryRef;
+    weight: number;
 }
 export interface MonetaryValue {
     local: number;
@@ -280,6 +418,7 @@ export interface Holding {
     holdingType: HoldingType;
     accountId: string;
     instrument?: Instrument | null;
+    assetKind?: AssetKind | null;
     quantity: number;
     openDate?: string | Date | null;
     lots?: Lot[] | null;
@@ -301,33 +440,35 @@ export interface Holding {
     weight: number;
     asOfDate: string;
 }
+/**
+ * Asset interface matching the v3 backend model.
+ * Identity is opaque (UUID). Classification is via `kind` and `instrumentType`.
+ */
 export interface Asset {
     id: string;
-    isin?: string | null;
+    kind: AssetKind;
     name?: string | null;
-    assetType?: string | null;
-    symbol: string;
-    symbolMapping?: string | null;
-    assetClass?: string | null;
-    assetSubClass?: string | null;
+    displayCode?: string | null;
     notes?: string | null;
-    countries?: string | null;
-    categories?: string | null;
-    classes?: string | null;
-    attributes?: string | null;
+    metadata?: Record<string, unknown>;
+    isActive?: boolean;
+    quoteMode: QuoteMode;
+    quoteCcy: string;
+    instrumentType?: string | null;
+    instrumentSymbol?: string | null;
+    instrumentExchangeMic?: string | null;
+    instrumentKey?: string | null;
+    providerConfig?: Record<string, unknown> | null;
+    exchangeName?: string | null;
     createdAt: string;
     updatedAt: string;
-    currency: string;
-    dataSource: string;
-    sectors?: string | null;
-    url?: string | null;
 }
 export interface Quote {
     id: string;
     createdAt: string;
     dataSource: string;
     timestamp: string;
-    symbol: string;
+    assetId: string;
     open: number;
     high: number;
     low: number;
@@ -335,10 +476,11 @@ export interface Quote {
     close: number;
     adjclose: number;
     currency: string;
+    notes?: string | null;
 }
 export interface QuoteUpdate {
     timestamp: string;
-    symbol: string;
+    assetId: string;
     open: number;
     high: number;
     low: number;
@@ -350,16 +492,11 @@ export interface Settings {
     theme: string;
     font: string;
     baseCurrency: string;
+    instanceId: string;
     onboardingCompleted: boolean;
     autoUpdateCheckEnabled: boolean;
-}
-export interface SettingsContextType {
-    settings: Settings | null;
-    isLoading: boolean;
-    isError: boolean;
-    updateBaseCurrency: (currency: Settings['baseCurrency']) => Promise<void>;
-    accountsGrouped: boolean;
-    setAccountsGrouped: (value: boolean) => void;
+    menuBarVisible: boolean;
+    syncEnabled: boolean;
 }
 export interface Goal {
     id: string;
@@ -382,11 +519,18 @@ export interface GoalProgress {
     progress: number;
     currency: string;
 }
+export interface IncomeByAsset {
+    assetId: string;
+    kind: AssetKind;
+    symbol: string;
+    name: string;
+    income: number;
+}
 export interface IncomeSummary {
     period: string;
     byMonth: Record<string, number>;
     byType: Record<string, number>;
-    bySymbol: Record<string, number>;
+    byAsset: Record<string, IncomeByAsset>;
     byCurrency: Record<string, number>;
     totalIncome: number;
     currency: string;
@@ -487,27 +631,83 @@ export interface PerformanceMetrics {
     periodStartDate?: string | null;
     periodEndDate?: string | null;
     currency: string;
-    cumulativeTwr: number;
+    /** Period gain in dollars (SOTA: change in unrealized P&L for HOLDINGS mode) */
+    periodGain: number;
+    /** Period return percentage (SOTA formula for HOLDINGS mode) */
+    periodReturn: number;
+    /** Time-weighted return (null for HOLDINGS mode - requires cash flow tracking) */
+    cumulativeTwr?: number | null;
+    /** Legacy field for backward compatibility */
     gainLossAmount?: number | null;
-    annualizedTwr: number;
+    /** Annualized TWR (null for HOLDINGS mode) */
+    annualizedTwr?: number | null;
     simpleReturn: number;
     annualizedSimpleReturn: number;
-    cumulativeMwr: number;
-    annualizedMwr: number;
+    /** Money-weighted return (null for HOLDINGS mode - requires cash flow tracking) */
+    cumulativeMwr?: number | null;
+    /** Annualized MWR (null for HOLDINGS mode) */
+    annualizedMwr?: number | null;
     volatility: number;
     maxDrawdown: number;
+    /** Indicates if this is a HOLDINGS mode account (no cash flow tracking) */
+    isHoldingsMode?: boolean;
 }
 export interface UpdateAssetProfile {
-    symbol: string;
-    name?: string;
-    sectors: string;
-    countries: string;
-    notes: string;
-    assetClass: string;
-    assetSubClass: string;
+    id: string;
+    displayCode?: string | null;
+    name?: string | null;
+    notes?: string | null;
+    kind?: AssetKind | null;
+    quoteMode?: QuoteMode | null;
+    providerConfig?: Record<string, unknown> | null;
 }
 export interface TrackedItem {
     id: string;
     type: 'account' | 'symbol';
     name: string;
 }
+export type ImportRunType = 'SYNC' | 'IMPORT';
+export type ImportRunMode = 'INITIAL' | 'INCREMENTAL' | 'BACKFILL' | 'REPAIR';
+export type ImportRunStatus = 'RUNNING' | 'APPLIED' | 'NEEDS_REVIEW' | 'FAILED' | 'CANCELLED';
+export type ReviewMode = 'NEVER' | 'ALWAYS' | 'IF_WARNINGS';
+export interface ImportRunSummary {
+    fetched: number;
+    inserted: number;
+    updated: number;
+    skipped: number;
+    warnings: number;
+    errors: number;
+    removed: number;
+}
+export interface ImportRun {
+    id: string;
+    accountId: string;
+    sourceSystem: string;
+    runType: ImportRunType;
+    mode: ImportRunMode;
+    status: ImportRunStatus;
+    startedAt: string;
+    finishedAt?: string;
+    reviewMode: ReviewMode;
+    appliedAt?: string;
+    checkpointIn?: Record<string, unknown>;
+    checkpointOut?: Record<string, unknown>;
+    summary?: ImportRunSummary;
+    warnings?: string[];
+    error?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export type SyncStatus = 'IDLE' | 'RUNNING' | 'NEEDS_REVIEW' | 'FAILED';
+export interface BrokerSyncState {
+    accountId: string;
+    provider: string;
+    checkpointJson?: Record<string, unknown>;
+    lastAttemptedAt?: string;
+    lastSuccessfulAt?: string;
+    lastError?: string;
+    lastRunId?: string;
+    syncStatus: SyncStatus;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/src/goal-progress.d.ts

@@ -0,0 +1,7 @@
+import type { Goal, GoalAllocation, AccountValuation, GoalProgress } from './data-types';
+/**
+ * Calculate goal progress using allocations.
+ * Converts account values to base currency, applies percent allocation per account,
+ * and computes progress ratio (0–1+) against target amount.
+ */
+export declare function calculateGoalProgress(accountsValuations: AccountValuation[], goals: Goal[], allocations: GoalAllocation[]): GoalProgress[];