@cranberry-money/shared-utils 4.6.0 → 4.7.0

package/dist/index.d.ts

@@ -11,5 +11,7 @@ export type { BadgeVariant, BadgeSize, BadgeConfig, BadgeStyle } from './badge';
 export { createBadge, BADGE_VARIANTS, BADGE_SIZES } from './badge';
 export type { StatusBadgeStyle, TradeStatus, WithdrawalStatus, LiquidationStatus, TargetTradeStatus, } from './badge-status';
 export { getTradeStatusBadge, getWithdrawalStatusBadge, getLiquidationStatusBadge, getTargetTradeStatusBadge, } from './badge-status';
-export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation, } from './portfolio';
+export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation } from './portfolio';
+export type { LiquidationProgress } from './withdrawal';
+export { formatWithdrawalAmount, formatLiquidationValue, formatSharesQuantity, calculateLiquidationProgress, getTotalEstimatedValue, } from './withdrawal';
 //# 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,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"}
+{"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,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhH,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -13,4 +13,5 @@ export { NUMBER_FORMAT_OPTIONS_CURRENCY, NUMBER_FORMAT_OPTIONS_CURRENCY_SIGNED,
 export { createBadge, BADGE_VARIANTS, BADGE_SIZES } from './badge';
 export { getTradeStatusBadge, getWithdrawalStatusBadge, getLiquidationStatusBadge, getTargetTradeStatusBadge, } from './badge-status';
 // Portfolio utilities
-export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation, } from './portfolio';
+export { formatPortfolioValue, calculateTotalValue, getMarketAllocation, getCashAllocation } from './portfolio';
+export { formatWithdrawalAmount, formatLiquidationValue, formatSharesQuantity, calculateLiquidationProgress, getTotalEstimatedValue, } from './withdrawal';

package/dist/portfolio.d.ts.map

@@ -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"}
+{"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../src/portfolio.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAUH;;;;;;;;;;;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"}

package/dist/portfolio.js

@@ -5,7 +5,7 @@
  * allocations, and formatting. All functions handle string or number inputs
  * for flexibility with API responses.
  */
-import { LOCALE_AUSTRALIA, DEFAULT_NUMERIC_ZERO, DEFAULT_EMPTY_STRING, CURRENCY_AUD } from '@cranberry-money/shared-constants';
+import { LOCALE_AUSTRALIA, DEFAULT_NUMERIC_ZERO, DEFAULT_EMPTY_STRING, CURRENCY_AUD, } from '@cranberry-money/shared-constants';
 import { NUMBER_FORMAT_OPTIONS_CURRENCY } from './currency';
 /**
  * Formats a portfolio value as currency with AUD

package/dist/withdrawal.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Withdrawal-related utility functions
+ *
+ * This module provides pure functions for formatting withdrawal amounts,
+ * calculating liquidation progress, and other withdrawal-related operations.
+ * Functions are designed to work with generic types to maintain flexibility.
+ */
+/**
+ * Formats a withdrawal amount as currency
+ *
+ * @param amount - Withdrawal amount as string or number
+ * @returns Formatted currency string with AUD symbol
+ *
+ * @example
+ * ```typescript
+ * formatWithdrawalAmount(5000) // 'A$5,000.00'
+ * formatWithdrawalAmount('5000.50') // 'A$5,000.50'
+ * ```
+ */
+export declare function formatWithdrawalAmount(amount: string | number): string;
+/**
+ * Formats a liquidation value as currency
+ *
+ * @param value - Liquidation value as string or number
+ * @returns Formatted currency string with AUD symbol
+ *
+ * @example
+ * ```typescript
+ * formatLiquidationValue(10000) // 'A$10,000.00'
+ * formatLiquidationValue('10000.50') // 'A$10,000.50'
+ * ```
+ */
+export declare function formatLiquidationValue(value: string | number): string;
+/**
+ * Formats share quantity without decimal places
+ *
+ * @param shares - Number of shares
+ * @returns Formatted number string with thousands separators
+ *
+ * @example
+ * ```typescript
+ * formatSharesQuantity(1234) // '1,234'
+ * formatSharesQuantity(1234567) // '1,234,567'
+ * ```
+ */
+export declare function formatSharesQuantity(shares: number): string;
+/**
+ * Progress calculation result for liquidations
+ */
+export interface LiquidationProgress {
+    total: number;
+    pending: number;
+    inProgress: number;
+    completed: number;
+    failed: number;
+    completionRate: number;
+}
+/**
+ * Calculates liquidation progress statistics
+ *
+ * @param liquidations - Array of liquidation objects with liquidationStatus property
+ * @returns Progress statistics including counts and completion rate
+ *
+ * @example
+ * ```typescript
+ * const liquidations = [
+ *   { liquidationStatus: 'PENDING' },
+ *   { liquidationStatus: 'SETTLED' },
+ *   { liquidationStatus: 'FAILED' }
+ * ];
+ * calculateLiquidationProgress(liquidations)
+ * // Returns: { total: 3, pending: 1, inProgress: 0, completed: 1, failed: 1, completionRate: 33.33 }
+ * ```
+ */
+export declare function calculateLiquidationProgress<T extends {
+    liquidationStatus: string;
+}>(liquidations: T[]): LiquidationProgress;
+/**
+ * Calculates total estimated value from liquidations
+ *
+ * @param liquidations - Array of liquidation objects with estimatedValue property
+ * @returns Total estimated value as number
+ *
+ * @example
+ * ```typescript
+ * const liquidations = [
+ *   { estimatedValue: '1000.50' },
+ *   { estimatedValue: '2000' },
+ *   { estimatedValue: null }
+ * ];
+ * getTotalEstimatedValue(liquidations) // 3000.50
+ * ```
+ */
+export declare function getTotalEstimatedValue<T extends {
+    estimatedValue?: string | null;
+}>(liquidations: T[]): number;
+//# sourceMappingURL=withdrawal.d.ts.map

