@lwrjs/client-modules 0.20.3 → 0.20.5

package/build/bundle/prod/lwr/init/init.js

@@ -1,2 +1,2 @@
-import{BOOTSTRAP_END as e,INIT as o,INIT_MODULE as t}from"lwr/metrics";import{logOperationStart as r,logOperationEnd as n}from"lwr/profiler";import{hydrateComponent as i,createElement as s}from"lwc";const c="lwr:hydrate",l="visible";function a(e,o,t){i(e,o,t)}function d(e,o,t){const r=f||(f=new IntersectionObserver(((e,o)=>{e.forEach((e=>{if(e.isIntersecting){const t=e.target;o.unobserve(t);const r=p.get(t);if(r){p.delete(t);const{ctor:e,props:o}=r;a(t,e,o)}}}))}),{root:null,rootMargin:"100px"}),f);p.set(e,{ctor:o,props:t}),r.observe(e)}const p=new Map;let f;function u(e){return"IntersectionObserver"in globalThis&&e.getAttribute(c)===l}const m=(()=>{const e=globalThis,{SSREnabled:o}=e.LWR&&e.LWR.env||{};if(!globalThis.performance||!o)return()=>!1;let t=globalThis.performance.now();return()=>{const e=globalThis.performance.now();return e-t>50&&(t=e,!0)}})();function b(e,o){return s(e,{is:o})}function h(e){return e.replace(/\/v\/[a-zA-Z0-9-_.]+$/,"").replace("/","-").replace(/([A-Z])/g,(e=>`-${e.toLowerCase()}`))}const g=/-([a-z])/g;function w(e){return e.replace(g,(e=>e[1].toUpperCase()))}function v(i,s={}){void 0!==globalThis.customElements&&void 0!==globalThis.document?(r({id:o}),(async()=>{let e=0;const o=globalThis.document;for(const[c,l]of i){m()&&await y();const i=++e,p=h(c);if(!o.body.querySelector(p)){r({id:t,specifier:c,specifierIndex:i});const e=b(p,l),s=o.querySelector("[lwr-root]");s?s.appendChild(e):o.body.appendChild(e),n({id:t,specifier:c,specifierIndex:i,metadata:{renderMode:"spa"}});continue}const f=o.querySelectorAll(p);for(const e of f){r({id:t,specifier:c,specifierIndex:i});const o=e.dataset.lwrPropsId;if(o){u(e)?d(e,l,s[o]||{}):a(e,l,s[o]||{}),n({id:t,specifier:c,specifierIndex:i,metadata:{renderMode:"ssr"}});continue}const f=b(p,l);for(const{name:o,value:t}of e.attributes){f.setAttribute(o,t);const e=w(o);e in f&&(f[e]=t)}for(;e.childNodes.length>0;)f.appendChild(e.childNodes[0]);const m=e.parentElement;m&&m.replaceChild(f,e),n({id:t,specifier:c,specifierIndex:i,metadata:{renderMode:"csr"}})}}})(),n({id:o}),r({id:e})):r({id:e})}async function y(){const e=globalThis.scheduler;return function(e){let o,t=e[0],r=1;for(;r<e.length;){const n=e[r],i=e[r+1];if(r+=2,("optionalAccess"===n||"optionalCall"===n)&&null==t)return;"access"===n||"optionalAccess"===n?(o=t,t=i(t)):"call"!==n&&"optionalCall"!==n||(t=i(((...e)=>t.call(o,...e))),o=void 0)}return t}([e,"optionalAccess",e=>e.yield])?e.yield():new Promise((e=>setTimeout(e,0)))}export{c as HYDRATE_DIRECTIVE,l as HYDRATE_VISIBLE_VALUE,w as getPropFromAttrName,v as init,h as toKebabCase};
+import{BOOTSTRAP_END as e,INIT as t,INIT_MODULE as o}from"lwr/metrics";import{logOperationStart as n,logOperationEnd as i}from"lwr/profiler";import{hydrateComponent as r,createElement as s}from"lwc";let c=0;async function l(){const e=function(e){if(!globalThis.performance||!function(){const e=globalThis,{SSREnabled:t}=e.LWR&&e.LWR.env||{};return!!t}())return{shouldYield:!1,timeOfLastYield:e};const t=50,o=globalThis.performance.now();if(o-e>t)return{shouldYield:!0,timeOfLastYield:o};return{shouldYield:!1,timeOfLastYield:e}}(c);e.shouldYield&&(c=e.timeOfLastYield,await async function(){const e=globalThis.scheduler;return function(e){let t,o=e[0],n=1;for(;n<e.length;){const i=e[n],r=e[n+1];if(n+=2,("optionalAccess"===i||"optionalCall"===i)&&null==o)return;"access"===i||"optionalAccess"===i?(t=o,o=r(o)):"call"!==i&&"optionalCall"!==i||(o=r(((...e)=>o.call(t,...e))),t=void 0)}return o}([e,"optionalAccess",e=>e.yield])?e.yield():new Promise((e=>setTimeout(e,0)))}())}const a="lwr:hydrate",d="visible";function f(e,t,o){r(e,t,o)}function p(e,t,o){const n=m||(m=new IntersectionObserver(((e,t)=>{e.forEach((e=>{if(e.isIntersecting){const o=e.target;t.unobserve(o);const n=u.get(o);if(n){u.delete(o);const{ctor:e,props:t}=n;f(o,e,t)}}}))}),{root:null,rootMargin:"100px"}),m);u.set(e,{ctor:t,props:o}),n.observe(e)}const u=new Map;let m;function h(e){return"IntersectionObserver"in globalThis&&e.getAttribute(a)===d}function b(e,t){return s(e,{is:t})}function g(e){return e.replace(/\/v\/[a-zA-Z0-9-_.]+$/,"").replace("/","-").replace(/([A-Z])/g,(e=>`-${e.toLowerCase()}`))}const w=/-([a-z])/g;function v(e){return e.replace(w,(e=>e[1].toUpperCase()))}function y(r,s={}){void 0!==globalThis.customElements&&void 0!==globalThis.document?(n({id:t}),(async()=>{let e=0;const t=globalThis.document;for(const[c,a]of r){await l();const r=++e,d=g(c);if(!t.body.querySelector(d)){n({id:o,specifier:c,specifierIndex:r});const e=b(d,a),s=t.querySelector("[lwr-root]");s?s.appendChild(e):t.body.appendChild(e),i({id:o,specifier:c,specifierIndex:r,metadata:{renderMode:"spa"}});continue}const u=t.querySelectorAll(d);for(const e of u){n({id:o,specifier:c,specifierIndex:r});const t=e.dataset.lwrPropsId;if(t){h(e)?p(e,a,s[t]||{}):f(e,a,s[t]||{}),i({id:o,specifier:c,specifierIndex:r,metadata:{renderMode:"ssr"}});continue}const l=b(d,a);for(const{name:t,value:o}of e.attributes){l.setAttribute(t,o);const e=v(t);e in l&&(l[e]=o)}for(;e.childNodes.length>0;)l.appendChild(e.childNodes[0]);const u=e.parentElement;u&&u.replaceChild(l,e),i({id:o,specifier:c,specifierIndex:r,metadata:{renderMode:"csr"}})}}})(),i({id:t}),n({id:e})):n({id:e})}export{a as HYDRATE_DIRECTIVE,d as HYDRATE_VISIBLE_VALUE,v as getPropFromAttrName,y as init,g as toKebabCase};
 //# sourceMappingURL=init.js.map

