@cranberry-money/shared-utils 8.17.8 → 8.17.9

package/package.json

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

package/dist/allocations.d.ts

@@ -1,18 +0,0 @@
-import type { AssetAllocation } from '@cranberry-money/shared-types';
-/**
- * Validates if allocation percentages sum to 100%
- * Allows for small floating point errors (e.g., 99.99 or 100.01)
- *
- * @param allocations - Array of asset allocations to validate
- * @returns true if allocations sum to approximately 100%, false otherwise
- *
- * @example
- * const allocations = [
- *   { percentage: '50.00' },
- *   { percentage: '30.00' },
- *   { percentage: '20.00' }
- * ];
- * validateAllocations(allocations); // returns true
- */
-export declare const validateAllocations: (allocations: readonly AssetAllocation[]) => boolean;
-//# sourceMappingURL=allocations.d.ts.map

package/dist/auth.d.ts

@@ -1,55 +0,0 @@
-/**
- * Authentication and token management utilities
- */
-import type { DeviceInfo, TokenRefreshResponse, TokenRefreshError, AutoRefreshHandler } from '@cranberry-money/shared-types';
-/**
- * Check if a token has expired based on its expiration timestamp
- * @param expiresAt - The expiration timestamp
- * @returns true if token is expired, false otherwise
- */
-export declare function isTokenExpired(expiresAt: string): boolean;
-/**
- * Check if a token will expire within a specified number of minutes
- * @param expiresAt - The expiration timestamp
- * @param minutesBeforeExpiry - Minutes before expiry to consider as "expiring soon"
- * @returns true if token is expiring soon, false otherwise
- */
-export declare function isTokenExpiringSoon(expiresAt: string, minutesBeforeExpiry?: number): boolean;
-/**
- * Get the remaining time until token expiry in minutes
- * @param expiresAt - The expiration timestamp
- * @returns Number of minutes until expiry
- */
-export declare function getTimeUntilExpiry(expiresAt: string): number;
-/**
- * Format the time until expiry in a human-readable format
- * @param expiresAt - The expiration timestamp
- * @returns Formatted time string
- */
-export declare function formatTimeUntilExpiry(expiresAt: string): string;
-/**
- * Parse device information from user agent string
- * @param userAgent - The user agent string
- * @returns Parsed device info
- */
-export declare function parseDeviceInfo(userAgent: string): DeviceInfo;
-/**
- * Check if token refresh was successful
- * @param response - The refresh response
- * @returns true if refresh was successful, false otherwise
- */
-export declare function isRefreshSuccess(response: TokenRefreshResponse): boolean;
-/**
- * Get error message from token refresh error
- * @param error - The refresh error
- * @returns Error message string
- */
-export declare function getRefreshErrorMessage(error: TokenRefreshError): string;
-/**
- * Create an auto-refresh handler for tokens
- * @param refreshCallback - Callback function to refresh token
- * @param checkInterval - Interval in milliseconds to check for refresh
- * @returns Auto refresh handler with start/stop methods
- */
-export declare function createAutoRefreshHandler(refreshCallback: () => Promise<void>, checkInterval?: number): AutoRefreshHandler;
-//# sourceMappingURL=auth.d.ts.map

package/dist/badge-status.d.ts

