@cranberry-money/shared-utils 4.5.0 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"badge-status.d.ts","sourceRoot":"","sources":["../src/badge-status.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EAKnB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,EAM3B,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,sCAAsC,EACtC,yCAAyC,EACzC,2BAA2B,EAC3B,2BAA2B,EAC3B,wBAAwB,EAUxB,0BAA0B,EAC1B,iCAAiC,EACjC,2BAA2B,EAC3B,0BAA0B,EAC1B,yBAAyB,EAM1B,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EAAgB,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,OAAO,qBAAqB,GAC5B,OAAO,oBAAoB,GAC3B,OAAO,sBAAsB,GAC7B,OAAO,mBAAmB,GAC1B,OAAO,2BAA2B,GAClC,OAAO,6BAA6B,GACpC,OAAO,2BAA2B,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,OAAO,gCAAgC,GACvC,OAAO,0BAA0B,GACjC,OAAO,0BAA0B,GACjC,OAAO,4BAA4B,GACnC,OAAO,sCAAsC,GAC7C,OAAO,yCAAyC,GAChD,OAAO,2BAA2B,GAClC,OAAO,2BAA2B,GAClC,OAAO,wBAAwB,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,OAAO,0BAA0B,GACjC,OAAO,iCAAiC,GACxC,OAAO,2BAA2B,GAClC,OAAO,0BAA0B,GACjC,OAAO,yBAAyB,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,OAAO,2BAA2B,GAClC,OAAO,4BAA4B,GACnC,OAAO,6BAA6B,GACpC,OAAO,6BAA6B,GACpC,OAAO,2BAA2B,CAAC;AAgFvC;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,WAAW,EACnB,IAAI,GAAE,SAAgB,GACrB,gBAAgB,CAUlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,gBAAgB,EACxB,IAAI,GAAE,SAAgB,GACrB,gBAAgB,CAUlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,iBAAiB,EACzB,IAAI,GAAE,SAAgB,GACrB,gBAAgB,CAUlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,iBAAiB,EACzB,IAAI,GAAE,SAAgB,GACrB,gBAAgB,CAUlB"}
1
+ {"version":3,"file":"badge-status.d.ts","sourceRoot":"","sources":["../src/badge-status.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EAKnB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,EAM3B,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,sCAAsC,EACtC,yCAAyC,EACzC,2BAA2B,EAC3B,2BAA2B,EAC3B,wBAAwB,EAUxB,0BAA0B,EAC1B,iCAAiC,EACjC,2BAA2B,EAC3B,0BAA0B,EAC1B,yBAAyB,EAM1B,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EAAgB,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,OAAO,qBAAqB,GAC5B,OAAO,oBAAoB,GAC3B,OAAO,sBAAsB,GAC7B,OAAO,mBAAmB,GAC1B,OAAO,2BAA2B,GAClC,OAAO,6BAA6B,GACpC,OAAO,2BAA2B,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,OAAO,gCAAgC,GACvC,OAAO,0BAA0B,GACjC,OAAO,0BAA0B,GACjC,OAAO,4BAA4B,GACnC,OAAO,sCAAsC,GAC7C,OAAO,yCAAyC,GAChD,OAAO,2BAA2B,GAClC,OAAO,2BAA2B,GAClC,OAAO,wBAAwB,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,OAAO,0BAA0B,GACjC,OAAO,iCAAiC,GACxC,OAAO,2BAA2B,GAClC,OAAO,0BAA0B,GACjC,OAAO,yBAAyB,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,OAAO,2BAA2B,GAClC,OAAO,4BAA4B,GACnC,OAAO,6BAA6B,GACpC,OAAO,6BAA6B,GACpC,OAAO,2BAA2B,CAAC;AAgFvC;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,GAAE,SAAgB,GAAG,gBAAgB,CAUjG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,GAAE,SAAgB,GAAG,gBAAgB,CAU3G;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,GAAE,SAAgB,GAAG,gBAAgB,CAU7G;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,GAAE,SAAgB,GAAG,gBAAgB,CAU7G"}
package/dist/index.d.ts CHANGED
@@ -9,6 +9,7 @@ export { formatDate, formatShortDate, formatTime, formatDateTime } from './date'
9
9
  export { NUMBER_FORMAT_OPTIONS_CURRENCY, NUMBER_FORMAT_OPTIONS_CURRENCY_SIGNED, formatCurrency, parseCurrencyInput, formatCurrencyWithCode, formatDefaultCurrency, formatShares, } from './currency';
10
10
  export type { BadgeVariant, BadgeSize, BadgeConfig, BadgeStyle } from './badge';
11
11
  export { createBadge, BADGE_VARIANTS, BADGE_SIZES } from './badge';
12
- export type { StatusBadgeStyle, TradeStatus, WithdrawalStatus, LiquidationStatus, TargetTradeStatus } from './badge-status';
12
+ export type { StatusBadgeStyle, TradeStatus, WithdrawalStatus, LiquidationStatus, TargetTradeStatus, } from './badge-status';
13
13
  export { getTradeStatusBadge, getWithdrawalStatusBadge, getLiquidationStatusBadge, getTargetTradeStatusBadge, } from './badge-status';
14
+ export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation, } from './portfolio';
14
15
  //# sourceMappingURL=index.d.ts.map