package/dist/withdrawal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal.d.ts","sourceRoot":"","sources":["../src/withdrawal.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAWH;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAMtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAMrE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAK3D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS;IAAE,iBAAiB,EAAE,MAAM,CAAA;CAAE,EAClF,YAAY,EAAE,CAAC,EAAE,GAChB,mBAAmB,CAkBrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS;IAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EACjF,YAAY,EAAE,CAAC,EAAE,GAChB,MAAM,CAIR"}

package/dist/withdrawal.js

@@ -0,0 +1,119 @@
+/**
+ * Withdrawal-related utility functions
+ *
+ * This module provides pure functions for formatting withdrawal amounts,
+ * calculating liquidation progress, and other withdrawal-related operations.
+ * Functions are designed to work with generic types to maintain flexibility.
+ */
+import { LOCALE_AUSTRALIA, CURRENCY_AUD, LIQUIDATION_STATUS_PENDING, LIQUIDATION_STATUS_TRADES_CREATED, LIQUIDATION_STATUS_EXECUTED, LIQUIDATION_STATUS_SETTLED, LIQUIDATION_STATUS_FAILED } from '@cranberry-money/shared-constants';
+import { NUMBER_FORMAT_OPTIONS_CURRENCY } from './currency';
+/**
+ * Formats a withdrawal amount as currency
+ *
+ * @param amount - Withdrawal amount as string or number
+ * @returns Formatted currency string with AUD symbol
+ *
+ * @example
+ * ```typescript
+ * formatWithdrawalAmount(5000) // 'A$5,000.00'
+ * formatWithdrawalAmount('5000.50') // 'A$5,000.50'
+ * ```
+ */
+export function formatWithdrawalAmount(amount) {
+    const numValue = typeof amount === 'string' ? parseFloat(amount) : amount;
+    return new Intl.NumberFormat(LOCALE_AUSTRALIA, {
+        ...NUMBER_FORMAT_OPTIONS_CURRENCY,
+        currency: CURRENCY_AUD,
+    }).format(numValue);
+}
+/**
+ * Formats a liquidation value as currency
+ *
+ * @param value - Liquidation value as string or number
+ * @returns Formatted currency string with AUD symbol
+ *
+ * @example
+ * ```typescript
+ * formatLiquidationValue(10000) // 'A$10,000.00'
+ * formatLiquidationValue('10000.50') // 'A$10,000.50'
+ * ```
+ */
+export function formatLiquidationValue(value) {
+    const numValue = typeof value === 'string' ? parseFloat(value) : value;
+    return new Intl.NumberFormat(LOCALE_AUSTRALIA, {
+        ...NUMBER_FORMAT_OPTIONS_CURRENCY,
+        currency: CURRENCY_AUD,
+    }).format(numValue);
+}
+/**
+ * Formats share quantity without decimal places
+ *
+ * @param shares - Number of shares
+ * @returns Formatted number string with thousands separators
+ *
+ * @example
+ * ```typescript
+ * formatSharesQuantity(1234) // '1,234'
+ * formatSharesQuantity(1234567) // '1,234,567'
+ * ```
+ */
+export function formatSharesQuantity(shares) {
+    return new Intl.NumberFormat(LOCALE_AUSTRALIA, {
+        minimumFractionDigits: 0,
+        maximumFractionDigits: 0,
+    }).format(shares);
+}
+/**
+ * Calculates liquidation progress statistics
+ *
+ * @param liquidations - Array of liquidation objects with liquidationStatus property
+ * @returns Progress statistics including counts and completion rate
+ *
+ * @example
+ * ```typescript
+ * const liquidations = [
+ *   { liquidationStatus: 'PENDING' },
+ *   { liquidationStatus: 'SETTLED' },
+ *   { liquidationStatus: 'FAILED' }
+ * ];
+ * calculateLiquidationProgress(liquidations)
+ * // Returns: { total: 3, pending: 1, inProgress: 0, completed: 1, failed: 1, completionRate: 33.33 }
+ * ```
+ */
+export function calculateLiquidationProgress(liquidations) {
+    const total = liquidations.length;
+    const pending = liquidations.filter((l) => l.liquidationStatus === LIQUIDATION_STATUS_PENDING).length;
+    const inProgress = liquidations.filter((l) => [LIQUIDATION_STATUS_TRADES_CREATED, LIQUIDATION_STATUS_EXECUTED].includes(l.liquidationStatus)).length;
+    const completed = liquidations.filter((l) => l.liquidationStatus === LIQUIDATION_STATUS_SETTLED).length;
+    const failed = liquidations.filter((l) => l.liquidationStatus === LIQUIDATION_STATUS_FAILED).length;
+    const completionRate = total > 0 ? (completed / total) * 100 : 0;
+    return {
+        total,
+        pending,
+        inProgress,
+        completed,
+        failed,
+        completionRate,
+    };
+}
+/**
+ * Calculates total estimated value from liquidations
+ *
+ * @param liquidations - Array of liquidation objects with estimatedValue property
+ * @returns Total estimated value as number
+ *
+ * @example
+ * ```typescript
+ * const liquidations = [
+ *   { estimatedValue: '1000.50' },
+ *   { estimatedValue: '2000' },
+ *   { estimatedValue: null }
+ * ];
+ * getTotalEstimatedValue(liquidations) // 3000.50
+ * ```
+ */
+export function getTotalEstimatedValue(liquidations) {
+    return liquidations.reduce((total, liquidation) => {
+        return total + parseFloat(liquidation.estimatedValue || '0');
+    }, 0);
+}

package/package.json

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