@cranberry-money/shared-utils 4.10.0 → 4.11.0

package/dist/auth.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Authentication and token management utilities
+ */
+/**
+ * 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;
+/**
+ * Device info structure
+ */
+export interface DeviceInfo {
+    browser: string;
+    os: 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;
+/**
+ * Token refresh response structure
+ */
+export interface TokenRefreshResponse {
+    status?: number;
+    data?: {
+        access?: string;
+        refresh?: string;
+    };
+}
+/**
+ * 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;
+/**
+ * Token refresh error structure
+ */
+export interface TokenRefreshError {
+    response?: {
+        data?: {
+            detail?: string;
+            message?: string;
+        };
+    };
+    message?: string;
+}
+/**
+ * Get error message from token refresh error
+ * @param error - The refresh error
+ * @returns Error message string
+ */
+export declare function getRefreshErrorMessage(error: TokenRefreshError): string;
+/**
+ * Auto refresh handler interface
+ */
+export interface AutoRefreshHandler {
+    start: () => void;
+    stop: () => void;
+}
+/**
+ * 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/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;GAEG;AAkBH;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAIzD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,mBAAmB,GAAE,MAA6C,GACjE,OAAO,CAMT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAkB/D;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAwB7D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAExE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE;YACL,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,iBAAiB,GAAG,MAAM,CAWvE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EACpC,aAAa,GAAE,MAAc,GAC5B,kBAAkB,CAiBpB"}

package/dist/auth.js

@@ -0,0 +1,135 @@
+/**
+ * Authentication and token management utilities
+ */
+import { DEFAULT_TOKEN_REFRESH_BUFFER_MINUTES, MILLISECONDS_PER_MINUTE, MINUTES_PER_HOUR, HOURS_PER_DAY, TIME_LABEL_EXPIRED, TIME_LABEL_MINUTE, TIME_LABEL_MINUTES, TIME_LABEL_HOUR, TIME_LABEL_HOURS, TIME_LABEL_DAY, TIME_LABEL_DAYS, DEFAULT_UNKNOWN_VALUE, DEFAULT_ERROR_MESSAGE, } from '@cranberry-money/shared-constants';
+/**
+ * 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 function isTokenExpired(expiresAt) {
+    const expirationTime = new Date(expiresAt).getTime();
+    const currentTime = Date.now();
+    return currentTime >= expirationTime;
+}
+/**
+ * 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 function isTokenExpiringSoon(expiresAt, minutesBeforeExpiry = DEFAULT_TOKEN_REFRESH_BUFFER_MINUTES) {
+    const expirationTime = new Date(expiresAt).getTime();
+    const currentTime = Date.now();
+    const bufferTime = minutesBeforeExpiry * MILLISECONDS_PER_MINUTE;
+    return currentTime + bufferTime >= expirationTime;
+}
+/**
+ * Get the remaining time until token expiry in minutes
+ * @param expiresAt - The expiration timestamp
+ * @returns Number of minutes until expiry
+ */
+export function getTimeUntilExpiry(expiresAt) {
+    const expirationTime = new Date(expiresAt).getTime();
+    const currentTime = Date.now();
+    const remainingTime = expirationTime - currentTime;
+    if (remainingTime <= 0) {
+        return 0;
+    }
+    return Math.floor(remainingTime / MILLISECONDS_PER_MINUTE);
+}
+/**
+ * Format the time until expiry in a human-readable format
+ * @param expiresAt - The expiration timestamp
+ * @returns Formatted time string
+ */
+export function formatTimeUntilExpiry(expiresAt) {
+    const minutesRemaining = getTimeUntilExpiry(expiresAt);
+    if (minutesRemaining <= 0) {
+        return TIME_LABEL_EXPIRED;
+    }
+    if (minutesRemaining < MINUTES_PER_HOUR) {
+        return minutesRemaining === 1 ? `1 ${TIME_LABEL_MINUTE}` : `${minutesRemaining} ${TIME_LABEL_MINUTES}`;
+    }
+    const hoursRemaining = Math.floor(minutesRemaining / MINUTES_PER_HOUR);
+    if (hoursRemaining < HOURS_PER_DAY) {
+        return hoursRemaining === 1 ? `1 ${TIME_LABEL_HOUR}` : `${hoursRemaining} ${TIME_LABEL_HOURS}`;
+    }
+    const daysRemaining = Math.floor(hoursRemaining / HOURS_PER_DAY);
+    return daysRemaining === 1 ? `1 ${TIME_LABEL_DAY}` : `${daysRemaining} ${TIME_LABEL_DAYS}`;
+}
+/**
+ * Parse device information from user agent string
+ * @param userAgent - The user agent string
+ * @returns Parsed device info
+ */
+export function parseDeviceInfo(userAgent) {
+    const browser = userAgent.includes('Chrome')
+        ? 'Chrome'
+        : userAgent.includes('Firefox')
+            ? 'Firefox'
+            : userAgent.includes('Safari')
+                ? 'Safari'
+                : userAgent.includes('Edge')
+                    ? 'Edge'
+                    : DEFAULT_UNKNOWN_VALUE;
+    const os = userAgent.includes('Windows')
+        ? 'Windows'
+        : userAgent.includes('Mac')
+            ? 'macOS'
+            : userAgent.includes('Linux')
+                ? 'Linux'
+                : userAgent.includes('Android')
+                    ? 'Android'
+                    : userAgent.includes('iOS')
+                        ? 'iOS'
+                        : DEFAULT_UNKNOWN_VALUE;
+    return { browser, os };
+}
+/**
+ * Check if token refresh was successful
+ * @param response - The refresh response
+ * @returns true if refresh was successful, false otherwise
+ */
+export function isRefreshSuccess(response) {
+    return !!(response?.status === 200 && response?.data?.access && response?.data?.refresh);
+}
+/**
+ * Get error message from token refresh error
+ * @param error - The refresh error
+ * @returns Error message string
+ */
+export function getRefreshErrorMessage(error) {
+    if (error.response?.data?.detail) {
+        return error.response.data.detail;
+    }
+    if (error.response?.data?.message) {
+        return error.response.data.message;
+    }
+    if (error.message) {
+        return error.message;
+    }
+    return DEFAULT_ERROR_MESSAGE;
+}
+/**
+ * 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 function createAutoRefreshHandler(refreshCallback, checkInterval = 60000 // 1 minute
+) {
+    let intervalId = null;
+    const start = () => {
+        if (intervalId)
+            return;
+        intervalId = setInterval(refreshCallback, checkInterval);
+    };
+    const stop = () => {
+        if (intervalId) {
+            clearInterval(intervalId);
+            intervalId = null;
+        }
+    };
+    return { start, stop };
+}

package/dist/index.d.ts

@@ -17,4 +17,8 @@ export { formatWithdrawalAmount, formatLiquidationValue, formatSharesQuantity, c
 export type { PasswordValidation, EmailConfirmationValidation, ExtendedPasswordValidation } from './validation';
 export { isNumericOnly, validatePassword, isValidTokenFormat, formatVerificationToken, validateEmailConfirmation, isValidEmail, hasUppercase, hasLowercase, hasSpecialCharacter, hasDigit, validatePasswordExtended, isValidPhoneNumber, isValidPhoneFormat, isValidUrl, isValidDate, isEmptyOrWhitespace, meetsMinLength, meetsMaxLength, isInRange, isPositiveNumber, isNonNegativeNumber, isValidFullName, isValidDateOfBirth, formatPhoneNumber, isValidInvestmentAmount, hasMinimumSelection, isSelected, } from './validation';
 export { hasActiveFilters, countActiveFilters, clearAllFilters, updateFilters, isFilterEmpty, removeEmptyFilters, mergeFilters, areFiltersEqual, createFilterPredicate, } from './filters';
+export type { DeviceInfo, TokenRefreshResponse, TokenRefreshError, AutoRefreshHandler } from './auth';
+export { isTokenExpired, isTokenExpiringSoon, getTimeUntilExpiry, formatTimeUntilExpiry, parseDeviceInfo, isRefreshSuccess, getRefreshErrorMessage, createAutoRefreshHandler, } from './auth';
+export type { InstrumentTypeInfo, InstrumentBasicInfo, PriceChangeResult, PriceSnapshot, FormattedPriceChange, TradeableInstrument, MarketDataInfo, } from './instruments';
+export { formatInstrumentPrice, getCurrencySymbol, getInstrumentType, formatInstrumentName, calculatePriceChange, formatPriceChange, isInstrumentTradeable, formatMarketCap, formatVolume, hasMarketData, } from './instruments';
 //# 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,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;AAGtB,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAChH,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,GACX,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,qBAAqB,GACtB,MAAM,WAAW,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;AAGtB,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAChH,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,GACX,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,qBAAqB,GACtB,MAAM,WAAW,CAAC;AAGnB,YAAY,EAAE,UAAU,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AACtG,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,QAAQ,CAAC;AAGhB,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,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"}

package/dist/index.js

@@ -18,3 +18,5 @@ export { formatWithdrawalAmount, formatLiquidationValue, formatSharesQuantity, c
 export { isNumericOnly, validatePassword, isValidTokenFormat, formatVerificationToken, validateEmailConfirmation, isValidEmail, hasUppercase, hasLowercase, hasSpecialCharacter, hasDigit, validatePasswordExtended, isValidPhoneNumber, isValidPhoneFormat, isValidUrl, isValidDate, isEmptyOrWhitespace, meetsMinLength, meetsMaxLength, isInRange, isPositiveNumber, isNonNegativeNumber, isValidFullName, isValidDateOfBirth, formatPhoneNumber, isValidInvestmentAmount, hasMinimumSelection, isSelected, } from './validation';
 // Filter utilities
 export { hasActiveFilters, countActiveFilters, clearAllFilters, updateFilters, isFilterEmpty, removeEmptyFilters, mergeFilters, areFiltersEqual, createFilterPredicate, } from './filters';
+export { isTokenExpired, isTokenExpiringSoon, getTimeUntilExpiry, formatTimeUntilExpiry, parseDeviceInfo, isRefreshSuccess, getRefreshErrorMessage, createAutoRefreshHandler, } from './auth';
+export { formatInstrumentPrice, getCurrencySymbol, getInstrumentType, formatInstrumentName, calculatePriceChange, formatPriceChange, isInstrumentTradeable, formatMarketCap, formatVolume, hasMarketData, } from './instruments';

package/dist/instruments.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Instrument and market data formatting utilities
+ */
+/**
+ * Format instrument price with currency symbol
+ * @param price - The price as string
+ * @param currency - The currency code
+ * @returns Formatted price with currency symbol
+ */
+export declare function formatInstrumentPrice(price: string, currency?: string | null): string;
+/**
+ * Get currency symbol for display
+ * @param currency - The currency code
+ * @returns Currency symbol
+ */
+export declare function getCurrencySymbol(currency?: string | null): string;
+/**
+ * Instrument interface for type determination
+ */
+export interface InstrumentTypeInfo {
+    isEtf?: boolean;
+    isFund?: boolean;
+}
+/**
+ * Determine instrument type based on flags
+ * @param instrument - The instrument with type flags
+ * @returns Instrument type string
+ */
+export declare function getInstrumentType(instrument: InstrumentTypeInfo): string;
+/**
+ * Basic instrument info for formatting
+ */
+export interface InstrumentBasicInfo {
+    symbol: string;
+    name: string;
+}
+/**
+ * Format instrument display name with symbol
+ * @param instrument - The instrument with symbol and name
+ * @returns Formatted display name
+ */
+export declare function formatInstrumentName(instrument: InstrumentBasicInfo): string;
+/**
+ * Price change calculation result
+ */
+export interface PriceChangeResult {
+    change: number;
+    changePercent: number;
+    isPositive: boolean;
+}
+/**
+ * Snapshot data for price change calculation
+ */
+export interface PriceSnapshot {
+    change: string;
+    changePercent: string;
+}
+/**
+ * Calculate price change from snapshot
+ * @param snapshot - The price snapshot
+ * @returns Price change calculation result
+ */
+export declare function calculatePriceChange(snapshot: PriceSnapshot): PriceChangeResult;
+/**
+ * Formatted price change result
+ */
+export interface FormattedPriceChange {
+    changeText: string;
+    changePercentText: string;
+    colorClass: string;
+}
+/**
+ * Format price change with appropriate color class
+ * @param snapshot - The price snapshot
+ * @returns Formatted price change with color class
+ */
+export declare function formatPriceChange(snapshot: PriceSnapshot): FormattedPriceChange;
+/**
+ * Tradeable instrument info
+ */
+export interface TradeableInstrument {
+    isActive: boolean;
+    isActivelyTrading: boolean;
+}
+/**
+ * Check if instrument is actively tradeable
+ * @param instrument - The instrument with trading flags
+ * @returns true if tradeable, false otherwise
+ */
+export declare function isInstrumentTradeable(instrument: TradeableInstrument): boolean;
+/**
+ * Format market cap value
+ * @param marketCap - The market cap value as string or null
+ * @returns Formatted market cap string
+ */
+export declare function formatMarketCap(marketCap: string | null | undefined): string;
+/**
+ * Format trading volume
+ * @param volume - The volume number
+ * @returns Formatted volume string
+ */
+export declare function formatVolume(volume: number): string;
+/**
+ * Market data availability info
+ */
+export interface MarketDataInfo {
+    openPrice?: string | null;
+    dayHigh?: string | null;
+    dayLow?: string | null;
+    volume?: number | null;
+}
+/**
+ * Check if market data is available
+ * @param marketData - The market data to check
+ * @returns true if market data is available, false otherwise
+ */
+export declare function hasMarketData(marketData: MarketDataInfo): boolean;
+//# sourceMappingURL=instruments.d.ts.map

package/dist/instruments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../src/instruments.ts"],"names":[],"mappings":"AAAA;;GAEG;AAUH;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAMrF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAalE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,kBAAkB,GAAG,MAAM,CAIxE;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,mBAAmB,GAAG,MAAM,CAE5E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,GAAG,iBAAiB,CAS/E;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,aAAa,GAAG,oBAAoB,CAY/E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAE9E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAU5E;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAEjE"}

package/dist/instruments.js

@@ -0,0 +1,135 @@
+/**
+ * Instrument and market data formatting utilities
+ */
+import { INSTRUMENT_TYPE_ETF, INSTRUMENT_TYPE_FUND, INSTRUMENT_TYPE_STOCK, CURRENCY_USD, CURRENCY_AUD, } from '@cranberry-money/shared-constants';
+/**
+ * Format instrument price with currency symbol
+ * @param price - The price as string
+ * @param currency - The currency code
+ * @returns Formatted price with currency symbol
+ */
+export function formatInstrumentPrice(price, currency) {
+    const numericPrice = parseFloat(price);
+    if (isNaN(numericPrice))
+        return price;
+    const currencySymbol = getCurrencySymbol(currency);
+    return `${currencySymbol}${numericPrice.toFixed(2)}`;
+}
+/**
+ * Get currency symbol for display
+ * @param currency - The currency code
+ * @returns Currency symbol
+ */
+export function getCurrencySymbol(currency) {
+    switch (currency) {
+        case CURRENCY_USD:
+            return '$';
+        case CURRENCY_AUD:
+            return 'A$';
+        case 'EUR':
+            return '€';
+        case 'GBP':
+            return '£';
+        default:
+            return '$'; // Default to USD symbol
+    }
+}
+/**
+ * Determine instrument type based on flags
+ * @param instrument - The instrument with type flags
+ * @returns Instrument type string
+ */
+export function getInstrumentType(instrument) {
+    if (instrument.isEtf)
+        return INSTRUMENT_TYPE_ETF;
+    if (instrument.isFund)
+        return INSTRUMENT_TYPE_FUND;
+    return INSTRUMENT_TYPE_STOCK;
+}
+/**
+ * Format instrument display name with symbol
+ * @param instrument - The instrument with symbol and name
+ * @returns Formatted display name
+ */
+export function formatInstrumentName(instrument) {
+    return `${instrument.symbol} - ${instrument.name}`;
+}
+/**
+ * Calculate price change from snapshot
+ * @param snapshot - The price snapshot
+ * @returns Price change calculation result
+ */
+export function calculatePriceChange(snapshot) {
+    const change = parseFloat(snapshot.change);
+    const changePercent = parseFloat(snapshot.changePercent);
+    return {
+        change,
+        changePercent,
+        isPositive: change >= 0,
+    };
+}
+/**
+ * Format price change with appropriate color class
+ * @param snapshot - The price snapshot
+ * @returns Formatted price change with color class
+ */
+export function formatPriceChange(snapshot) {
+    const { change, changePercent, isPositive } = calculatePriceChange(snapshot);
+    const changeText = `${isPositive ? '+' : ''}${change.toFixed(2)}`;
+    const changePercentText = `${isPositive ? '+' : ''}${changePercent.toFixed(2)}%`;
+    const colorClass = isPositive ? 'text-positive' : 'text-negative';
+    return {
+        changeText,
+        changePercentText,
+        colorClass,
+    };
+}
+/**
+ * Check if instrument is actively tradeable
+ * @param instrument - The instrument with trading flags
+ * @returns true if tradeable, false otherwise
+ */
+export function isInstrumentTradeable(instrument) {
+    return instrument.isActive && instrument.isActivelyTrading;
+}
+/**
+ * Format market cap value
+ * @param marketCap - The market cap value as string or null
+ * @returns Formatted market cap string
+ */
+export function formatMarketCap(marketCap) {
+    if (!marketCap)
+        return 'N/A';
+    const marketCapValue = parseFloat(marketCap);
+    if (isNaN(marketCapValue))
+        return 'N/A';
+    if (marketCapValue >= 1e12)
+        return `$${(marketCapValue / 1e12).toFixed(1)}T`;
+    if (marketCapValue >= 1e9)
+        return `$${(marketCapValue / 1e9).toFixed(1)}B`;
+    if (marketCapValue >= 1e6)
+        return `$${(marketCapValue / 1e6).toFixed(1)}M`;
+    return `$${marketCapValue.toFixed(0)}`;
+}
+/**
+ * Format trading volume
+ * @param volume - The volume number
+ * @returns Formatted volume string
+ */
+export function formatVolume(volume) {
+    if (volume >= 1e9)
+        return `${(volume / 1e9).toFixed(1)}B`;
+    if (volume >= 1e6)
+        return `${(volume / 1e6).toFixed(1)}M`;
+    if (volume >= 1e3)
+        return `${(volume / 1e3).toFixed(1)}K`;
+    return volume.toString();
+}
+/**
+ * Check if market data is available
+ * @param marketData - The market data to check
+ * @returns true if market data is available, false otherwise
+ */
+export function hasMarketData(marketData) {
+    return Boolean(marketData.openPrice || marketData.dayHigh || marketData.dayLow || marketData.volume);
+}

package/package.json

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