genesys-spark 4.264.2 → 4.265.0

package/README.md

@@ -50,6 +50,55 @@ that you link stylesheets to load the Urbanist and Noto Sans fonts in your docum
 prior to starting your app. This will improve loading performance and prevent a
 jarring font transition when the required fonts load.
 
+### Unit testing with Jest and jsdom
+
+If you render Spark components in a jsdom test environment, add
+`genesys-spark/dist/testing.cjs` to your Jest `setupFiles`:
+
+```js
+// jest.config.js
+module.exports = {
+  testEnvironment: 'jsdom',
+  setupFiles: ['genesys-spark/dist/testing.cjs']
+};
+```
+
+Without it, your suites use far more memory than they need to, and large suites
+can exhaust Node's heap.
+
+Spark shares a single ~400KB global stylesheet across every shadow root, using one
+constructable `CSSStyleSheet`. jsdom does not implement `adoptedStyleSheets`, so
+Stencil cannot detect support for that API and falls back to injecting a `<style>`
+element into every shadow root. jsdom then re-parses those 400KB once per Spark
+element. This entry point fills in the missing APIs so Spark stays on the shared
+stylesheet path.
+
+Use `setupFiles` rather than `setupFilesAfterEnv`. Stencil runs its detection when
+its runtime is first evaluated, so the shim has to be in place before your
+components are imported.
+
+If you use a custom Jest environment, import the function and apply it to that
+environment's global instead:
+
+```js
+const {
+  shimConstructableStyleSheets
+} = require('genesys-spark/dist/testing.cjs');
+
+class MyEnvironment extends JSDOMEnvironment {
+  constructor(config, context) {
+    super(config, context);
+    shimConstructableStyleSheets(this.global);
+  }
+}
+```
+
+The shim fills in each API only when it is missing, so it does nothing in a real
+browser and will retire itself if jsdom implements `adoptedStyleSheets`. The
+stylesheet text is never applied, because jsdom does not implement the shadow DOM
+cascade. That is equally true of the `<style>` element it replaces, so this costs
+no style fidelity.
+
 ## Asset loading details
 
 By adding a script tag to the document, we ensure that the components are always

package/dist/index.js

@@ -230,8 +230,8 @@ var sparkIntl = /*#__PURE__*/Object.freeze({
   relativeTimeFormat: relativeTimeFormat
 });
 
