@cranberry-money/shared-utils 5.0.0 → 5.0.1

package/dist/withdrawal.js

@@ -1,119 +0,0 @@
-/**
- * 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);
-}