@cranberry-money/shared-utils 8.2.0 → 8.3.0

package/dist/dashboard.d.ts

@@ -0,0 +1,72 @@
+import type { AssetAllocation, AssetHolding } from '@cranberry-money/shared-types';
+/**
+ * Display item interface for allocation data
+ */
+export interface AllocationDisplayItem {
+    readonly instrumentUuid: string;
+    readonly symbol: string;
+    readonly name: string;
+    readonly targetPercentage?: number;
+    readonly actualPercentage?: number;
+    readonly quantity?: number;
+    readonly value?: number;
+    readonly currentPrice?: number;
+    readonly color: string;
+    readonly hasTarget: boolean;
+    readonly hasActual: boolean;
+}
+/**
+ * Processes allocation and holding data for dashboard display
+ * Merges target allocations with actual holdings data
+ *
+ * @param allocations - Target asset allocations
+ * @param holdings - Actual asset holdings
+ * @returns Array of display items sorted by target/actual percentage
+ *
+ * @example
+ * const allocations = [{ instrument: '123', percentage: '50.00', ... }];
+ * const holdings = [{ instrument: { uuid: '123' }, quantity: 100, ... }];
+ * processAllocationData(allocations, holdings);
+ */
+export declare const processAllocationData: (allocations: readonly AssetAllocation[], holdings: readonly AssetHolding[]) => AllocationDisplayItem[];
+/**
+ * Calculates totals from allocation display items
+ *
+ * @param items - Array of allocation display items
+ * @returns Object with total calculations
+ *
+ * @example
+ * const items = [{ targetPercentage: 50, actualPercentage: 45, value: 1000, quantity: 10 }];
+ * calculateTotals(items);
+ * // returns { totalTarget: 50, totalActual: 45, totalValue: 1000, totalQuantity: 10 }
+ */
+export declare const calculateTotals: (items: readonly AllocationDisplayItem[]) => {
+    totalTarget: number;
+    totalActual: number;
+    totalValue: number;
+    totalQuantity: number;
+};
+/**
+ * Formats a percentage value for display
+ *
+ * @param value - The percentage value to format
+ * @returns Formatted percentage string
+ *
+ * @example
+ * formatPercentage(45.678); // returns "45.7%"
+ * formatPercentage(undefined); // returns "0.0%"
+ */
+export declare const formatPercentage: (value?: number) => string;
+/**
+ * Formats currency value for dashboard display
+ *
+ * @param value - The numeric value to format
+ * @param currency - Currency code (defaults to DEFAULT_CURRENCY)
+ * @returns Formatted currency string or "—" for undefined values
+ *
+ * @example
+ * formatDashboardCurrency(1234.56); // returns "$1,234.56"
+ * formatDashboardCurrency(undefined); // returns "—"
+ */
+export declare const formatDashboardCurrency: (value?: number, currency?: string) => string;
+//# sourceMappingURL=dashboard.d.ts.map

package/dist/dashboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../src/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAMnF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GAChC,aAAa,SAAS,eAAe,EAAE,EACvC,UAAU,SAAS,YAAY,EAAE,KAChC,qBAAqB,EAwEvB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,SAAS,qBAAqB,EAAE;;;;;CAOtE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,KAAG,MAGjD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,MAAM,EAAE,WAAU,MAAyB,KAAG,MAG7F,CAAC"}

package/dist/dashboard.js