package/build/es/modules/lwr/init/init.js

@@ -1,5 +1,6 @@
 import { BOOTSTRAP_END, INIT, INIT_MODULE } from 'lwr/metrics';
 import { logOperationStart, logOperationEnd } from 'lwr/profiler';
+import { yieldIfNecessary } from 'lwr/scheduler';
 // TODO: This is a temporal workaround until https://github.com/salesforce/lwc/pull/2083 is sorted - tmp
 // eslint-disable-next-line lwr/only-allowed-imports
 import { createElement } from 'lwc';
@@ -77,28 +78,6 @@ function createVisibilityObserver() {
     });
     return visibilityObserver;
 }
-const shouldYield = (() => {
-    const globalThisLWR = globalThis;
-    const { SSREnabled } = (globalThisLWR.LWR && globalThisLWR.LWR.env) || {};
-    // eslint-disable-next-line lwr/no-unguarded-apis
-    if (!globalThis.performance || !SSREnabled) {
-        return () => false;
-    }
-    // Break up hydration tasks into timed batches.
-    // Borrowed from https://tinyurl.com/5b4fw7eb
-    const TASK_BATCH_DURATION = 50;
-    // eslint-disable-next-line lwr/no-unguarded-apis
-    let timeOfLastYield = globalThis.performance.now();
-    return () => {
-        // eslint-disable-next-line lwr/no-unguarded-apis
-        const now = globalThis.performance.now();
-        if (now - timeOfLastYield > TASK_BATCH_DURATION) {
-            timeOfLastYield = now;
-            return true;
-        }
-        return false;
-    };
-})();
 function initializeWebComponent(elementName, Ctor) {
     return createElement(elementName, { is: Ctor });
 }
