@cranberry-money/shared-utils 4.1.0 → 4.2.0

package/dist/date.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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

package/dist/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../src/date.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,GAAE,MAAoB,GAAG,MAAM,CAG5F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,GAAE,MAAgB,GAAG,MAAM,CAMpF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,GAAE,MAAgB,GAAG,MAAM,CAM/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,GAAE,MAAgB,GAAG,MAAM,CAYnF"}

package/dist/date.js

@@ -0,0 +1,91 @@
+/**
+ * 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 function formatDate(dateString, fallback = 'No expiry') {
+    if (!dateString)
+        return fallback;
+    return new Date(dateString).toLocaleDateString();
+}
+/**
+ * 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 function formatShortDate(dateString, locale = 'en-AU') {
+    const date = new Date(dateString);
+    return date.toLocaleDateString(locale, {
+        month: 'short',
+        day: 'numeric',
+    });
+}
+/**
+ * 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 function formatTime(dateString, locale = 'en-AU') {
+    return new Date(dateString).toLocaleTimeString(locale, {
+        hour: '2-digit',
+        minute: '2-digit',
+        hour12: false,
+    });
+}
+/**
+ * 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 function formatDateTime(dateString, locale = 'en-AU') {
+    const date = new Date(dateString);
+    const shortDate = date.toLocaleDateString(locale, {
+        month: 'short',
+        day: 'numeric',
+    });
+    const time = date.toLocaleTimeString(locale, {
+        hour: '2-digit',
+        minute: '2-digit',
+        hour12: false,
+    });
+    return `${shortDate} ${time}`;
+}

package/dist/index.d.ts

@@ -5,4 +5,5 @@
  * All utilities are pure functions with no side effects.
  */
 export { truncateText } from './text';
+export { formatDate, formatShortDate, formatTime, formatDateTime } from './date';
 //# 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"}
+{"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"}

package/dist/index.js

@@ -6,3 +6,5 @@
  */
 // Text manipulation utilities
 export { truncateText } from './text';
+// Date and time formatting utilities
+export { formatDate, formatShortDate, formatTime, formatDateTime } from './date';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cranberry-money/shared-utils",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Shared utility functions for MyPortfolio platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",