@lotics/xlsx 0.1.0

package/src/excel_numfmt.test.ts

@@ -0,0 +1,607 @@
+import { formatNumFmt, serialToDateParts } from "./excel_numfmt";
+
+// =============================================================================
+// General format
+// =============================================================================
+
+describe("General format", () => {
+  test("returns plain number", () => {
+    expect(formatNumFmt(1234, "General").text).toBe("1234");
+  });
+
+  test("returns zero", () => {
+    expect(formatNumFmt(0, "General").text).toBe("0");
+  });
+
+  test("returns decimal", () => {
+    expect(formatNumFmt(3.14, "General").text).toBe("3.14");
+  });
+
+  test("returns empty format as General", () => {
+    expect(formatNumFmt(42, "").text).toBe("42");
+  });
+
+  test("large number uses scientific notation", () => {
+    const result = formatNumFmt(1.23e15, "General").text;
+    expect(result).toContain("E+");
+  });
+
+  test("small number stays decimal when it fits", () => {
+    expect(formatNumFmt(0.00001, "General").text).toBe("0.00001");
+  });
+
+  test("very small number uses scientific notation", () => {
+    const result = formatNumFmt(1e-10, "General").text;
+    expect(result).toContain("E-");
+  });
+
+  test("string value passes through", () => {
+    expect(formatNumFmt("Hello" as unknown as number, "General").text).toBe("Hello");
+  });
+});
+
+// =============================================================================
+// Built-in format IDs (via their format codes)
+// =============================================================================
+
+describe("built-in number formats", () => {
+  // ID 0: General
+  test("ID 0 — General", () => {
+    expect(formatNumFmt(1234.5, "General").text).toBe("1234.5");
+  });
+
+  // ID 1: 0
+  test("ID 1 — 0", () => {
+    expect(formatNumFmt(3.7, "0").text).toBe("4");
+    expect(formatNumFmt(3.1, "0").text).toBe("3");
+  });
+
+  // ID 2: 0.00
+  test("ID 2 — 0.00", () => {
+    expect(formatNumFmt(3.1, "0.00").text).toBe("3.10");
+    expect(formatNumFmt(0, "0.00").text).toBe("0.00");
+  });
+
+  // ID 3: #,##0
+  test("ID 3 — #,##0", () => {
+    expect(formatNumFmt(1234567, "#,##0").text).toBe("1,234,567");
+    expect(formatNumFmt(0, "#,##0").text).toBe("0");
+    expect(formatNumFmt(42, "#,##0").text).toBe("42");
+  });
+
+  // ID 4: #,##0.00
+  test("ID 4 — #,##0.00", () => {
+    expect(formatNumFmt(1234.5, "#,##0.00").text).toBe("1,234.50");
+    expect(formatNumFmt(0, "#,##0.00").text).toBe("0.00");
+  });
+
+  // ID 9: 0%
+  test("ID 9 — 0%", () => {
+    expect(formatNumFmt(0.75, "0%").text).toBe("75%");
+    expect(formatNumFmt(1, "0%").text).toBe("100%");
+  });
+
+  // ID 10: 0.00%
+  test("ID 10 — 0.00%", () => {
+    expect(formatNumFmt(0.5, "0.00%").text).toBe("50.00%");
+    expect(formatNumFmt(0.1234, "0.00%").text).toBe("12.34%");
+  });
+
+  // ID 11: 0.00E+00
+  test("ID 11 — 0.00E+00", () => {
+    expect(formatNumFmt(1234, "0.00E+00").text).toBe("1.23E+03");
+    expect(formatNumFmt(0.0056, "0.00E+00").text).toBe("5.60E-03");
+    expect(formatNumFmt(0, "0.00E+00").text).toBe("0.00E+00");
+  });
+
+  // ID 12: # ?/?
+  test("ID 12 — # ?/?", () => {
+    const result = formatNumFmt(3.25, "# ?/?").text;
+    expect(result).toContain("3");
+    expect(result).toContain("/");
+    expect(result).toContain("4");
+  });
+
+  // ID 13: # ??/??
+  test("ID 13 — # ??/??", () => {
+    const result = formatNumFmt(3.125, "# ??/??").text;
+    expect(result).toContain("3");
+    expect(result).toContain("/");
+  });
+
+  // ID 14: mm-dd-yy
+  test("ID 14 — mm-dd-yy", () => {
+    // Serial 44927 = 2023-01-01
+    expect(formatNumFmt(44927, "mm-dd-yy").text).toBe("01-01-23");
+  });
+
+  // ID 15: d-mmm-yy
+  test("ID 15 — d-mmm-yy", () => {
+    expect(formatNumFmt(44927, "d-mmm-yy").text).toBe("1-Jan-23");
+  });
+
+  // ID 16: d-mmm
+  test("ID 16 — d-mmm", () => {
+    expect(formatNumFmt(44927, "d-mmm").text).toBe("1-Jan");
+  });
+
+  // ID 17: mmm-yy
+  test("ID 17 — mmm-yy", () => {
+    expect(formatNumFmt(44927, "mmm-yy").text).toBe("Jan-23");
+  });
+
+  // ID 18: h:mm AM/PM
+  test("ID 18 — h:mm AM/PM", () => {
+    // Serial 0.75 = 6:00 PM
+    expect(formatNumFmt(0.75, "h:mm AM/PM").text).toBe("6:00 PM");
+    // Serial 0.25 = 6:00 AM
+    expect(formatNumFmt(0.25, "h:mm AM/PM").text).toBe("6:00 AM");
+  });
+
+  // ID 19: h:mm:ss AM/PM
+  test("ID 19 — h:mm:ss AM/PM", () => {
+    expect(formatNumFmt(0.5, "h:mm:ss AM/PM").text).toBe("12:00:00 PM");
+  });
+
+  // ID 20: h:mm
+  test("ID 20 — h:mm", () => {
+    expect(formatNumFmt(0.75, "h:mm").text).toBe("18:00");
+  });
+
+  // ID 21: h:mm:ss
+  test("ID 21 — h:mm:ss", () => {
+    expect(formatNumFmt(0.75, "h:mm:ss").text).toBe("18:00:00");
+  });
+
+  // ID 22: m/d/yy h:mm
+  test("ID 22 — m/d/yy h:mm", () => {
+    // 44927.75 = 2023-01-01 18:00
+    expect(formatNumFmt(44927.75, "m/d/yy h:mm").text).toBe("1/1/23 18:00");
+  });
+
+  // ID 37: #,##0 ;(#,##0)
+  test("ID 37 — #,##0 ;(#,##0)", () => {
+    expect(formatNumFmt(1234, "#,##0 ;(#,##0)").text).toBe("1,234 ");
+    expect(formatNumFmt(-1234, "#,##0 ;(#,##0)").text).toBe("(1,234)");
+  });
+
+  // ID 38: #,##0 ;[Red](#,##0)
+  test("ID 38 — #,##0 ;[Red](#,##0)", () => {
+    const pos = formatNumFmt(1234, "#,##0 ;[Red](#,##0)");
+    expect(pos.text).toBe("1,234 ");
+    expect(pos.color).toBeUndefined();
+
+    const neg = formatNumFmt(-1234, "#,##0 ;[Red](#,##0)");
+    expect(neg.text).toBe("(1,234)");
+    expect(neg.color).toBe("#FF0000");
+  });
+
+  // ID 39: #,##0.00;(#,##0.00)
+  test("ID 39 — #,##0.00;(#,##0.00)", () => {
+    expect(formatNumFmt(1234.56, "#,##0.00;(#,##0.00)").text).toBe("1,234.56");
+    expect(formatNumFmt(-1234.56, "#,##0.00;(#,##0.00)").text).toBe("(1,234.56)");
+  });
+
+  // ID 40: #,##0.00;[Red](#,##0.00)
+  test("ID 40 — #,##0.00;[Red](#,##0.00)", () => {
+    const neg = formatNumFmt(-1234.56, "#,##0.00;[Red](#,##0.00)");
+    expect(neg.text).toBe("(1,234.56)");
+    expect(neg.color).toBe("#FF0000");
+  });
+
+  // ID 45: mm:ss
+  test("ID 45 — mm:ss", () => {
+    // 0.5 = 12h = 720min → 00:00 of time part? Actually mm:ss is minutes:seconds
+    // For serial 0.04236... = 1 hour, 1 minute, 1 second? Let me use a clearer example:
+    // 0.25 = 6:00:00 → mm=00, ss=00
+    expect(formatNumFmt(0.25, "mm:ss").text).toBe("00:00");
+  });
+
+  // ID 46: [h]:mm:ss
+  test("ID 46 — [h]:mm:ss", () => {
+    // 1.5 = 36 hours
+    expect(formatNumFmt(1.5, "[h]:mm:ss").text).toBe("36:00:00");
+  });
+
+  // ID 48: ##0.0E+0
+  test("ID 48 — ##0.0E+0", () => {
+    const result = formatNumFmt(1234, "##0.0E+0").text;
+    expect(result).toContain("E+");
+  });
+
+  // ID 49: @
+  test("ID 49 — @", () => {
+    expect(formatNumFmt("Hello", "@").text).toBe("Hello");
+  });
+});
+
+// =============================================================================
+// 4-section format codes
+// =============================================================================
+
+describe("4-section format codes", () => {
+  const fmt = '#,##0.00;(#,##0.00);"Zero";"Text: "@';
+
+  test("positive section", () => {
+    expect(formatNumFmt(42.5, fmt).text).toBe("42.50");
+  });
+
+  test("negative section (absolute value, no sign)", () => {
+    expect(formatNumFmt(-42.5, fmt).text).toBe("(42.50)");
+  });
+
+  test("zero section", () => {
+    expect(formatNumFmt(0, fmt).text).toBe("Zero");
+  });
+
+  test("text section", () => {
+    expect(formatNumFmt("Hello", fmt).text).toBe("Text: Hello");
+  });
+});
+
+// =============================================================================
+// Color codes
+// =============================================================================
+
+describe("color codes", () => {
+  test("[Red] returns red color", () => {
+    const result = formatNumFmt(42, "[Red]#,##0");
+    expect(result.text).toBe("42");
+    expect(result.color).toBe("#FF0000");
+  });
+
+  test("[Blue] returns blue color", () => {
+    const result = formatNumFmt(42, "[Blue]0.00");
+    expect(result.text).toBe("42.00");
+    expect(result.color).toBe("#0000FF");
+  });
+
+  test("[Green] returns green color", () => {
+    const result = formatNumFmt(42, "[Green]0");
+    expect(result.text).toBe("42");
+    expect(result.color).toBe("#008000");
+  });
+
+  test("color in negative section only", () => {
+    const pos = formatNumFmt(42, "#,##0;[Red]-#,##0");
+    expect(pos.color).toBeUndefined();
+
+    const neg = formatNumFmt(-42, "#,##0;[Red]-#,##0");
+    expect(neg.color).toBe("#FF0000");
+  });
+
+  test("case-insensitive color matching", () => {
+    expect(formatNumFmt(1, "[red]0").color).toBe("#FF0000");
+    expect(formatNumFmt(1, "[RED]0").color).toBe("#FF0000");
+  });
+});
+
+// =============================================================================
+// Conditional sections
+// =============================================================================
+
+describe("conditional sections", () => {
+  test("[>100] condition selects first section", () => {
+    const fmt = "[>100]#,##0;0.00";
+    expect(formatNumFmt(200, fmt).text).toBe("200");
+    expect(formatNumFmt(50, fmt).text).toBe("50.00");
+  });
+
+  test("[<=0] condition", () => {
+    const fmt = "[<=0]0;#,##0";
+    expect(formatNumFmt(0, fmt).text).toBe("0");
+    expect(formatNumFmt(1234, fmt).text).toBe("1,234");
+  });
+});
+
+// =============================================================================
+// Date/time formats
+// =============================================================================
+
+describe("date/time formatting", () => {
+  // 44927 = 2023-01-01 (Sunday)
+  const serial = 44927;
+
+  test("yyyy-mm-dd", () => {
+    expect(formatNumFmt(serial, "yyyy-mm-dd").text).toBe("2023-01-01");
+  });
+
+  test("dd/mm/yyyy", () => {
+    expect(formatNumFmt(serial, "dd/mm/yyyy").text).toBe("01/01/2023");
+  });
+
+  test("m/d/yyyy", () => {
+    expect(formatNumFmt(serial, "m/d/yyyy").text).toBe("1/1/2023");
+  });
+
+  test("mmmm d, yyyy", () => {
+    expect(formatNumFmt(serial, 'mmmm d, yyyy').text).toBe("January 1, 2023");
+  });
+
+  test("mmmmm (first letter of month)", () => {
+    expect(formatNumFmt(serial, "mmmmm").text).toBe("J");
+  });
+
+  test("dddd (full day name)", () => {
+    expect(formatNumFmt(serial, "dddd").text).toBe("Sunday");
+  });
+
+  test("ddd (abbreviated day name)", () => {
+    expect(formatNumFmt(serial, "ddd").text).toBe("Sun");
+  });
+
+  test("yy (2-digit year)", () => {
+    expect(formatNumFmt(serial, "yy").text).toBe("23");
+  });
+
+  test("h:mm:ss with time fraction", () => {
+    // 0.5625 = 13:30:00
+    expect(formatNumFmt(0.5625, "h:mm:ss").text).toBe("13:30:00");
+  });
+
+  test("hh:mm:ss zero-padded", () => {
+    expect(formatNumFmt(0.125, "hh:mm:ss").text).toBe("03:00:00");
+  });
+
+  test("AM/PM formatting", () => {
+    expect(formatNumFmt(0.25, "h:mm AM/PM").text).toBe("6:00 AM");
+    expect(formatNumFmt(0.75, "h:mm AM/PM").text).toBe("6:00 PM");
+    expect(formatNumFmt(0.5, "h:mm AM/PM").text).toBe("12:00 PM");
+    expect(formatNumFmt(0, "h:mm AM/PM").text).toBe("12:00 AM");
+  });
+
+  test("A/P short format", () => {
+    expect(formatNumFmt(0.25, "h:mm A/P").text).toBe("6:00 A");
+    expect(formatNumFmt(0.75, "h:mm A/P").text).toBe("6:00 P");
+  });
+
+  test("m resolves to minutes when after h", () => {
+    expect(formatNumFmt(0.5625, "h:mm").text).toBe("13:30");
+  });
+
+  test("m resolves to minutes when before s", () => {
+    expect(formatNumFmt(0.5625, "mm:ss").text).toBe("30:00");
+  });
+
+  test("date with quoted literals", () => {
+    expect(formatNumFmt(serial, 'yyyy"/"mm"/"dd').text).toBe("2023/01/01");
+  });
+});
+
+// =============================================================================
+// Elapsed time
+// =============================================================================
+
+describe("elapsed time", () => {
+  test("[h]:mm:ss for > 24 hours", () => {
+    expect(formatNumFmt(1.5, "[h]:mm:ss").text).toBe("36:00:00");
+  });
+
+  test("[h]:mm:ss for < 24 hours", () => {
+    expect(formatNumFmt(0.5, "[h]:mm:ss").text).toBe("12:00:00");
+  });
+
+  test("[m]:ss for elapsed minutes", () => {
+    // 0.5 = 12 hours = 720 minutes
+    expect(formatNumFmt(0.5, "[m]:ss").text).toBe("720:00");
+  });
+
+  test("[s] for elapsed seconds", () => {
+    // 0.5 = 12 hours = 43200 seconds
+    expect(formatNumFmt(0.5, "[s]").text).toBe("43200");
+  });
+});
+
+// =============================================================================
+// Fractions
+// =============================================================================
+
+describe("fractions", () => {
+  test("# ?/? for simple fraction", () => {
+    const result = formatNumFmt(3.25, "# ?/?").text;
+    expect(result.trim()).toMatch(/3\s+1\/4/);
+  });
+
+  test("# ?/? for zero fraction shows integer only", () => {
+    const result = formatNumFmt(5, "# ?/?").text;
+    expect(result).toContain("5");
+  });
+
+  test("fixed denominator # ?/4", () => {
+    const result = formatNumFmt(3.5, "# ?/4").text;
+    expect(result).toContain("2/4");
+  });
+
+  test("fixed denominator # ?/8", () => {
+    const result = formatNumFmt(0.625, "# ?/8").text;
+    expect(result).toContain("5/8");
+  });
+});
+
+// =============================================================================
+// Scientific notation
+// =============================================================================
+
+describe("scientific notation", () => {
+  test("0.00E+00 positive", () => {
+    expect(formatNumFmt(1234, "0.00E+00").text).toBe("1.23E+03");
+  });
+
+  test("0.00E+00 negative exponent", () => {
+    expect(formatNumFmt(0.005, "0.00E+00").text).toBe("5.00E-03");
+  });
+
+  test("0.00E+00 zero", () => {
+    expect(formatNumFmt(0, "0.00E+00").text).toBe("0.00E+00");
+  });
+
+  test("0E+0 compact", () => {
+    const result = formatNumFmt(5000, "0E+0").text;
+    expect(result).toContain("E+");
+  });
+});
+
+// =============================================================================
+// Currency and locale codes
+// =============================================================================
+
+describe("currency and locale", () => {
+  test("$#,##0.00", () => {
+    expect(formatNumFmt(1234.56, "$#,##0.00").text).toBe("$1,234.56");
+  });
+
+  test("[$EUR] locale code extracts currency", () => {
+    const result = formatNumFmt(1234.56, '[$EUR]#,##0.00');
+    expect(result.text).toContain("EUR");
+    expect(result.text).toContain("1,234.56");
+  });
+
+  test("[$€-407] locale code with symbol and locale", () => {
+    const result = formatNumFmt(1234.56, "[$€-407]#,##0.00");
+    expect(result.text).toContain("€");
+    expect(result.text).toContain("1,234.56");
+  });
+
+  test("quoted currency suffix", () => {
+    expect(formatNumFmt(50000, '#,##0 "VND"').text).toBe("50,000 VND");
+  });
+});
+
+// =============================================================================
+// Percentage
+// =============================================================================
+
+describe("percentage", () => {
+  test("0% integer percent", () => {
+    expect(formatNumFmt(0.75, "0%").text).toBe("75%");
+  });
+
+  test("0.00% decimal percent", () => {
+    expect(formatNumFmt(0.1234, "0.00%").text).toBe("12.34%");
+  });
+
+  test("0% for value > 1", () => {
+    expect(formatNumFmt(1.5, "0%").text).toBe("150%");
+  });
+});
+
+// =============================================================================
+// Thousands separator and scaling
+// =============================================================================
+
+describe("thousands separator and scaling", () => {
+  test("#,##0 groups thousands", () => {
+    expect(formatNumFmt(1234567, "#,##0").text).toBe("1,234,567");
+  });
+
+  test("trailing comma scales by 1000", () => {
+    expect(formatNumFmt(1234567, "#,##0,").text).toBe("1,235");
+  });
+
+  test("two trailing commas scale by 1000000", () => {
+    expect(formatNumFmt(1234567890, "#,##0,,").text).toBe("1,235");
+  });
+});
+
+// =============================================================================
+// Digit placeholders
+// =============================================================================
+
+describe("digit placeholders", () => {
+  test("0 pads with zeros", () => {
+    expect(formatNumFmt(5, "000").text).toBe("005");
+  });
+
+  test("# suppresses leading zeros", () => {
+    expect(formatNumFmt(5, "###").text).toBe("5");
+  });
+
+  test("0.000 fixed decimal places", () => {
+    expect(formatNumFmt(3.1, "0.000").text).toBe("3.100");
+  });
+
+  test("0 rounds to integer", () => {
+    expect(formatNumFmt(3.7, "0").text).toBe("4");
+  });
+
+  test("#.## trims trailing zeros", () => {
+    expect(formatNumFmt(3.1, "#.##").text).toBe("3.1");
+  });
+
+  test("#.## shows .5 not 0.5", () => {
+    expect(formatNumFmt(0.5, "#.##").text).toBe(".5");
+  });
+});
+
+// =============================================================================
+// Underscore spacing and fill characters
+// =============================================================================
+
+describe("underscore and fill", () => {
+  test("_) adds a space", () => {
+    expect(formatNumFmt(42, "0_)").text).toBe("42 ");
+  });
+
+  test("*- fill character is stripped", () => {
+    expect(formatNumFmt(42, "0*-").text).toBe("42");
+  });
+});
+
+// =============================================================================
+// Negative numbers
+// =============================================================================
+
+describe("negative numbers", () => {
+  test("single section format shows minus sign", () => {
+    expect(formatNumFmt(-42, "#,##0").text).toBe("-42");
+  });
+
+  test("2-section format uses second section for negative", () => {
+    expect(formatNumFmt(-42, "#,##0;(#,##0)").text).toBe("(42)");
+  });
+
+  test("2-section format positive uses first section", () => {
+    expect(formatNumFmt(42, "#,##0;(#,##0)").text).toBe("42");
+  });
+});
+
+// =============================================================================
+// Text format (@)
+// =============================================================================
+
+describe("text format", () => {
+  test("@ passes text through", () => {
+    expect(formatNumFmt("Hello", "@").text).toBe("Hello");
+  });
+
+  test("4-section text section with prefix", () => {
+    expect(formatNumFmt("World", '0;0;0;"Hello "@').text).toBe("Hello World");
+  });
+});
+
+// =============================================================================
+// serialToDateParts
+// =============================================================================
+
+describe("serialToDateParts", () => {
+  test("serial 44927 = 2023-01-01", () => {
+    const p = serialToDateParts(44927, false);
+    expect(p.year).toBe(2023);
+    expect(p.month).toBe(1);
+    expect(p.day).toBe(1);
+  });
+
+  test("time fraction", () => {
+    const p = serialToDateParts(0.5, false);
+    expect(p.hours).toBe(12);
+    expect(p.minutes).toBe(0);
+    expect(p.seconds).toBe(0);
+  });
+
+  test("1904 date system", () => {
+    // In 1904 system, serial 0 = 1904-01-01
+    // Adding 1462 days shifts to 1900 system equivalent
+    const p = serialToDateParts(44927, true);
+    expect(p.year).toBe(2027);
+  });
+});