@@ -145,11 +124,9 @@ export function init(rootModules, serverData = {}) {
         // eslint-disable-next-line lwr/no-unguarded-apis
         const document = globalThis.document;
         for (const [specifier, ctor] of rootModules) {
-            if (shouldYield()) {
-                // Yield to the main thread during long hydration tasks
-                // eslint-disable-next-line no-await-in-loop
-                await yieldToMainThread();
-            }
+            // Yield to the main thread during long hydration tasks
+            // eslint-disable-next-line no-await-in-loop
+            await yieldIfNecessary();
             const specifierIndex = ++index;
             const elementName = toKebabCase(specifier);
             // initialize and inject the root module into the LWR Root or DOM if it is missing
@@ -229,10 +206,4 @@ export function init(rootModules, serverData = {}) {
     logOperationEnd({ id: INIT });
     logOperationStart({ id: BOOTSTRAP_END });
 }
-// Allows the browser to yield to the main thread during long-running tasks, improving responsiveness.
-async function yieldToMainThread() {
-    const scheduler = globalThis.scheduler;
-    // eslint-disable-next-line lwr/no-unguarded-apis
-    return scheduler?.yield ? scheduler.yield() : new Promise((resolve) => setTimeout(resolve, 0));
-}
 //# sourceMappingURL=init.js.map

package/build/es/modules/lwr/scheduler/scheduler.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Result of checking whether to yield to the main thread
+ */
+export interface ShouldYieldResult {
+    shouldYield: boolean;
+    timeOfLastYield: number;
+}
+/**
+ * Reset the internal yield tracking state. Used primarily for testing.
+ * @internal
+ */
+export declare function resetYieldTracking(): void;
+/**
+ * Yields control to the main thread if enough time has elapsed since the last yield.
+ * This automatically tracks yield timing internally to break up long-running tasks
+ * into batches, improving responsiveness without requiring manual state management.
+ *
+ * @returns Promise that resolves after yielding (if necessary) to the main thread
+ */
+export declare function yieldIfNecessary(): Promise<void>;
+//# sourceMappingURL=scheduler.d.ts.map

package/build/es/modules/lwr/scheduler/scheduler.js

@@ -0,0 +1,66 @@
+// Track the time of last yield for scheduler batching
+let timeOfLastYield = 0;
+/**
+ * Reset the internal yield tracking state. Used primarily for testing.
+ * @internal
+ */
+export function resetYieldTracking() {
+    timeOfLastYield = 0;
+}
+/**
+ * Yields control to the main thread if enough time has elapsed since the last yield.
+ * This automatically tracks yield timing internally to break up long-running tasks
+ * into batches, improving responsiveness without requiring manual state management.
+ *
+ * @returns Promise that resolves after yielding (if necessary) to the main thread
+ */
+export async function yieldIfNecessary() {
+    const result = checkShouldYield(timeOfLastYield);
+    if (result.shouldYield) {
+        timeOfLastYield = result.timeOfLastYield;
+        await yieldToMainThread();
+    }
+}
+/**
+ * Checks if the current execution should yield to the main thread based on elapsed time.
+ * Break up long-running tasks into timed batches to improve responsiveness.
+ * Borrowed from https://tinyurl.com/5b4fw7eb
+ *
+ * @param timeOfLastYield - Timestamp of the last yield (from performance.now())
+ * @returns Object containing whether to yield and the updated timestamp
+ */
+function checkShouldYield(timeOfLastYield) {
+    // eslint-disable-next-line lwr/no-unguarded-apis
+    if (!globalThis.performance || !getSSREnabled()) {
+        return { shouldYield: false, timeOfLastYield };
+    }
+    const TASK_BATCH_DURATION = 50;
+    // eslint-disable-next-line lwr/no-unguarded-apis
+    const now = globalThis.performance.now();
+    if (now - timeOfLastYield > TASK_BATCH_DURATION) {
+        return { shouldYield: true, timeOfLastYield: now };
+    }
+    return { shouldYield: false, timeOfLastYield };
+}
+/**
+ * Yields control to the main thread during long-running tasks to improve responsiveness.
+ * Uses the scheduler.yield() API if available, otherwise falls back to setTimeout.
+ *
+ * @returns Promise that resolves after yielding to the main thread
+ */
+async function yieldToMainThread() {
+    const scheduler = globalThis.scheduler;
+    // eslint-disable-next-line lwr/no-unguarded-apis
+    return scheduler?.yield ? scheduler.yield() : new Promise((resolve) => setTimeout(resolve, 0));
+}
+/**
+ * Gets the SSREnabled flag from the global LWR environment
+ *
+ * @returns Whether SSR is enabled
+ */
+function getSSREnabled() {
+    const globalThisLWR = globalThis;
+    const { SSREnabled } = (globalThisLWR.LWR && globalThisLWR.LWR.env) || {};
+    return !!SSREnabled;
+}
+//# sourceMappingURL=scheduler.js.map

package/build/modules/lwr/init/init.js

@@ -1,9 +1,8 @@
 // eslint-disable-next-line lwr/only-allowed-type-imports
 
-// eslint-disable-next-line lwr/only-allowed-type-imports
-
 import { BOOTSTRAP_END, INIT, INIT_MODULE } from 'lwr/metrics';
 import { logOperationStart, logOperationEnd } from 'lwr/profiler';
+import { yieldIfNecessary } from 'lwr/scheduler';
 
 // TODO: This is a temporal workaround until https://github.com/salesforce/lwc/pull/2083 is sorted - tmp
 // eslint-disable-next-line lwr/only-allowed-imports
@@ -97,32 +96,6 @@ function createVisibilityObserver() {
   });
   return visibilityObserver;
 }