@@ -1,65 +0,0 @@
-/**
- * Badge Status Utilities - Status-specific badge functions
- *
- * This module provides pre-configured badge functions for common status types
- * in the MyPortfolio platform. It builds on top of the core badge system.
- */
-import type { StatusBadgeStyle, TradeStatus, WithdrawalStatus, LiquidationStatus, TargetTradeStatus } from '@cranberry-money/shared-types';
-import type { BadgeSize } from '@cranberry-money/shared-types';
-/**
- * Creates a badge for trade status
- *
- * @param status - Trade status constant
- * @param size - Badge size (default: 'md')
- * @returns Badge style with display text and accessibility attributes
- *
- * @example
- * ```typescript
- * const badge = getTradeStatusBadge(TRADE_STATUS_SETTLED);
- * // Returns badge with success variant and "Settled" display text
- * ```
- */
-export declare function getTradeStatusBadge(status: TradeStatus, size?: BadgeSize): StatusBadgeStyle;
-/**
- * Creates a badge for withdrawal status
- *
- * @param status - Withdrawal status constant
- * @param size - Badge size (default: 'md')
- * @returns Badge style with display text and accessibility attributes
- *
- * @example
- * ```typescript
- * const badge = getWithdrawalStatusBadge(WITHDRAWAL_STATUS_APPROVED);
- * // Returns badge with success variant and "Approved" display text
- * ```
- */
-export declare function getWithdrawalStatusBadge(status: WithdrawalStatus, size?: BadgeSize): StatusBadgeStyle;
-/**
- * Creates a badge for liquidation status
- *
- * @param status - Liquidation status constant
- * @param size - Badge size (default: 'md')
- * @returns Badge style with display text and accessibility attributes
- *
- * @example
- * ```typescript
- * const badge = getLiquidationStatusBadge(LIQUIDATION_STATUS_SETTLED);
- * // Returns badge with success variant and "Settled" display text
- * ```
- */
-export declare function getLiquidationStatusBadge(status: LiquidationStatus, size?: BadgeSize): StatusBadgeStyle;
-/**
- * Creates a badge for target trade status
- *
- * @param status - Target trade status constant
- * @param size - Badge size (default: 'md')
- * @returns Badge style with display text and accessibility attributes
- *
- * @example
- * ```typescript
- * const badge = getTargetTradeStatusBadge(TARGET_TRADE_STATUS_PENDING);
- * // Returns badge with warning variant and "Pending" display text
- * ```
- */
-export declare function getTargetTradeStatusBadge(status: TargetTradeStatus, size?: BadgeSize): StatusBadgeStyle;
-//# sourceMappingURL=badge-status.d.ts.map

package/dist/badge.d.ts

@@ -1,41 +0,0 @@
-/**
- * Badge System Core - Type definitions and factory function
- *
- * This module provides a standardized way to create and style badges.
- * It ensures consistency in colors, typography, and semantic meaning
- * while maintaining accessibility standards.
- *
- * Note: The actual style classes are designed to work with Tailwind CSS
- * and assume a specific color system is in place.
- */
-import type { BadgeVariant, BadgeSize, BadgeConfig, BadgeStyle } from '@cranberry-money/shared-types';
-/**
- * Creates a badge style configuration with appropriate CSS classes
- *
- * @param config - Badge configuration options
- * @param variantStyles - Optional custom variant styles (defaults to DEFAULT_BADGE_VARIANTS)
- * @param sizeStyles - Optional custom size styles (defaults to DEFAULT_BADGE_SIZES)
- * @returns Badge style object with className and accessibility attributes
- *
- * @example
- * ```typescript
- * // Create a success badge
- * const successBadge = createBadge({ variant: 'success' });
- * // Returns: { className: 'inline-flex items-center rounded-md font-medium whitespace-nowrap transition-colors bg-success-900/80 text-success-300 text-xs px-2 py-1', ariaLabel: 'success status' }
- *
- * // Create a large warning badge with custom class
- * const warningBadge = createBadge({ variant: 'warning', size: 'lg', className: 'ml-2' });
- *
- * // Use custom variant styles
- * const customVariants = { primary: 'bg-blue-500 text-white', ... };
- * const customBadge = createBadge({ variant: 'primary' }, customVariants);
- * ```
- */
-export declare function createBadge({ variant, size, className }: BadgeConfig, variantStyles?: Record<BadgeVariant, string>, sizeStyles?: Record<BadgeSize, string>): BadgeStyle;
-/**
- * Export the default style mappings for consumers who want to use them directly
- * or extend them with their own styles
- */
-export declare const BADGE_VARIANTS: Record<BadgeVariant, string>;
-export declare const BADGE_SIZES: Record<BadgeSize, string>;
-//# sourceMappingURL=badge.d.ts.map

package/dist/cash-account.d.ts

@@ -1,43 +0,0 @@
-/**
- * Base transaction type interface for type flexibility
- */
-export interface BaseTransactionType {
-    readonly [key: string]: string;
-}
-/**
- * Format cash account balance with AUD currency formatting
- *
- * @param balance - Balance value to format (string or number)
- * @returns Formatted currency string using Australian locale and AUD currency
- *
- * @example
- * formatBalance(1234.56); // returns '$1,234.56'
- * formatBalance('1000'); // returns '$1,000.00'
- * formatBalance(0); // returns '$0.00'
- */
-export declare const formatBalance: (balance: string | number) => string;
-/**
- * Format transaction amount with signed currency formatting (shows + or -)
- *
- * @param amount - Transaction amount to format (string or number)
- * @returns Formatted signed currency string using Australian locale and AUD currency
- *
- * @example
- * formatTransactionAmount(1234.56); // returns '+$1,234.56'
- * formatTransactionAmount(-500); // returns '-$500.00'
- * formatTransactionAmount('1000'); // returns '+$1,000.00'
- */
-export declare const formatTransactionAmount: (amount: string | number) => string;
-/**
- * Get human-readable label for transaction type
- *
- * @param transactionType - Transaction type key
- * @param labels - Optional custom transaction type labels (defaults to shared constants)
- * @returns Human-readable transaction type label
- *
- * @example
- * getTransactionTypeLabel('DEPOSIT'); // returns transaction type label from constants
- * getTransactionTypeLabel('WITHDRAWAL'); // returns transaction type label from constants
- */
-export declare const getTransactionTypeLabel: <T extends string>(transactionType: T, labels?: Record<T, string>) => string;
-//# sourceMappingURL=cash-account.d.ts.map