@@ -0,0 +1,121 @@
+import { DEFAULT_CURRENCY } from '@cranberry-money/shared-constants';
+import { getChartColor } from '@cranberry-money/shared-constants';
+import { formatCurrencyWithCode } from './currency';
+import { calculateHoldingAllocations } from './holdings';
+/**
+ * Processes allocation and holding data for dashboard display
+ * Merges target allocations with actual holdings data
+ *
+ * @param allocations - Target asset allocations
+ * @param holdings - Actual asset holdings
+ * @returns Array of display items sorted by target/actual percentage
+ *
+ * @example
+ * const allocations = [{ instrument: '123', percentage: '50.00', ... }];
+ * const holdings = [{ instrument: { uuid: '123' }, quantity: 100, ... }];
+ * processAllocationData(allocations, holdings);
+ */
+export const processAllocationData = (allocations, holdings) => {
+    const actualAllocations = calculateHoldingAllocations(holdings);
+    const instrumentMap = new Map();
+    // Process target allocations
+    allocations.forEach((allocation) => {
+        instrumentMap.set(allocation.instrument, {
+            symbol: allocation.instrumentSymbol,
+            name: allocation.instrumentName,
+            targetPercentage: parseFloat(allocation.percentage),
+        });
+    });
+    // Process actual holdings
+    holdings.forEach((holding) => {
+        const existing = instrumentMap.get(holding.instrument.uuid);
+        const currentPrice = parseFloat(holding.instrument.currentPrice || '0');
+        const value = holding.quantity * currentPrice;
+        instrumentMap.set(holding.instrument.uuid, {
+            symbol: holding.instrumentSymbol,
+            name: holding.instrumentName,
+            targetPercentage: existing?.targetPercentage,
+            actualPercentage: actualAllocations[holding.instrument.uuid] || 0,
+            quantity: holding.quantity,
+            currentPrice,
+            value,
+        });
+    });
+    // Convert to display items
+    const items = [];
+    let colorIndex = 0;
+    instrumentMap.forEach((data, instrumentUuid) => {
+        items.push({
+            instrumentUuid,
+            symbol: data.symbol,
+            name: data.name,
+            targetPercentage: data.targetPercentage,
+            actualPercentage: data.actualPercentage,
+            quantity: data.quantity,
+            currentPrice: data.currentPrice,
+            value: data.value,
+            color: getChartColor(colorIndex++),
+            hasTarget: data.targetPercentage !== undefined,
+            hasActual: data.actualPercentage !== undefined && data.actualPercentage > 0,
+        });
+    });
+    // Sort by target percentage (highest first), then by actual percentage
+    return items.sort((a, b) => {
+        const aTarget = a.targetPercentage || 0;
+        const bTarget = b.targetPercentage || 0;
+        if (aTarget !== bTarget)
+            return bTarget - aTarget;
+        const aActual = a.actualPercentage || 0;
+        const bActual = b.actualPercentage || 0;
+        return bActual - aActual;
+    });
+};
+/**
+ * Calculates totals from allocation display items
+ *
+ * @param items - Array of allocation display items
+ * @returns Object with total calculations
+ *
+ * @example
+ * const items = [{ targetPercentage: 50, actualPercentage: 45, value: 1000, quantity: 10 }];
+ * calculateTotals(items);
+ * // returns { totalTarget: 50, totalActual: 45, totalValue: 1000, totalQuantity: 10 }
+ */
+export const calculateTotals = (items) => {
+    const totalTarget = items.reduce((sum, item) => sum + (item.targetPercentage || 0), 0);
+    const totalActual = items.reduce((sum, item) => sum + (item.actualPercentage || 0), 0);
+    const totalValue = items.reduce((sum, item) => sum + (item.value || 0), 0);
+    const totalQuantity = items.reduce((sum, item) => sum + (item.quantity || 0), 0);
+    return { totalTarget, totalActual, totalValue, totalQuantity };
+};
+/**
+ * Formats a percentage value for display
+ *
+ * @param value - The percentage value to format
+ * @returns Formatted percentage string
+ *
+ * @example
+ * formatPercentage(45.678); // returns "45.7%"
+ * formatPercentage(undefined); // returns "0.0%"
+ */
+export const formatPercentage = (value) => {
+    if (value === undefined)
+        return '0.0%';
+    return `${value.toFixed(1)}%`;
+};
+/**
+ * Formats currency value for dashboard display
+ *
+ * @param value - The numeric value to format
+ * @param currency - Currency code (defaults to DEFAULT_CURRENCY)
+ * @returns Formatted currency string or "—" for undefined values
+ *
+ * @example
+ * formatDashboardCurrency(1234.56); // returns "$1,234.56"
+ * formatDashboardCurrency(undefined); // returns "—"
+ */
+export const formatDashboardCurrency = (value, currency = DEFAULT_CURRENCY) => {
+    if (value === undefined || value === null)
+        return '—';
+    return formatCurrencyWithCode(value, currency, 'en-AU', 2, 2);
+};

package/dist/index.d.ts

@@ -21,4 +21,5 @@ export { capitalizeFirstLetter, formatStatus, formatRiskLevel, capitalizeFirst,
 export { formatQuantityWithSuffix, formatLargeNumber, formatAsPercentage, formatWithSeparators, roundToDecimals, clampNumber, } from './numbers';
 export { validateAllocations } from './allocations';
 export { calculatePortfolioValue, calculateHoldingAllocations, groupHoldingsByInstrument, filterHoldingsByMinQuantity, sortHoldings, } from './holdings';
+export { processAllocationData, calculateTotals, formatPercentage, formatDashboardCurrency, type AllocationDisplayItem, } from './dashboard';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAGjF,OAAO,EACL,8BAA8B,EAC9B,qCAAqC,EACrC,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,GACb,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGnE,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhH,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,UAAU,EAEV,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,qBAAqB,EAErB,0BAA0B,EAC1B,4BAA4B,EAC5B,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,WAAW,CAAC;AAGnB,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,YAAY,EACZ,aAAa,GACd,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,eAAe,EACf,eAAe,GAChB,MAAM,aAAa,CAAC;AAGrB,OAAO,EACL,qBAAqB,EACrB,YAAY,EACZ,eAAe,EACf,eAAe,EACf,WAAW,EACX,YAAY,GACb,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,WAAW,GACZ,MAAM,WAAW,CAAC;AAGnB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,YAAY,GACb,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAGjF,OAAO,EACL,8BAA8B,EAC9B,qCAAqC,EACrC,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,YAAY,GACb,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGnE,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhH,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,UAAU,EAEV,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,iBAAiB,GAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,qBAAqB,EAErB,0BAA0B,EAC1B,4BAA4B,EAC5B,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,WAAW,CAAC;AAGnB,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,YAAY,EACZ,aAAa,GACd,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,eAAe,EACf,eAAe,GAChB,MAAM,aAAa,CAAC;AAGrB,OAAO,EACL,qBAAqB,EACrB,YAAY,EACZ,eAAe,EACf,eAAe,EACf,WAAW,EACX,YAAY,GACb,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,wBAAwB,EACxB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,WAAW,GACZ,MAAM,WAAW,CAAC;AAGnB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,YAAY,GACb,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,KAAK,qBAAqB,GAC3B,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -42,3 +42,5 @@ export { formatQuantityWithSuffix, formatLargeNumber, formatAsPercentage, format
 export { validateAllocations } from './allocations';
 // Holdings utilities
 export { calculatePortfolioValue, calculateHoldingAllocations, groupHoldingsByInstrument, filterHoldingsByMinQuantity, sortHoldings, } from './holdings';
+// Dashboard utilities
+export { processAllocationData, calculateTotals, formatPercentage, formatDashboardCurrency, } from './dashboard';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cranberry-money/shared-utils",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "description": "Shared utility functions for MyPortfolio platform",
   "type": "module",
   "main": "dist/index.js",