@trackunit/date-and-time-utils 1.19.0 → 1.19.1-alpha-d660d5dfec1.0

package/README.md

@@ -10,6 +10,12 @@ AI agents should use the machine-readable index at [`/llms.txt`](https://design.
 
 For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
 
+## System time zone fallback
+
+Importing this package patches `Intl.DateTimeFormat.prototype.resolvedOptions` for the whole page. Some browsers report the system `timeZone` as `undefined` when they can't map the OS time zone to an IANA id (for example Chrome on Windows with "British Columbia Standard Time"), which makes the Temporal polyfill throw. The patch fills in the `Etc/GMT` zone for the system's current whole-hour UTC offset (UTC-07:00 becomes `Etc/GMT+7`), or `UTC` otherwise.
+
+Browsers that resolve a time zone, explicitly requested time zones and server runtimes are unaffected.
+
 ## Trackunit
 
 This package was developed by Trackunit ApS.

package/index.cjs.js

@@ -2,6 +2,39 @@
 
 var polyfill = require('@js-temporal/polyfill');
 
+const UTC_TIME_ZONE_ID = "UTC";
+/**
+ * Returns the `Etc/GMT` time zone matching the system's current UTC offset, or `UTC` when the
+ * offset isn't a whole number of hours. Offset ids like `-07:00` aren't used because the Temporal
+ * polyfill can't format dates in them.
+ */
+const getSystemOffsetTimeZoneId = () => {
+    const offsetHours = -new Date().getTimezoneOffset() / 60;
+    // Etc/GMT zones only exist from UTC-12 to UTC+14.
+    if (offsetHours === 0 || !Number.isInteger(offsetHours) || offsetHours < -12 || offsetHours > 14) {
+        return UTC_TIME_ZONE_ID;
+    }
+    // Etc/GMT ids use the POSIX sign convention, so UTC-07:00 is Etc/GMT+7.
+    return `Etc/GMT${offsetHours > 0 ? "-" : "+"}${Math.abs(offsetHours)}`;
+};
+const SYSTEM_TIME_ZONE_FALLBACK = Symbol.for("@trackunit/date-and-time-utils/system-time-zone-fallback");
+const nativeResolvedOptions = Intl.DateTimeFormat.prototype.resolvedOptions;
+/**
+ * Browsers resolve `timeZone` to `undefined` when they can't map the OS time zone to an IANA id
+ * (e.g. Chrome with the Windows "British Columbia Standard Time" zone). The Temporal polyfill reads
+ * it for `Temporal.Now` and for formatting, and throws on `undefined`, so fill in a fallback zone.
+ * Skipped when another copy of this library already installed it.
+ */
+if (!(SYSTEM_TIME_ZONE_FALLBACK in nativeResolvedOptions)) {
+    Intl.DateTimeFormat.prototype.resolvedOptions = Object.assign(function resolvedOptions() {
+        const options = nativeResolvedOptions.call(this);
+        if (!options.timeZone) {
+            options.timeZone = getSystemOffsetTimeZoneId();
+        }
+        return options;
+    }, { [SYSTEM_TIME_ZONE_FALLBACK]: true });
+}
+
 /**
  * converts timZoneId to TimeZone object with default to current user timezone
  *
@@ -128,10 +161,12 @@ const getHourCycle = (locale, hourCycleOverride) => {
 const formatDateUtil = (date, format, timeZone, locale, hourCycleOverride) => {
     const hourCycle = getHourCycle(locale, hourCycleOverride);
     const dateObj = timeZone ? toZonedDateTimeUtil(date, timeZone) : toTemporalUtil(toDateUtil(date));
+    // Plain values are formatted in UTC, so the output doesn't depend on the browser's system time zone.
     if (format?.selectFormat === "dateOnly") {
         if (dateObj instanceof polyfill.Temporal.ZonedDateTime) {
             return dateObj.toPlainDate().toLocaleString(locale, {
                 dateStyle: format.dateFormat ?? "medium",
+                timeZone: "UTC",
             });
         }
         return dateObj.toLocaleString(locale, {
@@ -144,6 +179,7 @@ const formatDateUtil = (date, format, timeZone, locale, hourCycleOverride) => {
             return dateObj.toPlainTime().toLocaleString(locale, {
                 timeStyle: format.timeFormat ?? "short",
                 hourCycle,
+                timeZone: "UTC",
             });
         }
         return dateObj.toLocaleString(locale, {

package/index.esm.js

@@ -1,6 +1,39 @@
 import { Temporal } from '@js-temporal/polyfill';
 export { Temporal } from '@js-temporal/polyfill';
 
+const UTC_TIME_ZONE_ID = "UTC";
+/**
+ * Returns the `Etc/GMT` time zone matching the system's current UTC offset, or `UTC` when the
+ * offset isn't a whole number of hours. Offset ids like `-07:00` aren't used because the Temporal
+ * polyfill can't format dates in them.
+ */
+const getSystemOffsetTimeZoneId = () => {
+    const offsetHours = -new Date().getTimezoneOffset() / 60;
+    // Etc/GMT zones only exist from UTC-12 to UTC+14.
+    if (offsetHours === 0 || !Number.isInteger(offsetHours) || offsetHours < -12 || offsetHours > 14) {
+        return UTC_TIME_ZONE_ID;
+    }
+    // Etc/GMT ids use the POSIX sign convention, so UTC-07:00 is Etc/GMT+7.
+    return `Etc/GMT${offsetHours > 0 ? "-" : "+"}${Math.abs(offsetHours)}`;
+};
+const SYSTEM_TIME_ZONE_FALLBACK = Symbol.for("@trackunit/date-and-time-utils/system-time-zone-fallback");
+const nativeResolvedOptions = Intl.DateTimeFormat.prototype.resolvedOptions;
+/**
+ * Browsers resolve `timeZone` to `undefined` when they can't map the OS time zone to an IANA id
+ * (e.g. Chrome with the Windows "British Columbia Standard Time" zone). The Temporal polyfill reads
+ * it for `Temporal.Now` and for formatting, and throws on `undefined`, so fill in a fallback zone.
+ * Skipped when another copy of this library already installed it.
+ */
+if (!(SYSTEM_TIME_ZONE_FALLBACK in nativeResolvedOptions)) {
+    Intl.DateTimeFormat.prototype.resolvedOptions = Object.assign(function resolvedOptions() {
+        const options = nativeResolvedOptions.call(this);
+        if (!options.timeZone) {
+            options.timeZone = getSystemOffsetTimeZoneId();
+        }
+        return options;
+    }, { [SYSTEM_TIME_ZONE_FALLBACK]: true });
+}
+
 /**
  * converts timZoneId to TimeZone object with default to current user timezone
  *
@@ -127,10 +160,12 @@ const getHourCycle = (locale, hourCycleOverride) => {
 const formatDateUtil = (date, format, timeZone, locale, hourCycleOverride) => {
     const hourCycle = getHourCycle(locale, hourCycleOverride);
     const dateObj = timeZone ? toZonedDateTimeUtil(date, timeZone) : toTemporalUtil(toDateUtil(date));
+    // Plain values are formatted in UTC, so the output doesn't depend on the browser's system time zone.
     if (format?.selectFormat === "dateOnly") {
         if (dateObj instanceof Temporal.ZonedDateTime) {
             return dateObj.toPlainDate().toLocaleString(locale, {
                 dateStyle: format.dateFormat ?? "medium",
+                timeZone: "UTC",
             });
         }
         return dateObj.toLocaleString(locale, {
@@ -143,6 +178,7 @@ const formatDateUtil = (date, format, timeZone, locale, hourCycleOverride) => {
             return dateObj.toPlainTime().toLocaleString(locale, {
                 timeStyle: format.timeFormat ?? "short",
                 hourCycle,
+                timeZone: "UTC",
             });
         }
         return dateObj.toLocaleString(locale, {

package/migrations/entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.js","sourceRoot":"","sources":["../../../../../libs/date-and-time/utils/migrations/entry.ts"],"names":[],"mappings":"","sourcesContent":["export {};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/date-and-time-utils",
-  "version": "1.19.0",
+  "version": "1.19.1-alpha-d660d5dfec1.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/systemTimeZone.d.ts

@@ -0,0 +1,9 @@
+declare const UTC_TIME_ZONE_ID = "UTC";
+/**
+ * Returns the `Etc/GMT` time zone matching the system's current UTC offset, or `UTC` when the
+ * offset isn't a whole number of hours. Offset ids like `-07:00` aren't used because the Temporal
+ * polyfill can't format dates in them.
+ */
+declare const getSystemOffsetTimeZoneId: () => string;
+declare const SYSTEM_TIME_ZONE_FALLBACK: unique symbol;
+declare const nativeResolvedOptions: () => Intl.ResolvedDateTimeFormatOptions;

package/src/temporal.d.ts

@@ -1 +1,2 @@
+import "./systemTimeZone";
 export { Temporal } from "@js-temporal/polyfill";