package/dist/collections.d.ts

@@ -1,81 +0,0 @@
-/**
- * Generic collection and array utilities
- * Pure functions for common array operations with type safety
- */
-/**
- * Sort array of objects by a string field
- * @param items - Array of objects to sort
- * @param fieldName - Name of the field to sort by
- * @returns New sorted array
- */
-export declare function sortByStringField<T>(items: T[], fieldName: keyof T): T[];
-/**
- * Filter array by text search in a specific field (case-insensitive)
- * @param items - Array of objects to filter
- * @param fieldName - Name of the field to search in
- * @param searchTerm - Search term
- * @returns Filtered array
- */
-export declare function filterByTextSearch<T>(items: T[], fieldName: keyof T, searchTerm: string): T[];
-/**
- * Filter array by boolean field
- * @param items - Array of objects to filter
- * @param fieldName - Name of the boolean field
- * @param value - Boolean value to filter by
- * @returns Filtered array
- */
-export declare function filterByBooleanField<T>(items: T[], fieldName: keyof T, value: boolean): T[];
-/**
- * Find item by exact field match
- * @param items - Array of objects to search
- * @param fieldName - Name of the field to match
- * @param value - Value to match
- * @returns Found item or undefined
- */
-export declare function findByField<T>(items: T[], fieldName: keyof T, value: unknown): T | undefined;
-/**
- * Find item by case-insensitive string field match
- * @param items - Array of objects to search
- * @param fieldName - Name of the string field to match
- * @param value - String value to match (case-insensitive)
- * @returns Found item or undefined
- */
-export declare function findByStringField<T>(items: T[], fieldName: keyof T, value: string): T | undefined;
-/**
- * Extract values from a specific field and sort them
- * @param items - Array of objects
- * @param fieldName - Name of the field to extract
- * @returns Sorted array of extracted values
- */
-export declare function extractAndSortField<T, K extends keyof T>(items: T[], fieldName: K): T[K][];
-/**
- * Group array items by the first character of a string field
- * @param items - Array of objects to group
- * @param fieldName - Name of the string field to group by
- * @returns Object with first letters as keys and arrays of items as values
- */
-export declare function groupByFirstLetter<T>(items: T[], fieldName: keyof T): Record<string, T[]>;
-/**
- * Group array items by a field value
- * @param items - Array of objects to group
- * @param fieldName - Name of the field to group by
- * @returns Object with field values as keys and arrays of items as values
- */
-export declare function groupByField<T, K extends keyof T>(items: T[], fieldName: K): Record<string, T[]>;
-/**
- * Check if any item in array has a specific boolean field value
- * @param items - Array of objects to check
- * @param fieldName - Name of the boolean field
- * @param value - Boolean value to check for
- * @returns true if any item matches, false otherwise
- */
-export declare function hasItemWithFieldValue<T>(items: T[], fieldName: keyof T, value: unknown): boolean;
-/**
- * Count items that match a field value
- * @param items - Array of objects to count
- * @param fieldName - Name of the field to check
- * @param value - Value to count
- * @returns Number of matching items
- */
-export declare function countByFieldValue<T>(items: T[], fieldName: keyof T, value: unknown): number;
-//# sourceMappingURL=collections.d.ts.map

package/dist/country.d.ts

