feat: upgrade dayjs's version and set default timezone for dayjs

Author: zhaoge

package.json

@@ -70,7 +70,7 @@
         "vitepress": "^1.6.3"
     },
     "dependencies": {
-        "dayjs": "^1.10.6",
+        "dayjs": "^1.11.13",
         "idb": "^8.0.0",
         "js-base64": "^3.7.7",
         "js-cookie": "^3.0.5",

pnpm-lock.yaml

@@ -1,6 +1,6 @@
 import dayjs from 'dayjs';
 
-import formatDateTime, { DateTimeFormat } from '..';
+import formatDateTime, { DateTimeFormat } from '../';
 
 describe('formatDateTime', () => {
     const testDate = new Date('2023-05-15T14:30:45');
@@ -92,6 +92,9 @@ describe('formatDateTime', () => {
         // Year boundaries
         const yearMin = new Date('0001-01-01T00:00:00');
         expect(formatDateTime(yearMin, DateTimeFormat.YEAR)).toBe('0001');
+        expect(formatDateTime(yearMin, DateTimeFormat.DATE)).toBe('0001-01-01');
+        expect(formatDateTime(yearMin, DateTimeFormat.DATE_TIME_12)).toBe('0001-01-01 12:00 AM');
+        expect(formatDateTime(yearMin, DateTimeFormat.STANDARD)).toBe('0001-01-01 00:00:00');
 
         const yearMax = new Date('9999-12-31T23:59:59');
         expect(formatDateTime(yearMax, DateTimeFormat.YEAR)).toBe('9999');

src/formatDateTime/__test__/index.test.ts

@@ -1,4 +1,17 @@
 import dayjs from 'dayjs';
+import timezone from 'dayjs/plugin/timezone'; // ES 2015
+import utc from 'dayjs/plugin/utc'; // ES 2015
+
+dayjs.extend(utc);
+dayjs.extend(timezone);
+// 默认时区：东八时区 (Asia/Shanghai)
+const DEFAULT_TIMEZONE = 'Asia/Shanghai';
+/**
+ * 将时间转换为默认时区
+ * @param {string | number | Date} time - 输入时间
+ * @return {dayjs.Dayjs} 带时区的Dayjs对象
+ */
+dayjs.tz.setDefault(DEFAULT_TIMEZONE);
 /**
  * @category 枚举
  * 日期和时间格式模式的枚举
@@ -117,16 +130,115 @@ type FormatPattern = DateTimeFormat | string;
  * formatDateTime(new Date(), "dddd, MMMM D, YYYY")  // dayjs.Dayjs
  * ```
  */
+/**
+ * Helper function to convert date to default timezone
+ */
+const toDefaultTz = (date: DateTimeInput): dayjs.Dayjs => {
+    // 如果已经是 dayjs 对象且支持 tz，直接转换到默认时区
+    if ((date as any) && typeof (date as any).tz === 'function') {
+        return (date as any).tz(DEFAULT_TIMEZONE);
+    }
+    // 否则使用 dayjs.tz 将输入解析为默认时区的 dayjs 对象
+    // 对于无效日期，dayjs.tz 可能会抛出错误，此时降级到普通 dayjs
+    try {
+        return (dayjs as any).tz(date, DEFAULT_TIMEZONE);
+    } catch {
+        return dayjs(date);
+    }
+};
+
+/**
+ * Normalize input to native Date object
+ */
+const getNativeDate = (date: DateTimeInput): Date | null => {
+    if ((date as any) && typeof (date as any).toDate === 'function') {
+        return (date as any).toDate();
+    } else if (date instanceof Date) {
+        return date as Date;
+    } else {
+        const d = new Date(date as any);
+        return Number.isNaN(d.getTime()) ? null : d;
+    }
+};
+
+/**
+ * Check if a date is an edge-case year (year < 1900)
+ * Edge-case years may have parsing inconsistencies in dayjs/timezone
+ */
+const isEdgeCaseYear = (date: DateTimeInput): boolean => {
+    const nativeDate = getNativeDate(date);
+    if (!nativeDate) return false;
+    return nativeDate.getFullYear() < 1900;
+};
+
+/**
+ * Format native Date object using dayjs-like format string
+ * Leverages dayjs for standard tokens, only customizing where needed
+ */
+const formatNativeDate = (nativeDate: Date, format: string): string => {
+    const pad = (num: number, len: number = 2) => String(num).padStart(len, '0');
+    const d = nativeDate;
+
+    // Use dayjs for all standard token formatting
+    const dayjsInstance = dayjs(d);
+
+    // Only define custom tokens that need special handling or differ from dayjs defaults
+    const customTokens: Record<string, () => string> = {
+        // Timezone offset with colon (e.g., +08:00)
+        Z: () => {
+            const offset = d.getTimezoneOffset();
+            const sign = offset <= 0 ? '+' : '-';
+            const h = Math.abs(Math.floor(offset / 60));
+            const m = Math.abs(offset % 60);
+            return `${sign}${pad(h)}:${pad(m)}`;
+        },
+        // Timezone offset without separator (e.g., +0800)
+        ZZ: () => {
+            const offset = d.getTimezoneOffset();
+            const sign = offset <= 0 ? '+' : '-';
+            const h = Math.abs(Math.floor(offset / 60));
+            const m = Math.abs(offset % 60);
+            return `${sign}${pad(h)}${pad(m)}`;
+        },
+    };
+
+    // Sort tokens by length (descending) to avoid partial matches (e.g., Z before ZZ)
+    const sortedCustomTokens = Object.keys(customTokens).sort((a, b) => b.length - a.length);
+    
+    let result = format;
+    
+    // First, replace our custom tokens
+    for (const token of sortedCustomTokens) {
+        const regex = new RegExp(token.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), 'g');
+        result = result.replace(regex, customTokens[token]());
+    }
+    
+    // Then, use dayjs to handle all standard tokens (YYYY, MM, DD, HH, mm, ss, etc.)
+    // This ensures consistency with dayjs behavior for all non-custom tokens
+    result = dayjsInstance.format(result);
+    
+    return result;
+};
+
 export const formatDateTime = (
     date: DateTimeInput,
     format: FormatPattern = DateTimeFormat.STANDARD
 ): string | dayjs.Dayjs => {
     const isValidFormat = Object.values<string>(DateTimeFormat).includes(format);
-
     if (!isValidFormat) {
-        return dayjs(date);
+        return toDefaultTz(date);
+    }
+
+    // 检测是否为极早年份（< 1900）：边缘情况年份可能存在解析问题，因此需要特殊处理
+    if (isEdgeCaseYear(date)) {
+        const nativeDate = getNativeDate(date);
+        if (!nativeDate) {
+            return 'Invalid Date';
+        }
+        return formatNativeDate(nativeDate, format as string);
     }
-    return dayjs(date).format(format);
+
+    return toDefaultTz(date).format(format);
 };
 
 export default formatDateTime;