@opendata-ai/openchart-core 6.2.0 → 6.2.1

package/dist/index.d.ts

@@ -2401,8 +2401,12 @@ type DateGranularity = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' |
  * @param value - Date object, ISO string, or timestamp number.
  * @param locale - Locale string (currently unused, reserved for i18n).
  * @param granularity - Time granularity for format selection.
+ * @param useUtc - Whether to infer granularity and format using UTC methods.
+ *   Pass `false` when formatting ticks from a local-time scale (d3 scaleTime),
+ *   so that e.g. midnight local isn't misread as an intra-day UTC time.
+ *   Defaults to `true` for backward compatibility.
  */
-declare function formatDate(value: Date | string | number, _locale?: string, granularity?: DateGranularity): string;
+declare function formatDate(value: Date | string | number, _locale?: string, granularity?: DateGranularity, useUtc?: boolean): string;
 /**
  * Build a formatter for temporal values using a d3-time-format string (e.g. "%Y", "%b %Y").
  * Returns a function that accepts a Date, string, or number and returns the formatted string.

package/dist/index.js

@@ -2403,16 +2403,16 @@ var GRANULARITY_FORMATS = {
   hour: "%b %d %H:%M",
   minute: "%H:%M"
 };
-function formatDate(value, _locale, granularity) {
+function formatDate(value, _locale, granularity, useUtc = true) {
   const date = value instanceof Date ? value : new Date(value);
   if (Number.isNaN(date.getTime())) return String(value);
-  const gran = granularity ?? inferGranularity(date);
+  const gran = granularity ?? inferGranularity(date, useUtc);
   if (gran === "quarter") {
-    const q = Math.ceil((date.getMonth() + 1) / 3);
+    const q = useUtc ? Math.ceil((date.getUTCMonth() + 1) / 3) : Math.ceil((date.getMonth() + 1) / 3);
     return `Q${q} ${date.getFullYear()}`;
   }
   const formatStr = GRANULARITY_FORMATS[gran];
-  if (["year", "month", "day"].includes(gran)) {
+  if (useUtc) {
     return utcFormat(formatStr)(date);
   }
   return timeFormat(formatStr)(date);
@@ -2426,12 +2426,16 @@ function buildTemporalFormatter(formatStr) {
     return fmt(date);
   };
 }
-function inferGranularity(date) {
-  if (date.getUTCHours() !== 0 || date.getUTCMinutes() !== 0) {
-    return date.getUTCMinutes() !== 0 ? "minute" : "hour";
+function inferGranularity(date, useUtc = true) {
+  const hours = useUtc ? date.getUTCHours() : date.getHours();
+  const minutes = useUtc ? date.getUTCMinutes() : date.getMinutes();
+  const day = useUtc ? date.getUTCDate() : date.getDate();
+  const month = useUtc ? date.getUTCMonth() : date.getMonth();
+  if (hours !== 0 || minutes !== 0) {
+    return minutes !== 0 ? "minute" : "hour";
   }
-  if (date.getUTCDate() !== 1) return "day";
-  if (date.getUTCMonth() !== 0) return "month";
+  if (day !== 1) return "day";
+  if (month !== 0) return "month";
   return "year";
 }