@@ -1,108 +0,0 @@
-/**
- * Base interface for country objects
- */
-export interface BaseCountry {
-    readonly name: string;
-    readonly code: string;
-    readonly uuid: string;
-    readonly isAvailable: boolean;
-    readonly dialCode?: string;
-}
-/**
- * Sort countries by name
- *
- * @param countries - Array of countries to sort
- * @returns Sorted array of countries
- *
- * @example
- * const sorted = sortCountriesByName(countries);
- */
-export declare const sortCountriesByName: <T extends BaseCountry>(countries: readonly T[]) => T[];
-/**
- * Filter countries by name (case-insensitive search)
- *
- * @param countries - Array of countries to filter
- * @param searchTerm - Search term to filter by
- * @returns Filtered array of countries
- *
- * @example
- * const filtered = filterCountriesByName(countries, 'united');
- * // Returns countries with 'united' in the name
- */
-export declare const filterCountriesByName: <T extends BaseCountry>(countries: readonly T[], searchTerm: string) => T[];
-/**
- * Filter countries by availability
- *
- * @param countries - Array of countries to filter
- * @returns Array of available countries
- *
- * @example
- * const available = filterAvailableCountries(countries);
- */
-export declare const filterAvailableCountries: <T extends BaseCountry>(countries: readonly T[]) => T[];
-/**
- * Find country by exact name match
- *
- * @param countries - Array of countries to search
- * @param name - Exact name to find
- * @returns Found country or undefined
- *
- * @example
- * const country = findCountryByName(countries, 'United States');
- */
-export declare const findCountryByName: <T extends BaseCountry>(countries: readonly T[], name: string) => T | undefined;
-/**
- * Find country by country code
- *
- * @param countries - Array of countries to search
- * @param code - Country code to find (e.g., 'US', 'CA')
- * @returns Found country or undefined
- *
- * @example
- * const country = findCountryByCode(countries, 'US');
- */
-export declare const findCountryByCode: <T extends BaseCountry>(countries: readonly T[], code: string) => T | undefined;
-/**
- * Get sorted list of country names
- *
- * @param countries - Array of countries
- * @returns Sorted array of country names
- *
- * @example
- * const names = getCountryNames(countries);
- * // ['Australia', 'Canada', 'United States', ...]
- */
-export declare const getCountryNames: <T extends BaseCountry>(countries: readonly T[]) => string[];
-/**
- * Group countries alphabetically by first letter
- *
- * @param countries - Array of countries to group
- * @returns Record of countries grouped by first letter
- *
- * @example
- * const grouped = groupCountriesAlphabetically(countries);
- * // { 'A': [...], 'B': [...], 'C': [...], ... }
- */
-export declare const groupCountriesAlphabetically: <T extends BaseCountry>(countries: readonly T[]) => Record<string, T[]>;
-/**
- * Format country with dial code for display
- *
- * @param country - Country to format
- * @returns Formatted string with country name and dial code
- *
- * @example
- * formatCountryWithDialCode({ name: 'United States', dialCode: '+1', ... });
- * // Returns 'United States (+1)'
- */
-export declare const formatCountryWithDialCode: <T extends BaseCountry>(country: T) => string;
-/**
- * Check if a country is available
- *
- * @param country - Country to check
- * @returns True if country is available
- *
- * @example
- * const available = isCountryAvailable(country);
- */
-export declare const isCountryAvailable: <T extends BaseCountry>(country: T) => boolean;
-//# sourceMappingURL=country.d.ts.map

package/dist/currency.d.ts

