@lotics/xlsx 0.1.0

package/src/excel_cf_evaluate.test.ts

@@ -0,0 +1,293 @@
+import { evaluateConditionalFormats, excelSerialToDate } from "./excel_cf_evaluate";
+import type { ParsedConditionalFormat } from "./excel_cf_types";
+import type { ParsedRow } from "./types";
+
+// =============================================================================
+// excelSerialToDate
+// =============================================================================
+
+describe("excelSerialToDate", () => {
+  test("day 1 = Jan 1, 1900 (1900 system)", () => {
+    const d = excelSerialToDate(1);
+    expect(d.getUTCFullYear()).toBe(1900);
+    expect(d.getUTCMonth()).toBe(0);
+    expect(d.getUTCDate()).toBe(1);
+  });
+
+  test("handles 1900 leap year bug (day 60 = Feb 29)", () => {
+    // Excel treats day 60 as Feb 29, 1900 (which doesn't exist).
+    // Day 61 should be Mar 1, 1900.
+    const d = excelSerialToDate(61);
+    expect(d.getUTCFullYear()).toBe(1900);
+    expect(d.getUTCMonth()).toBe(2); // March
+    expect(d.getUTCDate()).toBe(1);
+  });
+
+  test("modern date: 2024-01-15 = serial 45306", () => {
+    // Excel serial for 2024-01-15 is 45306
+    const d = excelSerialToDate(45306);
+    expect(d.getUTCFullYear()).toBe(2024);
+    expect(d.getUTCMonth()).toBe(0);
+    expect(d.getUTCDate()).toBe(15);
+  });
+
+  test("1904 date system: day 0 = Jan 1, 1904", () => {
+    const d = excelSerialToDate(0, true);
+    expect(d.getUTCFullYear()).toBe(1904);
+    expect(d.getUTCMonth()).toBe(0);
+    expect(d.getUTCDate()).toBe(1);
+  });
+
+  test("1904 date system: day 1 = Jan 2, 1904", () => {
+    const d = excelSerialToDate(1, true);
+    expect(d.getUTCFullYear()).toBe(1904);
+    expect(d.getUTCMonth()).toBe(0);
+    expect(d.getUTCDate()).toBe(2);
+  });
+
+  test("1904 date system: modern date", () => {
+    // In 1904 system, the serial is 1462 days less than 1900 system
+    // 2024-01-15 in 1904 system = 45306 - 1462 = 43844
+    const d = excelSerialToDate(43844, true);
+    expect(d.getUTCFullYear()).toBe(2024);
+    expect(d.getUTCMonth()).toBe(0);
+    expect(d.getUTCDate()).toBe(15);
+  });
+});
+
+// =============================================================================
+// CF expression rules
+// =============================================================================
+
+function makeRows(values: Array<{ row: number; col: number; value: string }>): ParsedRow[] {
+  const rowMap = new Map<number, ParsedRow>();
+  for (const { row, col, value } of values) {
+    if (!rowMap.has(row)) {
+      rowMap.set(row, { index: row, height: 15, cells: [], hidden: false });
+    }
+    rowMap.get(row)!.cells.push({
+      column: col,
+      value,
+      content: { type: "plain", text: value },
+      style: {},
+    });
+  }
+  return Array.from(rowMap.values());
+}
+
+describe("CF expression rules", () => {
+  test("expression rule applies when formula returns truthy", () => {
+    const rows = makeRows([
+      { row: 1, col: 1, value: "150000" },
+    ]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "expression",
+        formulae: ["A1>100000"],
+        style: { backgroundColor: "#FF0000" },
+      }],
+    }];
+
+    const evalFormula = (formula: string) => {
+      if (formula === "A1>100000") return true;
+      return false;
+    };
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined, evalFormula);
+    expect(result.get("1:1")?.backgroundColor).toBe("#FF0000");
+  });
+
+  test("expression rule does not apply when formula returns falsy", () => {
+    const rows = makeRows([
+      { row: 1, col: 1, value: "50000" },
+    ]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "expression",
+        formulae: ["A1>100000"],
+        style: { backgroundColor: "#FF0000" },
+      }],
+    }];
+
+    const evalFormula = () => false;
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined, evalFormula);
+    expect(result.get("1:1")).toBeUndefined();
+  });
+
+  test("expression rule does not apply when evaluateFormula is not provided", () => {
+    const rows = makeRows([
+      { row: 1, col: 1, value: "150000" },
+    ]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "expression",
+        formulae: ["A1>100000"],
+        style: { backgroundColor: "#FF0000" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")).toBeUndefined();
+  });
+});
+
+// =============================================================================
+// CF timePeriod rules
+// =============================================================================
+
+describe("CF timePeriod rules", () => {
+  // Helper: convert a JS Date to an Excel serial number (1900 system)
+  function dateToSerial(d: Date): number {
+    const epoch = Date.UTC(1900, 0, 1);
+    const days = Math.floor((d.getTime() - epoch) / 86400000) + 1;
+    // Account for 1900 leap year bug
+    return days > 59 ? days + 1 : days;
+  }
+
+  test("today rule matches today's serial", () => {
+    const now = new Date();
+    const serial = dateToSerial(now);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "today",
+        style: { backgroundColor: "#00FF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")?.backgroundColor).toBe("#00FF00");
+  });
+
+  test("today rule does not match yesterday's serial", () => {
+    const yesterday = new Date();
+    yesterday.setDate(yesterday.getDate() - 1);
+    const serial = dateToSerial(yesterday);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "today",
+        style: { backgroundColor: "#00FF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")).toBeUndefined();
+  });
+
+  test("yesterday rule matches", () => {
+    const yesterday = new Date();
+    yesterday.setDate(yesterday.getDate() - 1);
+    const serial = dateToSerial(yesterday);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "yesterday",
+        style: { backgroundColor: "#00FF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")?.backgroundColor).toBe("#00FF00");
+  });
+
+  test("thisMonth rule matches current month", () => {
+    const now = new Date();
+    const serial = dateToSerial(now);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "thisMonth",
+        style: { backgroundColor: "#0000FF" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")?.backgroundColor).toBe("#0000FF");
+  });
+
+  test("last7Days rule matches date within range", () => {
+    const threeDaysAgo = new Date();
+    threeDaysAgo.setDate(threeDaysAgo.getDate() - 3);
+    const serial = dateToSerial(threeDaysAgo);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "last7Days",
+        style: { backgroundColor: "#FFFF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")?.backgroundColor).toBe("#FFFF00");
+  });
+
+  test("non-numeric cell value does not match timePeriod", () => {
+    const rows = makeRows([{ row: 1, col: 1, value: "hello" }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "today",
+        style: { backgroundColor: "#00FF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined);
+    expect(result.get("1:1")).toBeUndefined();
+  });
+
+  test("date1904 flag adjusts date calculation", () => {
+    // In 1904 mode, serial 0 = Jan 1, 1904
+    // The same serial as "today" in 1900 mode will be a different date in 1904 mode
+    const now = new Date();
+    // Calculate serial for today in 1904 system
+    const epoch1904 = Date.UTC(1904, 0, 1);
+    const serial1904 = Math.floor((now.getTime() - epoch1904) / 86400000);
+    const rows = makeRows([{ row: 1, col: 1, value: String(serial1904) }]);
+    const cfs: ParsedConditionalFormat[] = [{
+      ref: "A1:A1",
+      rules: [{
+        ruleType: "style" as const,
+        priority: 1,
+        type: "timePeriod",
+        timePeriod: "today",
+        style: { backgroundColor: "#00FF00" },
+      }],
+    }];
+
+    const result = evaluateConditionalFormats(cfs, rows, () => undefined, undefined, true);
+    expect(result.get("1:1")?.backgroundColor).toBe("#00FF00");
+  });
+});