-const COMPONENT_ASSET_PREFIX = "/spark-components/build-assets/4.264.2-1115/genesys-webcomponents/";
-const CHART_COMPONENT_ASSET_PREFIX = "/spark-components/build-assets/4.264.2-1115/chart/genesys-chart-webcomponents/";
+const COMPONENT_ASSET_PREFIX = "/spark-components/build-assets/4.265.0-1116/genesys-webcomponents/";
+const CHART_COMPONENT_ASSET_PREFIX = "/spark-components/build-assets/4.265.0-1116/chart/genesys-chart-webcomponents/";
 function loadSparkFonts(opts) {
   const fontOrigin = getFontOrigin();
   const flareFonts = {

package/dist/testing.cjs

@@ -0,0 +1,51 @@
+'use strict';
+
+const adoptedStyleSheetsByHost = /* @__PURE__ */ new WeakMap();
+function getAdoptedStyleSheets(host) {
+  let sheets = adoptedStyleSheetsByHost.get(host);
+  if (!sheets) {
+    sheets = [];
+    adoptedStyleSheetsByHost.set(host, sheets);
+  }
+  return sheets;
+}
+const adoptedStyleSheetsDescriptor = {
+  configurable: true,
+  get() {
+    return getAdoptedStyleSheets(this);
+  },
+  set(sheets) {
+    adoptedStyleSheetsByHost.set(this, Array.from(sheets));
+  }
+};
+function shimConstructableStyleSheets(globalObject) {
+  if (!globalObject) {
+    return false;
+  }
+  const { CSSStyleSheet, ShadowRoot, document } = globalObject;
+  if (!CSSStyleSheet || !ShadowRoot || !document) {
+    return false;
+  }
+  if (typeof CSSStyleSheet.prototype.replaceSync !== "function") {
+    CSSStyleSheet.prototype.replaceSync = function replaceSync() {
+    };
+  }
+  if (!ShadowRoot.prototype.adoptedStyleSheets) {
+    Object.defineProperty(
+      ShadowRoot.prototype,
+      "adoptedStyleSheets",
+      adoptedStyleSheetsDescriptor
+    );
+  }
+  if (!document.adoptedStyleSheets) {
+    Object.defineProperty(
+      document,
+      "adoptedStyleSheets",
+      adoptedStyleSheetsDescriptor
+    );
+  }
+  return true;
+}
+shimConstructableStyleSheets(globalThis);
+
+exports.shimConstructableStyleSheets = shimConstructableStyleSheets;

package/dist/testing.d.cts

@@ -0,0 +1,42 @@
+/**
+ * Test-environment shim that lets Stencil detect constructable stylesheet
+ * support under jsdom.
+ *
+ * Spark shares one ~400KB global stylesheet across every shadow root through a
+ * single constructable `CSSStyleSheet`. When Stencil cannot detect support for
+ * that API it falls back to injecting a `<style>` element into *every* shadow
+ * root, so jsdom re-parses those 400KB once per Spark element. That is enough to
+ * take a moderate test suite past Node's 4GB heap limit.
+ *
+ * Stencil's detection needs two things: a truthy `document.adoptedStyleSheets`,
+ * and a `CSSStyleSheet` that is constructable and has `replaceSync`. Once it
+ * detects support it also reads and writes `adoptedStyleSheets` on each shadow
+ * root, so that needs to exist too. jsdom supplies only the bare `CSSStyleSheet`
+ * constructor, so Stencil takes the fallback. Supplying all three missing pieces
+ * keeps Spark on the shared-stylesheet path.
+ *
+ * Neither upgrading Spark nor upgrading jsdom removes the need for this. jsdom
+ * has never shipped `adoptedStyleSheets` (see
+ * https://github.com/jsdom/jsdom/issues/3998, which recommends this same
+ * approach). Each piece is filled in only when it is missing, so the shim
+ * retires itself if jsdom ever implements the API.
+ *
+ * The stylesheet text is never applied, because jsdom does not implement the
+ * shadow DOM cascade. That is equally true of the `<style>` element the fallback
+ * injects, so this costs no style fidelity.
+ *
+ * See COMUI-5120.
+ */
+/**
+ * Fills in the constructable stylesheet APIs that jsdom is missing.
+ *
+ * Importing this module applies the shim to `globalThis`, which is all a Jest
+ * `setupFiles` entry needs. Call this directly only if you patch a different
+ * global, for example from a custom Jest environment.
+ *
+ * @param globalObject the environment to patch, normally `globalThis`
+ * @returns true when the environment is a DOM the shim can support
+ */
+declare function shimConstructableStyleSheets(globalObject: unknown): boolean;
+
+export { shimConstructableStyleSheets };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genesys-spark",
-  "version": "4.264.2",
+  "version": "4.265.0",
   "description": "",
   "license": "ISC",
   "author": "",
@@ -45,24 +45,24 @@
     "@tsconfig/strictest": "^2.0.8",
     "dir-compare": "^5.0.0",
     "esbuild": "^0.28.2",
-    "eslint": "^10.8.1",
+    "eslint": "^10.10.0",
     "glob": "^13.0.6",
-    "globals": "^17.11.0",
-    "jest": "^30.4.2",
-    "jest-environment-jsdom": "^30.4.1",
+    "globals": "^17.12.0",
+    "jest": "^30.5.1",
+    "jest-environment-jsdom": "^30.5.1",
     "npm-run-all": "^4.1.5",
     "prettier-package-json": "^2.8.0",
-    "rollup": "^4.62.4",
+    "rollup": "^4.63.3",
     "rollup-plugin-dts": "^6.5.1",
     "rollup-plugin-esbuild": "^6.2.1",
     "sass": "^1.101.0",
     "smob": "^1.6.2",
-    "stylelint": "^17.14.1",
+    "stylelint": "^17.15.0",
     "stylelint-config-html": "^2.0.0",
     "stylelint-config-recess-order": "^7.8.0",
     "stylelint-config-standard": "^40.0.0",
     "stylelint-order": "^8.1.1",
-    "stylelint-scss": "^7.2.0",
+    "stylelint-scss": "^7.3.0",
     "ts-jest": "^29.4.12"
   }
 }