@@ -1,99 +0,0 @@
-/**
- * Currency formatting utility functions and constants
- *
- * This module provides pure functions for formatting currency values,
- * parsing currency inputs, and working with different currency formats.
- */
-/**
- * Number formatting options for currency display
- */
-export declare const NUMBER_FORMAT_OPTIONS_CURRENCY: {
-    readonly style: "currency";
-    readonly minimumFractionDigits: 2;
-    readonly maximumFractionDigits: 2;
-};
-/**
- * Number formatting options for currency with explicit sign display
- */
-export declare const NUMBER_FORMAT_OPTIONS_CURRENCY_SIGNED: {
-    readonly signDisplay: "always";
-    readonly style: "currency";
-    readonly minimumFractionDigits: 2;
-    readonly maximumFractionDigits: 2;
-};
-/**
- * Formats a number as currency with commas and 2 decimal places
- *
- * @param value - Number or string value to format
- * @returns Formatted currency string without currency symbol
- *
- * @example
- * ```typescript
- * formatCurrency(1234.5) // '1,234.50'
- * formatCurrency('1234.5') // '1,234.50'
- * formatCurrency(0) // '0.00'
- * ```
- */
-export declare function formatCurrency(value: number | string): string;
-/**
- * Parses a currency string input into a number
- *
- * @param value - Currency string to parse
- * @returns Parsed number value (or 0 if invalid)
- *
- * @example
- * ```typescript
- * parseCurrencyInput('$1,234.56') // 1234.56
- * parseCurrencyInput('1234.567') // 1234.56
- * parseCurrencyInput('abc') // 0
- * ```
- */
-export declare function parseCurrencyInput(value: string): number;
-/**
- * Formats a number as currency with specific currency code and locale
- *
- * @param value - Number to format
- * @param currencyCode - ISO 4217 currency code (default: DEFAULT_CURRENCY)
- * @param locale - Locale for formatting (default: 'en-AU')
- * @param minimumFractionDigits - Minimum decimal places (default: 0)
- * @param maximumFractionDigits - Maximum decimal places (default: 0)
- * @returns Formatted currency string
- *
- * @example
- * ```typescript
- * formatCurrencyWithCode(1234.5) // 'A$1,235'
- * formatCurrencyWithCode(1234.5, 'USD', 'en-US') // '$1,235'
- * formatCurrencyWithCode(1234.56, 'AUD', 'en-AU', 2, 2) // 'A$1,234.56'
- * ```
- */
-export declare function formatCurrencyWithCode(value: number, currencyCode?: string, locale?: string, minimumFractionDigits?: number, maximumFractionDigits?: number): string;
-/**
- * Convenience function to format currency with the default currency (AUD)
- *
- * @param value - Number to format
- * @param minimumFractionDigits - Minimum decimal places (default: 0)
- * @param maximumFractionDigits - Maximum decimal places (default: 0)
- * @returns Formatted currency string with default currency
- *
- * @example
- * ```typescript
- * formatDefaultCurrency(1234.5) // 'A$1,235'
- * formatDefaultCurrency(1234.56, 2, 2) // 'A$1,234.56'
- * ```
- */
-export declare function formatDefaultCurrency(value: number, minimumFractionDigits?: number, maximumFractionDigits?: number): string;
-/**
- * Formats a number for displaying share quantities (no decimals)
- *
- * @param shares - Number of shares to format
- * @param locale - Locale for formatting (default: 'en-AU')
- * @returns Formatted shares string with commas as thousands separators
- *
- * @example
- * ```typescript
- * formatShares(1234) // '1,234'
- * formatShares(1234567) // '1,234,567'
- * ```
- */
-export declare function formatShares(shares: number, locale?: string): string;
-//# sourceMappingURL=currency.d.ts.map

package/dist/dashboard.d.ts

@@ -1,72 +0,0 @@
-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/date.d.ts

@@ -1,64 +0,0 @@
-/**
- * Date and time formatting utility functions
- *
- * This module provides pure functions for formatting dates and times
- * in various formats suitable for display in the application.
- */
-/**
- * Formats a date string to a localized date
- *
- * @param dateString - ISO date string or null
- * @param fallback - Fallback text when date is null (default: 'No expiry')
- * @returns Formatted date string
- *
- * @example
- * ```typescript
- * formatDate('2024-03-15') // '3/15/2024' (in en-US)
- * formatDate(null) // 'No expiry'
- * formatDate(null, 'Not set') // 'Not set'
- * ```
- */
-export declare function formatDate(dateString: string | null, fallback?: string): string;
-/**
- * Formats a date string to a short date format (e.g., "Jan 15")
- *
- * @param dateString - ISO date string
- * @param locale - Locale for formatting (default: 'en-AU')
- * @returns Formatted short date string
- *
- * @example
- * ```typescript
- * formatShortDate('2024-01-15') // 'Jan 15'
- * formatShortDate('2024-12-25', 'en-US') // 'Dec 25'
- * ```
- */
-export declare function formatShortDate(dateString: string, locale?: string): string;
-/**
- * Formats a date string to a time format (24-hour)
- *
- * @param dateString - ISO date string
- * @param locale - Locale for formatting (default: 'en-AU')
- * @returns Formatted time string in 24-hour format
- *
- * @example
- * ```typescript
- * formatTime('2024-01-15T14:30:00') // '14:30'
- * formatTime('2024-01-15T09:05:00') // '09:05'
- * ```
- */
-export declare function formatTime(dateString: string, locale?: string): string;
-/**
- * Formats a date string to a combined short date and time format
- *
- * @param dateString - ISO date string
- * @param locale - Locale for formatting (default: 'en-AU')
- * @returns Formatted string like "Jan 15 14:30"
- *
- * @example
- * ```typescript
- * formatDateTime('2024-01-15T14:30:00') // 'Jan 15 14:30'
- * formatDateTime('2024-12-25T09:00:00', 'en-US') // 'Dec 25 09:00'
- * ```
- */
-export declare function formatDateTime(dateString: string, locale?: string): string;
-//# sourceMappingURL=date.d.ts.map