@@ -1 +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,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGnE,YAAY,EACV,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC"}
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,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGnE,YAAY,EACV,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,aAAa,CAAC"}
package/dist/index.js CHANGED
@@ -12,3 +12,5 @@ export { formatDate, formatShortDate, formatTime, formatDateTime } from './date'
12
12
  export { NUMBER_FORMAT_OPTIONS_CURRENCY, NUMBER_FORMAT_OPTIONS_CURRENCY_SIGNED, formatCurrency, parseCurrencyInput, formatCurrencyWithCode, formatDefaultCurrency, formatShares, } from './currency';
13
13
  export { createBadge, BADGE_VARIANTS, BADGE_SIZES } from './badge';
14
14
  export { getTradeStatusBadge, getWithdrawalStatusBadge, getLiquidationStatusBadge, getTargetTradeStatusBadge, } from './badge-status';
15
+ // Portfolio utilities
16
+ export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation, } from './portfolio';
@@ -0,0 +1,68 @@
1
+ /**
2
+ * Portfolio calculation and formatting utilities
3
+ *
4
+ * This module provides pure functions for portfolio value calculations,
5
+ * allocations, and formatting. All functions handle string or number inputs
6
+ * for flexibility with API responses.
7
+ */
8
+ /**
9
+ * Formats a portfolio value as currency with AUD
10
+ *
11
+ * @param value - Portfolio value as string or number
12
+ * @returns Formatted currency string with AUD symbol
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * formatPortfolioValue(12345.67) // 'A$12,345.67'
17
+ * formatPortfolioValue('12345.67') // 'A$12,345.67'
18
+ * ```
19
+ */
20
+ export declare function formatPortfolioValue(value: string | number): string;
21
+ /**
22
+ * Calculates total portfolio value from market value and cash balance
23
+ *
24
+ * @param marketValue - Market value of holdings
25
+ * @param cashBalance - Cash balance in portfolio
26
+ * @returns Total portfolio value as number
27
+ *
28
+ * @example
29
+ * ```typescript
30
+ * calculateTotalValue(10000, 5000) // 15000
31
+ * calculateTotalValue('10000', '5000') // 15000
32
+ * calculateTotalValue('10000.50', 5000.25) // 15000.75
33
+ * ```
34
+ */
35
+ export declare function calculateTotalValue(marketValue: string | number, cashBalance: string | number): number;
36
+ /**
37
+ * Calculates market allocation percentage in portfolio
38
+ *
39
+ * @param marketValue - Market value of holdings
40
+ * @param totalValue - Total portfolio value
41
+ * @returns Market allocation percentage (0-100)
42
+ *
43
+ * @example
44
+ * ```typescript
45
+ * getMarketAllocation(7500, 10000) // 75
46
+ * getMarketAllocation('7500', '10000') // 75
47
+ * getMarketAllocation(0, 10000) // 0
48
+ * getMarketAllocation(100, 0) // 0 (prevents division by zero)
49
+ * ```
50
+ */
51
+ export declare function getMarketAllocation(marketValue: string | number, totalValue: string | number): number;
52
+ /**
53
+ * Calculates cash allocation percentage in portfolio
54
+ *
55
+ * @param cashBalance - Cash balance in portfolio
56
+ * @param totalValue - Total portfolio value
57
+ * @returns Cash allocation percentage (0-100)
58
+ *
59
+ * @example
60
+ * ```typescript
61
+ * getCashAllocation(2500, 10000) // 25
62
+ * getCashAllocation('2500', '10000') // 25
63
+ * getCashAllocation(0, 10000) // 0
64
+ * getCashAllocation(100, 0) // 0 (prevents division by zero)
65
+ * ```
66
+ */
67
+ export declare function getCashAllocation(cashBalance: string | number, totalValue: string | number): number;
68
+ //# sourceMappingURL=portfolio.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../src/portfolio.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAMnE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAItG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAIrG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAInG"}
@@ -0,0 +1,87 @@
1
+ /**
2
+ * Portfolio calculation and formatting utilities
3
+ *
4
+ * This module provides pure functions for portfolio value calculations,
5
+ * allocations, and formatting. All functions handle string or number inputs
6
+ * for flexibility with API responses.
7
+ */
8
+ import { LOCALE_AUSTRALIA, DEFAULT_NUMERIC_ZERO, DEFAULT_EMPTY_STRING, CURRENCY_AUD } from '@cranberry-money/shared-constants';
9
+ import { NUMBER_FORMAT_OPTIONS_CURRENCY } from './currency';
10
+ /**
11
+ * Formats a portfolio value as currency with AUD
12
+ *
13
+ * @param value - Portfolio value as string or number
14
+ * @returns Formatted currency string with AUD symbol
15
+ *
16
+ * @example
17
+ * ```typescript
18
+ * formatPortfolioValue(12345.67) // 'A$12,345.67'
19
+ * formatPortfolioValue('12345.67') // 'A$12,345.67'
20
+ * ```
21
+ */
22
+ export function formatPortfolioValue(value) {
23
+ const numValue = typeof value === 'string' ? parseFloat(value) : value;
24
+ return new Intl.NumberFormat(LOCALE_AUSTRALIA, {
25
+ ...NUMBER_FORMAT_OPTIONS_CURRENCY,
26
+ currency: CURRENCY_AUD,
27
+ }).format(numValue);
28
+ }
29
+ /**
30
+ * Calculates total portfolio value from market value and cash balance
31
+ *
32
+ * @param marketValue - Market value of holdings
33
+ * @param cashBalance - Cash balance in portfolio
34
+ * @returns Total portfolio value as number
35
+ *
36
+ * @example
37
+ * ```typescript
38
+ * calculateTotalValue(10000, 5000) // 15000
39
+ * calculateTotalValue('10000', '5000') // 15000
40
+ * calculateTotalValue('10000.50', 5000.25) // 15000.75
41
+ * ```
42
+ */
43
+ export function calculateTotalValue(marketValue, cashBalance) {
44
+ const market = typeof marketValue === 'string' ? parseFloat(marketValue || DEFAULT_EMPTY_STRING) : marketValue;
45
+ const cash = typeof cashBalance === 'string' ? parseFloat(cashBalance || DEFAULT_EMPTY_STRING) : cashBalance;
46
+ return market + cash;
47
+ }
48
+ /**
49
+ * Calculates market allocation percentage in portfolio
50
+ *
51
+ * @param marketValue - Market value of holdings
52
+ * @param totalValue - Total portfolio value
53
+ * @returns Market allocation percentage (0-100)
54
+ *
55
+ * @example
56
+ * ```typescript
57
+ * getMarketAllocation(7500, 10000) // 75
58
+ * getMarketAllocation('7500', '10000') // 75
59
+ * getMarketAllocation(0, 10000) // 0
60
+ * getMarketAllocation(100, 0) // 0 (prevents division by zero)
61
+ * ```
62
+ */
63
+ export function getMarketAllocation(marketValue, totalValue) {
64
+ const market = typeof marketValue === 'string' ? parseFloat(marketValue || DEFAULT_EMPTY_STRING) : marketValue;
65
+ const total = typeof totalValue === 'string' ? parseFloat(totalValue || DEFAULT_EMPTY_STRING) : totalValue;
66
+ return total > DEFAULT_NUMERIC_ZERO ? (market / total) * 100 : DEFAULT_NUMERIC_ZERO;
67
+ }
68
+ /**
69
+ * Calculates cash allocation percentage in portfolio
70
+ *
71
+ * @param cashBalance - Cash balance in portfolio
72
+ * @param totalValue - Total portfolio value
73
+ * @returns Cash allocation percentage (0-100)
74
+ *
75
+ * @example
76
+ * ```typescript
77
+ * getCashAllocation(2500, 10000) // 25
78
+ * getCashAllocation('2500', '10000') // 25
79
+ * getCashAllocation(0, 10000) // 0
80
+ * getCashAllocation(100, 0) // 0 (prevents division by zero)
81
+ * ```
82
+ */
83
+ export function getCashAllocation(cashBalance, totalValue) {
84
+ const cash = typeof cashBalance === 'string' ? parseFloat(cashBalance || DEFAULT_EMPTY_STRING) : cashBalance;
85
+ const total = typeof totalValue === 'string' ? parseFloat(totalValue || DEFAULT_EMPTY_STRING) : totalValue;
86
+ return total > DEFAULT_NUMERIC_ZERO ? (cash / total) * 100 : DEFAULT_NUMERIC_ZERO;
87
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cranberry-money/shared-utils",
3
- "version": "4.5.0",
3
+ "version": "4.6.0",
4
4
  "description": "Shared utility functions for MyPortfolio platform",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",