@depup/jsdom 28.1.0-depup.1

package/lib/jsdom/living/helpers/dates-and-times.js

@@ -0,0 +1,270 @@
+"use strict";
+
+function isLeapYear(year) {
+  return year % 400 === 0 || (year % 4 === 0 && year % 100 !== 0);
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#number-of-days-in-month-month-of-year-year
+const daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
+function numberOfDaysInMonthOfYear(month, year) {
+  if (month === 2 && isLeapYear(year)) {
+    return 29;
+  }
+  return daysInMonth[month - 1];
+}
+
+const monthRe = /^([0-9]{4,})-([0-9]{2})$/;
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-month-string
+function parseMonthString(str) {
+  const matches = monthRe.exec(str);
+  if (!matches) {
+    return null;
+  }
+  const year = Number(matches[1]);
+  if (year <= 0) {
+    return null;
+  }
+  const month = Number(matches[2]);
+  if (month < 1 || month > 12) {
+    return null;
+  }
+  return { year, month };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-month-string
+function isValidMonthString(str) {
+  return parseMonthString(str) !== null;
+}
+function serializeMonth({ year, month }) {
+  const yearStr = `${year}`.padStart(4, "0");
+  const monthStr = `${month}`.padStart(2, "0");
+  return `${yearStr}-${monthStr}`;
+}
+
+const dateRe = /^([0-9]{4,})-([0-9]{2})-([0-9]{2})$/;
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-date-string
+function parseDateString(str) {
+  const matches = dateRe.exec(str);
+  if (!matches) {
+    return null;
+  }
+  const year = Number(matches[1]);
+  if (year <= 0) {
+    return null;
+  }
+  const month = Number(matches[2]);
+  if (month < 1 || month > 12) {
+    return null;
+  }
+  const day = Number(matches[3]);
+  if (day < 1 || day > numberOfDaysInMonthOfYear(month, year)) {
+    return null;
+  }
+  return { year, month, day };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-date-string
+function isValidDateString(str) {
+  return parseDateString(str) !== null;
+}
+function serializeDate(date) {
+  const dayStr = `${date.day}`.padStart(2, "0");
+  return `${serializeMonth(date)}-${dayStr}`;
+}
+
+const yearlessDateRe = /^(?:--)?([0-9]{2})-([0-9]{2})$/;
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-yearless-date-string
+function parseYearlessDateString(str) {
+  const matches = yearlessDateRe.exec(str);
+  if (!matches) {
+    return null;
+  }
+  const month = Number(matches[1]);
+  if (month < 1 || month > 12) {
+    return null;
+  }
+  const day = Number(matches[2]);
+  if (day < 1 || day > numberOfDaysInMonthOfYear(month, 4)) {
+    return null;
+  }
+  return { month, day };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-yearless-date-string
+function isValidYearlessDateString(str) {
+  return parseYearlessDateString(str) !== null;
+}
+function serializeYearlessDate({ month, day }) {
+  const monthStr = `${month}`.padStart(2, "0");
+  const dayStr = `${day}`.padStart(2, "0");
+  return `${monthStr}-${dayStr}`;
+}
+
+const timeRe = /^([0-9]{2}):([0-9]{2})(?::([0-9]{2}(?:\.([0-9]{1,3}))?))?$/;
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-time-string
+function parseTimeString(str) {
+  const matches = timeRe.exec(str);
+  if (!matches) {
+    return null;
+  }
+  const hour = Number(matches[1]);
+  if (hour < 0 || hour > 23) {
+    return null;
+  }
+  const minute = Number(matches[2]);
+  if (minute < 0 || minute > 59) {
+    return null;
+  }
+  const second = matches[3] !== undefined ? Math.trunc(Number(matches[3])) : 0;
+  if (second < 0 || second >= 60) {
+    return null;
+  }
+  const millisecond = matches[4] !== undefined ? Number(matches[4]) : 0;
+  return { hour, minute, second, millisecond };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-time-string
+function isValidTimeString(str) {
+  return parseTimeString(str) !== null;
+}
+
+function serializeTime({ hour, minute, second, millisecond }) {
+  const hourStr = `${hour}`.padStart(2, "0");
+  const minuteStr = `${minute}`.padStart(2, "0");
+  if (second === 0 && millisecond === 0) {
+    return `${hourStr}:${minuteStr}`;
+  }
+  const secondStr = `${second}`.padStart(2, "0");
+  const millisecondStr = `${millisecond}`.padStart(3, "0");
+  return `${hourStr}:${minuteStr}:${secondStr}.${millisecondStr}`;
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-local-date-and-time-string
+function parseLocalDateAndTimeString(str, normalized = false) {
+  let separatorIdx = str.indexOf("T");
+  if (separatorIdx < 0 && !normalized) {
+    separatorIdx = str.indexOf(" ");
+  }
+  if (separatorIdx < 0) {
+    return null;
+  }
+  const date = parseDateString(str.slice(0, separatorIdx));
+  if (date === null) {
+    return null;
+  }
+  const time = parseTimeString(str.slice(separatorIdx + 1));
+  if (time === null) {
+    return null;
+  }
+  return { date, time };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-local-date-and-time-string
+function isValidLocalDateAndTimeString(str) {
+  return parseLocalDateAndTimeString(str) !== null;
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-normalised-local-date-and-time-string
+function isValidNormalizedLocalDateAndTimeString(str) {
+  return parseLocalDateAndTimeString(str, true) !== null;
+}
+function serializeNormalizedDateAndTime({ date, time }) {
+  return `${serializeDate(date)}T${serializeTime(time)}`;
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#week-number-of-the-last-day
+// https://stackoverflow.com/a/18538272/1937836
+function weekNumberOfLastDay(year) {
+  const jan1 = new Date(year, 0);
+  return jan1.getDay() === 4 || (isLeapYear(year) && jan1.getDay() === 3) ? 53 : 52;
+}
+
+const weekRe = /^([0-9]{4,5})-W([0-9]{2})$/;
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#parse-a-week-string
+function parseWeekString(str) {
+  const matches = weekRe.exec(str);
+  if (!matches) {
+    return null;
+  }
+  const year = Number(matches[1]);
+  if (year <= 0) {
+    return null;
+  }
+  const week = Number(matches[2]);
+  if (week < 1 || week > weekNumberOfLastDay(year)) {
+    return null;
+  }
+  return { year, week };
+}
+
+// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-week-string
+function isValidWeekString(str) {
+  return parseWeekString(str) !== null;
+}
+function serializeWeek({ year, week }) {
+  const yearStr = `${year}`.padStart(4, "0");
+  const weekStr = `${week}`.padStart(2, "0");
+  return `${yearStr}-W${weekStr}`;
+}
+
+// https://stackoverflow.com/a/6117889
+function parseDateAsWeek(originalDate) {
+  const dayInSeconds = 86400000;
+  // Copy date so don't modify original
+  const date = new Date(Date.UTC(originalDate.getUTCFullYear(), originalDate.getUTCMonth(), originalDate.getUTCDate()));
+  // Set to nearest Thursday: current date + 4 - current day number
+  // Make Sunday's day number 7
+  date.setUTCDate(date.getUTCDate() + 4 - (date.getUTCDay() || 7));
+  // Get first day of year
+  const yearStart = new Date(Date.UTC(date.getUTCFullYear(), 0, 1));
+  // Calculate full weeks to nearest Thursday
+  const week = Math.ceil((((date - yearStart) / dayInSeconds) + 1) / 7);
+
+  return { year: date.getUTCFullYear(), week };
+}
+
+function isDate(obj) {
+  try {
+    Date.prototype.valueOf.call(obj);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+module.exports = {
+  isDate,
+  numberOfDaysInMonthOfYear,
+
+  parseMonthString,
+  isValidMonthString,
+  serializeMonth,
+
+  parseDateString,
+  isValidDateString,
+  serializeDate,
+
+  parseYearlessDateString,
+  isValidYearlessDateString,
+  serializeYearlessDate,
+
+  parseTimeString,
+  isValidTimeString,
+  serializeTime,
+
+  parseLocalDateAndTimeString,
+  isValidLocalDateAndTimeString,
+  isValidNormalizedLocalDateAndTimeString,
+  serializeNormalizedDateAndTime,
+
+  parseDateAsWeek,
+  weekNumberOfLastDay,
+  parseWeekString,
+  isValidWeekString,
+  serializeWeek
+};

package/lib/jsdom/living/helpers/details.js

@@ -0,0 +1,15 @@
+"use strict";
+const { firstChildWithLocalName } = require("./traversal");
+const { HTML_NS } = require("./namespaces");
+
+// https://html.spec.whatwg.org/multipage/interactive-elements.html#summary-for-its-parent-details
+exports.isSummaryForParentDetails = summaryElement => {
+  const parent = summaryElement.parentNode;
+  if (parent === null) {
+    return false;
+  }
+  if (parent._localName !== "details" || parent._namespaceURI !== HTML_NS) {
+    return false;
+  }
+  return firstChildWithLocalName(parent, "summary") === summaryElement;
+};

package/lib/jsdom/living/helpers/encoding.js

@@ -0,0 +1,60 @@
+"use strict";
+// Small wrapper around Node.js's native `TextEncoder`/`TextDecoder`to expose functions with names matching the
+// Encoding Standard, so it's more obvious what to use when implementing specs. See also discussion at
+// https://github.com/ExodusOSS/bytes/issues/17.
+//
+// Note that we could also use `@exodus/bytes` instead of Node.js's native `TextEncoder`/`TextDecoder`. This could give
+// benefits on non-Node.js environments. But, on Node.js, `@exodus/bytes` just delegates to the native classes, plus
+// adds some extra type checks that we don't want. Per the discussion above, it fixes some bugs, but they are not
+// relevant for our use cases.
+
+const encoder = new TextEncoder();
+const decoder = new TextDecoder("utf-8", { ignoreBOM: false, fatal: false });
+const decoderWithoutBOM = new TextDecoder("utf-8", { ignoreBOM: true, fatal: false });
+const decoderWithoutBOMOrFail = new TextDecoder("utf-8", { ignoreBOM: true, fatal: true });
+
+/**
+ * Implements the <https://encoding.spec.whatwg.org/#utf-8-decode> algorithm. If there are three preceding BOM bytes,
+ * they are discarded, and any lone surrogates become U+FFFD.
+ *
+ * @param {Uint8Array} bytes - The bytes to decode.
+ * @returns {string} - The decoded string.
+ */
+exports.utf8Decode = bytes => {
+  return decoder.decode(bytes);
+};
+
+/**
+ * Implements the <https://encoding.spec.whatwg.org/#utf-8-decode-without-bom> algorithm. If there are three preceding
+ * BOM bytes, they become U+FEFF, and any lone surrogates become U+FFFD.
+ *
+ * @param {Uint8Array} bytes - The bytes to decode.
+ * @returns {string} - The decoded string.
+ */
+exports.utf8DecodeWithoutBOM = bytes => {
+  return decoderWithoutBOM.decode(bytes);
+};
+
+/**
+ * Implements the <https://encoding.spec.whatwg.org/#utf-8-decode-without-bom-or-fail> algorithm. If there are three
+ * preceding BOM bytes, they become U+FEFF, and any lone surrogates cause an exception.
+ *
+ * @param {Uint8Array} bytes - The bytes to decode.
+ * @returns {string} - The decoded string.
+ */
+exports.utf8DecodeWithoutBOMOrFail = bytes => {
+  return decoderWithoutBOMOrFail.decode(bytes);
+};
+
+/**
+ * Implements the <https://encoding.spec.whatwg.org/#utf-8-decode> algorithm, but also bundles in `USVString` conversion
+ * (i.e. lone surrogates become 0xEF 0xBF 0xBD).
+ *
+ * @param {string} string - A string, possibly containing lone surrogates. If the string contains no lone surrogates,
+ * then this behaves as the spec algorithm. Otherwise, it behaves as the composition of the spec algorithm and
+ * `USVString` conversion.
+ * @returns {Uint8Array} - The UTF-8 encoded bytes of the input string.
+ */
+exports.utf8Encode = string => {
+  return encoder.encode(string);
+};

package/lib/jsdom/living/helpers/events.js

@@ -0,0 +1,24 @@
+"use strict";
+
+const Event = require("../../../generated/idl/Event");
+const { tryImplForWrapper } = require("../../../generated/idl/utils");
+
+function createAnEvent(e, globalObject, eventInterface = Event, attributes = {}) {
+  return eventInterface.createImpl(
+    globalObject,
+    [e, attributes],
+    { isTrusted: attributes.isTrusted !== false }
+  );
+}
+
+function fireAnEvent(e, target, eventInterface, attributes, legacyTargetOverrideFlag) {
+  const event = createAnEvent(e, target._globalObject, eventInterface, attributes);
+
+  // tryImplForWrapper() is currently required due to use in Window.js
+  return tryImplForWrapper(target)._dispatch(event, legacyTargetOverrideFlag);
+}
+
+module.exports = {
+  createAnEvent,
+  fireAnEvent
+};

package/lib/jsdom/living/helpers/focusing.js

@@ -0,0 +1,104 @@
+"use strict";
+const FocusEvent = require("../../../generated/idl/FocusEvent.js");
+const idlUtils = require("../../../generated/idl/utils.js");
+const { isDisabled } = require("./form-controls.js");
+const { firstChildWithLocalName } = require("./traversal");
+const { createAnEvent } = require("./events");
+const { HTML_NS, SVG_NS } = require("./namespaces");
+const { isRenderedElement } = require("./svg/render");
+
+const focusableFormElements = new Set(["input", "select", "textarea", "button"]);
+
+// https://html.spec.whatwg.org/multipage/interaction.html#focusable-area, but also some of
+// https://html.spec.whatwg.org/multipage/interaction.html#focusing-steps and some of
+// https://svgwg.org/svg2-draft/interact.html#TermFocusable
+exports.isFocusableAreaElement = elImpl => {
+  // We implemented most of the suggested focusable elements found here:
+  // https://html.spec.whatwg.org/multipage/interaction.html#tabindex-value
+  // However, some suggested elements are not focusable in web browsers, as detailed here:
+  // https://github.com/whatwg/html/issues/5490
+  if (elImpl._namespaceURI === HTML_NS) {
+    if (!elImpl._ownerDocument._defaultView) {
+      return false;
+    }
+
+    if (!elImpl.isConnected) {
+      return false;
+    }
+
+    if (!Number.isNaN(parseInt(elImpl.getAttributeNS(null, "tabindex")))) {
+      return true;
+    }
+
+    if (elImpl._localName === "iframe") {
+      return true;
+    }
+
+    if (elImpl._localName === "a" && elImpl.hasAttributeNS(null, "href")) {
+      return true;
+    }
+
+    if (elImpl._localName === "summary" && elImpl.parentNode &&
+        elImpl.parentNode._localName === "details" &&
+        elImpl === firstChildWithLocalName(elImpl.parentNode, "summary")) {
+      return true;
+    }
+
+    if (focusableFormElements.has(elImpl._localName) && !isDisabled(elImpl)) {
+      if (elImpl._localName === "input" && elImpl.type === "hidden") {
+        return false;
+      }
+
+      return true;
+    }
+
+    if (elImpl.hasAttributeNS(null, "contenteditable")) {
+      return true;
+    }
+
+    return false;
+
+    // This does not check for a designMode Document as specified in
+    // https://html.spec.whatwg.org/multipage/interaction.html#editing-host because the designMode
+    // attribute is not implemented.
+  }
+
+  if (elImpl._namespaceURI === SVG_NS) {
+    if (!Number.isNaN(parseInt(elImpl.getAttributeNS(null, "tabindex"))) && isRenderedElement(elImpl)) {
+      return true;
+    }
+
+    if (elImpl._localName === "a" && elImpl.hasAttributeNS(null, "href")) {
+      return true;
+    }
+
+    return false;
+  }
+
+  return false;
+};
+
+// https://html.spec.whatwg.org/multipage/interaction.html#fire-a-focus-event plus the steps of
+// https://html.spec.whatwg.org/multipage/interaction.html#focus-update-steps that adjust Documents to Windows
+// It's extended with the bubbles option to also handle focusin/focusout, which are "defined" in
+// https://w3c.github.io/uievents/#event-type-focusin. See https://github.com/whatwg/html/issues/3514.
+exports.fireFocusEventWithTargetAdjustment = (name, target, relatedTarget, { bubbles = false } = {}) => {
+  if (target === null) {
+    // E.g. firing blur with nothing previously focused.
+    return;
+  }
+
+  const event = createAnEvent(name, target._globalObject, FocusEvent, {
+    bubbles,
+    composed: true,
+    relatedTarget,
+    view: target._ownerDocument._defaultView,
+    detail: 0
+  });
+
+  if (target._defaultView) {
+    target = idlUtils.implForWrapper(target._defaultView);
+  }
+
+  target._dispatch(event);
+};