@lwrjs/client-modules 0.20.4 → 0.20.6

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

@@ -1,12 +1,9 @@
 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';
-// <hydrateComponentProxy> - This code is removed in core
-// Note: a build step uses these comments to strip the code for core.
-// eslint-disable-next-line lwr/only-allowed-imports
-import { hydrateComponent } from 'lwc';
+import { createElement, hydrateComponent } from 'lwc';
 // hydration directive + value constants
 // must align with the constants in @lwrjs/shared-utils/src/html-meta.ts
 export const HYDRATE_DIRECTIVE = 'lwr:hydrate';
@@ -14,7 +11,6 @@ export const HYDRATE_VISIBLE_VALUE = 'visible';
 function hydrateComponentProxy(customElement, Ctor, props) {
     hydrateComponent(customElement, Ctor, props);
 }
-// </hydrateComponentProxy>
 /**
  * Hydrate the custom element only when it is visible.
  * @param customElement - The custom element to hydrate
@@ -77,28 +73,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 +119,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 +201,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,18 +1,12 @@
 // 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
-import { createElement } from 'lwc';
-
-// <hydrateComponentProxy> - This code is removed in core
-// Note: a build step uses these comments to strip the code for core.
-// eslint-disable-next-line lwr/only-allowed-imports
-import { hydrateComponent } from 'lwc';
+import { createElement, hydrateComponent } from 'lwc';
 
 // hydration directive + value constants
 // must align with the constants in @lwrjs/shared-utils/src/html-meta.ts
@@ -21,7 +15,6 @@ export const HYDRATE_VISIBLE_VALUE = 'visible';
 function hydrateComponentProxy(customElement, Ctor, props) {
   hydrateComponent(customElement, Ctor, props);
 }
-// </hydrateComponentProxy>
 
 /**
  * Hydrate the custom element only when it is visible.
@@ -97,32 +90,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 +142,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 +251,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));
 }