-const shouldYield = (() => {
-  const globalThisLWR = globalThis;
-  const {
-    SSREnabled
-  } = globalThisLWR.LWR && globalThisLWR.LWR.env || {};
-
-  // eslint-disable-next-line lwr/no-unguarded-apis
-  if (!globalThis.performance || !SSREnabled) {
-    return () => false;
-  }
-
-  // Break up hydration tasks into timed batches.
-  // Borrowed from https://tinyurl.com/5b4fw7eb
-  const TASK_BATCH_DURATION = 50;
-  // eslint-disable-next-line lwr/no-unguarded-apis
-  let timeOfLastYield = globalThis.performance.now();
-  return () => {
-    // eslint-disable-next-line lwr/no-unguarded-apis
-    const now = globalThis.performance.now();
-    if (now - timeOfLastYield > TASK_BATCH_DURATION) {
-      timeOfLastYield = now;
-      return true;
-    }
-    return false;
-  };
-})();
 function initializeWebComponent(elementName, Ctor) {
   return createElement(elementName, {
     is: Ctor
@@ -175,11 +148,9 @@ export function init(rootModules, serverData = {}) {
     // eslint-disable-next-line lwr/no-unguarded-apis
     const document = globalThis.document;
     for (const [specifier, ctor] of rootModules) {
-      if (shouldYield()) {
-        // Yield to the main thread during long hydration tasks
-        // eslint-disable-next-line no-await-in-loop
-        await yieldToMainThread();
-      }
+      // Yield to the main thread during long hydration tasks
+      // eslint-disable-next-line no-await-in-loop
+      await yieldIfNecessary();
       const specifierIndex = ++index;
       const elementName = toKebabCase(specifier);
 
@@ -286,11 +257,4 @@ export function init(rootModules, serverData = {}) {
   logOperationStart({
     id: BOOTSTRAP_END
   });
-}
-
-// Allows the browser to yield to the main thread during long-running tasks, improving responsiveness.
-async function yieldToMainThread() {
-  const scheduler = globalThis.scheduler;
-  // eslint-disable-next-line lwr/no-unguarded-apis
-  return scheduler?.yield ? scheduler.yield() : new Promise(resolve => setTimeout(resolve, 0));
 }

package/build/modules/lwr/scheduler/scheduler.js

@@ -0,0 +1,85 @@
+/**
+ * Result of checking whether to yield to the main thread
+ */
+
+// Track the time of last yield for scheduler batching
+let timeOfLastYield = 0;
+
+/**
+ * Reset the internal yield tracking state. Used primarily for testing.
+ * @internal
+ */
+export function resetYieldTracking() {
+  timeOfLastYield = 0;
+}
+
+/**
+ * Yields control to the main thread if enough time has elapsed since the last yield.
+ * This automatically tracks yield timing internally to break up long-running tasks
+ * into batches, improving responsiveness without requiring manual state management.
+ *
+ * @returns Promise that resolves after yielding (if necessary) to the main thread
+ */
+export async function yieldIfNecessary() {
+  const result = checkShouldYield(timeOfLastYield);
+  if (result.shouldYield) {
+    timeOfLastYield = result.timeOfLastYield;
+    await yieldToMainThread();
+  }
+}
+
+/**
+ * Checks if the current execution should yield to the main thread based on elapsed time.
+ * Break up long-running tasks into timed batches to improve responsiveness.
+ * Borrowed from https://tinyurl.com/5b4fw7eb
+ *
+ * @param timeOfLastYield - Timestamp of the last yield (from performance.now())
+ * @returns Object containing whether to yield and the updated timestamp
+ */
+function checkShouldYield(timeOfLastYield) {
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  if (!globalThis.performance || !getSSREnabled()) {
+    return {
+      shouldYield: false,
+      timeOfLastYield
+    };
+  }
+  const TASK_BATCH_DURATION = 50;
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  const now = globalThis.performance.now();
+  if (now - timeOfLastYield > TASK_BATCH_DURATION) {
+    return {
+      shouldYield: true,
+      timeOfLastYield: now
+    };
+  }
+  return {
+    shouldYield: false,
+    timeOfLastYield
+  };
+}
+
+/**
+ * Yields control to the main thread during long-running tasks to improve responsiveness.
+ * Uses the scheduler.yield() API if available, otherwise falls back to setTimeout.
+ *
+ * @returns Promise that resolves after yielding to the main thread
+ */
+async function yieldToMainThread() {
+  const scheduler = globalThis.scheduler;
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  return scheduler?.yield ? scheduler.yield() : new Promise(resolve => setTimeout(resolve, 0));
+}
+
+/**
+ * Gets the SSREnabled flag from the global LWR environment
+ *
+ * @returns Whether SSR is enabled
+ */
+function getSSREnabled() {
+  const globalThisLWR = globalThis;
+  const {
+    SSREnabled
+  } = globalThisLWR.LWR && globalThisLWR.LWR.env || {};
+  return !!SSREnabled;
+}

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.20.3",
+    "version": "0.20.5",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -34,10 +34,10 @@
     },
     "dependencies": {
         "@locker/sandbox": "0.25.3",
-        "@lwrjs/shared-utils": "0.20.3"
+        "@lwrjs/shared-utils": "0.20.5"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.20.3",
+        "@lwrjs/types": "0.20.5",
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-sucrase": "^5.0.2",
         "@rollup/plugin-terser": "^0.4.4",
@@ -61,7 +61,8 @@
             "lwr/lockerSandbox",
             "lwr/metrics",
             "lwr/profiler",
-            "lwr/serverDataCallback"
+            "lwr/serverDataCallback",
+            "lwr/scheduler"
         ]
     },
     "engines": {
@@ -70,5 +71,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "54759076bcb5d09e143a620e7653e2494658aefb"
+    "gitHead": "4ee0fa9b14629833090b379589202b9ac5a4a6c3"
 }